Jacoco+Tomcat在On-The-Fly模式下统计接口测试代码覆盖率

一、准备工作
0.下载安装java环境 ,我的是java version “1.8.0_201”
1.下载安装ant,我的版本是apache-ant-1.10.7
2.下载安装Tomcat 我的是Tomcat 9.0.24
3.下载Jacoco 我的是jacoco-0.8.5
4.准备一个Spring MVC项目
Jacoco+Tomcat在On-The-Fly模式下统计接口测试代码覆盖率
简单些几行代码:
Jacoco+Tomcat在On-The-Fly模式下统计接口测试代码覆盖率
在idea中打个war包,丢进Tomcat 的webapps 文件夹
然后启动一下Tomcat调一下项目中的API看下是否成功。

准备完成,下面开始做。
写在前面:建议在准备开整之前先备份一下catalina.bat或者catalina.sh
还有XXXX/jacoco-0.8.5/doc/examples/build目录下的build.xml以免新手翻车不知道咋弄回去。

然后 在Tomcat的bin目录下找到 卡特琳娜,没错就是五杀那货。
开个玩笑,其实 Windows下是catalina.bat
mac和Linux下是 catalina.sh

然后我是macOS 所以我打开catalina.sh:
打开之后,在首行加入:

JAVA_OPTS="-javaagent:[yourPath/]jacocoagent.jar=includes=com.companyName.*,output=tcpserver,port=PORT,address=IP -Xverify:none"

参数说明:

  1. yourPath 是放 jacocoagent.jar 文件的目录路径;那么 jacocoagent.jar 这个 jar 包的路径就是在准备工作里下载下来的 zip 包,解压之后的 lib 目录下。
  2. includes 是指要收集哪些类(注意不要光写包名,最后要写.),不写的话默认是,会收集应用服务上所有的类,包括服务器和其他中间件的类,一般要过滤(当然如果你愿意写*也完全没有问题,如:includes=com.* or includes=*);
  3. output 有 4 个值,分别是 file、tcpserver、tcpclient、mbean,默认是 file。使用 file 的方式只有在停掉应用服务的时候才能产生覆盖率文件,而使用 tcpserver 的方式可以在不停止应用服务的情况下下载覆盖率文件,后面会介绍如何使用 dump 方法来得到覆盖率文件。
  4. address 是 IP 地址,IP 就是 Tomcat 服务器的机器的 IP,至于是写 服务器本机的 IP 还是写 127.0.0.1 要看情况 1) 如果是在 Tomcat 服务器上执行 ant dump 的话,就直接写 address=127.0.0.1 2) 如果执行 ant dump 不是在 Tomcat 服务器上执行的,就得写服务器本机的IP(切记)
  5. port 是端口(端口比较随便,找个能用的端口就行,直接我为什么将端口写成 8044,我的想法是 BUG 死死8044 挺配的,所以就用它作为端口号了) (addressport 是使用 tcpserver 方式需要的 2 个参数,也是执行 ant dump 方法必须要用到的。)
  6. -Xverify:none:这个参数是防止启动主程序异常才加的(非强制,可以不加)

我这边是本地运行,所以 IP是本地IP 端口8080 注意,记住这个IP和端口,后面还会用到。
在首行加入一个 JAVA_OPTS="-javaagent:/Users/dingtone/testTools/jacoco-0.8.5/lib/jacocoagent.jar=includes=com.oneal.*,output=tcpserver,port=8080,address=127.0.0.1 -Xverify:none"

另外,卡特琳娜(catalina.sh)这货 下面还有默认的JAVA_OPTS这个要给他屏蔽掉,我这边一开始踩坑发现Tomcat启动根本没有使用我设置的 jacoco代理JVM 原因就是被
下面的JAVA_OPTS覆盖掉了。反正只要看见JAVA_OPTS=""就全都屏蔽掉。
然后Tomcat就整好了。
我们验证JAVA_OPTS是生效的,下面我是mac就直接看了。
执行:ps -ef | grep tomcat
往下翻,可以看到-javaagent:XXXXjacoco-0.8.5/lib/jacocoagent.jar=includes=com.XXX说明Tomcat这边没啥问题了。

下面是Jacoco的build.xml配置:
1.配置好Jacoco的安装路径
2.生成.exec文件的路径,这个.exec文件用于后面生成报告的。
3.生成覆盖率报告的路径,这个用于存储HTML报告的路径。如果你后面直接copy我的build.xml,那这个路径不要跟.exec文件的路径相同。
4.远程tomcat服务的ip地址和端口号,这个就是我上面说要用到,在配置catalina.sh时写的。
5.源代码路径和.class文件的路径。这两个,我个人认为在打war包之后就不要改动,否则不知道会出什么幺蛾子。

剩下的配置照抄就行。
具体的build.xml如下:

<?xml version="1.0" encoding="UTF-8"?>
<description>
  Example Ant build file that demonstrates how a JaCoCo coverage report
  can be itegrated into an existing build in three simple steps.
</description>
<!--Jacoco的安装路径-->
<property name="jacocoantPath" value="/Users/dingtone/testTools/jacoco-0.8.5/lib/jacocoant.jar"/>
<!--最终生成.exec文件的路径,Jacoco就是根据这个文件生成最终的报告的-->
<property name="jacocoexecPath" value="/Users/dingtone/testTools/jacoco_result/jacoco.exec"/>
<!--生成覆盖率报告的路径-->
<property name="reportfolderPath" value="/Users/dingtone/testTools/jacoco_result_html/"/>
<!--远程tomcat服务的ip地址-->
<property name="server_ip" value="127.0.0.1"/>
<!--前面配置的远程tomcat服务打开的端口,要跟上面配置的一样-->
<property name="server_port" value="8080"/>

<!--源代码路径-->
<!--可以配置多个源代码-->
<property name="checkOrderSrcpath" value="/Users/dingtone/IdeaProjects/springmvcdemo/src/main/java/"/>

<!--.class文件路径-->
<!--跑的是class,标注的是源码?-->
<!--<property name="checkOrderClasspath" value="/root/wftest/target/classes/com/hundsun" />-->

<property name="checkOrderClasspath" value="/Users/dingtone/IdeaProjects/springmvcdemo/target/classes/com/oneal/controller/"/>



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

然后,我们的准备工作完成,此时请确保Tomcat正常运行,然后我们cd到这个build.xml配置文件的目录下运行:
ant dump
然后再ant report
Done !
效果验证:

  1. 先启动Tomcat,然后查看一下结果,发现 return index 这行代码是红色的说明没有被测试到。

我们打开postman,调一下"/"这个路径,让他走一下return index看下效果。

我们再生成一下报告:

发现"/"这个路径已经被覆盖到了。

完成!

上一篇:C# 8.0 新特性之二:接口默认实现


下一篇:适配器模式