美文网首页
关于代码覆盖lcov的使用

关于代码覆盖lcov的使用

作者: 萧然AND沐橦 | 来源:发表于2019-03-24 23:34 被阅读0次

    以下分两部分,介绍gcov、lcov以及lcov的使用

    gcov、lcov

    gcov是一个测试代码覆盖率的程序,正确地使用它搭配GCC可以分析、帮助你将代码写得更高效。帮助你优化程序。类似于一个profiling tool,使用gcov或者gprof,可以收集到一些基础的性能统计数据。比如:

    1. 每一行代码执行的频度
    2. 每个代码文件中实际被执行到的行数
    3. 每一个代码块执行使用的时间
      gcov创建一个logfile叫做 源文件名称.gcxx (这里的源文件名称指的是.c或者.cc文件的文件名),表示的是这个 源文件.c 中每一行所被执行的次数。这些文件可以配合gprof使用。
      gcov要工作只能用gcc编译这些代码。和其他的profiling 或者 测试代码覆盖率的机制不兼容。

    fprofile-arcs参数使gcc创建一个程序的流图,之后找到适合图的生成树。只有不在生成树中的弧被操纵(instrumented):gcc添加了代码来清点这些弧执行的次数。当这段弧是一个块的唯一出口或入口时,操纵工具代码(instrumentation code)将会添加到块中,否则创建一个基础块来包含操纵工具代码。

    详情请参考这个链接:https://www.cnblogs.com/ChinaHook/p/5508660.html

    lcov 是GCC 测试覆盖率的前端图形展示工具。它通过收集多个源文件的 行、函数和分支的代码覆盖信息(程序执行之后生成gcda、gcno文件,上面的链接有讲) 并且将收集后的信息生成HTML页面。生成HTML需要使用genhtml命令下文会解释。

    lcov的使用

    首先,在代码编译和链接的时候,需要加上下面两个编译选项。在链接时需要加上gcov链接参数。

    -fprofile-arcs
    -ftest-coverage

    我们举一个简单的例子。
    在lcov目录(我们的这次测试使用的目录)下存在3个文件,a.cpp a.hpp testa.cpp
    a.ccp 文件

    int add (int a , int b ) {
        return a+b ;
    }
    
    int minus(int a , int b ) {
        return a-b ;
    }
    

    a.hpp文件

    int add (int a , int b ) ;
    int minus(int a , int b ) ;
    

    testa.cpp文件

    #include <iostream>
    
    #include "a.hpp"
    
    using namespace std ;
    
    int main() {
    
        cout << add(10,20) << endl ;
    
        return 0 ;
    }
    

    这里的a.cpp和a.hpp中定义了两个接口 add 和 minus(暂不考虑溢出问题)。我们在testa.cpp中调用add这个接口。我们的代码覆盖率应该是50%,因为总共两个接口,我们只使用(调用)了其中一个。

    推荐的使用流程如下(最后再详述lcov常用的参数的含义):
    我们使用lcov时需要在项目的根路径。

    # 来自 man lcov
    Recommended procedure when capturing data for a test case:
    
                  1. create baseline coverage data file
                         # lcov -c -i -d appdir -o app_base.info
    
                  2. perform test
                         # appdir/test
    
                  3. create test coverage data file
                         # lcov -c -d appdir -o app_test.info
    
                  4. combine baseline and test coverage data
                         # lcov -a app_base.info -a app_test.info -o app_total.info
    

    按照上述流程,我们使用自己的例子来执行

    • 编译程序
    g++ testa.cpp a.cpp -fprofile-arcs -ftest-coverage -lgcov -o test_cover
    

    这步可有可无,即归零所有执行过的产生覆盖率信息的统计文件:
    lcov -d ./ -z

    1. 初始化并创建基准数据文件
    # -c 捕获,-i初始化,-d应用目录,-o输出文件
    lcov -c -i -d ./ -o init.info
    
    1. 执行编译后的测试文件
    ./test_cover
    
    1. 收集测试文件运行后产生的覆盖率文件
    lcov -c -d ./ -o cover.info
    
    1. 合并基准数据和执行测试文件后生成的覆盖率数据
    # -a 合并文件
    lcov -a init.info -a cover.info -o total.info
    
    1. 过滤不需要关注的源文件路径和信息
    # --remove 删除统计信息中如下的代码或文件,支持正则
    lcov --remove total.info '*/usr/include/*' '*/usr/lib/*' '*/usr/lib64/*' '*/usr/local/include/*' '*/usr/local/lib/*' '*/usr/local/lib64/*' '*/third/*' 'testa.cpp' -o final.info
    
    • 通过final.info生成html文件
    #如果是git目录,可以获取此次版本的commitID,如果不是,忽略此步
    # commitId=$(git log | head -n1 | awk '{print $2}')
    # 这里可以带上项目名称和提交ID,如果没有,忽略此步
    #genhtml -o cover_report --legend --title "${project_name} commit SHA1:${commitId}" --prefix=${curr_path} final.info
    # -o 生成的html及相关文件的目录名称,--legend 简单的统计信息说明
    # --title 项目名称,--prefix 将要生成的html文件的路径 
    genhtml -o cover_report --legend --title "lcov"  --prefix=./ final.info
    

    我们看一下目前目录下都生成了哪些文件:

    目录下所有文件

    a.gcda、a.gcno、testa.gcda、testa.gcno就是运行可执行文件后gcov产生的统计信息文件。
    cover_report目录就是生成的html信息目录。

    这样,我们就可以通过firefox或者chrome打开cover_report/index.html来查看我们的代码覆盖率。截图如下:

    页面信息

    左侧的路径可以点开,详细看每个文件哪些行被覆盖到了,没有覆盖到。这里就不赘述了,各位看官老爷亲自尝试以下吧。

    ** 注:如果使用CMake编译和构建的话,可以在指定路径的时候,统一使用项目的编译构建路径,即项目下源文件下创建的build目录作为路径,(运行lcov在项目的根路径)举例如下:

    lcov -c -i -d ./build -o init.info
    lcov -c -d ./build -o cover.info
    等等... ... 
    
    • lcov常用的参数
    1. -d 项目路径,即.gcda .gcno所在的路径
    2. -a 合并(归并)多个lcov生成的info文件
    3. -c 捕获,也即收集代码运行后所产生的统计计数信息
    4. --external 捕获其它目录产生的统计计数文件
    5. -i/--initial 初始化所有的覆盖率信息,作为基准数据
    6. -o 生成处理后的文件
    7. -r/--remove 移除不需要关注的覆盖率信息文件
    8. -z 重置所有执行程序所产生的统计信息为0

    参考链接
    https://www.cnblogs.com/ChinaHook/p/5508660.html

    如果有帮助到各位看官,打赏一下小弟吧,你的打赏是我继续写下去的动力喵 ~ :)

    相关文章

      网友评论

          本文标题:关于代码覆盖lcov的使用

          本文链接:https://www.haomeiwen.com/subject/zkkkcqtx.html