背景
Jacoco是主流的统计覆盖率的工具。下面以java语言为例,展示从0开始,获取代码覆盖率的过程。
展示平台
Jenkins
其他:虽然jacoco本身也支持生成xml或者html等多种形式的覆盖率报告,但是都没有jenkins用起来简单顺手,用户界面友好
操作步骤
术语定义
- 服务器:被测服务所在机器
- 客户端:跑完测试用例后,用来获取覆盖率的工具机器。一般就是jenkins的slave机器。如果slave机器无法直接连接到服务器,该怎么办呢?后面有详细介绍
安装jacoco,启动服务端
下载地址:https://www.jacoco.org/jacoco/index.html
按照对应系统下载到压缩包后,解压后,放到服务器所在一个路径例如/work/admin/test-qa-lib,在JVM启动参数中增加如下,其中6300表示服务器上要开的监听端口,用于后续jacoco客户端发出请求,请求服务中累积的覆盖率数据。
-javaagent:/work/admin/test-qa-lib/jacoco/lib/jacocoagent.jar=includes=,output=tcpserver,address=,port=6300,append=false
例如一个完整的服务启动脚本类似:
JACOCO_ARGS="-javaagent:/work/admin/test-qa-lib/jacoco/lib/jacocoagent.jar=includes=*,output=tcpserver,address=*,port=6300,append=false"
JAVA_OPTS="$JAVA_OPTS $JACOCO_ARGS"
nohup java $JAVA_OPTS -server -jar XX你的服务jar包XX.jar &
客户端上安装也要安装jacoco
记录下安装地址,暂时不用
客户端上安装ant,用来组织对jacoco的客户端调用
下载地址 https://ant.apache.org/bindownload.cgi
wget https://mirror.bit.edu.cn/apache//ant/binaries/apache-ant-1.9.14-bin.zip
unzip apache-ant-1.9.14-bin.zip
mv apache-ant-1.9.14 ant
ln -s /home/admin/ant/ant/bin/ant /home/admin/bin/
在客户端机器上准备好build.xml,其中的绝对路径是客户端机器上jacoco的所在路径
<?xml version="1.0" encoding="UTF-8"?>
<project name="coverage_service" xmlns:jacoco="antlib:org.jacoco.ant">
<taskdef uri="antlib:org.jacoco.ant" resource="org/jacoco/ant/antlib.xml">
<classpath path="绝对路径/jacoco-0.8.6/lib/jacocoant.jar"/>
</taskdef>
<target name="run">
<antcall target="dump"/>
<antcall target="merge"/>
</target>
<target name="dump">
<jacoco:dump address="服务所在机器的IP" reset="true" port="6300" destfile="./jacoco_0.exec" append="false"/>
</target>
<target name="merge">
<jacoco:merge destfile="./merged.exec">
<fileset dir="./" includes="*.exec"/>
</jacoco:merge>
</target>
</project>
配置jenkins
在jenkins的执行脚本中填入
ant dump #dump数据后,达到清空历史数据的目的。当被测环境和其他人共用时,为了避免其他人的行为产生更多覆盖数据,必须加上清空的操作
mvn test
ant run
当客户端无法访问到服务器时(可选,如果你的jenkins机器,能够直接连接上服务所在机器的6300端口,可以跳过这一节)
一般,所谓的客户端就是jenkins机器。如果两者不通时,还想用jenkins的代码覆盖率自动展示页面的功能,可以采取如下方法
实质执行的时候,由于网络不通,采取自动执行用例,手动拷贝覆盖率exec文件,自动展示的方式
- step1
Jenkins自动执行用例 mvn test - step2
手动拷贝覆盖率文件。将build.xml和手动脚本放在和服务所在的统一台机器上(解决网络问题),脚本的操作过程是执行ant dump/ant merge/将目标的class打包出来,最终生成我们所需的2个文件即merged.exec和estate-class.zip - step3 在jenkins上的脚本配置框里填入
cp /home/admin/merged.exec ./
cp /home/admin/service-class.zip ./
unzip -o service-class.zip -d classes - step4 将第二步step2里的merge.exec和estate-class.zip拷贝到jenkins的slave机器上,再启动jenkins的任务即可。最后的效果,就是在jenkins上能够基于jacoco插件看到覆盖率的统计结果
测试报告分析
一般都会使用行覆盖率来衡量测试用例的覆盖程度。M代表Miss,是指没有覆盖到的部分, C代表Catch,代表已经覆盖的部分
网友评论