如何在lcov代码覆盖率未达标时让CI/CD流水线失败？

问题背景 #

我有一个使用CMake生成Makefile的C++项目，已添加如下自定义目标来运行代码覆盖率分析：

add_custom_target(
  coverage
  COMMAND
    lcov --rc lcov_branch_coverage=1 --capture --directory
    ${CMAKE_SOURCE_DIR} --output-file
    ${CMAKE_BINARY_DIR}/${PROJECT_NAME}_coverage.info --no-external
  COMMAND
    genhtml --branch-coverage
    ${CMAKE_BINARY_DIR}/${PROJECT_NAME}_coverage.info --output-directory
    ${CMAKE_BINARY_DIR}/coverage_report --title
    "${PROJECT_NAME} code coverage report" --show-details --legend
  COMMAND
    echo
    "Covverage report in ${CMAKE_BINARY_DIR}/coverage_report/index.html")

此前已在项目中配置正确的编译和链接标志，并通过add_test添加各类测试。执行make、make test、make coverage可正常生成覆盖率报告。现需集成到CI/CD中，检查覆盖率是否达标，未达标则让流水线失败，请问如何实现？

解决方案 #

1. 扩展CMake目标，添加覆盖率检查逻辑 #

利用lcov自带的--check-coverage参数可直接设置覆盖率阈值，当实际覆盖率低于阈值时，lcov会返回非零退出码，触发CI流水线失败。你可以选择两种实现方式：

方式一：单独创建coverage-check目标

这种方式将报告生成和阈值检查分离，灵活度更高：

add_custom_target(
  coverage
  COMMAND
    lcov --rc lcov_branch_coverage=1 --capture --directory
    ${CMAKE_SOURCE_DIR} --output-file
    ${CMAKE_BINARY_DIR}/${PROJECT_NAME}_coverage.info --no-external
  COMMAND
    genhtml --branch-coverage
    ${CMAKE_BINARY_DIR}/${PROJECT_NAME}_coverage.info --output-directory
    ${CMAKE_BINARY_DIR}/coverage_report --title
    "${PROJECT_NAME} code coverage report" --show-details --legend
  COMMAND
    echo "Coverage report in ${CMAKE_BINARY_DIR}/coverage_report/index.html"
)

# 新增覆盖率检查目标，自定义阈值
add_custom_target(
  coverage-check
  COMMAND
    lcov --rc lcov_branch_coverage=1 --check-coverage --directory
    ${CMAKE_SOURCE_DIR} --output-file
    ${CMAKE_BINARY_DIR}/${PROJECT_NAME}_coverage.info --no-external
    --line-coverage-rate 90  # 行覆盖率最低要求，比如90%
    --branch-coverage-rate 80  # 分支覆盖率最低要求，比如80%
)

方式二：整合到现有coverage目标

如果希望执行make coverage时自动完成报告生成和阈值检查，直接追加检查命令即可：

add_custom_target(
  coverage
  COMMAND
    lcov --rc lcov_branch_coverage=1 --capture --directory
    ${CMAKE_SOURCE_DIR} --output-file
    ${CMAKE_BINARY_DIR}/${PROJECT_NAME}_coverage.info --no-external
  COMMAND
    genhtml --branch-coverage
    ${CMAKE_BINARY_DIR}/${PROJECT_NAME}_coverage.info --output-directory
    ${CMAKE_BINARY_DIR}/coverage_report --title
    "${PROJECT_NAME} code coverage report" --show-details --legend
  COMMAND
    echo "Coverage report in ${CMAKE_BINARY_DIR}/coverage_report/index.html"
  # 追加覆盖率检查命令
  COMMAND
    lcov --rc lcov_branch_coverage=1 --check-coverage --directory
    ${CMAKE_SOURCE_DIR} --output-file
    ${CMAKE_BINARY_DIR}/${PROJECT_NAME}_coverage.info --no-external
    --line-coverage-rate 90
    --branch-coverage-rate 80
)

2. CI流水线中配置执行步骤 #

在CI脚本里按顺序执行编译、测试、报告生成（可选）、覆盖率检查。以GitLab CI为例，.gitlab-ci.yml配置示例：

coverage-check:
  stage: test
  script:
    - mkdir -p build && cd build
    - cmake ..
    - make
    - make test
    - make coverage  # 可选，生成报告用于后续排查问题
    - make coverage-check  # 执行阈值检查，不达标则流水线直接失败
  artifacts:
    paths:
      - build/coverage_report/  # 保留覆盖率报告供查看

补充说明 #

• 确保你的lcov版本支持--check-coverage参数，若版本过旧请升级。
• 阈值数值（--line-coverage-rate和--branch-coverage-rate）根据项目实际需求调整。
• 若需要更细粒度的规则（比如特定文件设置不同阈值），可替换为gcovr工具，它支持通过配置文件定义复杂的覆盖率检查规则，但需要额外安装。

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