Jacoco Code Coverage

发表于:2018-5-04 15:57  作者:纳爱斯   来源:51Testing软件测试网采编

字体: | 上一篇 | 下一篇 |我要投稿 | 推荐标签: 软件测试工具 覆盖率测试

  近期因工作需要,需对代码覆盖率进行统计,所以这篇就当做对这段时间学习的总结。
  总得来说网上找到的资料都不系统,不适合新手理解和参考,下面我就以我一个小白的亲身体验,将我
  踩到的那些坑和遇到的那些疑惑记录下来
  (作为一名初学者,文章中可能会有错误或者理解偏差的地方,欢迎各位批评指正)
      市场上主要代码覆盖率工具:
          Emma
          Cobertura
          Jacoco
          Clover(商用)
  具体见下表:
     JaCoCo Java Code Coverage Library
  Jacoco 是一个开源的覆盖率工具。Jacoco 可以嵌入到 Ant 、Maven 中,并提供了 EclEmma Eclipse 插件,也可以使用 Java Agent 技术监控 Java 程序。很多第三方的工具提供了对 Jacoco 的集成,如:Sonar、Jenkins、IDEA.
     Java Counters
  Jacoco 包含了多种尺度的覆盖率计数器,包含指令级(Instructions,C0 coverage),分支(Branches,C1 coverage)、圈复杂度(Cyclomatic Complexity)、行(Lines)、方法(Non-abstract Methods)、类(Classes)。
  Instructions:Jacoco 计算的最小单位就是字节码指令。指令覆盖率表明了在所有的指令中,哪些被执行过以及哪些没有被执行。这项指数完全独立于源码格式并且在任何情况下有效,不需要类文件的调试信息。
  Branches:Jacoco 对所有的 if 和 switch 指令计算了分支覆盖率。这项指标会统计所有的分支数量,并同时支出哪些分支被执行,哪些分支没有被执行。这项指标也在任何情况都有效。异常处理不考虑在分支范围内。
        在有调试信息的情况下,分支点可以被映射到源码中的每一行,并且被高亮表示。
        红色钻石:无覆盖,没有分支被执行。
        黄色钻石:部分覆盖,部分分支被执行。
        绿色钻石:全覆盖,所有分支被执行。
  Cyclomatic Complexity:Jacoco 为每个非抽象方法计算圈复杂度,并也会计算每个类、包、组的复杂度。根据 McCabe 1996 的定义,圈复杂度可以理解为覆盖所有的可能情况最少使用的测试用例数。这项参数也在任何情况下有效。
  Lines:该项指数在有调试信息的情况下计算。
        因为每一行代码可能会产生若干条字节码指令,所以我们用三种不同状态表示行覆盖率
        红色背景:无覆盖,该行的所有指令均无执行。
        黄色背景:部分覆盖,该行部分指令被执行。
        绿色背景:全覆盖,该行所有指令被执行。
  Methods:每一个非抽象方法都至少有一条指令。若一个方法至少被执行了一条指令,就认为它被执行过。因为 Jacoco 直接对字节码进行操作,所以有些方法没有在源码显示(比如某些构造方法和由编译器自动生成的方法)也会被计入在内。
  Classes:每个类中只要有一个方法被执行,这个类就被认定为被执行。同 5 一样,有些没有在源码声明的方法被执行,也认定该类被执行。
      Jacoco 原理
  参考链接:
  好了,废话不多说,咱们直奔主题,大家只要按照操作步骤执行就可以
     Jacoco 收集集成测试代码覆盖率
  什么是集成测试?
      准备工作
          下载 jacoco.zip 包
      第一步:将下载下来的 zip 包与 Tomcat 服务放在一台机器上
      第二步:在 [yourTomcatPath]/bin/catalina.sh 添加 Jacoco 插件,指令如下??
       JAVA_OPTS="-javaagent:[yourPath/]jacocoagent.jar=includes=com.companyName.*,output=tcpserver,port=8044,address=100.44.44.144 -Xverify:none"
      Tip:添加插件之前,须将的 Tomcat 服务停掉之后再添加,添加完之后,再启动 Tomcat 服务
      参数说明:
         1. yourPath 是放 jacocoagent.jar 文件的目录路径;那么 `jacocoagent.jar` 这个 `jar` 包的路径就是在准备工作里下载下来的 `zip` 包,解压之后的 `lib` 目录下,如:'/jacoco-0.7.9/lib/jacocoagent.jar'
         2. includes 是指要收集哪些类(注意不要光写包名,最后要写.*),不写的话默认是*,会收集应用服务上所有的类,包括服务器和其他中间件的类,一般要过滤(当然如果你愿意写*也完全没有问题,如:`includes=com.*` or `includes=*`);
         3. output 有 4 个值,分别是 file、tcpserver、tcpclient、mbean,默认是 file。使用 file 的方式只有在停掉应用服务的时候才能产生覆盖率文件,而使用 tcpserver 的方式可以在不停止应用服务的情况下下载覆盖率文件,后面会介绍如何使用 dump 方法来得到覆盖率文件。
         4. address 是 IP 地址,IP 就是 Tomcat 服务器的机器的 IP,至于是写 `服务器本机的 IP` 还是写 `127.0.0.1` 要看情况
             1) 如果是在 Tomcat 服务器上执行 `ant dump` 的话,就直接写 `address=127.0.0.1`
             2) 如果执行 `ant dump` 不是在 Tomcat 服务器上执行的,就得写服务器本机的IP(切记)
         5. port 是端口(端口比较随便,找个能用的端口就行,直接我为什么将端口写成 `8044`,我的想法是 `BUG 死死` 与 `8044` 挺配的,所以就用它作为端口号了)
      (`address` 和 `port` 是使用 tcpserver 方式需要的 2 个参数,也是执行 ant dump 方法必须要用到的。)
         6. `-Xverify:none`:这个参数是防止启动主程序异常才加的(非强制,可以不加)
  启动 Tomcat 服务之后,ps 一下,如果在 Tomcat 服务中有 jacocoagent 这个服务的话
  那么恭喜你,你成功了!!!
      第三步:获取报告 ant dump(也是就上文中提到的,特别提醒:这里使用 ant 命令,和你的代码工程使用什么编译工具编译的没有一点关系,不要混淆)
      build.xml 文件内容如下
  <?xml version="1.0" ?>
  <project name="Jacoco" xmlns:jacoco="antlib:org.jacoco.ant" default="jacoco">   
      <property name="jacocoantPath" value="[yourPath/]jacocoant.jar"/>
      <property name="integrationJacocoexecPath" value="./jacoco-integration.exec"/>
      
      <taskdef uri="antlib:org.jacoco.ant" resource="org/jacoco/ant/antlib.xml">
        <classpath path="${jacocoantPath}" />
      </taskdef>
      
      <target name="dump">
          <jacoco:dump address="100.44.44.144" port="8044" reset="true" destfile="${integrationJacocoexecPath}" append="false"/>
      </target>
  </project>

  `.exec`:二进制文件,Jacoco 就是根据这个文件生成最终的报告
  `destfile`:是指生成的覆盖率文件路径
  Tip:
  build.xml 只需修改三个点,就可以直接拿去用
  第一个修改点:补全 `jacocoant.jar` 路径。(那么 `jacocoant.jar` 在哪?对于这个问题,或许会有疑问,当然,如果细心的小伙伴就会很轻易的发现 `jacocoant.jar` 的位置,其实也就在准备工作中所下载的 `zip` 包里面,与 `jacocoagent.jar` 在同级目录 `lib` 文件夹下)
  第二个修改点:修改 IP 地址(IP 须与 `catalina.sh` 中添加的一致)
  第三个修改点:修改端口号(与IP一样,端口号须与 `catalina.sh` 中添加的一致)
  Frequently Asked Questions:
  虽然得到了集成测试的覆盖率文件,但是需要应用服务器上的类文件才能产出相应的覆盖率报告,如果类文件是其他 JVM 编译的,产出的报告覆盖率是 0%。
  有 2 种方法可以得到覆盖率文件所需的 class 文件:
  1. 将应用服务部署的包(ear 或 war 或 jar)包下载下来之后解压,即可得到对应的 class 文件;
  2. 在前面做单元测试之后,可以将 class 文件打成一个 zip 包,然后上传到服务器,最后在需要的时候去服务器上取。
  修改好了,那么我们来测试一下,终端进入 build.xml 所在的目录,执行:ant dump 或者 ant dump -buildfile [yourPath/]build.xml
  ant dump
  成功之后,接下来就是 Jenkins 集成 jacoco 实现代码覆盖率,详见:Jenkins + Jacoco持续集成代码覆盖率
  是不是只有上面的这一种方式呢?当然不是!
  第二种方式(不推荐):
  JAVA_OPTS="-javaagent:[yourPath/]jacocoagent.jar=destfile=[storagePath/]jacoco.exec
  同样是加载 cataline.sh 文件中,除了获取报告的方式上面的不一样之前,其余步骤都一样
  获取报告:
  功能测试或者接口自动化后,需要获取报告的话,需关闭 Tomcat 获取结果文件 `jacoco.exec`,使用 kill [PID],之后到你保存的路径下就能看到 `jacoco.exec` 文件(切记不要使用 kill -9 [PID],否则不能生成结果)
  不推荐这种方式的理由:如果使用这种方式的话,不好做持续集成,因为 jenkins 服务器基本上都是和部署代码的服务器分开的,所以要从远程服务器取结果的话还是选择上面的方式
  Q:那现在可能又有同学会问,这个报告只能在 `Jenkins` 上面生成吗?
  A:当然也可以在本地生成了,附上代码,如下
  <?xml version="1.0" ?>
  <project name="Jacoco" xmlns:jacoco="antlib:org.jacoco.ant" default="jacoco">
      <!--Jacoco 的安装路径-->
    <property name="jacocoantPath" value="[yourPath/]jacocoant.jar"/>
    <!--最终生成 .exec 文件的路径,Jacoco 就是根据这个文件生成最终的报告的-->
    <property name="jacocoexecPath" value="[yourPath/]jacoco.exec"/>
      <!--生成覆盖率报告的路径-->
    <property name="reportfolderPath" value="[storageReportPath]"/>
    <!--远程 Tomcat 服务的 ip 地址-->
    <property name="server_ip" value="100.44.44.144"/>
    <!--前面配置的远程 Tomcat 服务打开的端口,要跟上面配置的一样-->
    <property name="server_port" value="8044"/>
    <!--源代码路径-->
    <property name="checkOrderSrcPath" value="[srcPath]" />
    <!--.class 文件路径-->
    <property name="checkOrderClasspath" value="[classPath]" />
    <!--让 ant 知道去哪儿找 Jacoco-->
    <taskdef uri="antlib:org.jacoco.ant" resource="org/jacoco/ant/antlib.xml">
        <classpath path="${jacocoantPath}" />
    </taskdef>
    <!--dump 任务:
        根据前面配置的 ip 地址,和端口号,
        访问目标 Tomcat 服务,并生成 .exec 文件。-->
    <target name="dump">
        <jacoco:dump address="${server_ip}" reset="false" destfile="${jacocoexecPath}" port="${server_port}" append="true"/>
    </target>
    
    <!--jacoco 任务:
        根据前面配置的源代码路径和 .class 文件路径,
        根据 dump 后,生成的 .exec 文件,生成最终的 html 覆盖率报告。-->
    <target name="report">
        <delete dir="${reportfolderPath}" />
        <mkdir dir="${reportfolderPath}" />
        
        <jacoco:report>
            <executiondata>
                <file file="${jacocoexecPath}" />
            </executiondata>
                
            <structure name="JaCoCo Report">
                <group name="Check Order related">           
                    <classfiles>
                        <fileset dir="${checkOrderClasspath}" />
                    </classfiles>
                    <sourcefiles encoding="gbk">
                        <fileset dir="${checkOrderSrcPath}" />
                    </sourcefiles>
                </group>
            </structure>
            <html destdir="${reportfolderPath}" encoding="utf-8" />         
        </jacoco:report>
    </target>
  </project>


上文内容不用于商业目的,如涉及知识产权问题,请权利人联系博为峰小编(021-64471599-8017),我们将立即处理。

21/212>

评 论

论坛新帖

顶部 底部


建议使用IE 6.0以上浏览器,800×600以上分辨率,法律顾问:上海信义律师事务所 项棋律师
版权所有 上海博为峰软件技术股份有限公司 Copyright©51testing.com 2003-2021, 沪ICP备05003035号
投诉及意见反馈:webmaster@51testing.com; 业务联系:service@51testing.com 021-64471599-8017

沪公网安备 31010102002173号

51Testing官方微信

51Testing官方微博

扫一扫 测试知识全知道