Проблема:

У меня есть проект с жакоко и я хочу иметь возможность фильтровать определенные классы и / или пакеты.

Связанная документация:

Я прочитал следующую документацию:

Официальный жакокосайт: http://www.eclemma.org/jacoco/index.html

Официальный жакоко документы для Gradle: https://gradle.org/docs/current/userguide/jacoco_plugin.html

Официальный жакоко Githubпроблемы, работающие над покрытием: https://github.com/jacoco/jacoco/wiki/FilteringOptions https://github.com/jacoco/jacoco/issues/14

Связанные ссылки на StackOverflow:

JaCoCo & Gradle - Параметры фильтрации (Нет ответа)

Исключить пакеты из отчета Jacoco с помощью Sonarrunner и Gradle (не использоватьсонар)

JaCoCo - исключить JSP из отчета (похоже, работает дляmaven, Я использую Gradle)

Конфигурация Maven Jacoco - исключить классы / пакеты из отчета, который не работает (похоже, работает дляmaven, Я использую Gradle)

Плагин JaCoCo gradle exclude (не удалось заставить это работать)

Gradle Jacoco - отчеты о покрытии включают классы, исключенные в конфигурации (похоже, очень близко, он использовал doFirst, у меня не работал)

Пример того, что я пробовал:

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"]
        }
    }
}

Вопрос:

Как я могу исключить определенные пакеты и классы при создании жакоко отчеты о покрытии?

Спасибо Yannick Welsch:

После поиска в Google, чтения документов Gradle и просмотра более старых сообщений StackOverflow я нашел этот ответ на официальном сайте. Gradle форумы!

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

Источник: https://issues.gradle.org/browse/GRADLE-2955

Решение для моих build.gradleпроектов 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/**'])
        })
    }
}

Как видите, мне удалось добавить что-то еще exclude:, чтобы отфильтровать несколько пакетов.

Источник: https://github.com/jaredsburrows/CS-Interview-Questions/blob/master/build.gradle

Пользовательские задачи для других проектов, таких как 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/**'])
        })
    }
}

Источник: https://github.com/jaredsburrows/android-gradle-java-app-template/blob/master/gradle/quality.gradle#L59

Для Gradle версии 5.x classDirectories = files(...)выдает предупреждение об устаревании и совсем не работает, начиная с Gradle 6.0. Это нерекомендованный способ исключения классов:

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

для меня нормально работать с

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

как указано в документации https://docs.gradle.org/current/userguide/jacoco_plugin.html#N16E62 и изначально задано, поэтому ответ:

так что если вы спросите меня: это не вопрос

excludes = ["projecteuler/**"]

или

excludes += ["projecteuler/**"]

но

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

исключить пакет *.projecteuler.*

и test {}на уровне проекта, а не вложены вjacocoTestReport

Для Gradle6 используйте что-то вроде ниже, потому что они сделали classDirectories as final, мы не можем переназначить его, но существует метод установки, classDirectories.setFromкоторый можно использовать

    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/**'
                    ]
            )
        }))
    }
}

Вот решение этой проблемы в ANT. Это можно адаптировать к gradle, добавив следующее под jacocoTestReportзадачей. Хотя это на самом деле не задокументировано jacoco, на данный момент это единственный способ отфильтровать результаты теста.

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

Это было давно, но я только что наткнулся на это. Я боролся со всеми необходимыми исключениями. Я обнаружил, что для меня это было намного проще. Если вы следуете стилю макета проекта Maven / src / main / java и / src / test / java, вам просто нужно поместить buildDir / classes / main в конфигурацию classDirectories следующим образом:

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
                     ]
        )
    }
}

Приведенный ниже код также исключает классы из проверки покрытия:

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

в некоторых комментариях упоминалось предупреждение об устаревании. для решения просто используйте геттер:

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

Чтобы выполнить фильтрацию в отчете jacoco, необходимо выполнить исключение в двух задачах jacocoTestReportи jacocoTestCoverageVerification.

образец кода

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

        ...
    }

добавьте ниже конфигурацию в файл gradle.properties

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