A couple of Gradle plugins to make Android modules work with JaCoCo Report Aggregation Plugin and Test Report Aggregation Plugin
Note
Since the arrival of Kover 0.8.0-Beta2
, this project loses momentum,
as test aggregation of JVM/Kotlin/Android mono-repos is supported out of the box, providing a much better coverage experience than JaCoCo
plugins {
id("org.jetbrains.kotlinx.kover") version "0.8.0-Beta2"
}
subprojects { apply(plugin = "org.jetbrains.kotlinx.kover") }
kover.merge { allProjects() }
Apply the plugin at the root project:
plugins {
id("io.github.gmazzo.test.aggregation.coverage") version "<latest>"
// and/or
id("io.github.gmazzo.test.aggregation.results") version "<latest>"
}
Note
This plugin can not be applied along with the java
one because it conflicts.
If you have a Java root project, it's recommended to move it to a dedicated module
The jacocoAggregatedReport
(for coverage
) and testAggregatedReport
(for results
) will be created
to aggregate test results from all projects in the build
The following is the old README.me of the demo project of my Medium article about this topic, now promoted to dedicated Gradle plugins: io.github.gmazzo.test.aggregation.coverage and io.github.gmazzo.test.aggregation.results
The plugins will automatically aggregate android
modules and java
modules that also apply jacoco
plugin on the
jacocoAggregation
and the testReportAggregation
configurations.
You control which projects are effectively included by using the DSL:
testAggregation {
modules {
include(project(":app"))
exclude(projects.lib) // typesafe accessors are also supported!
}
}
You can use the DSL to include/exclude .class
files from the aggregated JaCoCo coverage report:
testAggregation {
coverage {
include("com/**/Login*") // will only include classes starting with `com.` containing `Login` on its name
}
}
It's important to realize the filtering is done at .class
file level (compiled classes).
You should not use classes names here but GLOB patterns.
This is an example project that illustrates how can the
JaCoCo Report Aggregation Plugin and
Test Report Aggregation Plugin
can be used to aggregate a complex Android project with JVM modules in a single :jacocoAggregatedReport
and :testAggregatedReport
tasks.
- A
plugin
included build that provides thecoverage
root plugin - A
demo-project
with:- An
app
android module (with Robolectric tests) - A
login
android library module (with JUnit4/JVM tests) - A
domain
jvm module (with tests)
- An
The plugin fills the gaps between AGP and JaCoCo Report Aggregation Plugin by providing the necessary setup missing:
- It applies
jacoco-report-aggregation
andtest-report-aggregation
at root project - Creates
jacocoAggregatedReport
andtestAggregatedReport
forTestSuiteType.UNIT_TEST
- If a module applies
jacoco
plugin, it adds it to thejacocoAggregation
andtestReportAggregation
root configurations - If a module applies the
java
plugin, makes its childjacocoAggregatedReport
task to depend ontest
- If a module applies the
android
plugin:- it enables by default
BuildType.enableUnitTestCoverage
ondebug
to produce jacoco exec files - adds the
codeCoverageExecutionData
,codeCoverageSources
,codeCoverageElements
(classes) andtestResultsElements
outgoing variants, to allowjacoco-report-aggregation
andtest-report-aggregation
to aggregate it
- it enables by default
Please note that JVM still need to manually apply jacoco
plugin (this is an intentional opt-in behavior)
build.gradle.kts