Golang轻量级零依赖Docker测试容器插件库dft使用指南

dft (Docker For Test) 是一个轻量级、零依赖的Golang库，专门用于在单元测试和集成测试中管理Docker容器。它提供了简单的API来启动、停止和管理测试所需的容器服务。

主要特性

• 零外部依赖（仅依赖标准库和Docker引擎API）
• 轻量级实现
• 支持容器生命周期管理
• 自动清理测试容器
• 支持自定义容器配置

安装

go get github.com/yourusername/dft

基本使用示例

1. 启动一个Redis测试容器

package main

import (
	"context"
	"fmt"
	"testing"
	"time"

	"github.com/yourusername/dft"
)

func TestWithRedis(t *testing.T) {
	// 创建dft客户端
	client, err := dft.NewClient()
	if err != nil {
		t.Fatalf("Failed to create client: %v", err)
	}
	defer client.Close()

	// 定义Redis容器配置
	redisCfg := &dft.ContainerConfig{
		Image:         "redis:alpine",
		ExposedPorts:  []string{"6379/tcp"},
		WaitingPorts:  []string{"6379"},
		WaitingPeriod: 5 * time.Second,
	}

	// 启动Redis容器
	redisContainer, err := client.RunContainer(context.Background(), redisCfg)
	if err != nil {
		t.Fatalf("Failed to start Redis container: %v", err)
	}
	defer redisContainer.Stop(context.Background())

	// 获取容器映射的端口
	port := redisContainer.GetMappedPort("6379")
	redisAddr := fmt.Sprintf("localhost:%s", port)

	// 这里可以使用redisAddr连接测试Redis
	t.Logf("Redis is running at %s", redisAddr)

	// 测试逻辑...
}

2. 启动PostgreSQL测试容器

func TestWithPostgreSQL(t *testing.T) {
	client, err := dft.NewClient()
	if err != nil {
		t.Fatal(err)
	}
	defer client.Close()

	pgCfg := &dft.ContainerConfig{
		Image:         "postgres:13-alpine",
		ExposedPorts:  []string{"5432/tcp"},
		Env:           []string{"POSTGRES_PASSWORD=testpass"},
		WaitingPorts:  []string{"5432"},
		WaitingPeriod: 10 * time.Second,
	}

	pgContainer, err := client.RunContainer(context.Background(), pgCfg)
	if err != nil {
		t.Fatal(err)
	}
	defer pgContainer.Stop(context.Background())

	port := pgContainer.GetMappedPort("5432")
	dsn := fmt.Sprintf("postgres://postgres:testpass@localhost:%s/postgres?sslmode=disable", port)

	t.Logf("PostgreSQL DSN: %s", dsn)
	
	// 测试数据库连接和逻辑...
}

高级功能

自定义容器配置

cfg := &dft.ContainerConfig{
	Image:        "my-custom-image",
	ExposedPorts: []string{"8080/tcp", "9090/tcp"},
	Env:          []string{"ENV_VAR=value", "ANOTHER_VAR=123"},
	Cmd:          []string{"myapp", "--debug"},
	// 等待特定日志输出才认为容器就绪
	WaitingFor: &dft.WaitForLog{
		Pattern: "Server started",
		Timeout: 30 * time.Second,
	},
}

多容器测试

func TestMultiContainer(t *testing.T) {
	client, err := dft.NewClient()
	if err != nil {
		t.Fatal(err)
	}
	defer client.Close()

	// 启动Redis
	redisCfg := &dft.ContainerConfig{
		Image:        "redis:alpine",
		ExposedPorts: []string{"6379/tcp"},
	}
	redis, err := client.RunContainer(context.Background(), redisCfg)
	if err != nil {
		t.Fatal(err)
	}
	defer redis.Stop(context.Background())

	// 启动应用容器，链接到Redis
	appCfg := &dft.ContainerConfig{
		Image:        "myapp:test",
		ExposedPorts: []string{"8080/tcp"},
		Env: []string{
			fmt.Sprintf("REDIS_URL=redis://%s:6379", redis.GetIP()),
		},
	}
	app, err := client.RunContainer(context.Background(), appCfg)
	if err != nil {
		t.Fatal(err)
	}
	defer app.Stop(context.Background())

	// 测试逻辑...
}

最佳实践

1. 每个测试用例独立容器：为每个测试用例启动独立的容器，避免测试间相互影响
2. 使用defer清理：确保测试结束后清理容器
3. 合理设置等待时间：根据服务启动时间设置适当的WaitingPeriod
4. 复用客户端：在测试套件级别创建dft客户端，而不是每个测试用例都创建

与类似库的比较

相比于testcontainers-go等库，dft的优势在于：

• 更轻量，零外部依赖
• 更简单的API设计
• 更适合小型项目或简单测试场景

不足：

• 功能相对较少
• 社区支持较小

dft非常适合需要轻量级解决方案的测试场景，特别是当项目不希望引入过多依赖时。