如何通过Python测试获取Pybind调用的C++代码覆盖率？

结论 #

可以通过Pybind的.so文件生成C++覆盖率数据，核心需要解决编译时覆盖率标志配置、主动触发数据写入和Bazel沙箱权限三个关键问题。

具体步骤 #

1. 编译阶段启用覆盖率标志 #

确保所有涉及的C++目标（包括Pybind模块和依赖库）都用覆盖率标志编译：

• 构建时直接传递参数：

  bazel build //your/pybind:module //your/test:py_test --copt=-fprofile-arcs --copt=-ftest-coverage --linkopt=-lgcov
  

• 或者在.bazelrc中添加默认配置（避免重复输入）：

  build:coverage --copt=-fprofile-arcs
  build:coverage --copt=-ftest-coverage
  build:coverage --linkopt=-lgcov
  

  后续构建时只需执行bazel build --config=coverage ...

注：如果用Clang替代GCC，编译标志改为--copt=-fprofile-instr-generate --copt=-fcoverage-mapping --linkopt=-fprofile-instr-generate

2. 主动触发覆盖率数据写入 #

Python进程退出时，可能因析构顺序问题导致gcov未写入数据，需手动触发：

• 在Pybind模块中添加一个刷新覆盖率的接口：

  #include <pybind11/pybind11.h>
  
  #ifdef __GNUC__
  #include <gcov.h>
  #elif __clang__
  #include <llvm-c/profile.h>
  #endif
  
  namespace py = pybind11;
  
  PYBIND11_MODULE(your_module, m) {
      // 原有绑定代码...
  
      m.def("flush_coverage", []() {
          #ifdef __GNUC__
          __gcov_flush(); // GCC 触发数据写入
          #elif __clang__
          __llvm_profile_write_file(); // Clang 触发数据写入
          #endif
      });
  }
  

• 在Python测试的收尾阶段调用该接口，比如用pytest的teardown_module：

  import your_module
  
  def teardown_module():
      your_module.flush_coverage()
  
  # 测试用例...
  

3. 配置Bazel沙箱的覆盖率文件输出路径 #

Bazel沙箱默认限制写入位置，需指定gcda/profraw文件的输出目录：

• GCC环境：通过GCOV_PREFIX和GCOV_PREFIX_STRIP指定输出路径，运行测试时传递环境变量：

  bazel test //your/test:py_test --config=coverage --test_env=GCOV_PREFIX=/tmp/coverage_output --test_env=GCOV_PREFIX_STRIP=4
  

  • GCOV_PREFIX_STRIP：用于去掉编译路径的前缀层级，避免生成复杂的目录结构
• Clang环境：设置LLVM_PROFILE_FILE：

  bazel test //your/test:py_test --config=coverage --test_env=LLVM_PROFILE_FILE=/tmp/coverage_output/%p.profraw
  

  • %p：替换为进程ID，避免多测试进程覆盖文件

4. 生成覆盖率报告 #

• GCC + lcov：

  # 收集覆盖率数据
  lcov -c -d ./bazel-bin -o coverage.info
  # 过滤掉不需要统计的文件（比如系统头文件）
  lcov -r coverage.info "/usr/include/*" -o filtered_coverage.info
  # 生成HTML报告
  genhtml filtered_coverage.info -o coverage_report
  

• Clang + llvm-cov：

  # 合并profraw文件
  llvm-profdata merge -sparse /tmp/coverage_output/*.profraw -o coverage.profdata
  # 生成HTML报告
  llvm-cov show ./bazel-bin/your/pybind/your_module.so -instr-profile=coverage.profdata -show-line-counts-or-regions -output-dir=coverage_report
  

常见问题 #

• 若仍无gcda文件：检查所有依赖的C++库是否都启用了覆盖率标志，遗漏的库会导致部分数据无法生成
• Bazel的bazel coverage命令默认针对C++/Java测试，对Python测试需手动传递上述编译和运行参数，无法直接复用
• 确保测试运行时沙箱有权限写入指定的输出目录，可先手动创建目录并设置权限

内容的提问来源于stack exchange，提问作者celestialorb