Multimodule Project Configuration + Sonar Code Coverage Report

[Fagner Fernandes]

Hi everyone,

Even after reading Jacoco Aggregate Report I'm still struggling to configure Jacoco with Maven Multimodule configuration and send all data to Sonar (7.7). I'm using Spring Boot with Spring Cloud.

Currently, I have this structure on my application:

Parent

 - commons-module

 - eureka-module

 - module-a

 - module-b

 - module-c

 - module-d

 - module-e

 - module-f

Under build section, I'm using this configuration (jacoco.version=0.8.4):

<plugin>

<groupId>org.jacoco</groupId>

<artifactId>jacoco-maven-plugin</artifactId>

<version>${jacoco.version}</version>

<executions>

<execution>

<id>default-prepare-agent</id>

<goals>

<goal>prepare-agent</goal>

</goals>

</execution>

<execution>

<id>default-report</id>

<goals>

<goal>report</goal>

</goals>

</execution>

<execution>

<id>default-check</id>

<goals>

<goal>check</goal>

</goals>

<configuration>

<rules>

<rule>

<element>BUNDLE</element>

<limits>

<limit>

<counter>COMPLEXITY</counter>

<value>COVEREDRATIO</value>

<minimum>0.60</minimum>

</limit>

</limits>

</rule>

</rules>

</configuration>

</execution>

</executions>

</plugin>

And after running mvn jacoco:report-aggregate, I get this result:

Element	Missed Instructions	Cov.	Missed Branches	Cov.
Total	0 of 0	n/a	0 of 0	n/a

So what I have done wrong?

[Evgeny Mandrikov]

Execution of

mvn jacoco:report-aggregate

results in execution of https://www.jacoco.org/jacoco/trunk/doc/report-aggregate-mojo.html for each module,

above documentation states:

The report is created from all modules this project depends on. From those projects class and source files as well as JaCoCo execution data files will be collected.

What refers to "dependencies" section of pom.xml

Unlikely that your "Parent" specifies "dependencies", so "target/site/jacoco-aggregate/" is empty as expected.

If your "module-a" for example has "commons-module" in its dependencies, then expect that "module-a/target/site/jacoco-aggregate" is not empty.

"report-aggregate" is not intended to be triggered from command-line, but to be declared in a dedicated module and bound to same phase - for example

https://github.com/jacoco/jacoco/blob/v0.8.4/jacoco-maven-plugin.test/it/it-report-aggregate/report/pom.xml#L25-L62

or

https://github.com/jacoco/jacoco/blob/v0.8.4/org.jacoco.doc/pom.xml#L121-L145

or

https://stackoverflow.com/questions/41885772/jacoco-simple-integration-test-solution/41901853#41901853

[Fagner Fernandes]

Evgeny,

Thanks for your reply, it helped me a lot.

So I needed to add my modules in my parent project as dependencies so this way report-aggregate can invoke jacoco.exe in each module and append on a single site, right?

But if I need to excludes some classes from Jacoco's analysis I need to declare theses exclusions on my parent's pom or each one of my modules?

Thanks again in advance.

[Evgeny Mandrikov]

On Monday, May 20, 2019 at 1:38:47 PM UTC+2, Fagner Fernandes wrote:

Evgeny,

Thanks for your reply, it helped me a lot.

So I needed to add my modules in my parent project as dependencies so this way report-aggregate can invoke jacoco.exe in each module and append on a single site, right?

Have you tried to look at any of the provided examples??

Parent is not touched in all of them,

instead they all have a dedicated module for generation of aggregated coverage report,

where report-aggregate is bound to some phase such as "package"

and so will be executed during execution of "mvn package" or "mvn verify".

And this is exactly what was already advised in my previous email:

"report-aggregate" is not intended to be triggered from command-line, but to be declared in a dedicated module and bound to same phase

Because dependency of parent on its children looks incredibly weird, not even sure that it works.

But if I need to excludes some classes from Jacoco's analysis I need to declare theses exclusions on my parent's pom or each one of my modules?

If you want to exclude classes from being shown in report generated by "report-aggregate", then in the configuration for "report-aggregate" - https://www.jacoco.org/jacoco/trunk/doc/report-aggregate-mojo.html#excludes

If you want to exclude classes from being shown in report generated by "report", then in the configuration for "report" - https://www.jacoco.org/jacoco/trunk/doc/report-mojo.html#excludes

[Fagner Fernandes]

Yes, I looked at examples you told me earlier but not deeply (time constraint is real pain sometimes).

Sorry, I took the wrong approach to solve my problem because when I looked at this example (https://github.com/jacoco/jacoco/blob/v0.8.4/jacoco-maven-plugin.test/it/it-report-aggregate/report/pom.xml#L25-L62) I saw this pom's file as a parent instead of dedicated testing module.

In my defense I tried to solve this way since when Jenkins triggers the build, it executes jacoco from maven plugin command line (i,e,: mvn clean package jacoco:report-aggregate sonar:sonar) and sends reports to Sonar.

And dependency on parent it's really weird since it's other way around.

I'll refactor my project's structure and use a dedicated module test to solve all this mess.