refactor(database): move log logic into separate package

api/log.go

@@ -83,7 +83,9 @@ func GetBuildLogs(c *gin.Context) {
 	}).Infof("reading logs for build %s", entry)
 
 	// send API call to capture the list of logs for the build
-	l, err := database.FromContext(c).GetBuildLogs(b.GetID())
+	//
+	// TODO: add page and per_page query parameters
+	l, t, err := database.FromContext(c).ListLogsForBuild(b, 1, 100)
 	if err != nil {
 		retErr := fmt.Errorf("unable to get logs for build %s: %w", entry, err)
 
@@ -92,6 +94,15 @@ func GetBuildLogs(c *gin.Context) {
 		return
 	}
 
+	// create pagination object
+	pagination := Pagination{
+		Page:    1,
+		PerPage: 100,
+		Total:   t,
+	}
+	// set pagination headers
+	pagination.SetHeaderLink(c)
+
 	c.JSON(http.StatusOK, l)
 }
 
@@ -200,7 +211,7 @@ func CreateServiceLog(c *gin.Context) {
 	}
 
 	// send API call to capture the created log
-	l, _ := database.FromContext(c).GetServiceLog(s.GetID())
+	l, _ := database.FromContext(c).GetLogForService(s)
 
 	c.JSON(http.StatusCreated, l)
 }
@@ -270,7 +281,7 @@ func GetServiceLog(c *gin.Context) {
 	}).Infof("reading logs for service %s", entry)
 
 	// send API call to capture the service logs
-	l, err := database.FromContext(c).GetServiceLog(s.GetID())
+	l, err := database.FromContext(c).GetLogForService(s)
 	if err != nil {
 		retErr := fmt.Errorf("unable to get logs for service %s: %w", entry, err)
 
@@ -358,7 +369,7 @@ func UpdateServiceLog(c *gin.Context) {
 	}).Infof("updating logs for service %s", entry)
 
 	// send API call to capture the service logs
-	l, err := database.FromContext(c).GetServiceLog(s.GetID())
+	l, err := database.FromContext(c).GetLogForService(s)
 	if err != nil {
 		retErr := fmt.Errorf("unable to get logs for service %s: %w", entry, err)
 
@@ -396,7 +407,7 @@ func UpdateServiceLog(c *gin.Context) {
 	}
 
 	// send API call to capture the updated log
-	l, _ = database.FromContext(c).GetServiceLog(s.GetID())
+	l, _ = database.FromContext(c).GetLogForService(s)
 
 	c.JSON(http.StatusOK, l)
 }
@@ -444,8 +455,6 @@ func UpdateServiceLog(c *gin.Context) {
 
 // DeleteServiceLog represents the API handler to remove
 // the logs for a service from the configured backend.
-//
-//nolint:dupl // ignore similar code with step
 func DeleteServiceLog(c *gin.Context) {
 	// capture middleware values
 	b := build.Retrieve(c)
@@ -467,8 +476,18 @@ func DeleteServiceLog(c *gin.Context) {
 		"user":    u.GetName(),
 	}).Infof("deleting logs for service %s", entry)
 
+	// send API call to capture the service logs
+	l, err := database.FromContext(c).GetLogForService(s)
+	if err != nil {
+		retErr := fmt.Errorf("unable to get logs for service %s: %w", entry, err)
+
+		util.HandleError(c, http.StatusInternalServerError, retErr)
+
+		return
+	}
+
 	// send API call to remove the log
-	err := database.FromContext(c).DeleteLog(s.GetID())
+	err = database.FromContext(c).DeleteLog(l)
 	if err != nil {
 		retErr := fmt.Errorf("unable to delete logs for service %s: %w", entry, err)
 
@@ -585,7 +604,7 @@ func CreateStepLog(c *gin.Context) {
 	}
 
 	// send API call to capture the created log
-	l, _ := database.FromContext(c).GetStepLog(s.GetID())
+	l, _ := database.FromContext(c).GetLogForStep(s)
 
 	c.JSON(http.StatusCreated, l)
 }
@@ -656,7 +675,7 @@ func GetStepLog(c *gin.Context) {
 	}).Infof("reading logs for step %s", entry)
 
 	// send API call to capture the step logs
-	l, err := database.FromContext(c).GetStepLog(s.GetID())
+	l, err := database.FromContext(c).GetLogForStep(s)
 	if err != nil {
 		retErr := fmt.Errorf("unable to get logs for step %s: %w", entry, err)
 
@@ -744,7 +763,7 @@ func UpdateStepLog(c *gin.Context) {
 	}).Infof("updating logs for step %s", entry)
 
 	// send API call to capture the step logs
-	l, err := database.FromContext(c).GetStepLog(s.GetID())
+	l, err := database.FromContext(c).GetLogForStep(s)
 	if err != nil {
 		retErr := fmt.Errorf("unable to get logs for step %s: %w", entry, err)
 
@@ -782,7 +801,7 @@ func UpdateStepLog(c *gin.Context) {
 	}
 
 	// send API call to capture the updated log
-	l, _ = database.FromContext(c).GetStepLog(s.GetID())
+	l, _ = database.FromContext(c).GetLogForStep(s)
 
 	c.JSON(http.StatusOK, l)
 }
@@ -830,8 +849,6 @@ func UpdateStepLog(c *gin.Context) {
 
 // DeleteStepLog represents the API handler to remove
 // the logs for a step from the configured backend.
-//
-//nolint:dupl // ignore similar code with service
 func DeleteStepLog(c *gin.Context) {
 	// capture middleware values
 	b := build.Retrieve(c)
@@ -853,8 +870,18 @@ func DeleteStepLog(c *gin.Context) {
 		"user":  u.GetName(),
 	}).Infof("deleting logs for step %s", entry)
 
+	// send API call to capture the step logs
+	l, err := database.FromContext(c).GetLogForStep(s)
+	if err != nil {
+		retErr := fmt.Errorf("unable to get logs for step %s: %w", entry, err)
+
+		util.HandleError(c, http.StatusInternalServerError, retErr)
+
+		return
+	}
+
 	// send API call to remove the log
-	err := database.FromContext(c).DeleteLog(s.GetID())
+	err = database.FromContext(c).DeleteLog(l)
 	if err != nil {
 		retErr := fmt.Errorf("unable to delete logs for step %s: %w", entry, err)
 

api/stream.go

@@ -114,7 +114,7 @@ func PostServiceStream(c *gin.Context) {
 	defer close(done)
 
 	// send API call to capture the service logs
-	_log, err := database.FromContext(c).GetServiceLog(s.GetID())
+	_log, err := database.FromContext(c).GetLogForService(s)
 	if err != nil {
 		retErr := fmt.Errorf("unable to get logs for service %s/%d: %w", entry, s.GetNumber(), err)
 
@@ -269,7 +269,7 @@ func PostStepStream(c *gin.Context) {
 	defer close(done)
 
 	// send API call to capture the step logs
-	_log, err := database.FromContext(c).GetStepLog(s.GetID())
+	_log, err := database.FromContext(c).GetLogForStep(s)
 	if err != nil {
 		retErr := fmt.Errorf("unable to get logs for step %s/%d: %w", entry, s.GetNumber(), err)
 

database/log/count.go

@@ -0,0 +1,25 @@
+// Copyright (c) 2023 Target Brands, Inc. All rights reserved.
+//
+// Use of this source code is governed by the LICENSE file in this repository.
+
+package log
+
+import (
+	"github.com/go-vela/types/constants"
+)
+
+// CountLogs gets the count of all logs from the database.
+func (e *engine) CountLogs() (int64, error) {
+	e.logger.Tracef("getting count of all logs from the database")
+
+	// variable to store query results
+	var l int64
+
+	// send query to the database and store result in variable
+	err := e.client.
+		Table(constants.TableLog).
+		Count(&l).
+		Error
+
+	return l, err
+}

database/log/count_build.go

@@ -0,0 +1,27 @@
+// Copyright (c) 2023 Target Brands, Inc. All rights reserved.
+//
+// Use of this source code is governed by the LICENSE file in this repository.
+
+package log
+
+import (
+	"github.com/go-vela/types/constants"
+	"github.com/go-vela/types/library"
+)
+
+// CountLogsForBuild gets the count of logs by build ID from the database.
+func (e *engine) CountLogsForBuild(b *library.Build) (int64, error) {
+	e.logger.Tracef("getting count of logs for build %d from the database", b.GetID())
+
+	// variable to store query results
+	var l int64
+
+	// send query to the database and store result in variable
+	err := e.client.
+		Table(constants.TableLog).
+		Where("build_id = ?", b.GetID()).
+		Count(&l).
+		Error
+
+	return l, err
+}

database/log/count_build_test.go

@@ -0,0 +1,99 @@
+// Copyright (c) 2023 Target Brands, Inc. All rights reserved.
+//
+// Use of this source code is governed by the LICENSE file in this repository.
+
+package log
+
+import (
+	"reflect"
+	"testing"
+
+	"github.com/DATA-DOG/go-sqlmock"
+)
+
+func TestLog_Engine_CountLogsForBuild(t *testing.T) {
+	// setup types
+	_service := testLog()
+	_service.SetID(1)
+	_service.SetRepoID(1)
+	_service.SetBuildID(1)
+	_service.SetServiceID(1)
+
+	_step := testLog()
+	_step.SetID(2)
+	_step.SetRepoID(1)
+	_step.SetBuildID(1)
+	_step.SetStepID(1)
+
+	_build := testBuild()
+	_build.SetID(1)
+	_build.SetID(1)
+	_build.SetRepoID(1)
+	_build.SetNumber(1)
+
+	_postgres, _mock := testPostgres(t)
+	defer func() { _sql, _ := _postgres.client.DB(); _sql.Close() }()
+
+	// create expected result in mock
+	_rows := sqlmock.NewRows([]string{"count"}).AddRow(2)
+
+	// ensure the mock expects the query
+	_mock.ExpectQuery(`SELECT count(*) FROM "logs" WHERE build_id = $1`).WithArgs(1).WillReturnRows(_rows)
+
+	_sqlite := testSqlite(t)
+	defer func() { _sql, _ := _sqlite.client.DB(); _sql.Close() }()
+
+	err := _sqlite.CreateLog(_service)
+	if err != nil {
+		t.Errorf("unable to create test service log for sqlite: %v", err)
+	}
+
+	err = _sqlite.CreateLog(_step)
+	if err != nil {
+		t.Errorf("unable to create test step log for sqlite: %v", err)
+	}
+
+	// setup tests
+	tests := []struct {
+		failure  bool
+		name     string
+		database *engine
+		want     int64
+	}{
+		{
+			failure:  false,
+			name:     "postgres",
+			database: _postgres,
+			want:     2,
+		},
+		{
+			failure:  false,
+			name:     "sqlite3",
+			database: _sqlite,
+			want:     2,
+		},
+	}
+
+	// run tests
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			got, err := test.database.CountLogsForBuild(_build)
+
+			if test.failure {
+				if err == nil {
+					t.Errorf("CountLogsForBuild for %s should have returned err", test.name)
+				}
+
+				return
+			}
+
+			if err != nil {
+				t.Errorf("CountLogsForBuild for %s returned err: %v", test.name, err)
+			}
+
+			if !reflect.DeepEqual(got, test.want) {
+				t.Errorf("CountLogsForBuild for %s is %v, want %v", test.name, got, test.want)
+			}
+		})
+	}
+}