目的
a. 度量单元测试覆盖率;
b. 度量自动化测试(接口、UI)覆盖率;
c. 度量功能测试覆盖率;
代码覆盖率是衡量测试质量的一个重要指标。
Jacoco简介
JaCoCo是一个开源的覆盖率工具(官网地址:http://www.eclemma.org/JaCoCo/),它针对的开发语言是java,其使用方法很灵活。可以嵌入到Ant、Maven中;可以作为Eclipse插件。可以使用其JavaAgent技术监控Java程序等。
JaCoCo可以集成sonar、Jenkins等。
Jacoco安装
需要安装的工具与版本
➢ Jacoco官网下载地址 https://www.eclemma.org/jacoco/;
➢ Ant官网下载地址 https://ant.apache.org/bindownload.cgi;
注:Ant需要配置环境变量;
使用java agent方式启动项目
1) Spring Boot项目
nohup java -javaagent:/disk1/jacoco-0.8.3/lib/jacocoagent.jar=includes=*,output=tcpserver,port=9006,address=* -jar autoshell-0.0.1-SNAPSHOT.jar&
2) Tomcat部署项目
java -javaagent:/disk1/jacoco-0.8.3/lib/jacocoagent.jar=includes=*,output=tcpserver,port=9006,address=* -jar autoshell-0.0.1-SNAPSHOT.jar&
将以上内容放到tomcat>bin>catalina.bat(linux环境为catalina.sh),配置前需要停止服务。
➢ 以-javaagent开头的,注意这中间不能有空格,否则会启动失败,后面跟着的是jacoco的安装路径中的jacocoagent.jar包的路径,
➢ includes配置包含在执行分析中的类名列表,我分析全部,因此使用*通配符。可以只分析一个包下的代码,也可以使用excludes排除不想要的包。
➢ output指的是用于写入覆盖数据的输出方法,使用tcpserver代理侦听由address和port属性指定的TCP端口,并将执行的数据写入此TCP连接,从而实现不停止项目运行实时生成代码覆盖率报告。
➢ port为端口号,需要明确的一点就是这个端口号不是项目的yml配置文件中配置的server.port端口号,不要搞混淆了,选择一个未被占用的即可。address配置连接的ip地址,可以简单理解为之前安装ant的机器的ip地址。*号则表示此代理接受任何本地的连接,也就是说同一局域网下都可以。
➢ 其他属性配置请参照官方文档:https://www.eclemma.org/jacoco/trunk/doc/agent.html
注意:在tcpserver和 tcpclient模式下打开的端口和连接以及JMX接口不提供任何身份验证机制。如果在生产环境上运行jacoco,请确保没有不受信任的源可以访问TCP服务器端口,或者jacoco TCP客户端仅连接到受信任的目标。否则可能会泄露应用程序的内部信息或者可能发生DOS攻击。
上传源码到服务器
将源码与编译后的文件上传到项目服务器,若源码变更需要同步更新。
ant build.xml配置
覆盖度报告收集
1) 进入ant build.xml目录,执行ant dump
访问目标服务,并生成.exec文件;
2) 进入ant build.xml目录,执行ant report;
根据dump后,生成的.exec文件,生成最终的html覆盖率报告
3) 查看覆盖度报告
➢Elment对应jacocoant.xml文件中配置的group name属性,也就是我项目中的一个子项目,点进去可以看到所有的包,再点击包可以看到里面的类文件,点击类进入到方法列表,方法还可以点,点了会直接进入到代码当中,代码会有颜色并高亮显示,分支代码的左边还会有一颗带颜色的钻石
➢Jacoco包含了多种尺度的覆盖率计数器,包含指令级(Instructions,C0 coverage),分支(Branches,C1 coverage)、圈复杂度(CyclomaticComplexity)、行(Lines)、方法(Non-abstract
Methods)、类(Classes)。
➢1. Instructions
Jacoco计算的最小单位就是字节码指令。指令覆盖率表明了在所有的指令中,哪些被指令过以及哪些没有被执行。这项指数完全独立于源码格式并且在任何情况下有效,不需要类文件的调试信息。
➢2. Branches
Jacoco对所有的if和switch指令计算了分支覆盖率。这项指标会统计所有的分支数量,并同时支出哪些分支被执行,哪些分支没有被执行。这项指标也在任何情况都有效。异常处理不考虑在分支范围内。在有调试信息的情况下,分支点可以被映射到源码中的每一行,并且被高亮表示。
红色钻石:无覆盖,没有分支被执行。黄色钻石:部分覆盖,部分分支被执行。绿色钻石:全覆盖,所有分支被执行。
➢ Cyclomatic Complexity
Jacoco为每个非抽象方法计算圈复杂度,并也会计算每个类,包,组的复杂度。根据McCabe1996的定义,圈复杂度可以理解为覆盖所有的可能情况最少使用的测试用例数。这项参数也在任何情况下有效。
➢ Lines该项指数在有调试信息的情况下计算。因为每一行代码可能会产生若干条字节码指令,所以我们用三种不同状态表示行覆盖率
红色背景:无覆盖,该行的所有指令均无执行。黄色背景:部分覆盖,该行部分指令被执行。绿色背景:全覆盖,该行所有指令被执行。
➢Methods每一个非抽象方法都至少有一条指令。若一个方法至少被执行了一条指令,就认为它被执行过。因为JaCoco直接对字节码进行操作,所以有些方法没有在源码显示(比如某些构造方法和由编译器自动生成的方法)也会被计入在内。
➢Classes每个类中只要有一个方法被执行,这个类就被认定为被执行。同5一样,有些没有在源码声明的方法被执行,也认定该类被执行。
参考地址://www.greatytc.com/p/4c728b39185e