Add some tests to get started (#104)

Author: dkhalife

.github/workflows/go-build.yml

@@ -32,3 +32,6 @@ jobs:
 
     - name: Lint
       run: golangci-lint run
+
+    - name: Run Tests and Generate Coverage
+      run: go test -v -coverprofile=coverage.out ./...

.gitignore

@@ -3,3 +3,4 @@ core
 tmp
 task-wizard.db
 .vscode/launch.json
+coverage.out

go.mod

@@ -17,7 +17,17 @@ require (
 	gorm.io/gorm v1.25.10
 )
 
-require github.com/wneessen/go-mail v0.6.2
+require (
+	github.com/stretchr/testify v1.10.0
+	github.com/wneessen/go-mail v0.6.2
+	gorm.io/driver/sqlite v1.5.7
+)
+
+require (
+	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
+	github.com/mattn/go-sqlite3 v1.14.22 // indirect
+	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
+)
 
 require (
 	github.com/bytedance/sonic v1.11.8 // indirect

go.sum

@@ -75,6 +75,8 @@ github.com/magiconair/properties v1.8.7 h1:IeQXZAiQcpL9mgcAe1Nu6cX9LLw6ExEHKjN0V
 github.com/magiconair/properties v1.8.7/go.mod h1:Dhd985XPs7jluiymwWYZ0G4Z61jb3vdS329zhj2hYo0=
 github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
 github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
+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/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyuac5Z2hdY=
 github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=
 github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=
@@ -119,8 +121,9 @@ github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/
 github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
 github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
 github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
-github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
 github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
+github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 github.com/subosito/gotenv v1.6.0 h1:9NlTDc1FTs4qu0DDq7AEtTPNw6SVm7uBMsUCUjABIf8=
 github.com/subosito/gotenv v1.6.0/go.mod h1:Dk4QP5c2W3ibzajGcXpNraDfq2IrhjMIvMSWPKKo0FU=
 github.com/tidwall/gjson v1.17.0 h1:/Jocvlh98kcTfpN2+JzGQWQcqrPQwDrVEMApx/M5ZwM=
@@ -237,6 +240,8 @@ gopkg.in/ini.v1 v1.67.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gorm.io/driver/sqlite v1.5.7 h1:8NvsrhP0ifM7LX9G4zPB97NwovUakUxc+2V2uuf3Z1I=
+gorm.io/driver/sqlite v1.5.7/go.mod h1:U+J8craQU6Fzkcvu8oLeAQmi50TkwPEhHDEjQZXDah4=
 gorm.io/gorm v1.25.10 h1:dQpO+33KalOA+aFYGlK+EfxcI5MbO7EP2yYygwh9h+s=
 gorm.io/gorm v1.25.10/go.mod h1:hbnx/Oo0ChWMn1BIhpy1oYozzpM15i4YPuHDmfYtwg8=
 modernc.org/cc/v4 v4.21.4 h1:3Be/Rdo1fpr8GrQ7IVw9OHtplU4gWbb+wNgeoBMmGLQ=

internal/utils/auth/auth_test.go

@@ -0,0 +1,33 @@
+package auth
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestEncodePasswordAndMatches(t *testing.T) {
+	password := "securepassword"
+	hashedPassword, err := EncodePassword(password)
+	assert.NoError(t, err)
+	assert.NoError(t, Matches(hashedPassword, password))
+	assert.Error(t, Matches(hashedPassword, "wrongpassword"))
+}
+
+func TestEncodeAndDecodeEmailAndCode(t *testing.T) {
+	email := "user@example.com"
+	code := "reset-code"
+
+	encoded := EncodeEmailAndCode(email, code)
+	decodedEmail, decodedCode, err := DecodeEmailAndCode(encoded)
+
+	assert.NoError(t, err)
+	assert.Equal(t, email, decodedEmail)
+	assert.Equal(t, code, decodedCode)
+}
+
+func TestGenerateEmailResetToken(t *testing.T) {
+	token, err := GenerateEmailResetToken(nil)
+	assert.NoError(t, err)
+	assert.NotEmpty(t, token)
+}

internal/utils/database/database_test.go

@@ -0,0 +1,27 @@
+package database
+
+import (
+	"testing"
+
+	"dkhalife.com/tasks/core/config"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestNewDatabase(t *testing.T) {
+	// Mock configuration
+	cfg := &config.Config{
+		Database: config.DatabaseConfig{
+			FilePath: ":memory:", // Use in-memory SQLite database for testing
+		},
+	}
+
+	// Test database connection
+	db, err := NewDatabase(cfg)
+	assert.NoError(t, err)
+	assert.NotNil(t, db)
+
+	// Verify the connection
+	sqlDB, err := db.DB()
+	assert.NoError(t, err)
+	assert.NoError(t, sqlDB.Ping())
+}

internal/utils/middleware/middleware_test.go

@@ -0,0 +1,50 @@
+package middleware
+
+import (
+	"net/http"
+	"net/http/httptest"
+	"testing"
+	"time"
+
+	"dkhalife.com/tasks/core/config"
+	"github.com/gin-gonic/gin"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestRateLimitMiddleware(t *testing.T) {
+	cfg := &config.Config{
+		Server: config.ServerConfig{
+			RateLimit:  1,
+			RatePeriod: time.Second,
+		},
+	}
+	limiter := NewRateLimiter(cfg)
+
+	router := gin.New()
+	router.Use(RateLimitMiddleware(limiter))
+	router.GET("/", func(c *gin.Context) {
+		c.String(http.StatusOK, "OK")
+	})
+
+	w := httptest.NewRecorder()
+	req, _ := http.NewRequest("GET", "/", nil)
+	router.ServeHTTP(w, req)
+	assert.Equal(t, http.StatusOK, w.Code)
+
+	w = httptest.NewRecorder()
+	router.ServeHTTP(w, req)
+	assert.Equal(t, http.StatusTooManyRequests, w.Code)
+}
+
+func TestRequestLogger(t *testing.T) {
+	router := gin.New()
+	router.Use(RequestLogger())
+	router.GET("/", func(c *gin.Context) {
+		c.String(http.StatusOK, "OK")
+	})
+
+	w := httptest.NewRecorder()
+	req, _ := http.NewRequest("GET", "/", nil)
+	router.ServeHTTP(w, req)
+	assert.Equal(t, http.StatusOK, w.Code)
+}

internal/utils/migration/migration_test.go

@@ -0,0 +1,34 @@
+package migration
+
+import (
+	"testing"
+
+	"dkhalife.com/tasks/core/internal/models"
+	"github.com/stretchr/testify/assert"
+	"gorm.io/driver/sqlite"
+	"gorm.io/gorm"
+)
+
+func TestMigration(t *testing.T) {
+	// Create an in-memory SQLite database for testing
+	db, err := gorm.Open(sqlite.Open(":memory:"), &gorm.Config{})
+	assert.NoError(t, err)
+
+	// Run the migration
+	err = Migration(db)
+	assert.NoError(t, err)
+
+	// Verify that tables were created
+	for _, model := range []interface{}{
+		&models.User{},
+		&models.UserPasswordReset{},
+		&models.AppToken{},
+		&models.Label{},
+		&models.Task{},
+		&models.TaskHistory{},
+		&models.NotificationSettings{},
+		&models.Notification{},
+	} {
+		assert.True(t, db.Migrator().HasTable(model), "Table for model should exist")
+	}
+}