package sqlutil_test import ( "context" "database/sql" "fmt" "reflect" "testing" _ "github.com/mattn/go-sqlite3" "github.com/matrix-org/dendrite/internal/sqlutil" "github.com/matrix-org/dendrite/test" ) var dummyMigrations = []sqlutil.Migration{ { Version: "init", Up: func(ctx context.Context, txn *sql.Tx) error { _, err := txn.ExecContext(ctx, "CREATE TABLE IF NOT EXISTS dummy ( test TEXT );") return err }, }, { Version: "v2", Up: func(ctx context.Context, txn *sql.Tx) error { _, err := txn.ExecContext(ctx, "ALTER TABLE dummy ADD COLUMN test2 TEXT;") return err }, }, { Version: "v2", // duplicate, this migration will be skipped Up: func(ctx context.Context, txn *sql.Tx) error { _, err := txn.ExecContext(ctx, "ALTER TABLE dummy ADD COLUMN test2 TEXT;") return err }, }, { Version: "multiple execs", Up: func(ctx context.Context, txn *sql.Tx) error { _, err := txn.ExecContext(ctx, "ALTER TABLE dummy ADD COLUMN test3 TEXT;") if err != nil { return err } _, err = txn.ExecContext(ctx, "ALTER TABLE dummy ADD COLUMN test4 TEXT;") return err }, }, } var failMigration = sqlutil.Migration{ Version: "iFail", Up: func(ctx context.Context, txn *sql.Tx) error { return fmt.Errorf("iFail") }, Down: nil, } func Test_migrations_Up(t *testing.T) { withFail := append(dummyMigrations, failMigration) tests := []struct { name string migrations []sqlutil.Migration wantResult map[string]struct{} wantErr bool }{ { name: "dummy migration", migrations: dummyMigrations, wantResult: map[string]struct{}{ "init": {}, "v2": {}, "multiple execs": {}, }, }, { name: "with fail", migrations: withFail, wantErr: true, }, } ctx := context.Background() test.WithAllDatabases(t, func(t *testing.T, dbType test.DBType) { conStr, close := test.PrepareDBConnectionString(t, dbType) defer close() for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { driverName := "sqlite3" if dbType == test.DBTypePostgres { driverName = "postgres" } db, err := sql.Open(driverName, conStr) if err != nil { t.Errorf("unable to open database: %v", err) } m := sqlutil.NewMigrator(db) m.AddMigrations(tt.migrations...) if err = m.Up(ctx); (err != nil) != tt.wantErr { t.Errorf("Up() error = %v, wantErr %v", err, tt.wantErr) } result, err := m.ExecutedMigrations(ctx) if err != nil { t.Errorf("unable to get executed migrations: %v", err) } if !tt.wantErr && !reflect.DeepEqual(result, tt.wantResult) { t.Errorf("expected: %+v, got %v", tt.wantResult, result) } }) } }) } func Test_insertMigration(t *testing.T) { test.WithAllDatabases(t, func(t *testing.T, dbType test.DBType) { conStr, close := test.PrepareDBConnectionString(t, dbType) defer close() driverName := "sqlite3" if dbType == test.DBTypePostgres { driverName = "postgres" } db, err := sql.Open(driverName, conStr) if err != nil { t.Errorf("unable to open database: %v", err) } if err := sqlutil.InsertMigration(context.Background(), db, "testing"); err != nil { t.Fatalf("unable to insert migration: %s", err) } // Second insert should not return an error, as it was already executed. if err := sqlutil.InsertMigration(context.Background(), db, "testing"); err != nil { t.Fatalf("unable to insert migration: %s", err) } }) }