bld-jacoco-report/README.md

2.1 KiB

Bld Extension to Generate Code Coverage Reports with JaCoCo

License Java Release Snapshot GitHub CI

To run the tests and generate the code coverage reports:

@BuildCommand(summary = "Generates Jacoco Reports")
public void jacoco() throws IOException {
    new JacocoReportOperation()
            .fromProject(this)
            .execute();
}
./bld compile jacoco
  • The HTML, CSV and XML reports will be automatically created in the build/reports/jacoco/test directory.
  • The execution coverage data will be automatically recorded in the build/jacoco/jacoco.exec file.

Please check the JacocoReportOperation documentation for all available configuration options.

SonarQube/SonarCloud

To use a JaCoCo report with sonar, add something like the following to your sonar-project.properties:

sonar.organization=YOUR_ORGANIZATION
sonar.projectKey=YOUR_PROJECT_KEY
sonar.coverage.jacoco.xmlReportPaths=build/reports/jacoco/test/jacocoTestReport.xml
sonar.sources=src/main/java/
sonar.tests=src/test/java/
sonar.java.binaries=build/main,build/test
sonar.java.libraries=lib/compile/*.jar