Maven Jacoco配置-从报告中排除类/程序包不起作用

103

我有一个Maven多模块项目，并且正在使用jacoco-maven进行代码覆盖率报告。有些类不应该报告，因为它们是Spring配置的，我对它们不感兴趣。

我已经声明了maven-jacoco插件如下：

<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<version>0.7.2.201409121644</version>
<configuration>
    <outputDirectory>${project.reporting.outputDirectory}/jacoco-ut</outputDirectory>
    <exclude>some.package.*</exclude>
    <exclude>**/*Config.*</exclude>
    <exclude>**/*Dev.*</exclude>
    <exclude>some/package/SomeClass.java</exclude>
</configuration>
<executions>
    <execution>
        <goals>
            <goal>prepare-agent</goal>
        </goals>
    </execution>
    <execution>
        <id>report</id>
        <phase>prepare-package</phase>
        <goals>
            <goal>report</goal>
        </goals>
    </execution>
    <execution>
        <id>post-unit-test</id>
        <phase>test</phase>
        <goals>
            <goal>report</goal>
        </goals>
    </execution>
</executions>
</plugin>

问题是，当我执行mvn clean verifyjacoco时，仍然报告应删除的类，因为我的xml配置指出了这些类。如何正确配置？

maven  configuration  jacoco  jacoco-maven-plugin 
— resilva87
source

Answers:

181

您的XML略有错误，您需要在excludes父字段中添加任何类排除，因此根据Jacoco docs，上述配置应如下所示

<configuration>
    <excludes>
        <exclude>**/*Config.*</exclude>
        <exclude>**/*Dev.*</exclude>
    </excludes>
</configuration>

排除字段的值应该是使用标准通配符语法相对于目录target / classes /的已编译类的类路径（而不是程序包名称）

*   Match zero or more characters
**  Match zero or more directories
?   Match a single character

您还可以通过以下方式排除软件包及其所有子/子软件包：

<exclude>some/package/**/*</exclude>

这将排除中的每个班级some.package以及任何子级。例如，some.package.child也不会包含在报告中。

我已经使用上述方法进行了测试，并且我的报告目标报告的课程减少了。

如果您随后将此报告推送到Sonar中，则需要告诉Sonar将这些类排除在显示中，这可以在Sonar设置中完成

设置>常规设置>排除>代码覆盖率

Sonar Docs对此进行了解释

在上面运行命令

mvn clean verify

将显示已被排除的班级

没有排除

[INFO] --- jacoco-maven-plugin:0.7.4.201502262128:report (post-test) @ ** ---
[INFO] Analyzed bundle '**' with 37 classes

有排除

[INFO] --- jacoco-maven-plugin:0.7.4.201502262128:report (post-test) @ ** ---
[INFO] Analyzed bundle '**' with 34 classes

希望这可以帮助

— 安德鲁·邱
source
2
我必须将Jacoco插件从0.7.5升级到0.7.6，才能将排除因素考虑在内。
— Stephane
2
关于声纳的大提示。容易假设JaCoCo排除对象会像我一样自动地推广到Sonar。
— markdsievers
10
如果我排除文件格式的jacoco，它将显示在覆盖率报告中，覆盖率为0％。因此，与没有排除相比，基本上我得到的结果更糟。这个可以解决吗？
— 亚当·阿罗德
4
请记住在文件名之间使用斜杠，而不是点。另外，文件结尾是.class而不是.java。
— ThomasRS
1
了解**和*的影响很重要。如果您不包括**，则它将不会遍历到基础目录。*是单个字符，应用于文件名。
— Smart Coder
18

尽管安德鲁已经详细回答了问题，但我给出了如何在pom中排除它的代码

           <plugin>
                <groupId>org.jacoco</groupId>
                <artifactId>jacoco-maven-plugin</artifactId>
                <version>0.7.9</version>
                <configuration>
                    <excludes>
                        <exclude>**/*com/test/vaquar/khan/HealthChecker.class</exclude>
                    </excludes>
                </configuration>
                <executions>
                    <!-- prepare agent for measuring integration tests -->
                    <execution>
                        <id>jacoco-initialize</id>
                        <goals>
                            <goal>prepare-agent</goal>
                        </goals>
                    </execution>
                    <execution>
                        <id>jacoco-site</id>
                        <phase>package</phase>
                        <goals>
                            <goal>report</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>

对于Springboot应用程序

<build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>sonar-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.sonarsource.scanner.maven</groupId>
                <artifactId>sonar-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.jacoco</groupId>
                <artifactId>jacoco-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                       <!-- Exclude class from test coverage -->
                        <exclude>**/*com/khan/vaquar/Application.class</exclude>
                        <!-- Exclude full package from test coverage -->
                        <exclude>**/*com/khan/vaquar/config/**</exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>
— 瓦夸尔汗
source
1
嗨，Vaquar，我一直为通过jacoco maven插件将软件包排除在外而努力。我不想在已创建的Index.html上显示排除的软件包。.如果您有相同的代码，也可以这样做，请帮助我。请通过imvrajendra@gmail.com将代码发送给我
— Vrajendra Singh Mandloi '18年
3
看来类路径应该是没有.class结束，如： <exclude>**/*com/test/vaquar/khan/HealthChecker</exclude>
— hovenko
3
这将为我从报告中删除整个软件包： <exclude>com/mycompany/mypackage/**/*</exclude>
— Jim Tough19年
4

另一个解决方案：

<plugin>
    <groupId>org.jacoco</groupId>
    <artifactId>jacoco-maven-plugin</artifactId>
    <version>0.7.5.201505241946</version>
    <executions>
        <execution>
            <id>default-prepare-agent</id>
            <goals>
                <goal>prepare-agent</goal>
            </goals>
        </execution>
        <execution>
            <id>default-report</id>
            <phase>prepare-package</phase>
            <goals>
                <goal>report</goal>
            </goals>
        </execution>
        <execution>
            <id>default-check</id>
            <goals>
                <goal>check</goal>
            </goals>
            <configuration>
                <rules>
                    <rule implementation="org.jacoco.maven.RuleConfiguration">
                        <excludes>
                            <exclude>com.mypackage1</exclude
                            <exclude>com.mypackage2</exclude>
                        </excludes>
                        <element>PACKAGE</element>
                        <limits>
                            <limit implementation="org.jacoco.report.check.Limit">
                                <counter>COMPLEXITY</counter>
                                <value>COVEREDRATIO</value>
                                <minimum>0.85</minimum>
                            </limit>
                        </limits>
                    </rule>
                </rules>
            </configuration>
        </execution>
    </executions>
</plugin>

请注意，我们"<element>PACKAGE</element>"在配置中使用，这有助于我们在软件包级别进行排除。

— 阿里吉特
source
我正在使用jacoco-maven-plugin：0.7.9。使用您的解决方案，它可以正确计算结果。但是，项目中的所有分类都显示在jacoco报告（index.html）中。是否可以在报告中显示插件已分析的内容，以便获得覆盖率的真实价值？
— aloplop85 '18年
3

https://github.com/jacoco/jacoco/issues/34

这些是我们拥有的类的不同符号：

  • VM名称：java / util / Map $ Entry
  • Java名称：java.util.Map $ Entry文件
  • 名称：java / util / Map $ Entry.class

代理参数，Ant任务和Maven准备代理目标

  • 包括：Java名称（VM名称也可以）
  • 排除：Java名称（VM名称也可以）
  • exclclassloader：Java名称

这些规范允许使用通配符*和？，其中*通配符可以使用任意数量的字符，甚至可以使用多个嵌套文件夹。

Maven报告目标

  • 包括：文件名
  • 排除：文件名

这些规范允许Ant Filespec像通配符*，**和？，其中*仅通配符是单个路径元素的一部分。

— cra6
source
3

使用sonar.coverage.exclusions属性。

mvn clean install -Dsonar.coverage.exclusions=**/*ToBeExcluded.java

这应将类别从覆盖率计算中排除。

— 用户名
source
2

您可以在jacoco插件的配置之外，在声纳属性中配置覆盖率排除：

...
<properties>
    ....
    <sonar.exclusions>
        **/generated/**/*,
        **/model/**/*
    </sonar.exclusions>
    <sonar.test.exclusions>
        src/test/**/*
    </sonar.test.exclusions>
    ....
    <sonar.java.coveragePlugin>jacoco</sonar.java.coveragePlugin>
    <sonar.jacoco.reportPath>${project.basedir}/../target/jacoco.exec</sonar.jacoco.reportPath>
    <sonar.coverage.exclusions>
        **/generated/**/*,
        **/model/**/*
    </sonar.coverage.exclusions>
    <jacoco.version>0.7.5.201505241946</jacoco.version>
    ....
</properties>
....

并记得从插件中删除排除设置

— 莱昂西奥
source
1

这是pom.xml文件中的工作示例。

    <plugin>
        <groupId>org.jacoco</groupId>
        <artifactId>jacoco-maven-plugin</artifactId>
        <version>${jacoco.version}</version>


        <executions>
            <execution>
                <id>prepare-agent</id>
                <goals>
                    <goal>prepare-agent</goal>
                </goals>
            </execution>
            <execution>
                <id>post-unit-test</id>
                <phase>test</phase>
                <goals>
                    <goal>report</goal>
                </goals>

            </execution>

            <execution>
                <id>default-check</id>
                <goals>
                    <goal>check</goal>
                </goals>

            </execution>
        </executions>
        <configuration>
            <dataFile>target/jacoco.exec</dataFile>
            <!-- Sets the output directory for the code coverage report. -->
            <outputDirectory>target/jacoco-ut</outputDirectory>
            <rules>
                <rule implementation="org.jacoco.maven.RuleConfiguration">
                    <element>PACKAGE</element>
                    <limits>
                        <limit implementation="org.jacoco.report.check.Limit">
                            <counter>COMPLEXITY</counter>
                            <value>COVEREDRATIO</value>
                            <minimum>0.00</minimum>
                        </limit>
                    </limits>
                </rule>
            </rules>
            <excludes>
                <exclude>com/pfj/fleet/dao/model/**/*</exclude>
            </excludes>
            <systemPropertyVariables>

                <jacoco-agent.destfile>target/jacoco.exec</jacoco-agent.destfile>
            </systemPropertyVariables>
        </configuration>
    </plugin>
— Divyanayan
source
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.