Java|Jacoco覆盖率工具使用调研


JaCoCo Java Code Coverage Library Jacoco是一个开源的覆盖率工具。Jacoco可以嵌入到Ant 、Maven中,并提供了EclEmma Eclipse插件,也可以使用Java Agent技术监控Java程序。很多第三方的工具提供了对Jacoco的集成,如sonar、Jenkins、IDEA.

官方地址 http://www.eclemma.org/jacoco/

Java Counters Jacoco包含了多种尺度的覆盖率计数器,包含指令级(Instructions,C0 coverage),分支(Branches,C1 coverage)、圈复杂度(Cyclomatic Complexity)、行(Lines)、方法(non-abstract methods)、类(classes)。
Java|Jacoco覆盖率工具使用调研
文章图片

Java|Jacoco覆盖率工具使用调研
文章图片


如下所示,标示绿色的为分支覆盖充分,标黄色的为部分分支覆盖,标红色的为未执行该分支。
Java|Jacoco覆盖率工具使用调研
文章图片


Java|Jacoco覆盖率工具使用调研
文章图片

Integration Jacoco团队提供了如下的一些集成工具的支持

Java API
Command Line
Apache Ant
Apache Maven
Eclipse EclDmma Plugin


jacoco-maven-plugin

Jacoco总体上提供了比较完整的文档,但是Maven项目如果需要支持Jacoco,配置起来比较复杂,不如Cobertura方便。为了能够跑通该插件,调研了很多文章,其中‘Creating Code Coverage Reports for Unit And Integration Tests with The JaCoCo Maven Plugin’帮助最大。

具体的maven配置如下,执行mvn test即可得到。


org.jacoco jacoco-maven-plugin 0.6.4.201312101107 default-prepare-agent prepare-agent ${project.build.directory}/coverage-reports/jacoco.exec surefireArgLine default-reporttest report ${project.build.directory}/coverage-reports/jacoco.exec ${project.reporting.outputDirectory}/jacoco org.apache.maven.plugins maven-surefire-plugin 2.16 ${surefireArgLine}




动态监测Web项目的覆盖率 Jacoco使用Java Agent 动态插桩,来监控文件执行的覆盖率数据。Jacoco 代理可以收集执行信息,并且当JVM退出时dump,输出数据的方式有3种:


  • 1,文件,当JVM退出时将执行数据写到本地
  • 2,TCP Socket Server,以外部工具的形式连接JVM,通过socket获取执行数据。
  • 3,TCP Sockect Client,程序启动时Agent连接到TCP端点,通过request将执行数据输出。

Java Agent 可以通过如下的JVM参数来启动:
-javaagent:[yourpath/]jacocoagent.jar=[opt1]=[val1],[opt2]=[val2]


shutdown jvm时获取dump数据

Jacoco插件通过agent获取覆盖率信息文件,为了保证插件可以连接到Jacoco agent,我们必须正确配置Jacoco agent和应用一起首先运行起来。
在shutdown时,获取dump数据,在tomcat的catalina.sh中JAVA_OPTS中增加如下参数

-javaagent:[yourpath/]jacocoagent.jar=includes=com.xxx.*,output=xxx


其中,output=file/tcpserver/tcpclient:
覆盖率数据输出的形式,分别为file,tcpserver,tcpclient.
对应的Jenkins插件见https://wiki.jenkins-ci.org/display/JENKINS/JaCoCo+Plugin
以客户端形式运行
在tomcat的catalina.sh中JAVA_OPTS中增加如下参数
-javaagent:[yourpath/]jacocoagent.jar=includes=com.baidu.*, output=tcpserver,port=6300,address= 220.181.111.148


这样会在220.181.111.148地址的6300端口上提供client访问,并且能dump出此时的覆盖率文件。
使用这种方式,不需要停止jvm,只需要请求测试环境提供的端口地址即可。
这种调用方式,在Jacoco的网站上提供了生成报告等的API。


【Java|Jacoco覆盖率工具使用调研】具体请查看: http://blog.csdn.net/kittyboy0001/article/details/26400091










    推荐阅读