如何在CMake中为c++项目添加代码覆盖率(coverage)报告? (gcov/lcov)

启用编译器覆盖率支持需同时添加-fprofile-arcs和-ftest-coverage,禁用优化(-O0),链接时也要加-fprofile-arcs;运行测试生成.gcda后,用lcov过滤无关路径再用genhtml生成报告。

启用编译器的覆盖率支持(-fprofile-arcs -ftest-coverage)

不加这两个编译选项,gcov 就无法生成覆盖率数据文件(.gcda),后续所有报告都是空的。CMake 默认不会开启,必须显式添加。

  • CXX_FLAGS 添加 -fprofile-arcs -ftest-coverage,注意:二者需同时存在,缺一不可
  • 必须禁用优化(-O0)或至少禁用内联(-fno-inline),否则函数调用会被优化掉,.gcda 数据会不完整甚至缺失
  • 链接时也要加 -fprofile-arcs,否则链接阶段可能丢弃覆盖率相关符号(尤其在使用 target_link_libraries 时容易遗漏)
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fprofile-arcs -ftest-coverage -O0")
set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -fprofile-arcs")

确保测试运行后生成 .gcda 文件

.gcda 是运行时生成的二进制覆盖率数据,不是编译时产生的。如果没看到它们,大概率是测试没真正执行、程序提前退出,或工作目录不对。

  • 测试可执行文件必须实际运行(ctest 或直接 ./my_test),且正常退出(return 0exit(0));崩溃或被信号终止会导致 .gcda 写入不全
  • 运行路径要和编译路径一致(尤其是相对路径包含源码时),否则 gcov 找不到源文件,lcov 会跳过对应项
  • .gcda 默认生成在可执行文件所在目录,不是源码目录;若测试是 ctest 驱动,确认 ctest 的工作目录(可用 ctest -V 查看)

用 lcov 提取并过滤覆盖率数据

lcov 是封装 gcov 的工具,但直接跑 lcov --capture 会抓到系统库、第三方头文件甚至 C++ 标准库的覆盖数据,必须过滤。

  • 先用 lcov --capture --directory . --output-file coverage_base.info 抓原始数据
  • lcov --remove coverage_base.info '/usr/*' '*/test/*' '*/third_party/*' --output-file coverage_filtered.info 剔除无关路径(路径通配符需用单引号防 shell 展开)
  • 关键点:--directory . 指的是包含 .gcda 的目录,不是源码根目录;若 .gcdabuild/test/ 下,这里就得写 --directory build/test

生成 HTML 报告并检查路径映射

genhtml 依赖 .gcno(编译生成)、.gcda(运行生成)和源码路径三者能对齐。常见报错 “cannot open source file” 就是因为路径不匹配。

立即学习“C++免费学习笔记(深入)”;

  • 运行 genhtml coverage_filtered.info --output-directory coverage_html
  • 如果页面里显示源码路径是 /home/user/project/src/foo.cpp,但本地实际是 ~/proj/src/foo.cpp,就需用 --prefix 修复:genhtml ... --prefix "/home/user/project" --replace "path/to/project"
  • CI 环境中建议在 lcov --capture 前加 lcov --initial --directory . --output-file coverage_base.info,避免基线污染(尤其多轮测试时)
CMake 本身不内置覆盖率逻辑,所有步骤都靠手动注入编译标志 + 外部命令串联。最容易漏的是链接器标志和运行时工作目录 —— 这两个一错,整个链路就静默失败,连 .gcda 都看不到。