test: 测试库改为模板克隆并纳入完整租号 e2e

每个包不再重复 DROP+迁移,清空改用 DELETE 并重置自增,go test ./... 从约 6 分钟降到十几秒。租号全链路改走 NewTestDB,去掉依赖额外 DSN 才会跑的过渡测试。

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
yml2213
2026-09-10 15:46:18 +08:00
co-authored by Cursor
parent cbd5412315
commit 47ceb53c09
11 changed files with 456 additions and 275 deletions
+347 -63
View File
@@ -2,7 +2,9 @@ package database
import (
"context"
"crypto/sha256"
"database/sql"
"encoding/hex"
"errors"
"fmt"
"os"
@@ -11,6 +13,7 @@ import (
"runtime"
"strings"
"sync"
"time"
mysqldriver "github.com/go-sql-driver/mysql"
"gorm.io/driver/mysql"
@@ -22,6 +25,11 @@ import (
// 可通过 HFB_TEST_DSN 覆盖,库名必须包含 test 或 e2e。
const DefaultTestDSN = "hfb:secret@tcp(127.0.0.1:13306)/hfb_sys_test?charset=utf8mb4&parseTime=True&loc=Local"
const (
schemaMetaTable = "_test_schema_meta"
templateSuffix = "__template"
)
var (
testPrepareOnce sync.Once
testConn *gorm.DB
@@ -30,9 +38,10 @@ var (
// NewTestDB 返回指向 MySQL 测试库的干净连接。
//
// 首次调用会重建测试库并执行 backend/migrations 下的真实迁移,
// 因此测试用的表结构与生产完全一致;之后每次调用清空全部表,
// 使每个测试都从空库开始。
// 表结构来自 backend/migrations 的真实迁移,与生产一致。
// 迁移只在模板库上执行一次;各测试包克隆模板库,指纹未变则跨 `go test`
// 调用复用,避免每个包、每次运行都 DROP + 重放 68 条迁移。
// 每次调用仍会清空业务表,使测试从空库开始。
func NewTestDB() *gorm.DB {
db, err := sharedTestDB()
if err != nil {
@@ -94,13 +103,25 @@ func openTestDatabase() (*gorm.DB, error) {
if err != nil {
return nil, fmt.Errorf("解析测试库 DSN 失败: %w", err)
}
// 每个测试包使用独立库,避免 go test ./... 并发时互相重建同一个库。
cfg.DBName = cfg.DBName + "_" + packageSuffix()
if err := assertTestDatabaseName(cfg.DBName); err != nil {
baseName := cfg.DBName
templateName := baseName + templateSuffix
packageName := baseName + "_" + packageSuffix()
if err := assertTestDatabaseName(templateName); err != nil {
return nil, err
}
if err := assertTestDatabaseName(packageName); err != nil {
return nil, err
}
dir, err := migrationDir()
if err != nil {
return nil, err
}
fingerprint, err := migrationFingerprint(dir)
if err != nil {
return nil, err
}
// 重建空库,保证表结构只来自 migrations。
serverCfg := cfg.Clone()
serverCfg.DBName = ""
serverCfg.MultiStatements = false
@@ -109,23 +130,27 @@ func openTestDatabase() (*gorm.DB, error) {
return nil, fmt.Errorf("连接 MySQL 服务失败: %w", err)
}
defer func() { _ = serverDB.Close() }()
if _, err := serverDB.Exec("DROP DATABASE IF EXISTS `" + cfg.DBName + "`"); err != nil {
return nil, fmt.Errorf("删除测试库失败: %w", err)
}
if _, err := serverDB.Exec("CREATE DATABASE `" + cfg.DBName + "` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci"); err != nil {
return nil, fmt.Errorf("创建测试库失败: %w", err)
if err := serverDB.Ping(); err != nil {
return nil, fmt.Errorf("连接 MySQL 服务失败: %w", err)
}
if err := ensureTemplate(serverDB, templateName, dir, fingerprint); err != nil {
return nil, err
}
if err := ensurePackageClone(serverDB, templateName, packageName, fingerprint); err != nil {
return nil, err
}
cfg.DBName = packageName
cfg.ParseTime = true
cfg.MultiStatements = true
sqlDB, err := sql.Open("mysql", cfg.FormatDSN())
if err != nil {
return nil, fmt.Errorf("连接测试库失败: %w", err)
}
if err := applyMigrations(sqlDB); err != nil {
_ = sqlDB.Close()
return nil, err
}
sqlDB.SetMaxOpenConns(8)
sqlDB.SetMaxIdleConns(8)
sqlDB.SetConnMaxLifetime(30 * time.Minute)
gormDB, err := gorm.Open(mysql.New(mysql.Config{Conn: sqlDB}), &gorm.Config{
Logger: logger.Default.LogMode(logger.Silent),
})
@@ -136,6 +161,232 @@ func openTestDatabase() (*gorm.DB, error) {
return gormDB, nil
}
func ensureTemplate(serverDB *sql.DB, name, dir, fingerprint string) error {
return withMySQLLock(serverDB, mysqlLockName("tpl", name), func() error {
if readFingerprint(serverDB, name) == fingerprint {
return nil
}
if _, err := serverDB.Exec("DROP DATABASE IF EXISTS `" + name + "`"); err != nil {
return fmt.Errorf("删除模板库失败: %w", err)
}
if _, err := serverDB.Exec("CREATE DATABASE `" + name + "` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci"); err != nil {
return fmt.Errorf("创建模板库失败: %w", err)
}
if err := applyMigrationsTo(name, dir); err != nil {
return err
}
return writeFingerprint(serverDB, name, fingerprint)
})
}
func ensurePackageClone(serverDB *sql.DB, templateName, packageName, fingerprint string) error {
return withMySQLLock(serverDB, mysqlLockName("pkg", packageName), func() error {
if readFingerprint(serverDB, packageName) == fingerprint {
return nil
}
return cloneDatabase(serverDB, templateName, packageName)
})
}
func applyMigrationsTo(dbName, dir string) error {
cfg, err := parseTestDSN()
if err != nil {
return err
}
cfg.DBName = dbName
cfg.ParseTime = true
cfg.MultiStatements = true
db, err := sql.Open("mysql", cfg.FormatDSN())
if err != nil {
return fmt.Errorf("连接模板库失败: %w", err)
}
defer func() { _ = db.Close() }()
return applyMigrations(db, dir)
}
func parseTestDSN() (*mysqldriver.Config, error) {
rawDSN := strings.TrimSpace(os.Getenv("HFB_TEST_DSN"))
if rawDSN == "" {
rawDSN = DefaultTestDSN
}
cfg, err := mysqldriver.ParseDSN(rawDSN)
if err != nil {
return nil, fmt.Errorf("解析测试库 DSN 失败: %w", err)
}
return cfg, nil
}
func applyMigrations(db *sql.DB, dir string) error {
entries, err := os.ReadDir(dir)
if err != nil {
return fmt.Errorf("读取迁移目录失败: %w", err)
}
for _, entry := range entries {
if entry.IsDir() || !strings.HasSuffix(entry.Name(), ".sql") {
continue
}
raw, err := os.ReadFile(filepath.Join(dir, entry.Name()))
if err != nil {
return fmt.Errorf("读取迁移 %s 失败: %w", entry.Name(), err)
}
if _, err := db.Exec(gooseUpSQL(string(raw))); err != nil {
return fmt.Errorf("执行迁移 %s 失败: %w", entry.Name(), err)
}
}
return nil
}
func cloneDatabase(serverDB *sql.DB, src, dest string) error {
if _, err := serverDB.Exec("DROP DATABASE IF EXISTS `" + dest + "`"); err != nil {
return fmt.Errorf("删除测试库 %s 失败: %w", dest, err)
}
if _, err := serverDB.Exec("CREATE DATABASE `" + dest + "` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci"); err != nil {
return fmt.Errorf("创建测试库 %s 失败: %w", dest, err)
}
tables, err := listBaseTables(serverDB, src)
if err != nil {
return err
}
cfg, err := parseTestDSN()
if err != nil {
return err
}
cfg.DBName = dest
cfg.MultiStatements = false
destDB, err := sql.Open("mysql", cfg.FormatDSN())
if err != nil {
return fmt.Errorf("连接测试库 %s 失败: %w", dest, err)
}
defer func() { _ = destDB.Close() }()
ctx := context.Background()
conn, err := destDB.Conn(ctx)
if err != nil {
return err
}
defer func() { _ = conn.Close() }()
if _, err := conn.ExecContext(ctx, "SET FOREIGN_KEY_CHECKS = 0"); err != nil {
return err
}
defer func() { _, _ = conn.ExecContext(ctx, "SET FOREIGN_KEY_CHECKS = 1") }()
for _, table := range tables {
var name, create string
if err := serverDB.QueryRow("SHOW CREATE TABLE `"+src+"`.`"+table+"`").Scan(&name, &create); err != nil {
return fmt.Errorf("读取表结构 %s.%s 失败: %w", src, table, err)
}
if _, err := conn.ExecContext(ctx, create); err != nil {
return fmt.Errorf("克隆表 %s 失败: %w", table, err)
}
if _, err := conn.ExecContext(ctx, "INSERT INTO `"+table+"` SELECT * FROM `"+src+"`.`"+table+"`"); err != nil {
return fmt.Errorf("克隆表数据 %s 失败: %w", table, err)
}
}
return nil
}
func listBaseTables(db *sql.DB, schema string) ([]string, error) {
rows, err := db.Query(
"SELECT table_name FROM information_schema.tables "+
"WHERE table_schema = ? AND table_type = 'BASE TABLE' ORDER BY table_name",
schema,
)
if err != nil {
return nil, err
}
defer func() { _ = rows.Close() }()
var tables []string
for rows.Next() {
var name string
if err := rows.Scan(&name); err != nil {
return nil, err
}
tables = append(tables, name)
}
return tables, rows.Err()
}
func writeFingerprint(db *sql.DB, schema, fingerprint string) error {
ddl := "CREATE TABLE IF NOT EXISTS `" + schema + "`.`" + schemaMetaTable + "` (" +
"k VARCHAR(64) NOT NULL PRIMARY KEY," +
"v VARCHAR(128) NOT NULL" +
") ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci"
if _, err := db.Exec(ddl); err != nil {
return fmt.Errorf("创建模板指纹表失败: %w", err)
}
if _, err := db.Exec(
"REPLACE INTO `"+schema+"`.`"+schemaMetaTable+"` (k, v) VALUES (?, ?)",
"fingerprint", fingerprint,
); err != nil {
return fmt.Errorf("写入模板指纹失败: %w", err)
}
return nil
}
func readFingerprint(db *sql.DB, schema string) string {
var value string
err := db.QueryRow(
"SELECT v FROM `" + schema + "`.`" + schemaMetaTable + "` WHERE k = 'fingerprint'",
).Scan(&value)
if err != nil {
return ""
}
return value
}
func withMySQLLock(db *sql.DB, name string, fn func() error) error {
ctx, cancel := context.WithTimeout(context.Background(), 2*time.Minute)
defer cancel()
conn, err := db.Conn(ctx)
if err != nil {
return err
}
defer func() { _ = conn.Close() }()
var got int
if err := conn.QueryRowContext(ctx, "SELECT GET_LOCK(?, 120)", name).Scan(&got); err != nil {
return fmt.Errorf("GET_LOCK %s 失败: %w", name, err)
}
if got != 1 {
return fmt.Errorf("GET_LOCK %s 未拿到锁", name)
}
defer func() {
_, _ = conn.ExecContext(context.Background(), "SELECT RELEASE_LOCK(?)", name)
}()
return fn()
}
func mysqlLockName(kind, dbName string) string {
raw := "hfb:" + kind + ":" + dbName
if len(raw) <= 64 {
return raw
}
sum := sha256.Sum256([]byte(raw))
return ("hfb:" + kind + ":") + hex.EncodeToString(sum[:12])
}
func migrationFingerprint(dir string) (string, error) {
entries, err := os.ReadDir(dir)
if err != nil {
return "", fmt.Errorf("读取迁移目录失败: %w", err)
}
h := sha256.New()
for _, entry := range entries {
if entry.IsDir() || !strings.HasSuffix(entry.Name(), ".sql") {
continue
}
_, _ = fmt.Fprintf(h, "%s\n", entry.Name())
raw, err := os.ReadFile(filepath.Join(dir, entry.Name()))
if err != nil {
return "", fmt.Errorf("读取迁移 %s 失败: %w", entry.Name(), err)
}
_, _ = h.Write(raw)
}
return hex.EncodeToString(h.Sum(nil)), nil
}
// assertTestDatabaseName 拒绝重置非测试库,避免误删生产数据。
func assertTestDatabaseName(name string) error {
if name == "" {
@@ -176,30 +427,6 @@ func migrationDir() (string, error) {
return filepath.Join(filepath.Dir(currentFile), "..", "..", "migrations"), nil
}
func applyMigrations(db *sql.DB) error {
dir, err := migrationDir()
if err != nil {
return err
}
entries, err := os.ReadDir(dir)
if err != nil {
return fmt.Errorf("读取迁移目录失败: %w", err)
}
for _, entry := range entries {
if entry.IsDir() || !strings.HasSuffix(entry.Name(), ".sql") {
continue
}
raw, err := os.ReadFile(filepath.Join(dir, entry.Name()))
if err != nil {
return fmt.Errorf("读取迁移 %s 失败: %w", entry.Name(), err)
}
if _, err := db.Exec(gooseUpSQL(string(raw))); err != nil {
return fmt.Errorf("执行迁移 %s 失败: %w", entry.Name(), err)
}
}
return nil
}
// gooseUpSQL 截取 goose 迁移文件的 Up 段,Down 段与 goose 指令行原样保留,
// 后者在 MySQL 中属于注释,不影响执行。
func gooseUpSQL(raw string) string {
@@ -212,40 +439,97 @@ func gooseUpSQL(raw string) string {
return raw
}
// truncateAllTables 清空测试库中的全部基础表,使每个测试从空库开始。
// truncateAllTables 清空测试库中的全部业务表,使每个测试从空库开始。
// 指纹表保留,以便跨进程复用已克隆的库。
//
// 先用一条多语句 DELETE 清数据(测试数据量很小,通常几十毫秒),再把用过的
// AUTO_INCREMENT 表打回 1。全量 TRUNCATE 61 张表是 DDL,单次约 0.6s–1.4s,
// 而不少测试硬编码了 id=1,所以自增必须重置。
func truncateAllTables(db *gorm.DB) error {
var tables []string
if err := db.Raw(
"SELECT table_name FROM information_schema.tables " +
"WHERE table_schema = DATABASE() AND table_type = 'BASE TABLE'",
).Scan(&tables).Error; err != nil {
return err
}
if len(tables) == 0 {
return nil
}
sqlDB, err := db.DB()
if err != nil {
return err
}
ctx := context.Background()
// 固定单连接,保证 FOREIGN_KEY_CHECKS 的会话变量对后续 TRUNCATE 生效。
conn, err := sqlDB.Conn(ctx)
tables, err := listCurrentDatabaseTables(sqlDB)
if err != nil {
return err
}
defer func() { _ = conn.Close() }()
var b strings.Builder
b.WriteString("SET FOREIGN_KEY_CHECKS=0;")
count := 0
for _, table := range tables {
if table == schemaMetaTable {
continue
}
b.WriteString("DELETE FROM `")
b.WriteString(table)
b.WriteString("`;")
count++
}
if count == 0 {
return nil
}
b.WriteString("SET FOREIGN_KEY_CHECKS=1;")
if _, err := sqlDB.Exec(b.String()); err != nil {
return fmt.Errorf("清空测试表失败: %w", err)
}
if _, err := conn.ExecContext(ctx, "SET FOREIGN_KEY_CHECKS = 0"); err != nil {
aiTables, err := listAutoIncrementTables(sqlDB)
if err != nil {
return err
}
defer func() { _, _ = conn.ExecContext(ctx, "SET FOREIGN_KEY_CHECKS = 1") }()
for _, table := range tables {
if _, err := conn.ExecContext(ctx, "TRUNCATE TABLE `"+table+"`"); err != nil {
return fmt.Errorf("清空表 %s 失败: %w", table, err)
}
if len(aiTables) == 0 {
return nil
}
b.Reset()
for _, table := range aiTables {
b.WriteString("ALTER TABLE `")
b.WriteString(table)
b.WriteString("` AUTO_INCREMENT=1;")
}
if _, err := sqlDB.Exec(b.String()); err != nil {
return fmt.Errorf("重置自增失败: %w", err)
}
return nil
}
func listAutoIncrementTables(db *sql.DB) ([]string, error) {
rows, err := db.Query(
"SELECT table_name FROM information_schema.tables "+
"WHERE table_schema = DATABASE() AND table_name <> ? AND auto_increment > 1",
schemaMetaTable,
)
if err != nil {
return nil, err
}
defer func() { _ = rows.Close() }()
var tables []string
for rows.Next() {
var name string
if err := rows.Scan(&name); err != nil {
return nil, err
}
tables = append(tables, name)
}
return tables, rows.Err()
}
func listCurrentDatabaseTables(db *sql.DB) ([]string, error) {
rows, err := db.Query(
"SELECT table_name FROM information_schema.tables " +
"WHERE table_schema = DATABASE() AND table_type = 'BASE TABLE'",
)
if err != nil {
return nil, err
}
defer func() { _ = rows.Close() }()
var tables []string
for rows.Next() {
var name string
if err := rows.Scan(&name); err != nil {
return nil, err
}
tables = append(tables, name)
}
return tables, rows.Err()
}
+101
View File
@@ -0,0 +1,101 @@
package database
import (
"strings"
"testing"
)
func TestAssertTestDatabaseName(t *testing.T) {
t.Parallel()
cases := []struct {
name string
wantErr string
}{
{name: "hfb_sys_test", wantErr: ""},
{name: "hfb_sys_test_order", wantErr: ""},
{name: "hfb_e2e_flow", wantErr: ""},
{name: "", wantErr: "必须包含数据库名"},
{name: "hfb-sys-test", wantErr: "只允许字母、数字、下划线"},
{name: "hfb_sys", wantErr: "需包含 test 或 e2e"},
{name: strings.Repeat("test_", 20), wantErr: "超过 MySQL 上限"},
}
for _, item := range cases {
err := assertTestDatabaseName(item.name)
if item.wantErr == "" {
if err != nil {
t.Fatalf("%q: unexpected error %v", item.name, err)
}
continue
}
if err == nil || !strings.Contains(err.Error(), item.wantErr) {
t.Fatalf("%q: error = %v, want containing %q", item.name, err, item.wantErr)
}
}
}
func TestGooseUpSQL(t *testing.T) {
t.Parallel()
raw := "-- +goose Up\nCREATE TABLE t (id INT);\n-- +goose Down\nDROP TABLE t;\n"
got := strings.TrimSpace(gooseUpSQL(raw))
if got != "CREATE TABLE t (id INT);" {
t.Fatalf("gooseUpSQL = %q", got)
}
}
func TestNewDryRunDB(t *testing.T) {
t.Parallel()
if NewDryRunDB() == nil {
t.Fatal("NewDryRunDB returned nil")
}
}
func TestNewTestDBTruncatesBetweenCalls(t *testing.T) {
db := NewTestDB()
if err := db.Exec("INSERT INTO users (phone) VALUES ('13900001111')").Error; err != nil {
t.Fatalf("insert user: %v", err)
}
var n int64
if err := db.Raw("SELECT COUNT(*) FROM users").Scan(&n).Error; err != nil {
t.Fatal(err)
}
if n != 1 {
t.Fatalf("users count = %d, want 1", n)
}
db = NewTestDB()
if err := db.Raw("SELECT COUNT(*) FROM users").Scan(&n).Error; err != nil {
t.Fatal(err)
}
if n != 0 {
t.Fatalf("users count after reset = %d, want 0", n)
}
}
func TestNewTestDBKeepsSchemaFingerprint(t *testing.T) {
db := NewTestDB()
var fingerprint string
if err := db.Raw("SELECT v FROM " + schemaMetaTable + " WHERE k = 'fingerprint'").Scan(&fingerprint).Error; err != nil {
t.Fatalf("read fingerprint: %v", err)
}
if fingerprint == "" {
t.Fatal("expected schema fingerprint to survive truncate")
}
}
func TestNewTestDBResetsAutoIncrement(t *testing.T) {
db := NewTestDB()
if err := db.Exec("INSERT INTO users (phone) VALUES ('13900002222')").Error; err != nil {
t.Fatal(err)
}
db = NewTestDB()
if err := db.Exec("INSERT INTO users (phone) VALUES ('13900003333')").Error; err != nil {
t.Fatal(err)
}
var id uint64
if err := db.Raw("SELECT id FROM users WHERE phone = '13900003333'").Scan(&id).Error; err != nil {
t.Fatal(err)
}
if id != 1 {
t.Fatalf("id after reset = %d, want 1", id)
}
}