Fix usage of TestPlan API in instrumentation tests to match binary-incompatible change in 5.12

Author: mannodermaus

instrumentation/CHANGELOG.md

@@ -3,6 +3,9 @@ Change Log
 
 ## Unreleased
 
+- **This version requires (at least) android-junit5 1.12.0.0 and JUnit 5.12.0.**
+- Migrate to new TestPlan API in JUnit 5.12, which changed in a binary-incompatible fashion
+
 ## 1.6.0 (2024-10-05)
 
 - Use square brackets for parameterized tests to ensure that their logs show correctly in the IDE (#350)

instrumentation/runner/src/main/kotlin/de/mannodermaus/junit5/internal/discovery/EmptyTestPlan.kt

@@ -0,0 +1,38 @@
+package de.mannodermaus.junit5.internal.discovery
+
+import androidx.annotation.RequiresApi
+import org.junit.platform.engine.ConfigurationParameters
+import org.junit.platform.engine.TestDescriptor
+import org.junit.platform.engine.reporting.OutputDirectoryProvider
+import org.junit.platform.launcher.TestPlan
+import java.io.File
+import java.util.Optional
+
+/**
+ * A JUnit TestPlan that does absolutely nothing.
+ * Used by [de.mannodermaus.junit5.internal.runners.AndroidJUnit5] whenever a class
+ * is not loadable through the JUnit Platform and should be discarded.
+ */
+@RequiresApi(26)
+internal object EmptyTestPlan : TestPlan(
+    false,
+    emptyConfigurationParameters,
+    emptyOutputDirectoryProvider
+)
+
+@RequiresApi(26)
+private val emptyConfigurationParameters = object : ConfigurationParameters {
+    override fun get(key: String?) = Optional.empty<String>()
+    override fun getBoolean(key: String?) = Optional.empty<Boolean>()
+    override fun keySet() = emptySet<String>()
+
+    @Deprecated("Deprecated in Java", ReplaceWith("keySet().size"))
+    override fun size() = 0
+}
+
+@RequiresApi(26)
+private val emptyOutputDirectoryProvider = object : OutputDirectoryProvider {
+    private val path = File.createTempFile("empty-output", ".nop").toPath()
+    override fun getRootDirectory() = path
+    override fun createOutputDirectory(testDescriptor: TestDescriptor?) = path
+}

instrumentation/runner/src/main/kotlin/de/mannodermaus/junit5/internal/runners/AndroidJUnit5.kt

@@ -2,6 +2,7 @@ package de.mannodermaus.junit5.internal.runners
 
 import androidx.annotation.RequiresApi
 import androidx.annotation.VisibleForTesting
+import de.mannodermaus.junit5.internal.discovery.EmptyTestPlan
 import de.mannodermaus.junit5.internal.runners.notification.ParallelRunNotifier
 import org.junit.platform.commons.JUnitException
 import org.junit.platform.engine.ConfigurationParameters
@@ -25,19 +26,6 @@ internal class AndroidJUnit5(
     private val testClass: Class<*>,
     paramsSupplier: () -> AndroidJUnit5RunnerParams = AndroidJUnit5RunnerParams.Companion::create,
 ) : Runner() {
-    private companion object {
-        private val emptyConfigurationParameters = object : ConfigurationParameters {
-            override fun get(key: String?) = Optional.empty<String>()
-            override fun getBoolean(key: String?) = Optional.empty<Boolean>()
-            override fun keySet() = emptySet<String>()
-
-            @Deprecated("Deprecated in Java", ReplaceWith("keySet().size"))
-            override fun size() = 0
-        }
-
-        private val emptyTestPlan = TestPlan.from(emptyList(), emptyConfigurationParameters)
-    }
-
     private val launcher = LauncherFactory.create()
     private val testTree by lazy { generateTestTree(paramsSupplier()) }
 
@@ -80,7 +68,7 @@ internal class AndroidJUnit5(
             // or anything else not present in the Android runtime).
             // Log those to console, but discard them from being considered at all
             e.printStackTrace()
-            emptyTestPlan
+            EmptyTestPlan
         }
 
         return AndroidJUnitPlatformTestTree(

instrumentation/runner/src/main/kotlin/de/mannodermaus/junit5/internal/runners/AndroidJUnitPlatformTestTree.kt

@@ -137,7 +137,8 @@ internal class AndroidJUnitPlatformTestTree(
 
         return if (identifier.isTest || identifier.isDynamicTest) {
             Description.createTestDescription(
-                /* className = */ testPlan.getParent(identifier)
+                /* className = */
+                testPlan.getParent(identifier)
                     .map(nameExtractor)
                     .orElse("<unrooted>"),
                 /* name = */ name,
@@ -180,7 +181,11 @@ internal class AndroidJUnitPlatformTestTree(
      * Custom drop-in TestPlan for Android purposes.
      */
     private class ModifiedTestPlan(val delegate: TestPlan) :
-        TestPlan(delegate.containsTests(), delegate.configurationParameters) {
+        TestPlan(
+            /* containsTests = */ delegate.containsTests(),
+            /* configurationParameters = */ delegate.configurationParameters,
+            /* outputDirectoryProvider = */ delegate.outputDirectoryProvider
+        ) {
 
         fun getRealParent(child: TestIdentifier?): Optional<TestIdentifier> {
             // Because the overridden "getParent()" from the superclass is modified,