10

I've integrated the jacoco-maven-plugin in my project, based on this excellent guide: http://www.petrikainulainen.net/programming/maven/creating-code-coverage-reports-for-unit-and-integration-tests-with-the-jacoco-maven-plugin/

The Jacoco plugin runs fine. However, the maven-site-plugin does not include the Jacoco reports in the site. To be more specific: the 'Project Reports' section does not list the Jacoco reports. The Jacoco reports themselves are available in the target/site/jacoco-ut and target/site/jacoco-it directories.

Here's what I did (without success so far).

First, included the jacoco-maven-plugin as a plugin in the build section of my pom.xml, as explained in the guide referenced above. I'm using Jacoco version 0.6.4.201312101107.

<plugin>
  <groupId>org.jacoco</groupId>
  <artifactId>jacoco-maven-plugin</artifactId>
  <version>${jacoco.plugin.version}</version>
  <executions>
    <!-- scissors... -->
    <!-- report goal is bound to the pre-site phase -->
  </executions>
</plugin>

Second, included the jacoco-maven-plugin in the report section of my pom.xml: no success.

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

Third, tried to add a reportsets section to the jacoco-maven-plugin in the report section: no success.

<plugin>
  <groupId>org.jacoco</groupId>
  <artifactId>jacoco-maven-plugin</artifactId>
  <version>${jacoco.plugin.version}</version>
  <reportSets>
    <reportSet>
      <reports>
        <report>report</report>
      </reports>
    </reportSet>
  </reportSets>
</plugin>

Can anyone help me to make the maven-site-plugin reference the coverage reports generated by Jacoco in the 'Project Reports' section of the site?

Lii
  • 11,553
  • 8
  • 64
  • 88
Kristel
  • 163
  • 1
  • 1
  • 10

2 Answers2

4

I've found jacoco to be very tricky, the below config worked for me, i put it together from bits and pieces from blogs in the properties

<jacoco.reportPath>${main.basedir}/target/jacoco.exec</jacoco.reportPath>
    <jacoco.itReportPath>${main.basedir}/target/jacoco-it.exec</jacoco.itReportPath>

inside the build

<plugin>
                <groupId>org.jacoco</groupId>
                <artifactId>jacoco-maven-plugin</artifactId>
                <version>0.6.4.201312101107</version>
                <executions>
                    <execution>
                        <id>pre-unit-test</id>
                        <goals>
                            <goal>prepare-agent</goal>
                        </goals>
                        <configuration>
                            <destFile>${sonar.jacoco.reportPath}</destFile>
                            <propertyName>utCoverageAgent</propertyName>
                        </configuration>
                    </execution>
                    <execution>
                        <id>post-unit-test</id>
                        <phase>test</phase>
                        <goals>
                            <goal>report</goal>
                        </goals>
                        <configuration>
                            <dataFile>${sonar.jacoco.reportPath}</dataFile>
                        </configuration>
                    </execution>
                    <!-- prepare agent for measuring integration tests -->
                    <execution>
                        <id>agent</id>
                        <phase>pre-integration-test</phase>
                        <goals>
                            <goal>prepare-agent</goal>
                        </goals>
                        <configuration>
                            <destFile>${sonar.jacoco.itReportPath}</destFile>
                            <propertyName>itCoverageAgent</propertyName>
                        </configuration>
                    </execution>
                    <execution>
                        <id>jacoco-site</id>
                        <phase>post-integration-test</phase>
                        <goals>
                            <goal>report</goal>
                        </goals>
                        <configuration>
                            <dataFile>${sonar.jacoco.itReportPath}</dataFile>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

       <!-- Reporting plugins -->
        <plugin>
            <artifactId>maven-site-plugin</artifactId>
            <version>${plugin.site.version}</version>
            <configuration>
                <attach>true</attach>
                <reportPlugins>
                    <plugin>
                        <groupId>org.apache.maven.plugins</groupId>
                        <artifactId>maven-changelog-plugin</artifactId>
                        <version>2.2</version>
                        <configuration>
                            <type>range</type>
                            <range>1</range>
                            <!--<displayFileDetailUrl>${project.scm.url}/tree/master/%FILE%</displayFileDetailUrl>-->
                            <headingDateFormat>MM-dd-yyyy</headingDateFormat>
                            <outputEncoding>${project.reporting.outputEncoding}</outputEncoding>

                        </configuration>
                        <reports>
                            <report>changelog</report>
                        </reports>
                    </plugin>
                    <plugin>
                        <groupId>org.apache.maven.plugins</groupId>
                        <artifactId>maven-project-info-reports-plugin</artifactId>
                        <version>2.7</version>
                        <configuration>
                            <dependencyDetailsEnabled>false</dependencyDetailsEnabled>
                            <dependencyLocationsEnabled>false</dependencyLocationsEnabled>
                        </configuration>
                        <!-- simpler configuration without reportSets available for usual cases -->
                        <!-- distribution-management, index, dependencies, help, issue-tracking, plugins, cim,
                        license, dependency-management, mailing-list, project-team, dependency-convergence,
                        scm, plugin-management, modules, summary -->
                        <reports>
                            <report>index</report>
                            <report>dependencies</report>
                            <report>issue-tracking</report>
                            <report>scm</report>
                            <report>summary</report>
                        </reports>
                    </plugin>
                    <plugin>
                        <groupId>org.apache.maven.plugins</groupId>
                        <artifactId>maven-jxr-plugin</artifactId>
                        <version>2.4</version>
                        <configuration>
                            <aggregate>true</aggregate>
                        </configuration>
                    </plugin>
                    <plugin>
                        <groupId>org.apache.maven.plugins</groupId>
                        <artifactId>maven-javadoc-plugin</artifactId>
                        <version>2.9.1</version>
                            <reports>
                                <report>javadoc</report>
                                <report>aggregate</report>
                            </reports>
                        <configuration>
                            <failOnError>false</failOnError>
                        </configuration>
                    </plugin>

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

                </reportPlugins>
            </configuration>
            <executions>
                <execution>
                    <id>attach-descriptor</id>
                    <goals>
                        <goal>attach-descriptor</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>

Hope that helps !

GMelo
  • 229
  • 1
  • 16
  • as of mvn 3.0.4 you can't use the configuration->reportPlugins tag of the maven-site-plugin anymore. http://maven.apache.org/plugins/maven-site-plugin/maven-3.html#Configuration_formats – Adam Jul 25 '14 at 14:37
0

What I did was merge the two execution files (jacoco-ut.exec and jacoco-it.exec) into a single file named jacoco.exec and then set that file as the dataFile of the plugin.

First, let's define these properties:

<jacoco.it.execution.data.file>${project.build.directory}/coverage-reports/jacoco-it.exec</jacoco.it.execution.data.file>
<jacoco.ut.execution.data.file>${project.build.directory}/coverage-reports/jacoco-ut.exec</jacoco.ut.execution.data.file>
<jacoco.execution.data.file>${project.build.directory}/coverage-reports/jacoco.exec</jacoco.execution.data.file>

Then, along with the configuration to generate the reports, include this snippet to create the merged file:

<plugin>
    <groupId>org.jacoco</groupId>
    <artifactId>jacoco-maven-plugin</artifactId>
    <version>${jacoco-plugin.version}</version>
    <executions>
        ...
        <execution>
            <id>merge</id>
            <phase>verify</phase>
            <goals>
                <goal>merge</goal>
            </goals>
            <configuration>
                <fileSets>
                    <fileSet>
                        <directory>${project.build.directory}/coverage-reports</directory>
                        <includes>
                            <include>*.exec</include>
                        </includes>
                    </fileSet>
                </fileSets>
                <destFile>${jacoco.execution.data.file}</destFile>
            </configuration>
        </execution>
        <execution>
            <id>report-merge</id>
            <phase>verify</phase>
            <goals>
                <goal>report</goal>
            </goals>
            <configuration>
                <dataFile>${jacoco.execution.data.file}</dataFile>
            </configuration>
        </execution>
    </executions>
</plugin>

And, finally, configure the plugin in the reporting section to generate the report from that merged file:

<reporting>
    <plugins>
        <plugin>
            <groupId>org.jacoco</groupId>
            <artifactId>jacoco-maven-plugin</artifactId>
            <configuration>
                <dataFile>${jacoco.execution.data.file}</dataFile>
            </configuration>
            <reportSets>
                <reportSet>
                    <reports>
                        <report>report</report>
                    </reports>
                </reportSet>
            </reportSets>
        </plugin>
        ...
    </plugins>
</reporting>
flags
  • 461
  • 5
  • 11