Integrate Plugin with Instrumented Test companion library through config

The new ProductFlavor function "junit5InstrumentedTestsEnabled" connects
the RunnerBuilder to JUnit 5 to run instrumented tests through the
companion library "android-instrumentation-test"

Author: mannodermaus

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

@@ -77,4 +77,34 @@ class AGP2PluginSpec extends BasePluginSpec {
     def runAllTask = project.tasks.getByName("jacocoTestReport")
     expectedVariantTasks.each { assert runAllTask.getDependsOn().contains(it) }
   }
+
+  def "Instrumentation Test Integration: Works with Product Flavors"() {
+    when:
+    Project project = factory.newProject(rootProject())
+        .asAndroidApplication()
+        .applyJunit5Plugin()
+        .build()
+
+    project.android {
+      productFlavors {
+        paid {
+          junit5InstrumentedTestsEnabled false
+        }
+        free {
+          junit5InstrumentedTestsEnabled true
+        }
+      }
+    }
+
+    project.evaluate()
+
+    then:
+    def enabledFlavor = project.android.productFlavors.getByName("free")
+    def enabledArgs = enabledFlavor.getTestInstrumentationRunnerArguments()
+    assert enabledArgs.containsKey("runnerBuilder")
+
+    def disabledFlavor = project.android.productFlavors.getByName("paid")
+    def disabledArgs = disabledFlavor.getTestInstrumentationRunnerArguments()
+    assert !disabledArgs.containsKey("runnerBuilder")
+  }
 }

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

@@ -143,4 +143,39 @@ class AGP3PluginSpec extends BasePluginSpec {
     project.tasks.findByName("jacocoTestReportDebug") == null
     project.tasks.findByName("jacocoTestReportRelease") == null
   }
+
+  def "Instrumentation Test Integration: Works with Product Flavors"() {
+    when:
+    Project project = factory.newProject(rootProject())
+        .asAndroidApplication()
+        .applyJunit5Plugin()
+        .build()
+
+    project.android {
+      // "All flavors must now belong to a named flavor dimension"
+      flavorDimensions "price"
+
+      productFlavors {
+        paid {
+          dimension "price"
+          junit5InstrumentedTestsEnabled false
+        }
+        free {
+          dimension "price"
+          junit5InstrumentedTestsEnabled true
+        }
+      }
+    }
+
+    project.evaluate()
+
+    then:
+    def enabledFlavor = project.android.productFlavors.getByName("free")
+    def enabledArgs = enabledFlavor.getTestInstrumentationRunnerArguments()
+    assert enabledArgs.containsKey("runnerBuilder")
+
+    def disabledFlavor = project.android.productFlavors.getByName("paid")
+    def disabledArgs = disabledFlavor.getTestInstrumentationRunnerArguments()
+    assert !disabledArgs.containsKey("runnerBuilder")
+  }
 }

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

@@ -440,4 +440,24 @@ abstract class BasePluginSpec extends Specification {
     project.tasks.findByName("jacocoTestReportDebug") == null
     project.tasks.findByName("jacocoTestReportRelease") == null
   }
+
+  def "Instrumentation Test Integration: Enabled"() {
+    when:
+    Project project = factory.newProject(rootProject())
+        .asAndroidApplication()
+        .applyJunit5Plugin()
+        .build()
+
+    project.android {
+      defaultConfig {
+        junit5InstrumentedTestsEnabled true
+      }
+    }
+
+    project.evaluate()
+
+    then:
+    def args = project.android.defaultConfig.getTestInstrumentationRunnerArguments()
+    assert args.containsKey("runnerBuilder")
+  }
 }

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

@@ -0,0 +1,18 @@
+package de.mannodermaus.gradle.plugins.junit5
+
+import org.junit.Test
+
+class CallableGroovyTests {
+  @Test
+  void callable() {
+    def obj = new Callable({ 2 + 2 })
+    assert obj() == 4
+  }
+
+  @Test
+  void callable1() {
+    def obj = new Callable1<Boolean, Integer>({ state -> 2 + (state ? 1 : 0) })
+    assert obj(true) == 3
+    assert obj(false) == 2
+  }
+}

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

@@ -0,0 +1,18 @@
+package de.mannodermaus.gradle.plugins.junit5
+
+import org.junit.Test
+
+class CallableKotlinTests {
+  @Test
+  fun callable() {
+    val obj = Callable { 2 + 2 }
+    assert(obj() == 4)
+  }
+
+  @Test
+  fun callable1() {
+    val obj = Callable1<Boolean, Int> { state -> 2 + if (state) 1 else 0 }
+    assert(obj(true) == 3)
+    assert(obj(false) == 2)
+  }
+}

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

@@ -18,3 +18,15 @@ const val JUNIT_PLATFORM_VERSION_PROP = "junitPlatformVersion"
 const val JUNIT_JUPITER_VERSION_PROP = "junitJupiterVersion"
 const val JUNIT_VINTAGE_VERSION_PROP = "junitVintageVersion"
 const val JUNIT4_VERSION_PROP = "junit4Version"
+
+// Instrumentation Test integration
+const val RUNNER_BUILDER_ARG = "runnerBuilder"
+const val JUNIT5_RUNNER_BUILDER_CLASS_NAME = "de.mannodermaus.junit5.AndroidJUnit5Builder"
+
+// Dependency Handler Names
+const val DEP_HANDLER_NAME_JUNIT5 = "junit5"
+const val DEP_HANDLER_NAME_PARAMETERIZED = "junit5Params"
+const val DEP_HANDLER_NAME_RUNTIME = "junit5EmbeddedRuntime"
+
+// Configuration Names
+const val PARAM_NAME_ENABLE_INSTRUMENTED_TESTS = "junit5InstrumentedTestsEnabled"

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

@@ -4,6 +4,7 @@ import com.android.build.gradle.BaseExtension
 import com.android.build.gradle.api.BaseVariant
 import com.android.build.gradle.api.UnitTestVariant
 import com.android.build.gradle.internal.api.TestedVariant
+import com.android.builder.model.ProductFlavor
 import de.mannodermaus.gradle.plugins.junit5.tasks.AndroidJUnit5JacocoReport
 import de.mannodermaus.gradle.plugins.junit5.tasks.AndroidJUnit5UnitTest
 import groovy.lang.Closure
@@ -135,6 +136,17 @@ val DependencyHandler.ext: ExtraPropertiesExtension
         ExtraPropertiesExtension.EXTENSION_NAME) as ExtraPropertiesExtension
   }
 
+/**
+ * Access the extra properties of a ProductFlavor.
+ * Equivalent to "ProductFlavor#ext" in Groovy.
+ */
+val ProductFlavor.ext: ExtraPropertiesExtension
+  get() {
+    val aware = this as ExtensionAware
+    return aware.extensions.getByName(
+        ExtraPropertiesExtension.EXTENSION_NAME) as ExtraPropertiesExtension
+  }
+
 val BaseVariant.unitTestVariant: UnitTestVariant
   get() {
     if (this !is TestedVariant) {
@@ -205,3 +217,29 @@ class Callable(private val body: () -> Any) : Closure<Any>(null) {
   /** Groovy's call syntax */
   fun doCall(): Any = body()
 }
+
+/**
+ * Multi-language functional construct,
+ * mapped to Groovy's dynamic Closures as well as Kotlin's invoke syntax.
+ *
+ * A [Callable] 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
+ * </pre></code>
+ *
+ * <code><pre>
+ *   def callable = new Callable({ 2 + 2 })
+ *   def result = callable()  // result == 4
+ * </pre></code>
+ */
+@Suppress("unused")
+class Callable1<in T : Any, R>(private val body: (T) -> R) : Closure<R>(null) {
+  /** Kotlin's call syntax */
+  operator fun invoke(arg: T): R = body(arg)
+
+  /** Groovy's call syntax */
+  fun doCall(arg: T): R = body(arg)
+}

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

@@ -1,6 +1,7 @@
 package de.mannodermaus.gradle.plugins.junit5
 
 import com.android.build.gradle.api.BaseVariant
+import de.mannodermaus.gradle.plugins.junit5.integrations.attachInstrumentationTestSupport
 import de.mannodermaus.gradle.plugins.junit5.providers.DirectoryProvider
 import de.mannodermaus.gradle.plugins.junit5.providers.JavaDirectoryProvider
 import de.mannodermaus.gradle.plugins.junit5.providers.KotlinDirectoryProvider
@@ -47,6 +48,9 @@ class AndroidJUnitPlatformPlugin : Plugin<Project> {
       }
       createExtension<AndroidJUnit5JacocoReport.Extension>(JACOCO_EXTENSION_NAME)
     }
+
+    // Connect with integration libraries
+    attachInstrumentationTestSupport()
   }
 
   private fun Project.configureDependencies() {
@@ -68,7 +72,7 @@ class AndroidJUnitPlatformPlugin : Plugin<Project> {
     }
 
     // Create the dependency handlers for JUnit 5
-    project.dependencies.ext["junit5"] = Callable {
+    project.dependencies.ext[DEP_HANDLER_NAME_JUNIT5] = Callable {
       withDependencies(defaults) {
         listOf(
             it.others.junit4,
@@ -85,11 +89,11 @@ class AndroidJUnitPlatformPlugin : Plugin<Project> {
       }
     }
 
-    project.dependencies.ext["junit5Params"] = Callable {
+    project.dependencies.ext[DEP_HANDLER_NAME_PARAMETERIZED] = Callable {
       withDependencies(defaults) { it.jupiter.params }
     }
 
-    project.dependencies.ext["junit5EmbeddedRuntime"] = Callable {
+    project.dependencies.ext[DEP_HANDLER_NAME_RUNTIME] = Callable {
       withDependencies(defaults) { it.others.embeddedRuntime }
     }
   }