Java project config (JaCoCo)

Java project configuration required to generate JaCoCo report files for use with Cover Reports

JaCoCo reports are an essential component of Cover Reports. Some projects have access to a version of JaCoCo that Cover can use, either through their original configuration or via Cover itself (using Maven). However, if Cover cannot find a suitable JaCoCo configuration (typically detected during Preflight checks), the following minor configuration update for your projects to add the appropriate dependencies and plugins (if you're not already using JaCoCo) should be sufficient.

Add the following declarations to the pom.xml file for the project. The dependency ensures that JaCoCo is available for Cover to use for coverage and reporting analysis. The plugin below configures the JaCoCo plugin to provide reporting information when running tests on the project.

<dependency>
  <groupId>org.jacoco</groupId>
  <artifactId>jacoco-maven-plugin</artifactId>
  <version>0.8.7</version>
</dependency>

<plugin>
  <groupId>org.jacoco</groupId>
  <artifactId>jacoco-maven-plugin</artifactId>
  <version>0.8.7</version>
  <executions>
    <execution>
      <goals>
        <goal>prepare-agent</goal>
      </goals>
    </execution>
    <execution>
      <id>report</id>
      <phase>test</phase>
      <goals>
        <goal>report</goal>
      </goals>
    </execution>
  </executions>
</plugin>

Add the JaCoCo plugin to your build script (build.gradle or build.gradle.kts):

apply plugin: 'jacoco'

Include the following configuration to enable the generation of the XML reports:

jacocoTestReport {
   dependsOn test
   reports {
       xml.required = true
       csv.required = true
   }
}

To ensure that you run JaCoCo, we recommend adding finalizedBy jacocoTestReport to your test configuration, for example:

test {
    finalizedBy jacocoTestReport
}

Add the JaCoCo plugin to your build script (build.gradle or build.gradle.kts):

plugins {
  jacoco
}

Include the following configuration to enable the generation of the XML reports:

tasks {
  jacocoTestReport {
    dependsOn(test)
    reports {
      xml.required.set(true)
      csv.required.set(true)
    }
  }
}

To ensure that you run JaCoCo, we recommend adding finalizedBy jacocoTestReport to your test configuration, for example:

test {
    finalizedBy jacocoTestReport
}

PreviousCover Reports Contributor NextGenerate and upload reports bundles

Last updated 5 months ago

Was this helpful?