如何让Go Cover工具在覆盖率报告中排除间接调用的函数?
如何让Go Cover统计覆盖率时排除间接调用的函数?
我希望Go Cover生成覆盖率报告时,不将间接调用的函数纳入统计范围。例如pkg/response/response.go中的Success和Write函数完全没有编写测试用例,但因为src/api/info/info.go的测试用例调用了这两个函数,它们被计入了覆盖率,仿佛经过了测试一样。storage模块的相关函数也存在同样的问题。
我执行的测试命令如下:
$ go test -v -race -timeout=180s -count=1 -covermode=atomic -coverpkg=./... -coverprofile cover.out ./... $ go tool cover -func cover.out
输出的覆盖率结果:
cmd/app/main.go:22: main 0.0% pkg/response/response.go:28: Success 66.7% <- 完全未测试,但`src/api/info/info.go`已测试并调用此函数 pkg/response/response.go:138: Write 57.1% <- 完全未测试,但`src/api/info/info.go`已测试并调用此函数 src/api/info/handler.go:7: NewHandler 0.0% src/api/info/info.go:15: Handle 100.0% <- 已测试 src/api/v1/users/handler.go:22: NewHandler 0.0% src/api/v1/users/posts/handler.go:17: NewHandler 0.0% src/storage/database/error.go:10: isNotFoundError. 100.0% <- 完全未测试,但`src/storage/database/storage.go`已测试并调用此函数 src/storage/database/error.go:14: isConflictError 75.0% <- 完全未测试,但`src/storage/database/storage.go`已测试并调用此函数 src/storage/database/storage.go:25: CreateUser 80.0% <- 已测试 src/storage/database/storage.go:56: FindUser 83.3% <- 已测试 src/storage/database/storage.go:87: DeleteUser 80.0% <- 已测试 src/storage/database/storage.go:115: CreatePost 84.6% <- 已测试 src/storage/database/storage.go:155: ListPostsForUser 70.0% <- 已测试 total: (statements) 26.7%
解决方案
Go Cover本身没有直接提供排除间接调用的选项,但可以通过以下两种方式实现需求:
1. 拆分测试范围,避免跨包覆盖统计
不要使用-coverpkg=./...将所有包纳入覆盖统计,而是默认只统计当前测试包内的代码覆盖率。修改测试命令:
$ go test -v -race -timeout=180s -count=1 -covermode=atomic -coverprofile cover.out ./...
去掉-coverpkg=./...参数后,Go只会把针对当前包编写的测试用例执行到的代码计入覆盖率,其他包被间接调用的代码不会被统计。
如果需要单独查看某个特定包的真实覆盖率(比如pkg/response),可以直接测试该包并生成报告:
$ go test -v -race -timeout=180s -count=1 -covermode=atomic -coverprofile response.out ./pkg/response $ go tool cover -func response.out
这样只有专门为pkg/response写的测试用例才会被计入该包的覆盖率,间接调用的代码不会干扰统计结果。
2. 手动过滤覆盖率报告
如果必须保留全局统计的需求,可以生成报告后用脚本过滤掉没有对应测试文件的包的数据。
比如用Shell脚本实现:
# 找出所有包含测试文件的包路径 test_packages=$(find . -name "*_test.go" | xargs dirname | sort | uniq | sed 's/^\.\///' | paste -sd "|" -) # 过滤cover.out,只保留这些包的覆盖率数据 grep -E "^$test_packages" cover.out > filtered_cover.out # 生成过滤后的函数覆盖率报告 go tool cover -func filtered_cover.out
这个脚本会先定位所有有测试文件的包,然后从原始覆盖率文件中筛选出这些包的数据,间接调用的无测试包的统计就会被排除。
注意事项
- 第一种方法是最符合Go测试设计理念的方案:每个包的覆盖率应该由针对该包的测试用例来保证,而非依赖其他包的间接调用。
- 第二种方法适合需要全局统计但要排除无测试包的场景,不过需要根据项目结构调整脚本逻辑。
内容的提问来源于stack exchange,提问作者BentCoder
相关产品推荐
相关产品推荐

