使用OpenCppCoverage统计代码覆盖率

1. 简介

• OpenCppCoverage 是一款专为Windows平台设计的开源C++代码覆盖率统计工具。

2. 安装

• 安装包
• 下载exe安装包直接双击运行安装

3. 命令行参数介绍

• 完整命令行参数可参考OpenCppCoverage 命令行参数
• 本文章只介绍常用参数
• –sources arg
  • 指定要收集代码覆盖率的源代码文件或目录

  •   OpenCppCoverage.exe --sources="YourSourcesPath" -- "YourExePath\res.exe"
    

• –excluded_sources arg
  • 排除不需要收集代码覆盖率的源代码文件或目录，这对于使用第三方库的场景非常有用。

  •   OpenCppCoverage.exe --sources="YourSourcesPath" --excluded_sources="excludeSourcesPath" -- "YourExePath\res.exe"
    

• –export_type arg
  • 指定生成覆盖率报告的格式类型。常用的有以下两种
  • 生成html(默认就是此类型、可不指定)

  •   OpenCppCoverage.exe --sources="YourSourcesPath" --export_type=html -- "YourExePath\res.exe"
    

  • 生成*.cov类型的二进制文件(配合input_coverage命令使用)

  •   OpenCppCoverage.exe --sources="YourSourcesPath" --export_type=binary:res1.cov -- "YourExePath\res.exe"
    

  • 生成html文件时，会生成一个CoverageReport-YYYY-MM-DD-HHhMMmSSs格式的默认目录，可以通过此参数设置目录名

  •   OpenCppCoverage.exe --sources="YourSourcesPath" --export_type=html:YourObjfilePath -- "YourExePath\res.exe"
    

• –input_coverage arg
  • 此功能在想要累计多次运行或不同场景下的覆盖率数据时非常有用，可以获得更全面的代码覆盖率分析结果。
  • 一个很常用的场景是, 启动可执行程序时，传入参数argA则走A分支，传入参数argB则走B分支。如果想同时统计A和B分支的代码覆盖率，就可以使用此参数。
  • 统计A分支的代码覆盖率，生成*.cov文件。

  •   OpenCppCoverage.exe --sources="YourSourcesPath" --export_type=binary:res1.cov -- "YourExePath\res.exe" argA
    

  • 导入A分支的代码覆盖率文件*.cov，共同生成包含A和B分支的代码覆盖率文件html。

  •   OpenCppCoverage.exe --sources="YourSourcesPath" --input_coverage=res1.cov -- "YourExePath\res.exe" argB
    

• –working_dir arg
  • 指定程序运行时的工作目录, 确保程序能够找到其所需的资源文件，如配置文件、数据文件等。

4. 示例

• OpenCppCoverage安装目录在 “D:\Program Files (x86)\OpenCppCoverage” 下
• 测试程序源代码在 “D:\Program Files (x86)\OpenCppCoverageTest\src” 目录下
• 可执行程序在 “D:\Program Files (x86)\OpenCppCoverageTest\bin\Release” 目录下

4.1 基础使用

• 准备源文件main.cpp

  •   #include <stdio.h>
    
      void func1(){
          printf("start func1.\n");
          int sum = 1 + 1;
          printf("end func1.\n");
      }
    
      void func2(){
          printf("start func2.\n");
          int sum = 2 + 2;
          printf("end func2.\n");
      }
    
      void func3(){
          printf("start func3.\n");
          int sum = 3 + 3;
          printf("end func3.\n");
      }
    
    
      int main(){
          printf("hello world\n");
          func2();
          return 0;
      }
    

• 生成可执行程序

• 在OpenCppCoverage安装目录执行以下命令

  •   OpenCppCoverage.exe --sources="D:\Program Files (x86)\OpenCppCoverageTest\src" -- "D:\Program Files (x86)\OpenCppCoverageTest\bin\Release\test_c.exe"
    

• 执行完成会在当前目录下生成一个 CoverageReport-YYYY-MM-DD-HHhMMmSSs 格式的目录，此目录下有一个index.html文件, 用浏览器打开就可以查看代码执行情况。

• 可以看到此次测试，代码覆盖率为50%。

  • 

• 点击进去可以看到具体的代码执行情况

  • 
  • 
  • 

• main()函数和func2()函数被执行，func1()和func2()函数未被执行。

• 这里需要注意下，生成的可执行程序时，必须同时生成pdb文件。

4.2 移除不需要统计的文件

• 有的时候我们的工程会使用到第三方库，但进行代码覆盖率统计时并不需要统计第三方库，可以通过 --excluded_sources 移除不需要统计的文件。

• 使用mymath模拟第三方库

• mymath.h

  •   #ifndef __MY_MATH_H__
      #define __MY_MATH_H__
    
      int myAddfunc(int data1, int data2);
    
      int myMinusFunc(int data1, int data2);
    
      void myPrint();
    
      #endif
    

• mymath.cpp

  •   #include "mymath.h"
      #include <stdio.h>
    
      int myAddfunc(int data1, int data2){
          return data1 + data2;
      }
    
      int myMinusFunc(int data1, int data2){
          return data1 - data2;
      }
    
      void myPrint(){
          printf("this is myPrint func\n");
      }
    

• main.cpp 作如下修改

  •   #include <stdio.h>
      #include "mymath.h"
    
      void func1(){
          printf("start func1.\n");
          int sum = 1 + 1;
          printf("end func1.\n");
      }
    
      void func2(){
          printf("start func2.\n");
          int sum = 2 + 2;
          printf("end func2.\n");
      }
    
      void func3(){
          printf("start func3.\n");
          int sum = 3 + 3;
          printf("end func3.\n");
      }
    
    
      int main(){
          printf("hello world\n");
          func2();
    
          myAddfunc(1, 2);
    
          return 0;
      }
    

• 重新编译生成可执行程序

• 执行以下命令，先整体统计

  •   OpenCppCoverage.exe --sources="D:\Program Files (x86)\OpenCppCoverageTest\src" -- "D:\Program Files (x86)\OpenCppCoverageTest\bin\Release\test_c.exe"
    

• 可以看到，对mymath.cpp也进行了统计，整体代码覆盖率 46%

  • 

• 再去掉mymath，重新统计

  •   OpenCppCoverage.exe --sources="D:\Program Files (x86)\OpenCppCoverageTest\src" --excluded_sources="D:\Program Files (x86)\OpenCppCoverageTest\src\mymath.cpp"  -- "D:\Program Files (x86)\OpenCppCoverageTest\bin\Release\test_c.exe"
    

• 这样就只统计了main.cpp的代码覆盖率，为52%

  • 

4.3 统计不同分支的代码覆盖率

• 这里通过传入不同参数，实现每次执行走不同分支。

• main.cpp 如下

  •   #include <stdio.h>
      #include <string.h>
    
      int main(int argc, char** argv){
          if(argc != 2){
              printf("param error.\n");
              return -1;
          }
          int sum = 0;
    
          if(strcmp(argv[1], "argA") == 0){
              printf("start argA\n");
    
              sum ++;
    
              printf("end argA\n");
          }else if(strcmp(argv[1], "argB") == 0){
              printf("start argB\n");
    
              sum--;
    
              printf("enc argB\n");
          }else{
              printf("unkonw param\n");
          }
    
          printf("sum: %d\n", sum);
    
          return 0;
      }
    

• 先走argA分支, 这一步先生成一个二进制文件 argA.cov

  •   OpenCppCoverage.exe --sources="D:\Program Files (x86)\OpenCppCoverageTest\src" --export_type=binary:argA.cov -- "D:\Program Files (x86)\OpenCppCoverageTest\bin\Release\test_c.exe" argA
    

• 再走argB分支，同时将argA分支生成的二进制文件包含进来, 这样就可以同时统计到不同分支的代码执行情况。

  •   OpenCppCoverage.exe --sources="D:\Program Files (x86)\OpenCppCoverageTest\src" --input_coverage=argA.cov -- "D:\Program Files (x86)\OpenCppCoverageTest\bin\Release\test_c.exe" argB
    

• 看下效果

  • 

  • 

• 分支A和B的覆盖率都被统计到了。

5. 参考

• OpenCppCoverage wiki
• OpenCppCoverage Command-line-reference wiki