orlangure/gnomock

Gnomock – 无需Mock的测试工具

概述

Gnomock是一个集成和端到端测试工具包。它使用Docker创建临时容器来模拟应用依赖，设置它们的初始状态，并在测试结束时自动清理。Gnomock允许在可能的情况下使用真实服务而非mock进行代码测试。

Gnomock的优势在于其丰富的预设（Presets），每个预设针对特定的数据库、服务或工具，提供简单的初始状态设置方式：如创建SQL模式、上传测试数据到S3、向Splunk发送测试事件等。

名称“Gnomock”代表“no mock”，首字母“G”代表“Go”😼。它的发音也类似“gnome”（地精），因此有友好的花园地精图标（由Michael Zolotov设计）。

核心功能与特性

• 临时容器管理：自动创建和清理Docker容器，避免测试环境污染
• 预设支持：针对多种主流服务（数据库、消息队列、云服务模拟等）的预配置
• 初始状态设置：便捷地设置依赖服务的初始状态（如SQL脚本执行、测试数据注入）
• 多语言支持：作为Go包直接使用，或通过HTTP daemon供其他语言调用
• 健康检查：内置服务健康检查，确保容器就绪后才交付使用
• 跨平台兼容：支持本地Docker环境，实验性支持外部DOCKER_HOST

使用场景与适用范围

• 集成测试：测试应用与外部服务（数据库、缓存、消息队列等）的交互
• 端到端测试：模拟完整的依赖栈，验证应用在接近生产环境中的行为
• 开发环境：快速搭建临时开发环境，无需手动配置复杂依赖
• CI/CD流程：在持续集成中提供一致的测试环境，确保测试结果可靠

使用方法

前提条件

• 本地运行Docker daemon（外部DOCKER_HOST支持为实验性）

在Go应用中使用

安装

bash
go get github.com/orlangure/gnomock

示例：PostgreSQL容器设置

go
import (
    "database/sql"
    "fmt"

    _ "github.com/lib/pq" // PostgreSQL驱动
    "github.com/orlangure/gnomock"
    "github.com/orlangure/gnomock/preset/postgres"
)

// 创建PostgreSQL预设
p := postgres.Preset(
    postgres.WithUser("gnomock", "gnomick"), // 用户名和密码
    postgres.WithDatabase("mydb"),           // 数据库名称
    postgres.WithQueriesFile("/var/project/db/schema.sql"), // 执行SQL脚本设置初始状态
)

// 启动容器
container, err := gnomock.Start(p)
if err != nil {
    // 处理错误
}
defer func() { _ = gnomock.Stop(container) }() // 测试结束后停止容器

// 连接到PostgreSQL容器
connStr := fmt.Sprintf(
    "host=%s port=%d user=%s password=%s dbname=%s sslmode=disable",
    container.Host, container.DefaultPort(),
    "gnomock", "gnomick", "mydb",
)
db, err := sql.Open("postgres", connStr)
if err != nil {
    // 处理错误
}
// db已包含所需的模式和数据，可直接使用

在其他语言中使用

通过HTTP daemon使用Gnomock，需先启动Gnomock服务：

启动Gnomock服务（Docker方式）

bash
docker run -d -p 2304:2304 -v /var/run/docker.sock:/var/run/docker.sock --name gnomockd orlangure/gnomock

HTTP API调用示例（创建PostgreSQL容器）

bash
curl -X POST http://localhost:2304/start/postgres \
  -H "Content-Type: application/json" \
  -d '{
    "user": "gnomock",
    "password": "gnomick",
    "database": "mydb",
    "queries_file": "/var/project/db/schema.sql"
  }'

响应将包含容器信息（主机、端口等），用于连接服务。

官方预设

Gnomock的强大之处在于其预设，以下是支持的预设列表（支持版本经过CI管道测试，其他版本可能也能工作）：

故障排除

Gnomock测试耗时过长并最终超时

本地测试时若网络速度不足以拉取Docker镜像可能导致此问题。可手动拉取所需镜像：

bash
docker pull postgres:11  # 例如拉取PostgreSQL 11镜像

镜像已本地存在但测试仍超时

容器可能无法在超时前就绪。Gnomock默认超时较长，若使用WithTimeout（HTTP中为timeout）修改超时，可能设置过短。

单独运行测试通过，并行运行失败

同时启动过多容器可能导致系统（尤其是CI环境）负载过高，容器无法在超时前就绪。建议分批运行测试。

容器设置失败并提示“文件未找到”

通过Gnomock服务运行时，需确保设置中使用的文件挂载到容器内。启动服务时挂载工作目录：

bash
docker run -d -p 2304:2304 -v /var/run/docker.sock:/var/run/docker.sock -v $(pwd):$(pwd) --name gnomockd orlangure/gnomock

这样本地文件可在容器内访问。