Jacoco是Java Code Coverage的缩写,顾名思义,它是获取Java代码执行覆盖率的一个工具,通常用它来获取单元测试覆盖率。它通过分析Java字节码来得到代码执行覆盖率,因此它还可以分析任何基于JVM的语言(如Croovy、Kotlin)的覆盖率。本文不讨论如何用Jacoco获取单元测试的代码覆盖率,而是从Jacoco的原理出发,介绍如何通过Jacoco获取SIT或者UAT的测试覆盖率。更准确来讲,是获取一个应用执行过的代码占总代码的比率。包括字节码指令覆盖率,分支覆盖率,圈复杂度覆盖率,行覆盖率,方法覆盖率和类覆盖率。
Jacoco通过修改喂给JVM的字节码来达到获取那些代码执行了的目的。修改方式有两种,一种在线(on-the-fly),是通过Java agent,在JVM执行字节码之前动态对其进行修改,这种方式更灵活,也是Jcoco的一大特性。另一种是离线(offline)模式,在Java程序字节码文件(.class文件)生成之前进行修改,这样的字节码就不纯了。一般在无法使用on-the-fly方式的时候才使用offline方式。
上面这些概括起来讲,Jacoco最牛X的地方就在于它能够知道一个基于JVM的应用程序中哪些代码(指令、分支、行、方法、类)被执行了。用它除以总代码量,就得到了代码执行覆盖率。
由此,我们可以推断出Jacoco生成单元测试覆盖率报告的原理:单元测试代码会调用被测试代码,被测试代码的字节码指令会被Jacoco截获,用被截获的代码量除以总代码量,就算出了单元测试代码覆盖率。举一反三,在SIT或者UT的时候,也需要执行Java应用程序中的代码,因此可以也通过Jacoco获取被执行过的代码,从而计算出SIT,UT测试代码覆盖率。
接下来通过一个实验介绍如何使用Jacoco获取一个Java web应用代码的执行率。就拿Tomcat自带的example应用来做实验,我们在启动Tomcat时带上Jacoco的Java agent;然后在页面上做一些点击操作,触发后台Java代码的执行;再抓取包含执行情况数据,放到.exec的二进制文件中;最后由这些二进制文件生成html格式的报告,验证被覆盖的代码是否和我们点击的内容相关。
下载Jacoco(https://www.jacoco.org),解压缩。
下载Tomcat(https://mirrors.tuna.tsinghua.edu.cn/apache/tomcat/ 清华mirror),然后解压缩,进入bin目录,找到catalina.bat文件(Windows)。
修改如下代码,让Tomcat在启动时带上Javacoco的agent。
set "JAVA_OPTS=%JAVA_OPTS% %JSSE_OPTS%"
修改为
set "JAVA_OPTS=%JAVA_OPTS% %JSSE_OPTS% -javaagent:C:\Users\Robot\Application\jacoco-0.8.5\lib\jacocoagent.jar=destfile=jacoco.exec,output=tcpserver"
其中指定了javaagent是C:\Users\Robot\Application\jacoco-0.8.5\lib\jacocoagent.jar,解压Jacoco可以得到;指定了output是tcpserver,也就是需要通过访问一个地址才能获取到数据。默认地址是本地IP地址,端口号是6300。其它参数说明见:https://www.jacoco.org/jacoco/trunk/doc/agent.html。
设置完成之后,双击Tomcat bin目录下的startup.bat,启动Tomcat。控制台可以看见javaagent设置生效。此时Jacoco就可以动态地拦截喂给JVM的字节码,并且监听6300端口号和所以本机地址,等待获取代码执行情况数据(暂且称为.exec文件数据)的请求。
输入地址http://127.0.0.1:8080/ ,打开Tomcat 欢迎页面,做一些点击操作,可以确定它已经执行了一些字节码。
获取执行情况数据,在jacococli.jar所在目录(与jacocoagent.jar目录一致)执行命令:
java -jar jacococli.jar dump --port 6300 --destfile data/jacoco-it.exec
Jacoco会在当前目录下生成data/jacoco-it.exec文件,这个文件是一个二进制文件,我们无法直接查看它,需要用它生成html或者其它格式的文件。
执行如下命令生成html报告。--classfiles制定应用程序的class文件所在目录,--html指定html报告所在目录。
java -jar jacococli.jar report data/jacoco-it.exec --classfiles C:/Users/Robot/Application/apache-tomcat-9.0.29/webapps/examples/WEB-INF/classes --html html
打开html目录下的index.html文件就可以看到报告了。
上面实验比较简单,只为辅助对Jacoco原理的理解。理解了原理之后,参照官网的手册就可以用Jacoco来做一些实用的操作,提高Java代码的质量。
以上就是使用Jacoco获取 Java 程序的代码执行覆盖率的步骤详解的详细内容,更多关于使用Jacoco获取 Java 程序的代码执行覆盖率的资料请关注小牛知识库其它相关文章!
我正在尝试使用JaCoCo-javaagent传递VM参数来获得代码覆盖率 -Java agent:/test/jaco co/jaco agent . jar = dest file =/test/jaco co/jaco co . exec,includes=com。*,append=true 我能在jacoco中获得一些价值。执行文件,但无法获取覆盖率报告。我怎样才能把jacoco转化成。执
我在声纳中的代码覆盖率显示为0%,这不是真的,因为我有单元测试。 格拉德尔 当我打开inside然后我可以看到成功的单元测试。 我在Jenkins环境中运行作为
我的代码运行在具有单独JVM的单独虚拟机上。我想在此虚拟机上以tcpserver模式设置JaCoCo代理以收集覆盖率数据。然后,我将在我的maven项目中以tcpclient模式设置JaCoCo代理,以连接到上面提到的VM并获取覆盖率数据。 问题是代理不收集任何覆盖数据。在中创建了覆盖率数据文件,但该文件为空。 下面是代理选项:-Java agent:/usr/xx/plugins/org . j
我的android应用程序使用以下配置: 分级 - 0.12。 build.gradle文件的内容 当属性测试“已启用”设置为 false 时,我的所有测试都成功运行。将其设置为 true 时,运行测试时将引发以下异常 当模拟在测试中初始化时,错误发生在生产线上。 有没有人设法为使用mockito库进行测试的android应用程序生成代码覆盖率指标?
我正在尝试集成Jacoco,以便使用Maven获得Cucumber测试的代码覆盖率。以下是我的项目结构: > -src主java页面 -src主java助手 -src-测试-java-资源-功能 -src测试java步骤 以下是我的POM中的Jacoco配置。xml 我能够生成代码覆盖率报告。但是,在报告中,它涵盖了-src主包中的所有类。根据不同的google搜索和SO帖子,我试图修改POM以排
代码覆盖率在仪表板上显示为 0% build.gradle文件 运行此命令 JacocoTestReport使用正确的代码覆盖率生成 声纳曲渐变任务生成此日志 在谷歌上搜索了半天,这个问题的唯一真正解决方案是:财产的sonar.jacoco。不推荐使用“报告路径”。请使用“声纳”jacoco。改为“报告路径” 此处的答案解释了双重输出: 但是,这似乎尚未添加到gradle插件中,因为正在使用的插件