supabase-cli/pkg/migration/apply_test.go

package migration

import (
	"context"
	"embed"
	"os"
	"testing"
	fs "testing/fstest"

	"github.com/jackc/pgerrcode"
	"github.com/stretchr/testify/assert"
	"github.com/supabase/cli/pkg/pgtest"
)

func TestPendingMigrations(t *testing.T) {
	t.Run("finds pending migrations", func(t *testing.T) {
		local := []string{
			"20221201000000_test.sql",
			"20221201000001_test.sql",
			"20221201000002_test.sql",
			"20221201000003_test.sql",
		}
		remote := []string{
			"20221201000000",
			"20221201000001",
		}
		// Run test
		pending, err := FindPendingMigrations(local, remote)
		// Check error
		assert.NoError(t, err)
		assert.ElementsMatch(t, local[2:], pending)
	})

	t.Run("throws error on missing local migration", func(t *testing.T) {
		local := []string{}
		remote := []string{"0"}
		// Run test
		pending, err := FindPendingMigrations(local, remote)
		// Check error
		assert.ErrorIs(t, err, ErrMissingLocal)
		assert.ElementsMatch(t, remote, pending)
	})

	t.Run("throws error on missing remote version", func(t *testing.T) {
		local := []string{
			"0_test.sql",
			"1_test.sql",
		}
		remote := []string{"1"}
		// Run test
		pending, err := FindPendingMigrations(local, remote)
		// Check error
		assert.ErrorIs(t, err, ErrMissingRemote)
		assert.ElementsMatch(t, local[:1], pending)
	})

	t.Run("throws error on out-of-order remote migrations", func(t *testing.T) {
		local := []string{
			"20221201000000_test.sql",
			"20221201000001_test.sql",
			"20221201000002_test.sql",
			"20221201000003_test.sql",
			"20221201000004_test.sql",
		}
		remote := []string{
			"20221201000002",
			"20221201000004",
		}
		// Run test
		missing, err := FindPendingMigrations(local, remote)
		// Check error
		assert.ErrorIs(t, err, ErrMissingRemote)
		assert.ElementsMatch(t, []string{local[0], local[1], local[3]}, missing)
	})

	t.Run("throws error on out-of-order local migrations", func(t *testing.T) {
		local := []string{
			"20221201000000_test.sql",
			"20221201000002_test.sql",
		}
		remote := []string{
			"20221201000000",
			"20221201000001",
			"20221201000002",
			"20221201000003",
			"20221201000004",
		}
		// Run test
		missing, err := FindPendingMigrations(local, remote)
		// Check error
		assert.ErrorIs(t, err, ErrMissingLocal)
		assert.ElementsMatch(t, []string{remote[1], remote[3], remote[4]}, missing)
	})
}

var (
	//go:embed testdata
	testMigrations embed.FS
	//go:embed testdata/0_schema.sql
	testSchema string
)

func TestApplyMigrations(t *testing.T) {
	pending := []string{"testdata/0_schema.sql"}

	t.Run("applies migrations and appends history", func(t *testing.T) {
		// Setup mock postgres
		conn := pgtest.NewConn()
		defer conn.Close(t)
		mockMigrationHistory(conn).
			Query(testSchema).
			Reply("CREATE SCHEMA").
			Query(INSERT_MIGRATION_VERSION, "0", "schema", []string{testSchema}).
			Reply("INSERT 0 1")
		// Run test
		err := ApplyMigrations(context.Background(), pending, conn.MockClient(t), testMigrations)
		// Check error
		assert.NoError(t, err)
	})

	t.Run("throws error on history failure", func(t *testing.T) {
		// Setup in-memory fs
		fsys := fs.MapFS{}
		// Setup mock postgres
		conn := pgtest.NewConn()
		defer conn.Close(t)
		conn.Query(SET_LOCK_TIMEOUT).
			Query(CREATE_VERSION_SCHEMA).
			Reply("CREATE SCHEMA").
			Query(CREATE_VERSION_TABLE).
			ReplyError(pgerrcode.InsufficientPrivilege, "permission denied for relation supabase_migrations").
			Query(ADD_STATEMENTS_COLUMN).
			Query(ADD_NAME_COLUMN)
		// Run test
		err := ApplyMigrations(context.Background(), pending, conn.MockClient(t), fsys)
		// Check error
		assert.ErrorContains(t, err, "ERROR: permission denied for relation supabase_migrations (SQLSTATE 42501)")
	})

	t.Run("throws error on missing file", func(t *testing.T) {
		// Setup in-memory fs
		fsys := fs.MapFS{}
		// Setup mock postgres
		conn := pgtest.NewConn()
		defer conn.Close(t)
		mockMigrationHistory(conn)
		// Run test
		err := ApplyMigrations(context.Background(), pending, conn.MockClient(t), fsys)
		// Check error
		assert.ErrorIs(t, err, os.ErrNotExist)
	})

	t.Run("throws error on missing table", func(t *testing.T) {
		// Setup mock postgres
		conn := pgtest.NewConn()
		defer conn.Close(t)
		mockMigrationHistory(conn).
			Query(testSchema).
			ReplyError(pgerrcode.UndefinedTable, `relation "supabase_migrations.schema_migrations" does not exist`).
			Query(INSERT_MIGRATION_VERSION, "0", "schema", []string{testSchema}).
			Reply("INSERT 0 1")
		// Run test
		err := ApplyMigrations(context.Background(), pending, conn.MockClient(t), testMigrations)
		// Check error
		assert.ErrorContains(t, err, `ERROR: relation "supabase_migrations.schema_migrations" does not exist (SQLSTATE 42P01)`)
	})
}

func mockMigrationHistory(conn *pgtest.MockConn) *pgtest.MockConn {
	conn.Query(SET_LOCK_TIMEOUT).
		Query(CREATE_VERSION_SCHEMA).
		Reply("CREATE SCHEMA").
		Query(CREATE_VERSION_TABLE).
		Reply("CREATE TABLE").
		Query(ADD_STATEMENTS_COLUMN).
		Reply("ALTER TABLE").
		Query(ADD_NAME_COLUMN).
		Reply("ALTER TABLE")
	return conn
}