如何使用Jacoco遠程統計tomcat服務的代碼覆蓋率

時間 2019-11-11

標籤如何使用 jacoco 遠程統計 tomcat 服務代碼覆蓋率欄目 Tomcat 简体版

原文原文鏈接

如何使用Jacoco遠程統計tomcat服務的覆蓋率html

在作軟件開發的時候常常會遇到作各類測試，這裏介紹一種本人遇到的：代碼覆蓋率測試，java

這個測試很是實用，能發現許多無效的模塊和代碼。強烈推薦！！！！！tomcat

網上好多資料都不全，並且沒有詳細的配置流程安全

本文將簡單介紹如何使用Jacoco生成遠程tomcat服務的覆蓋率報告。app

(注：使用jacoco打開遠程服務端口，有必定安全風險。)
tcp

軟件安裝測試

Antui

Jacocospa

遠程Tomcat服務配置code

1:sh shutdown.sh先關閉tomcat服務。

2:修改bin/catalina.sh中JAVA_OPTS的配置。

# -javaagent: 的後面跟jacoco的安裝路徑
# includes= 選項，選擇你要覆蓋率的服務
# port= 選項，選擇你要打開的端口
# address= 選項，tomcat服務所在機器的ip地址（若是想在跟tomcat服務同一臺機器上執行ant任務的話，須要改成127.0.0.1）
JAVA_OPTS="-javaagent:/path/to/your/jacoco_0.6.4/lib/jacocoagent.jar=includes=com.baidu.*,output=tcpserver,port=8893,address=10.81.14.77"

3: sh startup.sh從新啓動tomcat服務。

若是發現啓動主程序異常，那麼在JAVA_OPTS 配置中國再加一項-Xverify:none

JAVA_OPTS="-javaagent:/path/to/your/jacoco_0.6.4/lib/jacocoagent.jar=includes=com.baidu.*,output=tcpserver,port=8893,address=10.81.14.77 -Xverify:none"

本地Ant任務配置

配置build.xml。

<?xml version="1.0" ?>
<project name="Lengyu" xmlns:jacoco="antlib:org.jacoco.ant" default="jacoco">
    <!--Jacoco的安裝路徑-->
  <property name="jacocoantPath" value="/home/work/software/jacoco_0.6.4/lib/jacocoant.jar"/>
  <!--最終生成.exec文件的路徑，Jacoco就是根據這個文件生成最終的報告的-->
  <property name="jacocoexecPath" value="/home/work/local/hudson_home/workspace/wg_merchant_oc_regression/jacoco.exec"/>
    <!--生成覆蓋率報告的路徑-->
  <property name="reportfolderPath" value="E:/Libs/coverage_ant_task/report/"/>
  <!--遠程tomcat服務的ip地址-->
  <property name="server_ip" value="10.81.14.77"/>
  <!--前面配置的遠程tomcat服務打開的端口，要跟上面配置的同樣-->
  <property name="server_port" value="8893"/>
  <!--源代碼路徑-->
  <property name="checkOrderSrcpath" value="E:/Src/ordercenter/ordercenter-biz/src/main/java/" />
  <!--.class文件路徑-->
  <property name="checkOrderClasspath" value="E:/Src/ordercenter/ordercenter-biz/target/classes/com/baidu/ordercenter/service/Impl" />

  <!--讓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>

生成覆蓋率報告

執行ant dump。成功的話，應會有以下輸出。

[work@st01-ecom-jn2.st01.baidu.com ant]$ ant dump
Buildfile: /home/work/local/hudson_home/workspace/wg_merchant_oc_regression/ant/build.xml

dump:
[jacoco:dump] Connecting to /10.81.14.77:8893
[jacoco:dump] Dumping execution data to /home/work/local/hudson_home/workspace/wg_merchant_oc_regression/jacoco.exec

BUILD SUCCESSFUL
Total time: 0 seconds

最後執行ant report。jacoco就會在你指定的路徑生成覆蓋率報告了。

附錄

更多關於Jacocoagent以及各類task能夠參考官方文檔

Jenkins的Jacoco plugin能夠根據.exec文件直接生成覆蓋率報告，並在Jenkins中生成圖表等等。那樣的話，ant report這個任務就沒用了。