Description / Feature
Get code coverage for Java project with This plugin is included in the Java Ecosystem.
It provides the ability to feed SonarQube with code coverage data coming from JaCoCo (an open source and robust Java code coverage tool, developed by the authors of EclEmma). For For more information, see: Comparison of Emma, Clover, Cobertura and JaCoCo.
JaCoCo SonarQube Java Plugin
Reports generated with JaCoCo
- Install the JaCoCo plugin through the Update Center or download it into the SONAR_HOME/extensions/plugins directory from the Java Ecosystem page.
- Restart the Sonar server
To launch JaCoCo as part of your Maven build, use this command:
mvn clean org.jacoco:jacoco-maven-plugin:prepare-agent install -Dmaven.test.failure.ignore=true
For more on JaCoCo, see its documentation.
You may also find the README.md of the sample project helpful.
- Some libraries complain on classes, which were instrumented by JaCoCo, so exclusions must be set:
- Javassist (e.g. when Hibernate used) - "*_javassist_*"
- Drools - "org.drools.*"
- The exact number of line hits is not available, because JaCoCo reports only status of line (no code, not covered, partly covered, fully covered) - see JaCoCo Coverage Counters.
If your project uses the
argLine property to configure the surefire-maven-plugin, be sure that
argLine defined as a
property, rather than as part of the plugin configuration. Doing so will allow JaCoCo to set its agent properly. Otherwise the JVM may crash while tests are running.
argLine should be defined this way:
<properties> <argLine>-Xmx128m</argLine> </properties> ... <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-plugin</artifactId> <configuration> <runOrder>random</runOrder> </configuration> </plugin>
Force coverage to 0%
By default, when no coverage report is found, the JaCoCo plugin will not set any value for coverage metric. This behaviour can be overriden to force coverage to 0% in case of a lack of report by setting the following property :
Coverage per test
Using some unit test listeners you can collect the information on which lines where covered by which tests and display them in SonarQube. See the pom.xml of the sample project to configure this and see the Component Viewer documentation to display this information in SonarQube.