Add Exclusion Rules for Jacoco Tasks (#44)

* Update to Gradle 4.4

* Use common exclusion rules for Jacoco & customizability

* Added new DSL "junitPlatform.jacoco.excludedClasses"
* Added new DSL "junitPlatform.jacoco.excludedSources"
* Automatically add R.class to excluded classes

Author: mannodermaus

android-junit5-tests/testAgp2x/src/test/groovy/de/mannodermaus/gradle/plugins/junit5/AGP2FunctionalSpec.groovy

@@ -21,9 +21,9 @@ class AGP2FunctionalSpec extends BaseFunctionalSpec {
     def flavors = flavorNames.collect { "$it {}" }.join("\n")
 
     return """
-productFlavors {
-  $flavors
-}
-"""
+      productFlavors {
+        $flavors
+      }
+    """
   }
 }

android-junit5-tests/testAgp3x/src/test/groovy/de/mannodermaus/gradle/plugins/junit5/AGP3FunctionalSpec.groovy

@@ -21,10 +21,10 @@ class AGP3FunctionalSpec extends BaseFunctionalSpec {
     def flavors = flavorNames.collect { """$it { dimension "tier" }""" }.join("\n")
 
     return """
-flavorDimensions "tier"
-productFlavors {
-  $flavors
-}
-"""
+      flavorDimensions "tier"
+      productFlavors {
+        $flavors
+      }
+    """
   }
 }

android-junit5-tests/testCommon/src/test/groovy/de/mannodermaus/gradle/plugins/junit5/BasePluginSpec.groovy

@@ -576,6 +576,88 @@ abstract class BasePluginSpec extends Specification {
     assert !runRelease.classDirectories.asPath.contains("classes/test/")
   }
 
+  def "Jacoco Exclude Rules: Addition"() {
+    when:
+    Project project = factory.newProject(rootProject())
+        .asAndroidApplication()
+        .applyJunit5Plugin()
+        .applyJacocoPlugin()
+        .build()
+
+    // Create some fake class files to verify the Jacoco task's tree
+    project.file("build/intermediates/classes/debug").mkdirs()
+    project.file("build/intermediates/classes/debug/R.class").createNewFile()
+    project.file("build/intermediates/classes/debug/FirstFile.class").createNewFile()
+    project.file("build/intermediates/classes/debug/SecondFile.class").createNewFile()
+    project.file("src/main/java").mkdirs()
+    project.file("src/main/java/OkFile.java").createNewFile()
+    project.file("src/main/java/AnnoyingFile.java").createNewFile()
+
+    project.junitPlatform {
+      jacoco {
+        // In addition to the default exclusion rules for R.class,
+        // also exclude any class prefixed with "Second"
+        excludedClasses += "Second*.class"
+        excludedSources += "AnnoyingFile.java"
+      }
+    }
+
+    project.evaluate()
+
+    then:
+    def jacocoTask = project.tasks.getByName("jacocoTestReportDebug") as AndroidJUnit5JacocoReport
+
+    def classFiles = jacocoTask.classDirectories.asFileTree.files
+    classFiles.find { it.name == "R.class" } == null
+    classFiles.find { it.name == "FirstFile.class" } != null
+    classFiles.find { it.name == "SecondFile.class" } == null
+
+    def sourceFiles = jacocoTask.sourceDirectories.asFileTree.files
+    sourceFiles.find { it.name == "OkFile.java" } != null
+    sourceFiles.find { it.name == "AnnoyingFile.java" } == null
+  }
+
+  def "Jacoco Exclude Rules: Replacement"() {
+    when:
+    Project project = factory.newProject(rootProject())
+        .asAndroidApplication()
+        .applyJunit5Plugin()
+        .applyJacocoPlugin()
+        .build()
+
+    // Create some fake class files to verify the Jacoco task's tree
+    project.file("build/intermediates/classes/debug").mkdirs()
+    project.file("build/intermediates/classes/debug/R.class").createNewFile()
+    project.file("build/intermediates/classes/debug/FirstFile.class").createNewFile()
+    project.file("build/intermediates/classes/debug/SecondFile.class").createNewFile()
+    project.file("src/main/java").mkdirs()
+    project.file("src/main/java/OkFile.java").createNewFile()
+    project.file("src/main/java/AnnoyingFile.java").createNewFile()
+
+    project.junitPlatform {
+      jacoco {
+        // Replace the default exclusion rules
+        // and only exclude any class prefixed with "Second"
+        excludedClasses = ["Second*.class"]
+        excludedSources = ["AnnoyingFile.java"]
+      }
+    }
+
+    project.evaluate()
+
+    then:
+    def jacocoTask = project.tasks.getByName("jacocoTestReportDebug") as AndroidJUnit5JacocoReport
+
+    def files = jacocoTask.classDirectories.asFileTree.files
+    files.find { it.name == "R.class" } != null
+    files.find { it.name == "FirstFile.class" } != null
+    files.find { it.name == "SecondFile.class" } == null
+
+    def sourceFiles = jacocoTask.sourceDirectories.asFileTree.files
+    sourceFiles.find { it.name == "OkFile.java" } != null
+    sourceFiles.find { it.name == "AnnoyingFile.java" } == null
+  }
+
   def "Library: Basic Integration"() {
     when:
     Project project = factory.newProject(rootProject())

android-junit5/src/main/groovy/de/mannodermaus/gradle/plugins/junit5/AndroidJUnitPlatformExtension.groovy

@@ -206,6 +206,12 @@ class AndroidJUnitPlatformExtension extends JUnitPlatformExtension {
     private final Report csv
     private final Report xml
 
+    @NonNull
+    public List<String> excludedClasses = ["**/R.class", '**/R$*.class']
+
+    @NonNull
+    public List<String> excludedSources = []
+
     JacocoOptions(Project project) {
       this.project = project
       this.html = new Report()

android-junit5/src/main/kotlin/de/mannodermaus/gradle/plugins/junit5/Extensions.kt

@@ -206,19 +206,19 @@ fun Project.withDependencies(defaults: Properties, config: (Versions) -> Any): A
 /* Types */
 
 /**
- * Multi-language functional construct,
+ * Multi-language functional construct with no parameters,
  * mapped to Groovy's dynamic Closures as well as Kotlin's invoke syntax.
  *
  * A [Callable0] can be invoked with the short-hand
  * function syntax from both Kotlin & Groovy:
  *
  * <code><pre>
- *   val callable = Callable { 2 + 2 }
+ *   val callable = Callable0 { 2 + 2 }
  *   val result = callable()  // result == 4
  * </pre></code>
  *
  * <code><pre>
- *   def callable = new Callable({ 2 + 2 })
+ *   def callable = new Callable0({ 2 + 2 })
  *   def result = callable()  // result == 4
  * </pre></code>
  */
@@ -232,20 +232,20 @@ class Callable0<R>(private val body: () -> R) : Closure<R>(null) {
 }
 
 /**
- * Multi-language functional construct,
+ * Multi-language functional construct with 1 parameter,
  * mapped to Groovy's dynamic Closures as well as Kotlin's invoke syntax.
  *
  * A [Callable1] can be invoked with the short-hand
  * function syntax from both Kotlin & Groovy:
  *
  * <code><pre>
- *   val callable = Callable { 2 + 2 }
- *   val result = callable()  // result == 4
+ *   val callable = Callable1 { 2 + it }
+ *   val result = callable(2)  // result == 4
  * </pre></code>
  *
  * <code><pre>
- *   def callable = new Callable({ 2 + 2 })
- *   def result = callable()  // result == 4
+ *   def callable = new Callable1({ input ->  2 + input })
+ *   def result = callable(2)  // result == 4
  * </pre></code>
  */
 @Suppress("unused")

android-junit5/src/main/kotlin/de/mannodermaus/gradle/plugins/junit5/tasks/Jacoco.kt

@@ -8,7 +8,9 @@ import de.mannodermaus.gradle.plugins.junit5.providers.DirectoryProvider
 import de.mannodermaus.gradle.plugins.junit5.providers.mainClassDirectories
 import de.mannodermaus.gradle.plugins.junit5.providers.mainSourceDirectories
 import org.gradle.api.Project
+import org.gradle.api.file.FileCollection
 import org.gradle.testing.jacoco.tasks.JacocoReport
+import java.io.File
 
 private const val TASK_NAME_DEFAULT = "jacocoTestReport"
 private const val GROUP_REPORTING = "reporting"
@@ -51,12 +53,6 @@ open class AndroidJUnit5JacocoReport : JacocoReport() {
       reportTask.description = "Generates Jacoco coverage reports " +
           "for the ${variant.name.capitalize()} variant."
 
-      // Task-level Configuration
-      val taskJacoco = testTask.jacoco
-      reportTask.executionData = project.files(taskJacoco.destinationFile.path)
-      reportTask.classDirectories = project.files(directoryProviders.mainClassDirectories())
-      reportTask.sourceDirectories = project.files(directoryProviders.mainSourceDirectories())
-
       // Apply JUnit 5 configuration parameters
       val junit5Jacoco = project.junit5.jacoco
       val allReports = listOf(
@@ -69,6 +65,17 @@ open class AndroidJUnit5JacocoReport : JacocoReport() {
         from.destination?.let { to.destination = it }
       }
 
+      // Task-level Configuration
+      val taskJacoco = testTask.jacoco
+      reportTask.executionData = project.files(taskJacoco.destinationFile.path)
+
+      // Apply exclusion rules to both class & source directories for Jacoco,
+      // using the sum of all DirectoryProviders' outputs as a foundation:
+      reportTask.classDirectories = directoryProviders.mainClassDirectories()
+          .toFileCollectionExcluding(junit5Jacoco.excludedClasses)
+      reportTask.sourceDirectories = directoryProviders.mainSourceDirectories()
+          .toFileCollectionExcluding(junit5Jacoco.excludedSources)
+
       project.logger.junit5Info(
           "Assembled Jacoco Code Coverage for JUnit 5 Task '${testTask.name}':")
       project.logger.junit5Info("|__ Execution Data: ${reportTask.executionData.asPath}")
@@ -81,5 +88,18 @@ open class AndroidJUnit5JacocoReport : JacocoReport() {
           group = GROUP_REPORTING)
       defaultJacocoTask.dependsOn(reportTask)
     }
+
+    /* Extension Functions */
+
+    /**
+     * Joins the given collection of Files together, while
+     * ignoring the provided patterns in the resulting FileCollection.
+     */
+    private fun Iterable<File>.toFileCollectionExcluding(
+        patterns: Iterable<String>): FileCollection = this
+        // Convert each directory to a Gradle FileTree, excluding the specified patterns
+        .map { project.fileTree(it).exclude(patterns) }
+        // Convert the resulting list of FileTree objects into a single FileCollection
+        .run { project.files(this) }
   }
 }

gradle/wrapper/gradle-wrapper.jar

@@ -2,4 +2,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-4.4-rc-4-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-4.4-bin.zip