SonarQube not picking up Unit Test Coverage

Question

I am having issues with sonar picking up the jacoco analysis report  Jenkins however is able to pick up the report and display the results  My project is a maven build  built by Jenkins  The jacoco report is generated by maven  configured in the pom   Sonar is executed by using the Jenkins plugin   This is what I see on SonarQube     This is the report i can see of the project in jenkins     The maven plugin config    lt plugin gt       lt groupId gt org jacoco lt  groupId gt       lt artifactId gt jacoco-maven-plugin lt  artifactId gt       lt version gt 0 6 4 201312101107 lt  version gt       lt executions gt         lt execution gt           lt id gt default-prepare-agent lt  id gt           lt goals gt               lt goal gt prepare-agent lt  goal gt           lt  goals gt         lt  execution gt         lt execution gt           lt id gt default-report lt  id gt           lt phase gt prepare-package lt  phase gt           lt goals gt               lt goal gt report lt  goal gt           lt  goals gt         lt  execution gt         lt execution gt             lt id gt default-check lt  id gt             lt goals gt                 lt goal gt check lt  goal gt             lt  goals gt         lt  execution gt       lt  executions gt   lt  plugin gt    Jenkins Sonar Plugin config

User · Accepted Answer

You were missing a few important sonar properties, Here is a sample from one of my builds:

sonar.jdbc.dialect=mssql
sonar.projectKey=projectname
sonar.projectName=Project Name
sonar.projectVersion=1.0
sonar.sources=src
sonar.language=java
sonar.binaries=build/classes
sonar.tests=junit
sonar.dynamicAnalysis=reuseReports
sonar.junit.reportsPath=build/test-reports
sonar.java.coveragePlugin=jacoco
sonar.jacoco.reportPath=build/test-reports/jacoco.exec

The error in Jenkins console output can be pretty useful for getting code coverage to work.

Project coverage is set to 0% since there is no directories with classes.
Indicates that you have not set the Sonar.Binaries property correctly

No information about coverage per test
Indicates you have not set the Sonar.Tests property properly

Coverage information was not collected. Perhaps you forget to include debug information into compiled classes? Indicates that the sonar.binaries property was set correctly, but those files were not compiled in debug mode, and they need to be

User · Answer

Include the sunfire and jacoco plugins in the pom xml and  Run the maven command as given below   mvn jacoco prepare-agent jacoco report sonar sonar   lt properties gt       lt surefire version gt 2 17 lt  surefire version gt       lt jacoco version gt 0 7 2 201409121644 lt  jacoco version gt       lt plugin gt               lt groupId gt org apache maven plugins lt  groupId gt               lt artifactId gt maven-surefire-plugin lt  artifactId gt               lt version gt   surefire version  lt  version gt           lt  plugin gt             lt plugin gt               lt groupId gt org jacoco lt  groupId gt               lt artifactId gt jacoco-maven-plugin lt  artifactId gt               lt version gt   jacoco version  lt  version gt                lt executions gt                   lt execution gt                       lt id gt default-prepare-agent lt  id gt                       lt goals gt  lt goal gt prepare-agent lt  goal gt  lt  goals gt                   lt  execution gt                   lt execution gt                       lt id gt default-report lt  id gt                       lt phase gt prepare-package lt  phase gt                       lt goals gt  lt goal gt report lt  goal gt  lt  goals gt                   lt  execution gt               lt  executions gt           lt  plugin gt       lt  plugins gt

User · Answer

I was facing the same problem and the challenge in my case was to configure Jacoco correctly and to configure the right parameters for Sonar  I will briefly explain  how I finally got SonarQube to display the test results and test coverage correctly    In your project you need the Jacoco plugin in your pom or parent pom  you already got this   Moreover  you need the maven-surefire-plugin  which is used to display test results  All test reports are automatically generated when you run the maven build  The tricky part is to find the right parameters for Sonar  Not all parameters seem to work with regular expressions and you have to use a comma separated list for those  documentation is not really good in my opinion   Here is the list of parameters I have used  I used them from Bamboo  you might omit the  -D  if you use a sonar properties file    -Dsonar branch target master  in newer version of SQ I had to remove this  so that master branch is analyzed correctly  I used auto branch checkbox in bamboo instead  -Dsonar working directory   target sonar -Dsonar java binaries    target classes -Dsonar sources   service-a src   service-b src   service-c src      -Dsonar exclusions    data dto    -Dsonar tests   -Dsonar test inclusions     Test java  - gt  all your tests have to end with  Test   -Dsonar junit reportPaths   service-a target surefire-reports   service-b target surefire-reports    service-c target surefire-reports      -Dsonar jacoco reportPaths   service-a target jacoco exec   service-b target jacoco exec    service-c target jacoco exec      -Dsonar projectVersion   bamboo buildNumber  -Dsonar coverage exclusions    src test       common    -Dsonar cpd exclusions     Dto java     Entity java    common      If you are using Lombok in your project  than you also need a lombok config file to get the correct code coverage  The lombok config file is located in the root directory of your project with the following content   config stopBubbling   true lombok addLombokGeneratedAnnotation   true

User · Answer

Based on https   github com SonarSource sonar-examples blob master projects tycho pom xml  the following POM works for me    lt properties gt       lt sonar core codeCoveragePlugin gt jacoco lt  sonar core codeCoveragePlugin gt       lt sonar dynamicAnalysis gt reuseReports lt  sonar dynamicAnalysis gt       lt sonar jacoco reportPath gt   project basedir     target jacoco exec lt  sonar jacoco reportPath gt   lt  properties gt   lt build gt       lt plugins gt           lt plugin gt               lt groupId gt org jacoco lt  groupId gt               lt artifactId gt jacoco-maven-plugin lt  artifactId gt               lt version gt 0 7 0 201403182114 lt  version gt               lt executions gt                   lt execution gt                       lt goals gt                           lt goal gt prepare-agent lt  goal gt                       lt  goals gt                   lt  execution gt               lt  executions gt               lt configuration gt                   lt destFile gt   sonar jacoco reportPath  lt  destFile gt               lt  configuration gt           lt  plugin gt       lt  plugins gt   lt  build gt     Setting the destination file to the report path ensures that Sonar reads exactly the file JaCoCo generates  The report path should be outside the projects  directories to take cross-project coverage into account  e g  in case of Tycho where the convention is to have separate projects for tests   The reuseReports setting prevents the deletion of the JaCoCo report file before it is read   Since 4 3  this is the default and is deprecated     Then I just run  mvn clean install mvn sonar sonar

User · Answer

The presence of argLine configurations in either of surefire and jacoco plugins stops the jacoco report generation  The argLine should be defined in properties   lt properties gt     lt argLine gt your jvm options here lt  argLine gt   lt  properties gt

User · Answer

Jenkins does not show coverage results as it is a problem of version compatibilities between jenkins jacoco plugin and maven jacoco plugin  On my side I have fixed it by using a more recent version of maven jacoco plugin   lt build gt      lt pluginManagement gt        lt plugins gt          lt plugin gt            lt groupId gt org jacoco lt  groupId gt            lt artifactId gt jacoco-maven-plugin lt  artifactId gt            lt version gt 0 7 9 lt  version gt          lt  plugin gt        lt plugins gt      lt pluginManagement gt   lt build gt

User · Answer

I had the similar issue  0 0  coverage  amp  no unit tests count on Sonar dashboard with SonarQube 6 7 2  Maven   3 5 2  Java   1 8  Jacoco   Worked with 7 0 7 9 8 0  OS   Windows  After a lot of struggle finding for correct solution on maven multi-module project not like single module project here we need to say to pick jacoco reports from individual modules  amp  merge to one report So resolved issue with this configuration as my parent pom looks like     lt properties gt               lt  --Sonar -- gt               lt sonar java coveragePlugin gt jacoco lt  sonar java coveragePlugin gt               lt sonar dynamicAnalysis gt reuseReports lt  sonar dynamicAnalysis gt           lt sonar jacoco reportPath gt   project basedir     target jacoco exec lt  sonar jacoco reportPath gt               lt sonar language gt java lt  sonar language gt            lt  properties gt            lt build gt               lt pluginManagement gt                   lt plugins gt                       lt plugin gt                           lt groupId gt org apache maven plugins lt  groupId gt                           lt artifactId gt maven-compiler-plugin lt  artifactId gt                           lt configuration gt                               lt source gt 1 5 lt  source gt                               lt target gt 1 5 lt  target gt                           lt  configuration gt                       lt  plugin gt                        lt plugin gt                           lt groupId gt org sonarsource scanner maven lt  groupId gt                           lt artifactId gt sonar-maven-plugin lt  artifactId gt                           lt version gt 3 4 0 905 lt  version gt                       lt  plugin gt                        lt plugin gt                           lt groupId gt org jacoco lt  groupId gt                           lt artifactId gt jacoco-maven-plugin lt  artifactId gt                           lt version gt 0 7 9 lt  version gt                           lt configuration gt                               lt destFile gt   sonar jacoco reportPath  lt  destFile gt                               lt append gt true lt  append gt                           lt  configuration gt                           lt executions gt                               lt execution gt                                   lt id gt agent lt  id gt                                   lt goals gt                                       lt goal gt prepare-agent lt  goal gt                                   lt  goals gt                               lt  execution gt                           lt  executions gt                       lt  plugin gt                    lt  plugins gt               lt  pluginManagement gt           lt  build gt    I ve tried few other options like jacoco-aggregate  amp  even creating a sub-module by including that in parent pom but nothing really worked  amp  this is simple  I see in logs  lt sonar jacoco reportPath gt  is deprecated but still works as is and seems like auto replaced on execution or can be manually updated to  lt sonar jacoco reportPaths gt  or latest  Once after doing setup in cmd start with mvn clean install then mvn org jacoco jacoco-maven-plugin prepare-agent install  Check on project s target folder whether jacoco exec is created   amp  then do mvn sonar sonar   this is what I ve tried please let me know if some other best possible solution available Hope this helps   If not please post your question

[maven] SonarQube not picking up Unit Test Coverage

Examples related to maven

Examples related to jenkins

Examples related to sonarqube

Examples related to jacoco