工具介绍
重要参数配置
CmakeLists.txt相关设置
测试用例使用的是GTest,在单元测试对应的CMake添加如下代码
# 设置代码覆盖率的相关参数
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -pthread -fprofile-arcs -ftest-coverage -O0 -lgcov ")
设置 -O0
原因是:在进行单元测试时,启用分支覆盖率通常需要关闭编译器优化。这是因为编译器优化可能会对代码进行重排、删除、合并或优化,从而导致覆盖率报告不准确或缺失某些分支。
源代码CMake配置
# 开启代码覆盖率测试
option(CODE_COVERAGE "Enable coverage reporting" ON)
if(CODE_COVERAGE AND CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang")
add_compile_options(-fprofile-arcs -ftest-coverage)
add_link_options(-fprofile-arcs -ftest-coverage)
endif()
其实两个CMake写法不体哦那个·不同作用一样,可以相互替换
Bash脚本
#!/bin/bash
# 源代码目录相对路径
src_dir=/src
# 测试代码目录相对路径
test_dir=../test
#文件cover_report生成目录
build_dir="./build/ut_test"
cd $build_dir
#生成一个名为 init.info 的文件,其中包含了当前目录下的测试覆盖率数据。
lcov -d $src_dir -c -o init.info --rc lcov_branch_coverage=1
#将名为 init.info 的 .info 文件中保存的测试覆盖率数据追加到名为 total.info 的 .info 文件中
lcov -a init.info -o total.info --rc lcov_branch_coverage=1
#移除最终得到的效果中与代码测试无关的文件目录并开启分支覆盖率
lcov --remove total.info '*/usr/include/*' '*/usr/lib/*' '*/usr/lib64/*' '*/src/log/*' '*/tests/*' '*/usr/local/include/*' '*/usr/local/lib/*' '*/usr/local/lib64/*' '*ut_test/*' '*utils/*' -o final.info --rc lcov_branch_coverage=1
#这段命令的作用是将已经生成的 final.info 文件转换为 HTML 格式的覆盖率报告。
#其中,-o cover_report 表示生成的 HTML 文件的目标路径为 cover_report ,
#--legend 表示在生成的 HTML 文件中显示图例信息,
#--title "lcov" 表示设置生成的 HTML 文件的标题为 lcov ,
#--prefix=$src_dir 表示从覆盖率数据中去掉 $src_dir 前缀,以便更好地排版和可读性。
genhtml -o cover_report --legend --title "lcov" --prefix=$src_dir final.info --branch-coverage
注意:每个lcov
命令之后都要加--rc lcov_branch_coverage=1
表示开启分支覆盖率计算
在最后--branch-coverage
或者--rc genhtml_branch_coverage=1
表示最后的报告中显示分支覆盖率
执行
先cmake编译源码,再执行单元测试用例,最后chmod +x bash.sh
后执行此脚本
效果
终端:
html报告
分析
+代表该子分支被覆盖,-代表该子分支未覆盖,但对应的另一分支被覆盖,#代表两个子分支均未被覆盖。
只有当条件分支的结果对代码路径产生影响时,才有分支覆盖率