Increase unit and integration test coverage for Consent Engine and PDP

Author: ginaxu1

exchange/consent-engine/go.mod

@@ -6,6 +6,7 @@ require (
 	github.com/golang-jwt/jwt/v5 v5.3.0
 	github.com/google/uuid v1.6.0
 	github.com/gov-dx-sandbox/exchange/shared/config v0.0.0
+	github.com/gov-dx-sandbox/exchange/shared/testutils v0.0.0
 	github.com/gov-dx-sandbox/exchange/shared/utils v0.0.0
 )
 
@@ -65,4 +66,6 @@ replace github.com/gov-dx-sandbox/exchange/shared/constants => ./shared/constant
 
 replace github.com/gov-dx-sandbox/exchange/shared/monitoring => ../shared/monitoring
 
+replace github.com/gov-dx-sandbox/exchange/shared/testutils => ../shared/testutils
+
 replace github.com/gov-dx-sandbox/exchange/shared/utils => ./shared/utils

exchange/consent-engine/v1/database/database_test.go

@@ -0,0 +1,64 @@
+package database
+
+import (
+	"os"
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestNewDatabaseConfig(t *testing.T) {
+	// Clear environment variables
+	os.Unsetenv("CHOREO_OPENDIF_DATABASE_HOSTNAME")
+	os.Unsetenv("CHOREO_OPENDIF_DATABASE_PORT")
+	os.Unsetenv("CHOREO_OPENDIF_DATABASE_USERNAME")
+	os.Unsetenv("CHOREO_OPENDIF_DATABASE_PASSWORD")
+	os.Unsetenv("CHOREO_OPENDIF_DATABASE_DATABASENAME")
+	os.Unsetenv("DB_SSLMODE")
+
+	config := NewDatabaseConfig()
+
+	assert.Equal(t, "localhost", config.Host)
+	assert.Equal(t, "5432", config.Port)
+	assert.Equal(t, "postgres", config.Username)
+	assert.Equal(t, "password", config.Password)
+	assert.Equal(t, "testdb", config.Database)
+	assert.Equal(t, "prefer", config.SSLMode)
+	assert.Equal(t, 25, config.MaxOpenConns)
+	assert.Equal(t, 5, config.MaxIdleConns)
+	assert.Equal(t, time.Hour, config.ConnMaxLifetime)
+	assert.Equal(t, 30*time.Minute, config.ConnMaxIdleTime)
+	assert.Equal(t, 5, config.MaxRetries)
+}
+
+func TestNewDatabaseConfig_WithEnvVars(t *testing.T) {
+	os.Setenv("CHOREO_OPENDIF_DATABASE_HOSTNAME", "test-host")
+	os.Setenv("CHOREO_OPENDIF_DATABASE_PORT", "5433")
+	os.Setenv("CHOREO_OPENDIF_DATABASE_USERNAME", "test-user")
+	os.Setenv("CHOREO_OPENDIF_DATABASE_PASSWORD", "test-password")
+	os.Setenv("CHOREO_OPENDIF_DATABASE_DATABASENAME", "test-db")
+	os.Setenv("DB_SSLMODE", "require")
+	defer func() {
+		os.Unsetenv("CHOREO_OPENDIF_DATABASE_HOSTNAME")
+		os.Unsetenv("CHOREO_OPENDIF_DATABASE_PORT")
+		os.Unsetenv("CHOREO_OPENDIF_DATABASE_USERNAME")
+		os.Unsetenv("CHOREO_OPENDIF_DATABASE_PASSWORD")
+		os.Unsetenv("CHOREO_OPENDIF_DATABASE_DATABASENAME")
+		os.Unsetenv("DB_SSLMODE")
+	}()
+
+	config := NewDatabaseConfig()
+
+	assert.Equal(t, "test-host", config.Host)
+	assert.Equal(t, "5433", config.Port)
+	assert.Equal(t, "test-user", config.Username)
+	assert.Equal(t, "test-password", config.Password)
+	assert.Equal(t, "test-db", config.Database)
+	assert.Equal(t, "require", config.SSLMode)
+}
+
+// NOTE: Tests for ConnectGormDB with real database connections have been moved to
+// tests/integration/database/database_test.go as integration tests.
+// Unit tests should not use real database connections.
+

exchange/consent-engine/v1/handlers/internal_handler_test.go

@@ -15,30 +15,19 @@ import (
 	"github.com/google/uuid"
 	"github.com/gov-dx-sandbox/exchange/consent-engine/v1/models"
 	"github.com/gov-dx-sandbox/exchange/consent-engine/v1/services"
+	"github.com/gov-dx-sandbox/exchange/shared/testutils"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
-	"gorm.io/driver/postgres"
 	"gorm.io/gorm"
 )
 
-func setupTestService(t *testing.T) (*services.ConsentService, sqlmock.Sqlmock) {
-	db, mock, err := sqlmock.New()
-	require.NoError(t, err)
-
-	dialector := postgres.New(postgres.Config{
-		Conn:       db,
-		DriverName: "postgres",
-	})
-
-	gormDB, err := gorm.Open(dialector, &gorm.Config{
-		SkipDefaultTransaction: true,
-	})
-	require.NoError(t, err)
+func setupTestService(t *testing.T) (*services.ConsentService, sqlmock.Sqlmock, func()) {
+	db, mock, cleanup := testutils.SetupMockDB(t)
 
-	service, err := services.NewConsentService(gormDB, "http://localhost:5173")
+	service, err := services.NewConsentService(db, "http://localhost:5173")
 	require.NoError(t, err)
 
-	return service, mock
+	return service, mock, cleanup
 }
 
 func TestInternalHandler_HealthCheck(t *testing.T) {
@@ -113,14 +102,16 @@ func TestInternalHandler_CreateConsent_MethodNotAllowed(t *testing.T) {
 }
 
 func TestInternalHandler_NewInternalHandler(t *testing.T) {
-	service, _ := setupTestService(t)
+	service, _, cleanup := setupTestService(t)
+	defer cleanup()
 	handler := NewInternalHandler(service)
 	assert.NotNil(t, handler)
 	assert.Equal(t, service, handler.consentService)
 }
 
 func TestInternalHandler_GetConsent_Success_WithOwnerID(t *testing.T) {
-	service, mock := setupTestService(t)
+	service, mock, cleanup := setupTestService(t)
+	defer cleanup()
 	handler := NewInternalHandler(service)
 
 	id := uuid.New()
@@ -145,7 +136,8 @@ func TestInternalHandler_GetConsent_Success_WithOwnerID(t *testing.T) {
 }
 
 func TestInternalHandler_GetConsent_Success_WithOwnerEmail(t *testing.T) {
-	service, mock := setupTestService(t)
+	service, mock, cleanup := setupTestService(t)
+	defer cleanup()
 	handler := NewInternalHandler(service)
 
 	id := uuid.New()
@@ -166,7 +158,8 @@ func TestInternalHandler_GetConsent_Success_WithOwnerEmail(t *testing.T) {
 }
 
 func TestInternalHandler_GetConsent_NotFound(t *testing.T) {
-	service, mock := setupTestService(t)
+	service, mock, cleanup := setupTestService(t)
+	defer cleanup()
 	handler := NewInternalHandler(service)
 
 	mock.ExpectQuery(regexp.QuoteMeta(`SELECT * FROM "consent_records"`)).
@@ -182,7 +175,8 @@ func TestInternalHandler_GetConsent_NotFound(t *testing.T) {
 }
 
 func TestInternalHandler_GetConsent_ContextTimeout(t *testing.T) {
-	service, mock := setupTestService(t)
+	service, mock, cleanup := setupTestService(t)
+	defer cleanup()
 	handler := NewInternalHandler(service)
 
 	ctx, cancel := context.WithTimeout(context.Background(), 1*time.Nanosecond)
@@ -202,7 +196,8 @@ func TestInternalHandler_GetConsent_ContextTimeout(t *testing.T) {
 }
 
 func TestInternalHandler_CreateConsent_Success(t *testing.T) {
-	service, mock := setupTestService(t)
+	service, mock, cleanup := setupTestService(t)
+	defer cleanup()
 	handler := NewInternalHandler(service)
 
 	// Mock GetConsentInternalView returning not found - specific query for owner_id and app_id
@@ -235,7 +230,8 @@ func TestInternalHandler_CreateConsent_Success(t *testing.T) {
 }
 
 func TestInternalHandler_CreateConsent_CreateFailed(t *testing.T) {
-	service, mock := setupTestService(t)
+	service, mock, cleanup := setupTestService(t)
+	defer cleanup()
 	handler := NewInternalHandler(service)
 
 	// Mock GetConsentInternalView returning not found - specific query
@@ -268,7 +264,8 @@ func TestInternalHandler_CreateConsent_CreateFailed(t *testing.T) {
 }
 
 func TestInternalHandler_GetConsent_InternalError(t *testing.T) {
-	service, mock := setupTestService(t)
+	service, mock, cleanup := setupTestService(t)
+	defer cleanup()
 	handler := NewInternalHandler(service)
 
 	mock.ExpectQuery(regexp.QuoteMeta(`SELECT * FROM "consent_records" WHERE owner_id = $1 AND app_id = $2 ORDER BY created_at DESC`)+".*"+regexp.QuoteMeta(` LIMIT $3`)).
@@ -285,7 +282,8 @@ func TestInternalHandler_GetConsent_InternalError(t *testing.T) {
 }
 
 func TestInternalHandler_CreateConsent_InternalError(t *testing.T) {
-	service, mock := setupTestService(t)
+	service, mock, cleanup := setupTestService(t)
+	defer cleanup()
 	handler := NewInternalHandler(service)
 
 	mock.ExpectQuery(regexp.QuoteMeta(`SELECT * FROM "consent_records" WHERE owner_id = $1 AND app_id = $2 ORDER BY created_at DESC`)+".*"+regexp.QuoteMeta(` LIMIT $3`)).

exchange/consent-engine/v1/handlers/portal_handler_test.go

@@ -15,11 +15,11 @@ import (
 // setUserEmailInContext is a test helper to set user email in context
 // Uses the same context key as middleware.auth.go (userEmailKey = "userEmail")
 func setUserEmailInContext(ctx context.Context, email string) context.Context {
-	return context.WithValue(ctx, contextKey("userEmail"), email)
+	type contextKey string
+	const userEmailKey contextKey = "userEmail"
+	return context.WithValue(ctx, userEmailKey, email)
 }
 
-type contextKey string
-
 func TestPortalHandler_HealthCheck(t *testing.T) {
 	handler := &PortalHandler{consentService: nil}