#56 Allow disabling Jacoco friend tasks based on plugin DSL (#59)

Author: Marcel Schnelle

android-junit5-tests/src/test/kotlin/de/mannodermaus/gradle/plugins/junit5/PluginSpec.kt

@@ -725,6 +725,87 @@ class PluginSpec : Spek({
               }
             }
           }
+
+          context("restricting task generation") {
+            val project by memoized { testProjectBuilder.build() }
+
+            on("disabling task generation altogether") {
+              project.android.testOptions.junitPlatform {
+                jacocoOptions {
+                  taskGenerationEnabled = false
+                }
+              }
+
+              project.evaluate()
+
+              listOf("jacocoTestReport", "jacocoTestReportDebug", "jacocoTestReportRelease")
+                  .forEach { task ->
+                    it("doesn't generate task '$task'") {
+                      assertThat(project.tasks.findByName(task)).isNull()
+                    }
+                  }
+            }
+
+            on("specifying specific variants without product flavors") {
+              project.android.testOptions.junitPlatform {
+                jacocoOptions {
+                  onlyGenerateTasksForVariants("debug")
+                }
+              }
+
+              project.evaluate()
+
+              it("generates main task") {
+                assertThat(project.tasks.findByName("jacocoTestReport")).isNotNull()
+              }
+
+              it("generates debug task") {
+                assertThat(project.tasks.findByName("jacocoTestReportDebug")).isNotNull()
+              }
+
+              it("doesn't generate release task") {
+                assertThat(project.tasks.findByName("jacocoTestReportRelease")).isNull()
+              }
+            }
+
+            on("specifying specific variants with product flavors") {
+              project.android.flavorDimensions("tier")
+              project.android.productFlavors {
+                it.create("paid").dimension = "tier"
+                it.create("free").dimension = "tier"
+              }
+
+              project.android.testOptions.junitPlatform {
+                jacocoOptions {
+                  onlyGenerateTasksForVariants("paidDebug", "freeRelease")
+                }
+              }
+
+              project.evaluate()
+
+              it("generates main task") {
+                assertThat(project.tasks.findByName("jacocoTestReport")).isNotNull()
+              }
+
+              listOf("paidDebug", "freeRelease")
+                  .forEach { generatedTask ->
+                    it("generates $generatedTask task") {
+                      assertThat(
+                          project.tasks.findByName("jacocoTestReport${generatedTask.capitalize()}"))
+                          .isNotNull()
+                    }
+                  }
+
+              listOf("paidRelease", "freeDebug")
+                  .forEach { filteredTask ->
+                    it("doesn't generate $filteredTask task") {
+                      assertThat(
+                          project.tasks.findByName("jacocoTestReport${filteredTask.capitalize()}"))
+                          .isNull()
+                    }
+                  }
+            }
+          }
         }
       }
     }

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

@@ -209,13 +209,26 @@ class AndroidJUnitPlatformExtension extends JUnitPlatformExtension {
     @NonNull
     public List<String> excludedSources = []
 
+    @NonNull
+    private List<String> onlyGenerateTasksForVariants = new ArrayList<>()
+    public boolean taskGenerationEnabled = true
+
     JacocoOptions(Project project) {
       this.project = project
       this.html = new Report()
       this.csv = new Report()
       this.xml = new Report()
     }
 
+    void onlyGenerateTasksForVariants(String... variantNames) {
+      this.onlyGenerateTasksForVariants.addAll(variantNames)
+    }
+
+    @NonNull
+    List<String> onlyGenerateTasksForVariants() {
+      return Collections.unmodifiableList(onlyGenerateTasksForVariants)
+    }
+
     void html(Closure closure) {
       ConfigureUtil.configure(closure, html)
     }

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

@@ -100,8 +100,15 @@ class AndroidJUnitPlatformPlugin : Plugin<Project> {
       val testTask = AndroidJUnit5UnitTest.create(this, variant, directoryProviders)
 
       if (isJacocoApplied) {
-        // Create a Jacoco friend task
-        AndroidJUnit5JacocoReport.create(this, testTask, directoryProviders)
+        val jacocoOptions = junit5.jacocoOptions
+
+        if (jacocoOptions.taskGenerationEnabled) {
+          // Create a Jacoco friend task
+          val enabledVariants = jacocoOptions.onlyGenerateTasksForVariants()
+          if (enabledVariants.isEmpty() || enabledVariants.contains(variant.name)) {
+            AndroidJUnit5JacocoReport.create(this, testTask, directoryProviders)
+          }
+        }
       }
     }
   }