测试工具函数应放在与被测代码同包的 _test.go 文件中,以访问未导出标识符;避免独立 testutil 包或 main_test.go,推荐细粒度、带 cleanup 的可组合函数。

测试工具函数该放在哪里
Go 项目中复用测试逻辑,最稳妥的位置是 _test.go 文件里定义的包级函数(非 Test* 函数),且与被测代码同包。例如,被测代码在 pkg/ 下,测试工具函数就写在 pkg/xxx_test.go 中,这样能直接访问包内未导出的变量、函数和类型——这是跨包调用做不到的。
常见错误是把工具函数放到独立的 testutil/ 包里再导出,结果发现无法构造内部状态、不能调用 unexported 方法,最终只能暴露一堆不该公开的接口,破坏封装。
- 同包
_test.go:可访问未导出标识符,推荐首选 - 独立
testutil包:仅适用于纯数据构造(如 mock HTTP 响应、生成 fixture map),不涉及被测包内部逻辑 - 避免在
main_test.go或顶层test_helpers.go中定义——容易引发 import 循环或测试隔离失效
如何设计可组合的测试工具函数
好的测试工具函数应该像 Lego 积木:参数明确、副作用可控、返回值利于断言。不要写 SetupTestEnv() 这种黑盒函数,它掩盖了依赖、难调试、不可复用;而要拆成 NewMockDB()、WithUserSession(t *testing.T, userID int) *http.Cookie 这类细粒度函数。
关键设计原则:
- 接收
*testing.T(如果需要失败提前退出)或返回error(供调用方决定是否t.Fatal) - 不隐式修改全局状态(如修改
time.Now、重置单例);必须改时,用defer恢复,或返回 cleanup 函数 - 命名体现行为:用
MustParseJSON表示 panic 风格,ParseJSON表示返回 error,别混用 - 参数优先用结构体选项模式(
func WithTimeout(d time.Duration) Option),避免长参数列表
表驱动测试中如何复用 setup 逻辑
表驱动测试(table-driven tests)最容易重复写 setup 代码。正确做法是把共用初始化提取到循环外,再用闭包或辅助函数注入 case 特异逻辑。
例如,测试 HTTP handler 时,别在每个 tc 里都调用 httptest.NewServer;而是:
func TestHandlers(t *testing.T) {
db := NewMockDB(t)
srv := httptest.NewUnstartedServer(NewHandler(db))
srv.Start()
defer srv.Close()
tests := []struct {
name string
path string
wantCode int
}{
{"user found", "/users/123", 200},
{"user not found", "/users/999", 404},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
resp, _ := http.Get(srv.URL + tc.path)
if resp.StatusCode != tc.wantCode {
t.Errorf("got %d, want %d", resp.StatusCode, tc.wantCode)
}
})
}
}
- server 和 db 在循环外创建,避免每个 case 重建开销
- case 内只保留差异化逻辑(路径、断言),不重复 setup
- 若某个 case 需特殊 DB 状态,用
db.Reset()+db.Insert(...)显式准备,而非另起一套 server
测试工具函数的生命周期与清理陷阱
最容易被忽略的是资源泄漏:临时文件没删、goroutine 没停、HTTP server 没关、mock clock 没还原。Go 测试运行器不会自动帮你回收这些。
正确做法是让工具函数返回 cleanup 函数,并强制调用:
-
tmpDir := t.TempDir()是安全的,内置自动清理 - 自建临时文件用
os.MkdirTemp后,必须defer os.RemoveAll(dir) - 启动 goroutine 的工具函数(如模拟后台 worker),返回
func() { close(done); wg.Wait() } - 修改全局变量(如
var nowFunc = time.Now)的工具函数,返回的 cleanup 应还原原值,而非只设回time.Now——因为原值可能已被其他测试篡改过
没有显式 cleanup 的工具函数,用一次就埋一个泄漏点;等 CI 上跑并发测试时,超时和随机失败会让你花半天定位。










