Golang集成测试工具推荐与配置

testing

testify

Docker

testcontainers-go

testing

TestMain

func TestMain(m *testing.M) {
    // 1. 初始化外部依赖，例如启动Docker容器中的数据库
    // dbContainer, err := startDBContainer()
    // if err != nil {
    //     log.Fatalf("failed to start db container: %v", err)
    // }
    // defer dbContainer.Terminate(context.Background())

    // 2. 配置环境变量或连接字符串
    // os.Setenv("DATABASE_URL", dbContainer.GetDSN())

    // 运行所有测试
    code := m.Run()

    // 3. 清理工作，例如关闭数据库连接池
    // db.Close()

    os.Exit(code)
}

func TestMyServiceIntegration(t *testing.T) {
    // ... 测试业务逻辑
}

github.com/stretchr/testify/assert

require

assert.Equal

assert.NotNil

require.NoError

require

Docker

testcontainers-go

testcontainers-go

net/http/httptest

httptest.NewServer

net/http

TestMain

Docker

testcontainers-go

testcontainers-go

package main

import (
    "context"
    "database/sql"
    "fmt"
    "log"
    "testing"
    "time"

    _ "github.com/lib/pq" // PostgreSQL driver
    "github.com/stretchr/testify/assert"
    "github.com/testcontainers/testcontainers-go"
    "github.com/testcontainers/testcontainers-go/wait"
)

func TestDatabaseIntegration(t *testing.T) {
    ctx := context.Background()

    // 1. 定义PostgreSQL容器请求
    req := testcontainers.ContainerRequest{
        Image:        "postgres:13",
        ExposedPorts: []string{"5432/tcp"},
        Env: map[string]string{
            "POSTGRES_DB":       "testdb",
            "POSTGRES_USER":     "testuser",
            "POSTGRES_PASSWORD": "testpassword",
        },
        WaitingFor: wait.ForLog("database system is ready to accept connections").WithOccurrence(2).WithStartupTimeout(5 * time.Minute),
    }

    // 2. 启动容器
    pgContainer, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{
        ContainerRequest: req,
        Started:          true,
    })
    if err != nil {
        t.Fatalf("could not start postgres container: %v", err)
    }
    defer pgContainer.Terminate(ctx) // 确保测试结束时容器被清理

    // 3. 获取数据库连接信息
    host, err := pgContainer.Host(ctx)
    if err != nil {
        t.Fatalf("could not get container host: %v", err)
    }
    port, err := pgContainer.MappedPort(ctx, "5432")
    if err != nil {
        t.Fatalf("could not get container port: %v", err)
    }

    dsn := fmt.Sprintf("host=%s port=%s user=testuser password=testpassword dbname=testdb sslmode=disable", host, port.Port())

    // 4. 连接到数据库
    db, err := sql.Open("postgres", dsn)
    if err != nil {
        t.Fatalf("could not connect to database: %v", err)
    }
    defer db.Close()

    err = db.Ping()
    if err != nil {
        t.Fatalf("could not ping database: %v", err)
    }

    // 5. 执行测试逻辑，例如创建表、插入数据、查询
    _, err = db.ExecContext(ctx, `CREATE TABLE IF NOT EXISTS users (id SERIAL PRIMARY KEY, name VARCHAR(255))`)
    assert.NoError(t, err)

    _, err = db.ExecContext(ctx, `INSERT INTO users (name) VALUES ('Alice')`)
    assert.NoError(t, err)

    var name string
    err = db.QueryRowContext(ctx, `SELECT name FROM users WHERE id = 1`).Scan(&name)
    assert.NoError(t, err)
    assert.Equal(t, "Alice", name)

    log.Println("Database integration test passed!")
}

testcontainers-go

docker-compose

testcontainers-go

docker-compose

func TestUserCreation(t *testing.T) {
    // 假设db是一个全局或TestMain中初始化的数据库连接池
    tx, err := db.BeginTx(context.Background(), nil)
    require.NoError(t, err)
    defer tx.Rollback() // 确保事务最终回滚

    // 在此事务中执行测试逻辑
    // service := NewUserService(tx) // 传入事务，确保所有操作都在同一事务中
    // err = service.CreateUser(ctx, "Bob")
    // require.NoError(t, err)

    // 验证用户是否创建成功 (在此事务中查询)
    // var count int
    // tx.QueryRowContext(ctx, "SELECT COUNT(*) FROM users WHERE name = $1", "Bob").Scan(&count)
    // assert.Equal(t, 1, count)
}