Add migration tests for postgres (#669)

.ecrc

@@ -8,6 +8,7 @@
     "LICENSE",
     "node_modules",
     "server/store/datastore/migration/test-files/sqlite.db",
+    "server/store/datastore/migration/test-files/postgres.sql",
     "server/store/datastore/feed.go",
     "cmd/server/openapi/docs.go",
     "_test.go",

.pre-commit-config.yaml

@@ -8,6 +8,7 @@ repos:
     rev: v6.0.0
     hooks:
       - id: end-of-file-fixer
+        exclude: '\.sql$'
       - id: trailing-whitespace
         exclude: ^docs/versioned_docs/.+/40-cli.md$
   - repo: https://github.com/golangci/golangci-lint

server/store/datastore/migration/migration_test.go

@@ -15,7 +15,9 @@
 package migration
 
 import (
+	"database/sql"
 	"os"
+	"strings"
 	"testing"
 	"time"
 
@@ -24,12 +26,14 @@ import (
 	_ "github.com/lib/pq"
 	_ "github.com/mattn/go-sqlite3"
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 	"xorm.io/xorm"
 	"xorm.io/xorm/schemas"
 )
 
 const (
 	sqliteDB     = "./test-files/sqlite.db"
+	postgresDump = "./test-files/postgres.sql"
 )
 
 func testDriver() string {
@@ -42,13 +46,9 @@ func testDriver() string {
 
 func createSQLiteDB(t *testing.T) string {
 	tmpF, err := os.CreateTemp("./test-files", "tmp_")
-	if !assert.NoError(t, err) {
+	require.NoError(t, err)
-		t.FailNow()
-	}
 	dbF, err := os.ReadFile(sqliteDB)
-	if !assert.NoError(t, err) {
+	require.NoError(t, err)
-		t.FailNow()
-	}
 
 	if !assert.NoError(t, os.WriteFile(tmpF.Name(), dbF, 0o644)) {
 		t.FailNow()
@@ -70,20 +70,27 @@ func testDB(t *testing.T, initNewDB bool) (engine *xorm.Engine, closeDB func())
 			}
 		}
 		engine, err = xorm.NewEngine(driver, config)
-		if !assert.NoError(t, err) {
+		require.NoError(t, err)
-			t.FailNow()
-		}
 		return engine, closeDB
-	case "mysql", "postgres":
+	case "mysql":
 		config := os.Getenv("WOODPECKER_DATABASE_DATASOURCE")
 		if !initNewDB {
 			t.Logf("do not have dump to test against")
 			t.SkipNow()
 		}
 		engine, err = xorm.NewEngine(driver, config)
-		if !assert.NoError(t, err) {
+		require.NoError(t, err)
-			t.FailNow()
+		return engine, closeDB
+	case "postgres":
+		config := os.Getenv("WOODPECKER_DATABASE_DATASOURCE")
+		closeDB = func() {
+			cleanPostgresDB(t, config)
 		}
+		if !initNewDB {
+			restorePostgresDump(t, config)
+		}
+		engine, err = xorm.NewEngine(driver, config)
+		require.NoError(t, err)
 		return engine, closeDB
 	default:
 		t.Errorf("unsupported driver: %s", driver)
@@ -92,6 +99,58 @@ func testDB(t *testing.T, initNewDB bool) (engine *xorm.Engine, closeDB func())
 	return engine, closeDB
 }
 
+// restorePostgresDump only supports dumps generated with `pg_dump --inserts`.
+func restorePostgresDump(t *testing.T, config string) {
+	dump, err := os.ReadFile(postgresDump)
+	require.NoError(t, err)
+
+	db, err := sql.Open("postgres", config)
+	require.NoError(t, err)
+	defer db.Close()
+
+	// clean dump
+	lines := strings.Split(string(dump), "\n")
+	newLines := make([]string, 0, len(lines))
+	for _, line := range lines {
+		line = strings.TrimSpace(line)
+		switch {
+		case line == "",
+			strings.HasPrefix(line, "\\"),
+			strings.HasPrefix(line, "--"):
+			continue
+		}
+		newLines = append(newLines, line)
+	}
+
+	for _, stmt := range strings.Split(strings.Join(newLines, "\n"), ";") {
+		if stmt == "" {
+			continue
+		}
+
+		_, err = db.Exec(stmt)
+		if err != nil {
+			t.Logf("Failed to execute statement: %s", stmt[:min(len(stmt), 100)])
+			require.NoErrorf(t, err, "could not load postgres dump")
+		}
+	}
+}
+
+func cleanPostgresDB(t *testing.T, config string) {
+	db, err := sql.Open("postgres", config)
+	require.NoError(t, err)
+	defer db.Close()
+
+	// Drop and recreate the public schema
+	// This removes all tables, indexes, constraints, sequences, etc.
+	_, err = db.Exec(`
+		DROP SCHEMA public CASCADE;
+		CREATE SCHEMA public;
+		GRANT ALL ON SCHEMA public TO postgres;
+		GRANT ALL ON SCHEMA public TO public;
+	`)
+	require.NoError(t, err)
+}
+
 func TestMigrate(t *testing.T) {
 	// init new db
 	engine, closeDB := testDB(t, true)