Define callbacks order to include project level (#5069)

Fixes #5062 <!-- If this PR updates documentation, please update all relevant versions of the docs, see: https://github.com/kotest/kotest/tree/master/documentation/versioned_docs The documentation at https://github.com/kotest/kotest/tree/master/documentation/docs is the documentation for the next minor or major version _TO BE RELEASED_ -->

Author: sksamuel

kotest-extensions/kotest-extensions-wiremock/src/jvmTest/kotlin/io/kotest/extensions/wiremock/WiremockListenerPerTestTest.kt

@@ -12,29 +12,28 @@ import io.kotest.engine.test.TestResult
 import io.kotest.matchers.shouldBe
 import java.net.ConnectException
 import java.net.HttpURLConnection
-import java.net.URL
+import java.net.URI
 
 @Suppress("BlockingMethodInNonBlockingContext")
 class WiremockListenerPerTestTest : FunSpec({
  val wireMockServer = WireMockServer(9000)
 
- extension(WireMockListener.perTest(wireMockServer))
  extension(object : TestListener {
  override suspend fun afterTest(testCase: TestCase, result: TestResult) {
  shouldThrow<ConnectException> {
- val connection = URL("http://localhost:9000/test").openConnection() as HttpURLConnection
+ val connection = URI.create("http://localhost:9000/test").toURL().openConnection() as HttpURLConnection
  connection.responseCode
  }
  }
  })
-
+ extension(WireMockListener.perTest(wireMockServer))
 
  test("should have started wiremock server") {
  wireMockServer.stubFor(
  get(urlEqualTo("/test"))
  .willReturn(ok())
  )
- val connection = URL("http://localhost:9000/test").openConnection() as HttpURLConnection
+ val connection = URI.create("http://localhost:9000/test").toURL().openConnection() as HttpURLConnection
  connection.responseCode shouldBe 200
  }
 
@@ -43,7 +42,7 @@ class WiremockListenerPerTestTest : FunSpec({
  get(urlEqualTo("/second-test"))
  .willReturn(ok())
  )
- val connection = URL("http://localhost:9000/second-test").openConnection() as HttpURLConnection
+ val connection = URI.create("http://localhost:9000/second-test").toURL().openConnection() as HttpURLConnection
  connection.responseCode shouldBe 200
  }
 })

kotest-framework/kotest-framework-engine/api/kotest-framework-engine.api

@@ -1625,8 +1625,6 @@ public abstract class io/kotest/core/spec/Extendable {
 public final fun extensions ()Ljava/util/List;
 public final fun extensions (Ljava/util/List;)V
 public final fun extensions ([Lio/kotest/core/extensions/Extension;)V
-public final fun prependExtension (Lio/kotest/core/extensions/Extension;)V
-public final fun prependExtensions (Ljava/util/List;)V
 }
 
 public final class io/kotest/core/spec/InvalidDslException : java/lang/Exception {
@@ -3245,7 +3243,6 @@ public final class io/kotest/engine/config/TestConfigResolver {
 public final fun coroutineDebugProbes (Lio/kotest/core/test/TestCase;)Z
 public final fun coroutineTestScope (Lio/kotest/core/test/TestCase;)Z
 public final fun enabled (Lio/kotest/core/test/TestCase;)Lkotlin/jvm/functions/Function1;
-public final fun extensions (Lio/kotest/core/test/TestCase;)Ljava/util/List;
 public final fun failfast (Lio/kotest/core/test/TestCase;)Z
 public final fun invocationTimeout-5sfh64U (Lio/kotest/core/test/TestCase;)J
 public final fun invocations (Lio/kotest/core/test/TestCase;)I

kotest-framework/kotest-framework-engine/src/commonMain/kotlin/io/kotest/core/TestConfiguration.kt

@@ -145,7 +145,7 @@ abstract class TestConfiguration : Extendable() {
  * top level callbacks.
  */
  fun afterContainer(f: AfterContainer) {
- prependExtension(object : AfterContainerListener {
+ extension(object : AfterContainerListener {
  override suspend fun afterContainer(testCase: TestCase, result: TestResult) {
  f(Tuple2(testCase, result))
  }
@@ -176,7 +176,7 @@ abstract class TestConfiguration : Extendable() {
  * top level callbacks.
  */
  fun afterEach(f: AfterEach) {
- prependExtension(object : AfterEachListener {
+ extension(object : AfterEachListener {
  override suspend fun afterEach(testCase: TestCase, result: TestResult) {
  f(Tuple2(testCase, result))
  }
@@ -237,7 +237,7 @@ abstract class TestConfiguration : Extendable() {
  * top level callbacks.
  */
  fun afterAny(f: AfterAny) {
- prependExtension(object : AfterTestListener {
+ extension(object : AfterTestListener {
  override suspend fun afterAny(testCase: TestCase, result: TestResult) {
  f(Tuple2(testCase, result))
  }

kotest-framework/kotest-framework-engine/src/commonMain/kotlin/io/kotest/core/spec/Extendable.kt

@@ -38,20 +38,4 @@ abstract class Extendable {
  require(extensions.isNotEmpty()) { "Cannot register empty list of extensions" }
  extensions(extensions.toList())
  }
-
- /**
- * Register [Extension]s to be invoked before all other extensions that have
- * been directly registered on this class.
- */
- fun prependExtensions(extensions: List<Extension>) {
- _extensions = extensions + _extensions
- }
-
- /**
- * Registers an [Extension] to be invoked before all other extensions that have
- * been directly registered on this class.
- */
- fun prependExtension(extension: Extension) {
- prependExtensions(listOf(extension))
- }
 }

kotest-framework/kotest-framework-engine/src/commonMain/kotlin/io/kotest/core/spec/Spec.kt

@@ -340,7 +340,7 @@ abstract class Spec : TestConfiguration() {
  * top level callbacks.
  */
  final override fun afterTest(f: AfterTest) {
- prependExtension(object : AfterTestListener {
+ extension(object : AfterTestListener {
  override suspend fun afterTest(testCase: TestCase, result: TestResult) {
  if (testCase.spec::class == this@Spec::class)
  f(Tuple2(testCase, result))

kotest-framework/kotest-framework-engine/src/commonMain/kotlin/io/kotest/core/spec/style/scopes/ContainerScope.kt

@@ -22,11 +22,11 @@ import io.kotest.core.spec.InvalidDslException
 import io.kotest.core.spec.KotestTestScope
 import io.kotest.core.test.NestedTest
 import io.kotest.core.test.TestCase
-import io.kotest.engine.test.TestResult
 import io.kotest.core.test.TestScope
 import io.kotest.core.test.TestType
 import io.kotest.core.test.config.TestConfig
 import io.kotest.engine.config.projectConfigResolver
+import io.kotest.engine.test.TestResult
 import kotlin.coroutines.CoroutineContext
 
 private val outOfOrderCallbacksException =
@@ -80,10 +80,6 @@ interface ContainerScope : TestScope {
  registerTest(name = name, disabled = disabled, config = config, type = TestType.Test, test = test)
  }
 
- private fun prependExtension(extension: Extension) {
- testCase.spec.prependExtensions(listOf(extension))
- }
-
  private fun appendExtension(extension: Extension) {
  testCase.spec.extension(extension)
  }
@@ -113,7 +109,7 @@ interface ContainerScope : TestScope {
  fun afterScope(f: suspend (TestCase) -> Unit) {
  val thisTestCase = this.testCase
  if (hasChildren()) throw outOfOrderCallbacksException
- prependExtension(object : TestListener {
+ appendExtension(object : TestListener {
  override suspend fun afterContainer(testCase: TestCase, result: TestResult) {
  if (thisTestCase.descriptor == testCase.descriptor) {
  f(testCase)
@@ -145,7 +141,7 @@ interface ContainerScope : TestScope {
  fun afterAny(f: AfterAny) {
  if (hasChildren() && !projectConfigResolver.allowOutOfOrderCallbacks()) throw outOfOrderCallbacksException
  val thisTestCase = this.testCase
- prependExtension(object : AfterTestListener {
+ appendExtension(object : AfterTestListener {
  override suspend fun afterAny(testCase: TestCase, result: TestResult) {
  if (thisTestCase.descriptor.isAncestorOf(testCase.descriptor)) f(Tuple2(testCase, result))
  }
@@ -183,7 +179,7 @@ interface ContainerScope : TestScope {
  fun afterContainer(f: AfterContainer) {
  if (hasChildren() && !projectConfigResolver.allowOutOfOrderCallbacks()) throw outOfOrderCallbacksException
  val thisTestCase = this.testCase
- prependExtension(object : AfterContainerListener {
+ appendExtension(object : AfterContainerListener {
  override suspend fun afterContainer(testCase: TestCase, result: TestResult) {
  if (thisTestCase.descriptor.isAncestorOf(testCase.descriptor)) {
  f(Tuple2(testCase, result))
@@ -221,7 +217,7 @@ interface ContainerScope : TestScope {
  fun afterEach(f: AfterEach) {
  if (hasChildren() && !projectConfigResolver.allowOutOfOrderCallbacks()) throw outOfOrderCallbacksException
  val thisTestCase = this.testCase
- prependExtension(object : TestListener {
+ appendExtension(object : TestListener {
  override suspend fun afterEach(testCase: TestCase, result: TestResult) {
  if (thisTestCase.descriptor.isAncestorOf(testCase.descriptor)) {
  f(Tuple2(testCase, result))

kotest-framework/kotest-framework-engine/src/commonMain/kotlin/io/kotest/engine/config/TestConfigResolver.kt

@@ -172,13 +172,13 @@ class TestConfigResolver(
  val projectEnabledOrReasonIf = projectConfig?.enabledOrReasonIf
  return { testCase ->
  when {
- disabledByTestConfig == true -> this@TestConfigResolver.disabledByTestConfig
- testEnabledIf != null -> if (testEnabledIf(testCase)) Enabled.Companion.enabled else disabledByEnabledIf
+ disabledByTestConfig -> this@TestConfigResolver.disabledByTestConfig
+ testEnabledIf != null -> if (testEnabledIf(testCase)) Enabled.enabled else disabledByEnabledIf
  testEnabledOrReasonIf != null -> testEnabledOrReasonIf.invoke(testCase)
- specEnabledIf != null -> if (specEnabledIf(testCase)) Enabled.Companion.enabled else disabledByEnabledIf
+ specEnabledIf != null -> if (specEnabledIf(testCase)) Enabled.enabled else disabledByEnabledIf
  specEnabledOrReasonIf != null -> specEnabledOrReasonIf.invoke(testCase)
  projectEnabledOrReasonIf != null -> projectEnabledOrReasonIf.invoke(testCase)
- else -> Enabled.Companion.enabled
+ else -> Enabled.enabled
  }
  }
  }
@@ -187,15 +187,21 @@ class TestConfigResolver(
  * Returns all [Extension]s applicable to the given [TestCase]. This includes extensions
  * included in test case config, those at the spec level, those from project config, and
  * globally registered extensions in the [ExtensionRegistry].
+ *
+ * @param order - controls the order of extensions returned
  */
- fun extensions(testCase: TestCase): List<Extension> {
- return testConfigs(testCase).flatMap { it.extensions ?: emptyList() } +
+ internal fun extensions(testCase: TestCase, order: ExtensionsOrder): List<Extension> {
+ val ext = registry.all() +
+ (projectConfig?.extensions ?: emptyList()) + // extensions defined at the project level
+ loadPackageConfigs(testCase.spec).flatMap { it.extensions } + // package level extensions
  testCase.spec.extensions + // overriding the extensions val in the spec
  testCase.spec.functionOverrideCallbacks() + // spec level dsl eg override fun beforeTest(tc...) {}
  testCase.spec.extensions() + // added to the spec via dsl eg beforeTest { tc -> }
- loadPackageConfigs(testCase.spec).flatMap { it.extensions } + // package level extensions
- (projectConfig?.extensions ?: emptyList()) + // extensions defined at the project level
- registry.all()
+ testConfigs(testCase).flatMap { it.extensions ?: emptyList() }
+ return when (order) {
+ ExtensionsOrder.GLOBAL_FIRST -> ext
+ ExtensionsOrder.LOCAL_FIRST -> ext.reversed()
+ }
  }
 
  /**
@@ -208,3 +214,28 @@ class TestConfigResolver(
  return if (parent == null) config else config + testConfigs(parent)
  }
 }
+
+/**
+ * Controls the order of extensions loaded from a [TestConfigResolver].
+ */
+internal enum class ExtensionsOrder {
+
+ /**
+ * Extensions are loaded with global first - eg those registered globally in the [ExtensionRegistry],
+ * those from project config, those at the spec level, and finally those at test level.
+ *
+ * At each level extensions are returned in definition order. That is, if two extensions are defined
+ * at the same level, the first one registered will be the first extension invoked.
+ */
+ GLOBAL_FIRST,
+
+ /**
+ * Extensions are loaded with most specific first - eg those defined in a test, those at the spec level,
+ * those from project config, and globally registered extensions in the [ExtensionRegistry].
+ *
+ * At each level extensions are returned in reversed definition order. That is, if two extensions are defined
+ * at the same level, the last one registered will be the first extension invoked.
+ */
+ LOCAL_FIRST,
+
+}