refactor(db): split store interface

Author: fiftin

db/Store.go

@@ -4,11 +4,12 @@ import (
 	"database/sql/driver"
 	"encoding/json"
 	"errors"
-	"github.com/semaphoreui/semaphore/pkg/task_logger"
 	"reflect"
 	"strings"
 	"time"
 
+	"github.com/semaphoreui/semaphore/pkg/task_logger"
+
 	log "github.com/sirupsen/logrus"
 )
 
@@ -177,7 +178,8 @@ type TaskStat struct {
 	AvgDuration   int                            `json:"avg_duration"`
 }
 
-type Store interface {
+// ConnectionManager handles database connection lifecycle
+type ConnectionManager interface {
 	// Connect connects to the database.
 	// Token parameter used if PermanentConnection returns false.
 	// Token used for debugging of session connections.
@@ -188,7 +190,10 @@ type Store interface {
 	// This mode is suitable for MySQL and Postgres but not for BoltDB.
 	// For BoltDB we should reconnect for each request because BoltDB support only one connection at time.
 	PermanentConnection() bool
+}
 
+// MigrationManager handles database migrations
+type MigrationManager interface {
 	// IsInitialized indicates is database already initialized, or it is empty.
 	// The method is useful for creating required entities in database during first run.
 	IsInitialized() (bool, error)
@@ -200,40 +205,109 @@ type Store interface {
 	// TryRollbackMigration attempts to roll back the database to an earlier version
 	// if a rollback exists
 	TryRollbackMigration(version Migration)
+}
 
+// OptionsManager handles system options
+type OptionsManager interface {
 	GetOptions(params RetrieveQueryParams) (map[string]string, error)
 	GetOption(key string) (string, error)
 	SetOption(key string, value string) error
 	DeleteOption(key string) error
 	DeleteOptions(filter string) error
+}
 
-	GetEnvironment(projectID int, environmentID int) (Environment, error)
-	GetEnvironmentRefs(projectID int, environmentID int) (ObjectReferrers, error)
-	GetEnvironments(projectID int, params RetrieveQueryParams) ([]Environment, error)
-	UpdateEnvironment(env Environment) error
-	CreateEnvironment(env Environment) (Environment, error)
-	DeleteEnvironment(projectID int, templateID int) error
-	GetEnvironmentSecrets(projectID int, environmentID int) ([]AccessKey, error)
+// UserManager handles user-related operations
+type UserManager interface {
+	GetProUserCount() (int, error)
+	GetUserCount() (int, error)
+	GetUsers(params RetrieveQueryParams) ([]User, error)
+	CreateUserWithoutPassword(user User) (User, error)
+	CreateUser(user UserWithPwd) (User, error)
+	DeleteUser(userID int) error
+	UpdateUser(user UserWithPwd) error
+	SetUserPassword(userID int, password string) error
+	AddTotpVerification(userID int, url string, recoveryHash string) (UserTotp, error)
+	DeleteTotpVerification(userID int, totpID int) error
+	AddEmailOtpVerification(userID int, code string) (UserEmailOtp, error)
+	DeleteEmailOtpVerification(userID int, totpID int) error
+	GetUser(userID int) (User, error)
+	GetUserByLoginOrEmail(login string, email string) (User, error)
+	GetAllAdmins() ([]User, error)
+}
+
+// ProjectStore handles project-related operations
+type ProjectStore interface {
+	GetProject(projectID int) (Project, error)
+	GetAllProjects() ([]Project, error)
+	GetProjects(userID int) ([]Project, error)
+	CreateProject(project Project) (Project, error)
+	DeleteProject(projectID int) error
+	UpdateProject(project Project) error
+	GetProjectUsers(projectID int, params RetrieveQueryParams) ([]UserWithProjectRole, error)
+	CreateProjectUser(projectUser ProjectUser) (ProjectUser, error)
+	DeleteProjectUser(projectID int, userID int) error
+	GetProjectUser(projectID int, userID int) (ProjectUser, error)
+	UpdateProjectUser(projectUser ProjectUser) error
+}
 
+// TemplateManager handles template-related operations
+type TemplateManager interface {
+	GetTemplates(projectID int, filter TemplateFilter, params RetrieveQueryParams) ([]Template, error)
+	GetTemplateRefs(projectID int, templateID int) (ObjectReferrers, error)
+	CreateTemplate(template Template) (Template, error)
+	UpdateTemplate(template Template) error
+	GetTemplate(projectID int, templateID int) (Template, error)
+	DeleteTemplate(projectID int, templateID int) error
+	SetTemplateDescription(projectID int, templateID int, description string) error
+	GetTemplateVaults(projectID int, templateID int) ([]TemplateVault, error)
+	CreateTemplateVault(vault TemplateVault) (TemplateVault, error)
+	UpdateTemplateVaults(projectID int, templateID int, vaults []TemplateVault) error
+}
+
+// InventoryManager handles inventory-related operations
+type InventoryManager interface {
 	GetInventory(projectID int, inventoryID int) (Inventory, error)
 	GetInventoryRefs(projectID int, inventoryID int) (ObjectReferrers, error)
 	GetInventories(projectID int, params RetrieveQueryParams, types []InventoryType) ([]Inventory, error)
 	UpdateInventory(inventory Inventory) error
 	CreateInventory(inventory Inventory) (Inventory, error)
 	DeleteInventory(projectID int, inventoryID int) error
+}
 
+// RepositoryManager handles repository-related operations
+type RepositoryManager interface {
 	GetRepository(projectID int, repositoryID int) (Repository, error)
 	GetRepositoryRefs(projectID int, repositoryID int) (ObjectReferrers, error)
 	GetRepositories(projectID int, params RetrieveQueryParams) ([]Repository, error)
 	UpdateRepository(repository Repository) error
 	CreateRepository(repository Repository) (Repository, error)
 	DeleteRepository(projectID int, repositoryID int) error
+}
+
+// EnvironmentManager handles environment-related operations
+type EnvironmentManager interface {
+	GetEnvironment(projectID int, environmentID int) (Environment, error)
+	GetEnvironmentRefs(projectID int, environmentID int) (ObjectReferrers, error)
+	GetEnvironments(projectID int, params RetrieveQueryParams) ([]Environment, error)
+	UpdateEnvironment(env Environment) error
+	CreateEnvironment(env Environment) (Environment, error)
+	DeleteEnvironment(projectID int, templateID int) error
+	GetEnvironmentSecrets(projectID int, environmentID int) ([]AccessKey, error)
+}
 
+// AccessKeyManager handles access key-related operations
+type AccessKeyManager interface {
 	GetAccessKey(projectID int, accessKeyID int) (AccessKey, error)
 	GetAccessKeyRefs(projectID int, accessKeyID int) (ObjectReferrers, error)
 	GetAccessKeys(projectID int, params RetrieveQueryParams) ([]AccessKey, error)
 	RekeyAccessKeys(oldKey string) error
+	UpdateAccessKey(accessKey AccessKey) error
+	CreateAccessKey(accessKey AccessKey) (AccessKey, error)
+	DeleteAccessKey(projectID int, accessKeyID int) error
+}
 
+// IntegrationManager handles integration-related operations
+type IntegrationManager interface {
 	CreateIntegration(integration Integration) (newIntegration Integration, err error)
 	GetIntegrations(projectID int, params RetrieveQueryParams) ([]Integration, error)
 	GetIntegration(projectID int, integrationID int) (integration Integration, err error)
@@ -259,88 +333,36 @@ type Store interface {
 	GetIntegrationAliases(projectID int, integrationID *int) ([]IntegrationAlias, error)
 	GetIntegrationsByAlias(alias string) ([]Integration, IntegrationAliasLevel, error)
 	DeleteIntegrationAlias(projectID int, aliasID int) error
+}
 
-	UpdateAccessKey(accessKey AccessKey) error
-	CreateAccessKey(accessKey AccessKey) (AccessKey, error)
-	DeleteAccessKey(projectID int, accessKeyID int) error
-
-	GetProUserCount() (int, error)
-	GetUserCount() (int, error)
-	GetUsers(params RetrieveQueryParams) ([]User, error)
-	CreateUserWithoutPassword(user User) (User, error)
-	CreateUser(user UserWithPwd) (User, error)
-	DeleteUser(userID int) error
-
-	// UpdateUser updates all fields of the entity except Pwd.
-	// Pwd should be present of you want update user password. Empty Pwd ignored.
-	UpdateUser(user UserWithPwd) error
-	SetUserPassword(userID int, password string) error
-	AddTotpVerification(userID int, url string, recoveryHash string) (UserTotp, error)
-	DeleteTotpVerification(userID int, totpID int) error
-	AddEmailOtpVerification(userID int, code string) (UserEmailOtp, error)
-	DeleteEmailOtpVerification(userID int, totpID int) error
-
-	GetUser(userID int) (User, error)
-	GetUserByLoginOrEmail(login string, email string) (User, error)
-
-	GetProject(projectID int) (Project, error)
-	GetAllProjects() ([]Project, error)
-	GetProjects(userID int) ([]Project, error)
-	CreateProject(project Project) (Project, error)
-	DeleteProject(projectID int) error
-	UpdateProject(project Project) error
-
-	GetTemplates(projectID int, filter TemplateFilter, params RetrieveQueryParams) ([]Template, error)
-	GetTemplateRefs(projectID int, templateID int) (ObjectReferrers, error)
-	CreateTemplate(template Template) (Template, error)
-	UpdateTemplate(template Template) error
-	GetTemplate(projectID int, templateID int) (Template, error)
-	DeleteTemplate(projectID int, templateID int) error
-	SetTemplateDescription(projectID int, templateID int, description string) error
-
-	GetSchedules() ([]Schedule, error)
-	GetProjectSchedules(projectID int) ([]ScheduleWithTpl, error)
-	GetTemplateSchedules(projectID int, templateID int, onlyCommitCheckers bool) ([]Schedule, error)
-	CreateSchedule(schedule Schedule) (Schedule, error)
-	UpdateSchedule(schedule Schedule) error
-	SetScheduleCommitHash(projectID int, scheduleID int, hash string) error
-	SetScheduleActive(projectID int, scheduleID int, active bool) error
-	GetSchedule(projectID int, scheduleID int) (Schedule, error)
-	DeleteSchedule(projectID int, scheduleID int) error
-
-	GetAllAdmins() ([]User, error)
-	GetProjectUsers(projectID int, params RetrieveQueryParams) ([]UserWithProjectRole, error)
-	CreateProjectUser(projectUser ProjectUser) (ProjectUser, error)
-	DeleteProjectUser(projectID int, userID int) error
-	GetProjectUser(projectID int, userID int) (ProjectUser, error)
-	UpdateProjectUser(projectUser ProjectUser) error
-
-	CreateEvent(event Event) (Event, error)
-	GetUserEvents(userID int, params RetrieveQueryParams) ([]Event, error)
-	GetEvents(projectID int, params RetrieveQueryParams) ([]Event, error)
-
-	GetAPITokens(userID int) ([]APIToken, error)
-	CreateAPIToken(token APIToken) (APIToken, error)
-	GetAPIToken(tokenID string) (APIToken, error)
-	ExpireAPIToken(userID int, tokenID string) error
-	DeleteAPIToken(userID int, tokenID string) error
-
+// SessionManager handles session-related operations
+type SessionManager interface {
 	GetSession(userID int, sessionID int) (Session, error)
 	CreateSession(session Session) (Session, error)
 	ExpireSession(userID int, sessionID int) error
 	TouchSession(userID int, sessionID int) error
 	SetSessionVerificationMethod(userID int, sessionID int, verificationMethod SessionVerificationMethod) error
 	VerifySession(userID int, sessionID int) error
+}
 
+// TokenManager handles token-related operations
+type TokenManager interface {
+	GetAPITokens(userID int) ([]APIToken, error)
+	CreateAPIToken(token APIToken) (APIToken, error)
+	GetAPIToken(tokenID string) (APIToken, error)
+	ExpireAPIToken(userID int, tokenID string) error
+	DeleteAPIToken(userID int, tokenID string) error
+}
+
+// TaskManager handles task-related operations
+type TaskManager interface {
 	CreateTask(task Task, maxTasks int) (Task, error)
 	UpdateTask(task Task) error
-
 	GetTemplateTasks(projectID int, templateID int, params RetrieveQueryParams) ([]TaskWithTpl, error)
 	GetProjectTasks(projectID int, params RetrieveQueryParams) ([]TaskWithTpl, error)
 	GetTask(projectID int, taskID int) (Task, error)
 	DeleteTaskWithOutputs(projectID int, taskID int) error
 	GetTaskOutputs(projectID int, taskID int, params RetrieveQueryParams) ([]TaskOutput, error)
-
 	CreateTaskOutput(output TaskOutput) (TaskOutput, error)
 	CreateTaskStage(stage TaskStage) (TaskStage, error)
 	EndTaskStage(taskID int, stageID int, end time.Time, endOutputID int) error
@@ -349,18 +371,37 @@ type Store interface {
 	CreateAnsibleTaskError(error AnsibleTaskError) error
 	GetAnsibleTaskHosts(projectID int, taskID int) ([]AnsibleTaskHost, error)
 	GetAnsibleTaskErrors(projectID int, taskID int) ([]AnsibleTaskError, error)
-
 	GetTaskStages(projectID int, taskID int) ([]TaskStageWithResult, error)
 	GetTaskStageResult(projectID int, taskID int, stageID int) (TaskStageResult, error)
 	GetTaskStageOutputs(projectID int, taskID int, stageID int) ([]TaskOutput, error)
+	GetTaskStats(projectID int, templateID *int, unit TaskStatUnit, filter TaskFilter) ([]TaskStat, error)
+}
+
+// ScheduleManager handles schedule-related operations
+type ScheduleManager interface {
+	GetSchedules() ([]Schedule, error)
+	GetProjectSchedules(projectID int) ([]ScheduleWithTpl, error)
+	GetTemplateSchedules(projectID int, templateID int, onlyCommitCheckers bool) ([]Schedule, error)
+	CreateSchedule(schedule Schedule) (Schedule, error)
+	UpdateSchedule(schedule Schedule) error
+	SetScheduleCommitHash(projectID int, scheduleID int, hash string) error
+	SetScheduleActive(projectID int, scheduleID int, active bool) error
+	GetSchedule(projectID int, scheduleID int) (Schedule, error)
+	DeleteSchedule(projectID int, scheduleID int) error
+}
 
+// ViewManager handles view-related operations
+type ViewManager interface {
 	GetView(projectID int, viewID int) (View, error)
 	GetViews(projectID int) ([]View, error)
 	UpdateView(view View) error
 	CreateView(view View) (View, error)
 	DeleteView(projectID int, viewID int) error
 	SetViewPositions(projectID int, viewPositions map[int]int) error
+}
 
+// RunnerManager handles runner-related operations
+type RunnerManager interface {
 	GetRunner(projectID int, runnerID int) (Runner, error)
 	GetRunners(projectID int, activeOnly bool, tag *string) ([]Runner, error)
 	DeleteRunner(projectID int, runnerID int) error
@@ -373,12 +414,35 @@ type Store interface {
 	TouchRunner(runner Runner) (err error)
 	ClearRunnerCache(runner Runner) (err error)
 	GetRunnerTags(projectID int) ([]RunnerTag, error)
+}
 
-	GetTemplateVaults(projectID int, templateID int) ([]TemplateVault, error)
-	CreateTemplateVault(vault TemplateVault) (TemplateVault, error)
-	UpdateTemplateVaults(projectID int, templateID int, vaults []TemplateVault) error
+// EventManager handles event-related operations
+type EventManager interface {
+	CreateEvent(event Event) (Event, error)
+	GetUserEvents(userID int, params RetrieveQueryParams) ([]Event, error)
+	GetEvents(projectID int, params RetrieveQueryParams) ([]Event, error)
+}
 
-	GetTaskStats(projectID int, templateID *int, unit TaskStatUnit, filter TaskFilter) ([]TaskStat, error)
+// Store is the main interface that aggregates all specialized interfaces
+type Store interface {
+	ConnectionManager
+	MigrationManager
+	OptionsManager
+	UserManager
+	ProjectStore
+	TemplateManager
+	InventoryManager
+	RepositoryManager
+	EnvironmentManager
+	AccessKeyManager
+	IntegrationManager
+	SessionManager
+	TokenManager
+	TaskManager
+	ScheduleManager
+	ViewManager
+	RunnerManager
+	EventManager
 }
 
 var AccessKeyProps = ObjectProps{