Add support for AndroidX Test Runner 1.4.0 as it was incompatible with this library due to internal changes in AndroidJUnitRunner and the fact that rely on reflection.

Piotr Zawadzki · Piotr Zawadzki · commit b0e514cc478a · 2021-08-13T10:47:19.000+02:00
Fixes issue #6
diff --git a/README.md b/README.md
@@ -85,6 +85,7 @@ Here are some samples:
 
 | XRunner version                                                          | Test runner version                     |
 |:------------------------------------------------------------------------:|:---------------------------------------:|
+| [X.Y.Z](https://github.com/stepstone-tech/AndroidTestXRunner/tree/X.Y.Z) | `androidx.test:runner:1.4.0`            |
 | [2.1.0](https://github.com/stepstone-tech/AndroidTestXRunner/tree/2.1.0) | `androidx.test:runner:1.2.0`            |
 | [2.0.0](https://github.com/stepstone-tech/AndroidTestXRunner/tree/2.0.0) | `androidx.test:runner:1.1.0`            |
 | [1.0.0](https://github.com/stepstone-tech/AndroidTestXRunner/tree/1.0.0) | `com.android.support.test:runner:1.0.2` |
diff --git a/build.gradle b/build.gradle
@@ -2,7 +2,7 @@
 
 buildscript {
     ext.KOTLIN_VERSION = '1.3.41'
-    ext.ANDROID_GRADLE_PLUGIN_VERSION = '3.5.0'
+    ext.ANDROID_GRADLE_PLUGIN_VERSION = '3.5.4'
     ext.DOKKA_VERSION = '0.9.17'
     ext.BINTRAY_VERSION = '1.8.4'
     repositories {
@@ -30,19 +30,19 @@ allprojects {
 configure(allprojects) {
     ext {
         ANDROID_MIN_SDK_VERSION             = 19
-        ANDROID_TARGET_SDK_VERSION          = 28
-        ANDROID_COMPILE_SDK_VERSION         = 28
+        ANDROID_TARGET_SDK_VERSION          = 30
+        ANDROID_COMPILE_SDK_VERSION         = 30
 
-        TEST_RUNNER_VERSION                 = '1.2.0'
+        TEST_RUNNER_VERSION                 = '1.4.0'
         SUPER_REFLEKT_VERSION               = '1.0.1'
 
         // Sample app only
-        TEST_RULES_VERSION                  = '1.2.0'
-        TEST_EXT_VERSION                    = '1.1.1'
-        TEST_ORCHESTRATOR_VERSION           = '1.2.0'
-        ESPRESSO_VERSION                    = '3.2.0'
+        TEST_RULES_VERSION                  = '1.4.0'
+        TEST_EXT_VERSION                    = '1.1.3'
+        TEST_ORCHESTRATOR_VERSION           = '1.4.0'
+        ESPRESSO_VERSION                    = '3.4.0'
         APPCOMPAT_VERSION                   = '1.1.0'
-        MATERIAL_VERSION                    = '1.1.0-alpha10'
+        MATERIAL_VERSION                    = '1.1.0'
         CONSTRAINT_VERSION                  = '1.1.3'
     }
 }
diff --git a/xrunner-library/src/main/java/com/stepstone/xrunner/AndroidJUnitXRunner.kt b/xrunner-library/src/main/java/com/stepstone/xrunner/AndroidJUnitXRunner.kt
@@ -1,11 +1,11 @@
 package com.stepstone.xrunner
 
 import android.os.Bundle
+import android.util.Log
+import androidx.test.internal.events.client.TestEventClient
 import androidx.test.internal.runner.RunnerArgs
 import androidx.test.internal.runner.TestRequestBuilder
-import androidx.test.orchestrator.instrumentationlistener.OrchestratedInstrumentationListener
 import androidx.test.runner.AndroidJUnitRunner
-import android.util.Log
 import com.stepstone.xrunner.internal.ARGUMENT_CLASS
 import com.stepstone.xrunner.internal.ARGUMENT_LIST_TESTS_FOR_ORCHESTRATOR
 import com.stepstone.xrunner.internal.ARGUMENT_NOT_CLASS
@@ -33,7 +33,7 @@ open class AndroidJUnitXRunner : AndroidJUnitRunner() {
     companion object {
         private const val TAG = "XRunner"
 
-        private const val RUNNER_FIELD_ORCHESTRATOR_LISTENER = "orchestratorListener"
+        private const val RUNNER_FIELD_TEST_EVENT_CLIENT = "testEventClient"
         private const val RUNNER_FIELD_RUNNER_ARGS = "runnerArgs"
         private const val RUNNER_METHOD_CREATE_TEST_REQUEST_BUILDER = "createTestRequestBuilder"
         private const val RUNNER_ARGS_FIELD_LISTENERS = "listeners"
@@ -61,13 +61,13 @@ open class AndroidJUnitXRunner : AndroidJUnitRunner() {
     }
 
     override fun onStart() {
-        val orchestratorListener = SuperReflect.on(this).get<OrchestratedInstrumentationListener>(RUNNER_FIELD_ORCHESTRATOR_LISTENER)
+        val testEventClient = SuperReflect.on(this).get<TestEventClient>(RUNNER_FIELD_TEST_EVENT_CLIENT)
 
         if (shouldUpdateTestSuiteForXRunner()) {
             val runCount = getXRunnerCountArgument(modifiedBundle)
-            addXRunnerTestsWithOrchestrator(runCount, modifiedBundle, orchestratorListener)
+            addXRunnerTestsWithOrchestrator(runCount, modifiedBundle, testEventClient)
         } else if (isXRunnerTestExecution(originalBundle)) {
-            updateListenersBeforeXRunnerTestExecution(orchestratorListener)
+            updateListenersBeforeXRunnerTestExecution(testEventClient)
         }
         super.onStart()
     }
@@ -87,7 +87,7 @@ open class AndroidJUnitXRunner : AndroidJUnitRunner() {
     @Suppress("DEPRECATION")
     private fun isPrimaryInstrumentationProcess(): Boolean = isPrimaryInstrProcess(originalBundle.getString(ARGUMENT_TARGET_PROCESS))
 
-    private fun addXRunnerTestsWithOrchestrator(runCount: Int, bundle: Bundle, orchestratorListener: OrchestratedInstrumentationListener) {
+    private fun addXRunnerTestsWithOrchestrator(runCount: Int, bundle: Bundle, testEventClient: TestEventClient) {
         val testDescriptionFromBundle = getTestDescriptionFromBundle(bundle)
         val testsToRerun = getMethodTestArgumentsFromDescription(testDescriptionFromBundle)
 
@@ -98,29 +98,30 @@ open class AndroidJUnitXRunner : AndroidJUnitRunner() {
             .flatMap { testArg -> (1 until runCount).map { createXRunnerTestDescription(testArg, it) }.asSequence() }
             .forEach {
                 Log.d(TAG, "Adding '$it' to test suite")
-                orchestratorListener.addTests(it)
+                testEventClient.addTests(it)
             }
     }
 
     private fun shouldUpdateTestSuiteForXRunner(): Boolean {
+        // TODO: 12/08/2021 check for orchestration V2
         val listTestsForOrchestrator = (originalBundle.getString(ARGUMENT_LIST_TESTS_FOR_ORCHESTRATOR, false.toString())!!).toBoolean()
         return listTestsForOrchestrator && isPrimaryInstrumentationProcess() && shouldUseXRunner(originalBundle)
     }
 
-    private fun updateListenersBeforeXRunnerTestExecution(orchestratorListener: OrchestratedInstrumentationListener) {
+    private fun updateListenersBeforeXRunnerTestExecution(testEventClient: TestEventClient) {
         val runnerArgs = getRunnerArgsWithReflection()
         SuperReflect.on(runnerArgs).set(
             RUNNER_ARGS_FIELD_LISTENERS, mutableListOf<RunListener>(
                 OrchestratorListenerWrapper(
-                    orchestratorListener,
+                    testEventClient.runListener!!,
                     originalTestToRun
                 )
             )
         )
-        /* We need to set this listener to null as otherwise it would be added in AndroidJUnitRunner#addListeners()
+        /* We need to set test event client to no-op as otherwise it would be added in AndroidJUnitRunner#addListeners()
          * and it would duplicate what SCXRunnerOrchestratorListenerWrapper is already doing.
          */
-        SuperReflect.on(this).set(RUNNER_FIELD_ORCHESTRATOR_LISTENER, null)
+        SuperReflect.on(this).set(RUNNER_FIELD_TEST_EVENT_CLIENT, TestEventClient.NO_OP_CLIENT)
     }
 
     private fun getRunnerArgsWithReflection() = SuperReflect.on(this).get<RunnerArgs>(RUNNER_FIELD_RUNNER_ARGS)
diff --git a/xrunner-library/src/main/java/com/stepstone/xrunner/internal/OrchestratorListenerWrapper.kt b/xrunner-library/src/main/java/com/stepstone/xrunner/internal/OrchestratorListenerWrapper.kt
@@ -1,20 +1,20 @@
 package com.stepstone.xrunner.internal
 
-import androidx.test.orchestrator.instrumentationlistener.OrchestratedInstrumentationListener
+import androidx.test.internal.events.client.OrchestratedInstrumentationListener
 import org.junit.runner.Description
 import org.junit.runner.Result
 import org.junit.runner.notification.Failure
 import org.junit.runner.notification.RunListener
 
 /**
- * This is a wrapper for the original [OrchestratedInstrumentationListener] set in [android.support.test.runner.AndroidJUnitRunner].
+ * This is a wrapper for the original [OrchestratedInstrumentationListener] set in [androidx.test.runner.AndroidJUnitRunner].
  * It's purpose is to report to Android Test Orchestrator correct XRunner test methods e.g.
  * if [com.stepstone.xrunner.AndroidJUnitXRunner] was originally triggered to run "com.android.foo.FooTest#testFoo_XRUNNER_RUN_1"
  * this class would make sure that [OrchestratedInstrumentationListener] would get a test description with "_XRUNNER_RUN_1" suffix.
  * This is because [com.stepstone.xrunner.AndroidJUnitXRunner] removes this suffix when running the test.
  */
 class OrchestratorListenerWrapper(
-    private val orchestratorListener: OrchestratedInstrumentationListener,
+    private val orchestratorListener: RunListener,
     private val originalTestToRun: String?
 ) : RunListener() {
 
