Jacoco遠程統計代碼覆蓋率


Jacoco
 
什么是Jacoco?
Jacoco是一個開源的Java代碼覆蓋率工具 Jacoco可以嵌入到Ant 、Maven中,並提供了EclEmma Eclipse插件,也可以使用JavaAgent技術監控Java程序。很多第三方的工具提供了對Jacoco的集成,如sonar、Jenkins等。
 
Jacoco遠程統計tomcat服務的代碼覆蓋率
 
軟件安裝
Ant
Jacoco
 
Ant  安裝步驟
由於服務器上已經安裝了Ant,所以沒有親自安裝過在Linux服務器上,百度上有好多文章,可以搜一下,下面就給出一個參考鏈接
 
Jacoco安裝步驟
下載下來,隨意放在一個目錄,解壓
在官網上下載Jacoco,官網地址:http://eclemma.org/jacoco/
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見附件
 1 <?xml version="1.0" ?>
 2 <project name="coverage" xmlns:jacoco="antlib:org.jacoco.ant" >
 3     <!--Jacoco的安裝路徑-->
 4   <property name="jacocoantPath" value="/home/work/zj/jacoco/lib/jacocoant.jar"/>
 5   <!--最終生成.exec文件的路徑,Jacoco就是根據這個文件生成最終的報告的-->
 6   <property name="jacocoexecPath" value="/home/work/zj/jacoco/target/jacoco.exec"/>
 7     <!--生成覆蓋率報告的路徑-->
 8   <property name="reportfolderPath" value="/home/work/zj/jacoco/report/"/>
 9   <!--遠程tomcat服務的ip地址-->
10   <property name="server_ip" value="10.99.30.64"/>
11   <!--前面配置的遠程tomcat服務打開的端口,要跟上面配置的一樣-->
12   <property name="server_port" value="8998"/>
13   <!--源代碼路徑可以包含多個源代碼-->
14   <property name="webSrcpath" value="/home/work/zj/adp-feed-access-web/src/main/java/" />
15   <property name="businessSrcpath" value="/home/work/zj/adp-feed-access-business-delivery/src/main/java/"/>
16   <property name="commonSrcpath" value="/home/work/zj/adp-feed-access-business-common/src/main/java/"/>
17   <property name="uasSrcpath" value="/home/work/zj/uas-pbrpc4j/src/main/java/"/>
18   <!--.class文件路徑可以包含多個-->
19   <property name="webClasspath" value="/home/work/local/adp_launch_feed_1/ROOT/WEB-INF/classes/"/>
20   <property name="businessClasspath" value="/home/work/local/adp_launch_feed_1/ROOT/WEB-INF/lib/adp-feed-access-business-delivery/"/>
21   <property name="commonClasspath" value="/home/work/local/adp_launch_feed_1/ROOT/WEB-INF/lib/adp-feed-access-business-common/"/>
22   <property name="uasClasspath" value="/home/work/local/adp_launch_feed_1/ROOT/WEB-INF/lib/uas-pbrpc4j/"/>
23 
24   <!--讓ant知道去哪兒找Jacoco-->
25   <taskdef uri="antlib:org.jacoco.ant" resource="org/jacoco/ant/antlib.xml">
26       <classpath path="${jacocoantPath}" />
27   </taskdef>
28 
29   <!--dump任務:
30       根據前面配置的ip地址,和端口號,
31       訪問目標tomcat服務,並生成.exec文件。-->
32 
33   <target name="dump">
34       <jacoco:dump address="${server_ip}" reset="false" destfile="${jacocoexecPath}" port="${server_port}" append="true"/>
35   </target>
36   
37   <!--jacoco任務:
38       根據前面配置的源代碼路徑和.class文件路徑,
39       根據dump后,生成的.exec文件,生成最終的html覆蓋率報告。-->
40 
41   <target name="report">
42       <delete dir="${reportfolderPath}" />
43       <mkdir dir="${reportfolderPath}" />
44       
45       <jacoco:report>
46           <executiondata>
47               <file file="${jacocoexecPath}" />
48           </executiondata>
49               
50           <structure name="JaCoCo Report">
51               <group name="Launch related">           
52                   <classfiles>
53                       <fileset dir="${webClasspath}" />
54                   </classfiles>
55                   <sourcefiles encoding="gbk">
56                       <fileset dir="${webSrcpath}" />
57                   </sourcefiles>
58               </group>
59               <group name="Business related">           
60                   <classfiles>
61                       <fileset dir="${businessClasspath}" />
62                   </classfiles>
63                   <sourcefiles encoding="gbk">
64                       <fileset dir="${businessSrcpath}" />
65                   </sourcefiles>
66               </group>
67               <group name="Common related">           
68                   <classfiles>
69                       <fileset dir="${commonClasspath}" />
70                   </classfiles>
71                   <sourcefiles encoding="gbk">
72                       <fileset dir="${commonSrcpath}" />
73                   </sourcefiles>
74               </group>
75           </structure>
76 
77           <html destdir="${reportfolderPath}" encoding="utf-8" />         
78       </jacoco:report>
79   </target>
80 </project>
View Code

 

需要注意的點:
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下搭建
 
 
參考文檔


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM