Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
iconfalse
titleTable of Contents

Table of Contents
maxLevel2

There are two different ways to feed Sonar SonarQube with information on unit tests execution and code coverage:

  • Using Reusing existing reports that have been previously generated by external tools.
  • Use its embedded engine (Deprecated) to let Sonar directly launch SonarQube launch the unit tests execution test and code coverage execution directly. Then, the analyzer will automatically fed feed the database with data exported from the generated reports. Reusing existing reports that have been previously generated by external tools.This mode will be removed starting at version 2.2 of the Java plugin.

Project samples covering the different cases below are available on github that can be browsed or downloadedprojects/languages/java/code-coverage/

See Resource Viewer Component Viewer on Unit TestsTest File or Quality Flows > Lack of Unit Tests to browse the results on in the Sonar web interface.

Using Sonar Embedded Engine

Maven supports this mode with the following code coverage tools: JaCoCo, Cobertura, Emma and Clover.

The Sonar Ant Task and the Sonar Runner do not support this mode.

Note
titleCompile

Before running a Sonar analysis with JaCoCo set as the code coverage tool, the source code has to be compiled.

 

First, tell Sonar to execute the unit tests and the code coverage tool:

With Maven in your pom file:

Code Block
languagehtml/xml
<sonar.dynamicAnalysis>true</sonar.dynamicAnalysis>

Maven Project

With Maven, then, you just have to tell Sonar which code coverage engine you wish to use: jacoco or cobertura or emma or clover.

Code Block
languagehtml/xml
<sonar.java.coveragePlugin>jacoco or cobertura or emma or clover</sonar.java.coveragePlugin>
 
Prior to Sonar 3.4, the property was sonar.core.codeCoveragePlugin.

Note that this property can be set at Sonar instance level through the web interface: Settings > Configuration > General Settings > Java.

Sample projects are available on github that can be browsed or downloaded:

  • Maven and JaCoCo: projects/code-coverage/ut/maven/ut-maven-jacoco-runTests
  • Maven and Cobertura: projects/code-coverage/ut/maven/ut-maven-cobertura-runTests
  • Maven and Emma: projects/code-coverage/ut/maven/ut-maven-emma-runTests

Maven Multi-module Project and JaCoCo

For multi-module Maven projects, compute overall code coverage by unit tests across modules. This case clearly lies between unit tests and integration tests but this is widely used.

Sample projects are available on github that can be browsed or downloaded: projects/code-coverage/combined ut-it/maven/combined-ut-it-multimodule-maven-jacoco

Reusing Existing Reports

...

Reusing Existing Reports

Every analyzer supports the reuse reports mode.

To be reused by Sonarby SonarQube:

  • The tests execution reports have to comply to the JUnit XML format.
  • The code coverage reports have to be generated by either by JaCoCo, Emma,  Cobertura or Clover.
Sample projects are available on github that can be browsed or downloaded:

...

First, tell SonarQube to reuse existing reports:

With Maven in your pom.xml file:

...

Code Block
languagehtml/xml
<property name="sonar.dynamicAnalysis" value="reuseReports" />

With Sonar Runner SonarQube Runner in your your sonar-project.properties file file:

Code Block
languagehtml/xml
sonar.dynamicAnalysis=reuseReports

Test Execution Reports

Tell Sonar where Tell SonarQube where your unit tests execution reports are: absolute or relative path to the directory containing your reports

...

Code Block
languagehtml/xml
<sonar.surefirejunit.reportsPath>[baseDir]/myReports/myExecutionReports</sonar.surefirejunit.reportsPath>

With Ant in your build file:

Code Block
languagehtml/xml
<property name="sonar.surefirejunit.reportsPath" value="[baseDir]/myReports/myExecutionReports" />

With Sonar SonarQube Runner in your your sonar-project file.properties file:

Code Block
languagehtml/xml
sonar.surefirejunit.reportsPath=[baseDir]/myReports/myExecutionReports

Code Coverage Report 

First, tell Sonar which tell SonarQube which code coverage engine has been used to generate the reports: jacoco or cobertura or emma or , cobertura or clover.

Code Block
languagehtml/xml
<sonar.java.coveragePlugin>jacoco or| cobertura or| emma or clover</sonar.java.coveragePlugin>
 
Prior to Sonar 3.4, the property was sonar.core.codeCoveragePlugin.

Then, tell Sonar SonarQube where to get the code coverage reports:.

With Maven in your pom file:

Code Block
languagehtml/xml
<sonar.jacoco.reportPath>[baseDir]/myReports/myCodeCoverageReport</sonar.jacoco.reportPath>

...

Code Block
languagehtml/xml
<property name="sonar.jacoco.reportPath" value="[baseDir]/myReports/myCodeCoverageReport" />

With Sonar Runner SonarQube Runner in your your sonar-project file.properties file:

Code Block
languagehtml/xml
sonar.jacoco.reportPath=[baseDir]/myReports/myCodeCoverageReport

Depending on the code coverage tool you used to generate your report, replace jacoco by emmacoberturaby cobertura or clover in the property name.

Using SonarQube Embedded Engine

Maven supports this mode with the following code coverage tools: JaCoCo, Cobertura and Clover.

The SonarQube Ant Task and the SonarQube Runner do not support this mode.

Note
titleCompile

Before running an analysis with JaCoCo, the source code has to be compiled.

First, tell SonarQube to execute the unit tests and the code coverage tool:

Add this to your pom file:

Code Block
languagehtml/xml
<sonar.dynamicAnalysis>true</sonar.dynamicAnalysis>

Maven Project

With Maven, then, you just have to tell SonarQube which code coverage engine you wish to use: jacoco or cobertura or clover.

Code Block
languagehtml/xml
<sonar.java.coveragePlugin>jacoco | cobertura | clover</sonar.java.coveragePlugin>

Note that this property can be set at the SonarQube instance level through the web interface: Settings > Configuration > General Settings > Java.

Sample projects are available on github that can be browsed or downloaded:

See also the Manage Code Coverage by Unit Tests with Sonar blog post.

  • Maven and JaCoCo: 

...

  • projects/code-coverage/ut/maven/ut-maven-jacoco-runTests
  • Maven and Cobertura: projects/code-coverage/ut/maven/ut-maven-cobertura-runTests

Maven Multi-module Project and JaCoCo

For multi-module Maven projects, compute overall code coverage by unit tests across modules. This case clearly lies between unit tests and integration tests but this is widely used.

Sample projects are available on github that can be browsed or downloadedprojects/code-coverage/combined ut-it/maven/combined-ut-it-multimodule-maven-jacoco

Note that this project structure is not compatible with the below feature: mapping of unit tests and covered code.

Anchor
mappingUnitTest
mappingUnitTest

 

Mapping of Unit Tests and Covered Code

The objective is to answer the following questions:

  • Which files are covered by a given unit test?
  • How many lines of code are covered by a given unit test?
  • Which lines are covered by a given unit test?
  • Which tests cover a given line of code?

See Component Viewer on Unit Test File for more details.

A sample project is available on github that can be browsed or downloadedprojects/code-coverage/ut/maven/ut-maven-jacoco-runTests. What you need to add to your pom.xml to get this behavior is contained between "BEGIN/END: Specific to mapping unit tests and covered code" tags in the pom file. Note that you have to run the analysis with the coverage-per-test profile. Read the README file for more information.

Requires:

  • JUnit 4.7+
  • Maven Surefire Plugin 2.4+ 

This feature is only available while using JaCoCo as the code coverage tool.

FAQ

0% code coverage reported, but unit tests are correctly executed

This problem occurs while using the Maven Cobertura Plugin and a special configuration of the Maven Surefire Plugin prevents the unit tests from being forked. This problem can be solved by removing the line "<forkMode>never</forkMode>" in the Maven configuration file (see SONAR-1445 and MCOBERTURA-70).

java.lang.Error: Unable to access JaCoCo Agent - make sure that you use JaCoCo and version not lower than 0.6.2

There can be several reasons for this error:
  • Make sure that you do NOT set 'forkMode' to 'never' on the Surefire plugin - otherwise it will not fork the process and no JaCoCo agent will be attached.
Code Block
titlepom.xml
languagehtml/xml
...
<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-surefire-plugin</artifactId>
  <version>2.4.2</version>
  <configuration>
    <forkMode>never</forkMode> <!-- Do not set forkMode to never -->
    <reportFormat>xml</reportFormat>
    <testFailureIgnore>true</testFailureIgnore>
  </configuration>
</plugin>
...

 

  • Make sure that you call first mvn clean install and then mvn sonar:sonar Pcoverage-per-test separately. Indeed, only SonarQube can attach the JaCoCo agent, so mvn clean install sonar:sonar -Pcoverage-per-test will produce the error because the test phase will be executed a first time alone.