Code_coverage

使用 lcov 和 gcovr 为项目生成代码覆盖率

0.概览以及准备工作

(1)概览

主要流程就是在编译时添加相应指令，编译时产生相关文件。然后运行代码产生运行时文件。然后将产生的文件信息进行收集，最后对收集的信息进行可视化的展现（产生html文件以便查看）。

(2)准备工作

在ubuntu20.04上进行实践

安装相应的软件

sudo apt-get update
# 安装 lcov
sudo apt-get install lcov
# 安装 gcovr
sudo apt-get install gcovr

1.在CMakeList.txt添加相应的指令，构建生成 .gcno 文件

SET(CMAKE_CXX_FLAGS "-g -O0 -fprofile-arcs -ftest-coverage")
SET(CMAKE_C_FLAGS "-g -O0 -fprofile-arcs -ftest-coverage")

or

SET(CMAKE_CXX_FLAGS "-fprofile-arcs -ftest-coverage")
SET(CMAKE_C_FLAGS "-fprofile-arcs -ftest-coverage")

该指令会在编译时为每个文件生成 .gcno 文件

例如对于项目she_base64来说

$ cd she_base64
$ mkdir build
$ cd build
$ cmake ..
$ make -j8

在进行构建后，会出现以下文件

build/CMakeFiles/she_base64_test.dir/src/she_base64.cpp.gcno

2.运行程序生成 .gcda 文件

将编译的程序进行运行后，会为每个文件生成相应的 .gcda 文件

例如在1.在CMakeList.txt添加相应的指令后，运行构建的测试程序，会生成以下文件

build/CMakeFiles/she_base64_test.dir/src/she_base64.cpp.gcda

3.收集代码覆盖率信息

在通过1.在CMakeList.txt添加相应的指令，构建生成 .gcno 文件以及2.运行程序 .gcda 文件以后，通过 lcov来收集相关的代码覆盖率信息，并且产生响应的 .info 文件

lcov --directory . \
     --capture \
     --output-file ./coverage/coverage.info \
     --rc lcov_branch_coverage=1

--directory用于在指定目录下搜集 .gcno 以及 .gcda 文件，该命令会递归遍历指定目录下的所有文件

--capture用于执行代码覆盖率测试，并将测试结果保存到 .info 文件中

--output-file用于指定 .info 文件的目录

--rc lcov_branch_coverage=1 启用分支覆盖率

忽略相关目录代码信息

在指定 .info 文件中忽略相关代码

lcov --remove ./coverage/coverage.info \
     '/usr/*' \
     '*/googletest/*' \
     --output-file ./coverage/coverage.info

ps:若没有排除成功可能是因为路径问题， 可以使用类似 */third_party/*的方法来排除

交叉编译平台问题

问题一：对于交叉编译的平台问题，例如在 x86 平台上交叉编译 arm 的程序，在 x86 上编译结束，并且在 arm 上运行结束。相应的文件已经生成，在 x86 下使用 lcov 的时候，需要通过--gcov-tool指定交叉编译链中携带的 gcov 工具，否则无法正确生成相应的 .info 文件（猜测可能是不同平台下生成的文件格式不同）。

lcov --directory . \
     --capture \
     --output-file ./coverage/coverage.info \
     --gcov-tool /cross_compilation_toolchain/arm-oe-linux-gcov

问题二：在进行交叉编译时，可能需要将 x86 平台下的编译目录与 arm 上的运行目录进行特殊处理。

因为在编译时，其实已经指定了 .gcno 的产生路径 A_x86 ，并且 .gcda 的路径也会在 A_x86 下。这样就会导致在交叉编译后，放在 arm 上运行的时候，此时在 arm 的环境中， .gcda文件会想要在路径 A_x86 下去生成。可能就会因为目录权限问题导致 .gcda 文件无法生成。并且最后需要把 .gcno 和 .gcda 文件放在一起（可以详见1.和2.中的示例文件目录）， lcov 才能正确生成 .info 文件。

4.生成可视化代码覆盖率 html 文件

通过以下命令对 .info 文件进行处理，在相应目录下产生 html 文件

genhtml ./coverage/coverage.info \
        -o ./coverage/coverage_report \
        --branch-coverage

ps: --branch-coverage产生分支覆盖率，若lcov未启用分支覆盖率，genhtml 将无法生成对应的分支覆盖率

现在可以在./coverage/coverage_report目录下找到 index.html 文件了，打开就可以看到代码覆盖率的相关信息了。

5.关于分支覆盖率

对于函数

// 该函数用来计算人体健康的分数
// 身高高于170加十分
// 体重大于50加十分
int fun(int height, int weight) {
    int ret = 0;
    if (height > 170) {
        ret += 10;
    }
    if (weight > 50) {
        ret += 10;
    }
    return ret;
}

若有测试用例

void test() {
    fun(190,80);
}

运行后分支覆盖率为 50%

若添加测试用例

void test() {
    fun(190,80);
    fun(150,30);
}

运行后分支覆盖率为 100%