Spring Boot 代码覆盖率测试

　　代码覆盖率测试是规范软件开发流程里一个必不可少的环节。一般都是在PG末尾阶段，伴随着IT自测产生。

↑以上，是自己yy出来的啊，反正我司是这样要求的。不跑覆盖率，鬼知道你在代码里夹杂了一些什么东西。

　　好了，以下是正题。

安装jacoco和ant

　　传统的Spring MVC WEB项目，只需要jacoco即可。找到这边文章的朋友应该知道spring是怎么跑覆盖率的，我就不说明了啊。

因Spring Boot本身集成了Tomcat，所以我们这边需要用到ant，ant是干嘛的？自行百度，这里不做说明。

　　地址如下：

　　1.jacoco： http://www.eclemma.org/jacoco/

　　2.ant: https://www.apache.org/dist/ant/binaries/

　　注：下载ant时请认准binaries里的包而不是source，要是解压后找不到bin文件夹请回到这瞅瞅。

配置ant

　　在解压后的bin路径下编写build.xml文件，

<?xml version="1.0" encoding="UTF-8"?>

<project name="test" xmlns:jacoco="antlib:org.jacoco.ant" >

    <!--Jacoco的安装路径-->

  <property name="jacocoantPath" value="D:\jar\jacoco-0.8.1\lib\jacocoant.jar"/>

  <!--最终生成.exec文件的路径，Jacoco就是根据这个文件生成最终的报告的-->

  <property name="jacocoexecPath" value="D:\jar\jacoco-0.8.1\target\jacoco.exec"/>

    <!--生成覆盖率报告的路径-->

  <property name="reportfolderPath" value="D:\jar\jacoco-0.8.1\report"/>

  <!--远程tomcat服务的ip地址-->

  <property name="server_ip" value="127.0.0.1"/>

  <!--监听端口号，非项目端口号，和常用的8080是不是很接近，别误会，自行配置就好-->

  <property name="server_port" value="8090"/>

  <!--源代码路径可以包含多个源代码-->

  <property name="webSrcpath" value="D:\springboot\demo\src\main\java" />   

  <!--.class文件路径可以包含多个-->

  <property name="webClasspath" value="D:\springboot\demo\target\classes"/>

  <!--让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="true" destfile="${jacocoexecPath}" port="${server_port}" append="false"/>

  </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="Launch related">

             <!--此处配置classes文件地址 -->

                  <classfiles>

                      <fileset dir="${webClasspath}" />

                  </classfiles>

                  <!--此处配置源码地址-->

                    <sourcefiles encoding="utf-8">

                      <fileset dir="${webSrcpath}" />

                  </sourcefiles>

              </group>

          </structure>

          <html destdir="${reportfolderPath}" encoding="utf-8" />

      </jacoco:report>

  </target>

</project>

　再强调一遍build.xml中的server_port是后面启动命令参数中的监听端口号，非项目端口号。如果写错会报 Unable to dump coverage data。

启动项目

　　1.Debug模式

　　　　　配置VM arguments，步骤：右击项目>Debug As>Debug Configruations...>Arguments

　　　　　在VM arguments 中添加-javaagent:D:\jar\jacoco-0.8.1\lib\jacocoagent.jar=includes=*,output=tcpserver,port=,address=127.0.0.1

　　　　　debug启动

　　2.jar包

　　　　　mvn clean package生成jar包后，在启动jar包时添加上面的参数就行。

　　　　　java -javaagent:D:\jar\jacoco-0.8.1\lib\jacocoagent.jar=includes=*,output=tcpserver,port=,address=127.0.0.1 -jar D:\springboot\demo\target\demo.jar

测试

　　根据自己的测试case，测试就行啦。测完之后,不需要stop项目。在ant所在目录的bin路径下执行ant dump, 如果build success 表示生成了报告数据。

　　然后再执行ant report，导出数据,在build.xml中指定的路径中生成index.html和jacoco.exec文件

至此，结束。不对之处，还望指正。