Jacoco远程统计代码覆盖率

Jacoco

 

什么是Jacoco？

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

 

Jacoco远程统计tomcat服务的代码覆盖率

 

软件安装

Ant

Jacoco

 

Ant 安装步骤

由于服务器上已经安装了Ant，所以没有亲自安装过在Linux服务器上，百度上有好多文章，可以搜一下，下面就给出一个参考链接

http://hanqunfeng.iteye.com/blog/668133

 

Jacoco安装步骤

下载下来，随意放在一个目录，解压

在官网上下载Jacoco，官网地址：http://eclemma.org/jacoco/

wget https://oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=org.jacoco&a=jacoco&e=zip&v=LATEST

unzip jacoco-0.7.6-20151002.081900-29.zip

 

Tomcat配置

1、进入你需要统计代码覆盖率的tomcat  

cd /home/work/tomcat_8998_launch_feed_1/bin

2、先关闭这个tomcat的服务

正常情况下可以直接执行  ./shutdown.sh

执行结束后 ps -ef|grep 端口号 查看是否已经正常关闭，如果还没有关闭 kill -9 pid(来源于ps的结果)

3、修改 catalina.sh  的JAVA_OPTS配置

JAVA_OPTS="$JAVA_OPTS -javaagent:/home/work/zj/jacoco/lib/jacocoagent.jar=includes=*,output=file,append=true,destfile=/home/work/zj/jacoco/target/jacoco.exec"

具体参数的意思请查看官方文档

4、启动服务 ./startup.sh

5、查看一下JAVA_OPTS是否有修改正确，我掉在这个坑里了，有一种情况是你把JAVA_OPTS写在前面，在后面被别人的覆盖了

ps -ef|grep 端口号 看出来的结果有没有刚才你修改的值

 

 

Ant配置

随意进入一个目录新建build.xml,build.xml见附件

 <?xml version="1.0" ?>
 <project name="coverage" xmlns:jacoco="antlib:org.jacoco.ant" >
     <!--Jacoco的安装路径-->
   <property name="jacocoantPath" value="/home/work/zj/jacoco/lib/jacocoant.jar"/>
   <!--最终生成.exec文件的路径，Jacoco就是根据这个文件生成最终的报告的-->
   <property name="jacocoexecPath" value="/home/work/zj/jacoco/target/jacoco.exec"/>
     <!--生成覆盖率报告的路径-->
   <property name="reportfolderPath" value="/home/work/zj/jacoco/report/"/>
   <!--远程tomcat服务的ip地址-->
   <property name="server_ip" value="10.99.30.64"/>
   <!--前面配置的远程tomcat服务打开的端口，要跟上面配置的一样-->
   <property name="server_port" value="8998"/>
   <!--源代码路径可以包含多个源代码-->
   <property name="webSrcpath" value="/home/work/zj/adp-feed-access-web/src/main/java/" />
   <property name="businessSrcpath" value="/home/work/zj/adp-feed-access-business-delivery/src/main/java/"/>
   <property name="commonSrcpath" value="/home/work/zj/adp-feed-access-business-common/src/main/java/"/>
   <property name="uasSrcpath" value="/home/work/zj/uas-pbrpc4j/src/main/java/"/>
   <!--.class文件路径可以包含多个-->
   <property name="webClasspath" value="/home/work/local/adp_launch_feed_1/ROOT/WEB-INF/classes/"/>
   <property name="businessClasspath" value="/home/work/local/adp_launch_feed_1/ROOT/WEB-INF/lib/adp-feed-access-business-delivery/"/>
   <property name="commonClasspath" value="/home/work/local/adp_launch_feed_1/ROOT/WEB-INF/lib/adp-feed-access-business-common/"/>
   <property name="uasClasspath" value="/home/work/local/adp_launch_feed_1/ROOT/WEB-INF/lib/uas-pbrpc4j/"/>

   <!--让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="Launch related">
                   <classfiles>
                       <fileset dir="${webClasspath}" />
                   </classfiles>
                   <sourcefiles encoding="gbk">
                       <fileset dir="${webSrcpath}" />
                   </sourcefiles>
               </group>
               <group name="Business related">
                   <classfiles>
                       <fileset dir="${businessClasspath}" />
                   </classfiles>
                   <sourcefiles encoding="gbk">
                       <fileset dir="${businessSrcpath}" />
                   </sourcefiles>
               </group>
               <group name="Common related">
                   <classfiles>
                       <fileset dir="${commonClasspath}" />
                   </classfiles>
                   <sourcefiles encoding="gbk">
                       <fileset dir="${commonSrcpath}" />
                   </sourcefiles>
               </group>
           </structure>

           <html destdir="${reportfolderPath}" encoding="utf-8" />
       </jacoco:report>
   </target>
 </project>

需要注意的点：

1、需要上传源代码到服务器 

2、如果你的web工程里面还引入了别的工程，例如你现在tomcat所部署的war包只是web的入口，实际的逻辑，模型等都作为jar包放在这个工程的lib里面的时候，

此时你又要统计这些逻辑模型的代码覆盖率，那么你需要做的是：1、把lib中你需要统计覆盖率的jar包解压出来；2、把jar包对应的源代码上传上去；3、build.xml中

structure下面建立多个group，对应的源文件和类文件也要新增进去；

 

 

覆盖率报告

1、由于我使用的是file的方式，因此需要获得覆盖率的话，需要shutdown tomcat，执行./shutdown.sh ，如果不行的话，执行kill但是千万不能执行kill -9

执行完kill后，会把覆盖率dump到jacoco.exec

2、在build.xml所在的目录执行ant report将会把报告输出到相应的目录下面

3、在报告所在的目录直接打开index.html将会看到所有的覆盖率，如果想在线查看report的话，可以在nginx或者tomcat下搭建

 

 

参考文档

http://www.ibm.com/developerworks/cn/java/j-lo-jacoco/

http://wiki.baidu.com/pages/viewpage.action?pageId=120894834

http://www.51testing.com/html/50/253150-848196.html

http://my.oschina.net/91jason/blog/491171

http://wiki.baidu.com/pages/viewpage.action?pageId=120657837

sonar的安装

http://blog.csdn.net/wuxuguang123/article/details/39005103