使用 Bazel 实现代码覆盖率

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 项目的一部分)生成可在网络 浏览器中查看的报告:

genhtml --branch-coverage --output genhtml "$(bazel info output_path)/_coverage/_coverage_report.dat"

请注意,genhtml 也会读取源代码,以注释这些文件中缺失的覆盖率。为此,预计 genhtml 将在 bazel 项目的根目录中执行。

如需查看结果,只需在任何网络浏览器中打开 genhtml 目录中生成的 index.html 文件即可。

如需详细了解 genhtml 工具或 lcov 覆盖率格式,请参阅 the lcov project

远程执行

目前,使用远程测试执行运行有一些注意事项:

  • 报告组合操作尚无法远程运行。这是因为 Bazel 不会将覆盖率输出文件视为其图的一部分(请参阅 此问题),因此无法正确地将它们视为组合操作的输入。如需解决此问题,请使用 --strategy=CoverageReport=local
    • 注意:如果 Bazel 设置为尝试 local,remote,则可能需要指定类似 --strategy=CoverageReport=local,remote 的内容,具体取决于 Bazel 解析策略的方式。
  • --remote_download_minimal 和类似标志也无法使用 由于上述原因。
  • 如果之前缓存了测试 ,Bazel 目前将无法创建覆盖率信息。如需解决此问题, --nocache_test_results可以专门为覆盖率运行设置, 但这当然会大大增加测试时间。
  • --experimental_split_coverage_postprocessing--experimental_fetch_all_coverage_outputs
    • 通常,覆盖率作为测试操作的一部分运行,因此默认情况下,我们不会默认将所有覆盖率作为远程执行的输出返回。这些标志会替换默认值并获取 覆盖率数据。如需了解详情,请参阅此问题

特定于语言的配置

Java

Java 应该可以使用默认配置开箱即用。 bazel 工具链包含 远程执行所需的一切内容,包括 JUnit。

Python

如需了解在 Python 中启用覆盖率支持所需的其他步骤,请参阅 rules_python 覆盖率文档