新增统一项目根实体及三库迁移并验证项目备份恢复
This commit is contained in:
1 parent
adb7d7f536
commit
6b72ac2e20
20 files changed
+846
-4
No files matched your search
@@ -13,6 +13,7 @@ import (
|
||||
|
||||
"git.pcux.cn/xuans/Scert/backend/internal/config"
|
||||
"git.pcux.cn/xuans/Scert/backend/internal/database"
|
||||
"git.pcux.cn/xuans/Scert/backend/internal/domain"
|
||||
"git.pcux.cn/xuans/Scert/backend/internal/repository"
|
||||
"git.pcux.cn/xuans/Scert/backend/internal/secretstore"
|
||||
"golang.org/x/crypto/bcrypt"
|
||||
@@ -82,6 +83,7 @@ func TestSQLiteBusinessUpgradeStandaloneCLI(t *testing.T) {
|
||||
runSQLiteProductCLI(t, binary, fixture, "backup", "--output", archive)
|
||||
runSQLiteProductCLI(t, binary, fixture, "certificate", "list")
|
||||
assertSQLiteCLIUpgradeUsable(t, fixture)
|
||||
createSQLiteProjectForBackup(t, fixture)
|
||||
upgraded := snapshotSQLiteCLIState(t, *cfg)
|
||||
currentArchive := filepath.Join(t.TempDir(), "upgraded-backup")
|
||||
runSQLiteProductCLI(t, binary, fixture, "backup", "--output", currentArchive)
|
||||
@@ -99,6 +101,10 @@ func TestSQLiteBusinessUpgradeStandaloneCLI(t *testing.T) {
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if _, err := current.DB.ExecContext(t.Context(), "UPDATE projects SET name = ?", "待恢复的项目名称"); err != nil {
|
||||
_ = current.Close()
|
||||
t.Fatal(err)
|
||||
}
|
||||
if _, err := current.DB.ExecContext(t.Context(), "UPDATE tasks SET message = '不应保留'; DELETE FROM domain_servers"); err != nil {
|
||||
_ = current.Close()
|
||||
t.Fatal(err)
|
||||
@@ -130,6 +136,19 @@ func TestSQLiteBusinessUpgradeStandaloneCLI(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func createSQLiteProjectForBackup(t *testing.T, fixture sqliteBusinessFixture) {
|
||||
t.Helper()
|
||||
db, err := database.Open(t.Context(), fixture.config.Database)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer db.Close()
|
||||
item := domain.Project{ID: "backup-project", Name: "独立程序备份项目", Description: "恢复时必须保留的项目说明"}
|
||||
if err := repository.NewSQLProjectRepository(db.DB).CreateProject(t.Context(), item); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
}
|
||||
|
||||
func runSQLiteProductCLI(t *testing.T, binary string, fixture sqliteBusinessFixture, args ...string) {
|
||||
t.Helper()
|
||||
ctx, cancel := context.WithTimeout(t.Context(), 30*time.Second)
|
||||
@@ -199,9 +218,13 @@ func assertSQLiteCLIUpgradeUsable(t *testing.T, fixture sqliteBusinessFixture) {
|
||||
}
|
||||
defer db.Close()
|
||||
var version, bindings int
|
||||
if err := db.DB.QueryRowContext(t.Context(), "SELECT MAX(version) FROM schema_migrations").Scan(&version); err != nil || version != 9 {
|
||||
if err := db.DB.QueryRowContext(t.Context(), "SELECT MAX(version) FROM schema_migrations").Scan(&version); err != nil || version != 10 {
|
||||
t.Fatalf("正式应用入口未完成历史升级:%d,%v", version, err)
|
||||
}
|
||||
project, err := repository.NewSQLProjectRepository(db.DB).GetProject(t.Context(), domain.DefaultProjectID)
|
||||
if err != nil || project.Name != "默认项目" {
|
||||
t.Fatalf("正式应用入口未保留默认项目:%+v,%v", project, err)
|
||||
}
|
||||
task, err := repository.NewSQLTaskRepository(db.DB).GetTask(t.Context(), "task")
|
||||
if err != nil || task.Message != "历史任务" || task.DomainID != "domain" || task.Status != "success" {
|
||||
t.Fatalf("历史任务不可用:%v", err)
|
||||
|
||||
@@ -11,6 +11,7 @@ import (
|
||||
|
||||
//go:embed migrations/sqlite/0001_initial.sql migrations/sqlite/0002_domain_options.sql migrations/sqlite/0003_deployment.sql migrations/sqlite/0004_task_attempts.sql migrations/sqlite/0005_users.sql migrations/sqlite/0006_server_validation.sql migrations/sqlite/0007_server_password_auth.sql migrations/sqlite/0009_server_ssh_key_status.sql migrations/mysql/0001_initial.sql migrations/mysql/0002_domain_options.sql migrations/mysql/0003_deployment.sql migrations/mysql/0004_task_attempts.sql migrations/mysql/0005_users.sql migrations/mysql/0006_server_validation.sql migrations/mysql/0007_server_password_auth.sql migrations/mysql/0009_server_ssh_key_status.sql migrations/postgres/0001_initial.sql migrations/postgres/0002_domain_options.sql migrations/postgres/0003_deployment.sql migrations/postgres/0004_task_attempts.sql migrations/postgres/0005_users.sql migrations/postgres/0006_server_validation.sql migrations/postgres/0007_server_password_auth.sql migrations/postgres/0009_server_ssh_key_status.sql
|
||||
//go:embed migrations/sqlite/0008_user_groups.sql migrations/mysql/0008_user_groups.sql migrations/postgres/0008_user_groups.sql
|
||||
//go:embed migrations/sqlite/0010_projects.sql migrations/mysql/0010_projects.sql migrations/postgres/0010_projects.sql
|
||||
var migrationFiles embed.FS
|
||||
|
||||
func Migrate(ctx context.Context, db *sql.DB, driver string) error {
|
||||
@@ -35,7 +36,7 @@ func Migrate(ctx context.Context, db *sql.DB, driver string) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
const latestMigrationVersion = 9
|
||||
const latestMigrationVersion = 10
|
||||
|
||||
// currentMigrationVersion 在执行业务迁移前拒绝新版数据库及不连续的迁移历史。
|
||||
func currentMigrationVersion(ctx context.Context, db *sql.DB) (int, error) {
|
||||
@@ -164,6 +165,8 @@ func migrationName(version int) string {
|
||||
return "user_groups"
|
||||
case 9:
|
||||
return "server_ssh_key_status"
|
||||
case 10:
|
||||
return "projects"
|
||||
default:
|
||||
return "unknown"
|
||||
}
|
||||
|
||||
@@ -58,7 +58,7 @@ func TestMigrationCatalogDetectsIncompleteChanges(t *testing.T) {
|
||||
mutate func(fstest.MapFS, fstest.MapFS)
|
||||
}{
|
||||
{"unregistered_source", func(source, embedded fstest.MapFS) {
|
||||
source["migrations/mysql/0010_extra.sql"] = &fstest.MapFile{Data: []byte("SELECT 1;")}
|
||||
source[fmt.Sprintf("migrations/mysql/%04d_extra.sql", latestMigrationVersion+1)] = &fstest.MapFile{Data: []byte("SELECT 1;")}
|
||||
}},
|
||||
{"missing_embed", func(source, embedded fstest.MapFS) { delete(embedded, "migrations/postgres/0001_initial.sql") }},
|
||||
{"missing_source", func(source, embedded fstest.MapFS) { delete(source, "migrations/sqlite/0001_initial.sql") }},
|
||||
@@ -73,7 +73,7 @@ func TestMigrationCatalogDetectsIncompleteChanges(t *testing.T) {
|
||||
delete(source, "migrations/mysql/0001_initial.sql")
|
||||
}},
|
||||
{"unregistered_embed", func(source, embedded fstest.MapFS) {
|
||||
embedded["migrations/postgres/0010_extra.sql"] = &fstest.MapFile{Data: []byte("SELECT 1;")}
|
||||
embedded[fmt.Sprintf("migrations/postgres/%04d_extra.sql", latestMigrationVersion+1)] = &fstest.MapFile{Data: []byte("SELECT 1;")}
|
||||
}},
|
||||
}
|
||||
for _, tc := range cases {
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
CREATE TABLE IF NOT EXISTS projects (
|
||||
id VARCHAR(36) NOT NULL PRIMARY KEY,
|
||||
name VARCHAR(128) NOT NULL,
|
||||
description TEXT NOT NULL,
|
||||
created_at DATETIME(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6),
|
||||
updated_at DATETIME(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6)
|
||||
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin;
|
||||
|
||||
INSERT INTO projects (id, name, description)
|
||||
SELECT 'default', '默认项目', '历史资源的默认归属项目'
|
||||
WHERE NOT EXISTS (SELECT 1 FROM projects WHERE id = 'default');
|
||||
@@ -0,0 +1,11 @@
|
||||
CREATE TABLE IF NOT EXISTS projects (
|
||||
id VARCHAR(36) NOT NULL PRIMARY KEY,
|
||||
name VARCHAR(128) NOT NULL,
|
||||
description TEXT NOT NULL,
|
||||
created_at TIMESTAMPTZ NOT NULL DEFAULT CURRENT_TIMESTAMP,
|
||||
updated_at TIMESTAMPTZ NOT NULL DEFAULT CURRENT_TIMESTAMP
|
||||
);
|
||||
|
||||
INSERT INTO projects (id, name, description)
|
||||
SELECT 'default', '默认项目', '历史资源的默认归属项目'
|
||||
WHERE NOT EXISTS (SELECT 1 FROM projects WHERE id = 'default');
|
||||
@@ -0,0 +1,11 @@
|
||||
CREATE TABLE IF NOT EXISTS projects (
|
||||
id TEXT NOT NULL PRIMARY KEY,
|
||||
name TEXT NOT NULL,
|
||||
description TEXT NOT NULL,
|
||||
created_at DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
|
||||
updated_at DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP
|
||||
);
|
||||
|
||||
INSERT INTO projects (id, name, description)
|
||||
SELECT 'default', '默认项目', '历史资源的默认归属项目'
|
||||
WHERE NOT EXISTS (SELECT 1 FROM projects WHERE id = 'default');
|
||||
@@ -0,0 +1,78 @@
|
||||
package database
|
||||
|
||||
import (
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestSQLiteProjectMigrationPreservesBusiness(t *testing.T) {
|
||||
db, err := Open(t.Context(), sqliteBusinessUpgradeConfig(t))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer db.Close()
|
||||
createSQLiteHistoricalBusiness(t, db.DB, 9)
|
||||
before := snapshotSQLiteHistoricalBusiness(t, db.DB)
|
||||
if err := Migrate(t.Context(), db.DB, "sqlite"); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
assertSQLiteHistoricalBusiness(t, db.DB, before)
|
||||
var name string
|
||||
if err := db.DB.QueryRowContext(t.Context(), "SELECT name FROM projects WHERE id = 'default'").Scan(&name); err != nil || name != "默认项目" {
|
||||
t.Fatalf("默认项目未创建:%q,%v", name, err)
|
||||
}
|
||||
if _, err := db.DB.ExecContext(t.Context(), "UPDATE projects SET name = '调整后的默认项目' WHERE id = 'default'"); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
// 模拟建表、种子写入已成功,但版本记录尚未落盘的可重试情况。
|
||||
if _, err := db.DB.ExecContext(t.Context(), "DELETE FROM schema_migrations WHERE version = 10"); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
for round := 0; round < 2; round++ {
|
||||
if err := Migrate(t.Context(), db.DB, "sqlite"); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
}
|
||||
var count int
|
||||
if err := db.DB.QueryRowContext(t.Context(), "SELECT COUNT(*) FROM projects").Scan(&count); err != nil || count != 1 {
|
||||
t.Fatalf("重复迁移改变项目数量:%d,%v", count, err)
|
||||
}
|
||||
if err := db.DB.QueryRowContext(t.Context(), "SELECT name FROM projects WHERE id = 'default'").Scan(&name); err != nil || name != "调整后的默认项目" {
|
||||
t.Fatalf("重复迁移覆盖用户修改:%q,%v", name, err)
|
||||
}
|
||||
assertSQLiteHistoricalBusiness(t, db.DB, before)
|
||||
}
|
||||
|
||||
func TestSQLiteProjectMigrationRollsBackAndRetries(t *testing.T) {
|
||||
db, err := Open(t.Context(), sqliteBusinessUpgradeConfig(t))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer db.Close()
|
||||
createSQLiteHistoricalBusiness(t, db.DB, 9)
|
||||
before := snapshotSQLiteHistoricalBusiness(t, db.DB)
|
||||
// 在登记版本时制造失败,验证同一事务中的新表及默认项目也会回滚。
|
||||
_, err = db.DB.ExecContext(t.Context(), `CREATE TRIGGER fail_project_version BEFORE INSERT ON schema_migrations
|
||||
WHEN NEW.version = 10 BEGIN SELECT RAISE(ABORT, 'test-only'); END`)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := Migrate(t.Context(), db.DB, "sqlite"); err == nil {
|
||||
t.Fatal("版本登记故障未阻断迁移")
|
||||
}
|
||||
version, err := currentMigrationVersion(t.Context(), db.DB)
|
||||
if err != nil || version != 9 {
|
||||
t.Fatalf("失败迁移错误登记版本:%d,%v", version, err)
|
||||
}
|
||||
var count int
|
||||
if err := db.DB.QueryRowContext(t.Context(), "SELECT COUNT(*) FROM sqlite_master WHERE name = 'projects'").Scan(&count); err != nil || count != 0 {
|
||||
t.Fatalf("失败迁移未回滚项目表:%d,%v", count, err)
|
||||
}
|
||||
assertSQLiteHistoricalBusiness(t, db.DB, before)
|
||||
if _, err := db.DB.ExecContext(t.Context(), "DROP TRIGGER fail_project_version"); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := Migrate(t.Context(), db.DB, "sqlite"); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
assertSQLiteHistoricalBusiness(t, db.DB, before)
|
||||
}
|
||||
@@ -0,0 +1,72 @@
|
||||
package database
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestMySQLRealProjectMigrationRetry(t *testing.T) {
|
||||
fixture := startRealMySQL(t)
|
||||
db := fixture.database(t)
|
||||
ctx := t.Context()
|
||||
if _, err := db.DB.ExecContext(ctx, migrationTableSQL("mysql")); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
for version := 1; version <= 9; version++ {
|
||||
if err := applyMigration(ctx, db.DB, "mysql", version); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
}
|
||||
if _, err := db.DB.ExecContext(ctx, `INSERT INTO tasks (id, domain_id, task_type, status, message)
|
||||
VALUES ('historical-task', 'historical-domain', 'deploy', 'success', '保留历史任务')`); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
// MySQL 的 DDL 不会随事务回滚,必须验证建表后版本登记失败可安全重试。
|
||||
var schema string
|
||||
if err := db.DB.QueryRowContext(ctx, "SELECT DATABASE()").Scan(&schema); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
schema = "`" + strings.ReplaceAll(schema, "`", "``") + "`"
|
||||
// 故障注入仅使用隔离实例管理连接,不给产品连接增加全局权限。
|
||||
if _, err := fixture.admin.ExecContext(ctx, `CREATE TRIGGER `+schema+`.fail_project_version BEFORE INSERT ON `+schema+`.schema_migrations
|
||||
FOR EACH ROW SIGNAL SQLSTATE '45000' SET MESSAGE_TEXT = 'test-only'`); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := Migrate(ctx, db.DB, "mysql"); err == nil {
|
||||
t.Fatal("版本登记故障未阻断 MySQL 迁移")
|
||||
}
|
||||
version, err := currentMigrationVersion(ctx, db.DB)
|
||||
if err != nil || version != 9 {
|
||||
t.Fatalf("失败迁移错误登记版本:%d,%v", version, err)
|
||||
}
|
||||
var name string
|
||||
if err := db.DB.QueryRowContext(ctx, "SELECT name FROM projects WHERE id = 'default'").Scan(&name); err != nil || name != "默认项目" {
|
||||
t.Fatalf("MySQL 部分迁移的默认项目缺失:%q,%v", name, err)
|
||||
}
|
||||
if _, err := db.DB.ExecContext(ctx, "UPDATE projects SET name = '保留用户调整' WHERE id = 'default'"); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if _, err := fixture.admin.ExecContext(ctx, "DROP TRIGGER "+schema+".fail_project_version"); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
for repeat := 0; repeat < 2; repeat++ {
|
||||
if err := Migrate(ctx, db.DB, "mysql"); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
}
|
||||
var count int
|
||||
if err := db.DB.QueryRowContext(ctx, "SELECT COUNT(*) FROM projects").Scan(&count); err != nil || count != 1 {
|
||||
t.Fatalf("重试后项目数量错误:%d,%v", count, err)
|
||||
}
|
||||
if err := db.DB.QueryRowContext(ctx, "SELECT name FROM projects WHERE id = 'default'").Scan(&name); err != nil || name != "保留用户调整" {
|
||||
t.Fatalf("重试覆盖已有默认项目:%q,%v", name, err)
|
||||
}
|
||||
var message string
|
||||
if err := db.DB.QueryRowContext(ctx, "SELECT message FROM tasks WHERE id = 'historical-task'").Scan(&message); err != nil || message != "保留历史任务" {
|
||||
t.Fatalf("迁移影响历史任务:%q,%v", message, err)
|
||||
}
|
||||
version, err = currentMigrationVersion(ctx, db.DB)
|
||||
if err != nil || version != latestMigrationVersion {
|
||||
t.Fatalf("重试后迁移版本不完整:%d,%v", version, err)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,62 @@
|
||||
package domain
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"regexp"
|
||||
"strings"
|
||||
"time"
|
||||
"unicode"
|
||||
"unicode/utf8"
|
||||
)
|
||||
|
||||
const DefaultProjectID = "default"
|
||||
|
||||
var projectIDPattern = regexp.MustCompile(`^[a-z0-9][a-z0-9_-]{0,35}$`)
|
||||
|
||||
type Project struct {
|
||||
ID string `json:"id"`
|
||||
Name string `json:"name"`
|
||||
Description string `json:"description"`
|
||||
CreatedAt time.Time `json:"created_at"`
|
||||
UpdatedAt time.Time `json:"updated_at"`
|
||||
}
|
||||
|
||||
func NewProject(name, description string) (Project, error) {
|
||||
now := time.Now().UTC()
|
||||
item := (Project{
|
||||
ID: NewID(), Name: name, Description: description,
|
||||
CreatedAt: now, UpdatedAt: now,
|
||||
}).Normalize()
|
||||
if err := item.Validate(); err != nil {
|
||||
return Project{}, err
|
||||
}
|
||||
return item, nil
|
||||
}
|
||||
|
||||
func (p Project) Normalize() Project {
|
||||
p.ID = strings.TrimSpace(p.ID)
|
||||
p.Name = strings.TrimSpace(p.Name)
|
||||
p.Description = strings.TrimSpace(p.Description)
|
||||
return p
|
||||
}
|
||||
|
||||
func (p Project) Validate() error {
|
||||
if !projectIDPattern.MatchString(p.ID) {
|
||||
return errors.New("项目 ID 必须为 1~36 位小写字母、数字、连字符或下划线,并以字母或数字开头")
|
||||
}
|
||||
if !utf8.ValidString(p.Name) || strings.TrimSpace(p.Name) == "" || utf8.RuneCountInString(p.Name) > 128 {
|
||||
return errors.New("项目名称必须为 1~128 个字符")
|
||||
}
|
||||
if strings.ContainsFunc(p.Name, unicode.IsControl) {
|
||||
return errors.New("项目名称不能包含控制字符")
|
||||
}
|
||||
if !utf8.ValidString(p.Description) || utf8.RuneCountInString(p.Description) > 4096 {
|
||||
return errors.New("项目说明不能超过 4096 个字符")
|
||||
}
|
||||
if strings.ContainsFunc(p.Description, func(r rune) bool {
|
||||
return unicode.IsControl(r) && r != '\n' && r != '\r' && r != '\t'
|
||||
}) {
|
||||
return errors.New("项目说明包含无效控制字符")
|
||||
}
|
||||
return nil
|
||||
}
|
||||
@@ -0,0 +1,56 @@
|
||||
package domain
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestNewProject(t *testing.T) {
|
||||
item, err := NewProject(" 证书项目 ", " 项目说明\n支持换行 ")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if item.ID == DefaultProjectID || item.Name != "证书项目" || item.Description != "项目说明\n支持换行" {
|
||||
t.Fatalf("项目规范化失败:%+v", item)
|
||||
}
|
||||
if item.CreatedAt.IsZero() || !item.CreatedAt.Equal(item.UpdatedAt) || item.CreatedAt.Location().String() != "UTC" {
|
||||
t.Fatal("项目时间戳未初始化为统一 UTC 时间")
|
||||
}
|
||||
other, err := NewProject(item.Name, "")
|
||||
if err != nil || other.ID == item.ID {
|
||||
t.Fatal("独立项目 ID 必须唯一,同名项目不应混淆")
|
||||
}
|
||||
}
|
||||
|
||||
func TestProjectValidation(t *testing.T) {
|
||||
cases := []struct {
|
||||
name string
|
||||
item Project
|
||||
valid bool
|
||||
}{
|
||||
{"default", Project{ID: DefaultProjectID, Name: "默认项目"}, true},
|
||||
{"unicode_limit", Project{ID: "project-1", Name: strings.Repeat("证", 128), Description: strings.Repeat("书", 4096)}, true},
|
||||
{"multiline", Project{ID: "project_2", Name: "项目", Description: "一\r\n二\t三"}, true},
|
||||
{"empty_id", Project{Name: "项目"}, false},
|
||||
{"long_id", Project{ID: strings.Repeat("a", 37), Name: "项目"}, false},
|
||||
{"uppercase_id", Project{ID: "Default", Name: "项目"}, false},
|
||||
{"unsafe_id", Project{ID: "../a", Name: "项目"}, false},
|
||||
{"empty_name", Project{ID: "a", Name: " "}, false},
|
||||
{"long_name", Project{ID: "a", Name: strings.Repeat("证", 129)}, false},
|
||||
{"name_control", Project{ID: "a", Name: "证\x00书"}, false},
|
||||
{"invalid_name_encoding", Project{ID: "a", Name: string([]byte{0xff})}, false},
|
||||
{"long_description", Project{ID: "a", Name: "项目", Description: strings.Repeat("书", 4097)}, false},
|
||||
{"description_control", Project{ID: "a", Name: "项目", Description: "证\x00书"}, false},
|
||||
{"invalid_description_encoding", Project{ID: "a", Name: "项目", Description: string([]byte{0xff})}, false},
|
||||
}
|
||||
for _, tc := range cases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
if err := tc.item.Validate(); (err == nil) != tc.valid {
|
||||
t.Fatalf("项目校验结果不符:%v", err)
|
||||
}
|
||||
})
|
||||
}
|
||||
if _, err := NewProject(" ", ""); err == nil {
|
||||
t.Fatal("构造函数未拒绝空项目名称")
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,153 @@
|
||||
package repository
|
||||
|
||||
import (
|
||||
"context"
|
||||
"database/sql"
|
||||
"errors"
|
||||
"fmt"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"git.pcux.cn/xuans/Scert/backend/internal/domain"
|
||||
)
|
||||
|
||||
var ErrDefaultProject = errors.New("默认项目不能删除或重复创建")
|
||||
|
||||
type ProjectRepository interface {
|
||||
CreateProject(context.Context, domain.Project) error
|
||||
GetProject(context.Context, string) (domain.Project, error)
|
||||
ListProjects(context.Context) ([]domain.Project, error)
|
||||
UpdateProject(context.Context, domain.Project) error
|
||||
DeleteProject(context.Context, string) error
|
||||
}
|
||||
|
||||
type SQLProjectRepository struct {
|
||||
db *sql.DB
|
||||
driver string
|
||||
}
|
||||
|
||||
var _ ProjectRepository = (*SQLProjectRepository)(nil)
|
||||
|
||||
func NewSQLProjectRepository(db *sql.DB, driver ...string) *SQLProjectRepository {
|
||||
return &SQLProjectRepository{db: db, driver: repositoryDriver(driver)}
|
||||
}
|
||||
|
||||
func (r *SQLProjectRepository) query(query string) string {
|
||||
return Rebind(r.driver, query)
|
||||
}
|
||||
|
||||
func (r *SQLProjectRepository) ensureDB() error {
|
||||
if r == nil || r.db == nil {
|
||||
return errors.New("数据库连接不能为空")
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (r *SQLProjectRepository) CreateProject(ctx context.Context, item domain.Project) error {
|
||||
if err := r.ensureDB(); err != nil {
|
||||
return err
|
||||
}
|
||||
item = item.Normalize()
|
||||
if err := item.Validate(); err != nil {
|
||||
return err
|
||||
}
|
||||
if item.ID == domain.DefaultProjectID {
|
||||
return ErrDefaultProject
|
||||
}
|
||||
now := time.Now().UTC()
|
||||
_, err := r.db.ExecContext(ctx, r.query(`INSERT INTO projects
|
||||
(id, name, description, created_at, updated_at) VALUES (?, ?, ?, ?, ?)`),
|
||||
item.ID, item.Name, item.Description, now, now)
|
||||
if err != nil {
|
||||
return fmt.Errorf("创建项目失败:%w", err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
const projectSelect = `SELECT id, name, description, created_at, updated_at FROM projects`
|
||||
|
||||
func (r *SQLProjectRepository) GetProject(ctx context.Context, id string) (domain.Project, error) {
|
||||
if err := r.ensureDB(); err != nil {
|
||||
return domain.Project{}, err
|
||||
}
|
||||
return scanProject(r.db.QueryRowContext(ctx, r.query(projectSelect+` WHERE id = ?`), strings.TrimSpace(id)))
|
||||
}
|
||||
|
||||
func (r *SQLProjectRepository) ListProjects(ctx context.Context) ([]domain.Project, error) {
|
||||
if err := r.ensureDB(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
rows, err := r.db.QueryContext(ctx, r.query(projectSelect+`
|
||||
ORDER BY CASE WHEN id = ? THEN 0 ELSE 1 END, created_at, id`), domain.DefaultProjectID)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("查询项目列表失败:%w", err)
|
||||
}
|
||||
defer rows.Close()
|
||||
items := make([]domain.Project, 0)
|
||||
for rows.Next() {
|
||||
item, err := scanProject(rows)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
items = append(items, item)
|
||||
}
|
||||
if err := rows.Err(); err != nil {
|
||||
return nil, fmt.Errorf("读取项目列表失败:%w", err)
|
||||
}
|
||||
return items, nil
|
||||
}
|
||||
|
||||
func (r *SQLProjectRepository) UpdateProject(ctx context.Context, item domain.Project) error {
|
||||
if err := r.ensureDB(); err != nil {
|
||||
return err
|
||||
}
|
||||
item = item.Normalize()
|
||||
if err := item.Validate(); err != nil {
|
||||
return err
|
||||
}
|
||||
result, err := r.db.ExecContext(ctx, r.query(`UPDATE projects SET name = ?, description = ?, updated_at = ? WHERE id = ?`),
|
||||
item.Name, item.Description, time.Now().UTC(), item.ID)
|
||||
if err != nil {
|
||||
return fmt.Errorf("更新项目失败:%w", err)
|
||||
}
|
||||
count, err := result.RowsAffected()
|
||||
if err != nil {
|
||||
return fmt.Errorf("读取项目更新结果失败:%w", err)
|
||||
}
|
||||
if count == 0 {
|
||||
// MySQL 未实际改变字段时也可能返回零,不能将其直接解释为项目不存在。
|
||||
_, err = r.GetProject(ctx, item.ID)
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (r *SQLProjectRepository) DeleteProject(ctx context.Context, id string) error {
|
||||
if err := r.ensureDB(); err != nil {
|
||||
return err
|
||||
}
|
||||
id = strings.TrimSpace(id)
|
||||
if id == domain.DefaultProjectID {
|
||||
return ErrDefaultProject
|
||||
}
|
||||
result, err := r.db.ExecContext(ctx, r.query(`DELETE FROM projects WHERE id = ?`), id)
|
||||
if err != nil {
|
||||
return fmt.Errorf("删除项目失败:%w", err)
|
||||
}
|
||||
count, err := result.RowsAffected()
|
||||
if err != nil {
|
||||
return fmt.Errorf("读取项目删除结果失败:%w", err)
|
||||
}
|
||||
if count == 0 {
|
||||
return sql.ErrNoRows
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func scanProject(row rowScanner) (domain.Project, error) {
|
||||
var item domain.Project
|
||||
if err := row.Scan(&item.ID, &item.Name, &item.Description, &item.CreatedAt, &item.UpdatedAt); err != nil {
|
||||
return domain.Project{}, fmt.Errorf("读取项目失败:%w", err)
|
||||
}
|
||||
return item, nil
|
||||
}
|
||||
@@ -0,0 +1,190 @@
|
||||
package repository
|
||||
|
||||
import (
|
||||
"context"
|
||||
"database/sql"
|
||||
"errors"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"git.pcux.cn/xuans/Scert/backend/internal/config"
|
||||
"git.pcux.cn/xuans/Scert/backend/internal/database"
|
||||
"git.pcux.cn/xuans/Scert/backend/internal/domain"
|
||||
"git.pcux.cn/xuans/Scert/backend/internal/testsupport/mysqltest"
|
||||
)
|
||||
|
||||
func TestSQLProjectRepositorySQLite(t *testing.T) {
|
||||
cfg := config.Default(t.TempDir()).Database
|
||||
cfg.DSN = filepath.Join(t.TempDir(), "projects.db")
|
||||
db, err := database.Open(t.Context(), cfg)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
t.Cleanup(func() { _ = db.Close() })
|
||||
if err := database.Migrate(t.Context(), db.DB, cfg.Driver); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
checkProjectRepository(t, NewSQLProjectRepository(db.DB))
|
||||
if err := db.Close(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
db, err = database.Open(t.Context(), cfg)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := database.Migrate(t.Context(), db.DB, cfg.Driver); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
items, err := NewSQLProjectRepository(db.DB).ListProjects(t.Context())
|
||||
if err != nil || len(items) != 2 || items[0].Name != "调整后的默认项目" || items[1].ID != "retained" {
|
||||
t.Fatalf("关闭重开后项目未保留:%+v,%v", items, err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestSQLProjectRepositoryMySQLReal(t *testing.T) {
|
||||
server := mysqltest.New(t)
|
||||
cfg := server.Database(t)
|
||||
db, err := database.Open(t.Context(), cfg)
|
||||
if err != nil {
|
||||
t.Fatal("打开独立 MySQL 项目测试库失败")
|
||||
}
|
||||
t.Cleanup(func() { _ = db.Close() })
|
||||
if err := database.Migrate(t.Context(), db.DB, cfg.Driver); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
checkProjectRepository(t, NewSQLProjectRepository(db.DB, cfg.Driver))
|
||||
}
|
||||
|
||||
func checkProjectRepository(t *testing.T, repo *SQLProjectRepository) {
|
||||
t.Helper()
|
||||
ctx := t.Context()
|
||||
items, err := repo.ListProjects(ctx)
|
||||
if err != nil || len(items) != 1 || items[0].ID != domain.DefaultProjectID || items[0].Name != "默认项目" {
|
||||
t.Fatalf("默认项目缺失:%+v,%v", items, err)
|
||||
}
|
||||
initial := items[0]
|
||||
t.Run("reserved_default", func(t *testing.T) {
|
||||
if err := repo.CreateProject(ctx, initial); !errors.Is(err, ErrDefaultProject) {
|
||||
t.Fatalf("未拒绝重复创建默认项目:%v", err)
|
||||
}
|
||||
if err := repo.DeleteProject(ctx, " default "); !errors.Is(err, ErrDefaultProject) {
|
||||
t.Fatalf("未阻止删除默认项目:%v", err)
|
||||
}
|
||||
})
|
||||
item := domain.Project{ID: "project-a", Name: " 证书项目🔒 ", Description: " 项目说明\n第二行 "}
|
||||
item.CreatedAt = time.Date(2000, 1, 1, 0, 0, 0, 0, time.UTC)
|
||||
t.Run("create_and_read", func(t *testing.T) {
|
||||
if err := repo.CreateProject(ctx, item); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
loaded, err := repo.GetProject(ctx, " project-a ")
|
||||
if err != nil || loaded.Name != strings.TrimSpace(item.Name) || loaded.Description != strings.TrimSpace(item.Description) {
|
||||
t.Fatalf("项目数据读取不符:%+v,%v", loaded, err)
|
||||
}
|
||||
if loaded.CreatedAt.Equal(item.CreatedAt) || loaded.CreatedAt.IsZero() || !loaded.CreatedAt.Equal(loaded.UpdatedAt) {
|
||||
t.Fatal("仓储必须生成自己的创建和更新时间")
|
||||
}
|
||||
item = loaded
|
||||
})
|
||||
t.Run("duplicate_and_invalid", func(t *testing.T) {
|
||||
if err := repo.CreateProject(ctx, item); err == nil {
|
||||
t.Fatal("重复项目主键未拒绝")
|
||||
}
|
||||
bad := item
|
||||
bad.Name = " "
|
||||
if err := repo.CreateProject(ctx, bad); err == nil {
|
||||
t.Fatal("创建未校验项目")
|
||||
}
|
||||
if err := repo.UpdateProject(ctx, bad); err == nil {
|
||||
t.Fatal("更新未校验项目")
|
||||
}
|
||||
})
|
||||
t.Run("update_and_order", func(t *testing.T) {
|
||||
before, err := repo.GetProject(ctx, item.ID)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
item.Name = "更新后的项目"
|
||||
item.CreatedAt = time.Time{}
|
||||
for round := 0; round < 2; round++ {
|
||||
if err := repo.UpdateProject(ctx, item); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
}
|
||||
loaded, err := repo.GetProject(ctx, item.ID)
|
||||
if err != nil || loaded.Name != item.Name || !loaded.CreatedAt.Equal(before.CreatedAt) || loaded.UpdatedAt.Before(before.UpdatedAt) {
|
||||
t.Fatalf("更新改变了创建时间或丢失内容:%+v,%v", loaded, err)
|
||||
}
|
||||
if err := repo.CreateProject(ctx, domain.Project{ID: "retained", Name: item.Name}); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
items, err := repo.ListProjects(ctx)
|
||||
if err != nil || len(items) != 3 || items[0].ID != domain.DefaultProjectID {
|
||||
t.Fatalf("项目列表必须默认项目在前:%+v,%v", items, err)
|
||||
}
|
||||
initial.Name = "调整后的默认项目"
|
||||
if err := repo.UpdateProject(ctx, initial); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
})
|
||||
t.Run("cancelled_context", func(t *testing.T) {
|
||||
cancelled, cancel := context.WithCancel(ctx)
|
||||
cancel()
|
||||
if err := repo.CreateProject(cancelled, domain.Project{ID: "cancelled", Name: "不应写入"}); !errors.Is(err, context.Canceled) {
|
||||
t.Fatalf("取消后创建未被拒绝:%v", err)
|
||||
}
|
||||
if _, err := repo.ListProjects(cancelled); !errors.Is(err, context.Canceled) {
|
||||
t.Fatalf("取消后查询未被拒绝:%v", err)
|
||||
}
|
||||
if err := repo.DeleteProject(cancelled, item.ID); !errors.Is(err, context.Canceled) {
|
||||
t.Fatalf("取消后删除未被拒绝:%v", err)
|
||||
}
|
||||
})
|
||||
t.Run("missing_and_injection", func(t *testing.T) {
|
||||
for _, id := range []string{"missing", "' OR 1=1 --"} {
|
||||
if _, err := repo.GetProject(ctx, id); !errors.Is(err, sql.ErrNoRows) {
|
||||
t.Fatalf("查询不存在项目应保留未找到语义:%v", err)
|
||||
}
|
||||
if err := repo.DeleteProject(ctx, id); !errors.Is(err, sql.ErrNoRows) {
|
||||
t.Fatalf("删除不存在项目应保留未找到语义:%v", err)
|
||||
}
|
||||
}
|
||||
if err := repo.UpdateProject(ctx, domain.Project{ID: "missing", Name: "不存在"}); !errors.Is(err, sql.ErrNoRows) {
|
||||
t.Fatalf("更新不存在项目应保留未找到语义:%v", err)
|
||||
}
|
||||
})
|
||||
t.Run("delete", func(t *testing.T) {
|
||||
if err := repo.DeleteProject(ctx, item.ID); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if _, err := repo.GetProject(ctx, item.ID); !errors.Is(err, sql.ErrNoRows) {
|
||||
t.Fatalf("删除后仍能读取项目:%v", err)
|
||||
}
|
||||
items, err := repo.ListProjects(ctx)
|
||||
if err != nil || len(items) != 2 || items[1].ID != "retained" {
|
||||
t.Fatalf("删除项目影响了其他项目:%+v,%v", items, err)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func TestSQLProjectRepositoryNilDatabase(t *testing.T) {
|
||||
for _, repo := range []*SQLProjectRepository{nil, NewSQLProjectRepository(nil)} {
|
||||
if err := repo.CreateProject(t.Context(), domain.Project{}); err == nil {
|
||||
t.Fatal("创建没有拒绝空数据库")
|
||||
}
|
||||
if _, err := repo.GetProject(t.Context(), "a"); err == nil {
|
||||
t.Fatal("查询没有拒绝空数据库")
|
||||
}
|
||||
if _, err := repo.ListProjects(t.Context()); err == nil {
|
||||
t.Fatal("列表没有拒绝空数据库")
|
||||
}
|
||||
if err := repo.UpdateProject(t.Context(), domain.Project{}); err == nil {
|
||||
t.Fatal("更新没有拒绝空数据库")
|
||||
}
|
||||
if err := repo.DeleteProject(t.Context(), "a"); err == nil {
|
||||
t.Fatal("删除没有拒绝空数据库")
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user