如何在Go测试覆盖率计算中忽略生成文件

嘿，这个问题我之前也碰到过！那些标了DO NOT EDIT的自动生成代码混入覆盖率统计确实挺烦人的——我们根本不需要为这些自动生成的内容写测试。下面给你几个实用的原生解决办法，不需要额外安装第三方工具：

方案一：过滤覆盖率报告文件（最灵活通用） #

这种方法先正常生成完整的覆盖率数据，再把包含DO NOT EDIT的文件从报告里剔除，步骤如下：

1. 先生成原始的覆盖率文件：

go test -coverprofile=cover.out ./your/target/package

2. 找出所有包含DO NOT EDIT标记的生成文件，然后过滤掉这些文件对应的覆盖率数据行：

# 生成过滤后的覆盖率文件
grep -v -f <(grep -rl "DO NOT EDIT" ./your/target/package) cover.out > filtered_cover.out

3. 用过滤后的文件生成可视化报告：

go tool cover -html=filtered_cover.out

这个方法不管生成文件和源码在不在同一个目录、有没有统一命名规则，都能准确识别并排除，非常灵活。

方案二：用-coverpkg指定要覆盖的范围（适合有规律的文件结构） #

如果你的生成文件都集中在某个子目录（比如gen/），或者有统一的包路径，可以直接用Go测试的-coverpkg参数指定要包含/排除的包（Go 1.17及以上版本支持用!前缀排除路径）：

比如生成文件都在./your/target/package/gen目录下，那么可以这样执行测试：

go test -coverprofile=cover.out -coverpkg ./your/target/package/...,!./your/target/package/gen/... ./your/target/package

如果生成文件的命名有规律但和源码在同一目录，这种方法可能不太适用，还是方案一更靠谱。

小提示 #

如果经常需要执行这个操作，可以把过滤命令写成一个shell脚本，每次直接运行脚本就能得到干净的覆盖率报告啦！

内容的提问来源于stack exchange，提问作者Rohanil