Configurazione Maven Jacoco - Esclude classi / pacchetti dal report non funzionante

Ho un progetto multimodulo maven e sto usando jacoco-maven per i rapporti sulla copertura del codice. Alcune classi non dovrebbero essere segnalate, poiché sono una configurazione Spring e non mi interessano.

Ho dichiarato il plugin maven-jacoco come segue:

<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<version>0.7.2.201409121644</version>
<configuration>
    <outputDirectory>${project.reporting.outputDirectory}/jacoco-ut</outputDirectory>
    <exclude>some.package.*</exclude>
    <exclude>**/*Config.*</exclude>
    <exclude>**/*Dev.*</exclude>
    <exclude>some/package/SomeClass.java</exclude>
</configuration>
<executions>
    <execution>
        <goals>
            <goal>prepare-agent</goal>
        </goals>
    </execution>
    <execution>
        <id>report</id>
        <phase>prepare-package</phase>
        <goals>
            <goal>report</goal>
        </goals>
    </execution>
    <execution>
        <id>post-unit-test</id>
        <phase>test</phase>
        <goals>
            <goal>report</goal>
        </goals>
    </execution>
</executions>
</plugin>

Il problema è che quando mvn clean verifyeseguo jacoco riporta ancora le classi che avrebbero dovuto essere escluse come indica la mia configurazione xml. Come posso configurarlo correttamente?

Il tuo XML è leggermente sbagliato, devi aggiungere eventuali esclusioni di classi all'interno di un campo genitore esclude, quindi la tua configurazione sopra dovrebbe essere simile alla seguente come da documenti Jacoco

<configuration>
    <excludes>
        <exclude>**/*Config.*</exclude>
        <exclude>**/*Dev.*</exclude>
    </excludes>
</configuration>

I valori dei campi di esclusione dovrebbero essere percorsi di classe (non nomi di pacchetto) delle classi compilate relative alla directory di destinazione / classi / utilizzando la sintassi jolly standard

*   Match zero or more characters
**  Match zero or more directories
?   Match a single character

Puoi anche escludere un pacchetto e tutti i suoi figli / sottopacchetti in questo modo:

<exclude>some/package/**/*</exclude>

Ciò escluderà tutte le classi some.packagee tutti i bambini. Ad esempio, some.package.childnon verrebbero nemmeno inclusi nei rapporti.

Ho testato e il mio obiettivo di report riporta su un numero ridotto di classi utilizzando quanto sopra.

Se stai quindi inserendo questo rapporto in Sonar, dovrai quindi dire a Sonar di escludere queste classi nel display che può essere fatto nelle impostazioni del sonar

Impostazioni> Impostazioni generali> Esclusioni> Copertura codice

Sonar Docs lo spiega un po 'di più

Esegui il tuo comando sopra

mvn clean verify

Mostrerà che le classi sono state escluse

Nessuna esclusione

[INFO] --- jacoco-maven-plugin:0.7.4.201502262128:report (post-test) @ ** ---
[INFO] Analyzed bundle '**' with 37 classes

Con esclusioni

[INFO] --- jacoco-maven-plugin:0.7.4.201502262128:report (post-test) @ ** ---
[INFO] Analyzed bundle '**' with 34 classes

Spero che questo ti aiuti

Sebbene Andrew abbia già risposto alla domanda con i dettagli, sto fornendo il codice per escluderlo 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>

Per l'applicazione Springboot

<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>

Un'altra soluzione:

<plugin>
    <groupId>org.jacoco</groupId>
    <artifactId>jacoco-maven-plugin</artifactId>
    <version>0.7.5.201505241946</version>
    <executions>
        <execution>
            <id>default-prepare-agent</id>
            <goals>
                <goal>prepare-agent</goal>
            </goals>
        </execution>
        <execution>
            <id>default-report</id>
            <phase>prepare-package</phase>
            <goals>
                <goal>report</goal>
            </goals>
        </execution>
        <execution>
            <id>default-check</id>
            <goals>
                <goal>check</goal>
            </goals>
            <configuration>
                <rules>
                    <rule implementation="org.jacoco.maven.RuleConfiguration">
                        <excludes>
                            <exclude>com.mypackage1</exclude
                            <exclude>com.mypackage2</exclude>
                        </excludes>
                        <element>PACKAGE</element>
                        <limits>
                            <limit implementation="org.jacoco.report.check.Limit">
                                <counter>COMPLEXITY</counter>
                                <value>COVEREDRATIO</value>
                                <minimum>0.85</minimum>
                            </limit>
                        </limits>
                    </rule>
                </rules>
            </configuration>
        </execution>
    </executions>
</plugin>

Si prega di notare che stiamo usando "<element>PACKAGE</element>"nella configurazione che quindi ci aiuta a escludere a livello di pacchetto.

https://github.com/jacoco/jacoco/issues/34

Queste sono le diverse notazioni per le classi che abbiamo:

• Nome VM: java / util / Map $ Entry
• Nome Java: java.util.Map $ Entry File
• Nome: java / util / Map $ Entry.class

Parametri agente, attività Ant e obiettivo di preparazione dell'agente Maven

• include: Java Name (funziona anche il nome VM)
• esclude: Java Name (funziona anche VM Name)
• exclclassloader: nome Java

Queste specifiche consentono caratteri jolly * e?, Dove * caratteri jolly un numero qualsiasi di caratteri, anche più cartelle nidificate.

Obiettivo del rapporto Maven

• include: Nome file
• esclude: Nome file

Queste specifiche consentono ad Ant Filespec come i caratteri jolly *, ** e?, Dove * i caratteri jolly sono solo parti di un singolo elemento del percorso.

Usa la proprietà sonar.coverage.exclusions.

mvn clean install -Dsonar.coverage.exclusions=**/*ToBeExcluded.java

Ciò dovrebbe escludere le classi dal calcolo della copertura.

è possibile configurare l'esclusione di copertura nelle proprietà del sonar, al di fuori della configurazione del plugin jacoco:

...
<properties>
    ....
    <sonar.exclusions>
        **/generated/**/*,
        **/model/**/*
    </sonar.exclusions>
    <sonar.test.exclusions>
        src/test/**/*
    </sonar.test.exclusions>
    ....
    <sonar.java.coveragePlugin>jacoco</sonar.java.coveragePlugin>
    <sonar.jacoco.reportPath>${project.basedir}/../target/jacoco.exec</sonar.jacoco.reportPath>
    <sonar.coverage.exclusions>
        **/generated/**/*,
        **/model/**/*
    </sonar.coverage.exclusions>
    <jacoco.version>0.7.5.201505241946</jacoco.version>
    ....
</properties>
....

e ricorda di rimuovere le impostazioni di esclusione dal plugin

Ecco l'esempio funzionante nel pom.xmlfile.

    <plugin>
        <groupId>org.jacoco</groupId>
        <artifactId>jacoco-maven-plugin</artifactId>
        <version>${jacoco.version}</version>


        <executions>
            <execution>
                <id>prepare-agent</id>
                <goals>
                    <goal>prepare-agent</goal>
                </goals>
            </execution>
            <execution>
                <id>post-unit-test</id>
                <phase>test</phase>
                <goals>
                    <goal>report</goal>
                </goals>

            </execution>

            <execution>
                <id>default-check</id>
                <goals>
                    <goal>check</goal>
                </goals>

            </execution>
        </executions>
        <configuration>
            <dataFile>target/jacoco.exec</dataFile>
            <!-- Sets the output directory for the code coverage report. -->
            <outputDirectory>target/jacoco-ut</outputDirectory>
            <rules>
                <rule implementation="org.jacoco.maven.RuleConfiguration">
                    <element>PACKAGE</element>
                    <limits>
                        <limit implementation="org.jacoco.report.check.Limit">
                            <counter>COMPLEXITY</counter>
                            <value>COVEREDRATIO</value>
                            <minimum>0.00</minimum>
                        </limit>
                    </limits>
                </rule>
            </rules>
            <excludes>
                <exclude>com/pfj/fleet/dao/model/**/*</exclude>
            </excludes>
            <systemPropertyVariables>

                <jacoco-agent.destfile>target/jacoco.exec</jacoco-agent.destfile>
            </systemPropertyVariables>
        </configuration>
    </plugin>