feat(db): migrations with test

Author: shamikkarkhanis

Makefile

@@ -1,13 +1,14 @@
-.PHONY: generate build run test test-integration test-all lint swagger docker docker-down ci benchmark \
-	migrate-create migrate-up migrate-down migrate-down-one migrate-version migrate-force \
-	migrate-up-docker migrate-down-docker migrate-down-one-docker migrate-version-docker migrate-force-docker
+.PHONY: generate build run test test-integration test-integration-verbose test-all lint swagger docker docker-down ci benchmark \
+	migrate-create migrate-up migrate-down migrate-down-all migrate-down-one migrate-version migrate-force \
+	migrate-up-docker migrate-down-docker migrate-down-all-docker migrate-down-one-docker migrate-version-docker migrate-force-docker
 
 MIGRATE ?= migrate
 MIGRATIONS_DIR ?= migrations
 MIGRATE_DATABASE_URL ?=
 MIGRATE_DOCKER_IMAGE ?= migrate/migrate
 COMPOSE_PROJECT_NAME ?= $(notdir $(CURDIR))
 COMPOSE_NETWORK ?= $(COMPOSE_PROJECT_NAME)_default
+DOCKER_COMPOSE ?= docker compose
 
 # Code generation
 generate:
@@ -28,6 +29,9 @@ migrate-up:
 	$(MIGRATE) -path $(MIGRATIONS_DIR) -database "$$db_url" up
 
 migrate-down:
+	@$(MAKE) migrate-down-all
+
+migrate-down-all:
 	@db_url="$${MIGRATE_DATABASE_URL:-$${DATABASE_URL:-$$(grep -E '^DATABASE_URL=' .env 2>/dev/null | head -n1 | cut -d= -f2-)}}"; \
 	test -n "$$db_url" || (echo "Set MIGRATE_DATABASE_URL or DATABASE_URL (or add DATABASE_URL to .env)" && exit 1); \
 	$(MIGRATE) -path $(MIGRATIONS_DIR) -database "$$db_url" down -all
@@ -55,6 +59,9 @@ migrate-up-docker:
 	docker run --rm --network $(COMPOSE_NETWORK) -v "$(CURDIR)/$(MIGRATIONS_DIR):/migrations" $(MIGRATE_DOCKER_IMAGE) -path /migrations -database "$$db_url" up
 
 migrate-down-docker:
+	@$(MAKE) migrate-down-all-docker
+
+migrate-down-all-docker:
 	@db_url="$${MIGRATE_DATABASE_URL:-$${DATABASE_URL:-$$(grep -E '^DATABASE_URL=' .env 2>/dev/null | head -n1 | cut -d= -f2-)}}"; \
 	test -n "$$db_url" || (echo "Set MIGRATE_DATABASE_URL or DATABASE_URL (or add DATABASE_URL to .env)" && exit 1); \
 	docker run --rm --network $(COMPOSE_NETWORK) -v "$(CURDIR)/$(MIGRATIONS_DIR):/migrations" $(MIGRATE_DOCKER_IMAGE) -path /migrations -database "$$db_url" down -all
@@ -92,6 +99,11 @@ test-integration:
 	go test -tags=integration ./tests/integration/... -coverprofile=coverage.out -coverpkg=./...
 	go tool cover -func=coverage.out
 
+test-integration-verbose:
+	go test -v -tags=integration ./internal/database/... -count=1
+	go test -v -tags=integration ./tests/integration/... -coverprofile=coverage.out -coverpkg=./...
+	go tool cover -func=coverage.out
+
 test-all:
 	go test -v -race -tags=integration ./...
 
@@ -122,10 +134,10 @@ lint:
 
 # Docker
 docker:
-	docker-compose up --build -d
+	$(DOCKER_COMPOSE) up --build -d
 
 docker-down:
-	docker-compose down -v
+	$(DOCKER_COMPOSE) down -v
 
 # CI pipeline
 ci: lint test-all

internal/database/migrations_integration_test.go

@@ -4,86 +4,178 @@ package database_test
 
 import (
 	"context"
+	"fmt"
+	"os"
 	"path/filepath"
 	"runtime"
+	"sort"
+	"strings"
 	"testing"
 
-	"github.com/capyrpi/api/internal/database"
 	"github.com/capyrpi/api/internal/testutils"
-	"github.com/jackc/pgx/v5/pgtype"
-	"github.com/stretchr/testify/assert"
+	"github.com/jackc/pgx/v5/pgxpool"
 	"github.com/stretchr/testify/require"
 )
 
-func TestRunMigrations_AppliesInitAndIsIdempotent(t *testing.T) {
-	connStr := testutils.SetupTestPostgres(t)
-	migrationsPath := testMigrationsPath(t)
+func TestMigrationsApplyAndRollback(t *testing.T) {
+	pool := testutils.SetupEmptyTestDB(t)
+	defer pool.Close()
+
 	ctx := context.Background()
+	migrationsDir := repoRoot(t, 2)
+	migrationsDir = filepath.Join(migrationsDir, "migrations")
 
-	require.NoError(t, database.RunMigrations(ctx, connStr, migrationsPath))
-	require.NoError(t, database.RunMigrations(ctx, connStr, migrationsPath))
+	upFiles, downFiles := migrationFiles(t, migrationsDir)
+	require.NotEmpty(t, upFiles, "no migration files found in %s", migrationsDir)
+	require.Equal(t, len(upFiles), len(downFiles), "up/down migration file count mismatch")
 
-	pool, err := database.NewPool(ctx, connStr)
-	require.NoError(t, err)
-	defer pool.Close()
+	beforeState := snapshotPublicSchema(t, ctx, pool)
 
-	for _, table := range []string{
-		"users",
-		"organizations",
-		"org_members",
-		"events",
-		"event_hosting",
-		"event_registrations",
-		"bot_tokens",
-	} {
-		var regclass pgtype.Text
-		err := pool.QueryRow(ctx, "SELECT to_regclass($1)::text", "public."+table).Scan(&regclass)
+	for i, path := range upFiles {
+		sqlBytes, err := os.ReadFile(path)
 		require.NoError(t, err)
-		assert.Truef(t, regclass.Valid, "expected table %s to exist", table)
+		_, err = pool.Exec(ctx, string(sqlBytes))
+		require.NoErrorf(t, err, "failed applying up migration %d: %s", i, filepath.Base(path))
 	}
 
-	var version int64
-	var dirty bool
-	err = pool.QueryRow(ctx, "SELECT version, dirty FROM schema_migrations").Scan(&version, &dirty)
+	afterUpState := snapshotPublicSchema(t, ctx, pool)
+	require.NotEqual(t, beforeState, afterUpState, "expected schema to change after applying up migrations")
+
+	for i := len(downFiles) - 1; i >= 0; i-- {
+		path := downFiles[i]
+		sqlBytes, err := os.ReadFile(path)
+		require.NoError(t, err)
+		_, err = pool.Exec(ctx, string(sqlBytes))
+		require.NoErrorf(t, err, "failed applying down migration %d: %s", i, filepath.Base(path))
+	}
+
+	afterDownState := snapshotPublicSchema(t, ctx, pool)
+	require.Equal(t, beforeState, afterDownState, "expected schema state after down migrations to match initial state")
+}
+
+func migrationFiles(t *testing.T, dir string) ([]string, []string) {
+	t.Helper()
+
+	entries, err := os.ReadDir(dir)
 	require.NoError(t, err)
-	assert.Equal(t, int64(1), version)
-	assert.False(t, dirty)
+
+	var upFiles []string
+	var downFiles []string
+
+	for _, entry := range entries {
+		if entry.IsDir() {
+			continue
+		}
+		name := entry.Name()
+		fullPath := filepath.Join(dir, name)
+
+		switch {
+		case strings.HasSuffix(name, ".up.sql"):
+			upFiles = append(upFiles, fullPath)
+		case strings.HasSuffix(name, ".down.sql"):
+			downFiles = append(downFiles, fullPath)
+		}
+	}
+
+	sort.Strings(upFiles)
+	sort.Strings(downFiles)
+	return upFiles, downFiles
 }
 
-func TestRunMigrations_DownAndUp(t *testing.T) {
-	connStr := testutils.SetupTestPostgres(t)
-	migrationsPath := testMigrationsPath(t)
-	ctx := context.Background()
+func repoRoot(t *testing.T, upLevels int) string {
+	t.Helper()
 
-	require.NoError(t, database.RunMigrations(ctx, connStr, migrationsPath))
-	require.NoError(t, database.RunMigrationsDown(ctx, connStr, migrationsPath, 1))
+	_, filename, _, ok := runtime.Caller(0)
+	require.True(t, ok)
 
-	pool, err := database.NewPool(ctx, connStr)
-	require.NoError(t, err)
+	root := filepath.Dir(filename)
+	for range upLevels {
+		root = filepath.Dir(root)
+	}
+	return root
+}
 
-	var regclass pgtype.Text
-	err = pool.QueryRow(ctx, "SELECT to_regclass('public.users')::text").Scan(&regclass)
-	require.NoError(t, err)
-	assert.False(t, regclass.Valid, "users table should be removed after rolling back init migration")
-	pool.Close()
+type schemaSnapshot struct {
+	Tables    []string
+	Columns   []string
+	Indexes   []string
+	Views     []string
+	Sequences []string
+	Enums     []string
+}
 
-	require.NoError(t, database.RunMigrations(ctx, connStr, migrationsPath))
+func snapshotPublicSchema(t *testing.T, ctx context.Context, pool *pgxpool.Pool) schemaSnapshot {
+	t.Helper()
 
-	pool, err = database.NewPool(ctx, connStr)
+	return schemaSnapshot{
+		Tables:    querySingleColumn(t, ctx, pool, `SELECT table_name FROM information_schema.tables WHERE table_schema = 'public' AND table_type = 'BASE TABLE' ORDER BY table_name`),
+		Columns:   queryColumns(t, ctx, pool),
+		Indexes:   querySingleColumn(t, ctx, pool, `SELECT indexname || ':' || indexdef FROM pg_indexes WHERE schemaname = 'public' ORDER BY indexname`),
+		Views:     querySingleColumn(t, ctx, pool, `SELECT table_name FROM information_schema.views WHERE table_schema = 'public' ORDER BY table_name`),
+		Sequences: querySingleColumn(t, ctx, pool, `SELECT sequence_name FROM information_schema.sequences WHERE sequence_schema = 'public' ORDER BY sequence_name`),
+		Enums:     queryEnums(t, ctx, pool),
+	}
+}
+
+func querySingleColumn(t *testing.T, ctx context.Context, pool *pgxpool.Pool, sql string) []string {
+	t.Helper()
+
+	rows, err := pool.Query(ctx, sql)
 	require.NoError(t, err)
-	defer pool.Close()
+	defer rows.Close()
 
-	err = pool.QueryRow(ctx, "SELECT to_regclass('public.users')::text").Scan(&regclass)
+	var out []string
+	for rows.Next() {
+		var v string
+		require.NoError(t, rows.Scan(&v))
+		out = append(out, v)
+	}
+	require.NoError(t, rows.Err())
+	return out
+}
+
+func queryColumns(t *testing.T, ctx context.Context, pool *pgxpool.Pool) []string {
+	t.Helper()
+
+	rows, err := pool.Query(ctx, `
+		SELECT table_name, column_name, data_type, is_nullable, COALESCE(column_default, '')
+		FROM information_schema.columns
+		WHERE table_schema = 'public'
+		ORDER BY table_name, ordinal_position
+	`)
 	require.NoError(t, err)
-	assert.True(t, regclass.Valid, "users table should exist after re-applying migrations")
+	defer rows.Close()
+
+	var out []string
+	for rows.Next() {
+		var tableName, columnName, dataType, isNullable, columnDefault string
+		require.NoError(t, rows.Scan(&tableName, &columnName, &dataType, &isNullable, &columnDefault))
+		out = append(out, fmt.Sprintf("%s.%s:%s:%s:%s", tableName, columnName, dataType, isNullable, columnDefault))
+	}
+	require.NoError(t, rows.Err())
+	return out
 }
 
-func testMigrationsPath(t *testing.T) string {
+func queryEnums(t *testing.T, ctx context.Context, pool *pgxpool.Pool) []string {
 	t.Helper()
 
-	_, filename, _, ok := runtime.Caller(0)
-	require.True(t, ok)
+	rows, err := pool.Query(ctx, `
+		SELECT t.typname, e.enumlabel
+		FROM pg_type t
+		JOIN pg_enum e ON e.enumtypid = t.oid
+		JOIN pg_namespace n ON n.oid = t.typnamespace
+		WHERE n.nspname = 'public'
+		ORDER BY t.typname, e.enumsortorder
+	`)
+	require.NoError(t, err)
+	defer rows.Close()
 
-	projectRoot := filepath.Join(filepath.Dir(filename), "../..")
-	return filepath.Join(projectRoot, "migrations")
+	var out []string
+	for rows.Next() {
+		var typeName, label string
+		require.NoError(t, rows.Scan(&typeName, &label))
+		out = append(out, fmt.Sprintf("%s:%s", typeName, label))
+	}
+	require.NoError(t, rows.Err())
+	return out
 }

internal/testutils/container.go

@@ -67,3 +67,41 @@ func SetupTestDB(t *testing.T) *pgxpool.Pool {
 
 	return pool
 }
+
+// SetupEmptyTestDB creates a fresh Postgres container without loading schema.sql.
+// Use this for migration tests that need to apply schema changes from scratch.
+func SetupEmptyTestDB(t *testing.T) *pgxpool.Pool {
+	ctx := context.Background()
+
+	pgContainer, err := postgres.Run(ctx,
+		"postgres:16-alpine",
+		postgres.WithDatabase("test_db"),
+		postgres.WithUsername("test"),
+		postgres.WithPassword("test"),
+		testcontainers.WithWaitStrategy(
+			wait.ForLog("database system is ready to accept connections").
+				WithOccurrence(2).
+				WithStartupTimeout(30*time.Second)),
+	)
+	if err != nil {
+		t.Fatalf("failed to start postgres container: %v", err)
+	}
+
+	t.Cleanup(func() {
+		if err := pgContainer.Terminate(ctx); err != nil {
+			t.Fatalf("failed to terminate container: %v", err)
+		}
+	})
+
+	connStr, err := pgContainer.ConnectionString(ctx, "sslmode=disable")
+	if err != nil {
+		t.Fatalf("failed to get connection string: %v", err)
+	}
+
+	pool, err := database.NewPool(ctx, connStr)
+	if err != nil {
+		t.Fatalf("failed to connect to database: %v", err)
+	}
+
+	return pool
+}