member-console/cmd/database_files_test.go

// SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Commercial
// SPDX-FileCopyrightText: 2025-2026 Christian Galo

package cmd

import (
	"context"
	"log/slog"
	"net"
	"os"
	"path/filepath"
	"strconv"
	"strings"
	"testing"

	"github.com/spf13/cobra"
	"github.com/spf13/viper"
)

// databaseCommandPath is one way a command opens the database. run executes
// the path and returns the error it ends with.
type databaseCommandPath struct {
	name string
	run  func() error
	// fileKey is the -file key the command reads, and unset is the refusal
	// it ends with when neither the key nor its direct variant is set.
	fileKey string
	unset   string
}

const (
	dbDSNNotSet        = "db-dsn is not set (MC_DB_DSN or MC_DB_DSN_FILE)"
	dbMigrateDSNNotSet = "member-console migrate needs db-migrate-dsn (MC_DB_MIGRATE_DSN or MC_DB_MIGRATE_DSN_FILE)"
)

func databaseCommandPaths() []databaseCommandPath {
	return []databaseCommandPath{
		{"migrate up", func() error { return migrateUpCmd.RunE(migrateUpCmd, nil) }, "db-migrate-dsn-file", dbMigrateDSNNotSet},
		{"migrate down", func() error { return migrateDownCmd.RunE(migrateDownCmd, nil) }, "db-migrate-dsn-file", dbMigrateDSNNotSet},
		{"migrate status", func() error { return migrateStatusCmd.RunE(migrateStatusCmd, nil) }, "db-migrate-dsn-file", dbMigrateDSNNotSet},
		{"connectSettings", func() error {
			_, _, _, err := connectSettings()
			return err
		}, "db-dsn-file", dbDSNNotSet},
		{"seed-demo", func() error { return seedDemoCmd.RunE(&cobra.Command{}, nil) }, "db-dsn-file", dbDSNNotSet},
	}
}

// closedPort returns a loopback port that nothing listens on.
func closedPort(t *testing.T) string {
	t.Helper()
	l, err := net.Listen("tcp", "127.0.0.1:0")
	if err != nil {
		t.Fatalf("listen: %v", err)
	}
	port := strconv.Itoa(l.Addr().(*net.TCPAddr).Port)
	if err := l.Close(); err != nil {
		t.Fatalf("close listener: %v", err)
	}
	return port
}

// checkFileKeyRead sets only the command's file key and asserts that the path read the
// file: its error is the connection failure to the file's port.
func checkFileKeyRead(t *testing.T, p databaseCommandPath, port string) {
	t.Helper()
	viper.Reset()
	t.Cleanup(viper.Reset)

	path := filepath.Join(t.TempDir(), p.fileKey)
	dsn := "postgres://u:p@127.0.0.1:" + port + "/x?connect_timeout=1"
	if err := os.WriteFile(path, []byte(dsn+"\n"), 0o600); err != nil {
		t.Fatalf("write fixture file: %v", err)
	}
	viper.Set(p.fileKey, path)

	err := p.run()
	if err == nil {
		t.Fatalf("%s: want a connection failure, got nil", p.name)
	}
	if strings.Contains(err.Error(), p.unset) {
		t.Errorf("%s: error = %q, want a connection failure, not the unset refusal", p.name, err.Error())
	}
	if !strings.Contains(err.Error(), port) {
		t.Errorf("%s: error = %q, want a connection failure that names port %s", p.name, err.Error(), port)
	}
}

// checkUnsetRefused sets neither key and asserts the unset refusal.
func checkUnsetRefused(t *testing.T, p databaseCommandPath) {
	t.Helper()
	viper.Reset()
	t.Cleanup(viper.Reset)

	err := p.run()
	if err == nil {
		t.Fatalf("%s: want the unset refusal, got nil", p.name)
	}
	if !strings.Contains(err.Error(), p.unset) {
		t.Errorf("%s: error = %q, want it to contain %q", p.name, err.Error(), p.unset)
	}
}

// checkWhitespaceRefused sets the command's direct key to whitespace only and
// asserts the unset refusal: pgx would otherwise connect with libpq's defaults.
func checkWhitespaceRefused(t *testing.T, p databaseCommandPath) {
	t.Helper()
	viper.Reset()
	t.Cleanup(viper.Reset)
	viper.Set(strings.TrimSuffix(p.fileKey, "-file"), " \t")

	err := p.run()
	if err == nil {
		t.Fatalf("%s: want the unset refusal, got nil", p.name)
	}
	if !strings.Contains(err.Error(), p.unset) {
		t.Errorf("%s: error = %q, want it to contain %q", p.name, err.Error(), p.unset)
	}
}

// TestDatabaseCommandsReadTheFileKeys covers task 2.4 (design D12): every
// command that opens the database resolves its file key first, and one that
// finds no connection string refuses instead of letting the driver fall back
// to its defaults.
func TestDatabaseCommandsReadTheFileKeys(t *testing.T) {
	// viper.Reset drops the environment binding, so the rows never read
	// MC_DB_DSN or MC_DB_MIGRATE_DSN; blanking them as well keeps migrate down,
	// which this test runs, off a real database even if that ever changes.
	t.Setenv("MC_DB_DSN", "")
	t.Setenv("MC_DB_DSN_FILE", "")
	t.Setenv("MC_DB_MIGRATE_DSN", "")
	t.Setenv("MC_DB_MIGRATE_DSN_FILE", "")
	t.Setenv("MC_DB_MIGRATE_DSN", "")
	t.Setenv("MC_DB_MIGRATE_DSN_FILE", "")
	port := closedPort(t)
	for _, p := range databaseCommandPaths() {
		t.Run("file key read: "+p.name, func(t *testing.T) {
			checkFileKeyRead(t, p, port)
		})
	}
	for _, p := range databaseCommandPaths() {
		t.Run("neither key set: "+p.name, func(t *testing.T) {
			checkUnsetRefused(t, p)
		})
	}
	for _, p := range databaseCommandPaths() {
		t.Run("whitespace only: "+p.name, func(t *testing.T) {
			checkWhitespaceRefused(t, p)
		})
	}
}

// TestMigrationDSNIsUnsetWhenOnlyWhitespace covers the read start and
// seed-demo make of db-migrate-dsn: the boot migrates only when it holds a
// string, and ValidateStart already treats whitespace as none.
func TestMigrationDSNIsUnsetWhenOnlyWhitespace(t *testing.T) {
	viper.Reset()
	t.Cleanup(viper.Reset)
	viper.Set("db-migrate-dsn", "  \n")
	if got := migrationDSN(); got != "" {
		t.Errorf("migrationDSN() = %q, want it unset", got)
	}
	viper.Set("db-migrate-dsn", " postgres://u@h/db ")
	if got := migrationDSN(); got != "postgres://u@h/db" {
		t.Errorf("migrationDSN() = %q, want the string without its whitespace", got)
	}
}

// TestOpenDBRefusesAnUnknownMode covers the mode switch: a mode that no case
// names opens nothing, instead of running the migrating boot.
func TestOpenDBRefusesAnUnknownMode(t *testing.T) {
	viper.Reset()
	t.Cleanup(viper.Reset)
	_, _, err := openDB(context.Background(), slog.New(slog.DiscardHandler), dbMode(99))
	if err == nil || !strings.Contains(err.Error(), "unknown database mode 99") {
		t.Errorf("openDB error = %v, want unknown database mode 99", err)
	}
}