使用 Bazel 实现代码覆盖率

<ph type="x-smartling-placeholder"></ph> 报告问题查看来源敬上每晚 · 7.3。 · 7.2 条 · 7.1。 · 7.0。 · 6.5 条

Bazel 使用 coverage 子命令来生成代码覆盖率有关可使用 bazel coverage 测试的代码库的报告。到期日与各种语言生态系统的特性息息相关，但这并不是这对于给定项目而言是轻而易举的。

本页记录了创建和查看覆盖率报告，还会提供一些以不同语言撰写的备注，配置众所周知的语言。最好先阅读阅读“常规”部分了解特定语言的要求。同时请注意 remote execution section（远程执行部分），该部分需要一些。

尽管可以进行大量自定义操作，但本文档重点介绍生成和使用 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 的一部分）项目）生成可在 Web 环境中查看的报告浏览器：

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

请注意，genhtml 也会读取源代码，为缺少的内容添加注释对这些文件的覆盖率为了实现这一功能 genhtml 将在 bazel 项目的根目录中执行。

如需查看结果，只需打开在index.html genhtml 目录中。

如需有关 genhtml 工具或 lcov 覆盖率格式，请参阅 lcov 项目。

远程执行

目前，使用远程测试执行运行有几点注意事项：

目前无法远程运行此报告组合操作。这是因为 Bazel 并不将覆盖率输出文件视为其图表（请参阅此问题），因此没有将它们正确视为组合操作的输入。接收者如需解决此问题，请使用 --strategy=CoverageReport=local。
- 注意：您可能需要指定类似于 --strategy=CoverageReport=local,remote（如果设置了 Bazel）最多尝试 local,remote，这要归功于 Bazel 解析策略的方式。
--remote_download_minimal 和类似标志也不能使用。
目前，如果测试，Bazel 将无法创建覆盖率信息之前已缓存过的内容为解决此问题，可以专门为覆盖率运行设置 --nocache_test_results，当然这会产生高昂的测试时间。
--experimental_split_coverage_postprocessing和 --experimental_fetch_all_coverage_outputs <ph type="x-smartling-placeholder">
- 覆盖率通常作为测试操作的一部分运行，因此，默认情况下，我们并不会将所有覆盖率都返回为远程默认执行方式这些标志会覆盖默认值，并获取覆盖率数据。如需了解详情，请参阅此问题。

特定于语言的配置

Java

Java 应该可以在默认配置下开箱即用。通过 bazel 工具链包含包括 JUnit。

Python

前提条件

使用 Python 运行覆盖率需满足一些前提条件：

一个包含 b01c859 的 bazel 二进制文件它应该是任何版本高于 3.0 的 Bazel
Coverage.py 的修改版本。

使用修改后的覆盖率.py

一种方法是通过 rules_python，使用 requirements.txt 文件的能力，所列的要求并使用 pip_install 代码库规则。

requirements.txt 应包含以下条目：

git+https://github.com/ulfjack/coveragepy.git@lcov-support

然后，应在 WORKSPACE 文件中将 rules_python、pip_install 和 requirements.txt 文件用作：

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
    name = "rules_python",
    url = "https://github.com/bazelbuild/rules_python/releases/download/0.5.0/rules_python-0.5.0.tar.gz",
    sha256 = "cd6730ed53a002c56ce4e2f396ba3b3be262fd7cb68339f0377a45e8227fe332",
)

load("@rules_python//python:pip.bzl", "pip_install")

pip_install(
   name = "python_deps",
   requirements = "//:requirements.txt",
)

然后，Coverage.py 要求可以用于测试目标，在 BUILD 文件中设置以下内容：

load("@python_deps//:requirements.bzl", "entry_point")

alias(
    name = "python_coverage_tools",
    actual = entry_point("coverage"),
)

py_test(
    name = "test",
    srcs = ["test.py"],
    env = {
        "PYTHON_COVERAGE": "$(location :python_coverage_tools)",
    },
    deps = [
        ":main",
        ":python_coverage_tools",
    ],
)

如果您使用封闭的 Python 工具链，而不是添加覆盖率依赖项，您可以改为将覆盖率工具添加到py_test 工具链配置。

由于 pip_install 规则依赖于 Python 工具链，它不能用于提取 coverage 模块。而是添加您的 WORKSPACE，例如

http_archive(
    name = "coverage_linux_x86_64"",
    build_file_content = """
py_library(
    name = "coverage",
    srcs = ["coverage/__main__.py"],
    data = glob(["coverage/*", "coverage/**/*.py"]),
    visibility = ["//visibility:public"],
)
""",
    sha256 = "84631e81dd053e8a0d4967cedab6db94345f1c36107c71698f746cb2636c63e3",
    type = "zip",
    urls = [
        "https://files.pythonhosted.org/packages/74/0d/0f3c522312fd27c32e1abe2fb5c323b583a5c108daf2c26d6e8dfdd5a105/coverage-6.4.1-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
    ],
)

然后配置您的 Python 工具链，例如

py_runtime(
    name = "py3_runtime_linux_x86_64",
    coverage_tool = "@coverage_linux_x86_64//:coverage",
    files = ["@python3_9_x86_64-unknown-linux-gnu//:files"],
    interpreter = "@python3_9_x86_64-unknown-linux-gnu//:bin/python3",
    python_version = "PY3",
)

py_runtime_pair(
    name = "python_runtimes_linux_x86_64",
    py2_runtime = None,
    py3_runtime = ":py3_runtime_linux_x86_64",
)

toolchain(
    name = "python_toolchain_linux_x86_64",
    exec_compatible_with = [
        "@platforms//os:linux",
        "@platforms//cpu:x86_64",
    ],
    toolchain = ":python_runtimes_linux_x86_64",
    toolchain_type = "@bazel_tools//tools/python:toolchain_type",
)