Replace usage of Scope API for variants (#209)

* Add AGP 4.1 line to the list of tested plugin versions

* Replace Scope API with manual task name composition

AGP 4.1 removes the Scope API, which necessitates this change

* Reduce visibility of plugin's internal APIs

Make them actually `internal`

* Changelog

Author: mannodermaus

buildSrc/src/main/kotlin/Artifacts.kt

@@ -35,7 +35,7 @@ object Artifacts {
       platform = Java,
       groupId = "de.mannodermaus.gradle.plugins",
       artifactId = "android-junit5",
-      currentVersion = "1.6.1.0-SNAPSHOT",
+      currentVersion = "1.6.0.1-SNAPSHOT",
       latestStableVersion = "1.6.0.0",
       license = license,
       description = "Unit Testing with JUnit 5 for Android."

buildSrc/src/main/kotlin/Libs.kt

@@ -40,6 +40,8 @@ object Libs {
         Versions.com_android_tools_build_gradle_36x
     const val com_android_tools_build_gradle_40x: String = "com.android.tools.build:gradle:" +
         Versions.com_android_tools_build_gradle_40x
+    const val com_android_tools_build_gradle_41x: String = "com.android.tools.build:gradle:" +
+        Versions.com_android_tools_build_gradle_41x
 
     /**
      * https://developer.android.com/studio */

buildSrc/src/main/kotlin/Versions.kt

@@ -18,6 +18,7 @@ object Versions {
   const val com_android_tools_build_gradle_35x: String = "3.5.0"
   const val com_android_tools_build_gradle_36x: String = "3.6.0"
   const val com_android_tools_build_gradle_40x: String = "4.0.0-beta01"
+  const val com_android_tools_build_gradle_41x: String = "4.1.0-alpha01"
   const val com_android_tools_build_gradle: String = com_android_tools_build_gradle_35x
 
   const val lint_gradle: String = "26.5.0"

plugin/CHANGELOG.md

@@ -4,7 +4,9 @@ Change Log
 ## Unreleased
 
 #### Added
+- Compatibility with Android Gradle Plugin 4.1.x
 #### Changed
+- Restricted visibility of internal APIs to prevent them from leaking into consumer code
 #### Fixed
 #### Removed
 

plugin/android-junit5/build.gradle.kts

@@ -50,6 +50,7 @@ gradlePlugin {
 // Use JUnit 5
 tasks.withType<Test> {
   useJUnitPlatform()
+  failFast = true
   testLogging {
     events = setOf(TestLogEvent.STARTED, TestLogEvent.SKIPPED, TestLogEvent.FAILED)
     exceptionFormat = TestExceptionFormat.FULL
@@ -67,6 +68,7 @@ tasks.named("processTestResources", Copy::class.java).configure {
       "AGP_35X" to Versions.com_android_tools_build_gradle_35x,
       "AGP_36X" to Versions.com_android_tools_build_gradle_36x,
       "AGP_40X" to Versions.com_android_tools_build_gradle_40x,
+      "AGP_41X" to Versions.com_android_tools_build_gradle_41x,
       "KOTLIN" to Versions.org_jetbrains_kotlin,
 
       "KOTLIN_STD_LIB" to Libs.kotlin_stdlib,
@@ -112,7 +114,8 @@ data class AgpConfiguration(val version: String, val dependency: String) {
 private val agpConfigurations = listOf(
     AgpConfiguration("3.5", Libs.com_android_tools_build_gradle_35x),
     AgpConfiguration("3.6", Libs.com_android_tools_build_gradle_36x),
-    AgpConfiguration("4.0", Libs.com_android_tools_build_gradle_40x)
+    AgpConfiguration("4.0", Libs.com_android_tools_build_gradle_40x),
+    AgpConfiguration("4.1", Libs.com_android_tools_build_gradle_41x)
 )
 
 configurations {

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

@@ -1,7 +1,6 @@
 package de.mannodermaus.gradle.plugins.junit5
 
 import com.android.build.gradle.api.BaseVariant
-import com.android.build.gradle.internal.variant.BaseVariantData
 import de.mannodermaus.gradle.plugins.junit5.internal.invokeTyped
 import de.mannodermaus.gradle.plugins.junit5.internal.reflectiveMethod
 import org.gradle.api.Project
@@ -23,17 +22,6 @@ import java.io.File
  * =====================================================================================================================
  */
 
-/**
- * Obtains the VariantData of the provided Variant.
- *
- * @because 'BaseVariant.variantData' is protected and can't be accessed through Kotlin directly
- * @return The variant data
- */
-val BaseVariant.variantData: BaseVariantData
-  get() = this.reflectiveMethod("getVariantData")
-      ?.invokeTyped<BaseVariantData>(this)
-      ?: throw IllegalArgumentException("BaseVariant.variantData not available")
-
 /**
  * Obtains the Java class directory for the provided variant in a safe manner.
  *

plugin/android-junit5/src/main/kotlin/de/mannodermaus/gradle/plugins/junit5/internal/ConfigurationKind.kt

@@ -1,6 +1,6 @@
 package de.mannodermaus.gradle.plugins.junit5.internal
 
-enum class ConfigurationKind(internal val value: String) {
+internal enum class ConfigurationKind(internal val value: String) {
   APP(""),
   TEST("test"),
   ANDROID_TEST("androidTest")

plugin/android-junit5/src/main/kotlin/de/mannodermaus/gradle/plugins/junit5/internal/ConfigurationScope.kt

@@ -1,6 +1,6 @@
 package de.mannodermaus.gradle.plugins.junit5.internal
 
-enum class ConfigurationScope(internal vararg val values: String) {
+internal enum class ConfigurationScope(internal vararg val values: String) {
   API("api", "compile"),
   IMPLEMENTATION("implementation", "compile"),
   COMPILE_ONLY("compileOnly", "provided"),

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

@@ -10,14 +10,10 @@ import com.github.zafarkhaja.semver.Version
 import de.mannodermaus.gradle.plugins.junit5.AndroidJUnitPlatformPlugin
 import de.mannodermaus.gradle.plugins.junit5.JUnit5TaskConfig
 import de.mannodermaus.gradle.plugins.junit5.VariantTypeCompat
-import de.mannodermaus.gradle.plugins.junit5.internal.ConfigurationKind.APP
-import de.mannodermaus.gradle.plugins.junit5.variantData
 import org.gradle.api.GradleException
 import org.gradle.api.Project
 import org.gradle.api.Task
-import org.gradle.api.artifacts.Configuration
 import org.gradle.api.artifacts.dsl.DependencyHandler
-import org.gradle.api.internal.tasks.testing.junitplatform.JUnitPlatformTestFramework
 import org.gradle.api.logging.LogLevel
 import org.gradle.api.logging.LogLevel.ERROR
 import org.gradle.api.logging.LogLevel.INFO
@@ -26,8 +22,6 @@ import org.gradle.api.logging.Logger
 import org.gradle.api.plugins.ExtensionAware
 import org.gradle.api.plugins.ExtraPropertiesExtension
 import org.gradle.api.tasks.TaskContainer
-import org.gradle.api.tasks.testing.Test
-import org.gradle.api.tasks.testing.junitplatform.JUnitPlatformOptions
 import org.gradle.util.GradleVersion
 import java.util.Properties
 
@@ -45,7 +39,7 @@ internal fun requireGradle(version: String, message: () -> String) {
   }
 }
 
-fun requireVersion(actual: String, required: String, message: () -> String) {
+internal fun requireVersion(actual: String, required: String, message: () -> String) {
   val actualVersion = Version.valueOf(actual)
   val requiredVersion = Version.valueOf(required)
   require(actualVersion.greaterThanOrEqualTo(requiredVersion)) {
@@ -65,7 +59,7 @@ internal fun loadProperties(resource: String): Properties {
  * and splits it into a list using the delimiter.
  * Returns an empty List if the key doesn't exist in the Map.
  */
-fun Map<String, String>.getAsList(key: String, delimiter: String = ","): List<String> =
+internal fun Map<String, String>.getAsList(key: String, delimiter: String = ","): List<String> =
     this[key]?.split(delimiter) ?: emptyList()
 
 /**
@@ -74,7 +68,7 @@ fun Map<String, String>.getAsList(key: String, delimiter: String = ","): List<St
  * the value is appended to the end of the current value
  * using the given delimiter.
  */
-fun MutableMap<String, String>.append(
+internal fun MutableMap<String, String>.append(
     key: String, value: String, delimiter: String = ","): String? {
   val insertedValue = if (containsKey(key)) {
     "${this[key]}$delimiter$value"
@@ -91,7 +85,7 @@ fun MutableMap<String, String>.append(
  * Log a message with the Android Gradle Plugin style syntax,
  * which will cause Android Studio to pick it up & display it inside the Messages window.
  */
-fun Logger.agpLog(level: LogLevel, message: String) {
+internal fun Logger.agpLog(level: LogLevel, message: String) {
   val pair: Pair<String, (String) -> Unit> = when (level) {
     ERROR -> "error" to { s -> error(s) }
     WARN -> "warning" to { s -> warn(s) }
@@ -107,7 +101,7 @@ fun Logger.agpLog(level: LogLevel, message: String) {
 /**
  * Create & add an Extension to the given container by name.
  */
-inline fun <reified T> Any.extend(
+internal inline fun <reified T> Any.extend(
     name: String,
     args: Array<Any> = emptyArray(),
     noinline init: ((T) -> Unit)? = null): T {
@@ -119,11 +113,11 @@ inline fun <reified T> Any.extend(
 
   // Create & Configure the new extension
   val created: T = this.extensions.create(name, T::class.java, *args)
-  init?.let { init(created) }
+  init?.let { it(created) }
   return created
 }
 
-fun Any.extensionExists(name: String): Boolean {
+internal fun Any.extensionExists(name: String): Boolean {
   if (this !is ExtensionAware) {
     throw IllegalArgumentException("Argument is not ExtensionAware: $this")
   }
@@ -135,7 +129,7 @@ fun Any.extensionExists(name: String): Boolean {
  * Obtain an Extension by name & directly cast it to the expected type.
  */
 @Suppress("UNCHECKED_CAST")
-fun <T> Any.extensionByName(name: String): T {
+internal fun <T> Any.extensionByName(name: String): T {
   if (this !is ExtensionAware) {
     throw IllegalArgumentException("Argument is not ExtensionAware: $this")
   }
@@ -146,27 +140,27 @@ fun <T> Any.extensionByName(name: String): T {
 /**
  * Log the provided info message using the plugin's Log Tag.
  */
-fun Logger.junit5Info(text: String) {
+internal fun Logger.junit5Info(text: String) {
   info("[android-junit5]: $text")
 }
 
 /**
  * Log the provided warning message using the plugin's Log Tag.
  */
-fun Logger.junit5Warn(text: String) {
+internal fun Logger.junit5Warn(text: String) {
   warn("[android-junit5]: $text")
 }
 
 /**
  * Shorthand function to check for the existence of a plugin on a Project.
  */
-fun Project.hasPlugin(name: String) = this.plugins.findPlugin(name) != null
+internal fun Project.hasPlugin(name: String) = this.plugins.findPlugin(name) != null
 
 /**
  * Access the Android extension applied by a respective plugin.
  * Equivalent to "Project#android" in Groovy.
  */
-val Project.android: BaseExtension
+internal val Project.android: BaseExtension
   get() = this.extensions.getByName("android") as BaseExtension
 
 internal fun Project.junit5ConfigurationOf(variant: BaseVariant) =
@@ -176,14 +170,14 @@ internal fun Project.junit5ConfigurationOf(variant: BaseVariant) =
  * Access the extra properties of a DependencyHandler.
  * Equivalent to "DependencyHandler#ext" in Groovy.
  */
-val DependencyHandler.ext: ExtraPropertiesExtension
+internal val DependencyHandler.ext: ExtraPropertiesExtension
   get() {
     val aware = this as ExtensionAware
     return aware.extensions.getByName(
         ExtraPropertiesExtension.EXTENSION_NAME) as ExtraPropertiesExtension
   }
 
-val BaseVariant.unitTestVariant: UnitTestVariant
+internal val BaseVariant.unitTestVariant: UnitTestVariant
   get() {
     if (this !is TestedVariant) {
       throw IllegalArgumentException("Argument is not TestedVariant: $this")
@@ -192,7 +186,7 @@ val BaseVariant.unitTestVariant: UnitTestVariant
     return this.unitTestVariant
   }
 
-val BaseVariant.instrumentationTestVariant: TestVariant?
+internal val BaseVariant.instrumentationTestVariant: TestVariant?
   get() {
     if (this !is TestedVariant) {
       throw IllegalArgumentException("Argument is not TestedVariant: $this")
@@ -201,12 +195,34 @@ val BaseVariant.instrumentationTestVariant: TestVariant?
     return this.testVariant
   }
 
+/**
+ * Composes the name of the variant-specific Gradle task with the given [prefix] and [suffix].
+ * For example, to obtain the "free" variant's assemble task name, call `variant.getTaskName(prefix = "assemble")`.
+ */
+internal fun BaseVariant.getTaskName(prefix: String = "", suffix: String = ""): String {
+  // At least one value must be provided
+  require(prefix.isNotEmpty() || suffix.isNotEmpty())
+
+  return StringBuilder().apply {
+    append(prefix)
+    append(if (isEmpty()) {
+      name
+    } else {
+      name.capitalize()
+    })
+    append(suffix.capitalize())
+  }.toString()
+}
+
 /**
  * Obtains the {AndroidUnitTest} for the provided variant.
  */
-fun TaskContainer.testTaskOf(variant: BaseVariant): AndroidUnitTest {
-  val taskName = variant.variantData.scope.getTaskName(VariantTypeCompat.UNIT_TEST_PREFIX,
-      VariantTypeCompat.UNIT_TEST_SUFFIX)
+internal fun TaskContainer.testTaskOf(variant: BaseVariant): AndroidUnitTest {
+  // From AGP 4.1 onwards, there is no Scope API on VariantData anymore.
+  // Task names must be constructed manually
+  val taskName = variant.getTaskName(
+      prefix = VariantTypeCompat.UNIT_TEST_PREFIX,
+      suffix = VariantTypeCompat.UNIT_TEST_SUFFIX)
   return getByName(taskName) as AndroidUnitTest
 }
 
@@ -216,7 +232,7 @@ fun TaskContainer.testTaskOf(variant: BaseVariant): AndroidUnitTest {
  * in which case the existing task is returned.
  */
 @Suppress("UNCHECKED_CAST")
-fun TaskContainer.maybeCreate(name: String, group: String? = null): Task {
+internal fun TaskContainer.maybeCreate(name: String, group: String? = null): Task {
   val existing = findByName(name)
   return if (existing != null) {
     existing

plugin/android-junit5/src/main/kotlin/de/mannodermaus/gradle/plugins/junit5/internal/Reflective.kt

@@ -13,7 +13,7 @@ import java.lang.reflect.Method
  * @param paramTypes Parameter types of the method's signature
  * @return A reference to the method with that signature, or null if it doesn't exist
  */
-fun Any.reflectiveMethod(named: String, vararg paramTypes: Class<*>): Method? =
+internal fun Any.reflectiveMethod(named: String, vararg paramTypes: Class<*>): Method? =
     try {
       val targetClass = if (this is Class<*>) {
         this
@@ -34,6 +34,6 @@ fun Any.reflectiveMethod(named: String, vararg paramTypes: Class<*>): Method? =
  * @param params Parameters to call the method with
  * @return Result, cast to the desired type
  */
-fun <T> Method.invokeTyped(target: Any? = null, vararg params: Any?): T? {
+internal fun <T> Method.invokeTyped(target: Any? = null, vararg params: Any?): T? {
   return this.invoke(target, *params) as? T?
 }