refactor(database): restructure DDL functions

database/pipeline/index.go

@@ -15,8 +15,8 @@ ON pipelines (repo_id);
 `
 )
 
-// CreateIndexes creates the indexes for the pipelines table in the database.
-func (e *engine) CreateIndexes() error {
+// CreatePipelineIndexes creates the indexes for the pipelines table in the database.
+func (e *engine) CreatePipelineIndexes() error {
 	e.logger.Tracef("creating indexes for pipelines table in the database")
 
 	// create the repo_id column index for the pipelines table

database/pipeline/index_test.go

@@ -10,7 +10,7 @@ import (
 	"github.com/DATA-DOG/go-sqlmock"
 )
 
-func TestPipeline_Engine_CreateIndexes(t *testing.T) {
+func TestPipeline_Engine_CreatePipelineIndexes(t *testing.T) {
 	// setup types
 	_postgres, _mock := testPostgres(t)
 	defer func() { _sql, _ := _postgres.client.DB(); _sql.Close() }()
@@ -41,18 +41,18 @@ func TestPipeline_Engine_CreateIndexes(t *testing.T) {
 	// run tests
 	for _, test := range tests {
 		t.Run(test.name, func(t *testing.T) {
-			err := test.database.CreateIndexes()
+			err := test.database.CreatePipelineIndexes()
 
 			if test.failure {
 				if err == nil {
-					t.Errorf("CreateIndexes for %s should have returned err", test.name)
+					t.Errorf("CreatePipelineIndexes for %s should have returned err", test.name)
 				}
 
 				return
 			}
 
 			if err != nil {
-				t.Errorf("CreateIndexes for %s returned err: %v", test.name, err)
+				t.Errorf("CreatePipelineIndexes for %s returned err: %v", test.name, err)
 			}
 		})
 	}

database/pipeline/pipeline.go

@@ -67,13 +67,13 @@ func New(opts ...EngineOpt) (*engine, error) {
 	}
 
 	// create the pipelines table
-	err := e.CreateTable(e.client.Config.Dialector.Name())
+	err := e.CreatePipelineTable(e.client.Config.Dialector.Name())
 	if err != nil {
 		return nil, fmt.Errorf("unable to create %s table: %w", constants.TablePipeline, err)
 	}
 
 	// create the indexes for the pipelines table
-	err = e.CreateIndexes()
+	err = e.CreatePipelineIndexes()
 	if err != nil {
 		return nil, fmt.Errorf("unable to create indexes for %s table: %w", constants.TablePipeline, err)
 	}

database/pipeline/service.go

@@ -17,10 +17,10 @@ type PipelineService interface {
 	//
 	// https://en.wikipedia.org/wiki/Data_definition_language
 
-	// CreateIndexes creates the indexes for the pipelines table.
-	CreateIndexes() error
-	// CreateTable defines a function that creates the pipelines table.
-	CreateTable(string) error
+	// CreatePipelineIndexes defines a function that creates the indexes for the pipelines table.
+	CreatePipelineIndexes() error
+	// CreatePipelineTable defines a function that creates the pipelines table.
+	CreatePipelineTable(string) error
 
 	// Pipeline Data Manipulation Language Functions
 	//

database/pipeline/table.go

@@ -56,8 +56,8 @@ pipelines (
 `
 )
 
-// CreateTable creates the pipelines table in the database.
-func (e *engine) CreateTable(driver string) error {
+// CreatePipelineTable creates the pipelines table in the database.
+func (e *engine) CreatePipelineTable(driver string) error {
 	e.logger.Tracef("creating pipelines table in the database")
 
 	// handle the driver provided to create the table

database/pipeline/table_test.go

@@ -10,7 +10,7 @@ import (
 	"github.com/DATA-DOG/go-sqlmock"
 )
 
-func TestPipeline_Engine_CreateTable(t *testing.T) {
+func TestPipeline_Engine_CreatePipelineTable(t *testing.T) {
 	// setup types
 	_postgres, _mock := testPostgres(t)
 	defer func() { _sql, _ := _postgres.client.DB(); _sql.Close() }()
@@ -41,18 +41,18 @@ func TestPipeline_Engine_CreateTable(t *testing.T) {
 	// run tests
 	for _, test := range tests {
 		t.Run(test.name, func(t *testing.T) {
-			err := test.database.CreateTable(test.name)
+			err := test.database.CreatePipelineTable(test.name)
 
 			if test.failure {
 				if err == nil {
-					t.Errorf("CreateTable for %s should have returned err", test.name)
+					t.Errorf("CreatePipelineTable for %s should have returned err", test.name)
 				}
 
 				return
 			}
 
 			if err != nil {
-				t.Errorf("CreateTable for %s returned err: %v", test.name, err)
+				t.Errorf("CreatePipelineTable for %s returned err: %v", test.name, err)
 			}
 		})
 	}

database/postgres/postgres.go

@@ -11,6 +11,7 @@ import (
 	"github.com/DATA-DOG/go-sqlmock"
 	"github.com/go-vela/server/database/pipeline"
 	"github.com/go-vela/server/database/postgres/ddl"
+	"github.com/go-vela/server/database/user"
 	"github.com/go-vela/types/constants"
 	"github.com/sirupsen/logrus"
 
@@ -37,11 +38,15 @@ type (
 	}
 
 	client struct {
-		config   *config
+		config *config
+		// https://pkg.go.dev/gorm.io/gorm#DB
 		Postgres *gorm.DB
 		// https://pkg.go.dev/github.com/sirupsen/logrus#Entry
 		Logger *logrus.Entry
+		// https://pkg.go.dev/github.com/go-vela/server/database/pipeline#PipelineService
 		pipeline.PipelineService
+		// https://pkg.go.dev/github.com/go-vela/server/database/user#UserService
+		user.UserService
 	}
 )
 
@@ -140,6 +145,8 @@ func NewTest() (*client, sqlmock.Sqlmock, error) {
 
 	_mock.ExpectExec(pipeline.CreatePostgresTable).WillReturnResult(sqlmock.NewResult(1, 1))
 	_mock.ExpectExec(pipeline.CreateRepoIDIndex).WillReturnResult(sqlmock.NewResult(1, 1))
+	_mock.ExpectExec(user.CreatePostgresTable).WillReturnResult(sqlmock.NewResult(1, 1))
+	_mock.ExpectExec(user.CreateUserRefreshIndex).WillReturnResult(sqlmock.NewResult(1, 1))
 
 	// create the new mock Postgres database client
 	//
@@ -262,12 +269,6 @@ func createTables(c *client) error {
 		return fmt.Errorf("unable to create %s table: %w", constants.TableStep, err)
 	}
 
-	// create the users table
-	err = c.Postgres.Exec(ddl.CreateUserTable).Error
-	if err != nil {
-		return fmt.Errorf("unable to create %s table: %w", constants.TableUser, err)
-	}
-
 	// create the workers table
 	err = c.Postgres.Exec(ddl.CreateWorkerTable).Error
 	if err != nil {
@@ -342,12 +343,6 @@ func createIndexes(c *client) error {
 		return fmt.Errorf("unable to create secrets_type_org index for the %s table: %w", constants.TableSecret, err)
 	}
 
-	// create the users_refresh index for the users table
-	err = c.Postgres.Exec(ddl.CreateUserRefreshIndex).Error
-	if err != nil {
-		return fmt.Errorf("unable to create users_refresh index for the %s table: %w", constants.TableUser, err)
-	}
-
 	// create the workers_hostname_address index for the workers table
 	err = c.Postgres.Exec(ddl.CreateWorkerHostnameAddressIndex).Error
 	if err != nil {
@@ -374,5 +369,18 @@ func createServices(c *client) error {
 		return err
 	}
 
+	// create the database agnostic user service
+	//
+	// https://pkg.go.dev/github.com/go-vela/server/database/user#New
+	c.UserService, err = user.New(
+		user.WithClient(c.Postgres),
+		user.WithEncryptionKey(c.config.EncryptionKey),
+		user.WithLogger(c.Logger),
+		user.WithSkipCreation(c.config.SkipCreation),
+	)
+	if err != nil {
+		return err
+	}
+
 	return nil
 }

database/postgres/postgres_test.go

@@ -12,6 +12,7 @@ import (
 	"github.com/DATA-DOG/go-sqlmock"
 	"github.com/go-vela/server/database/pipeline"
 	"github.com/go-vela/server/database/postgres/ddl"
+	"github.com/go-vela/server/database/user"
 )
 
 func TestPostgres_New(t *testing.T) {
@@ -80,7 +81,6 @@ func TestPostgres_setupDatabase(t *testing.T) {
 	_mock.ExpectExec(ddl.CreateSecretTable).WillReturnResult(sqlmock.NewResult(1, 1))
 	_mock.ExpectExec(ddl.CreateServiceTable).WillReturnResult(sqlmock.NewResult(1, 1))
 	_mock.ExpectExec(ddl.CreateStepTable).WillReturnResult(sqlmock.NewResult(1, 1))
-	_mock.ExpectExec(ddl.CreateUserTable).WillReturnResult(sqlmock.NewResult(1, 1))
 	_mock.ExpectExec(ddl.CreateWorkerTable).WillReturnResult(sqlmock.NewResult(1, 1))
 
 	// ensure the mock expects the index queries
@@ -94,7 +94,6 @@ func TestPostgres_setupDatabase(t *testing.T) {
 	_mock.ExpectExec(ddl.CreateSecretTypeOrgRepo).WillReturnResult(sqlmock.NewResult(1, 1))
 	_mock.ExpectExec(ddl.CreateSecretTypeOrgTeam).WillReturnResult(sqlmock.NewResult(1, 1))
 	_mock.ExpectExec(ddl.CreateSecretTypeOrg).WillReturnResult(sqlmock.NewResult(1, 1))
-	_mock.ExpectExec(ddl.CreateUserRefreshIndex).WillReturnResult(sqlmock.NewResult(1, 1))
 	_mock.ExpectExec(ddl.CreateWorkerHostnameAddressIndex).WillReturnResult(sqlmock.NewResult(1, 1))
 	_mock.ExpectExec(pipeline.CreatePostgresTable).WillReturnResult(sqlmock.NewResult(1, 1))
 	_mock.ExpectExec(pipeline.CreateRepoIDIndex).WillReturnResult(sqlmock.NewResult(1, 1))
@@ -165,7 +164,6 @@ func TestPostgres_createTables(t *testing.T) {
 	_mock.ExpectExec(ddl.CreateSecretTable).WillReturnResult(sqlmock.NewResult(1, 1))
 	_mock.ExpectExec(ddl.CreateServiceTable).WillReturnResult(sqlmock.NewResult(1, 1))
 	_mock.ExpectExec(ddl.CreateStepTable).WillReturnResult(sqlmock.NewResult(1, 1))
-	_mock.ExpectExec(ddl.CreateUserTable).WillReturnResult(sqlmock.NewResult(1, 1))
 	_mock.ExpectExec(ddl.CreateWorkerTable).WillReturnResult(sqlmock.NewResult(1, 1))
 
 	tests := []struct {
@@ -215,7 +213,6 @@ func TestPostgres_createIndexes(t *testing.T) {
 	_mock.ExpectExec(ddl.CreateSecretTypeOrgRepo).WillReturnResult(sqlmock.NewResult(1, 1))
 	_mock.ExpectExec(ddl.CreateSecretTypeOrgTeam).WillReturnResult(sqlmock.NewResult(1, 1))
 	_mock.ExpectExec(ddl.CreateSecretTypeOrg).WillReturnResult(sqlmock.NewResult(1, 1))
-	_mock.ExpectExec(ddl.CreateUserRefreshIndex).WillReturnResult(sqlmock.NewResult(1, 1))
 	_mock.ExpectExec(ddl.CreateWorkerHostnameAddressIndex).WillReturnResult(sqlmock.NewResult(1, 1))
 
 	tests := []struct {
@@ -257,6 +254,8 @@ func TestPostgres_createServices(t *testing.T) {
 	// ensure the mock expects the index queries
 	_mock.ExpectExec(pipeline.CreatePostgresTable).WillReturnResult(sqlmock.NewResult(1, 1))
 	_mock.ExpectExec(pipeline.CreateRepoIDIndex).WillReturnResult(sqlmock.NewResult(1, 1))
+	_mock.ExpectExec(user.CreatePostgresTable).WillReturnResult(sqlmock.NewResult(1, 1))
+	_mock.ExpectExec(user.CreateUserRefreshIndex).WillReturnResult(sqlmock.NewResult(1, 1))
 
 	tests := []struct {
 		failure bool

database/service.go

@@ -6,6 +6,7 @@ package database
 
 import (
 	"github.com/go-vela/server/database/pipeline"
+	"github.com/go-vela/server/database/user"
 	"github.com/go-vela/types/library"
 )
 
@@ -239,39 +240,16 @@ type Service interface {
 	// deletes a step by unique ID.
 	DeleteService(int64) error
 
-	// User Database Interface Functions
-
-	// GetUser defines a function that
-	// gets a user by unique ID.
-	GetUser(int64) (*library.User, error)
-	// GetUserName defines a function that
-	// gets a user by name.
-	GetUserName(string) (*library.User, error)
-	// GetUserList defines a function that
-	// gets a list of all users.
-	GetUserList() ([]*library.User, error)
-	// GetUserCount defines a function that
-	// gets the count of users.
-	GetUserCount() (int64, error)
-	// GetUserLiteList defines a function
-	// that gets a lite list of users.
-	GetUserLiteList(int, int) ([]*library.User, error)
-	// CreateUser defines a function that
-	// creates a new user.
-	CreateUser(*library.User) error
-	// UpdateUser defines a function that
-	// updates a user.
-	UpdateUser(*library.User) error
-	// DeleteUser defines a function that
-	// deletes a user by unique ID.
-	DeleteUser(int64) error
+	// UserService provides the interface for functionality
+	// related to users stored in the database.
+	user.UserService
 
 	// Worker Database Interface Functions
 
 	// GetWorker defines a function that
 	// gets a worker by hostname.
 	GetWorker(string) (*library.Worker, error)
-	// GetWorkerAddress defines a function that
+	// GetWorkerByAddress defines a function that
 	// gets a worker by address.
 	GetWorkerByAddress(string) (*library.Worker, error)
 	// GetWorkerList defines a function that

database/sqlite/sqlite.go

@@ -10,6 +10,7 @@ import (
 
 	"github.com/go-vela/server/database/pipeline"
 	"github.com/go-vela/server/database/sqlite/ddl"
+	"github.com/go-vela/server/database/user"
 	"github.com/go-vela/types/constants"
 	"github.com/sirupsen/logrus"
 
@@ -37,10 +38,14 @@ type (
 
 	client struct {
 		config *config
+		// https://pkg.go.dev/gorm.io/gorm#DB
 		Sqlite *gorm.DB
 		// https://pkg.go.dev/github.com/sirupsen/logrus#Entry
 		Logger *logrus.Entry
+		// https://pkg.go.dev/github.com/go-vela/server/database/pipeline#PipelineService
 		pipeline.PipelineService
+		// https://pkg.go.dev/github.com/go-vela/server/database/user#UserService
+		user.UserService
 	}
 )
 
@@ -258,12 +263,6 @@ func createTables(c *client) error {
 		return fmt.Errorf("unable to create %s table: %w", constants.TableStep, err)
 	}
 
-	// create the users table
-	err = c.Sqlite.Exec(ddl.CreateUserTable).Error
-	if err != nil {
-		return fmt.Errorf("unable to create %s table: %w", constants.TableUser, err)
-	}
-
 	// create the workers table
 	err = c.Sqlite.Exec(ddl.CreateWorkerTable).Error
 	if err != nil {
@@ -338,12 +337,6 @@ func createIndexes(c *client) error {
 		return fmt.Errorf("unable to create secrets_type_org index for the %s table: %w", constants.TableSecret, err)
 	}
 
-	// create the users_refresh index for the users table
-	err = c.Sqlite.Exec(ddl.CreateUserRefreshIndex).Error
-	if err != nil {
-		return fmt.Errorf("unable to create users_refresh index for the %s table: %w", constants.TableUser, err)
-	}
-
 	// create the workers_hostname_address index for the workers table
 	err = c.Sqlite.Exec(ddl.CreateWorkerHostnameAddressIndex).Error
 	if err != nil {
@@ -370,5 +363,18 @@ func createServices(c *client) error {
 		return err
 	}
 
+	// create the database agnostic user service
+	//
+	// https://pkg.go.dev/github.com/go-vela/server/database/user#New
+	c.UserService, err = user.New(
+		user.WithClient(c.Sqlite),
+		user.WithEncryptionKey(c.config.EncryptionKey),
+		user.WithLogger(c.Logger),
+		user.WithSkipCreation(c.config.SkipCreation),
+	)
+	if err != nil {
+		return err
+	}
+
 	return nil
 }