Проблема:

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

Супутня документація:

Я прочитав таку документацію:

Офіційна джакокосайт: http://www.eclemma.org/jacoco/index.html

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

Офіційна джакоко Githubпитань, працюючи над висвітленням: https://github.com/jacoco/jacoco/wiki/FilteringOptions https://github.com/jacoco/jacoco/isissue/14

Пов'язані посилання StackOverflow:

JaCoCo & Gradle - Параметри фільтрації (немає відповіді)

Виключіть пакунки зі звіту Якоко за допомогою Sonarrunner та Gradle (Не використовуєтьсясонар)

JaCoCo - виключити JSP із звіту (здається, він працює дляmaven, Я використовую градле)

Конфігурація Maven Jacoco - Виключіть класи / пакети із звіту, які не працюють (це, здається, працює дляmaven, Я використовую градле)

Плагін JaCoCo gradle виключити (не вдалося це зробити)

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 я знайшов цю відповідь на Офіційному градле форуми!

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

Джерело: https://isissue.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. Це можна адаптувати до градуля, додавши в jacocoTestReportзавдання наступне . Хоча насправді це не документально підтверджено компанією jacoco, це здається єдиним способом фільтрації результатів тестів.

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

Це вже деякий час, але я просто перебіг це. Я боровся з усіма необхідними виключеннями. Я виявив, що це для мене щось набагато простіше. Якщо ви дотримуєтесь стилю макетування проекту Maven / src / main / java та / src / test / java, вам просто потрібно поставити buildDir / class / 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.*",]