Jacoco Maven多模块项目覆盖范围

时间:2015-10-12 10:21:37

标签: java html report jacoco jacoco-maven-plugin

似乎有几个问题,这些问题相当陈旧,并且从Jacoco的Java 8支持中改变了一些问题。

我的项目包含以下结构

pom.xml
|
|
-----sub module A pom.xml
|
|
-----sub module B pom.xml
|
|
-----sub module C pom.xml

我已经像这样配置了main pom

主要POM.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.test</groupId>
    <artifactId>jacoco-multi</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>pom</packaging>
    <modules>
        <module>projectA</module>
        <module>projectB</module>
    </modules>

    <properties>
        <jacoco.version>0.5.7.201204190339</jacoco.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit-dep</artifactId>
            <version>4.10</version>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.hamcrest</groupId>
                    <artifactId>hamcrest-core</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

        <dependency>
            <groupId>org.hamcrest</groupId>
            <artifactId>hamcrest-core</artifactId>
            <version>1.3.RC2</version>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>org.hamcrest</groupId>
            <artifactId>hamcrest-library</artifactId>
            <version>1.3.RC2</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.jacoco</groupId>
                <artifactId>jacoco-maven-plugin</artifactId>
                <version>0.7.5.201505241946</version>
                <configuration>
                    <destFile>${project.basedir}/../target/jacoco.exec</destFile>
                    <append>true</append>
                </configuration>
                <executions>
                    <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>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-failsafe-plugin</artifactId>
                <version>2.16</version>
                <executions>
                    <execution>
                        <id>default-integration-test</id>
                        <goals>
                            <goal>integration-test</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>2.16</version>
            </plugin>
        </plugins>
    </build>

</project>

Pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <artifactId>jacoco-multi</artifactId>
        <groupId>com.test</groupId>
        <version>0.0.1-SNAPSHOT</version>
        <relativePath>..</relativePath>
    </parent>
    <artifactId>projectA</artifactId>

    <build>
        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-surefire-plugin</artifactId>
                    <version>2.12</version>
                </plugin>

            </plugins>
        </pluginManagement>
    </build>

</project>

B pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
    <artifactId>jacoco-multi</artifactId>
    <groupId>com.test</groupId>
    <version>0.0.1-SNAPSHOT</version>
    <relativePath>..</relativePath>
</parent>
<artifactId>projectB</artifactId>

<dependencies>
    <dependency>
        <groupId>com.test</groupId>
        <artifactId>projectA</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </dependency>
</dependencies>

<build>
    <pluginManagement>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>2.12</version>
            </plugin>
        </plugins>
    </pluginManagement>
</build>

我正在执行此命令mvn clean package。我可以看到jacoco.exec正在生成,但是我无法看到任何HTML报告正在验证数据。

请帮我解决这个问题。 另一点是,我的配置对于Multi-Module项目是否正确?

更新

确定问题。  <destFile>${project.basedir}/../target/jacoco.exec</destFile> 变成 <destFile>${project.basedir}/target/jacoco.exec</destFile>

现在它正在为各个模块生成报告。 知道如何生成合并报告

6 个答案:

答案 0 :(得分:7)

JaCoCo版本0.7.7可通过新目标jacoco:report-aggregate从多个Maven模块中generate an aggregate coverage report

答案 1 :(得分:2)

将文章的代码末尾复制到https://dzone.com/articles/jacoco-maven-multi-module并将其放入....适合我。只需添加您想要报告的模块。此外,我需要将antrun从1.7更改为1.8才能运行ant任务。

答案 2 :(得分:1)

运行覆盖作为...的Junit用于单独各模块。然后创建一个启动组,每次添加的运行配置。有一个弹出的“启动模式”的选项继承,档案,保险,调试或运行。选择覆盖面为所有的人。您可能还需要选择“等待,直到结束。”

您现在可以在点击运行所有的覆盖测试。之后,他们完成,你需要进入的行业评级,并选择合并会话(双红/绿条),并将它们全部合并成一个报告。

答案 3 :(得分:0)

如果聚合器pom用作模块的父pom,则会导致多模块项目中的一个问题,就像上例中的情况一样:

- parentAggregator pom
---sub module A pom.xml -> parentAggregator pom
---sub module B pom.xml -> parentAggregator pom
---sub module C pom.xml -> parentAggregator pom

在这种情况下,构建顺序为:

- parentAggregator
- sub module A
- sub module B
- sub module C

表示父聚合器无法收集完整信息。在我的情况下,mvn声纳:sonar将数据传输到sonarQube会导致意外和不完整的结果。

将模块结构更改为:

- aggregator pom
-- parent pom
---sub module A pom.xml -> parent pom
---sub module B pom.xml -> parent pom
---sub module C pom.xml -> parent pom

会将构建顺序更改为:

- parent
- sub module A
- sub module B
- sub module C
- aggregator

在这种情况下,聚合器将是最后一个并使用模块的结果。就我而言,SonarQube的结果与预期的一样。

答案 4 :(得分:0)

在扫描了许多解决方案后,我创建了一个简单但完整的 Jacoco 演示项目,显示:

  • 多模块项目
  • 单元测试(通过mvn clean install)
  • 集成测试(通过mvn clean install -P integration-test)
  • Jacoco - 测试覆盖率(聚合数据文件和汇总报告)
  • FindBugs - 代码质量

享受simple demo project

答案 5 :(得分:0)

遵循以下说明

  1. 创建一个新的子项目。这将用作报表聚合器。 父pom会像这样:

<modules>
        <module>A</module>
        <module>B</module>
        <module>C</module>
        <module>ReportAggregator</module>
    </modules>

  1. 在聚合器分支pom中,添加其他子项目依赖项。

<dependency>
            <groupId>xyz</groupId>
            <artifactId>A</artifactId>
            <version>${project.version}</version>
        </dependency>

  1. 在聚合器分支pom中-配置jacoco插件

<plugin>
                <groupId>org.jacoco</groupId>
                <artifactId>jacoco-maven-plugin</artifactId>
                <version>0.8.6</version>
                <executions>
                    <execution>
                        <goals>
                            <goal>prepare-agent</goal>
                        </goals>
                    </execution>
                    <execution>
                        <id>report-aggregate</id>
                        <phase>verify</phase>
                        <goals>
                            <goal>report-aggregate</goal>
                        </goals>
                        <configuration>
                            <dataFileIncludes>
                                <dataFileInclude>**/jacoco.exec</dataFileInclude>
                            </dataFileIncludes>
                            <outputDirectory>${project.reporting.outputDirectory}/jacoco-aggregate</outputDirectory>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

  1. 在聚合器分支pom中,将surefire插件配置为

<plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>3.0.0-M5</version>
                <configuration>
                    <systemPropertyVariables>
                        <jacoco-agent.destfile>**/jacoco.exec</jacoco-agent.destfile>
                    </systemPropertyVariables>
                </configuration>
            </plugin>

  1. (可选步骤)如果有人面临警告/错误,例如: 捆绑' *'中的类与执行数据不匹配。为了生成报告,必须使用与运行时相同的类文件。**

然后在聚合器分支pom中添加以下提到的行

 <plugin>
                <groupId>org.jacoco</groupId>
                <artifactId>jacoco-maven-plugin</artifactId>
                <version>0.8.6</version>
                <executions>
                    <execution>
                        <id>instrument-ut</id>
                        <goals>
                            <goal>instrument</goal>
                        </goals>
                    </execution>
                    <execution>
                        <id>restore-ut</id>
                        <goals>
                            <goal>restore-instrumented-classes</goal>
                        </goals>
                    </execution>
                    <execution>
                        <goals>
                            <goal>prepare-agent</goal>
                        </goals>
                    </execution>
                    <execution>
                        <id>report-aggregate</id>
                        <phase>verify</phase>
                        <goals>
                            <goal>report-aggregate</goal>
                        </goals>
                        <configuration>
                            <dataFileIncludes>
                                <dataFileInclude>**/jacoco.exec</dataFileInclude>
                            </dataFileIncludes>
                            <outputDirectory>${project.reporting.outputDirectory}/jacoco-aggregate</outputDirectory>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

  1. 运行mvn clean install