merge: Kotest runner fixes

maximegirardet · maximegirardet · commit 1dca9cd40852 · 2024-07-28T06:56:30.000Z
Various fixes and workarounds for the stability of the Kotest runner.

See merge request opensavvy/groundwork/prepared!89
diff --git a/compat/compat-arrow/build.gradle.kts b/compat/compat-arrow/build.gradle.kts
@@ -1,6 +1,7 @@
 plugins {
 	alias(opensavvyConventions.plugins.base)
 	alias(opensavvyConventions.plugins.kotlin.library)
+	alias(opensavvyConventions.plugins.aligned.kotest)
 }
 
 kotlin {
diff --git a/compat/compat-kotlinx-datetime/build.gradle.kts b/compat/compat-kotlinx-datetime/build.gradle.kts
@@ -3,6 +3,7 @@ import org.jetbrains.kotlin.gradle.targets.js.dsl.ExperimentalWasmDsl
 plugins {
 	alias(opensavvyConventions.plugins.base)
 	alias(opensavvyConventions.plugins.kotlin.library)
+	alias(opensavvyConventions.plugins.aligned.kotest)
 }
 
 @OptIn(ExperimentalWasmDsl::class)
diff --git a/compat/compat-parameterize/build.gradle.kts b/compat/compat-parameterize/build.gradle.kts
@@ -1,6 +1,7 @@
 plugins {
 	alias(opensavvyConventions.plugins.base)
 	alias(opensavvyConventions.plugins.kotlin.library)
+	alias(opensavvyConventions.plugins.aligned.kotest)
 }
 
 kotlin {
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -1,7 +1,6 @@
 # List of dependencies of the project
 
 [versions]
-kotest = "5.9.0"              # https://github.com/kotest/kotest/releases
 arrow = "1.2.4"               # https://github.com/arrow-kt/arrow/releases
 kotlinx-coroutines = "1.8.1"  # https://github.com/Kotlin/kotlinx.coroutines/releases
 kotlinx-datetime = "0.5.0"    # https://github.com/Kotlin/kotlinx-datetime/releases
@@ -15,9 +14,6 @@ ktor = "2.3.11"               # https://ktor.io/docs/releases.html#release-detai
 kotlinx-coroutines-core = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "kotlinx-coroutines" }
 kotlinx-coroutines-test = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-test", version.ref = "kotlinx-coroutines" }
 kotlinx-datetime = { module = "org.jetbrains.kotlinx:kotlinx-datetime", version.ref = "kotlinx-datetime" }
-kotest-engine = { module = "io.kotest:kotest-framework-engine", version.ref = "kotest" }
-kotest-runner-junit5 = { module = "io.kotest:kotest-runner-junit5", version.ref = "kotest" }
-kotest-assertions = { module = "io.kotest:kotest-assertions-core", version.ref = "kotest" }
 gradle-testkit = { module = "dev.gradleplugins:gradle-test-kit", version.ref = "gradle-testkit" }
 arrow-core = { module = "io.arrow-kt:arrow-core", version.ref = "arrow" }
 parameterize = { module = "com.benwoodworth.parameterize:parameterize", version.ref = "parameterize" }
diff --git a/runners/runner-kotest/build.gradle.kts b/runners/runner-kotest/build.gradle.kts
@@ -36,14 +36,13 @@ kotlin {
 		dependencies {
 			api(projects.suite)
 
-			api(libs.kotest.engine)
-			api(libs.kotest.assertions)
+			api("io.kotest:kotest-framework-engine:${opensavvyConventions.versions.kotest.get()}")
 		}
 	}
 
 	val jvmMain by sourceSets.getting {
 		dependencies {
-			api(libs.kotest.runner.junit5)
+			api("io.kotest:kotest-runner-junit5:${opensavvyConventions.versions.kotest.get()}")
 		}
 	}
 }
diff --git a/runners/runner-kotest/src/commonMain/kotlin/PreparedSuite.kt b/runners/runner-kotest/src/commonMain/kotlin/PreparedSuite.kt
@@ -1,16 +1,15 @@
 package opensavvy.prepared.runner.kotest
 
-import io.kotest.core.coroutines.coroutineTestScope
 import io.kotest.core.names.TestName
 import io.kotest.core.spec.KotestTestScope
 import io.kotest.core.spec.style.StringSpec
+import io.kotest.core.spec.style.scopes.ContainerScope
 import io.kotest.core.spec.style.scopes.RootScope
 import io.kotest.core.spec.style.scopes.addTest
 import io.kotest.core.test.TestType
 import opensavvy.prepared.suite.SuiteDsl
 import opensavvy.prepared.suite.TestDsl
 import opensavvy.prepared.suite.config.*
-import opensavvy.prepared.suite.runTestDslSuspend
 import kotlin.coroutines.CoroutineContext
 
 /**
@@ -67,11 +66,15 @@ private class NonNestedSuite(private val root: RootScope, private val parentConf
 		)
 
 		root.addTest(testName = TestName(name = prefix child name), disabled = false, type = TestType.Test, config = kotestConfig) {
-			coroutineTestScope.runTestDslSuspend(name, context, config, block)
+			executeTest(name, context, config, block)
 		}
 	}
 }
 
+// Workaround to avoid using the coroutine dispatcher on KJS.
+// See https://gitlab.com/opensavvy/groundwork/prepared/-/issues/59
+internal expect suspend fun ContainerScope.executeTest(name: String, context: CoroutineContext, config: TestConfig, block: suspend TestDsl.() -> Unit)
+
 /**
  * Appends [name] at the end of `this`, handling the case where `this` is `null`.
  */
diff --git a/runners/runner-kotest/src/jsMain/kotlin/PreparedSuite.js.kt b/runners/runner-kotest/src/jsMain/kotlin/PreparedSuite.js.kt
@@ -0,0 +1,19 @@
+package opensavvy.prepared.runner.kotest
+
+import io.kotest.core.spec.style.scopes.ContainerScope
+import kotlinx.coroutines.await
+import opensavvy.prepared.suite.TestDsl
+import opensavvy.prepared.suite.config.TestConfig
+import opensavvy.prepared.suite.runTestDsl
+import kotlin.coroutines.CoroutineContext
+import kotlin.js.Promise
+
+internal actual suspend fun ContainerScope.executeTest(name: String, context: CoroutineContext, config: TestConfig, block: suspend TestDsl.() -> Unit) {
+	// Currently, Kotest is not able to give us access to the Kotlin.Coroutines.Test dispatcher.
+	// Instead, we create a new coroutine environment and awaits it.
+	// See https://gitlab.com/opensavvy/groundwork/prepared/-/issues/59
+	// See https://github.com/kotest/kotest/issues/4077
+
+	val promise = runTestDsl(name, context, config, block) as Promise<*>
+	promise.await()
+}
diff --git a/runners/runner-kotest/src/jvmMain/kotlin/PreparedSuite.jvm.kt b/runners/runner-kotest/src/jvmMain/kotlin/PreparedSuite.jvm.kt
@@ -0,0 +1,12 @@
+package opensavvy.prepared.runner.kotest
+
+import io.kotest.core.coroutines.coroutineTestScope
+import io.kotest.core.spec.style.scopes.ContainerScope
+import opensavvy.prepared.suite.TestDsl
+import opensavvy.prepared.suite.config.TestConfig
+import opensavvy.prepared.suite.runTestDslSuspend
+import kotlin.coroutines.CoroutineContext
+
+internal actual suspend fun ContainerScope.executeTest(name: String, context: CoroutineContext, config: TestConfig, block: suspend TestDsl.() -> Unit) {
+	coroutineTestScope.runTestDslSuspend(name, context, config, block)
+}
diff --git a/runners/runner-kotest/src/nativeMain/kotlin/PreparedSuite.native.kt b/runners/runner-kotest/src/nativeMain/kotlin/PreparedSuite.native.kt
@@ -0,0 +1,12 @@
+package opensavvy.prepared.runner.kotest
+
+import io.kotest.core.coroutines.coroutineTestScope
+import io.kotest.core.spec.style.scopes.ContainerScope
+import opensavvy.prepared.suite.TestDsl
+import opensavvy.prepared.suite.config.TestConfig
+import opensavvy.prepared.suite.runTestDslSuspend
+import kotlin.coroutines.CoroutineContext
+
+internal actual suspend fun ContainerScope.executeTest(name: String, context: CoroutineContext, config: TestConfig, block: suspend TestDsl.() -> Unit) {
+	coroutineTestScope.runTestDslSuspend(name, context, config, block)
+}
diff --git a/runners/runner-kotest/src/wasmJsMain/kotlin/PreparedSuite.wasmJs.kt b/runners/runner-kotest/src/wasmJsMain/kotlin/PreparedSuite.wasmJs.kt
@@ -0,0 +1,12 @@
+package opensavvy.prepared.runner.kotest
+
+import io.kotest.core.coroutines.coroutineTestScope
+import io.kotest.core.spec.style.scopes.ContainerScope
+import opensavvy.prepared.suite.TestDsl
+import opensavvy.prepared.suite.config.TestConfig
+import opensavvy.prepared.suite.runTestDslSuspend
+import kotlin.coroutines.CoroutineContext
+
+internal actual suspend fun ContainerScope.executeTest(name: String, context: CoroutineContext, config: TestConfig, block: suspend TestDsl.() -> Unit) {
+	coroutineTestScope.runTestDslSuspend(name, context, config, block)
+}
diff --git a/suite/build.gradle.kts b/suite/build.gradle.kts
@@ -3,6 +3,7 @@ import org.jetbrains.kotlin.gradle.targets.js.dsl.ExperimentalWasmDsl
 plugins {
 	alias(opensavvyConventions.plugins.base)
 	alias(opensavvyConventions.plugins.kotlin.library)
+	alias(opensavvyConventions.plugins.aligned.kotest)
 }
 
 @OptIn(ExperimentalWasmDsl::class)

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`plugins {`
`2`	`2`	`alias(opensavvyConventions.plugins.base)`
`3`	`3`	`alias(opensavvyConventions.plugins.kotlin.library)`
	`4`	`+ alias(opensavvyConventions.plugins.aligned.kotest)`
`4`	`5`	`}`
`5`	`6`
`6`	`7`	`kotlin {`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@ import org.jetbrains.kotlin.gradle.targets.js.dsl.ExperimentalWasmDsl`
`3`	`3`	`plugins {`
`4`	`4`	`alias(opensavvyConventions.plugins.base)`
`5`	`5`	`alias(opensavvyConventions.plugins.kotlin.library)`
	`6`	`+ alias(opensavvyConventions.plugins.aligned.kotest)`
`6`	`7`	`}`
`7`	`8`
`8`	`9`	`@OptIn(ExperimentalWasmDsl::class)`
Original file line number	Diff line number	Diff line change
`@@ -36,14 +36,13 @@ kotlin {`
`36`	`36`	`dependencies {`
`37`	`37`	`api(projects.suite)`
`38`	`38`
`39`		`- api(libs.kotest.engine)`
`40`		`- api(libs.kotest.assertions)`
	`39`	`+ api("io.kotest:kotest-framework-engine:${opensavvyConventions.versions.kotest.get()}")`
`41`	`40`	`}`
`42`	`41`	`}`
`43`	`42`
`44`	`43`	`val jvmMain by sourceSets.getting {`
`45`	`44`	`dependencies {`
`46`		`- api(libs.kotest.runner.junit5)`
	`45`	`+ api("io.kotest:kotest-runner-junit5:${opensavvyConventions.versions.kotest.get()}")`
`47`	`46`	`}`
`48`	`47`	`}`
`49`	`48`	`}`