Go 项目代码覆盖率:
cmd:
go test -coverprofile=tmp.cov.out -coverpkg=$(dir)
名词解释:
go: 管理 Go源码的 工具
test:
go的一系列命令之一,自动测试指定的package,重新编译指定包下的*_test.go文件
go test 两种运行模式:
- local directory mode:没有指定package,只编译并执行测试当前目录,没有cache成功的测试结果
- package list mode: go test 编译并执行测试每个列出的package,cache成功的测试结果,避免重复测试执行。
go test flags:
- -c::编译二进制文件为pkg.test,不执行测试
- -o:编译二进制文件并命名为指定名字,执行测试
- -json:转换测试输出为json格式
- -i:install 测试依赖包,不执行测试
- -coverprofile:输出覆盖信息, 调用cover工具,在编译之前重写源代码。
- -coverpkg:统计覆盖率的package
- -covermode: count/set/atomatic
覆盖率统计原理:
go命令内置 cover工具, 在编译之前重写源代码。
cover三种模式:
- set: 每个语句执行 (默认)
- count: 每个语句执行了几次
- atomic: 类似于 count, 但表示的是并行程序中的精确计数
covermode=set时:
在执行go test编译成二进制文件前,更改源码,在每行可执行代码前增加一个赋值语句标记,用于执行时统计。计数器与 cover 工具生成的第二个只读数据结构记录的语句的原始源位置相关联。 测试运行完成后,收集计数器,通过查看设置的数量的来计算百分比。
示例:
func Size(a int) string {
GoCover.Count[0] = 1
switch {
case a < 0:
GoCover.Count[2] = 1
return "negative"
case a == 0:
GoCover.Count[3] = 1
return "zero"
case a < 10:
GoCover.Count[4] = 1
return "small"
case a < 100:
GoCover.Count[5] = 1
return "big"
case a < 1000:
GoCover.Count[6] = 1
return "huge"
}
GoCover.Count[1] = 1
return "enormous"
}
输出test.cov.out文件,执行go cover 分析文件。
覆盖率统计实践:
单测覆盖率统计:
- 循环遍历项目下所有目录:
dir_all=$(go list ./...)
2. 收集每个目录下代码覆盖率输出:
go test -coverprofile=tmp.cov.out -coverpkg=$(dir)
3. 结合sonarqube工具:scanner 分析cov.out文件
集成测试覆盖率统计:
使用ginex框架:
- 通过 init() 方法 隐式初始化flag,设置进程执行时参数。
- func init() {
- flag.BoolVar(&systemTest, "systemTest", false, "Set to true when running system tests.")
- }
- Note:运行时通过 main函数里 ginex.Init() 解析flag
- 执行二进制可执行文件时,添加flag标志
- exec {BinaryName} -systemTest -test.coverprofile=systest.cov.out
- Note:执行时有systemTest flag则值为true,进程会执行到TestEntry,走测试二进制可执行文件, 此时的二进制可执行文件包含测试收集标志,即此时的二进制可执行文件必须为go test 编译的产物。
- -test.coverprofile 指出覆盖率输出文件。
- 在build.sh 文件中增加:
- go test -c -covermode=set -a -o output/bin/${RUN_NAME} -coverpkg=./...
- 输出的文件结合sonarqube工具:scanner 分析cov.out文件