Bazel覆盖率报告未包含无测试源文件的问题求助

核心原因 #

Bazel默认仅统计被测试目标直接/间接依赖的源文件，未被测试引用的文件不会被纳入覆盖率报告，导致覆盖率百分比虚高（比如目录下1个有覆盖、1个无覆盖文件时，会显示100%）。

解决方案 #

1. 确保所有源文件都被Bazel目标管理 #

检查你的BUILD.bazel文件，确保目录下的所有源文件都被对应语言的library目标（比如Go的go_library）包含：

go_library(
    name = "servicescode",
    srcs = [
        "file1.go",
        "file2.go",  # 务必把无覆盖的文件也加入
    ],
    importpath = "your/import/path",
    visibility = ["//visibility:public"],
)

同时让测试目标依赖这个包含所有源文件的library：

go_test(
    name = "servicescode_test",
    srcs = ["servicescode_test.go"],
    deps = [
        ":servicescode",
    ],
)

只有Bazel识别到这些文件属于某个目标，才会将其纳入覆盖率统计范围。

2. 调整Bazel Coverage命令参数 #

执行bazel coverage时添加--instrumentation_filter参数，强制对指定路径下的所有文件插桩，避免过滤未被测试覆盖的文件：

./bazel coverage --config=gocov //src/servicescode/... --combined_report=lcov --instrumentation_filter="src/servicescode/.*"

3. 检查自定义覆盖率生成器配置 #

你使用的gocoverage-lcov是自定义生成器，需要确认它的逻辑是否会过滤无覆盖数据的文件。如果有过滤逻辑，修改为保留这些文件，将其覆盖数设为0即可。

4. 手动补充无覆盖文件记录（临时方案） #

如果上述方法无法生效，可通过lcov工具手动补充无覆盖文件的空记录：

1. 收集目录下所有源文件路径：

find src/servicescode -name "*.go" > all_files.txt

2. 生成空覆盖记录文件：

lcov --base-directory . --directory . --output-file empty_coverage.dat --no-external --quiet

3. 为每个文件添加空覆盖条目：

while read file; do
    echo "SF:$file" >> empty_coverage.dat
    echo "end_of_record" >> empty_coverage.dat
done < all_files.txt

4. 合并空记录与Bazel生成的报告：

lcov --add-tracefile bazel-out/_coverage/_coverage_report.dat --add-tracefile empty_coverage.dat --output-file combined_coverage.dat

5. 用合并后的报告生成HTML：

./bazel run @lcov//:bin/genhtml -- -o $HOME/waste/ --ignore-errors source --function-coverage --branch-coverage --no-sort combined_coverage.dat

验证效果 #

重新生成报告后，检查_coverage_report.dat是否包含之前遗漏的文件（即使覆盖数为0）。此时上传至SonarQube后，覆盖率会基于所有文件计算，结果更符合实际情况。

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