Add support for WASM target

JakeWharton · evant · commit cee95973827d · 2023-08-23T20:06:56.000-07:00
diff --git a/assertk/build.gradle.kts b/assertk/build.gradle.kts
@@ -1,3 +1,7 @@
+import org.jetbrains.kotlin.gradle.plugin.KotlinPlatformType
+import org.jetbrains.kotlin.gradle.plugin.KotlinPlatformType.common
+import org.jetbrains.kotlin.gradle.plugin.KotlinPlatformType.wasm
+
 plugins {
     id("assertk.multiplatform")
     id("assertk.publish")
@@ -25,11 +29,9 @@ kotlin {
             }
             kotlin.srcDir(compileTemplates)
         }
-        commonTest {
+        val commonTest by getting {
             dependencies {
                 implementation(kotlin("test"))
-                implementation(libs.kotlinx.coroutines)
-                implementation(libs.kotlinx.coroutines.test)
             }
             kotlin.srcDir(compileTestTemplates)
         }
@@ -43,5 +45,21 @@ kotlin {
                 implementation(kotlin("reflect"))
             }
         }
+
+        val coroutinesTest by creating {
+            dependsOn(commonTest)
+            dependencies {
+                implementation(libs.kotlinx.coroutines)
+                implementation(libs.kotlinx.coroutines.test)
+            }
+        }
+    }
+
+    targets.configureEach {
+        if (platformType != common && platformType != wasm) {
+            compilations.getByName("test")
+                .defaultSourceSet
+                .dependsOn(sourceSets.getByName("coroutinesTest"))
+        }
     }
-}
+}
diff --git a/assertk/src/commonTest/kotlin/test/assertk/AssertFailureTest.kt b/assertk/src/commonTest/kotlin/test/assertk/AssertFailureTest.kt
@@ -5,7 +5,6 @@ import assertk.assertions.isEqualTo
 import assertk.assertions.isInstanceOf
 import assertk.assertions.message
 import com.willowtreeapps.opentest4k.AssertionFailedError
-import kotlinx.coroutines.test.runTest
 import test.assertk.assertions.valueOrFail
 import kotlin.coroutines.resume
 import kotlin.coroutines.resumeWithException
diff --git a/assertk/src/commonTest/kotlin/test/assertk/AssertLambdaTest.kt b/assertk/src/commonTest/kotlin/test/assertk/AssertLambdaTest.kt
@@ -8,7 +8,6 @@ import assertk.assertions.isSuccess
 import test.assertk.assertions.valueOrFail
 import kotlin.test.Test
 import kotlin.test.assertEquals
-import kotlinx.coroutines.test.runTest
 
 @Suppress("DEPRECATION_ERROR")
 class AssertLambdaTest {
diff --git a/assertk/src/commonTest/kotlin/test/assertk/runTest.kt b/assertk/src/commonTest/kotlin/test/assertk/runTest.kt
@@ -0,0 +1,7 @@
+package test.assertk
+
+/**
+ * A quick shim for common, coroutine-based tests since the coroutines library
+ * does not yet support WASM target.
+ */
+expect fun runTest(block: suspend () -> Unit)
diff --git a/assertk/src/coroutinesTest/kotlin/test/assertk/runTest.kt b/assertk/src/coroutinesTest/kotlin/test/assertk/runTest.kt
@@ -0,0 +1,5 @@
+package test.assertk
+
+actual fun runTest(block: suspend () -> Unit) {
+    kotlinx.coroutines.test.runTest { block() }
+}
diff --git a/assertk/src/wasmMain/kotlin/assertk/PlatformName.kt b/assertk/src/wasmMain/kotlin/assertk/PlatformName.kt
@@ -0,0 +1,3 @@
+package assertk
+
+actual annotation class PlatformName(actual val name: String)
diff --git a/assertk/src/wasmMain/kotlin/assertk/ThreadLocalRef.kt b/assertk/src/wasmMain/kotlin/assertk/ThreadLocalRef.kt
@@ -0,0 +1,26 @@
+package assertk
+
+/*
+ * Copyright (C) 2018 Touchlab, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+actual open class ThreadLocalRef<T> actual constructor(initial: () -> T) {
+    private var localValue: T = initial()
+
+    actual fun get(): T = localValue
+
+    actual fun set(value: T) {
+        localValue = value
+    }
+}
diff --git a/assertk/src/wasmMain/kotlin/assertk/assertions/support/support.kt b/assertk/src/wasmMain/kotlin/assertk/assertions/support/support.kt
@@ -0,0 +1,5 @@
+package assertk.assertions.support
+
+internal actual fun displayPlatformSpecific(value: Any?): String {
+    return value.toString()
+}
diff --git a/assertk/src/wasmMain/kotlin/assertk/failure.kt b/assertk/src/wasmMain/kotlin/assertk/failure.kt
@@ -0,0 +1,13 @@
+@file:Suppress("NOTHING_TO_INLINE")
+
+package assertk
+
+internal actual inline fun failWithNotInStacktrace(error: Throwable): Nothing {
+    throw error
+}
+
+internal actual inline fun Throwable.addSuppressed(error: Throwable) {
+    // ignore
+}
+
+internal actual inline fun Throwable.isOutOfMemory(): Boolean = false
diff --git a/assertk/src/wasmMain/kotlin/assertk/showError.kt b/assertk/src/wasmMain/kotlin/assertk/showError.kt
@@ -0,0 +1,5 @@
+package assertk
+
+import assertk.assertions.support.show
+
+internal actual fun showError(e: Throwable) = show(e)
diff --git a/assertk/src/wasmTest/kotlin/test/assertk/exceptionName.kt b/assertk/src/wasmTest/kotlin/test/assertk/exceptionName.kt
@@ -0,0 +1,5 @@
+package test.assertk
+
+actual val exceptionPackageName: String = ""
+
+actual val opentestPackageName: String = ""
diff --git a/assertk/src/wasmTest/kotlin/test/assertk/runTest.kt b/assertk/src/wasmTest/kotlin/test/assertk/runTest.kt
@@ -0,0 +1,5 @@
+package test.assertk
+
+actual fun runTest(block: suspend () -> Unit) {
+    // Not supported yet! Ignore for now…
+}
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -1,4 +1,6 @@
 import org.jetbrains.dokka.gradle.DokkaMultiModuleTask
+import org.jetbrains.kotlin.gradle.targets.js.nodejs.NodeJsRootExtension
+import org.jetbrains.kotlin.gradle.targets.js.nodejs.NodeJsRootPlugin
 
 plugins {
     id("org.jetbrains.dokka")
@@ -23,4 +25,10 @@ val dokkaHtmlMultiModule by tasks.getting(DokkaMultiModuleTask::class)
 val generateDocs by tasks.creating(Copy::class) {
     from(dokkaHtmlMultiModule.outputDirectory)
     into("docs")
-}
+}
+
+plugins.withType<NodeJsRootPlugin> {
+    extensions.getByType<NodeJsRootExtension>().apply {
+        nodeVersion = "20.0.0"
+    }
+}
diff --git a/buildSrc/src/main/kotlin/assertk.multiplatform.gradle.kts b/buildSrc/src/main/kotlin/assertk.multiplatform.gradle.kts
@@ -48,6 +48,12 @@ kotlin {
             }
         }
     }
+    // TODO Remove conditional once coroutines ships a version with WASM target.
+    if (project.path != ":assertk-coroutines") {
+        wasm {
+            nodejs()
+        }
+    }
 
     for (target in nativeTargets) {
         targets.add(presets.getByName(target).createTarget(target))
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -5,7 +5,7 @@ kotlinx-coroutines = "1.7.0"
 [libraries]
 kotlin-gradle = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin" }
 dokka-gradle = { module = "org.jetbrains.dokka:dokka-gradle-plugin", version = "1.8.10" }
-detekt-gradle = { module = "io.gitlab.arturbosch.detekt:detekt-gradle-plugin", version = "1.19.0" }
+detekt-gradle = { module = "io.gitlab.arturbosch.detekt:detekt-gradle-plugin", version = "1.23.0" }
 kotlinx-coroutines = { 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" }
 opentest4k = { module = "com.willowtreeapps.opentest4k:opentest4k", version = "1.2.4" }

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+package assertk`
	`2`	`+`
	`3`	`+actual annotation class PlatformName(actual val name: String)`