Add and setup code coverage: jacoco plugin.

Author: android10

README.md

@@ -54,6 +54,7 @@ Here are some useful Gradle/adb commands for executing this example:
  * `./gradlew compileApp` - Builds the debug apk.
  * `./gradlew runUnitTests` - Execute unit tests (both unit and integration).
  * `./gradlew runAcceptanceTests` - Execute acceptance and instrumentation tests in the connected device.
+ * `./gradlew runTestCoverage` - Reports code coverage on tests within the Android codebase.
 
 ## Discussions
 Refer to the issues section: https://github.com/android10/Android-CleanArchitecture-Kotlin/issues

buildSrc/src/main/kotlin/scripts/infrastructure.gradle.kts

@@ -3,13 +3,6 @@ package scripts
 import scripts.Variants_gradle.*
 import java.util.*
 
-private object Default {
- const val BUILD_TYPE = BuildTypes.DEBUG
- const val BUILD_FLAVOR = ProductFlavors.DEV
-
- val VARIANT = "${BUILD_FLAVOR.capitalize()}${BUILD_TYPE.capitalize()}"
-}
-
 tasks.register("clean", Delete::class){
  delete(rootProject.buildDir)
 }
@@ -21,22 +14,22 @@ tasks.named<Wrapper>("wrapper") {
 
 tasks.register("runUnitTests") {
  description = "Runs all Unit Tests."
- dependsOn(":app:test${Default.VARIANT}UnitTest")
+ dependsOn(":app:test${Default.BUILD_VARIANT}UnitTest")
 }
 
 tasks.register("runAcceptanceTests") {
  description = "Runs all Acceptance Tests in the connected device."
- dependsOn(":app:connected${Default.VARIANT}AndroidTest")
+ dependsOn(":app:connected${Default.BUILD_VARIANT}AndroidTest")
 }
 
 tasks.register("compileApp") {
  description = "Compiles the Clean Architecture Android Client."
- dependsOn(":app:assemble${Default.VARIANT}")
+ dependsOn(":app:assemble${Default.BUILD_VARIANT}")
 }
 
 tasks.register("runApp", Exec::class) {
  val compileAppTask = "compileApp"
- val installAppTask = ":app:install${Default.VARIANT}"
+ val installAppTask = ":app:install${Default.BUILD_VARIANT}"
 
  description = "Compiles and runs the Clean Architecture Android Client in the connected device."
  dependsOn(compileAppTask, installAppTask)

buildSrc/src/main/kotlin/scripts/quality.gradle.kts

@@ -1,6 +1,11 @@
 package scripts
 
-plugins { id("com.android.application") apply false }
+import scripts.Variants_gradle.*
+
+plugins {
+ id("com.android.application") apply false
+ id("jacoco")
+}
 
 android {
  lintOptions {
@@ -12,4 +17,58 @@ android {
  disable("IconDensities") //For testing purpose. This is safe to remove.
  disable("IconMissingDensityFolder") //For testing purpose. This is safe to remove.
  }
+}
+
+tasks.register("jacocoReport", JacocoReport::class) {
+ group = "Quality"
+ description = "Report code coverage on tests within the Android codebase."
+ dependsOn("test${Default.BUILD_VARIANT}UnitTest")
+
+ val buildVariantClassPath = "${Default.BUILD_FLAVOR}${Default.BUILD_TYPE.capitalize()}"
+ val outputDir = "${project.buildDir}/testCoverage/html"
+
+ reports {
+ xml.isEnabled = true
+ html.isEnabled = true
+ html.destination = file(outputDir)
+ }
+
+ classDirectories.setFrom(fileTree(project.buildDir) {
+ include(
+ "**/classes/**/main/**",
+ "**/intermediates/classes/$buildVariantClassPath/**",
+ "**/intermediates/javac/$buildVariantClassPath/*/classes/**",
+ "**/tmp/kotlin-classes/$buildVariantClassPath/**")
+ exclude(
+ "**/R.class",
+ "**/R\$*.class",
+ "**/BuildConfig.*",
+ "**/Manifest*.*",
+ "**/Manifest$*.class",
+ "**/*Test*.*",
+ "**/Injector.*",
+ "android/**/*.*",
+ "**/*\$Lambda$*.*",
+ "**/*\$inlined$*.*",
+ "**/di/*.*",
+ "**/*Database.*",
+ "**/*Response.*",
+ "**/*Application.*",
+ "**/*Entity.*")
+ }
+ )
+ sourceDirectories.setFrom(fileTree(project.projectDir) {
+ include("src/main/java/**", "src/main/kotlin/**") })
+ executionData.setFrom(fileTree(project.buildDir) {
+ include("**/*.exec", "**/*.ec") })
+
+ doLast {
+ println("Code Coverage Report: $outputDir/index.html")
+ }
+}
+
+tasks.register("runTestCoverage") {
+ group = "Quality"
+ description = "Report code coverage on tests within the Android codebase."
+ dependsOn("jacocoReport")
 }

buildSrc/src/main/kotlin/scripts/variants.gradle.kts

@@ -2,12 +2,12 @@ package scripts
 
 plugins { id("com.android.application") apply false }
 
-object BuildTypes {
+private object BuildTypes {
  const val DEBUG = "debug"
  const val RELEASE = "release"
 }
 
-object ProductFlavors {
+private object ProductFlavors {
  const val DEV = "dev"
  const val INTERNAL = "internal"
  const val PUBLIC = "public"
@@ -17,6 +17,13 @@ private object FlavorDimensions {
  const val DEFAULT = "default"
 }
 
+object Default {
+ const val BUILD_TYPE = BuildTypes.DEBUG
+ const val BUILD_FLAVOR = ProductFlavors.DEV
+
+ val BUILD_VARIANT = "${BUILD_FLAVOR.capitalize()}${BUILD_TYPE.capitalize()}"
+}
+
 android {
  buildTypes {
  getByName(BuildTypes.DEBUG) {