Added some db unit tests

Author: jc21

backend/go.mod

@@ -3,6 +3,7 @@ module npm
 go 1.20
 
 require (
+	github.com/DATA-DOG/go-sqlmock v1.5.0
 	github.com/alexflint/go-arg v1.4.3
 	github.com/amacneil/dbmate/v2 v2.3.0
 	github.com/aymerick/raymond v2.0.3-0.20180322193309-b565731e1464+incompatible

backend/go.sum

@@ -139,7 +139,11 @@ func DeleteUser() func(http.ResponseWriter, *http.Request) {
 		case sql.ErrNoRows:
 			h.NotFound(w, r)
 		case nil:
-			h.ResultResponseJSON(w, r, http.StatusOK, item.Delete())
+			if err := item.Delete(); err != nil {
+				h.ResultErrorJSON(w, r, http.StatusBadRequest, err.Error(), nil)
+			} else {
+				h.ResultResponseJSON(w, r, http.StatusOK, true)
+			}
 		default:
 			h.ResultErrorJSON(w, r, http.StatusBadRequest, err.Error(), nil)
 		}

backend/internal/api/handler/users.go

@@ -37,6 +37,12 @@ func GetDB() *gorm.DB {
 	return dbInstance
 }
 
+// SetDB will set the dbOnstance to this
+// Used by unit testing to set the db to a mock database
+func SetDB(db *gorm.DB) {
+	dbInstance = db
+}
+
 func connect() (*gorm.DB, error) {
 	var d gorm.Dialector
 	dsn := config.Configuration.DB.GetGormConnectURL()

backend/internal/database/db.go

@@ -64,12 +64,13 @@ func (m *Model) LoadByEmail(email string) error {
 
 // Save will save this model to the DB
 func (m *Model) Save() error {
-	// Ensure email is nice
-	m.Email = strings.TrimSpace(strings.ToLower(m.Email))
 	if m.IsSystem {
 		return errors.ErrSystemUserReadonly
 	}
 
+	// Ensure email is nice
+	m.Email = strings.TrimSpace(strings.ToLower(m.Email))
+
 	// Check if an existing user with this email exists
 	if m2, err := GetByEmail(m.Email); err == nil && m.ID != m2.ID {
 		return errors.ErrDuplicateEmailUser
@@ -81,14 +82,14 @@ func (m *Model) Save() error {
 }
 
 // Delete will mark a user as deleted
-func (m *Model) Delete() bool {
+func (m *Model) Delete() error {
 	if m.ID == 0 {
 		// Can't delete a new object
-		return false
+		return eris.New("Unable to delete a new object")
 	}
 	db := database.GetDB()
 	result := db.Delete(m)
-	return result.Error == nil
+	return result.Error
 }
 
 // SetPermissions will wipe out any existing permissions and add new ones for this user

backend/internal/entity/user/model.go

@@ -0,0 +1,154 @@
+package user
+
+import (
+	"regexp"
+	"testing"
+
+	"npm/internal/errors"
+	"npm/internal/model"
+	"npm/internal/test"
+
+	"github.com/DATA-DOG/go-sqlmock"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"github.com/stretchr/testify/suite"
+)
+
+// +------------+
+// | Setup      |
+// +------------+
+
+type testsuite struct {
+	suite.Suite
+	mock      sqlmock.Sqlmock
+	singleRow *sqlmock.Rows
+}
+
+// SetupTest is executed before each test
+func (s *testsuite) SetupTest() {
+	var err error
+	s.mock, err = test.Setup()
+	require.NoError(s.T(), err)
+
+	s.singleRow = sqlmock.NewRows([]string{
+		"id",
+		"name",
+		"nickname",
+		"email",
+		"is_disabled",
+		"is_system",
+	}).AddRow(
+		10,
+		"John Doe",
+		"Jonny",
+		"[email protected]",
+		false,
+		false,
+	)
+}
+
+// In order for 'go test' to run this suite, we need to create
+// a normal test function and pass our suite to suite.Run
+func TestExampleTestSuite(t *testing.T) {
+	suite.Run(t, new(testsuite))
+}
+
+// +------------+
+// | Tests      |
+// +------------+
+
+func (s *testsuite) TestLoadByID() {
+	s.mock.
+		ExpectQuery(regexp.QuoteMeta(`SELECT * FROM "user" WHERE "user"."id" = $1 AND "user"."is_deleted" = $2 ORDER BY "user"."id" LIMIT 1`)).
+		WithArgs(10, 0).
+		WillReturnRows(s.singleRow)
+
+	m := Model{}
+	err := m.LoadByID(10)
+	require.NoError(s.T(), err)
+	require.NoError(s.T(), s.mock.ExpectationsWereMet())
+}
+
+func (s *testsuite) TestLoadByEmail() {
+	s.mock.
+		ExpectQuery(regexp.QuoteMeta(`SELECT * FROM "user" WHERE email = $1 AND is_system = $2 AND "user"."is_deleted" = $3 ORDER BY "user"."id" LIMIT 1`)).
+		WithArgs("[email protected]", false, 0).
+		WillReturnRows(s.singleRow)
+
+	m := Model{}
+	err := m.LoadByEmail("[email protected]")
+	require.NoError(s.T(), err)
+	require.NoError(s.T(), s.mock.ExpectationsWereMet())
+}
+
+func (s *testsuite) TestSave() {
+	s.mock.
+		ExpectQuery(regexp.QuoteMeta(`SELECT * FROM "user" WHERE email = $1 AND is_system = $2 AND "user"."is_deleted" = $3 ORDER BY "user"."id" LIMIT 1`)).
+		WithArgs("[email protected]", false, 0).
+		WillReturnRows(s.singleRow)
+
+	s.mock.ExpectBegin()
+	s.mock.ExpectQuery(regexp.QuoteMeta(`INSERT INTO "user" ("created_at","updated_at","is_deleted","name","nickname","email","is_disabled","is_system") VALUES ($1,$2,$3,$4,$5,$6,$7,$8) RETURNING "id"`)).
+		WithArgs(
+			sqlmock.AnyArg(),
+			sqlmock.AnyArg(),
+			0,
+			"John Doe",
+			"Jonny",
+			"[email protected]",
+			false,
+			false,
+		).
+		WillReturnRows(sqlmock.NewRows([]string{"id"}).AddRow("11"))
+	s.mock.ExpectCommit()
+
+	// New model, as system
+	m := Model{
+		Name:     "John Doe",
+		Nickname: "Jonny",
+		Email:    "[email protected]", // mixed case on purpose
+		IsSystem: true,
+	}
+	err := m.Save()
+	assert.Equal(s.T(), errors.ErrSystemUserReadonly.Error(), err.Error())
+
+	// Remove system and try again. Expect error due to duplicate email
+	m.IsSystem = false
+	err = m.Save()
+	assert.Equal(s.T(), errors.ErrDuplicateEmailUser.Error(), err.Error())
+
+	// Change email and try again. Expect success
+	m.Email = "[email protected]"
+	err = m.Save()
+	require.NoError(s.T(), err)
+	require.NoError(s.T(), s.mock.ExpectationsWereMet())
+}
+
+func (s *testsuite) TestDelete() {
+	s.mock.ExpectBegin()
+	s.mock.
+		ExpectExec(regexp.QuoteMeta(`UPDATE "user" SET "is_deleted"=$1 WHERE "user"."id" = $2 AND "user"."is_deleted" = $3`)).
+		WithArgs(1, 10, 0).
+		WillReturnResult(sqlmock.NewResult(0, 1))
+	s.mock.ExpectCommit()
+
+	m := Model{}
+	err := m.Delete()
+	assert.Equal(s.T(), "Unable to delete a new object", err.Error())
+
+	m2 := Model{
+		ModelBase: model.ModelBase{
+			ID: 10,
+		},
+		Name: "John Doe",
+	}
+	err2 := m2.Delete()
+	require.NoError(s.T(), err2)
+	require.NoError(s.T(), s.mock.ExpectationsWereMet())
+}
+
+func (s *testsuite) TestGenerateGravatar() {
+	m := Model{Email: "[email protected]"}
+	m.generateGravatar()
+	assert.Equal(s.T(), "https://www.gravatar.com/avatar/dc36565cc2376197358fa27ed4c47253?d=mm&r=pg&s=128", m.GravatarURL)
+}

backend/internal/entity/user/model_test.go

@@ -0,0 +1,23 @@
+package test
+
+import (
+	"npm/internal/database"
+
+	"github.com/DATA-DOG/go-sqlmock"
+	"gorm.io/driver/postgres"
+	"gorm.io/gorm"
+)
+
+func Setup() (sqlmock.Sqlmock, error) {
+	db, mock, err := sqlmock.New()
+	if err != nil {
+		return nil, err
+	}
+	dialector := postgres.New(postgres.Config{
+		Conn:       db,
+		DriverName: "postgres",
+	})
+	gormDB, err := gorm.Open(dialector, &gorm.Config{})
+	database.SetDB(gormDB)
+	return mock, err
+}