使用Jacoco统计功能测试覆盖率(Ant方式)
Posted nikeylee
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了使用Jacoco统计功能测试覆盖率(Ant方式)相关的知识,希望对你有一定的参考价值。
目录
4、配置文件CoverageReportBuild.xml和运行
5、再运行一个测试用例,再dump覆盖率,再生成覆盖率报告(覆盖率报告记录追加)
2)运行ant命令,dump覆盖率文件,生成覆盖率报告(覆盖率报告有追加的测试结果)
背景:
- 1、项目工程在windows环境下,使用maven进行编译和打包;(本地开发模式)
- 2、ant安装和配置在windows环境下,在windows环境下运行ant;
目标:使用ant将远程的覆盖率文件dump下来,再生成代码覆盖率;
1、下载工具和环境配置--准备工作
1)先安装Apache Ant,配置环境变量
参考文章:https://blog.csdn.net/nikeylee/article/details/117259754
2)下载Jacoco包
下载地址:https://www.eclemma.org/jacoco/
这里使用的版本:jacoco-0.8.7.zip
下载后,解压到目录:D:\\jacoco\\test\\jacoco-0.8.7
3)使用maven打包项目工程
创建项目工程参考文章:https://blog.csdn.net/nikeylee/article/details/117164851
工程有2个接口:
Hello World页面显示:http://localhost:8081/first/view
请求后Json数据回传:http://localhost:8081/first/back
将打包后的工程shopping-1.0.0-SNAPSHOT.jar拷贝到目录:D:\\jacoco\\test
2、使用javaagent参数启动项目工程
启动命令:port设置为8005,是后面使用ant运行dump任务时需要访问的端口号
java -javaagent:D:\\jacoco\\test\\jacoco-0.8.7\\lib\\jacocoagent.jar=includes=*,output=tcpserver,port=8005 -jar D:\\jacoco\\test\\shopping-1.0.0-SNAPSHOT.jar
3、运行测试用例
1)使用postman请求后Json数据回传:http://localhost:8081/first/back
2)请求后结果:控台打印日志,进入json测试页面
4、配置文件CoverageReportBuild.xml和运行
1)CoverageReportBuild.xml内容
拷贝到目录:D:\\jacoco\\test\\CoverageReportBuild.xml
<?xml version="1.0" encoding="UTF-8" ?>
<project name="Jacoco" xmlns:jacoco="antlib:org.jacoco.ant" default="report">
<!--项目工程tomcat服务的ip地址-->
<property name="server_ip" value="127.0.0.1"/>
<!--项目工程tomcat服务启动时配置的端口port 8005-->
<property name="server_port" value="8005"/>
<!--Jacoco的安装路径-->
<property name="jacoco.dir" location="D:\\jacoco\\jacoco-0.8.7"/>
<property name="jacocoantPath" value="$jacoco.dir\\lib\\jacocoant.jar"/>
<!--项目工程路径-->
<property name="project.dir" location="D:\\Nikey\\Project\\Repository\\gitee\\shopping"/>
<!--项目工程打包路径-->
<property name="result.dir" location="$project.dir\\target"/>
<!--创建存放覆盖率文件的路径-->
<property name="coverage.dir" location="$result.dir\\jacoco"/>
<!--最终生成.exec文件的路径,Jacoco就是根据这个文件生成最终的报告的-->
<property name="integrationJacocoexecPath" value="$coverage.dir\\jacoco.exec"/>
<!--生成覆盖率报告的路径-->
<property name="jacocoReportPath" location="$coverage.dir\\coverageResults"/>
<!--源代码路径-->
<property name="resource.code" location="$project.dir\\src\\main\\java"/>
<!--.class文件路径-->
<property name="result.classes.dir" location="$result.dir\\classes"/>
<!--让ant知道去哪儿找jacocoant.jar-->
<taskdef uri="antlib:org.jacoco.ant" resource="org/jacoco/ant/antlib.xml">
<classpath path="$jacocoantPath"/>
</taskdef>
<!--dump任务:
根据前面配置的ip地址,和端口号,
访问目标tomcat服务,并生成.exec文件。
append="true",表示可追加覆盖率记录-->
<target name="dump">
<delete dir="$coverage.dir"/>
<mkdir dir="$coverage.dir"/>
<jacoco:dump address="$server_ip" port="$server_port" reset="false" destfile="$integrationJacocoexecPath"
append="true"/>
</target>
<!--jacoco任务:
根据前面配置的源代码路径和.class文件路径,
根据dump后,生成的.exec文件,生成最终的html覆盖率报告。-->
<target name="report" depends="dump">
<!-- Create coverage report -->
<jacoco:report>
<!-- This task needs the collected execution data and ... -->
<executiondata>
<file file="$integrationJacocoexecPath"/>
</executiondata>
<!-- the class files and optional source files ... -->
<structure name="shopping_CodeCoverage">
<group name="shopping">
<classfiles>
<fileset dir="$result.classes.dir"/>
</classfiles>
<sourcefiles encoding="UTF-8">
<fileset dir="$resource.code"/>
</sourcefiles>
</group>
</structure>
<!-- 生成不同格式的report -->
<html destdir="$jacocoReportPath" encoding="utf-8"/>
<csv destfile="$jacocoReportPath/report.csv"/>
<xml destfile="$jacocoReportPath/report.xml"/>
</jacoco:report>
</target>
</project>
2)运行ant命令,dump覆盖率文件,生成覆盖率报告
在D:\\jacoco\\test\\目录运行Ant命令:
ant -buildfile CoverageReportBuild.xml
运行结果:
打开index.html,显示覆盖率报告
因为只运行了一个接口的测试用例,所以FirstController类的行覆盖率不是100%(一共有5行代码,有2行代码没有被覆盖到)
3)测试覆盖率报告说明
报告列名说明:
- Instructions:指令,jacoco计算的最小单位就是字节码指令。指令覆盖率表明了在所有的指令中,哪些被指令过以及哪些没有被执行。这项指数完全独立于源码格式并且在任何情况下有效,不需要类文件的调试信息。
- Branches:分支,jacoco对所有的if和switch指令计算了分支覆盖率。这项指标会统计所有的分支数量,并同时指出哪些分支被执行,哪些分支没有被执行。这项指标也在任何情况都有效。异常处理不考虑在分支范围内。在有调试信息的情况下,代码分支的左边会有一个带颜色的钻石,绿色全部分支被执行,红色全部分支未执行,黄色钻石部分分支被执行。
- Cxty:圈复杂度,Cyclomatic Complexity,jacoco会计算每个非抽象方法的圈复杂度,并且也会计算类,包,组的复杂度。根据McCabe1996的定义,圈复杂度可以理解为覆盖所有的可能情况最少使用的测试用例数。这项参数也在任何情况下有效。
- Lines:行,该项指数在有调试信息的情况下计算。因为每一行代码可能会产生若干条字节码指令,因此使用红色背景表示该行指令未被执行,黄色背景表示该行部分指令未被执行,绿色背景则表示该行指令全部执行。
- Methods:方法,每一个非抽象方法都至少有一条指令。若一个方法至少被执行了一条指令,就认为它被执行过。因为jacoco直接对字节码进行操作,所以有些方法没有在源码显示(比如某些构造方法和由编译器自动生成的方法)也会被计入在内。
- Classes:类,每个类中只要有一个方法被执行,这个类就被认定为被执行。同medhods一样,有些没有在源码声明的方法被执行,也认定该类被执行。
Missed:表示未被覆盖到。
Cov:是coverage的缩写,意思是代码覆盖率。
第二栏指令覆盖率和第三栏分支覆盖率,都是进度条的显示形式,红色未覆盖绿色已覆盖,后面跟着覆盖率百分比。
从Total那一栏可以看出,总共有65条指令,9条未执行,因此覆盖率为86%。
问题:如果运行命令报错,Error reading project file D:\\jacoco\\test\\CoverageReportBuild.xml: 2 字节的 UTF-8 序列的字节 2 无效。
解决方法:CoverageReportBuild.xml文件保存为UTF-8的格式后,再运行命令。
5、再运行一个测试用例,再dump覆盖率,再生成覆盖率报告(覆盖率报告记录追加)
1)浏览器访问Hello World页面
Hello World页面显示:http://localhost:8081/first/view
显示结果:控台打印日志,进入测试页面
2)运行ant命令,dump覆盖率文件,生成覆盖率报告(覆盖率报告有追加的测试结果)
ant -buildfile CoverageReportBuild.xml
运行后覆盖率报告结果:
可以看到com.company.shopping.controller包的覆盖率结果,包含了2个测试用例的覆盖结果
以上是关于使用Jacoco统计功能测试覆盖率(Ant方式)的主要内容,如果未能解决你的问题,请参考以下文章
通过ant方式使用Jacoco远程统计tomcat服务的代码覆盖率