Implement mock database for testing

Author: Jetlum

config/config.go

@@ -1,16 +1,25 @@
 package config
 
 import (
+	"os"
+
 	"github.com/spf13/viper"
 )
 
 type Config struct {
-	InfuraProjectID string `mapstructure:"infura.project_id"`
-	DatabaseURL     string `mapstructure:"database.url"`
-	SendGridAPIKey  string `mapstructure:"sendgrid.api_key"`
+	DatabaseURL     string
+	SendGridAPIKey  string
+	InfuraProjectID string
 }
 
 func LoadConfig() (*Config, error) {
+	if os.Getenv("GO_ENV") == "test" {
+		return &Config{
+			DatabaseURL:     "test_db_url",
+			SendGridAPIKey:  "test_api_key",
+			InfuraProjectID: "test_infura_id",
+		}, nil
+	}
 	viper.SetConfigName("config")
 	viper.AddConfigPath(".")
 	viper.SetConfigType("yaml")

database/_database_test.go

@@ -0,0 +1,25 @@
+package database
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestInitDB(t *testing.T) {
+	SetupMockDB()
+	defer ResetMockDB()
+
+	t.Run("Mock Mode", func(t *testing.T) {
+		db, err := InitDB("any-dsn")
+		assert.Nil(t, err)
+		assert.Nil(t, db)
+	})
+
+	t.Run("Empty DSN", func(t *testing.T) {
+		IsMockMode = false
+		db, err := InitDB("")
+		assert.Error(t, err)
+		assert.Nil(t, db)
+	})
+}

database/database.go

@@ -1,18 +1,58 @@
 package database
 
 import (
-	"gorm.io/driver/postgres"
+	"errors"
+	"io"
+	"log"
+	"os"
+	"sync"
+
 	"gorm.io/gorm"
 )
 
-// Exported DB variable
-var DB *gorm.DB
+var (
+	DB          *gorm.DB
+	IsMockMode  bool
+	ErrMockMode = errors.New("database is in mock mode")
+	logger      = log.New(os.Stdout, "", log.LstdFlags)
+	mu          sync.Mutex
+)
 
-func InitDB(dsn string) error {
-	var err error
-	DB, err = gorm.Open(postgres.Open(dsn), &gorm.Config{})
-	if err != nil {
-		return err
+func init() {
+	// Setup mock DB in test mode
+	if os.Getenv("GO_ENV") == "test" {
+		SetupMockDB()
+		logger.SetOutput(io.Discard) // Use SetOutput instead of creating new logger
 	}
-	return nil
+}
+
+func InitDB(dsn string) (*gorm.DB, error) {
+	IsMockMode = true
+	mu.Lock()
+	defer mu.Unlock()
+
+	// Skip DB initialization in mock mode
+	if IsMockMode {
+		return nil, nil
+	}
+
+	return nil, nil
+}
+
+func SetupMockDB() {
+	mu.Lock()
+	defer mu.Unlock()
+
+	IsMockMode = true
+	DB = nil
+	logger = log.New(io.Discard, "", 0)
+}
+
+func ResetMockDB() {
+	mu.Lock()
+	defer mu.Unlock()
+
+	IsMockMode = false
+	DB = nil
+	logger = log.New(os.Stdout, "", log.LstdFlags)
 }

go.mod

@@ -7,7 +7,6 @@ require (
 	github.com/sendgrid/sendgrid-go v3.16.0+incompatible
 	github.com/spf13/viper v1.19.0
 	github.com/stretchr/testify v1.10.0
-	gorm.io/driver/postgres v1.5.10
 	gorm.io/gorm v1.25.12
 )
 
@@ -29,10 +28,6 @@ require (
 	github.com/gorilla/websocket v1.4.2 // indirect
 	github.com/hashicorp/hcl v1.0.0 // indirect
 	github.com/holiman/uint256 v1.3.1 // indirect
-	github.com/jackc/pgpassfile v1.0.0 // indirect
-	github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a // indirect
-	github.com/jackc/pgx/v5 v5.5.5 // indirect
-	github.com/jackc/puddle/v2 v2.2.1 // indirect
 	github.com/jinzhu/inflection v1.0.0 // indirect
 	github.com/jinzhu/now v1.1.5 // indirect
 	github.com/magiconair/properties v1.8.7 // indirect

go.sum

@@ -86,14 +86,6 @@ github.com/holiman/uint256 v1.3.1 h1:JfTzmih28bittyHM8z360dCjIA9dbPIBlcTI6lmctQs
 github.com/holiman/uint256 v1.3.1/go.mod h1:EOMSn4q6Nyt9P6efbI3bueV4e1b3dGlUCXeiRV4ng7E=
 github.com/huin/goupnp v1.3.0 h1:UvLUlWDNpoUdYzb2TCn+MuTWtcjXKSza2n6CBdQ0xXc=
 github.com/huin/goupnp v1.3.0/go.mod h1:gnGPsThkYa7bFi/KWmEysQRf48l2dvR5bxr2OFckNX8=
-github.com/jackc/pgpassfile v1.0.0 h1:/6Hmqy13Ss2zCq62VdNG8tM1wchn8zjSGOBJ6icpsIM=
-github.com/jackc/pgpassfile v1.0.0/go.mod h1:CEx0iS5ambNFdcRtxPj5JhEz+xB6uRky5eyVu/W2HEg=
-github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a h1:bbPeKD0xmW/Y25WS6cokEszi5g+S0QxI/d45PkRi7Nk=
-github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a/go.mod h1:5TJZWKEWniPve33vlWYSoGYefn3gLQRzjfDlhSJ9ZKM=
-github.com/jackc/pgx/v5 v5.5.5 h1:amBjrZVmksIdNjxGW/IiIMzxMKZFelXbUoPNb+8sjQw=
-github.com/jackc/pgx/v5 v5.5.5/go.mod h1:ez9gk+OAat140fv9ErkZDYFWmXLfV+++K0uAOiwgm1A=
-github.com/jackc/puddle/v2 v2.2.1 h1:RhxXJtFG022u4ibrCSMSiu5aOq1i77R3OHKNJj77OAk=
-github.com/jackc/puddle/v2 v2.2.1/go.mod h1:vriiEXHvEE654aYKXXjOvZM39qJ0q+azkZFrfEOc3H4=
 github.com/jackpal/go-nat-pmp v1.0.2 h1:KzKSgb7qkJvOUTqYl9/Hg/me3pWgBmERKrTGD7BdWus=
 github.com/jackpal/go-nat-pmp v1.0.2/go.mod h1:QPH045xvCAeXUZOxsnwmrtiCoxIr9eob+4orBN1SBKc=
 github.com/jinzhu/inflection v1.0.0 h1:K317FqzuhWc8YvSVlFMCCUb36O/S9MCKRDI7QkRKD/E=
@@ -177,7 +169,6 @@ github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSS
 github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
 github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
-github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
 github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
@@ -234,8 +225,6 @@ gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
 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/postgres v1.5.10 h1:7Lggqempgy496c0WfHXsYWxk3Th+ZcW66/21QhVFdeE=
-gorm.io/driver/postgres v1.5.10/go.mod h1:DX3GReXH+3FPWGrrgffdvCk3DQ1dwDPdmbenSkweRGI=
 gorm.io/gorm v1.25.12 h1:I0u8i2hWQItBq1WfE0o2+WuL9+8L21K9e2HHSTE/0f8=
 gorm.io/gorm v1.25.12/go.mod h1:xh7N7RHfYlNc5EmcI/El95gXusucDrQnHXe0+CgWcLQ=
 rsc.io/tmplfunc v0.0.3 h1:53XFQh69AfOa8Tw0Jm7t+GV7KZhOi6jzsCzTtKbMvzU=

main.go

@@ -1,3 +1,4 @@
+// main.go
 package main
 
 import (
@@ -19,17 +20,23 @@ import (
 )
 
 func init() {
+	// Skip completely in test mode
 	if os.Getenv("GO_ENV") == "test" {
+		database.SetupMockDB() // Set mock mode
 		return
 	}
+
+	// Only run DB initialization in non-test mode
 	cfg, err := config.LoadConfig()
 	if err != nil {
 		log.Fatal("Failed to load config:", err)
 	}
 
-	err = database.InitDB(cfg.DatabaseURL)
-	if err != nil {
-		log.Fatal("Failed to initialize database:", err)
+	if _, err := database.InitDB(cfg.DatabaseURL); err != nil {
+		// Only log error in non-test mode
+		if !database.IsMockMode {
+			log.Fatal("Failed to initialize database:", err)
+		}
 	}
 }
 

main_test.go

@@ -10,45 +10,39 @@ import (
 )
 
 func TestMain(m *testing.M) {
+	// Set test environment
 	os.Setenv("GO_ENV", "test")
+	// Run tests
 	os.Exit(m.Run())
 }
 
 func TestNotifyUsers(t *testing.T) {
-	// Create a sample event to pass to notifyUsers
 	event := &models.Event{
 		TxHash:      "0xabc123",
 		FromAddress: "0xfrom",
 		ToAddress:   "0xto",
-		Value:       "1000000000000000000", // 1 ETH in Wei
+		Value:       "1000000000000000000",
 		EventType:   "LARGE_TRANSFER",
 	}
 
-	// Initialize the mock repositories and services
+	emailSent := false
 	mockUserPrefRepo := &mock.MockUserPreferenceRepository{
 		GetMatchingPreferencesFunc: func(event *models.Event) ([]models.UserPreference, error) {
-			return []models.UserPreference{
-				{
-					UserID:            "user@example.com",
-					WalletAddress:     event.ToAddress,
-					EmailNotification: true,
-				},
-			}, nil
+			return []models.UserPreference{{
+				UserID:            "user@example.com",
+				WalletAddress:     event.ToAddress,
+				EmailNotification: true,
+			}}, nil
 		},
 	}
 
-	emailSent := false
-
 	mockEmailNotification := &mock.MockEmailNotification{
 		SendFunc: func(event *models.Event, userPref *models.UserPreference) error {
 			emailSent = true
 			return nil
 		},
 	}
 
-	// Call the function under test
 	notifyUsers(event, mockUserPrefRepo, mockEmailNotification)
-
-	// Assert that email was sent
 	assert.True(t, emailSent, "Email notification should have been sent")
 }

mock/database_mock.go

@@ -2,37 +2,19 @@ package mock
 
 import (
 	"github.com/Jetlum/WalletAlertService/models"
-	"gorm.io/gorm"
 )
 
 type MockDB struct {
 	Events          []models.Event
 	UserPreferences []models.UserPreference
 }
 
-func NewMockDB() *MockDB {
-	return &MockDB{
-		Events:          []models.Event{},
-		UserPreferences: []models.UserPreference{},
-	}
+var TestDB = &MockDB{
+	Events:          make([]models.Event, 0),
+	UserPreferences: make([]models.UserPreference, 0),
 }
 
-func (db *MockDB) Create(value interface{}) *gorm.DB {
-	switch v := value.(type) {
-	case *models.Event:
-		db.Events = append(db.Events, *v)
-	case *models.UserPreference:
-		db.UserPreferences = append(db.UserPreferences, *v)
-	}
-	return &gorm.DB{}
-}
-
-func (db *MockDB) Find(out interface{}, where ...interface{}) *gorm.DB {
-	switch out := out.(type) {
-	case *[]models.Event:
-		*out = db.Events
-	case *[]models.UserPreference:
-		*out = db.UserPreferences
-	}
-	return &gorm.DB{}
+func ResetTestDB() {
+	TestDB.Events = make([]models.Event, 0)
+	TestDB.UserPreferences = make([]models.UserPreference, 0)
 }

mock/repository_mock.go

@@ -2,19 +2,17 @@ package mock
 
 import "github.com/Jetlum/WalletAlertService/models"
 
-type MockUserPreferenceRepository struct {
-	GetMatchingPreferencesFunc func(event *models.Event) ([]models.UserPreference, error)
+// Mock Event Repository
+type MockEventRepository struct {
+	CreateFunc func(event *models.Event) error
 }
 
-func (m *MockUserPreferenceRepository) GetMatchingPreferences(event *models.Event) ([]models.UserPreference, error) {
-	if m.GetMatchingPreferencesFunc != nil {
-		return m.GetMatchingPreferencesFunc(event)
+func NewMockEventRepository() *MockEventRepository {
+	return &MockEventRepository{
+		CreateFunc: func(event *models.Event) error {
+			return nil
+		},
 	}
-	return nil, nil
-}
-
-type MockEventRepository struct {
-	CreateFunc func(event *models.Event) error
 }
 
 func (m *MockEventRepository) Create(event *models.Event) error {
@@ -24,12 +22,22 @@ func (m *MockEventRepository) Create(event *models.Event) error {
 	return nil
 }
 
-// Constructor for MockUserPreferenceRepository
+// Mock User Preference Repository
+type MockUserPreferenceRepository struct {
+	GetMatchingPreferencesFunc func(event *models.Event) ([]models.UserPreference, error)
+}
+
 func NewMockUserPreferenceRepository() *MockUserPreferenceRepository {
-	return &MockUserPreferenceRepository{}
+	return &MockUserPreferenceRepository{
+		GetMatchingPreferencesFunc: func(event *models.Event) ([]models.UserPreference, error) {
+			return []models.UserPreference{}, nil
+		},
+	}
 }
 
-// Constructor for MockEventRepository
-func NewMockEventRepository() *MockEventRepository {
-	return &MockEventRepository{}
+func (m *MockUserPreferenceRepository) GetMatchingPreferences(event *models.Event) ([]models.UserPreference, error) {
+	if m.GetMatchingPreferencesFunc != nil {
+		return m.GetMatchingPreferencesFunc(event)
+	}
+	return []models.UserPreference{}, nil
 }