snapshot of https://github.com/golang-migrate/migrate.git (master, 2026-09-15; blobs > 131072B omitted)

database/spanner/spanner_test.go

@@ -0,0 +1,176 @@
+package spanner
+
+import (
+	"fmt"
+	"os"
+	"testing"
+
+	"github.com/golang-migrate/migrate/v4"
+
+	dt "github.com/golang-migrate/migrate/v4/database/testing"
+	_ "github.com/golang-migrate/migrate/v4/source/file"
+
+	"cloud.google.com/go/spanner/spannertest"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+// withSpannerEmulator is not thread-safe and cannot be used with parallel tests since it sets the emulator
+func withSpannerEmulator(t *testing.T, testFunc func(t *testing.T)) {
+	t.Helper()
+	srv, err := spannertest.NewServer("localhost:0")
+	if err != nil {
+		t.Fatal("Failed to create Spanner emulator:", err)
+	}
+	// This is not thread-safe
+	if err := os.Setenv("SPANNER_EMULATOR_HOST", srv.Addr); err != nil {
+		t.Fatal("Failed to set SPANNER_EMULATOR_HOST env var:", err)
+	}
+	defer srv.Close()
+	testFunc(t)
+
+}
+
+const db = "projects/abc/instances/def/databases/testdb"
+
+func Test(t *testing.T) {
+	withSpannerEmulator(t, func(t *testing.T) {
+		uri := fmt.Sprintf("spanner://%s", db)
+		s := &Spanner{}
+		d, err := s.Open(uri)
+		if err != nil {
+			t.Fatal(err)
+		}
+		dt.Test(t, d, []byte("CREATE TABLE test (id BOOL) PRIMARY KEY (id)"))
+	})
+}
+
+func TestMigrate(t *testing.T) {
+	withSpannerEmulator(t, func(t *testing.T) {
+		s := &Spanner{}
+		uri := fmt.Sprintf("spanner://%s", db)
+		d, err := s.Open(uri)
+		if err != nil {
+			t.Fatal(err)
+		}
+		m, err := migrate.NewWithDatabaseInstance("file://./examples/migrations", uri, d)
+		if err != nil {
+			t.Fatal(err)
+		}
+		dt.TestMigrate(t, m)
+	})
+}
+
+func TestCleanStatements(t *testing.T) {
+	testCases := []struct {
+		name           string
+		multiStatement string
+		expected       []string
+	}{
+		{
+			name:           "no statement",
+			multiStatement: "",
+			expected:       []string{},
+		},
+		{
+			name:           "single statement, single line, no semicolon, no comment",
+			multiStatement: "CREATE TABLE table_name (id STRING(255) NOT NULL) PRIMARY KEY (id)",
+			expected:       []string{"CREATE TABLE table_name (\n  id STRING(255) NOT NULL,\n) PRIMARY KEY(id)"},
+		},
+		{
+			name: "single statement, multi line, no semicolon, no comment",
+			multiStatement: `CREATE TABLE table_name (
+			id STRING(255) NOT NULL,
+		) PRIMARY KEY (id)`,
+			expected: []string{"CREATE TABLE table_name (\n  id STRING(255) NOT NULL,\n) PRIMARY KEY(id)"},
+		},
+		{
+			name:           "single statement, single line, with semicolon, no comment",
+			multiStatement: "CREATE TABLE table_name (id STRING(255) NOT NULL) PRIMARY KEY (id);",
+			expected:       []string{"CREATE TABLE table_name (\n  id STRING(255) NOT NULL,\n) PRIMARY KEY(id)"},
+		},
+		{
+			name:           "can clean uuid column types",
+			multiStatement: "CREATE TABLE table_name (id uuid NOT NULL) PRIMARY KEY (id);",
+			expected:       []string{"CREATE TABLE table_name (\n  id UUID NOT NULL,\n) PRIMARY KEY(id)"},
+		},
+		{
+			name: "single statement, multi line, with semicolon, no comment",
+			multiStatement: `CREATE TABLE table_name (
+			id STRING(255) NOT NULL,
+		) PRIMARY KEY (id);`,
+			expected: []string{"CREATE TABLE table_name (\n  id STRING(255) NOT NULL,\n) PRIMARY KEY(id)"},
+		},
+		{
+			name: "multi statement, with trailing semicolon. no comment",
+			// From https://github.com/mattes/migrate/pull/281
+			multiStatement: `CREATE TABLE table_name (
+			id STRING(255) NOT NULL,
+		) PRIMARY KEY(id);
+
+		CREATE INDEX table_name_id_idx ON table_name (id);`,
+			expected: []string{`CREATE TABLE table_name (
+  id STRING(255) NOT NULL,
+) PRIMARY KEY(id)`, "CREATE INDEX table_name_id_idx ON table_name(id)"},
+		},
+		{
+			name: "multi statement, no trailing semicolon, no comment",
+			// From https://github.com/mattes/migrate/pull/281
+			multiStatement: `CREATE TABLE table_name (
+			id STRING(255) NOT NULL,
+		) PRIMARY KEY(id);
+
+		CREATE INDEX table_name_id_idx ON table_name (id)`,
+			expected: []string{`CREATE TABLE table_name (
+  id STRING(255) NOT NULL,
+) PRIMARY KEY(id)`, "CREATE INDEX table_name_id_idx ON table_name(id)"},
+		},
+		{
+			name: "multi statement, no trailing semicolon, standalone comment",
+			// From https://github.com/mattes/migrate/pull/281
+			multiStatement: `CREATE TABLE table_name (
+			-- standalone comment
+			id STRING(255) NOT NULL,
+		) PRIMARY KEY(id);
+
+		CREATE INDEX table_name_id_idx ON table_name (id)`,
+			expected: []string{`CREATE TABLE table_name (
+  id STRING(255) NOT NULL,
+) PRIMARY KEY(id)`, "CREATE INDEX table_name_id_idx ON table_name(id)"},
+		},
+		{
+			name: "multi statement, no trailing semicolon, inline comment",
+			// From https://github.com/mattes/migrate/pull/281
+			multiStatement: `CREATE TABLE table_name (
+			id STRING(255) NOT NULL, -- inline comment
+		) PRIMARY KEY(id);
+
+		CREATE INDEX table_name_id_idx ON table_name (id)`,
+			expected: []string{`CREATE TABLE table_name (
+  id STRING(255) NOT NULL,
+) PRIMARY KEY(id)`, "CREATE INDEX table_name_id_idx ON table_name(id)"},
+		},
+		{
+			name: "alter table with SET OPTIONS",
+			multiStatement: `ALTER TABLE users ALTER COLUMN created
+			SET OPTIONS (allow_commit_timestamp=true);`,
+			expected: []string{"ALTER TABLE users ALTER COLUMN created SET OPTIONS (allow_commit_timestamp = true)"},
+		},
+		{
+			name: "column with NUMERIC type",
+			multiStatement: `CREATE TABLE table_name (
+				id STRING(255) NOT NULL,
+				sum NUMERIC,
+			) PRIMARY KEY (id)`,
+			expected: []string{"CREATE TABLE table_name (\n  id STRING(255) NOT NULL,\n  sum NUMERIC,\n) PRIMARY KEY(id)"},
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			stmts, err := cleanStatements([]byte(tc.multiStatement))
+			require.NoError(t, err, "Error cleaning statements")
+			assert.Equal(t, tc.expected, stmts)
+		})
+	}
+}