Refactor database connection (#37496)

Clean up legacy copied&pasted code, introduce the unique "database connection" function. Move migration testing helper function PrepareTestEnv to a separate package. By the way, remove "shadow connection secrets" tricks: showing connection string on UI is useless --------- Co-authored-by: Nicolas <bircni@icloud.com>
2026-05-01 23:38:38 +08:00
parent 02b1b8a549
commit deb31d3f30
67 changed files with 611 additions and 865 deletions
@@ -6,17 +6,18 @@ package base
 import (
 	"testing"

+	"code.gitea.io/gitea/models/migrations/migrationtest"
 	"code.gitea.io/gitea/modules/timeutil"

 	"xorm.io/xorm/names"
 )

 func TestMain(m *testing.M) {
-	MainTest(m)
+	migrationtest.MainTest(m)
 }

 func Test_DropTableColumns(t *testing.T) {
-	x, deferable := PrepareTestEnv(t, 0)
+	x, deferable := migrationtest.PrepareTestEnv(t, 0)
 	defer deferable()
 	// FIXME: this logic seems wrong. Need to add an assertion here in the future, but it seems causing failure.
 	if x == nil || t.Failed() {
@@ -1,223 +0,0 @@
-// Copyright 2022 The Gitea Authors. All rights reserved.
-// SPDX-License-Identifier: MIT
-
-package base
-
-import (
-	"database/sql"
-	"fmt"
-	"os"
-	"path"
-	"path/filepath"
-	"testing"
-
-	"code.gitea.io/gitea/models/db"
-	"code.gitea.io/gitea/models/unittest"
-	"code.gitea.io/gitea/modules/git"
-	"code.gitea.io/gitea/modules/setting"
-	"code.gitea.io/gitea/modules/testlogger"
-	"code.gitea.io/gitea/modules/util"
-
-	"github.com/stretchr/testify/require"
-	"xorm.io/xorm"
-	"xorm.io/xorm/schemas"
-)
-
-// FIXME: this file shouldn't be in a normal package, it should only be compiled for tests
-
-func newXORMEngine(t *testing.T) (*xorm.Engine, error) {
-	if err := db.InitEngine(t.Context()); err != nil {
-		return nil, err
-	}
-	x := unittest.GetXORMEngine()
-	return x, nil
-}
-
-func deleteDB() error {
-	switch {
-	case setting.Database.Type.IsSQLite3():
-		if err := util.Remove(setting.Database.Path); err != nil {
-			return err
-		}
-		return os.MkdirAll(path.Dir(setting.Database.Path), os.ModePerm)
-
-	case setting.Database.Type.IsMySQL():
-		db, err := sql.Open("mysql", fmt.Sprintf("%s:%s@tcp(%s)/",
-			setting.Database.User, setting.Database.Passwd, setting.Database.Host))
-		if err != nil {
-			return err
-		}
-		defer db.Close()
-
-		if _, err = db.Exec("DROP DATABASE IF EXISTS " + setting.Database.Name); err != nil {
-			return err
-		}
-
-		if _, err = db.Exec("CREATE DATABASE IF NOT EXISTS " + setting.Database.Name); err != nil {
-			return err
-		}
-		return nil
-	case setting.Database.Type.IsPostgreSQL():
-		db, err := sql.Open("postgres", fmt.Sprintf("postgres://%s:%s@%s/?sslmode=%s",
-			setting.Database.User, setting.Database.Passwd, setting.Database.Host, setting.Database.SSLMode))
-		if err != nil {
-			return err
-		}
-		defer db.Close()
-
-		if _, err = db.Exec("DROP DATABASE IF EXISTS " + setting.Database.Name); err != nil {
-			return err
-		}
-
-		if _, err = db.Exec("CREATE DATABASE " + setting.Database.Name); err != nil {
-			return err
-		}
-		db.Close()
-
-		// Check if we need to set up a specific schema
-		if len(setting.Database.Schema) != 0 {
-			db, err = sql.Open("postgres", fmt.Sprintf("postgres://%s:%s@%s/%s?sslmode=%s",
-				setting.Database.User, setting.Database.Passwd, setting.Database.Host, setting.Database.Name, setting.Database.SSLMode))
-			if err != nil {
-				return err
-			}
-			defer db.Close()
-
-			schrows, err := db.Query(fmt.Sprintf("SELECT 1 FROM information_schema.schemata WHERE schema_name = '%s'", setting.Database.Schema))
-			if err != nil {
-				return err
-			}
-			defer schrows.Close()
-
-			if !schrows.Next() {
-				// Create and set up a DB schema
-				_, err = db.Exec("CREATE SCHEMA " + setting.Database.Schema)
-				if err != nil {
-					return err
-				}
-			}
-
-			// Make the user's default search path the created schema; this will affect new connections
-			_, err = db.Exec(fmt.Sprintf(`ALTER USER "%s" SET search_path = %s`, setting.Database.User, setting.Database.Schema))
-			if err != nil {
-				return err
-			}
-			return nil
-		}
-	case setting.Database.Type.IsMSSQL():
-		host, port := setting.ParseMSSQLHostPort(setting.Database.Host)
-		db, err := sql.Open("mssql", fmt.Sprintf("server=%s; port=%s; database=%s; user id=%s; password=%s;",
-			host, port, "master", setting.Database.User, setting.Database.Passwd))
-		if err != nil {
-			return err
-		}
-		defer db.Close()
-
-		if _, err = db.Exec(fmt.Sprintf("DROP DATABASE IF EXISTS [%s]", setting.Database.Name)); err != nil {
-			return err
-		}
-		if _, err = db.Exec(fmt.Sprintf("CREATE DATABASE [%s]", setting.Database.Name)); err != nil {
-			return err
-		}
-	default:
-		return fmt.Errorf("unsupported database type: %s", setting.Database.Type)
-	}
-
-	return nil
-}
-
-// PrepareTestEnv prepares the test environment and reset the database. The skip parameter should usually be 0.
-// Provide models to be sync'd with the database - in particular any models you expect fixtures to be loaded from.
-//
-// fixtures in `models/migrations/fixtures/<TestName>` will be loaded automatically
-func PrepareTestEnv(t *testing.T, skip int, syncModels ...any) (*xorm.Engine, func()) {
-	t.Helper()
-	ourSkip := 2
-	ourSkip += skip
-	deferFn := testlogger.PrintCurrentTest(t, ourSkip)
-	giteaRoot := setting.GetGiteaTestSourceRoot()
-	require.NoError(t, unittest.SyncDirs(filepath.Join(giteaRoot, "tests/gitea-repositories-meta"), setting.RepoRootPath))
-
-	if err := deleteDB(); err != nil {
-		t.Fatalf("unable to reset database: %v", err)
-		return nil, deferFn
-	}
-
-	x, err := newXORMEngine(t)
-	require.NoError(t, err)
-	if x != nil {
-		oldDefer := deferFn
-		deferFn = func() {
-			oldDefer()
-			if err := x.Close(); err != nil {
-				t.Errorf("error during close: %v", err)
-			}
-			if err := deleteDB(); err != nil {
-				t.Errorf("unable to reset database: %v", err)
-			}
-		}
-	}
-	if err != nil {
-		return x, deferFn
-	}
-
-	if len(syncModels) > 0 {
-		if err := x.Sync(syncModels...); err != nil {
-			t.Errorf("error during sync: %v", err)
-			return x, deferFn
-		}
-	}
-
-	fixturesDir := filepath.Join(giteaRoot, "models", "migrations", "fixtures", t.Name())
-
-	if _, err := os.Stat(fixturesDir); err == nil {
-		t.Logf("initializing fixtures from: %s", fixturesDir)
-		if err := unittest.InitFixtures(
-			unittest.FixturesOptions{
-				Dir: fixturesDir,
-			}, x); err != nil {
-			t.Errorf("error whilst initializing fixtures from %s: %v", fixturesDir, err)
-			return x, deferFn
-		}
-		if err := unittest.LoadFixtures(); err != nil {
-			t.Errorf("error whilst loading fixtures from %s: %v", fixturesDir, err)
-			return x, deferFn
-		}
-	} else if !os.IsNotExist(err) {
-		t.Errorf("unexpected error whilst checking for existence of fixtures: %v", err)
-	} else {
-		t.Logf("no fixtures found in: %s", fixturesDir)
-	}
-
-	return x, deferFn
-}
-
-func LoadTableSchemasMap(t *testing.T, x *xorm.Engine) map[string]*schemas.Table {
-	tables, err := x.DBMetas()
-	require.NoError(t, err)
-	tableMap := make(map[string]*schemas.Table)
-	for _, table := range tables {
-		tableMap[table.Name] = table
-	}
-	return tableMap
-}
-
-func mainTest(m *testing.M) int {
-	testlogger.Init()
-	err := setting.PrepareIntegrationTestConfig()
-	if err != nil {
-		return testlogger.MainErrorf("Unable to prepare integration test config: %v", err)
-	}
-	setting.SetupGiteaTestEnv()
-
-	if err = git.InitFull(); err != nil {
-		return testlogger.MainErrorf("Unable to InitFull: %v", err)
-	}
-	setting.LoadDBSetting()
-	setting.InitLoggersForTest()
-	return m.Run()
-}
-
-func MainTest(m *testing.M) {
-	os.Exit(mainTest(m))
-}