refactor(database): move user logic into separate package

api/admin/user.go

@@ -45,7 +45,7 @@ func AllUsers(c *gin.Context) {
 	logrus.Info("Admin: reading all users")
 
 	// send API call to capture all users
-	u, err := database.FromContext(c).GetUserList()
+	u, err := database.FromContext(c).ListUsers()
 	if err != nil {
 		retErr := fmt.Errorf("unable to capture all users: %w", err)
 

api/authenticate.go

@@ -99,7 +99,7 @@ func Authenticate(c *gin.Context) {
 	}
 
 	// send API call to capture the user logging in
-	u, err := database.FromContext(c).GetUserName(newUser.GetName())
+	u, err := database.FromContext(c).GetUserForName(newUser.GetName())
 	// create a new user account
 	if len(u.GetName()) == 0 || err != nil {
 		// create unique id for the user
@@ -314,7 +314,7 @@ func AuthenticateToken(c *gin.Context) {
 	}
 
 	// check if the user exists
-	u, err = database.FromContext(c).GetUserName(u.GetName())
+	u, err = database.FromContext(c).GetUserForName(u.GetName())
 	if err != nil {
 		retErr := fmt.Errorf("user %s not found", u.GetName())
 

api/metrics.go

@@ -74,7 +74,7 @@ func CustomMetrics(c *gin.Context) {
 // helper function to get the totals of resource types.
 func recordGauges(c *gin.Context) {
 	// send API call to capture the total number of users
-	u, err := database.FromContext(c).GetUserCount()
+	u, err := database.FromContext(c).CountUsers()
 	if err != nil {
 		logrus.Errorf("unable to get count of all users: %v", err)
 	}

api/user.go

@@ -87,7 +87,7 @@ func CreateUser(c *gin.Context) {
 	}
 
 	// send API call to capture the created user
-	user, _ := database.FromContext(c).GetUserName(input.GetName())
+	user, _ := database.FromContext(c).GetUserForName(input.GetName())
 
 	c.JSON(http.StatusCreated, user)
 }
@@ -172,18 +172,8 @@ func GetUsers(c *gin.Context) {
 	// ensure per_page isn't above or below allowed values
 	perPage = util.MaxInt(1, util.MinInt(100, perPage))
 
-	// send API call to capture the total number of users
-	t, err := database.FromContext(c).GetUserCount()
-	if err != nil {
-		retErr := fmt.Errorf("unable to get users count: %w", err)
-
-		util.HandleError(c, http.StatusInternalServerError, retErr)
-
-		return
-	}
-
 	// send API call to capture the list of users
-	users, err := database.FromContext(c).GetUserLiteList(page, perPage)
+	users, t, err := database.FromContext(c).ListLiteUsers(page, perPage)
 	if err != nil {
 		retErr := fmt.Errorf("unable to get users: %w", err)
 
@@ -311,7 +301,7 @@ func UpdateCurrentUser(c *gin.Context) {
 	}
 
 	// send API call to capture the updated user
-	u, err = database.FromContext(c).GetUserName(u.GetName())
+	u, err = database.FromContext(c).GetUserForName(u.GetName())
 	if err != nil {
 		retErr := fmt.Errorf("unable to get updated user %s: %w", u.GetName(), err)
 
@@ -363,7 +353,7 @@ func GetUser(c *gin.Context) {
 	}).Infof("reading user %s", user)
 
 	// send API call to capture the user
-	u, err := database.FromContext(c).GetUserName(user)
+	u, err := database.FromContext(c).GetUserForName(user)
 	if err != nil {
 		retErr := fmt.Errorf("unable to get user %s: %w", user, err)
 
@@ -548,7 +538,7 @@ func UpdateUser(c *gin.Context) {
 	}
 
 	// send API call to capture the user
-	u, err = database.FromContext(c).GetUserName(user)
+	u, err = database.FromContext(c).GetUserForName(user)
 	if err != nil {
 		retErr := fmt.Errorf("unable to get user %s: %w", user, err)
 
@@ -584,7 +574,7 @@ func UpdateUser(c *gin.Context) {
 	}
 
 	// send API call to capture the updated user
-	u, _ = database.FromContext(c).GetUserName(user)
+	u, _ = database.FromContext(c).GetUserForName(user)
 
 	c.JSON(http.StatusOK, u)
 }
@@ -633,7 +623,7 @@ func DeleteUser(c *gin.Context) {
 	}).Infof("deleting user %s", user)
 
 	// send API call to capture the user
-	u, err := database.FromContext(c).GetUserName(user)
+	u, err := database.FromContext(c).GetUserForName(user)
 	if err != nil {
 		retErr := fmt.Errorf("unable to get user %s: %w", user, err)
 
@@ -643,7 +633,7 @@ func DeleteUser(c *gin.Context) {
 	}
 
 	// send API call to remove the user
-	err = database.FromContext(c).DeleteUser(u.GetID())
+	err = database.FromContext(c).DeleteUser(u)
 	if err != nil {
 		retErr := fmt.Errorf("unable to delete user %s: %w", u.GetName(), err)
 

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)
 			}
 		})
 	}