docs(constitution): 新增数据库设计原则(v2.4.0)

在项目宪章中新增第九条原则"数据库设计原则",明确禁止使用数据库外键约束和ORM关联标签。

主要变更:
- 新增原则IX:数据库设计原则(Database Design Principles)
- 强制要求:数据库表不得使用外键约束
- 强制要求:GORM模型不得使用ORM关联标签(foreignKey、hasMany等)
- 强制要求:表关系必须通过ID字段手动维护
- 强制要求:关联数据查询必须显式编写,避免ORM魔法
- 强制要求:时间字段由GORM处理,不使用数据库触发器

设计理念:
- 提升业务逻辑灵活性(无数据库约束限制)
- 优化高并发性能(无外键检查开销)
- 增强代码可读性(显式查询,无隐式预加载)
- 简化数据库架构和迁移流程
- 支持分布式和微服务场景

版本升级:2.3.0 → 2.4.0(MINOR)
This commit is contained in:
2025-11-13 13:40:19 +08:00
parent ea0c6a8b16
commit 984ccccc63
63 changed files with 12099 additions and 83 deletions

View File

@@ -7,7 +7,6 @@ import (
"testing"
"time"
"github.com/break/junhong_cmp_fiber/internal/handler"
"github.com/break/junhong_cmp_fiber/internal/middleware"
"github.com/break/junhong_cmp_fiber/pkg/constants"
"github.com/break/junhong_cmp_fiber/pkg/errors"
@@ -64,7 +63,8 @@ func setupAuthTestApp(t *testing.T, rdb *redis.Client) *fiber.App {
})
})
app.Get("/api/v1/users", handler.GetUsers)
// 注释:用户路由已移至实例方法,集成测试中使用测试路由即可
// 实际的用户路由测试应在 cmd/api/main.go 中完整初始化
return app
}

View File

@@ -0,0 +1,489 @@
package integration
import (
"context"
"fmt"
"os"
"path/filepath"
"testing"
"time"
"github.com/break/junhong_cmp_fiber/internal/model"
"github.com/break/junhong_cmp_fiber/internal/store/postgres"
"github.com/break/junhong_cmp_fiber/pkg/constants"
"github.com/golang-migrate/migrate/v4"
_ "github.com/golang-migrate/migrate/v4/database/postgres"
_ "github.com/golang-migrate/migrate/v4/source/file"
_ "github.com/lib/pq"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/testcontainers/testcontainers-go"
testcontainers_postgres "github.com/testcontainers/testcontainers-go/modules/postgres"
"github.com/testcontainers/testcontainers-go/wait"
"go.uber.org/zap"
postgresDriver "gorm.io/driver/postgres"
"gorm.io/gorm"
"gorm.io/gorm/logger"
)
// TestMain 设置测试环境
func TestMain(m *testing.M) {
code := m.Run()
os.Exit(code)
}
// setupTestDB 启动 PostgreSQL 容器并使用迁移脚本初始化数据库
func setupTestDB(t *testing.T) (*postgres.Store, func()) {
ctx := context.Background()
// 启动 PostgreSQL 容器
postgresContainer, err := testcontainers_postgres.RunContainer(ctx,
testcontainers.WithImage("postgres:14-alpine"),
testcontainers_postgres.WithDatabase("testdb"),
testcontainers_postgres.WithUsername("postgres"),
testcontainers_postgres.WithPassword("password"),
testcontainers.WithWaitStrategy(
wait.ForLog("database system is ready to accept connections").
WithOccurrence(2).
WithStartupTimeout(30*time.Second),
),
)
require.NoError(t, err, "启动 PostgreSQL 容器失败")
// 获取连接字符串
connStr, err := postgresContainer.ConnectionString(ctx, "sslmode=disable")
require.NoError(t, err, "获取数据库连接字符串失败")
// 应用数据库迁移
migrationsPath := getMigrationsPath(t)
m, err := migrate.New(
fmt.Sprintf("file://%s", migrationsPath),
connStr,
)
require.NoError(t, err, "创建迁移实例失败")
// 执行向上迁移
err = m.Up()
require.NoError(t, err, "执行数据库迁移失败")
// 连接数据库
db, err := gorm.Open(postgresDriver.Open(connStr), &gorm.Config{
Logger: logger.Default.LogMode(logger.Silent),
})
require.NoError(t, err, "连接数据库失败")
// 创建测试 logger
testLogger := zap.NewNop()
store := postgres.NewStore(db, testLogger)
// 返回清理函数
cleanup := func() {
// 执行向下迁移清理数据
if err := m.Down(); err != nil && err != migrate.ErrNoChange {
t.Logf("清理迁移失败: %v", err)
}
m.Close()
sqlDB, _ := db.DB()
if sqlDB != nil {
sqlDB.Close()
}
if err := postgresContainer.Terminate(ctx); err != nil {
t.Logf("终止容器失败: %v", err)
}
}
return store, cleanup
}
// getMigrationsPath 获取迁移文件路径
func getMigrationsPath(t *testing.T) string {
// 获取项目根目录
wd, err := os.Getwd()
require.NoError(t, err, "获取工作目录失败")
// 从测试目录向上找到项目根目录
migrationsPath := filepath.Join(wd, "..", "..", "migrations")
// 验证迁移目录存在
_, err = os.Stat(migrationsPath)
require.NoError(t, err, fmt.Sprintf("迁移目录不存在: %s", migrationsPath))
return migrationsPath
}
// TestUserCRUD 测试用户 CRUD 操作
func TestUserCRUD(t *testing.T) {
store, cleanup := setupTestDB(t)
defer cleanup()
ctx := context.Background()
t.Run("创建用户", func(t *testing.T) {
user := &model.User{
Username: "testuser",
Email: "test@example.com",
Password: "hashedpassword",
Status: constants.UserStatusActive,
}
err := store.User.Create(ctx, user)
assert.NoError(t, err)
assert.NotZero(t, user.ID)
assert.NotZero(t, user.CreatedAt)
assert.NotZero(t, user.UpdatedAt)
})
t.Run("根据ID查询用户", func(t *testing.T) {
// 创建测试用户
user := &model.User{
Username: "queryuser",
Email: "query@example.com",
Password: "hashedpassword",
Status: constants.UserStatusActive,
}
err := store.User.Create(ctx, user)
require.NoError(t, err)
// 查询用户
found, err := store.User.GetByID(ctx, user.ID)
assert.NoError(t, err)
assert.Equal(t, user.Username, found.Username)
assert.Equal(t, user.Email, found.Email)
assert.Equal(t, constants.UserStatusActive, found.Status)
})
t.Run("根据用户名查询用户", func(t *testing.T) {
// 创建测试用户
user := &model.User{
Username: "findbyname",
Email: "findbyname@example.com",
Password: "hashedpassword",
Status: constants.UserStatusActive,
}
err := store.User.Create(ctx, user)
require.NoError(t, err)
// 根据用户名查询
found, err := store.User.GetByUsername(ctx, "findbyname")
assert.NoError(t, err)
assert.Equal(t, user.ID, found.ID)
assert.Equal(t, user.Email, found.Email)
})
t.Run("更新用户", func(t *testing.T) {
// 创建测试用户
user := &model.User{
Username: "updateuser",
Email: "update@example.com",
Password: "hashedpassword",
Status: constants.UserStatusActive,
}
err := store.User.Create(ctx, user)
require.NoError(t, err)
// 更新用户
user.Email = "newemail@example.com"
user.Status = constants.UserStatusInactive
err = store.User.Update(ctx, user)
assert.NoError(t, err)
// 验证更新
found, err := store.User.GetByID(ctx, user.ID)
assert.NoError(t, err)
assert.Equal(t, "newemail@example.com", found.Email)
assert.Equal(t, constants.UserStatusInactive, found.Status)
})
t.Run("列表查询用户", func(t *testing.T) {
// 创建多个测试用户
for i := 1; i <= 5; i++ {
user := &model.User{
Username: fmt.Sprintf("listuser%d", i),
Email: fmt.Sprintf("list%d@example.com", i),
Password: "hashedpassword",
Status: constants.UserStatusActive,
}
err := store.User.Create(ctx, user)
require.NoError(t, err)
}
// 列表查询
users, total, err := store.User.List(ctx, 1, 3)
assert.NoError(t, err)
assert.GreaterOrEqual(t, len(users), 3)
assert.GreaterOrEqual(t, total, int64(5))
})
t.Run("软删除用户", func(t *testing.T) {
// 创建测试用户
user := &model.User{
Username: "deleteuser",
Email: "delete@example.com",
Password: "hashedpassword",
Status: constants.UserStatusActive,
}
err := store.User.Create(ctx, user)
require.NoError(t, err)
// 软删除
err = store.User.Delete(ctx, user.ID)
assert.NoError(t, err)
// 验证已删除(查询应该找不到)
_, err = store.User.GetByID(ctx, user.ID)
assert.Error(t, err)
assert.Equal(t, gorm.ErrRecordNotFound, err)
})
}
// TestOrderCRUD 测试订单 CRUD 操作
func TestOrderCRUD(t *testing.T) {
store, cleanup := setupTestDB(t)
defer cleanup()
ctx := context.Background()
// 创建测试用户
user := &model.User{
Username: "orderuser",
Email: "orderuser@example.com",
Password: "hashedpassword",
Status: constants.UserStatusActive,
}
err := store.User.Create(ctx, user)
require.NoError(t, err)
t.Run("创建订单", func(t *testing.T) {
order := &model.Order{
OrderID: "ORD-001",
UserID: user.ID,
Amount: 10000,
Status: constants.OrderStatusPending,
Remark: "测试订单",
}
err := store.Order.Create(ctx, order)
assert.NoError(t, err)
assert.NotZero(t, order.ID)
assert.NotZero(t, order.CreatedAt)
})
t.Run("根据ID查询订单", func(t *testing.T) {
// 创建测试订单
order := &model.Order{
OrderID: "ORD-002",
UserID: user.ID,
Amount: 20000,
Status: constants.OrderStatusPending,
}
err := store.Order.Create(ctx, order)
require.NoError(t, err)
// 查询订单
found, err := store.Order.GetByID(ctx, order.ID)
assert.NoError(t, err)
assert.Equal(t, order.OrderID, found.OrderID)
assert.Equal(t, order.Amount, found.Amount)
})
t.Run("根据订单号查询", func(t *testing.T) {
// 创建测试订单
order := &model.Order{
OrderID: "ORD-003",
UserID: user.ID,
Amount: 30000,
Status: constants.OrderStatusPending,
}
err := store.Order.Create(ctx, order)
require.NoError(t, err)
// 根据订单号查询
found, err := store.Order.GetByOrderID(ctx, "ORD-003")
assert.NoError(t, err)
assert.Equal(t, order.ID, found.ID)
})
t.Run("根据用户ID列表查询", func(t *testing.T) {
// 创建多个订单
for i := 1; i <= 3; i++ {
order := &model.Order{
OrderID: fmt.Sprintf("ORD-USER-%d", i),
UserID: user.ID,
Amount: int64(i * 10000),
Status: constants.OrderStatusPending,
}
err := store.Order.Create(ctx, order)
require.NoError(t, err)
}
// 列表查询
orders, total, err := store.Order.ListByUserID(ctx, user.ID, 1, 10)
assert.NoError(t, err)
assert.GreaterOrEqual(t, len(orders), 3)
assert.GreaterOrEqual(t, total, int64(3))
})
t.Run("更新订单状态", func(t *testing.T) {
// 创建测试订单
order := &model.Order{
OrderID: "ORD-UPDATE",
UserID: user.ID,
Amount: 50000,
Status: constants.OrderStatusPending,
}
err := store.Order.Create(ctx, order)
require.NoError(t, err)
// 更新状态
now := time.Now()
order.Status = constants.OrderStatusPaid
order.PaidAt = &now
err = store.Order.Update(ctx, order)
assert.NoError(t, err)
// 验证更新
found, err := store.Order.GetByID(ctx, order.ID)
assert.NoError(t, err)
assert.Equal(t, constants.OrderStatusPaid, found.Status)
assert.NotNil(t, found.PaidAt)
})
t.Run("软删除订单", func(t *testing.T) {
// 创建测试订单
order := &model.Order{
OrderID: "ORD-DELETE",
UserID: user.ID,
Amount: 60000,
Status: constants.OrderStatusPending,
}
err := store.Order.Create(ctx, order)
require.NoError(t, err)
// 软删除
err = store.Order.Delete(ctx, order.ID)
assert.NoError(t, err)
// 验证已删除
_, err = store.Order.GetByID(ctx, order.ID)
assert.Error(t, err)
assert.Equal(t, gorm.ErrRecordNotFound, err)
})
}
// TestTransaction 测试事务功能
func TestTransaction(t *testing.T) {
store, cleanup := setupTestDB(t)
defer cleanup()
ctx := context.Background()
t.Run("事务提交", func(t *testing.T) {
var userID uint
var orderID uint
err := store.Transaction(ctx, func(tx *postgres.Store) error {
// 创建用户
user := &model.User{
Username: "txuser",
Email: "txuser@example.com",
Password: "hashedpassword",
Status: constants.UserStatusActive,
}
if err := tx.User.Create(ctx, user); err != nil {
return err
}
userID = user.ID
// 创建订单
order := &model.Order{
OrderID: "ORD-TX-001",
UserID: user.ID,
Amount: 10000,
Status: constants.OrderStatusPending,
}
if err := tx.Order.Create(ctx, order); err != nil {
return err
}
orderID = order.ID
return nil
})
assert.NoError(t, err)
// 验证用户和订单都已创建
user, err := store.User.GetByID(ctx, userID)
assert.NoError(t, err)
assert.Equal(t, "txuser", user.Username)
order, err := store.Order.GetByID(ctx, orderID)
assert.NoError(t, err)
assert.Equal(t, "ORD-TX-001", order.OrderID)
})
t.Run("事务回滚", func(t *testing.T) {
var userID uint
err := store.Transaction(ctx, func(tx *postgres.Store) error {
// 创建用户
user := &model.User{
Username: "rollbackuser",
Email: "rollback@example.com",
Password: "hashedpassword",
Status: constants.UserStatusActive,
}
if err := tx.User.Create(ctx, user); err != nil {
return err
}
userID = user.ID
// 模拟错误,触发回滚
return fmt.Errorf("模拟错误")
})
assert.Error(t, err)
assert.Equal(t, "模拟错误", err.Error())
// 验证用户未创建(已回滚)
_, err = store.User.GetByID(ctx, userID)
assert.Error(t, err)
assert.Equal(t, gorm.ErrRecordNotFound, err)
})
}
// TestConcurrentOperations 测试并发操作
func TestConcurrentOperations(t *testing.T) {
store, cleanup := setupTestDB(t)
defer cleanup()
ctx := context.Background()
t.Run("并发创建用户", func(t *testing.T) {
concurrency := 10
errChan := make(chan error, concurrency)
for i := 0; i < concurrency; i++ {
go func(index int) {
user := &model.User{
Username: fmt.Sprintf("concurrent%d", index),
Email: fmt.Sprintf("concurrent%d@example.com", index),
Password: "hashedpassword",
Status: constants.UserStatusActive,
}
errChan <- store.User.Create(ctx, user)
}(i)
}
// 收集结果
successCount := 0
for i := 0; i < concurrency; i++ {
err := <-errChan
if err == nil {
successCount++
}
}
assert.Equal(t, concurrency, successCount, "所有并发创建应该成功")
})
}

View File

@@ -0,0 +1,169 @@
package integration
import (
"context"
"net/http/httptest"
"testing"
"github.com/break/junhong_cmp_fiber/internal/handler"
"github.com/gofiber/fiber/v2"
"github.com/redis/go-redis/v9"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"go.uber.org/zap"
"gorm.io/driver/sqlite"
"gorm.io/gorm"
)
// TestHealthCheckNormal 测试健康检查 - 正常状态
func TestHealthCheckNormal(t *testing.T) {
// 初始化日志
logger, _ := zap.NewDevelopment()
// 初始化内存数据库
db, err := gorm.Open(sqlite.Open(":memory:"), &gorm.Config{})
require.NoError(t, err)
// 初始化 Redis 客户端(使用本地 Redis
rdb := redis.NewClient(&redis.Options{
Addr: "localhost:6379",
DB: 0,
})
defer rdb.Close()
// 创建 Fiber 应用
app := fiber.New()
// 创建健康检查处理器
healthHandler := handler.NewHealthHandler(db, rdb, logger)
app.Get("/health", healthHandler.Check)
// 发送测试请求
req := httptest.NewRequest("GET", "/health", nil)
resp, err := app.Test(req)
require.NoError(t, err)
defer resp.Body.Close()
// 验证响应状态码
assert.Equal(t, 200, resp.StatusCode)
// 验证响应内容
// 注意:这里可以进一步解析 JSON 响应体验证详细信息
}
// TestHealthCheckDatabaseDown 测试健康检查 - 数据库异常
func TestHealthCheckDatabaseDown(t *testing.T) {
t.Skip("需要模拟数据库连接失败的场景")
// 初始化日志
logger, _ := zap.NewDevelopment()
// 初始化一个会失败的数据库连接
db, err := gorm.Open(sqlite.Open("/invalid/path/test.db"), &gorm.Config{})
if err != nil {
// 预期会失败
t.Log("数据库连接失败(预期行为)")
}
// 初始化 Redis 客户端
rdb := redis.NewClient(&redis.Options{
Addr: "localhost:6379",
DB: 0,
})
defer rdb.Close()
// 创建 Fiber 应用
app := fiber.New()
// 创建健康检查处理器
healthHandler := handler.NewHealthHandler(db, rdb, logger)
app.Get("/health", healthHandler.Check)
// 发送测试请求
req := httptest.NewRequest("GET", "/health", nil)
resp, err := app.Test(req)
require.NoError(t, err)
defer resp.Body.Close()
// 验证响应状态码应该是 503 (Service Unavailable)
assert.Equal(t, 503, resp.StatusCode)
}
// TestHealthCheckRedisDown 测试健康检查 - Redis 异常
func TestHealthCheckRedisDown(t *testing.T) {
// 初始化日志
logger, _ := zap.NewDevelopment()
// 初始化内存数据库
db, err := gorm.Open(sqlite.Open(":memory:"), &gorm.Config{})
require.NoError(t, err)
// 初始化一个连接到无效地址的 Redis 客户端
rdb := redis.NewClient(&redis.Options{
Addr: "localhost:9999", // 无效端口
DB: 0,
})
defer rdb.Close()
// 创建 Fiber 应用
app := fiber.New()
// 创建健康检查处理器
healthHandler := handler.NewHealthHandler(db, rdb, logger)
app.Get("/health", healthHandler.Check)
// 发送测试请求
req := httptest.NewRequest("GET", "/health", nil)
resp, err := app.Test(req)
require.NoError(t, err)
defer resp.Body.Close()
// 验证响应状态码应该是 503 (Service Unavailable)
assert.Equal(t, 503, resp.StatusCode)
}
// TestHealthCheckDetailed 测试健康检查 - 验证详细信息
func TestHealthCheckDetailed(t *testing.T) {
// 初始化日志
logger, _ := zap.NewDevelopment()
// 初始化内存数据库
db, err := gorm.Open(sqlite.Open(":memory:"), &gorm.Config{})
require.NoError(t, err)
// 初始化 Redis 客户端
rdb := redis.NewClient(&redis.Options{
Addr: "localhost:6379",
DB: 0,
})
defer rdb.Close()
// 测试 Redis 连接
ctx := context.Background()
_, err = rdb.Ping(ctx).Result()
if err != nil {
t.Skip("Redis 未运行,跳过测试")
}
// 创建 Fiber 应用
app := fiber.New()
// 创建健康检查处理器
healthHandler := handler.NewHealthHandler(db, rdb, logger)
app.Get("/health", healthHandler.Check)
// 发送测试请求
req := httptest.NewRequest("GET", "/health", nil)
resp, err := app.Test(req)
require.NoError(t, err)
defer resp.Body.Close()
// 验证响应状态码
assert.Equal(t, 200, resp.StatusCode)
// TODO: 解析 JSON 响应并验证包含以下字段:
// - status: "healthy"
// - postgres: "up"
// - redis: "up"
// - timestamp
}

View File

@@ -1,7 +1,6 @@
package integration
import (
"encoding/json"
"io"
"net/http/httptest"
"os"
@@ -14,6 +13,7 @@ import (
"github.com/break/junhong_cmp_fiber/pkg/errors"
"github.com/break/junhong_cmp_fiber/pkg/logger"
"github.com/break/junhong_cmp_fiber/pkg/response"
"github.com/bytedance/sonic"
"github.com/gofiber/fiber/v2"
"github.com/gofiber/fiber/v2/middleware/requestid"
"github.com/google/uuid"
@@ -115,7 +115,7 @@ func TestPanicRecovery(t *testing.T) {
if tt.shouldPanic {
// panic 应该返回统一错误响应
var response response.Response
if err := json.Unmarshal(body, &response); err != nil {
if err := sonic.Unmarshal(body, &response); err != nil {
t.Fatalf("Failed to unmarshal response: %v", err)
}
@@ -348,7 +348,7 @@ func TestSubsequentRequestsAfterPanic(t *testing.T) {
// 验证响应内容
var response map[string]any
if err := json.Unmarshal(body, &response); err != nil {
if err := sonic.Unmarshal(body, &response); err != nil {
t.Fatalf("Request %d: failed to unmarshal response: %v", i, err)
}
@@ -606,7 +606,7 @@ func TestRecoverMiddlewareOrder(t *testing.T) {
// 解析响应,验证返回了统一错误格式
body, _ := io.ReadAll(resp.Body)
var response response.Response
if err := json.Unmarshal(body, &response); err != nil {
if err := sonic.Unmarshal(body, &response); err != nil {
t.Fatalf("Failed to unmarshal response: %v", err)
}

View File

@@ -0,0 +1,312 @@
package integration
import (
"context"
"testing"
"time"
"github.com/bytedance/sonic"
"github.com/hibiken/asynq"
"github.com/redis/go-redis/v9"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/break/junhong_cmp_fiber/pkg/constants"
)
// EmailPayload 邮件任务载荷(测试用)
type EmailPayload struct {
RequestID string `json:"request_id"`
To string `json:"to"`
Subject string `json:"subject"`
Body string `json:"body"`
CC []string `json:"cc,omitempty"`
}
// TestTaskSubmit 测试任务提交
func TestTaskSubmit(t *testing.T) {
// 创建 Redis 客户端
redisClient := redis.NewClient(&redis.Options{
Addr: "localhost:6379",
})
defer redisClient.Close()
// 清理测试数据
ctx := context.Background()
redisClient.FlushDB(ctx)
// 创建 Asynq 客户端
client := asynq.NewClient(asynq.RedisClientOpt{
Addr: "localhost:6379",
})
defer client.Close()
// 构造任务载荷
payload := &EmailPayload{
RequestID: "test-request-001",
To: "test@example.com",
Subject: "Test Email",
Body: "This is a test email",
}
payloadBytes, err := sonic.Marshal(payload)
require.NoError(t, err)
// 提交任务
task := asynq.NewTask(constants.TaskTypeEmailSend, payloadBytes)
info, err := client.Enqueue(task,
asynq.Queue(constants.QueueDefault),
asynq.MaxRetry(constants.DefaultRetryMax),
)
// 验证
require.NoError(t, err)
assert.NotEmpty(t, info.ID)
assert.Equal(t, constants.QueueDefault, info.Queue)
assert.Equal(t, constants.DefaultRetryMax, info.MaxRetry)
}
// TestTaskPriority 测试任务优先级
func TestTaskPriority(t *testing.T) {
// 创建 Redis 客户端
redisClient := redis.NewClient(&redis.Options{
Addr: "localhost:6379",
})
defer redisClient.Close()
ctx := context.Background()
redisClient.FlushDB(ctx)
// 创建 Asynq 客户端
client := asynq.NewClient(asynq.RedisClientOpt{
Addr: "localhost:6379",
})
defer client.Close()
tests := []struct {
name string
queue string
}{
{"Critical Priority", constants.QueueCritical},
{"Default Priority", constants.QueueDefault},
{"Low Priority", constants.QueueLow},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
payload := &EmailPayload{
RequestID: "test-request-" + tt.queue,
To: "test@example.com",
Subject: "Test",
Body: "Test",
}
payloadBytes, err := sonic.Marshal(payload)
require.NoError(t, err)
task := asynq.NewTask(constants.TaskTypeEmailSend, payloadBytes)
info, err := client.Enqueue(task, asynq.Queue(tt.queue))
require.NoError(t, err)
assert.Equal(t, tt.queue, info.Queue)
})
}
}
// TestTaskRetry 测试任务重试机制
func TestTaskRetry(t *testing.T) {
redisClient := redis.NewClient(&redis.Options{
Addr: "localhost:6379",
})
defer redisClient.Close()
ctx := context.Background()
redisClient.FlushDB(ctx)
client := asynq.NewClient(asynq.RedisClientOpt{
Addr: "localhost:6379",
})
defer client.Close()
payload := &EmailPayload{
RequestID: "retry-test-001",
To: "test@example.com",
Subject: "Retry Test",
Body: "Test retry mechanism",
}
payloadBytes, err := sonic.Marshal(payload)
require.NoError(t, err)
// 提交任务并设置重试次数
task := asynq.NewTask(constants.TaskTypeEmailSend, payloadBytes)
info, err := client.Enqueue(task,
asynq.MaxRetry(3),
asynq.Timeout(30*time.Second),
)
require.NoError(t, err)
assert.Equal(t, 3, info.MaxRetry)
assert.Equal(t, 30*time.Second, info.Timeout)
}
// TestTaskIdempotency 测试任务幂等性键
func TestTaskIdempotency(t *testing.T) {
redisClient := redis.NewClient(&redis.Options{
Addr: "localhost:6379",
})
defer redisClient.Close()
ctx := context.Background()
redisClient.FlushDB(ctx)
requestID := "idempotent-test-001"
lockKey := constants.RedisTaskLockKey(requestID)
// 第一次设置锁(模拟任务开始执行)
result, err := redisClient.SetNX(ctx, lockKey, "1", 24*time.Hour).Result()
require.NoError(t, err)
assert.True(t, result, "第一次设置锁应该成功")
// 第二次设置锁(模拟重复任务)
result, err = redisClient.SetNX(ctx, lockKey, "1", 24*time.Hour).Result()
require.NoError(t, err)
assert.False(t, result, "第二次设置锁应该失败(幂等性)")
// 验证锁存在
exists, err := redisClient.Exists(ctx, lockKey).Result()
require.NoError(t, err)
assert.Equal(t, int64(1), exists)
// 验证 TTL
ttl, err := redisClient.TTL(ctx, lockKey).Result()
require.NoError(t, err)
assert.Greater(t, ttl.Hours(), 23.0)
assert.LessOrEqual(t, ttl.Hours(), 24.0)
}
// TestTaskStatusTracking 测试任务状态跟踪
func TestTaskStatusTracking(t *testing.T) {
redisClient := redis.NewClient(&redis.Options{
Addr: "localhost:6379",
})
defer redisClient.Close()
ctx := context.Background()
redisClient.FlushDB(ctx)
taskID := "task-123456"
statusKey := constants.RedisTaskStatusKey(taskID)
// 设置任务状态
statuses := []string{"pending", "processing", "completed"}
for _, status := range statuses {
err := redisClient.Set(ctx, statusKey, status, 7*24*time.Hour).Err()
require.NoError(t, err)
// 读取状态
result, err := redisClient.Get(ctx, statusKey).Result()
require.NoError(t, err)
assert.Equal(t, status, result)
}
// 验证 TTL
ttl, err := redisClient.TTL(ctx, statusKey).Result()
require.NoError(t, err)
assert.Greater(t, ttl.Hours(), 24.0*6)
}
// TestQueueInspection 测试队列检查
func TestQueueInspection(t *testing.T) {
redisClient := redis.NewClient(&redis.Options{
Addr: "localhost:6379",
})
defer redisClient.Close()
ctx := context.Background()
redisClient.FlushDB(ctx)
client := asynq.NewClient(asynq.RedisClientOpt{
Addr: "localhost:6379",
})
defer client.Close()
// 提交多个任务
for i := 0; i < 5; i++ {
payload := &EmailPayload{
RequestID: "test-" + string(rune(i)),
To: "test@example.com",
Subject: "Test",
Body: "Test",
}
payloadBytes, err := sonic.Marshal(payload)
require.NoError(t, err)
task := asynq.NewTask(constants.TaskTypeEmailSend, payloadBytes)
_, err = client.Enqueue(task, asynq.Queue(constants.QueueDefault))
require.NoError(t, err)
}
// 创建 Inspector 检查队列
inspector := asynq.NewInspector(asynq.RedisClientOpt{
Addr: "localhost:6379",
})
defer inspector.Close()
// 获取队列信息
info, err := inspector.GetQueueInfo(constants.QueueDefault)
require.NoError(t, err)
assert.Equal(t, 5, info.Pending)
assert.Equal(t, 0, info.Active)
}
// TestTaskSerialization 测试任务序列化
func TestTaskSerialization(t *testing.T) {
tests := []struct {
name string
payload EmailPayload
}{
{
name: "Simple Email",
payload: EmailPayload{
RequestID: "req-001",
To: "user@example.com",
Subject: "Hello",
Body: "Hello World",
},
},
{
name: "Email with CC",
payload: EmailPayload{
RequestID: "req-002",
To: "user@example.com",
Subject: "Hello",
Body: "Hello World",
CC: []string{"cc1@example.com", "cc2@example.com"},
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
// 序列化
payloadBytes, err := sonic.Marshal(tt.payload)
require.NoError(t, err)
assert.NotEmpty(t, payloadBytes)
// 反序列化
var decoded EmailPayload
err = sonic.Unmarshal(payloadBytes, &decoded)
require.NoError(t, err)
// 验证
assert.Equal(t, tt.payload.RequestID, decoded.RequestID)
assert.Equal(t, tt.payload.To, decoded.To)
assert.Equal(t, tt.payload.Subject, decoded.Subject)
assert.Equal(t, tt.payload.Body, decoded.Body)
assert.Equal(t, tt.payload.CC, decoded.CC)
})
}
}