用jacoco统计代码覆盖率:不依赖ant的解决方案

参考网上的教程,用jacoco统计代码覆盖率,需要用到jacoco和ant,我原来的计划也是jacoco和ant的方案,后来研究发现其实不用ant也可以实现,省去了ant的安装和配置,更加灵活方便。

相关软件下载:

Sudo Wget http://mirrors.tuna.tsinghua.edu.cn/apache/maven/maven-3/3.6.3/binaries/apache-maven-3.6.3-bin.tar.gz

sudo wget http://search.maven.org/remotecontent?filepath=org/jacoco/jacoco/0.8.5/jacoco-0.8.5.zip -O jacoco-0.8.5.zip

Sudo wget https://mirrors.tuna.tsinghua.edu.cn/apache//ant/binaries/apache-ant-1.9.14-bin.tar.gz

 关于jacoco和ant的具体安装和环境变量配置过程这里就不多说了,自行百度

 

jacoco统计代码覆盖率的主要步骤为:

  1. 启动jar包时,指定jacocoagent.jar做为javaagent(output模式有file/tcpserver/tcpclient
  2. dump:输出统计数据.exec文件
  3. 下载源码:并编译生成class文件
  4. 生成报告:通过.exec文件,class文件和源码文件生成测试报告

其中1必须在服务端执行,伴随应用,要不然怎么加探针统一执行到了哪些代码呢?

但2,3,4步则是灵活的,即可以在服务端完成,也可以在客户端完成,重点就是第2步的统计数据和第3步的源码能拿到,第4步只不过是用第2,3步的数据生成可视化的报告而已。

第2,3,4步之所以可以在客户端完成,就是因为jacoco提供了tcpserver方式的output模式,为用户统计代码覆盖率并生成报告提供了极大的灵活性,下面会详情介绍这种方式的应用。

关键:在启动jar包时,启动命令指定jacocoagent.jar做为javaagent,实现对原jar包的动态插桩和收集代码执行数据

java - javaagent:${JACOCO_HOME}/lib/jacocoagent.jar=includes=*,output=tcpserver,port=6000,address=127.0.0.1 -jar demo2-0.0.1-SNAPSHOT.jar

原计划:jacoco+ant方案

服务器部署过程:

  • 安装jacoco和ant到指定的服务器上
  • 可选:为jacoco和ant配置环境变量
  • 修改服务启动脚本,增加javaagent相关参数
  • 为ant配置build.xml并放入指定位置

 用jenkin收集代码覆盖率:

  1. dump出代码覆盖统计数据:ant dump (dump配置见下面build.xml)
  2. 下载工程源码,用mvn命令打包:mvn compile
  3. 生成代码覆盖率统计报告要用到class文件,需要指定classfiles,必需
  4. 如果想到在报告中看到源码,需要指定sourcefiles,非必需
  5. 生成报告:ant report (report配置见下面build.xml)

ant需要用到的build.xml模板

<?xml version="1.0" encoding="UTF-8"?>

<project name="test" xmlns:jacoco="antlib:org.jacoco.ant" >

    <!--Jacoco的安装路径-->

  <property name="jacocoantPath" value="/opt/jacoco/lib/jacocoant.jar"/>

  <!--最终生成.exec文件的路径,Jacoco就是根据这个文件生成最终的报告的-->

  <property name="jacocoexecPath" value="./exec"/>

    <!--生成覆盖率报告的路径-->

  <property name="reportfolderPath" value="./report"/>

  <!--JaCoCo的tcpserver的ip地址-->

  <property name="server_ip" value="192.168.0.201"/>

  <!--JaCoCo的tcpserver的端口,要跟启动时jacocoagent中的参数一样-->

  <!--property name="server_port" value="6001"/-->

  <!--源代码路径可以包含多个源代码-->

  <property name="webSrcpath" value="./push-center" />



  <!--.class文件路径可以包含多个-->

  <property name="webClasspath" value="./push-center"/>



  <!--让ant知道去哪儿找Jacoco-->

  <taskdef uri="antlib:org.jacoco.ant" resource="org/jacoco/ant/antlib.xml">

      <classpath path="${jacocoantPath}" />

  </taskdef>



  <!--dump任务: 根据前面配置的ip地址,和端口号,访问目标tomcat服务,并生成.exec文件。

  可以配置多个服务和端口同时dump,适用一台服务器上跑多个服务的情况-->



  <target name="dump">

      <!-- jacoco:dump address="${server_ip}" reset="true" destfile="${jacocoexecPath}" port="${server_port}" append="false"/-->

      <jacoco:dump address="${server_ip}" reset="true" destfile="${jacocoexecPath}/push_center_core_provider.exec" port="6001" append="false"/>

      <jacoco:dump address="${server_ip}" reset="true" destfile="${jacocoexecPath}/push_center_rest_api.exec" port="6002" append="false"/>

      <jacoco:dump address="${server_ip}" reset="true" destfile="${jacocoexecPath}/push-center-validation-provider.exec" port="6003" append="false"/>

  </target>



  <!--jacoco任务:

      根据前面配置的源代码路径和.class文件路径,

      根据dump后,生成的.exec文件,生成最终的html覆盖率报告。-->



  <target name="report">

      <delete dir="${reportfolderPath}" />

      <mkdir dir="${reportfolderPath}" />



      <jacoco:report>

          <executiondata>

            <!--fileset dir="${jacocoexecPath}" includes="*.exec" /-->

            <file file="${jacocoexecPath}/push_center_core_provider.exec" />

            <file file="${jacocoexecPath}/push_center_rest_api.exec" />

            <file file="${jacocoexecPath}/push-center-validation-provider.exec" />

          </executiondata>



          <structure name="JaCoCo Report">

            <group name='push_center_core_provider'>

                 <!--此处配置classes文件地址 -->

                  <classfiles>

                      <fileset dir="${webSrcpath}/push-center-core/push-center-core-provider/target/classes" />

                  </classfiles>

                  <!--此处配置源码地址-->

                  <sourcefiles encoding="utf-8">

                      <fileset dir="${webClasspath}/push-center-core/push-center-core-provider/src/main/java" />

                  </sourcefiles>

            </group>

            <group name='push_center_rest_api'>

                 <!--此处配置classes文件地址 -->

                  <classfiles>

                      <fileset dir="${webSrcpath}/push-center-rest-api/target/classes" />

                  </classfiles>

                  <!--此处配置源码地址-->

                    <sourcefiles encoding="utf-8">

                    <fileset dir="${webClasspath}/push-center-rest-api/src/main/java" />

                  </sourcefiles>

            </group>

            <group name='push-center-validation-provider'>

                 <!--此处配置classes文件地址 -->

                  <classfiles>

                      <fileset dir="${webClasspath}/push-center-validation/push-center-validation-provider/target/classes" />

                  </classfiles>

                  <!--此处配置源码地址-->

                    <sourcefiles encoding="utf-8">

                      <fileset dir="${webSrcpath}/push-center-validation/push-center-validation-provider/src/main/java" />

                  </sourcefiles>

            </group>

           </structure>

          <html destdir="${reportfolderPath}" encoding="utf-8" />

      </jacoco:report>

  </target>

</project>

此方案假设所有的步骤都在目标服务所运行的服务器上执行。

其实生成报告完全可以做到与目标服务分离

首先jacoco支持的三种output模式(file/tcpserver/tcpclient):

  1. 如果是output=file模式,kill服务时会dump统计数据到本地文件,采用这种模式虽然不依赖ant,但是每次dump覆盖率统计数据都要重启服务,很不方便
  2. 如果是output=tcpserver模式,则jacoco额外提供一个tcp服务,可以用ip+端口,访问,随时可以dump数据,无需重启服务(推荐,需要为每一个服务分配一个端口号来dump数据,如果是多个服务部署在同一台服务器上,则要做好端口分配和管理)
  3. 如果是output=tcpclient,未做研究

所以采用output=tcpserver模式,可以实现在任何客户端上收集覆盖率数据和生成报告

  • 服务器端只需安装jacoco,收集统计信息,并使用tcpserver模式提供dump服务
  • 生成报告可以在客户机上完成,客户机需安装ant,通过服务端提供的tcpserver来dump出exec,然后生成报告 

此方案的局限性和不足

  • 严重依赖ant,需要配置build.xml,对于不知道该如何配置build.xml的人来说,这一项就会令人却步
  • 虽然可以用脚本生成build.xml,或用其他方法屏蔽用户直接接触build.xml,只需要提供必须的参数即可,但是考虑到部署环境的复杂性,脚本不可能完全兼顾,最终可能还是需要人工维护build.xml
  • 另外维护脚本或转换层也需要成本,不见得比直接维护build.xml更方便

重点说新方案:不依赖ant

那么能不能不依赖ant?如果要做到不依赖ant,那么就做到以下两点:

  1. dump统计数据不依赖ant
  2. 生成报告不依赖ant

report生成报告摆脱ant

进一步调研发现生成报告可以有三种方式

  1. 用ant命令生成report
  2. jenkins的jacoco插件可以直接收集exec,class和src(推荐)
  3. 用jacococli.jar生成report

重点用jacococli.jar生成report示例:

java -jar /usr/local/jacoco-0.8.5/lib/jacococli.jar report exec/*.exec  --classfiles push-center/push-center-core/push-center-core-api/target/classes/ --html report

 非常好,生成报告可以不依赖ant了,但是dump还是要依赖ant啊。

关于用jenkins的jacoco插件生成报告非常简单,这也是推荐用这种方式生成报告的原因,具体操作百度一下吧

dump统计数据摆脱ant

考虑过采用output=file模式,输出到指定文件的方式,这种方式的优点是不依赖ant,但是缺点也很明显,需要kill服务进程来收集代码覆盖率数据。

而kill服务进程又需要在服务器上执行,不利于将统计代码覆盖率与服务端操作彻底隔离(期望从收集到生成报告都可以在客户端完成,这样服务端就清爽了,少打扰运维哥哥在服务端安装各种插件)

想到即然可以用用jacococli.jar生成report,那么用jacococli.jar是不是也有dump的命令,查了一下果真支持:

java -jar /usr/local/jacoco-0.8.5/lib/jacococli.jar --help
java -jar /usr/local/jacoco-0.8.5/lib/jacococli.jar dump --help

好了,如此一来完全不用再依赖ant就可以愉快的玩耍了。

总结一下新方案的最终实现

启动服务:

java -javaagent:/opt/jacoco/lib/jacocoagent.jar=includes=*,output=tcpserver,port=6001,address=192.168.0.201 -jar push-center-core-provider-1.0.1-SNAPSHOT.jar
java -javaagent:/opt/jacoco/lib/jacocoagent.jar=includes=*,output=tcpserver,port=6002,address=192.168.0.201 -jar push-center-validation-provider-1.0.1-SNAPSHOT.jar
java -javaagent:/opt/jacoco/lib/jacocoagent.jar=includes=*,output=tcpserver,port=6003,address=192.168.0.201 -jar push-center-rest-api-1.0.1-SNAPSHOT.jar

dump数据:

java -jar /opt/jacoco/lib/jacococli.jar dump --address 192.168.0.201 --port 6001 --destfile exec/6001.exec --reset
java -jar /opt/jacoco/lib/jacococli.jar dump --address 192.168.0.201 --port 6002 --destfile exec/6002.exec --reset
java -jar /opt/jacoco/lib/jacococli.jar dump --address 192.168.0.201 --port 6003 --destfile exec/6003.exec --reset

生成报告:

# 编译源码,生成class文件
mvn compile -f push-center/pom.xml

# 删除以前的report
report_dir=report

if [ -d $report_dir ]; then

  echo '删除之前的report:'$target_dir

  rm -r $report_dir

fi


# 可以指定多个classfiles路径
classfiles=''
classfiles=$classfiles' --classfiles push-center/push-center-core/push-center-core-provider/target/classes'
classfiles=$classfiles' --classfiles push-center/push-center-validation/push-center-validation-provider/target/classes'
classfiles=$classfiles' --classfiles push-center/push-center-rest-api/target/classes'


# 可以指定多个sourcefiles路径
sourcefiles=''
sourcefiles=$sourcefiles' --sourcefiles push-center/push-center-core/push-center-core-provider/src/main/java'
sourcefiles=$sourcefiles' --sourcefiles push-center/push-center-validation/push-center-validation-provider/src/main/java'
sourcefiles=$sourcefiles' --sourcefiles push-center/push-center-rest-api/src/main/java'


# 使用jacococli.jar生成报告
java -jar /opt/jacoco/lib/jacococli.jar report exec/*.exec $classfiles $sourcefiles --encoding utf-8 --html report

另外,jacococli.jar这个工具还有很多其他的功能,这里记录一下使用jacococli.jar查看exec文件内容的命令:

java -jar D:\jacococli.jar execinfo jacoco.exec

更多jacococli.jar的使用参考:https://www.eclemma.org/jacoco/trunk/doc/cli.html

  • 0
    点赞
  • 15
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值