背景
项目开发在做单元测试, 发现跑测试 cases 的时候,每一个跑完,日志后都带有一个 (cached) 的标志。尽管代码的实现已经做了修改(比如返回不同数据), 但是发现再次执行 go test -v case_test.go
,返回跟上一次的结果居然一致,实际上这样的测试是没多少意义的。 之前没有了解过 go test
的原理, 这里想看下了内部是怎么 run 的,以及要怎样禁用测试缓存。
<!--more-->
问题分析
Go 官方文档详细说明了 test 包的工作原理:在执行 go test
时会编译每个包和所有后缀匹配 *_test.go 命名的文件(这些测试文件包括一些单元测试和基准测试),链接和执行生成的二进制程序, 然后打印每一个测试函数的输出日志。
Go test 支持两种模式:
- Local directory mode, 在调用
go test
时,没有加参数 (比如go test
或go test -v
)。在这种模式下,缓存会被禁用。 会编译当前目录下的代码和测试,然后运行测试二进制程序。 - Package list mode,执行
go test
时,指定文件路径 (比如go test math
,go test ./...
)。在这种模式下,会编译并测试路径列出的每个测试文件。go test
会缓存成功的测试结果,以避免不必要的重复运行测试。当再次执行测试时,会检查缓存中对应的测试结果是否 OK, 如果 OK 会重新显示之前的输出,而不会运行测试二进制文件。此时go test
会打印 '(cached)' 标识。
回过头来再看下项目的测试脚本:
CGO_ENABLED=1 go test -v --mod=vendor ./pkg/...
运行在 Package list mode, 所以单测通过后的二次测试, 会走 cache。
解决方案
有以下三种方式, 在测试中禁用缓存:
执行
go test
添加--count=1
参数(推荐,效率高),以上面????例子:CGO_ENABLED=1 go test -v --count=1 --mod=vendor ./pkg/...
Go 官方提供 clean工具,来删除对象文件和缓存文件, 不过这种方式相对麻烦:
go clean -testcache // Delete all cached test results
- 设置 GOCACHE 环境变量。GOCACHE 指定了 go 命令执行时缓存的路径,以便之后被复用。 设置
GOCACHE=off
即可禁用缓存。
小结
在 Go 项目测试的时候, 还是要多关注 go test
的行为表现,如果单测的结果跟实际有出入, 那么得考虑下使用 go test
的姿势对不对, 或者忘记加了参数。
参考
有疑问加站长微信联系(非本文作者)