Make jacoco test coverage verification fail if there is no test

C-Otto · April 5, 2021, 9:08am

The jacoco plugin provides a task jacocoTestCoverageVerification which fails the build if the coverage is below some configured threshold. However, the plugin only runs if some *.exec file exists, which is created during test execution. If the subproject doesn’t have any test, this file is not created, causing the verification task to be skipped. This is implemented using a file check with onlyIf:

github.com

gradle/gradle/blob/master/subprojects/jacoco/src/main/java/org/gradle/testing/jacoco/tasks/JacocoReportBase.java#L59


*/
public abstract class JacocoReportBase extends JacocoBase {

   private final ConfigurableFileCollection executionData = getProject().files();
   private final ConfigurableFileCollection sourceDirectories = getProject().files();
   private final ConfigurableFileCollection classDirectories = getProject().files();
   private final ConfigurableFileCollection additionalClassDirs = getProject().files();
   private final ConfigurableFileCollection additionalSourceDirs = getProject().files();

   public JacocoReportBase() {
       onlyIf(new Spec<Task>() {
           @Override
           public boolean isSatisfiedBy(Task element) {
               return Iterables.any(getExecutionData(), new Predicate<File>() {
                   @Override
                   public boolean apply(File file) {
                       return file.exists();
                   }
               });
           }
       });

I’d like to think that having no test is a special case of having 0% code coverage, and I’d like to fail my build if that is the case. How can I override the onlyIf in the plugin task definition? Is this a bug worth fixing in Gradle’s code?

Thank you,
Carsten

C-Otto · April 20, 2021, 10:43am

Any help is appreciated: Bug: build should fail if subproject does not have any test · Issue #82 · C-Otto/BitBook · GitHub

C-Otto · November 8, 2022, 1:05pm

abstract class CheckForExecutionDataTask : DefaultTask() {
    @InputFiles
    val executionData = project.files()

    @TaskAction
    fun check() {
        if (executionData.isEmpty) {
            throw GradleException("No tests found for " + this.project)
        }
    }
}

tasks.register<CheckForExecutionDataTask>("checkForExecutionData") {
    mustRunAfter(tasks.withType<Test>())
    executionData.setFrom(fileTree(buildDir).include("/jacoco/*.exec"))
}

tasks.withType<JacocoCoverageVerification>().configureEach {
    dependsOn(tasks.withType<Test>())
    dependsOn(tasks.withType<CheckForExecutionDataTask>())
}