Bazel 具有 coverage 子命令,可针对可通过 bazel coverage 进行测试的代码库生成代码覆盖率报告。由于各种语言生态系统的特殊性,要让此功能适用于特定项目并非易事。
本页介绍了创建和查看覆盖率报告的一般流程,还针对配置众所周知的语言提供了一些特定于语言的注意事项。最好先阅读常规部分,然后再阅读有关特定语言的要求。
虽然可以进行许多自定义,但本文档重点介绍如何生成和使用 lcov 报告,这是目前支持最完善的方法。
创建覆盖率报告
准备工作
创建覆盖率报告的基本工作流程需要执行以下操作:
- 包含测试目标的基本代码库
- 已安装特定于语言的代码覆盖率工具的工具链
- 正确的“插桩”配置
前两种方法特定于语言,而且大多比较简单,但对于复杂的项目,后一种方法可能会更难。
在这种情况下,“插桩”是指用于特定目标的覆盖率工具。Bazel 允许使用 --instrumentation_filter 标志针对特定文件子集启用此功能,该标志用于指定针对启用插桩的测试目标进行的过滤。如需为测试启用插桩,需要使用 --instrument_test_targets 标志。
默认情况下,bazel 会尝试匹配目标软件包,并以 INFO 消息的形式输出相关过滤条件。
跑步覆盖范围
如需生成覆盖率报告,请使用 bazel coverage
--combined_report=lcov
[target]。此命令会针对目标运行测试,并为每个文件生成 lcov 格式的覆盖率报告。
完成后,bazel 会运行一个操作,收集所有生成的覆盖率文件,并将它们合并为一个,然后最终在 $(bazel info
output_path)/_coverage/_coverage_report.dat 下创建该文件。
如果测试失败,系统也会生成覆盖率报告,但请注意,这不包括失败的测试,仅报告通过的测试。
查看覆盖范围
覆盖面报告仅以非人类可读的 lcov 格式输出。这样一来,我们就可以使用 genhtml 实用程序(属于 lcov 项目)生成可在 Web 浏览器中查看的报告:
genhtml --branch-coverage --output genhtml "$(bazel info output_path)/_coverage/_coverage_report.dat"
请注意,genhtml 也会读取源代码,以注释这些文件中缺失的覆盖率。为了使此功能正常运行,我们希望 genhtml 在 bazel 项目的根目录中执行。
如需查看结果,请在任意网络浏览器中打开 genhtml 目录中生成的 index.html 文件。
如需详细了解 genhtml 工具或 lcov 覆盖率格式,请参阅 lcov 项目。
特定于语言的配置
以下部分详细介绍了使用 Bazel 设置代码覆盖率时需要考虑的特定于语言的因素。
C++
Linux
C++ 代码覆盖率应在默认配置下开箱即用。
macOS
GCOV_PREFIX_STRIP 的默认值几乎可以肯定是不正确的,需要手动调整,因为正确的值取决于您的设置。
如果值不正确,则找不到任何覆盖率数据。
设置 GCOV_PREFIX_STRIP=10 的示例
bazel coverage //foo:foo_test --test_env=GCOV_PREFIX_STRIP=10`
Java
Java 应该可以开箱即用,并使用默认配置。Bazel 工具链包含远程执行所需的一切,包括 JUnit。
Python
如需了解在 Python 中启用覆盖率支持所需的其他步骤,请参阅rules_python 覆盖率文档。