Jacoco 统计E2E的代码覆盖率

2018-08-16 本文已影响59人博客已迁移I米阳

原本一直以为代码覆盖率只能单测能搞，后来听了MTSC大会的一个分享，发现这东西E2E测试也是可以搞，而且这东西搞好来想想对精准测试帮助非常大。
于是花了点时间搞了个demo，并写了这个简单的笔记。
该笔记不涉及太多理论，基本讲如何通过jacoco做到E2E代码覆盖率统计实操。

Jacoco 安装配置

安装Tomcat
下载并解压Jacoco，获取到如下文件
image.png
配置Tomcat
3.1 把解压获取到的jacoco下的lib\jacocoagent.jar 文件放到tomcat安装路径\lib 下
3.2 配置Tomcat \bin\catalina.bat文件，添加如下

# -javaagent: 的后面跟jacoco的安装路径
# includes= 选项，选择你要覆盖率的服务，例如com.baidu.*
# port= 选项，选择你要打开的端口
# address= 选项，tomcat服务所在机器的ip地址（如果想在跟tomcat服务同一台机器上执行ant任务的话，需要改为127.0.0.1）
set JAVA_OPTS="-javaagent:%CATALINA_BASE%\lib\jacocoagent.jar=includes=*,output=tcpserver,port=6300,address=127.0.0.1"

部署项目

打包你的java工程项目到Tomcat 下的 \webapps 目录下，并启动Tomcat.

我的工程是github上人家分享的一个Spring MVC 项目：
https://github.com/githubofrico/RestSpringMVCDemo
下载后配置好数据库，直接通过maven 的package命令打成war包

image.png

启动服务
访问项目提供的API进行测试：
如post请求的：http://localhost:8080/RestSpringMVCDemo/tokens
get请求的：http://localhost:8080/RestSpringMVCDemo/users/user/1

Ant 构建获取代码覆盖率

ant 安装配置
这里就直接忽略了，没啥特别
新建 build.xml 如下

<?xml version="1.0" encoding="UTF-8"?>
<project name="plate_id_sample_service" xmlns:jacoco="antlib:org.jacoco.ant">
    <taskdef uri="antlib:org.jacoco.ant" resource="org/jacoco/ant/antlib.xml">
        <classpath path="C:\app\jacoco-0.8.1\lib\jacocoant.jar"/>
    </taskdef>

    <target name="dump">
        <!-- address和port和catalina.bat设置保持一致，destfile设置jacoco.exec保存地址 -->
        <jacoco:dump address="127.0.0.1" reset="true" port="6300" destfile="C:\CodeCoverage\jacoco\jacoco.exec"/>
    </target>

    <target name="report">
        <jacoco:report>
            <executiondata>
                <file file="C:\CodeCoverage\jacoco\jacoco.exec"/>
            </executiondata>

            <structure name="Example Project">
                <!-- 可以按软件功能模块设置多个group，方便在report中查看 -->
                <group name="SpringMVC">
                    <classfiles>
                        <!--.class文件路径，可以放在客户端-->
                        <fileset dir="C:\workspace\IdeaProjects\RestSpringMVCDemo\target\classes"/>
                    </classfiles>
                    <sourcefiles encoding="utf-8">
                        <!--源代码路径，可以放在客户端-->
                        <fileset dir="C:\workspace\IdeaProjects\RestSpringMVCDemo\src\main\java" />
                    </sourcefiles>
                </group>
            </structure>

            <!-- report文件保存地址 -->
            <html destdir="C:\CodeCoverage\jacoco\report"/>

        </jacoco:report>
    </target>
</project>

执行ant命令
3.1 ant dump生成jacoco.exec文件
3.2 ant report 生成report文件(如果通过Jenkins插件这步骤可免)

image.png
查看生成的覆盖率报告
生成报告地址是build.xml 中配置的。红色表示未测试未覆盖到的代码，绿色表示测试已经覆盖到代码。

report
image.png
image.png

抛砖引玉

测试覆盖率，一种讲测试覆盖了多少需求点，还一种就是测试覆盖了多少行代码，多少个方法，多少个分支等。
Demo中可以看到java语言完全可以通过jacoco实现黑盒的代码覆盖率统计，如果把这再跟jenkins集成，那这对精准测试是非常有帮助的。根据当前覆盖情况去针对性设计case，进行针对性测试。
当然也需要注意一点就算代码覆盖率100%也不能保证程序是OK的。

参考文档

如何使用Jacoco远程统计tomcat服务的代码覆盖率

如果文章对您有帮助，请赞赏支持！

欢迎关注个人公众号：

个人公众号