JaCoCo & Gradle - Part 2 - <insert witty blog title>

This is a small follow-up on my first post onJaCoCo & Gradle that shows how to collate and report the code coverage for a multi-project build.

We’ve already seen the basics in part one. We still run JaCoCo during the unit testing, but now the unit testing happens once per Java project.

I decided to collect together the generated JaCoCo coverage files for generating the report, but I think this step could be cut out, but I haven’t tried this simplification yet. Here’s the code coverage run per project and the results copied to the root project’s output directory using the projects’ names as part of the new coverage file names:

subprojects { apply plugin: 'groovy' sourceCompatibility = 1.6 configurations { codeCoverage } dependencies { codeCoverage files("${rootProject.projectDir.path}/lib/jacocoagent.jar") } test { // only include tests from the default package (which are expected to be test suites) include 'Test*' // JaCoCo uses an agent to do code coverage instrumentation on loading rather than instrumenting class files on disk // we set the jacoco property in case code needs to know that jacoco is active (otherwise some reflection tests fail) jvmArgs "-javaagent:${configurations.codeCoverage.singleFile}=destfile=${buildDirName}/coverage-results/jacoco.exec,sessionid=HSServ,append=false", '-Djacoco=true', '-Xms128m', '-Xmx512m', '-XX:MaxPermSize=128m' } task copyCoverageData(dependsOn: test, type: Copy) { from "${buildDirName}/coverage-results" into "${rootProject.buildDir.path}/coverage-results" include 'jacoco.exec' rename 'jacoco.exec', "${project.name}.jacoco.exec" } }

Now we can generate the report from the individual JaCoCo data files and include the source code for each project:

task generateCoverageReport << { ant { taskdef(name:'jacocoreport', classname: 'org.jacoco.ant.ReportTask') { classpath path: "${rootProject.projectDir.path}/lib/jacocoant.jar" } mkdir dir: "${buildDirName}/reports/coverage" jacocoreport { executiondata { fileset(dir: "${buildDirName}/coverage-results") { include name: '*.jacoco.exec' } } structure(name: project.name) { classfiles { dependsOnProjects.each { project -> fileset dir: "${project.buildDir.path}/classes/main" } } sourcefiles(encoding: 'CP1252') { dependsOnProjects.each { project -> fileset dir: "${project.projectDir.path}/src/main/java" } } } xml destfile: "${buildDirName}/reports/coverage/jacoco.xml" html destdir: "${buildDirName}/reports/coverage" } } }

The final part is to wire up the dependencies. We can’t generate the report unless all the sub-projects have finished copying the JaCoCo data files:

It's all About Tech

JaCoCo & Gradle - Part 2

Comments