idea JaCoCo统计单元测试覆盖率在idea中使用JaCoCo插件统计单元测试覆盖率的实现

风雨诗轩 2021-01-27 我要评论

在后台工程师开发完新代码交给QA进行测试时，软件测试人员一般都会要求后台开发对单元测试的覆盖率达到一定的标准；例如我们的标准是分支覆盖率达到50%以上，函数覆盖率达到50%以上。

在idea中查看覆盖率挺简单的，idea中支持三种插件来查看覆盖率，每种插件统计明细各有千秋，分别是idea自带插件、JaCoCo、Emma。

在idea中打开一个测试类，点击右上角“Edit Configurations”按钮，如下图所示：

然后会弹出一个框，左侧菜单栏显示JUnit栏目，右边我们选择“Code Coverage"选项卡，下面有一个”choose coverage runner“下拉菜单，默认是idea自带的，我们可以切换成其他的（只不过需要在pom中配置一下），如下图所示：

idea默认自带的插件，统计出来的覆盖率只包含classes、method、line，不太详细，不能满足我们的要求；所以一般使用JaCoCo插件来统计，我们切换成JaCoCo插件以后，紧接着在maven的pom文件中这样配置：

（1）添加依赖

<dependency>
 <groupId>org.jacoco</groupId>
 <artifactId>jacoco-maven-plugin</artifactId>
 <version>0.8.2</version>
</dependency>

（2）配置plugins

<plugin>
 <groupId>org.jacoco</groupId>
 <artifactId>jacoco-maven-plugin</artifactId>
 <version>0.8.2</version>
 <configuration>
  <destFile>target/coverage-reports/jacoco-unit.exec</destFile>
  <dataFile>target/coverage-reports/jacoco-unit.exec</dataFile>
  <includes>
   <include>**/service/**</include>
   <include>**/controller/**</include>
   <!--<include>**/service/impl/*.class</include>-->
  </includes>
  <!-- rules里面指定覆盖规则 -->
  <rules>
   <rule implementation="org.jacoco.maven.RuleConfiguration">
    <element>BUNDLE</element>
    <limits>　　
     <!-- 指定方法覆盖到50% -->
     <limit implementation="org.jacoco.report.check.Limit">
      <counter>METHOD</counter>
      <value>COVEREDRATIO</value>
      <minimum>0.50</minimum>
     </limit>
     <!-- 指定分支覆盖到50% -->
     <limit implementation="org.jacoco.report.check.Limit">
      <counter>BRANCH</counter>
      <value>COVEREDRATIO</value>
      <minimum>0.50</minimum>
     </limit>
     <!-- 指定类覆盖到100%，不能遗失任何类 -->
     <limit implementation="org.jacoco.report.check.Limit">
     <counter>CLASS</counter>
     <value>MISSEDCOUNT</value>
     <maximum>0</maximum>
     </limit>
    </limits>
   </rule>
  </rules>
 </configuration>
 <executions>
  <execution>
   <id>jacoco-initialize</id>
   <goals>
    <goal>prepare-agent</goal>
   </goals>
  </execution>
  <!--这个check:对代码进行检测，控制项目构建成功还是失败-->
  <execution>
   <id>check</id>
   <goals>
    <goal>check</goal>
   </goals>
  </execution>
  <!--这个report:对代码进行检测，然后生成index.html在 target/site/index.html中可以查看检测的详细结果-->
  <execution>
   <id>jacoco-site</id>
   <phase>package</phase>
   <goals>
    <goal>report</goal>
   </goals>
  </execution>
 </executions> 
</plugin>

如果你想使用idea自带的插件，查看简单的覆盖率数据，可以直接在测试类上右键点击”Run ‘xxxxxTest' with Coverage"，如下图所示：

当JaCoCo插件配置好以后，要获得 JaCoCo的统计数据，就要执行mvn install 命令。执行完以后，target/site/jacoco/目录下会生成一个index.html文件，这是统计数据总览页面，可以在浏览器打开查看，如下图所示：

由于我们在pom文件的plugin里面配置了rule规则和check 目标，所以在覆盖率不满足的情况下，mvn install是不会成功的，并且会报错：

另一个需要注意的是我在rule中配置的规则，有的是 COVEREDRATIO，有的是MISSEDCOUNT，这说明有的统计的是覆盖率，有的统计的是丢失率（也即未覆盖到的），你可别看错了。

配置JaCoCo插件一定注意和JDK版本的对应关系，如果你用的是jdk1.8，则插件一定要用最新版，要不然会报如下错误：

Caused by: java.lang.RuntimeException: Class java/util/UUID could not be instrumented.
 at org.jacoco.agent.rt.internal_5d10cad.core.runtime.ModifiedSystemClassRuntime.createFor(ModifiedSystemClassRuntime.java:138)
 at org.jacoco.agent.rt.internal_5d10cad.core.runtime.ModifiedSystemClassRuntime.createFor(ModifiedSystemClassRuntime.java:99)
 at org.jacoco.agent.rt.internal_5d10cad.PreMain.createRuntime(PreMain.java:51)
 at org.jacoco.agent.rt.internal_5d10cad.PreMain.premain(PreMain.java:43)
 ... 6 more
Caused by: java.lang.NoSuchFieldException: $jacocoAccess
 at java.lang.Class.getField(Class.java:1542)
 at org.jacoco.agent.rt.internal_5d10cad.core.runtime.ModifiedSystemClassRuntime.createFor(ModifiedSystemClassRuntime.java:136)
 ... 9 more
FATAL ERROR in native method: processing of -javaagent failed
Exception in thread "main"

补充：Intellij IDEA run coverage之覆盖率测试