使用lcov+gtest生成的代码覆盖率仅统计单元测试文件,未覆盖被测库文件
覆盖率报告缺失被测类数据的修复方案
核心问题根因
报告仅包含测试文件覆盖数据、缺失foo类对应文件的原因主要有两点:
- 编译阶段未为被测的Foo库开启覆盖率插桩选项,编译
foo.cpp生成的目标文件没有内置覆盖率计数逻辑,不会生成对应的.gcno/.gcda插桩文件,lcov自然无法采集到这部分代码的覆盖数据。 - lcov采集覆盖率数据时的路径配置错误,将目录指向了源码路径而非构建产物路径,而所有的覆盖率插桩计数文件均生成在构建目录下,路径不匹配会导致采集不全。
分步配置修改
1. 全局添加覆盖率编译/链接选项
在根目录CMakeLists.txt的项目初始化部分加入如下配置,确保所有参与编译的目标(包括被测foo库、测试可执行文件)都带上覆盖率插桩参数:
# GCC/Clang通用的覆盖率插桩配置 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} --coverage") set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} --coverage") set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} --coverage")
这里的--coverage参数是GCC和Clang通用的等价配置,会自动完成编译期插桩、链接gcov运行库的操作,不需要手动拆分写-fprofile-arcs -ftest-coverage -lgcov等零散参数。
注意:修改配置后需要完全清理旧的构建目录再重新编译,避免复用之前未插桩的foo库目标文件,导致配置不生效。
2. 修正lcov采集与生成流程的参数
原自定义run_tests目标的采集路径错误,需要调整为指向构建目录,并补充旧数据清理、无关文件过滤的步骤,修正后的完整配置如下:
add_custom_target(run_tests # 清空构建目录下旧的覆盖率计数,避免残留数据干扰结果 COMMAND lcov --directory ${CMAKE_BINARY_DIR} --zerocounters # 执行单元测试,运行时生成被测代码的.gcda计数文件 COMMAND ${CMAKE_BINARY_DIR}/src/test/unit_test # 从构建目录采集全量覆盖率数据,排除系统外部路径 COMMAND lcov --capture --directory ${CMAKE_BINARY_DIR} \ --output-file gtest_demo.info \ --test-name gtest_demo \ --no-external # 过滤掉不需要统计的第三方代码(如gtest框架自身代码、系统头文件路径) COMMAND lcov --remove gtest_demo.info '/usr/*' '*gtest*' \ --output-file gtest_demo_filtered.info # 基于过滤后的数据生成HTML格式覆盖率报告 COMMAND genhtml gtest_demo_filtered.info \ --output-directory ${CMAKE_SOURCE_DIR}/coverage_report \ --title "代码覆盖率报告" \ --show-details --legend # 统一在构建目录下执行所有命令,避免.gcda文件散落到其他路径 WORKING_DIRECTORY ${CMAKE_BINARY_DIR} )
其中关键调整点:
- 将lcov的采集路径从
${CMAKE_SOURCE_DIR}(源码目录)改为${CMAKE_BINARY_DIR}(构建目录),因为所有带插桩信息的对象文件、计数文件都在构建目录生成,源码目录本身不会存在这类中间文件。 - 保留原配置的
--no-external参数,该参数会自动过滤不属于项目源码树的外部路径,减少无关数据的采集量。 - 补充了计数器清零步骤,保证每次运行
make run_tests得到的是干净的、当次测试的覆盖率数据,不会混入历史运行的旧计数。 - 补充了第三方代码过滤步骤,避免gtest框架、系统库的代码被纳入项目自身的覆盖率统计,导致报告冗余。
验证方式
完成配置修改并重新编译执行后,打开coverage_report目录下的index.html文件,即可看到foo.h、foo.cpp的覆盖率统计结果:
- 已经被单元测试覆盖的构造函数、times方法会标记为绿色覆盖状态
- 未被测试覆盖的isPositive方法会标记为红色未覆盖状态
内容的提问来源于stack exchange,提问作者apalomer
相关产品推荐
相关产品推荐

