How to configure multi-module Maven Sonar JaCoCo to give merged coverage report

Question

I ve searched up and down the internet for this one  There s lots of half-answers out there  to do with Maven properties such as   sonar jacoco reportPath   or org jacoco jacoco-maven-plugin prepare-agent or setting maven-surefire-plugin argLine with -javaagent   Some how  none of these answers  either on their own  or in combination  are producing what I m after  A coverage report which shows a class as covered if it is used in tests higher up the stack  such as entities being used by DAOs  even though it was not fully covered by tests in its own module   Is there a definitive config somewhere  to achieve this  please

User · Answer

This sample works very well for me     lt plugin gt               lt groupId gt org jacoco lt  groupId gt               lt artifactId gt jacoco-maven-plugin lt  artifactId gt               lt version gt 0 8 2 lt  version gt               lt executions gt                   lt execution gt                       lt id gt pre-unit-test lt  id gt                       lt goals gt                           lt goal gt prepare-agent lt  goal gt                       lt  goals gt                       lt configuration gt                           lt destFile gt   project build directory  coverage-reports jacoco-ut exec lt  destFile gt                           lt propertyName gt surefireArgLine lt  propertyName gt                       lt  configuration gt                   lt  execution gt                   lt execution gt                       lt id gt pre-integration-test lt  id gt                       lt goals gt                           lt goal gt prepare-agent-integration lt  goal gt                       lt  goals gt                       lt configuration gt                           lt destFile gt   project build directory  coverage-reports jacoco-it exec lt  destFile gt                           lt  -- lt excludes gt                               lt exclude gt com asimio demo rest lt  exclude gt                               lt exclude gt com asimio demo service lt  exclude gt                           lt  excludes gt -- gt                           lt propertyName gt testArgLine lt  propertyName gt                       lt  configuration gt                   lt  execution gt                   lt execution gt                       lt id gt post-integration-test lt  id gt                       lt phase gt post-integration-test lt  phase gt                       lt goals gt                           lt goal gt report lt  goal gt                       lt  goals gt                       lt configuration gt                           lt dataFile gt   project build directory  coverage-reports jacoco-it exec lt  dataFile gt                           lt outputDirectory gt   project reporting outputDirectory  jacoco-it lt  outputDirectory gt                       lt  configuration gt                   lt  execution gt                   lt execution gt                       lt id gt post-unit-test 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 configuration gt                           lt dataFile gt   project build directory  coverage-reports jacoco-ut exec lt  dataFile gt                           lt outputDirectory gt   project reporting outputDirectory  jacoco-ut lt  outputDirectory gt                       lt  configuration gt                   lt  execution gt                   lt execution gt                       lt id gt merge-results lt  id gt                       lt phase gt verify lt  phase gt                       lt goals gt                           lt goal gt merge lt  goal gt                       lt  goals gt                       lt configuration gt                           lt fileSets gt                               lt fileSet gt                                   lt directory gt   project build directory  coverage-reports lt  directory gt                                   lt includes gt                                       lt include gt   exec lt  include gt                                   lt  includes gt                               lt  fileSet gt                           lt  fileSets gt                           lt destFile gt   project build directory  coverage-reports aggregate exec lt  destFile gt                       lt  configuration gt                   lt  execution gt                   lt execution gt                       lt id gt post-merge-report lt  id gt                       lt phase gt verify lt  phase gt                       lt goals gt                           lt goal gt report lt  goal gt                       lt  goals gt                       lt configuration gt                           lt dataFile gt   project build directory  coverage-reports aggregate exec lt  dataFile gt                           lt outputDirectory gt   project reporting outputDirectory  jacoco-aggregate lt  outputDirectory gt                       lt  configuration gt                   lt  execution gt               lt  executions gt           lt  plugin 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 2 18 1 lt  version gt               lt configuration gt                   lt argLine gt   surefireArgLine  lt  argLine gt                   lt  -- lt skipTests gt   skip unit tests  lt  skipTests gt -- gt                   lt includes gt                       lt include gt     Test java lt  include gt                       lt  -- lt include gt     MT java lt  include gt                       lt include gt     Test java lt  include gt -- gt                   lt  includes gt               lt  --     lt skipTests gt   skipUTMTs  lt  skipTests gt -- gt               lt  configuration gt           lt  plugin gt           lt plugin gt               lt groupId gt org apache maven plugins lt  groupId gt               lt artifactId gt maven-failsafe-plugin lt  artifactId gt               lt version gt 2 12 4 lt  version gt               lt configuration gt                   lt  -- lt skipTests gt   skipTests  lt  skipTests gt                   lt skipITs gt   skipITs  lt  skipITs gt -- gt                   lt argLine gt   testArgLine  lt  argLine gt                   lt includes gt                       lt include gt     IT java lt  include gt                   lt  includes gt                   lt  -- lt excludes gt                       lt exclude gt     UT  java lt  exclude gt                   lt  excludes gt -- gt               lt  configuration gt               lt executions gt                   lt execution gt                       lt goals gt                           lt goal gt integration-test lt  goal gt                           lt goal gt verify lt  goal gt                       lt  goals gt                   lt  execution gt               lt  executions gt           lt  plugin gt

User · Answer

I was in the same situation as you  the half answers scattered throughout the Internet were quite annoying  since it seemed that many people had the same issue  but no one could be bothered to fully explain how they solved it   The Sonar docs refer to   a GitHub project with examples that are helpful  What I did to solve this was to apply the integration tests logic to regular unit tests  although proper unit tests should be submodule specific  this isn t always the case    In the parent pom xml  add these properties    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    This will make Sonar pick up unit testing reports for all submodules in the same place  a target folder in the parent project   It also tells Sonar to reuse reports ran manually instead of rolling its own  We just need to make jacoco-maven-plugin run for all submodules by placing this in the parent pom  inside build plugins    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 0 201210061924 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    destFile places the report file in the place where Sonar will look for it and append makes it append to the file rather than overwriting it  This will combine all JaCoCo reports for all submodules in the same file   Sonar will look at that file for each submodule  since that s what we pointed him at above  giving us combined unit testing results for multi module files in Sonar

User · Answer

lt sonar language gt java lt  sonar language gt       lt sonar java coveragePlugin gt jacoco lt  sonar java coveragePlugin gt       lt sonar jacoco reportPath gt   user dir  target jacoco exec lt  sonar jacoco reportPath gt       lt sonar jacoco itReportPath gt   user dir  target jacoco-it exec lt  sonar jacoco itReportPath gt       lt sonar exclusions gt          file    target generated-sources             file    target generated-test-sources             file    target test-classes             file    model   java          file     Config java          file     App java      lt  sonar exclusions 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 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 configuration gt                               lt destFile gt   sonar jacoco reportPath  lt  destFile gt                               lt append gt true lt  append gt                               lt propertyName gt surefire argLine lt  propertyName gt                           lt  configuration gt                       lt  execution gt                       lt execution gt                           lt id gt default-prepare-agent-integration lt  id gt                           lt goals gt                               lt goal gt prepare-agent-integration lt  goal gt                           lt  goals gt                           lt configuration gt                               lt destFile gt   sonar jacoco itReportPath  lt  destFile gt                               lt append gt true lt  append gt                               lt propertyName gt failsafe argLine lt  propertyName gt                           lt  configuration gt                       lt  execution gt                       lt execution gt                           lt id gt default-report lt  id gt                           lt goals gt                               lt goal gt report lt  goal gt                           lt  goals gt                       lt  execution gt                       lt execution gt                           lt id gt default-report-integration lt  id gt                           lt goals gt                               lt goal gt report-integration lt  goal gt                           lt  goals gt                       lt  execution gt                   lt  executions gt               lt  plugin gt

User · Answer

I found another solution for new Sonar versions where JaCoCo s binary report format    exec  was deprecated and the preferred format is XML  SonarJava 5 12 and higher   The solution is very simple and similar to the previous solution with   exec reports in parent directory from this topic  https   stackoverflow com a 15535970 4448263   Assuming that our project structure is   moduleC - aggregate project s pom    - moduleA - some classes without tests    - moduleB - some classes depending from moduleA and tests for classes in both modules  moduleA and moduleB   You need following maven build plugin configuration in aggregate project s pom    lt plugin gt       lt groupId gt org jacoco lt  groupId gt       lt artifactId gt jacoco-maven-plugin lt  artifactId gt       lt version gt 0 8 5 lt  version gt       lt executions gt           lt execution gt               lt id gt prepare-and-report lt  id gt               lt goals gt                   lt goal gt prepare-agent lt  goal gt                   lt goal gt report lt  goal gt               lt  goals gt           lt  execution gt           lt execution gt               lt id gt report-aggregate lt  id gt               lt phase gt verify lt  phase gt               lt goals gt                   lt goal gt report-aggregate lt  goal gt               lt  goals gt               lt configuration gt                   lt outputDirectory gt   project basedir     target site jacoco-aggregate lt  outputDirectory gt               lt  configuration gt           lt  execution gt       lt  executions gt   lt  plugin gt    Then build project with maven   mvn clean verify   And for Sonar you should set property in administration GUI   sonar coverage jacoco xmlReportPaths target site jacoco jacoco xml    target site jacoco-aggregate jacoco xml   or using command line   mvn sonar sonar -Dsonar coverage jacoco xmlReportPaths target site jacoco jacoco xml    target site jacoco-aggregate jacoco xml   Description  This creates binary reports for each module in default directories  target jacoco exec  Then creates XML reports for each module in default directories  target site jacoco jacoco xml  Then creates an aggregate report for each module in custom directory   project basedir     target site jacoco-aggregate  that is relative to parent directory for each module  For moduleA and moduleB this will be common path moduleC target site jacoco-aggregate    As moduleB depends on moduleA  moduleB will be built last and its report will be used as an aggregate coverage report in Sonar for both modules A and B   In addition to the aggregate report  we need a normal module report as JaCoCo aggregate reports contain coverage data only for dependencies   Together  these two types of reports providing full coverage data for Sonar   There is one little restriction  you should be able to write a report in the project s parent directory  should have permission   Or you can set property jacoco skip true in root project s pom xml  moduleC  and jacoco skip false in modules with classes and tests  moduleA and moduleB

User · Answer

to have unit-testing AND integration-testing you can use maven-surefire-plugin and maven-failsafe-plugin with restricted includes excludes  I was playing with CDI while getting in touch with sonar jacoco  so i ended up in this project   https   github com FibreFoX cdi-sessionscoped-login   Maybe it helps you a little bit  in my pom xml i use  -javaagent  implicit by setting the argLine-option in the configuration-section of the specified testing-plugins  Explicit using ANT in MAVEN projects is something i would not give a try  for me its to much mixing two worlds   I only have a single-module maven project  but maybe it helps you to adjust yours to work   note  maybe not all maven-plugins are up2date  maybe some issues are fixed in later versions

User · Answer

NEW WAY SINCE VERSION 0 7 7  Since Version 0 7 7 there is a new way to create an aggregated report   You create a separate  report  project which collects all the necessary reports  Any goal in the aggregator project is executed before its modules therefore it can t be used    aggregator pom    - parent pom    - module a    - module b    - report module    The root pom looks like this  don t forget to add the new report module under modules     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 8 lt  version gt       lt executions gt         lt execution gt           lt id gt prepare-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      The poms from each sub module doesn t need to be changed at all  The pom from the report module looks like this    lt  -- Add all sub modules as dependencies here -- gt   lt dependencies gt     lt dependency gt       lt module a gt     lt  dependency gt     lt dependency gt       lt module b gt     lt  dependency 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 8 lt  version gt           lt executions gt             lt execution gt               lt id gt report-aggregate lt  id gt               lt phase gt verify lt  phase gt               lt goals gt                 lt goal gt report-aggregate lt  goal gt               lt  goals gt             lt  execution gt           lt  executions gt         lt  plugin gt       lt  plugins gt     lt  build gt    A full exmple can be found here

User · Answer

I ll post my solution as it it subtly different from others and also took me a solid day to get right  with the assistance of the existing answers   For a multi-module Maven project   ROOT  --WAR  --LIB-1  --LIB-2  --TEST   Where the WAR project is the main web app  LIB 1 and 2 are additional modules the WAR depends on and TEST is where the integration tests live  TEST spins up an embedded Tomcat instance  not via Tomcat plugin  and runs WAR project and tests them via a set of JUnit tests  The WAR and LIB projects both have their own unit tests   The result of all this is the integration and unit test coverage being separated and able to be distinguished in SonarQube   ROOT pom xml   lt  -- Sonar properties-- gt   lt sonar jacoco itReportPath gt   project basedir     target jacoco-it exec lt  sonar jacoco itReportPath 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 sonar java coveragePlugin gt jacoco lt  sonar java coveragePlugin gt    lt  -- build plugins  not build pluginManagement 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 6 201602180812 lt  version gt       lt executions gt           lt execution gt               lt id gt agent-for-ut lt  id gt               lt goals gt                   lt goal gt prepare-agent lt  goal gt               lt  goals gt               lt configuration gt                   lt append gt true lt  append gt                   lt destFile gt   sonar jacoco reportPath  lt  destFile gt               lt  configuration gt           lt  execution gt           lt execution gt               lt id gt agent-for-it lt  id gt               lt goals gt                   lt goal gt prepare-agent-integration lt  goal gt               lt  goals gt               lt configuration gt                   lt append gt true lt  append gt                   lt destFile gt   sonar jacoco itReportPath  lt  destFile gt               lt  configuration gt           lt  execution gt       lt  executions gt   lt  plugin gt    WAR  LIB  and TEST pom xml will inherit the the JaCoCo plugins execution   TEST pom xml   lt plugin gt       lt groupId gt org apache maven plugins lt  groupId gt       lt artifactId gt maven-failsafe-plugin lt  artifactId gt       lt version gt 2 19 1 lt  version gt       lt executions gt           lt execution gt               lt goals gt                   lt goal gt integration-test lt  goal gt                   lt goal gt verify lt  goal gt               lt  goals gt               lt configuration gt                   lt skipTests gt   skip tests  lt  skipTests gt                   lt argLine gt   argLine  -Duser timezone UTC -Xms256m -Xmx256m lt  argLine gt                   lt includes gt                       lt includes gt     Test  lt  includes gt                   lt  includes gt               lt  configuration gt           lt  execution gt       lt  executions gt   lt  plugin gt    I also found Petri Kainulainens blog post  Creating Code Coverage Reports for Unit and Integration Tests With the JaCoCo Maven Plugin  to be valuable for the JaCoCo setup side of things

User · Answer

The configuration I use in my parent level pom where I have separate unit and integration test phases   I configure the following properties in the parent POM Properties       lt maven surefire report plugin gt 2 19 1 lt  maven surefire report plugin gt       lt jacoco plugin version gt 0 7 6 201602180812 lt  jacoco plugin version gt       lt jacoco check lineRatio gt 0 52 lt  jacoco check lineRatio gt       lt jacoco check branchRatio gt 0 40 lt  jacoco check branchRatio gt       lt jacoco check complexityMax gt 15 lt  jacoco check complexityMax gt       lt jacoco skip gt false lt  jacoco skip gt       lt jacoco excludePattern  gt       lt jacoco destfile gt   project basedir     target coverage-reports jacoco exec lt  jacoco destfile gt        lt sonar language gt java lt  sonar language gt       lt sonar exclusions gt    generated-sources      lt  sonar exclusions gt       lt sonar core codeCoveragePlugin gt jacoco lt  sonar core codeCoveragePlugin gt       lt sonar coverage exclusions gt   jacoco excludePattern  lt  sonar coverage exclusions gt       lt sonar dynamicAnalysis gt reuseReports lt  sonar dynamicAnalysis gt       lt sonar jacoco reportPath gt   project basedir     target coverage-reports lt  sonar jacoco reportPath gt        lt skip surefire tests gt   skipTests  lt  skip surefire tests gt       lt skip failsafe tests gt   skipTests  lt  skip failsafe tests gt    I place the plugin definitions under plugin management     Note that I define a property for surefire  surefireArgLine  and failsafe  failsafeArgLine  arguments to allow jacoco to configure the javaagent to run with each test   Under pluginManagement     lt build gt        lt pluginManagment 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 version gt 3 1 lt  version gt                   lt configuration gt                       lt fork gt true lt  fork gt                       lt meminitial gt 1024m lt  meminitial gt                       lt maxmem gt 1024m lt  maxmem gt                       lt compilerArgument gt -g lt  compilerArgument gt                       lt source gt   maven compiler source  lt  source gt                       lt target gt   maven compiler target  lt  target gt                       lt encoding gt   project build sourceEncoding  lt  encoding gt                   lt  configuration gt               lt  plugin 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 2 19 1 lt  version gt                   lt configuration gt                       lt forkCount gt 4 lt  forkCount gt                       lt reuseForks gt false lt  reuseForks gt                       lt argLine gt -Xmx2048m   surefireArgLine  lt  argLine gt                       lt includes gt                           lt include gt     Test java lt  include gt                       lt  includes gt                       lt excludes gt                           lt exclude gt     IT java lt  exclude gt                       lt  excludes gt                       lt skip gt   skip surefire tests  lt  skip gt                   lt  configuration gt               lt  plugin gt               lt plugin gt                   lt  -- For integration test separation -- gt                   lt groupId gt org apache maven plugins lt  groupId gt                   lt artifactId gt maven-failsafe-plugin lt  artifactId gt                   lt version gt 2 19 1 lt  version gt                   lt dependencies gt                       lt dependency gt                           lt groupId gt org apache maven surefire lt  groupId gt                           lt artifactId gt surefire-junit47 lt  artifactId gt                           lt version gt 2 19 1 lt  version gt                       lt  dependency gt                   lt  dependencies gt                   lt configuration gt                       lt forkCount gt 4 lt  forkCount gt                       lt reuseForks gt false lt  reuseForks gt                       lt argLine gt   failsafeArgLine  lt  argLine gt                       lt includes gt                           lt include gt     IT java lt  include gt                       lt  includes gt                       lt skip gt   skip failsafe tests  lt  skip gt                   lt  configuration gt                   lt executions gt                       lt execution gt                           lt id gt integration-test lt  id gt                           lt goals gt                               lt goal gt integration-test lt  goal gt                           lt  goals gt                       lt  execution gt                       lt execution gt                           lt id gt verify lt  id gt                           lt goals gt                               lt goal gt verify lt  goal gt                           lt  goals gt                       lt  execution gt                   lt  executions gt               lt  plugin gt                lt plugin gt                   lt  -- Code Coverage -- gt                   lt groupId gt org jacoco lt  groupId gt                   lt artifactId gt jacoco-maven-plugin lt  artifactId gt                   lt version gt   jacoco plugin version  lt  version gt                   lt configuration gt                       lt haltOnFailure gt true lt  haltOnFailure gt                       lt excludes gt                           lt exclude gt      mar lt  exclude gt                           lt exclude gt   jacoco excludePattern  lt  exclude gt                       lt  excludes gt                       lt rules gt                           lt rule gt                               lt element gt BUNDLE lt  element gt                               lt limits gt                                   lt limit gt                                       lt counter gt LINE lt  counter gt                                       lt value gt COVEREDRATIO lt  value gt                                       lt minimum gt   jacoco check lineRatio  lt  minimum gt                                   lt  limit gt                                   lt limit gt                                       lt counter gt BRANCH lt  counter gt                                       lt value gt COVEREDRATIO lt  value gt                                       lt minimum gt   jacoco check branchRatio  lt  minimum gt                                   lt  limit gt                               lt  limits gt                           lt  rule gt                           lt rule gt                               lt element gt METHOD lt  element gt                               lt limits gt                                   lt limit gt                                       lt counter gt COMPLEXITY lt  counter gt                                       lt value gt TOTALCOUNT lt  value gt                                       lt maximum gt   jacoco check complexityMax  lt  maximum gt                                   lt  limit gt                               lt  limits gt                           lt  rule gt                       lt  rules gt                   lt  configuration gt                   lt executions gt                       lt execution gt                           lt id gt pre-unit-test lt  id gt                           lt goals gt                               lt goal gt prepare-agent lt  goal gt                           lt  goals gt                           lt configuration gt                               lt destFile gt   jacoco destfile  lt  destFile gt                               lt append gt true lt  append gt                               lt propertyName gt surefireArgLine lt  propertyName gt                           lt  configuration gt                       lt  execution gt                       lt execution gt                           lt id gt post-unit-test lt  id gt                           lt phase gt test lt  phase gt                           lt goals gt                               lt goal gt report lt  goal gt                           lt  goals gt                           lt configuration gt                               lt dataFile gt   jacoco destfile  lt  dataFile gt                               lt outputDirectory gt   sonar jacoco reportPath  lt  outputDirectory gt                               lt skip gt   skip surefire tests  lt  skip gt                           lt  configuration gt                       lt  execution gt                       lt execution gt                           lt id gt pre-integration-test lt  id gt                           lt phase gt pre-integration-test lt  phase gt                           lt goals gt                               lt goal gt prepare-agent-integration lt  goal gt                           lt  goals gt                           lt configuration gt                               lt destFile gt   jacoco destfile  lt  destFile gt                               lt append gt true lt  append gt                               lt propertyName gt failsafeArgLine lt  propertyName gt                           lt  configuration gt                       lt  execution gt                       lt execution gt                           lt id gt post-integration-test lt  id gt                           lt phase gt post-integration-test lt  phase gt                           lt goals gt                               lt goal gt report-integration lt  goal gt                           lt  goals gt                           lt configuration gt                               lt dataFile gt   jacoco destfile  lt  dataFile gt                               lt outputDirectory gt   sonar jacoco reportPath  lt  outputDirectory gt                               lt skip gt   skip failsafe tests  lt  skip gt                           lt  configuration gt                       lt  execution gt                       lt  -- Disabled until such time as code quality stops this tripping                      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 configuration gt                               lt dataFile gt   jacoco destfile  lt  dataFile gt                           lt  configuration gt                       lt  execution gt                      -- gt                   lt  executions gt               lt  plugin gt                    And in the build section    lt build 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  plugin gt            lt plugin gt               lt  -- for unit test execution -- gt               lt groupId gt org apache maven plugins lt  groupId gt               lt artifactId gt maven-surefire-plugin lt  artifactId gt           lt  plugin gt           lt plugin gt               lt  -- For integration test separation -- gt               lt groupId gt org apache maven plugins lt  groupId gt               lt artifactId gt maven-failsafe-plugin lt  artifactId gt           lt  plugin gt           lt plugin gt               lt  -- For code coverage -- gt               lt groupId gt org jacoco lt  groupId gt               lt artifactId gt jacoco-maven-plugin lt  artifactId gt           lt  plugin gt                 And in the reporting section       lt reporting gt       lt plugins gt           lt plugin gt               lt groupId gt org apache maven plugins lt  groupId gt               lt artifactId gt maven-surefire-report-plugin lt  artifactId gt               lt version gt   maven surefire report plugin  lt  version gt               lt configuration gt                   lt showSuccess gt false lt  showSuccess gt                   lt alwaysGenerateFailsafeReport gt true lt  alwaysGenerateFailsafeReport gt                   lt alwaysGenerateSurefireReport gt true lt  alwaysGenerateSurefireReport gt                   lt aggregate gt true lt  aggregate gt               lt  configuration 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 plugin version  lt  version gt               lt configuration gt                   lt excludes gt                       lt exclude gt      mar lt  exclude gt                       lt exclude gt   jacoco excludePattern  lt  exclude gt                   lt  excludes gt               lt  configuration gt           lt  plugin gt        lt  plugins gt     lt  reporting gt

User · Answer

As Sonars sonar jacoco reportPath  sonar jacoco itReportPath and sonar jacoco reportPaths have all been deprecated  you should use sonar coverage jacoco xmlReportPaths now  This also has some impact if you want to configure a multi module maven project with Sonar and Jacoco    As  Lonzak pointed out  since Sonar 0 7 7  you can use Sonars report aggragation goal  Just put in you parent pom the following dependency    lt plugin gt       lt groupId gt org jacoco lt  groupId gt       lt artifactId gt jacoco-maven-plugin lt  artifactId gt       lt version gt 0 8 5 lt  version gt       lt executions gt           lt execution gt               lt id gt report lt  id gt               lt goals gt                   lt goal gt report-aggregate lt  goal gt               lt  goals gt               lt phase gt verify lt  phase gt           lt  execution gt       lt  executions gt   lt  plugin gt    As current versions of the jacoco-maven-plugin are compatible with the xml-reports  this will create for every module in it s own target folder a site jacoco-aggregate folder containing a jacoco xml file   To let Sonar combine all the modules  use following command   mvn -Dsonar coverage jacoco xmlReportPaths full-path-to-module1 target site jacoco-aggregate jacoco xml module2    module3    clean verify sonar sonar     To keep my answer short and precise  I did not mention the maven-surefire-plugin and  maven-failsafe-plugin dependencies  You can just add them without any other configuration    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 2 22 2 lt  version gt   lt  plugin gt   lt plugin gt       lt groupId gt org apache maven plugins lt  groupId gt       lt artifactId gt maven-failsafe-plugin lt  artifactId gt       lt version gt 2 22 2 lt  version gt       lt executions gt           lt execution gt           lt id gt integration-test lt  id gt               lt goals gt                   lt goal gt integration-test lt  goal gt               lt  goals gt           lt  execution gt       lt  executions gt   lt  plugin gt

User · Answer

There is a way to accomplish this  The magic is to create a combined jacoco exec file  And with maven 3 3 1 there is an easy way to get this  Here my profile    lt profile gt       lt id gt runSonar lt  id gt       lt activation gt           lt property gt               lt name gt runSonar lt  name gt               lt value gt true lt  value gt           lt  property gt       lt  activation gt       lt properties gt           lt sonar language gt java lt  sonar language gt           lt sonar host url gt http   sonar url lt  sonar host url gt           lt sonar login gt tokenX lt  sonar login gt           lt sonar jacoco reportMissing force zero gt true lt  sonar jacoco reportMissing force zero gt           lt sonar jacoco reportPath gt   jacoco destFile  lt  sonar jacoco reportPath gt           lt jacoco destFile gt   maven multiModuleProjectDirectory  target jacoco analysis jacoco exec lt  jacoco destFile 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 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 configuration gt                               lt append gt true lt  append gt                               lt destFile gt   jacoco destFile  lt  destFile gt                           lt  configuration gt                       lt  execution gt                   lt  executions gt               lt  plugin gt           lt  plugins gt           lt pluginManagement gt               lt plugins 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 2 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 8 lt  version gt                   lt  plugin gt               lt  plugins gt           lt  pluginManagement gt       lt  build gt   lt  profile gt    If you add this profile to your parent pom and call mvn clean install sonar sonar -DrunSonar you get the complete coverage   The magic here is maven multiModuleProjectDirectory  This folder is always the folder where you started your maven build

User · Answer

FAQ  Questions from the top of my head since that time I gone crazy with jacoco   My application server  jBoss  Glassfish    located in Iraq  Syria  whatever   Is it possible to get multi-module coverage when running integration tests on it  Jenkins and Sonar are also on different servers   Yes  You have to use jacoco agent that runs in mode output tcpserver  jacoco ant lib  Basically two jars  This will give you 99  success   How does jacoco agent works   You append a string   -javaagent  your path  jacocoagent jar destfile  jacoco exec output tcpserver address     to your application server JAVA OPTS and restart it  In this string only  your path  have to be replaced with the path to jacocoagent jar  stored store it   on your VM where app server runs  Since that time you start app server  all applications that are deployed will be dynamically monitored and their activity  meaning code usage  will be ready for you to get in jacocos  exec format by tcl request    Could I reset jacoco agent to start collecting execution data only since the time my test start   Yes  for that purpose you need jacocoant jar and ant build script located in your jenkins workspace   So basically what I need from http   www eclemma org jacoco  is jacocoant jar located in my jenkins workspace  and jacocoagent jar located on my app server VM   That s right   I don t want to use ant  I ve heard that jacoco maven plugin can do all the things too   That s not right  jacoco maven plugin can collect unit test data and some integration tests data see Arquillian Jacoco   but if you have for example rest assured tests as a separated build in jenkins  and want to show multi-module coverage  I can t see how maven plugin can help you   What exactly does jacoco agent produce    Only coverage data in  exec format  Sonar then can read it   Does jacoco need to know where my java classes located are   No  sonar does  but not jacoco  When you do mvn sonar sonar path to classes comes into play   So what about the ant script   It has to be presented in your jenkins workspace  Mine ant script  I called it jacoco xml looks like that     lt project name  Jacoco library to collect code coverage remotely  xmlns jacoco  antlib org jacoco ant  gt       lt property name  jacoco port  value  6300   gt       lt property name  jacocoReportFile  location    workspace  it-jacoco exec   gt        lt taskdef uri  antlib org jacoco ant  resource  org jacoco ant antlib xml  gt           lt classpath path    workspace  tools jacoco jacocoant jar   gt       lt  taskdef gt        lt target name  jacocoReport  gt               lt jacoco dump address    jacoco host   port    jacoco port   dump  true  reset  true  destfile    jacocoReportFile   append  false   gt       lt  target gt        lt target name  jacocoReset  gt               lt jacoco dump address    jacoco host   port    jacoco port   reset  true  destfile    jacocoReportFile   append  false   gt           lt delete file    jacocoReportFile    gt       lt  target gt   lt  project gt    Two mandatory params you should pass when invoking this script  -Dworkspace  WORKSPACE use it to point to your jenkins workspace and -Djacoco host yourappserver com host without http     Also notice that I put my jacocoant jar to   workspace  tools jacoco jacocoant jar  What should I do next   Did you start your app server with jacocoagent jar   Did you put ant script and jacocoant jar in your jenkins workspace   If yes the last step is to configure a jenkins build  Here is the strategy     Invoke ant target jacocoReset to reset all previously collected data  Run your tests Invoke ant target jacocoReport to get report   If everything is right  you will see it-jacoco exec in your build workspace   Look at the screenshot  I also have ant installed in my workspace in  WORKSPACE tools ant dir  but you can use one that is installed in your jenkins      How to push this report in sonar   Maven sonar sonar will do the job  don t forget to configure it   point it to main pom xml so it will run through all modules  Use sonar jacoco itReportPath  WORKSPACE it-jacoco exec parameter to tell sonar where your integration test report is located  Every time it will analyse new module classes  it will look for information about coverage in it-jacoco exec   I already have jacoco exec in my  target  dir   mvn sonar sonar  ignores removes it   By default mvn sonar sonar does clean and deletes your target dir  use sonar dynamicAnalysis reuseReports to avoid it

User · Answer

You can call a ant task called merge on maven  to put all coverage files    exec  together in the same file   If you are run unit tests use the phase prepare-package  if you run integration test so use post-integration-test   This site has an example to how call jacoco ant task in maven project  You can use this merged file on sonar

[maven] How to configure multi-module Maven + Sonar + JaCoCo to give merged coverage report?

Examples related to maven

Examples related to code-coverage

Examples related to sonarqube

Examples related to jacoco