Add error checking and logging to migrations

cmd/draconctl/main.go

@@ -64,7 +64,7 @@ func initializeConfig(cmd *cobra.Command) error {
 
 	// Bind to environment variables
 	// Works great for simple config names, but needs help for names
-	// like --favorite-color which we fix in the bindFlags function
+	// like --favorite-color which we fix in the visitall function
 	v.AutomaticEnv()
 
 	if !slices.Contains(supportedLogFormats, strings.ToLower(loggingFormat)) {

cmd/draconctl/migrations/apply.go

@@ -3,6 +3,7 @@ package migrations
 import (
 	"errors"
 	"fmt"
+	"log/slog"
 	"os"
 
 	"github.com/golang-migrate/migrate/v4"
@@ -34,6 +35,8 @@ func applyMigrations(cmd *cobra.Command, args []string) error {
 	if migrationsCmdConfig.migratiosnPath == "" {
 		return fmt.Errorf("you need to provide a path to the migrations that will be applied")
 	}
+	slog.Info("applying migrations", "migrations path:", migrationsCmdConfig.migratiosnPath)
+
 	dirFS := os.DirFS(migrationsCmdConfig.migratiosnPath)
 
 	dbURL, err := db.ParseConnectionStr(migrationsCmdConfig.connStr)

cmd/draconctl/migrations/inspect.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"log/slog"
 	"os"
 
 	"github.com/golang-migrate/migrate/v4"
@@ -32,6 +33,7 @@ func inspectMigrations(cmd *cobra.Command, args []string) error {
 	if migrationsCmdConfig.migratiosnPath == "" {
 		return fmt.Errorf("you need to provide a path to the migrations that will be applied")
 	}
+	slog.Info("inspecting migrations", "migrations path:", migrationsCmdConfig.migratiosnPath)
 	dirFS := os.DirFS(migrationsCmdConfig.migratiosnPath)
 
 	dbURL, err := db.ParseConnectionStr(migrationsCmdConfig.connStr)

cmd/draconctl/migrations/revert.go

@@ -3,6 +3,7 @@ package migrations
 import (
 	"errors"
 	"fmt"
+	"log/slog"
 	"os"
 
 	"github.com/golang-migrate/migrate/v4"
@@ -30,6 +31,7 @@ func revertMigrations(cmd *cobra.Command, args []string) error {
 	if migrationsCmdConfig.migratiosnPath == "" {
 		return fmt.Errorf("you need to provide a path to the migrations that will be applied")
 	}
+	slog.Info("reverting migrations", "migrations path:", migrationsCmdConfig.migratiosnPath)
 	dirFS := os.DirFS(migrationsCmdConfig.migratiosnPath)
 
 	dbURL, err := db.ParseConnectionStr(migrationsCmdConfig.connStr)

deploy/deduplication-db-migrations/chart/templates/migrations-job.yaml

@@ -32,7 +32,6 @@ spec:
         - apply
         - --url
         - "postgresql://{{ .Values.database.auth.username }}:{{ .Values.database.auth.password }}@{{ .Values.database.host }}/{{ .Values.database.auth.database }}?{{ .Values.database.auth.querystringargs}}"
-        - ${DRACONCTL_MIGRATIONS_PATH}
         resources:
           {{- toYaml .Values.resources | nindent 12 }}
       serviceAccountName: {{ include "deduplication_db_migrations.fullname" . }}

pkg/db/migrations.go

@@ -20,6 +20,9 @@ type Migrations struct {
 
 func (m *Migrations) ListAvailable(migrationsDir fs.FS) (*bindata.AssetSource, error) {
 	var assetNames []string
+	if _, err := fs.Stat(migrationsDir, "."); err != nil {
+		return nil, fmt.Errorf("could not find migrations directory: %w", err)
+	}
 	if err := fs.WalkDir(migrationsDir, ".", func(path string, info fs.DirEntry, err error) error {
 		if !info.IsDir() {
 			assetNames = append(assetNames, info.Name())

tests/migrations/compose.yaml

@@ -33,13 +33,13 @@ services:
     - |
       apt-get update && apt-get install -y jq &&
       echo "------------------------------ Starting tests ------------------------------" &&
-      /bin/draconctl migrations inspect --url postgres://postgres:password@postgres:5432?sslmode=disable --json | tee | jq -eM '. | select(.Version == 0)' &&
+      /bin/draconctl migrations inspect --url postgres://postgres:password@postgres:5432?sslmode=disable --json |grep -v 'level=' | tee | jq -eM '. | select(.Version == 0)' &&
       echo "------------------------------ Applying migrations ------------------------------" &&
       /bin/draconctl migrations apply --url postgres://postgres:password@postgres:5432?sslmode=disable &&
-      /bin/draconctl migrations inspect --url postgres://postgres:password@postgres:5432?sslmode=disable --json | tee | jq -eM '. | select(.Version > 0)' &&
+      /bin/draconctl migrations inspect --url postgres://postgres:password@postgres:5432?sslmode=disable --json |grep -v 'level=' | tee | jq -eM '. | select(.Version > 0)' &&
       echo "------------------------------ Reverting migrations ------------------------------" &&
       /bin/draconctl migrations revert --url postgres://postgres:password@postgres:5432?sslmode=disable &&
-      /bin/draconctl migrations inspect --url postgres://postgres:password@postgres:5432?sslmode=disable --json | tee | jq -eM '. | select(.Version == 0)'
+      /bin/draconctl migrations inspect --url postgres://postgres:password@postgres:5432?sslmode=disable --json |grep -v 'level=' | tee | jq -eM '. | select(.Version == 0)'
 
 networks:
   test-migrations: