I have a Maven multi module project where the JaCoCo is not generating reports based on the source files.
Generally, if MyService
is the class under test, it would be reported in two ways, one through a file name MyService.html
in appropriate package based location with a list of methods giving an overall picture of the coverage in numbers and graphs - with listing of all the methods in the class and each method has a clickable link to another html MyService.java.html
which contains the source code with red/green/yellow background to display coverage status.
In my scenario, only MyService.html
is generated and not the MyService.java.html
and methods are listed in the former with coverage details, but without hyperlinks to the other report as displayed below.
Issue gets more interesting here that my Maven configuration is not configured in this module, but in a parent module and other child modules are able to generate reports properly. Below is the maven plugin configuration for reference.
Parent POM:
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<version>${jacoco.version}</version>
<configuration>
<destFile>${project.basedir}/target/jacoco-unit.exec</destFile>
<dataFile>${project.basedir}/target/jacoco-unit.exec</dataFile>
<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>
Child POM:
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
</plugin>
Tried switching JaCoCo versions, but none helped, now sticking to the latest 0.8.2. And Maven is latest - 3.6.0. Apart from this, the other plugin configured in the child pom is PMD - whose presence or absence did not make any difference to report.
Similar issue: Gradle JaCoCo plugin - class and method names not clickable in report
Why does the coverage report not show highlighted source code? Make sure the following prerequisites are fulfilled to get source code highlighting in JaCoCo coverage reports: Class files must be compiled with debug information to contain line numbers. Source files must be properly supplied at report generation time.
Step 4: To get you code coverage report navigate to the target > site > jacoco > index.
JaCoCo vs SonarQube: What are the differences? JaCoCo: A code coverage library for Java. It is a free code coverage library for Java, which has been created based on the lessons learned from using and integration existing libraries for many years; SonarQube: Continuous Code Quality.
In absence of Minimal, Complete, and Verifiable example that fully demonstrates steps to reproduce your difficulty, can only quote JaCoCo FAQ :
Why does the coverage report not show highlighted source code?
Make sure the following prerequisites are fulfilled to get source code highlighting in JaCoCo coverage reports:
- Class files must be compiled with debug information to contain line numbers.
- Source files must be properly supplied at report generation time.
About first point see -g
option of javac
, debug
and debuglevel
options of maven-compiler-plugin.
For the second point make sure that source file Example.java
with
package org.example;
is located in src/main/java/org/example/Example.java
Thank you! @Godin
It is also important to make sure you specify the SourceDirectory
. In my case - working against Groovy
Source Files, for detailed coverage you should specify the child Maven
structure as follows:
<build>
<sourceDirectory>src/main/groovy</sourceDirectory>
<plugins> ... </plugins>
</build>
This was a combination of the issues in my case. The source Directory and the Compile with Debug option. Thanks again.
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With