Remove robolectric deprecated override (#18)

LeoColman · Jun 8, 2024 · 0fbb721 · 0fbb721
1 parent b73ec0f
commit 0fbb721
Show file tree

Hide file tree

Showing 4 changed files with 50 additions and 22 deletions.
diff --git a/kotest-extensions-android/build.gradle.kts b/kotest-extensions-android/build.gradle.kts
@@ -44,7 +44,7 @@ configurations {
 dependencies {
   implementation(kotlin("reflect"))
   implementation("io.kotest:kotest-framework-api:5.9.0")
-  implementation("org.robolectric:robolectric:4.11.1")
+  implementation("org.robolectric:robolectric:4.12.2")
   implementation("junit:junit:4.13.2")
   implementation("androidx.appcompat:appcompat:1.7.0")
 

diff --git a/.../kotlin/br/com/colman/kotest/android/extensions/robolectric/ContainedRobolectricRunner.kt b/.../kotlin/br/com/colman/kotest/android/extensions/robolectric/ContainedRobolectricRunner.kt
@@ -1,16 +1,24 @@
 package br.com.colman.kotest.android.extensions.robolectric
 
+import org.junit.experimental.runners.Enclosed
+import org.junit.runner.RunWith
 import org.junit.runners.model.FrameworkMethod
 import org.robolectric.RobolectricTestRunner
 import org.robolectric.annotation.Config
 import org.robolectric.internal.bytecode.InstrumentationConfiguration
 import org.robolectric.pluginapi.config.ConfigurationStrategy
-import org.robolectric.plugins.ConfigConfigurer
+import org.robolectric.pluginapi.config.Configurer
+import org.robolectric.plugins.HierarchicalConfigurationStrategy
 import java.lang.reflect.Method
 
+@RunWith(Enclosed::class)
 internal class ContainedRobolectricRunner(
-  private val config: Config?
+  private val config: Config
 ) : RobolectricTestRunner(PlaceholderTest::class.java, injector) {
+  init {
+    injectKotestConfig()
+  }
+
   private val placeHolderMethod: FrameworkMethod = children[0]
   val sdkEnvironment = getSandbox(placeHolderMethod).also {
     configureSandbox(it, placeHolderMethod)
@@ -35,16 +43,14 @@ internal class ContainedRobolectricRunner(
       .build()
   }
 
-  override fun getConfig(method: Method?): Config {
-    val defaultConfiguration = injector.getInstance(ConfigurationStrategy::class.java)
-      .getConfig(testClass.javaClass, method)
-
-    if (config != null) {
-      val configConfigurer = injector.getInstance(ConfigConfigurer::class.java)
-      return configConfigurer.merge(defaultConfiguration[Config::class.java], config)
-    }
-
-    return super.getConfig(method)
+  private fun injectKotestConfig() {
+    val configurationStrategyField =
+      RobolectricTestRunner::class.java
+        .getField(ConfigurationStrategy::class.java)
+        .apply { isAccessible = true }
+    val configurers = injector.getInstance(arrayOf<Configurer<*>>()::class.java)
+    val newConfigurationStrategy = KotestHierarchicalConfigurationStrategy(config, configurers)
+    configurationStrategyField.set(this, newConfigurationStrategy)
   }
 
   class PlaceholderTest {
@@ -56,6 +62,19 @@ internal class ContainedRobolectricRunner(
     }
   }
 
+  class KotestHierarchicalConfigurationStrategy(
+    private val config: Config,
+    configurers: Array<Configurer<*>>
+  ) : HierarchicalConfigurationStrategy(*configurers) {
+    override fun getConfig(testClass: Class<*>?, method: Method?): ConfigurationImpl {
+      val configurationImpl = super.getConfig(testClass, method)
+      val config = (configurationImpl.get(Config::class.java) as Config)
+      val newConfig = Config.Builder(config).overlay(this.config).build()
+      configurationImpl.map()[Config::class.java] = newConfig
+      return configurationImpl
+    }
+  }
+
   companion object {
     private val injector = defaultInjector().build()
   }

diff --git a/...android/src/main/kotlin/br/com/colman/kotest/android/extensions/robolectric/Extensions.kt b/...android/src/main/kotlin/br/com/colman/kotest/android/extensions/robolectric/Extensions.kt
@@ -0,0 +1,15 @@
+package br.com.colman.kotest.android.extensions.robolectric
+
+import java.lang.reflect.Field
+import java.lang.reflect.Type
+
+internal fun Class<*>.getField(fieldClass: Type): Field {
+  return declaredFields.firstOrNull { it.type == fieldClass }
+    ?: throw IllegalStateException("Not found $fieldClass field.")
+}
+
+internal inline fun <reified T> Class<*>.getValue(obj: Any): T {
+  val field = getField(T::class.java)
+  field.isAccessible = true
+  return field.get(obj) as T
+}
diff --git a/...c/main/kotlin/br/com/colman/kotest/android/extensions/robolectric/RobolectricExtension.kt b/...c/main/kotlin/br/com/colman/kotest/android/extensions/robolectric/RobolectricExtension.kt
@@ -115,7 +115,9 @@ class RobolectricExtension : ConstructorExtension, TestCaseExtension {
     val containedRobolectricRunner = runnerMap[testCase.spec]!!
     // Using sdkEnvironment.executorService to ensure Robolectric's
     // looper state doesn't carry over to the next test class.
-    val executorService = containedRobolectricRunner.sdkEnvironment.getExecutorService()
+    val executorService =
+      Sandbox::class.java
+        .getValue<ExecutorService>(containedRobolectricRunner.sdkEnvironment)
     return withContext(executorService.asCoroutineDispatcher()) {
       if (testCase.isRootTest()) {
         containedRobolectricRunner.containedBefore()
@@ -129,14 +131,6 @@ class RobolectricExtension : ConstructorExtension, TestCaseExtension {
   }
 }
 
-private fun Sandbox.getExecutorService(): ExecutorService {
-  val field = Sandbox::class.java.declaredFields
-    .firstOrNull { it.type == ExecutorService::class.java }
-  checkNotNull(field) { "Not found ExecutorService field." }
-  field.isAccessible = true
-  return field.get(this) as ExecutorService
-}
-
 internal class KotestDefaultApplication : Application()
 
 annotation class RobolectricTest(