go-mysql-test-container 使用指南

go-mysql-test-container 是一个用于 Go 语言 MySQL 集成测试的辅助工具库，它基于 TestContainers 项目，可以方便地在测试中启动和管理 MySQL 容器实例。

主要特性

1. 快速启动 MySQL 容器用于测试
2. 自动清理测试资源
3. 支持自定义 MySQL 配置
4. 与标准 database/sql 包无缝集成

安装

go get github.com/arikama/go-mysql-test-container

基本使用示例

package main

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

	mysqltestcontainer "github.com/arikama/go-mysql-test-container"
	_ "github.com/go-sql-driver/mysql"
)

func TestMySQLIntegration(t *testing.T) {
	// 创建 MySQL 测试容器
	mysqlContainer, err := mysqltestcontainer.NewMysqlTestContainer(mysqltestcontainer.WithPassword("testpassword"))
	if err != nil {
		t.Fatalf("Failed to start MySQL container: %v", err)
	}
	
	// 确保测试结束后容器会被停止
	t.Cleanup(func() {
		if err := mysqlContainer.Close(); err != nil {
			t.Errorf("Failed to stop MySQL container: %v", err)
		}
	})

	// 获取数据库连接字符串
	dsn := mysqlContainer.GetDsn()

	// 连接数据库
	db, err := sql.Open("mysql", dsn)
	if err != nil {
		t.Fatalf("Failed to connect to MySQL: %v", err)
	}
	defer db.Close()

	// 执行测试查询
	var version string
	err = db.QueryRow("SELECT VERSION()").Scan(&version)
	if err != nil {
		t.Fatalf("Failed to query version: %v", err)
	}

	fmt.Printf("MySQL version: %s\n", version)
}

高级配置选项

func TestWithCustomConfig(t *testing.T) {
	// 使用自定义配置创建容器
	mysqlContainer, err := mysqltestcontainer.NewMysqlTestContainer(
		mysqltestcontainer.WithPassword("custompass"),
		mysqltestcontainer.WithDatabase("testdb"),
		mysqltestcontainer.WithUsername("testuser"),
		mysqltestcontainer.WithPort("3307"), // 映射到主机的端口
		mysqltestcontainer.WithVersion("5.7"), // 指定 MySQL 版本
	)
	if err != nil {
		t.Fatal(err)
	}
	defer mysqlContainer.Close()

	// 使用自定义配置连接
	db, err := sql.Open("mysql", mysqlContainer.GetDsn())
	if err != nil {
		t.Fatal(err)
	}
	defer db.Close()

	// 检查数据库是否存在
	var dbName string
	err = db.QueryRow("SELECT DATABASE()").Scan(&dbName)
	if err != nil {
		t.Fatal(err)
	}

	if dbName != "testdb" {
		t.Errorf("Expected database 'testdb', got '%s'", dbName)
	}
}

初始化数据库脚本

func TestWithInitScript(t *testing.T) {
	initScript := `
CREATE TABLE IF NOT EXISTS users (
    id INT AUTO_INCREMENT PRIMARY KEY,
    name VARCHAR(100) NOT NULL,
    email VARCHAR(100) NOT NULL UNIQUE
);

INSERT INTO users (name, email) VALUES 
('Alice', 'alice@example.com'),
('Bob', 'bob@example.com');
`

	mysqlContainer, err := mysqltestcontainer.NewMysqlTestContainer(
		mysqltestcontainer.WithPassword("testpass"),
		mysqltestcontainer.WithInitScript(initScript),
	)
	if err != nil {
		t.Fatal(err)
	}
	defer mysqlContainer.Close()

	db, err := sql.Open("mysql", mysqlContainer.GetDsn())
	if err != nil {
		t.Fatal(err)
	}
	defer db.Close()

	// 查询初始化数据
	var count int
	err = db.QueryRow("SELECT COUNT(*) FROM users").Scan(&count)
	if err != nil {
		t.Fatal(err)
	}

	if count != 2 {
		t.Errorf("Expected 2 users, got %d", count)
	}
}

并行测试支持

func TestParallel(t *testing.T) {
	t.Parallel()

	mysqlContainer, err := mysqltestcontainer.NewMysqlTestContainer()
	if err != nil {
		t.Fatal(err)
	}
	defer mysqlContainer.Close()

	// 测试逻辑...
}

最佳实践

1. 每个测试用例使用独立的容器实例，避免测试间的相互影响
2. 使用 t.Cleanup() 确保容器被正确清理
3. 对于简单的测试，可以使用内存数据库如 SQLite
4. 考虑使用测试套件级别的容器，减少容器启动时间

替代方案

如果 go-mysql-test-container 不满足需求，也可以考虑：

1. 直接使用 TestContainers Go 库
2. 使用 Docker SDK 直接管理容器
3. 使用本地安装的 MySQL 服务

go-mysql-test-container 简化了 MySQL 测试容器的管理，使得编写集成测试更加方便快捷。