Maven Jacoco Configuration - Exclude classes packages from report not working

Question

I have a maven multi-module project and I m using jacoco-maven for code coverage reports  Some classes should not be reported  as they re Spring configuration and I m not interested in them   I have declared the maven-jacoco plugin as follow    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 2 201409121644 lt  version gt   lt configuration gt       lt outputDirectory gt   project reporting outputDirectory  jacoco-ut lt  outputDirectory gt       lt exclude gt some package   lt  exclude gt       lt exclude gt     Config   lt  exclude gt       lt exclude gt     Dev   lt  exclude gt       lt exclude gt some package SomeClass java lt  exclude gt   lt  configuration 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 execution gt           lt id gt 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 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  execution gt   lt  executions gt   lt  plugin gt    The problem is that when I execute mvn clean verify jacoco still reports classes that should have been excluded as my xml configuration points out  How can I configure it properly

User · Answer

Though Andrew already answered question with details , i am giving code how to exclude it in pom

           <plugin>
                <groupId>org.jacoco</groupId>
                <artifactId>jacoco-maven-plugin</artifactId>
                <version>0.7.9</version>
                <configuration>
                    <excludes>
                        <exclude>**/*com/test/vaquar/khan/HealthChecker.class</exclude>
                    </excludes>
                </configuration>
                <executions>
                    <!-- prepare agent for measuring integration tests -->
                    <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>

For Springboot application

<build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>sonar-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.sonarsource.scanner.maven</groupId>
                <artifactId>sonar-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.jacoco</groupId>
                <artifactId>jacoco-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                       <!-- Exclude class from test coverage -->
                        <exclude>**/*com/khan/vaquar/Application.class</exclude>
                        <!-- Exclude full package from test coverage -->
                        <exclude>**/*com/khan/vaquar/config/**</exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

User · Answer

Another solution    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 5 201505241946 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 configuration gt                   lt rules gt                       lt rule implementation  org jacoco maven RuleConfiguration  gt                           lt excludes gt                               lt exclude gt com mypackage1 lt  exclude                              lt exclude gt com mypackage2 lt  exclude gt                           lt  excludes gt                           lt element gt PACKAGE lt  element gt                           lt limits gt                               lt limit implementation  org jacoco report check Limit  gt                                   lt counter gt COMPLEXITY lt  counter gt                                   lt value gt COVEREDRATIO lt  value gt                                   lt minimum gt 0 85 lt  minimum gt                               lt  limit gt                           lt  limits gt                       lt  rule gt                   lt  rules gt               lt  configuration gt           lt  execution gt       lt  executions gt   lt  plugin gt    Please note that  we are using   lt element gt PACKAGE lt  element gt   in the configuration which then helps us to exclude at package level

User · Answer

Use sonar coverage exclusions property   mvn clean install -Dsonar coverage exclusions     ToBeExcluded java   This should exclude the classes from coverage calculation

User · Answer

Here is the working sample in pom xml file        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 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 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  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 configuration gt               lt dataFile gt target jacoco exec lt  dataFile gt               lt  -- Sets the output directory for the code coverage report  -- gt               lt outputDirectory gt target jacoco-ut lt  outputDirectory gt               lt rules gt                   lt rule implementation  org jacoco maven RuleConfiguration  gt                       lt element gt PACKAGE lt  element gt                       lt limits gt                           lt limit implementation  org jacoco report check Limit  gt                               lt counter gt COMPLEXITY lt  counter gt                               lt value gt COVEREDRATIO lt  value gt                               lt minimum gt 0 00 lt  minimum gt                           lt  limit gt                       lt  limits gt                   lt  rule gt               lt  rules gt               lt excludes gt                   lt exclude gt com pfj fleet dao model      lt  exclude gt               lt  excludes gt               lt systemPropertyVariables gt                    lt jacoco-agent destfile gt target jacoco exec lt  jacoco-agent destfile gt               lt  systemPropertyVariables gt           lt  configuration gt       lt  plugin gt

User · Answer

Your XML is slightly wrong  you need to add any class exclusions within an excludes parent field  so your above configuration should look like the following as per the Jacoco docs   lt configuration gt       lt excludes gt           lt exclude gt     Config   lt  exclude gt           lt exclude gt     Dev   lt  exclude gt       lt  excludes gt   lt  configuration gt    The values of the exclude fields should be class paths  not package names  of the compiled classes relative to the directory target classes  using the standard wildcard syntax      Match zero or more characters     Match zero or more directories     Match a single character   You may also exclude a package and all of its children subpackages this way    lt exclude gt some package      lt  exclude gt    This will exclude every class in some package  as well as any children  For example  some package child wouldn t be included in the reports either   I have tested and my report goal reports on a reduced number of classes using the above   If you are then pushing this report into Sonar  you will then need to tell Sonar to exclude these classes in the display which can be done in the Sonar settings  Settings   General Settings   Exclusions   Code Coverage  Sonar Docs explains it a bit more  Running your command above  mvn clean verify   Will show the classes have been excluded  No exclusions   INFO  --- jacoco-maven-plugin 0 7 4 201502262128 report  post-test       ---  INFO  Analyzed bundle      with 37 classes   With exclusions   INFO  --- jacoco-maven-plugin 0 7 4 201502262128 report  post-test       ---  INFO  Analyzed bundle      with 34 classes   Hope this helps

User · Answer

you can configure the coverage exclusion in the sonar properties  outside of the configuration of the jacoco plugin        lt properties gt                lt sonar exclusions gt             generated                  model           lt  sonar exclusions gt       lt sonar test exclusions gt          src test           lt  sonar test exclusions gt                lt sonar java coveragePlugin gt jacoco lt  sonar java coveragePlugin gt       lt sonar jacoco reportPath gt   project basedir     target jacoco exec lt  sonar jacoco reportPath gt       lt sonar coverage exclusions gt             generated                  model           lt  sonar coverage exclusions gt       lt jacoco version gt 0 7 5 201505241946 lt  jacoco version gt            lt  properties gt         and remember to remove the exclusion settings from the plugin

User · Answer

https   github com jacoco jacoco issues 34  These are the different notations for classes we have    VM Name  java util Map Entry  Java Name  java util Map Entry File Name  java util Map Entry class   Agent Parameters  Ant tasks and Maven prepare-agent goal   includes  Java Name  VM Name also works  excludes  Java Name  VM Name also works  exclclassloader  Java Name   These specifications allow wildcards   and    where   wildcards any number of characters  even multiple nested folders   Maven report goal   includes  File Name excludes  File Name   These specs allow Ant Filespec like wildcards       and    where   wildcards parts of a single path element only

[maven] Maven Jacoco Configuration - Exclude classes/packages from report not working

Examples related to maven

Examples related to configuration

Examples related to jacoco

Examples related to jacoco-maven-plugin