如果JUnit覆盖率低于特定阈值，如何使Maven构建失败 [英] How to fail a maven build, if JUnit coverage falls below certain threshold

问题描述

我从声纳休息API获取单元测试覆盖率百分比指标.

I'm getting the Unit test coverage percentage metric from sonar rest api.

如果构建低于定义的值，如何使构建失败?

How can I fail the build if it falls below a defined value?

推荐答案

JaCoCo提供了该功能.

使用针对LINE和BRANCH的配置规则COVEREDRATIO定义JaCoCo插件:

Define JaCoCo plugin using configuration rules COVEREDRATIO forLINE and BRANCH :

<plugin>
  <groupId>org.jacoco</groupId>
  <artifactId>jacoco-maven-plugin</artifactId>
  <version>0.7.7.201606060606</version>
  <executions>
    <execution>
      <id>default-prepare-agent</id>
      <goals>
        <goal>prepare-agent</goal>
      </goals>
    </execution>
    <execution>
      <id>check</id>
      <goals>
          <goal>check</goal>
      </goals>
      <configuration>
        <rules>
          <rule>
            <element>CLASS</element>
            <limits>
              <limit>
                <counter>LINE</counter>
                <value>COVEREDRATIO</value>
                <minimum>0.80</minimum>
              </limit>
              <limit>
                <counter>BRANCH</counter>
                <value>COVEREDRATIO</value>
                <minimum>0.80</minimum>
              </limit>
            </limits>
            <excludes>
              <exclude>com.xyz.ClassToExclude</exclude>
            </excludes>
          </rule>
        </rules>
      </configuration>
    </execution>
  </executions>
</plugin>

各种选项

受支持的counter选项是:

• LINE
• 分支
• 说明
• 复杂度
• 方法
• CLASS

我相信INSTRUCTION将允许您进行常规检查(例如，验证整个项目的覆盖率至少为0.80).

I believe INSTRUCTION would allow you to make a general check (verify that the whole project has at least 0.80 of coverage for instance).

示例示例-整个指令覆盖率达80％

此示例需要80％的总体指令覆盖率，并且没有 必须错过课程:

This example requires an overall instruction coverage of 80% and no class must be missed:

<rules>
  <rule implementation="org.jacoco.maven.RuleConfiguration">
    <element>BUNDLE</element>
    <limits>
      <limit implementation="org.jacoco.report.check.Limit">
        <counter>INSTRUCTION</counter>
        <value>COVEREDRATIO</value>
        <minimum>0.80</minimum>
      </limit>
      <limit implementation="org.jacoco.report.check.Limit">
        <counter>CLASS</counter>
        <value>MISSEDCOUNT</value>
        <maximum>0</maximum>
      </limit>
    </limits>
  </rule>
</rules>

失败消息

如果覆盖范围与预期不符，则会失败，并显示以下消息:

Message on failure

If the coverage isn't as expected, it fails with the following message:

[WARNING] Rule violated for class com.sampleapp.SpringConfiguration: lines covered ratio is 0.00, but expected minimum is 0.80
[WARNING] Rule violated for class com.sampleapp.Launcher: lines covered ratio is 0.33, but expected minimum is 0.80
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------

排除项

在上面的示例中，我设置了<exclude>com.xyz.ClassToExclude</exclude>.我认为您会发现需要添加许多排除项.项目通常包含许多无法测试/测试的类(Spring Configuration，Java Bean ...).您也许也可以使用正则表达式.

Exclusions

In the example above, I set <exclude>com.xyz.ClassToExclude</exclude>. I think you'll find you need to add many exclusions. Projects usually contain many classes which aren't testable/tested (Spring Configuration, Java beans...). You may be able to use regular expression too.

• http://choudhury.com/blog/2014 /02/25/enforcing-minimum-code-coverage
• http://www.eclemma.org/jacoco/trunk/doc /maven.html
• http://www.eclemma.org/jacoco/trunk /doc/check-mojo.html

• http://choudhury.com/blog/2014/02/25/enforcing-minimum-code-coverage
• http://www.eclemma.org/jacoco/trunk/doc/maven.html
• http://www.eclemma.org/jacoco/trunk/doc/check-mojo.html

这篇关于如果JUnit覆盖率低于特定阈值，如何使Maven构建失败的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！