Problema:

Tengo un proyecto con jacoco y quiero poder filtrar ciertas clases y / o paquetes.

Documentación relacionada:

He leído la siguiente documentación:

Oficial jacocositio: http://www.eclemma.org/jacoco/index.html

Oficial jacoco docs para gradle: https://gradle.org/docs/current/userguide/jacoco_plugin.html

Oficial jacoco Githubproblemas, trabajando en la cobertura: https://github.com/jacoco/jacoco/wiki/FilteringOptions https://github.com/jacoco/jacoco/issues/14

Enlaces relacionados de StackOverflow:

JaCoCo & Gradle - Opciones de filtrado (Sin respuesta)

Excluir paquetes del informe de Jacoco usando Sonarrunner y Gradle (sin usarsonar)

JaCoCo: excluir JSP del informe (parece funcionar paramaven, Estoy usando gradle)

Configuración de Maven Jacoco: excluir clases / paquetes del informe que no funciona (parece funcionar paramaven, Estoy usando gradle)

Exclusión del complemento gradle de JaCoCo (No se pudo hacer que esto funcione)

Gradle Jacoco: los informes de cobertura incluyen clases excluidas en la configuración (parece muy cercano, se usó doFirst, no funcionó para mí)

Ejemplo de lo que he probado:

apply plugin: 'java'
apply plugin: 'jacoco'

buildscript {
    repositories {
        mavenCentral()
        jcenter()
    }
}

repositories {
    jcenter()
}

jacocoTestReport {
    reports {
        xml {
            enabled true // coveralls plugin depends on xml format report
        }

        html {
            enabled true
        }
    }

    test {
        jacoco {
            destinationFile = file("$buildDir/jacoco/jacocoTest.exec")
            classDumpFile = file("$buildDir/jacoco/classpathdumps")
            excludes = ["projecteuler/**"] // <-- does not work
            // excludes = ["projecteuler"]
        }
    }
}

Pregunta:

¿Cómo puedo excluir ciertos paquetes y clases al generar el jacoco informes de cobertura?

Gracias a Yannick Welsch:

Después de buscar en Google, leer los documentos de Gradle y revisar las publicaciones más antiguas de StackOverflow, encontré esta respuesta en el Oficial gradle foros!

jacocoTestReport {
    afterEvaluate {
        classDirectories = files(classDirectories.files.collect {
            fileTree(dir: it, exclude: 'com/blah/**')
        })
    }
}

Fuente: https://issues.gradle.org/browse/GRADLE-2955

Solución a mi build.gradlepara proyectos Java / Groovy:

apply plugin: 'java'
apply plugin: 'jacoco'

jacocoTestReport {
    reports {
        xml {
            enabled true // coveralls plugin depends on xml format report
        }

        html {
            enabled true
        }
    }

    afterEvaluate {
        classDirectories = files(classDirectories.files.collect {
            fileTree(dir: it,
                    exclude: ['codeeval/**',
                              'crackingthecode/part3knowledgebased/**',
                              '**/Chapter7ObjectOrientedDesign**',
                              '**/Chapter11Testing**',
                              '**/Chapter12SystemDesignAndMemoryLimits**',
                              'projecteuler/**'])
        })
    }
}

Como puede ver, pude agregar más exclude:para filtrar algunos paquetes.

Fuente: https://github.com/jaredsburrows/CS-Interview-Questions/blob/master/build.gradle

Tareas personalizadas para otros proyectos como Android:

apply plugin: 'jacoco'

task jacocoReport(type: JacocoReport) {
    reports {
        xml {
            enabled true // coveralls plugin depends on xml format report
        }

        html {
            enabled true
        }
    }

    afterEvaluate {
        classDirectories = files(classDirectories.files.collect {
            fileTree(dir: it,
                    exclude: ['codeeval/**',
                              'crackingthecode/part3knowledgebased/**',
                              '**/Chapter7ObjectOrientedDesign**',
                              '**/Chapter11Testing**',
                              '**/Chapter12SystemDesignAndMemoryLimits**',
                              'projecteuler/**'])
        })
    }
}

Fuente: https://github.com/jaredsburrows/android-gradle-java-app-template/blob/master/gradle/quality.gradle#L59

Para la versión 5.x de Gradle, classDirectories = files(...)da una advertencia de obsolescencia y no funciona en absoluto a partir de Gradle 6.0 Esta es la forma no obsoleta de excluir clases:

jacocoTestReport {
    afterEvaluate {
        classDirectories.setFrom(files(classDirectories.files.collect {
            fileTree(dir: it, exclude: 'com/exclude/**')
        }))
    }
}

para mí, está bien trabajar con

test {
  jacoco {
    excludes += ['codeeval/**',
                 'crackingthecode/part3knowledgebased/**',
                 '**/Chapter7ObjectOrientedDesign**',
                 '**/Chapter11Testing**',
                 '**/Chapter12SystemDesignAndMemoryLimits**',
                 'projecteuler/**']
  }
}

como se indica en la documentación https://docs.gradle.org/current/userguide/jacoco_plugin.html#N16E62 y se preguntó inicialmente, por lo que la respuesta es:

así que si me preguntas: no es una cuestión de

excludes = ["projecteuler/**"]

o

excludes += ["projecteuler/**"]

pero

excludes = ["**/projecteuler/**"]

para excluir un paquete *.projecteuler.*

y test {}a nivel de proyecto, no anidado enjacocoTestReport

Para Gradle6 Use algo como a continuación, porque hicieron classDirectories as final, no podemos reasignarlo, pero existe un método de establecimiento classDirectories.setFromque se puede utilizar

    jacocoTestReport {
    reports {
        xml.enabled true
        html.enabled true
        html.destination file("$buildDir/reports/jacoco")
    }

    afterEvaluate {
        classDirectories.setFrom(files(classDirectories.files.collect {
            fileTree(dir: it,
                    exclude: ['**/server/**',
                              '**/model/**',
                              '**/command/**'
                    ]
            )
        }))
    }
}

Aquí hay una solución para este problema en ANT. Esto se puede adaptar a Gradle agregando lo siguiente debajo de la jacocoTestReporttarea. Aunque esto no está realmente documentado por jacoco, parece ser la única forma de filtrar los resultados de la prueba por ahora.

afterEvaluate {
    classDirectories = files(classDirectories.files.collect {
        fileTree(dir: it, exclude: 'excluded/files/**')
    })
}

Esto ha estado fuera por un tiempo, pero me encontré con esto. Estaba luchando con todas las exclusiones necesarias. Descubrí que era algo mucho más simple para mí. Si sigue el estilo de diseño del proyecto Maven / src / main / java y / src / test / java, simplemente necesita poner buildDir / classes / main en su configuración de classDirectories así:

afterEvaluate {
    jacocoTestReport {
        def coverageSourceDirs = ['src/main/java']
        reports {
            xml.enabled false
            csv.enabled false
            html.destination "${buildDir}/reports/jacocoHtml"
        }
        sourceDirectories = files(coverageSourceDirs)
        classDirectories = fileTree(
                dir: "${project.buildDir}/classes/main",
                excludes: [
                      //whatever here like JavaConfig etc. in /src/main/java
                     ]
        )
    }
}

El siguiente código también excluye las clases de la verificación de cobertura:

jacocoTestCoverageVerification {
    afterEvaluate {
        classDirectories = files(classDirectories.files.collect {
            fileTree(dir: "${project.buildDir}/classes/main",
                    exclude: ['**/packagename/**'])
        })
    }
}

algunos comentarios mencionaron la advertencia de desaprobación. para resolver solo usa el getter:

afterEvaluate {
    getClassDirectories().from(files(classDirectories.files.collect {
        fileTree(dir: it, exclude: 'com/blah/**')
    }))
}

Para filtrar en el informe jacoco, la exclusión debe realizarse en dos tareas jacocoTestReporty jacocoTestCoverageVerification.

Código de muestra

    def jacocoExclude = ['**/example/**', '**/*Module*.class']

    jacocoTestReport {
        afterEvaluate {
            getClassDirectories().setFrom(classDirectories.files.collect {
                fileTree(dir: it, exclude: jacocoExclude)
            })
        }
    }

    jacocoTestCoverageVerification {
        afterEvaluate {
            getClassDirectories().setFrom(classDirectories.files.collect {
                fileTree(dir: it, exclude: jacocoExclude)
            })
        }

        ...
    }

agregue la siguiente configuración en el archivo gradle.properties

coverageExcludeClasses=["com.example.package.elasticsearch.*", "com.example.package2.*",]