From f13230cabadf75bbf4cd22037cd169d3edc5b906 Mon Sep 17 00:00:00 2001 From: qpismont Date: Tue, 25 Feb 2025 20:55:12 +0000 Subject: [PATCH] add unit tests helpers --- cmd/api/main.go | 2 +- go.mod | 5 ++ go.sum | 12 ++++ internal/accounts/const.go | 6 ++ internal/accounts/model.go | 10 ++++ internal/accounts/repository.go | 35 ++++++++++++ internal/accounts/repository_test.go | 48 ++++++++++++++++ internal/core/database_test.go | 38 +++++++++++++ internal/core/helpers.go | 6 +- internal/core/helpers_test.go | 17 ++++++ internal/core/http.go | 1 + test/fixtures/00-accounts.sql | 2 + test/helpers.go | 84 ++++++++++++++++++++++++++++ 13 files changed, 262 insertions(+), 4 deletions(-) create mode 100644 internal/accounts/const.go create mode 100644 internal/accounts/model.go create mode 100644 internal/accounts/repository_test.go create mode 100644 internal/core/database_test.go create mode 100644 internal/core/helpers_test.go create mode 100644 test/fixtures/00-accounts.sql create mode 100644 test/helpers.go diff --git a/cmd/api/main.go b/cmd/api/main.go index c29443d..c3545bc 100644 --- a/cmd/api/main.go +++ b/cmd/api/main.go @@ -22,7 +22,7 @@ var ascii string func main() { fmt.Println(ascii) - core.LoadEnvVars() + core.LoadEnvVars(".env") db := setupDB() router := setupRouter(db) diff --git a/go.mod b/go.mod index 7c5edac..97d1152 100644 --- a/go.mod +++ b/go.mod @@ -6,14 +6,19 @@ require ( github.com/jackc/pgx v3.6.2+incompatible github.com/jmoiron/sqlx v1.4.0 github.com/joho/godotenv v1.5.1 + github.com/magiconair/properties v1.8.9 + github.com/stretchr/testify v1.10.0 ) require ( github.com/cockroachdb/apd v1.1.0 // indirect + github.com/davecgh/go-spew v1.1.1 // indirect github.com/gofrs/uuid v4.4.0+incompatible // indirect github.com/jackc/fake v0.0.0-20150926172116-812a484cc733 // indirect github.com/pkg/errors v0.9.1 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect github.com/shopspring/decimal v1.4.0 // indirect golang.org/x/crypto v0.33.0 // indirect golang.org/x/text v0.22.0 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect ) diff --git a/go.sum b/go.sum index 239523b..29b24b3 100644 --- a/go.sum +++ b/go.sum @@ -2,6 +2,8 @@ filippo.io/edwards25519 v1.1.0 h1:FNf4tywRC1HmFuKW5xopWpigGjJKiJSV0Cqo0cJWDaA= filippo.io/edwards25519 v1.1.0/go.mod h1:BxyFTGdWcka3PhytdK4V28tE5sGfRvvvRV7EaN4VDT4= github.com/cockroachdb/apd v1.1.0 h1:3LFP3629v+1aKXU5Q37mxmRxX/pIu1nijXydLShEq5I= github.com/cockroachdb/apd v1.1.0/go.mod h1:8Sl8LxpKi29FqWXR16WEFZRNSz3SoPzUzeMeY4+DwBQ= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/go-sql-driver/mysql v1.8.1 h1:LedoTUt/eveggdHS9qUFC1EFSa8bU2+1pZjSRpvNJ1Y= github.com/go-sql-driver/mysql v1.8.1/go.mod h1:wEBSXgmK//2ZFJyE+qWnIsVGmvmEKlqwuVSjsCm7DZg= github.com/gofrs/uuid v4.4.0+incompatible h1:3qXRTX8/NbyulANqlc0lchS1gqAVxRgsuW1YrTJupqA= @@ -16,13 +18,23 @@ github.com/joho/godotenv v1.5.1 h1:7eLL/+HRGLY0ldzfGMeQkb7vMd0as4CfYvUVzLqw0N0= github.com/joho/godotenv v1.5.1/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4= github.com/lib/pq v1.10.9 h1:YXG7RB+JIjhP29X+OtkiDnYaXQwpS4JEWq7dtCCRUEw= github.com/lib/pq v1.10.9/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o= +github.com/magiconair/properties v1.8.9 h1:nWcCbLq1N2v/cpNsy5WvQ37Fb+YElfq20WJ/a8RkpQM= +github.com/magiconair/properties v1.8.9/go.mod h1:Dhd985XPs7jluiymwWYZ0G4Z61jb3vdS329zhj2hYo0= github.com/mattn/go-sqlite3 v1.14.22 h1:2gZY6PC6kBnID23Tichd1K+Z0oS6nE/XwU+Vz/5o4kU= github.com/mattn/go-sqlite3 v1.14.22/go.mod h1:Uh1q+B4BYcTPb+yiD3kU8Ct7aC0hY9fxUwlHK0RXw+Y= github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/shopspring/decimal v1.4.0 h1:bxl37RwXBklmTi0C79JfXCEBD1cqqHt0bbgBAGFp81k= github.com/shopspring/decimal v1.4.0/go.mod h1:gawqmDU56v4yIKSwfBSFip1HdCCXN8/+DMd9qYNcwME= +github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA= +github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= golang.org/x/crypto v0.33.0 h1:IOBPskki6Lysi0lo9qQvbxiQ+FvsCC/YWOecCHAixus= golang.org/x/crypto v0.33.0/go.mod h1:bVdXmD7IV/4GdElGPozy6U7lWdRXA4qyRVGJV57uQ5M= golang.org/x/text v0.22.0 h1:bofq7m3/HAFvbF51jz3Q9wLg3jkvSPuiZu/pD1XwgtM= golang.org/x/text v0.22.0/go.mod h1:YRoo4H8PVmsu+E3Ou7cqLVH8oXWIHVoX0jqUWALQhfY= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/internal/accounts/const.go b/internal/accounts/const.go new file mode 100644 index 0000000..6e417dd --- /dev/null +++ b/internal/accounts/const.go @@ -0,0 +1,6 @@ +package accounts + +const ( + SqlInsert = "INSERT INTO accounts (username, password, role_id) VALUES ($1, $2, $3) RETURNING id" + SqlFetchOneByUsername = "SELECT * FROM accounts WHERE username = $1" +) diff --git a/internal/accounts/model.go b/internal/accounts/model.go new file mode 100644 index 0000000..fad9d86 --- /dev/null +++ b/internal/accounts/model.go @@ -0,0 +1,10 @@ +package accounts + +type Account struct { + Id int `db:"id" json:"id"` + Username string `db:"username" json:"username"` + Password string `db:"password" json:"-"` + RoleId int `db:"role_id" json:"role_id"` + CreatedAt string `db:"created_at" json:"created_at"` + UpdatedAt string `db:"updated_at" json:"updated_at"` +} diff --git a/internal/accounts/repository.go b/internal/accounts/repository.go index 11adc24..59da0f5 100644 --- a/internal/accounts/repository.go +++ b/internal/accounts/repository.go @@ -1,6 +1,8 @@ package accounts import ( + "database/sql" + "github.com/jmoiron/sqlx" ) @@ -11,3 +13,36 @@ type Repository struct { func NewRepository(db *sqlx.DB) Repository { return Repository{db: db} } + +func (r *Repository) Insert(account *Account) (int, error) { + var id int + + stmt, err := r.db.Prepare(SqlInsert) + if err != nil { + return id, err + } + + defer stmt.Close() + + err = stmt.QueryRow(account.Username, account.Password, account.RoleId).Scan(&id) + if err != nil { + return id, err + } + + return id, nil +} + +func (r *Repository) FetchOneByUsername(username string) (*Account, error) { + var account Account + + err := r.db.Get(&account, SqlFetchOneByUsername, username) + if err != nil { + if err == sql.ErrNoRows { + return nil, nil + } else { + return nil, err + } + } + + return &account, nil +} diff --git a/internal/accounts/repository_test.go b/internal/accounts/repository_test.go new file mode 100644 index 0000000..f4b9d39 --- /dev/null +++ b/internal/accounts/repository_test.go @@ -0,0 +1,48 @@ +package accounts + +import ( + "testing" + + "gitea.qpismont.fr/qpismont/trepa/test" + "github.com/magiconair/properties/assert" +) + +func TestRepository_Insert(t *testing.T) { + db := test.SetupTestDB(t, "../../") + defer db.Close() + + repo := NewRepository(db) + + account := &Account{ + Username: "test", + Password: "test", + RoleId: 1, + } + + id, err := repo.Insert(account) + if err != nil { + t.Fatalf("Failed to insert account: %v", err) + } + + assert.Equal(t, id, 3) +} + +func TestRepository_FetchOneByUsername(t *testing.T) { + db := test.SetupTestDB(t, "../../") + defer db.Close() + + repo := NewRepository(db) + + account, err := repo.FetchOneByUsername("admin") + if err != nil { + t.Fatalf("Failed to fetch account: %v", err) + } + + if account == nil { + t.Fatalf("Account not found") + } + + assert.Equal(t, account.Username, "admin") + assert.Equal(t, account.Password, "LOLPASSWORD") + assert.Equal(t, account.RoleId, 1) +} diff --git a/internal/core/database_test.go b/internal/core/database_test.go new file mode 100644 index 0000000..89fb4ed --- /dev/null +++ b/internal/core/database_test.go @@ -0,0 +1,38 @@ +package core + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestComputeDBURL(t *testing.T) { + LoadEnvVars("../../.env") + + dbHost := MustGetEnvVar("TEST_DB_HOST") + dbPort := MustGetEnvVar("TEST_DB_PORT") + dbUser := MustGetEnvVar("TEST_DB_USER") + dbPassword := MustGetEnvVar("TEST_DB_PASSWORD") + dbName := MustGetEnvVar("TEST_DB_NAME") + + dbURL := ComputeDBURL(dbHost, dbPort, dbUser, dbPassword, dbName) + + assert.Equal(t, dbURL, "postgres://dev:dev@host.docker.internal:5432/trepa_test") +} + +func TestSetupDB(t *testing.T) { + LoadEnvVars("../../.env") + + dbHost := MustGetEnvVar("TEST_DB_HOST") + dbPort := MustGetEnvVar("TEST_DB_PORT") + dbUser := MustGetEnvVar("TEST_DB_USER") + dbPassword := MustGetEnvVar("TEST_DB_PASSWORD") + dbName := MustGetEnvVar("TEST_DB_NAME") + + dbURL := ComputeDBURL(dbHost, dbPort, dbUser, dbPassword, dbName) + db, err := SetupDB(dbURL) + defer db.Close() + + assert.NoError(t, err) + assert.NotNil(t, db) +} diff --git a/internal/core/helpers.go b/internal/core/helpers.go index d09a742..f44fb17 100644 --- a/internal/core/helpers.go +++ b/internal/core/helpers.go @@ -7,10 +7,10 @@ import ( "github.com/joho/godotenv" ) -func LoadEnvVars() { - err := godotenv.Load() +func LoadEnvVars(path string) { + err := godotenv.Load(path) if err != nil { - slog.Warn("Error loading .env file") + slog.Warn("Error loading .env file", "path", path) } } diff --git a/internal/core/helpers_test.go b/internal/core/helpers_test.go new file mode 100644 index 0000000..79e1b16 --- /dev/null +++ b/internal/core/helpers_test.go @@ -0,0 +1,17 @@ +package core + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestMustGetEnvVar(t *testing.T) { + LoadEnvVars("../../.env") + + assert.Equal(t, MustGetEnvVar("TEST_DB_HOST"), "host.docker.internal") + assert.Equal(t, MustGetEnvVar("TEST_DB_PORT"), "5432") + assert.Equal(t, MustGetEnvVar("TEST_DB_USER"), "dev") + assert.Equal(t, MustGetEnvVar("TEST_DB_PASSWORD"), "dev") + assert.Equal(t, MustGetEnvVar("TEST_DB_NAME"), "trepa_test") +} diff --git a/internal/core/http.go b/internal/core/http.go index c3447a3..23fb068 100644 --- a/internal/core/http.go +++ b/internal/core/http.go @@ -39,6 +39,7 @@ func (r *Response) Write(b []byte) (int, error) { return n, err } +// Implement http.Handler type ServerMux struct { mux *http.ServeMux } diff --git a/test/fixtures/00-accounts.sql b/test/fixtures/00-accounts.sql new file mode 100644 index 0000000..bc38a90 --- /dev/null +++ b/test/fixtures/00-accounts.sql @@ -0,0 +1,2 @@ +INSERT INTO accounts (username, password, role_id) VALUES ('admin', 'LOLPASSWORD', 1); +INSERT INTO accounts (username, password, role_id) VALUES ('user', 'LOLPASSWORD', 2); diff --git a/test/helpers.go b/test/helpers.go new file mode 100644 index 0000000..7ac8be0 --- /dev/null +++ b/test/helpers.go @@ -0,0 +1,84 @@ +package test + +import ( + "os" + "path/filepath" + "testing" + + "gitea.qpismont.fr/qpismont/trepa/internal/core" + "github.com/jmoiron/sqlx" +) + +func SetupTestDB(test *testing.T, rootPath string) *sqlx.DB { + core.LoadEnvVars(rootPath + "/.env") + + dbHost := core.MustGetEnvVar("TEST_DB_HOST") + dbPort := core.MustGetEnvVar("TEST_DB_PORT") + dbUser := core.MustGetEnvVar("TEST_DB_USER") + dbPassword := core.MustGetEnvVar("TEST_DB_PASSWORD") + dbName := core.MustGetEnvVar("TEST_DB_NAME") + + dbExecute := initTestDB(test, dbHost, dbPort, dbUser, dbPassword, "postgres") + resetTestDB(dbExecute, test, dbName) + dbExecute.Close() + + dbTest := initTestDB(test, dbHost, dbPort, dbUser, dbPassword, dbName) + executeMigrations(dbTest, test, rootPath) + executeFixtures(dbTest, test, rootPath) + + return dbTest +} + +func initTestDB(t *testing.T, dbHost, dbPort, dbUser, dbPassword, dbName string) *sqlx.DB { + dbURL := core.ComputeDBURL(dbHost, dbPort, dbUser, dbPassword, dbName) + db, err := core.SetupDB(dbURL) + if err != nil { + t.Fatalf("Failed to connect to test database: %v", err) + } + + return db +} + +func resetTestDB(db *sqlx.DB, t *testing.T, dbName string) { + _, err := db.Exec("DROP DATABASE IF EXISTS " + dbName + " WITH (FORCE);") + if err != nil { + t.Fatalf("Failed to drop test database: %v", err) + } + + _, err = db.Exec("CREATE DATABASE " + dbName + ";") + if err != nil { + t.Fatalf("Failed to create test database: %v", err) + } +} +func executeMigrations(db *sqlx.DB, t *testing.T, rootPath string) { + rootPath = filepath.Join(rootPath, "migrations") + + executeSqlFolder(db, t, rootPath) +} + +func executeFixtures(db *sqlx.DB, t *testing.T, rootPath string) { + rootPath = filepath.Join(rootPath, "test", "fixtures") + + executeSqlFolder(db, t, rootPath) +} + +func executeSqlFolder(db *sqlx.DB, t *testing.T, folder string) { + files, err := filepath.Glob(folder + "/*.sql") + if err != nil { + t.Fatalf("Failed to read sql folder: %v", err) + } + + for _, file := range files { + t.Log("Executing " + file) + + sql, err := os.ReadFile(file) + if err != nil { + t.Fatalf("Failed to read sql file: %v", err) + } + + _, err = db.Exec(string(sql)) + if err != nil { + t.Fatalf("Failed to execute sql file: %v", err) + } + } +}