Bazel 具有 coverage
子命令,可针对可以使用 bazel coverage
测试的代码库生成代码覆盖率报告。由于各种语言生态系统的特性,让此方法适用于给定项目并非总是轻而易举。
本页面介绍了创建和查看覆盖率报告的一般流程,还针对配置众所周知的语言提供了一些特定于语言的备注。您最好先阅读一般部分,然后再阅读特定语言的要求。另请注意远程执行部分,该部分需要一些额外的注意事项。
虽然可以进行很多自定义操作,但本文档重点介绍如何生成和使用 lcov
报告,这也是目前受支持最出色的路线。
创建覆盖率报告
准备
创建覆盖率报告的基本工作流程需要满足以下要求:
- 包含测试目标的基本代码库
- 安装了特定语言代码覆盖率工具的工具链
- 正确的“Instrumentation”配置
前者仅适用于特定语言,而且大多十分简单,但对于复杂的项目而言,后者可能会比较困难。
在本例中,“插桩”是指用于特定目标的覆盖率工具。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 --output genhtml "$(bazel info output_path)/_coverage/_coverage_report.dat"
请注意,genhtml
也会读取源代码,为这些文件中缺失的覆盖率添加注解。为此,应在 bazel 项目的根目录中执行 genhtml
。
如需查看结果,只需在任何网络浏览器中打开 genhtml
目录中生成的 index.html
文件即可。
如需有关 genhtml
工具或 lcov
覆盖率格式的更多帮助和信息,请参阅 lcov 项目。
远程执行
目前,通过远程测试执行运行需要注意一些事项:
- 报告组合操作尚无法远程运行。这是因为 Bazel 不会将覆盖率输出文件视为其图的一部分(请参阅此问题),因此无法正确地将它们视为组合操作的输入。如需解决此问题,请使用
--strategy=CoverageReport=local
。- 注意:鉴于 Bazel 解析策略的方式,如果 Bazel 设置为尝试
local,remote
,则可能需要指定类似--strategy=CoverageReport=local,remote
的内容。
- 注意:鉴于 Bazel 解析策略的方式,如果 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
覆盖率文档。