使用 Bazel 生成覆盖率报告答案

【问题标题】：Using Bazel to generate coverage report使用 Bazel 生成覆盖率报告
【发布时间】：2017-09-27 11:54:18
【问题描述】：

我正在使用 genhtml 命令从 Bazel 生成的 coverage.dat 文件生成 html 覆盖率报告：

genhtml bazel-testlogs/path/to/TestTarget/coverage.dat --output-directory coverage

使用 genhtml 的问题是我必须提供 coverage.dat 文件的路径（在 bazel-testlogs/.. 中生成）是否可以从另一个规则中获取这些 coverage.dat 文件作为输出?

我不想直接调用 genthml 命令，而是让 Bazel 处理所有事情。

【问题讨论】：

嗨，你遇到过ERROR: output '_coverage/_coverage_report.dat' was not created运行时bazel coverage
@stamaimer 不记得这个特定的错误，这是不久前的事了......
您好，您还记得您编译时使用的 gcc 版本吗？

标签： code-coverage bazel

【解决方案1】：

我无法找到一种方法来获取 coverage.dat 文件作为 bazel 规则的输出。但是，我能够将所有 .dat 文件的所有位置作为 src 包装到 WORKSPACE 目录中的文件组中：

filegroup(
    name = "coverage_files",
    srcs = glob(["bazel-out/**/coverage.dat"]),
)

然后在包含 genthml 命令的自定义 .bzl 规则中使用该文件组以生成 html 覆盖率报告。所以现在我只需要打电话

bazel coverage //path/... --instrumentation_filter=/path[/:]

命令生成coverage.dat 文件，生成html 报告并将其压缩。因此，bazel 处理一切。

【讨论】：

您能否展示您如何结合使用filegroup 和genhtml 来生成最终的index.html 覆盖率报告？你用过genrule吗？我在工作区根目录的BUILD 文件中添加了filegroup 和genrule，但似乎没有任何效果。
@PavanManjunath 无法找到所有代码。我确实有一个自定义 .bzl 文件，它使用 run_shell 和 cmd 运行 python coverage html 命令，该命令生成 html 文件。不确定这是否有帮助，如果您需要更多信息，请告诉我。
@Zeitgeist 我不明白，你不能发布代码吗？或者你找不到？您能分享一下您是如何生成 HTML 的吗？
@sgammon 正确，我无权访问代码，多年来一直从事不同的项目。为了生成 HTML 文件，我在 WORKSPACE 中使用 http_file() 下载了 genhtml 可执行文件，然后我创建了一个自定义 bzl 规则，其中我合并了一个运行该可执行文件的 cmd 命令。（由于这是很久以前完成的，现在可能有更好的方法来做事）

【解决方案2】：

Bazel 添加了对C++ coverage 的支持（尽管我找不到太多关于它的文档）。

我能够生成一个组合的coverage.dat文件

bazel coverage -s \
  --instrument_test_targets \
  --experimental_cc_coverage \
  --combined_report=lcov \
  --coverage_report_generator=@bazel_tools//tools/test/CoverageOutputGenerator/java/com/google/devtools/coverageoutputgenerator:Main \
  //...

覆盖文件被添加到bazel-out/_coverage/_coverage_report.dat

【讨论】：

你使用的是哪个 bazel 版本？
我用 0.21.0 版本测试过
FWIW，你的链接失效了

【解决方案3】：

对于基于 Java 的项目，我们可以通过以下方式获得代码覆盖率

获取完整模块的覆盖范围 ->

完整项目模块的运行覆盖率。运行以下命令 ->

bazel coverage ... --compilation_mode=dbg --subcommands --announce_rc --verbose_failures --jobs=auto  --sandbox_debug --build_runfile_links --combined_report=lcov --coverage_report_generator=@bazel_tools//tools/test/CoverageOutputGenerator/java/com/google/devtools/coverageoutputgenerator:Main

然后从父项目目录运行以下命令以获取 html 视图。在我们指定的output-directory-name 中生成 HTML 报告。从那个打开的index.html 看报道。

genhtml -o <output-directory-name> bazel-out/_coverage/_coverage_report.dat

bazel-out 目录通常在项目父目录中创建（例如 bazel WORKSPACE 文件所在的位置）

覆盖模块中的特定 IT/测试 ->

模块中特定 IT/测试的运行覆盖率。从项目/子项目目录运行以下命令 ->

bazel coverage <class-name-of-Test-or-IT> --compilation_mode=dbg --subcommands --announce_rc --verbose_failures --jobs=auto  --sandbox_debug --build_runfile_links --combined_report=lcov --coverage_report_generator=@bazel_tools//tools/test/CoverageOutputGenerator/java/com/google/devtools/coverageoutputgenerator:Main

然后从父项目目录运行以下命令以获取 html 视图。在我们指定的output-directory-name 中生成 HTML 报告。从那个打开的index.html 看报道。

genhtml -o <output-directory-name> bazel-out/_coverage/_coverage_report.dat

【讨论】：