Engine tests: use compilations to share logic between ktor/default engines

build-logic/src/main/kotlin/Mpp.kt

@@ -138,8 +138,9 @@ fun Project.configureMpp(
 }
 
 /**
- * Current Graph is something like so
+ * Current Graph is something like so:
  *
+ * ```mermaid
  * graph TB
  * commonMain --> concurrentMain
  * commonMain --> linuxMain
@@ -158,21 +159,19 @@ fun Project.configureMpp(
  * appleMain --> tvosX64
  * appleMain --> tvosSimulatorArm64
  *
- *
  * commonTest --> kotlinCodegenTest
  * commonTest --> jvmJavaCodeGen
  * kotlinCodegenTest --> macOsArm64Test
  * kotlinCodegenTest --> jvmTest
  * kotlinCodegenTest --> jsTest
  *
- *
- *
  * classDef kotlinPurple fill:#A97BFF,stroke:#333,stroke-width:2px,color:#333
  * classDef javaOrange fill:#b07289,stroke:#333,stroke-width:2px,color:#333
  * classDef gray fill:#AAA,stroke:#333,stroke-width:2px,color:#333
  * class kotlinCodegenTest gray
  * class jvmJavaCodeGen,macOsArm64Test,jvmTest,jsTest kotlinPurple
  * class commonTest javaOrange
+ * ```
  */
 private fun KotlinMultiplatformExtension.configureSourceSetGraph() {
   val hasAppleTarget = targets.any {
@@ -201,12 +200,12 @@ private fun KotlinMultiplatformExtension.configureSourceSetGraph() {
     }
   }
 
-  val kotlinCodegentTest = sourceSets.create("kotlinCodegenTest")
+  val kotlinCodegenTest = sourceSets.create("kotlinCodegenTest")
 
-  kotlinCodegentTest.dependsOn(sourceSets.getByName("commonTest"))
+  kotlinCodegenTest.dependsOn(sourceSets.getByName("commonTest"))
 
   targets.forEach {
-    sourceSets.findByName("${it.name}Test")?.dependsOn(kotlinCodegentTest)
+    sourceSets.findByName("${it.name}Test")?.dependsOn(kotlinCodegenTest)
   }
 }
 
@@ -218,6 +217,18 @@ private fun KotlinMultiplatformExtension.addTestDependencies() {
   }
 }
 
+/**
+ * Registers a new testRun that substitutes the Kotlin models by the Java models.
+ * Because they have the same JVM API, this is transparent to all tests that are in `kotlinCodegenTest` that work the same for Kotlin
+ * & Java models.
+ *
+ * - For Kotlin models, `kotlinCodegenTest` is directly in the sourceSet graph and generated models are wired to the source set
+ * - For Java models, `kotlinCodegenTest` is not in the sourceSet graph. The generated models are wired to the separate `javaCodegen`
+ * source set. Then the contents of `kotlinCodegenTest/kotlin` is sourced directly
+ *
+ * This breaks IDE support because now `kotlinCodegenTest/kotlin` is used from 2 different places so clicking a model there, it's impossible
+ * to tell which model it is. We could expect/actual all of the model APIs but that'd be a lot of very manual work
+ */
 fun Project.registerJavaCodegenTestTask() {
   val kotlin = kotlinExtension
   check(kotlin is KotlinMultiplatformExtension) {
@@ -250,5 +261,5 @@ fun Project.registerJavaCodegenTestTask() {
     }
   }
 
-  tasks.named("build").dependsOn(task)
+  tasks.named("allTests").dependsOn(task)
 }

tests/engine/build.gradle.kts

@@ -1,3 +1,8 @@
+
+import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTargetWithHostTests
+import org.jetbrains.kotlin.gradle.targets.js.ir.KotlinJsIrTarget
+import org.jetbrains.kotlin.gradle.targets.jvm.KotlinJvmTarget
+
 plugins {
   id("org.jetbrains.kotlin.multiplatform")
   id("apollo.test")
@@ -9,19 +14,65 @@ apolloTest {
 
 kotlin {
   sourceSets {
-    findByName("commonMain")?.apply {
+    getByName("commonMain").apply {
       dependencies {
         implementation(libs.apollo.runtime)
-        implementation(libs.apollo.engine.ktor)
       }
     }
 
-    findByName("commonTest")?.apply {
+    val commonTest = getByName("commonTest").apply {
       dependencies {
         implementation(libs.apollo.mockserver)
         implementation(libs.apollo.testingsupport)
         implementation(libs.turbine)
       }
     }
+
+    val ktorTest = create("ktorTest") {
+      dependsOn(commonTest)
+      dependencies {
+        implementation(libs.apollo.engine.ktor)
+      }
+    }
+    val defaultTest = create("defaultTest") {
+      dependsOn(commonTest)
+    }
+
+    targets.all {
+      val defaultTestCompilation = compilations.findByName("test")
+      if (defaultTestCompilation != null) {
+        defaultTestCompilation.defaultSourceSet.dependsOn(defaultTest)
+
+        when (this ) {
+          is KotlinJvmTarget -> {
+            val ktorTestCompilation = compilations.create("ktorTest").apply {
+              defaultSourceSet.dependsOn(ktorTest)
+            }
+            testRuns.create("ktor") {
+              setExecutionSourceFrom(ktorTestCompilation)
+            }
+          }
+          is KotlinJsIrTarget -> {
+            val ktorTestCompilation = compilations.create("ktorTest").apply {
+              defaultSourceSet.dependsOn(ktorTest)
+            }
+            testRuns.create("ktor") {
+              setExecutionSourceFrom(ktorTestCompilation)
+            }
+          }
+          is KotlinNativeTargetWithHostTests -> {
+            val ktorTestCompilation = compilations.create("ktorTest").apply {
+              defaultSourceSet.dependsOn(ktorTest)
+            }
+            binaries.test("integration") {
+              compilation = ktorTestCompilation
+            }
+            testRuns.create("ktor") {
+              setExecutionSourceFrom(binaries.getTest("integration", DEBUG))
+            }
+          }
+        }
+      }
+    }
   }
 }

tests/engine/src/commonTest/kotlin/GzipTest.kt

@@ -1,8 +1,8 @@
+
 import com.apollographql.apollo3.mockserver.MockResponse
 import com.apollographql.apollo3.mockserver.MockServer
 import com.apollographql.apollo3.network.http.DefaultHttpEngine
 import com.apollographql.apollo3.network.http.HttpEngine
-import com.apollographql.apollo3.network.http.KtorHttpEngine
 import com.apollographql.apollo3.network.http.get
 import com.apollographql.apollo3.testing.internal.runTest
 import okio.Buffer
@@ -51,8 +51,5 @@ class GzipTest {
   }
 
   @Test
-  fun gzipTestDefault() = gzipTest(DefaultHttpEngine())
-
-  @Test
-  fun gzipTestKtor() = gzipTest(KtorHttpEngine())
+  fun gzipTest() = gzipTest(DefaultHttpEngine())
 }

tests/engine/src/commonTest/kotlin/HttpEngineTest.kt

@@ -6,9 +6,7 @@ import com.apollographql.apollo3.exception.ApolloException
 import com.apollographql.apollo3.mockserver.MockResponse
 import com.apollographql.apollo3.mockserver.MockServer
 import com.apollographql.apollo3.mockserver.enqueue
-import com.apollographql.apollo3.network.http.DefaultHttpEngine
 import com.apollographql.apollo3.network.http.HttpEngine
-import com.apollographql.apollo3.network.http.KtorHttpEngine
 import com.apollographql.apollo3.testing.internal.runTest
 import kotlin.test.Test
 import kotlin.test.assertEquals
@@ -37,10 +35,7 @@ class HttpEngineTest {
   }
 
   @Test
-  fun errorWithBodyDefault() = errorWithBody(DefaultHttpEngine())
-
-  @Test
-  fun errorWithBodyKtor() = errorWithBody(KtorHttpEngine())
+  fun errorWithBody() = errorWithBody(httpEngine())
 
   private fun headers(httpEngine: HttpEngine) = runTest(before = { setUp() }, after = { tearDown() }) {
     mockServer.enqueue(
@@ -65,10 +60,7 @@ class HttpEngineTest {
   }
 
   @Test
-  fun headersDefault() = headers(DefaultHttpEngine())
-
-  @Test
-  fun headersKtor() = headers(KtorHttpEngine())
+  fun headers() = headers(httpEngine())
 
   private fun post(httpEngine: HttpEngine) = runTest(before = { setUp() }, after = { tearDown() }) {
     mockServer.enqueue(
@@ -90,10 +82,7 @@ class HttpEngineTest {
   }
 
   @Test
-  fun postDefault() = post(DefaultHttpEngine())
-
-  @Test
-  fun postKtor() = post(KtorHttpEngine())
+  fun post() = post(httpEngine())
 
   private fun connectTimeout(httpEngine: HttpEngine) = runTest(before = { setUp() }, after = { tearDown() }) {
     assertFailsWith<ApolloException> {
@@ -103,11 +92,8 @@ class HttpEngineTest {
   }
 
   @Test
-  fun connectTimeoutDefault() = connectTimeout(DefaultHttpEngine(500))
-
-  @Test
-  fun connectTimeoutKtor() = connectTimeout(KtorHttpEngine(500))
-
+  fun connectTimeout() = connectTimeout(httpEngine(500))
+
   private fun readTimeout(httpEngine: HttpEngine) = runTest(before = { setUp() }, after = { tearDown() }) {
     mockServer.enqueue(
         MockResponse.Builder()
@@ -122,9 +108,5 @@ class HttpEngineTest {
   }
 
   @Test
-  fun readTimeoutDefault() = readTimeout(DefaultHttpEngine(500))
-
-  @Test
-  fun readTimeoutKtor() = readTimeout(KtorHttpEngine(500))
-
+  fun readTimeout() = readTimeout(httpEngine(500))
 }

tests/engine/src/commonTest/kotlin/WebSocketEngineTest.kt

@@ -1,3 +1,4 @@
+
 import app.cash.turbine.test
 import com.apollographql.apollo3.api.http.HttpHeader
 import com.apollographql.apollo3.exception.ApolloException
@@ -7,11 +8,9 @@ import com.apollographql.apollo3.mockserver.WebSocketMockServer
 import com.apollographql.apollo3.mockserver.WebSocketMockServer.WebSocketEvent
 import com.apollographql.apollo3.mpp.Platform
 import com.apollographql.apollo3.mpp.platform
-import com.apollographql.apollo3.network.ws.DefaultWebSocketEngine
-import com.apollographql.apollo3.network.ws.KtorWebSocketEngine
 import com.apollographql.apollo3.network.ws.WebSocketEngine
 import com.apollographql.apollo3.testing.internal.runTest
-import io.ktor.utils.io.core.toByteArray
+import okio.Buffer
 import okio.ByteString.Companion.encodeUtf8
 import kotlin.test.Test
 import kotlin.test.assertEquals
@@ -49,10 +48,7 @@ class WebSocketEngineTest {
   }
 
   @Test
-  fun textFramesDefault() = textFrames(DefaultWebSocketEngine())
-
-  @Test
-  fun textFramesKtor() = textFrames(KtorWebSocketEngine())
+  fun textFrames() = textFrames(webSocketEngine())
 
   private fun binaryFrames(webSocketEngine: WebSocketEngine) = runTest {
     if (platform() == Platform.Js) return@runTest // JS doesn't have a WebSocketMockServer yet
@@ -82,11 +78,10 @@ class WebSocketEngineTest {
     webSocketServer.close()
   }
 
-  @Test
-  fun binaryFramesDefault() = binaryFrames(DefaultWebSocketEngine())
+  private fun String.toByteArray() = Buffer().writeUtf8(this).readByteArray()
 
   @Test
-  fun binaryFramesKtor() = binaryFrames(KtorWebSocketEngine())
+  fun binaryFrames() = binaryFrames(webSocketEngine())
 
   private fun serverCloseNicely(webSocketEngine: WebSocketEngine, checkCodeAndReason: Boolean = true) = runTest {
     if (platform() == Platform.Js) return@runTest // JS doesn't have a WebSocketMockServer yet
@@ -115,14 +110,9 @@ class WebSocketEngineTest {
   }
 
   @Test
-  fun serverCloseNicelyDefault() = serverCloseNicely(DefaultWebSocketEngine())
-
-  @Test
-  fun serverCloseNicelyKtor() = serverCloseNicely(
-      webSocketEngine = KtorWebSocketEngine(),
-
+  fun serverCloseNicely() = serverCloseNicely(webSocketEngine(),
       // On Apple, the close code and reason are not available - https://youtrack.jetbrains.com/issue/KTOR-6198
-      checkCodeAndReason = platform() != Platform.Native
+      checkCodeAndReason = !isKtor || platform() != Platform.Native
   )
 
   private fun serverCloseAbruptly(webSocketEngine: WebSocketEngine) = runTest {
@@ -143,10 +133,7 @@ class WebSocketEngineTest {
   }
 
   @Test
-  fun serverCloseAbruptlyDefault() = serverCloseAbruptly(DefaultWebSocketEngine())
-
-  @Test
-  fun serverCloseAbruptlyKtor() = serverCloseAbruptly(KtorWebSocketEngine())
+  fun serverCloseAbruptly() = serverCloseAbruptly(webSocketEngine())
 
   private fun headers(webSocketEngine: WebSocketEngine) = runTest {
     if (platform() == Platform.Js) return@runTest // JS doesn't have a WebSocketMockServer yet
@@ -170,8 +157,5 @@ class WebSocketEngineTest {
   }
 
   @Test
-  fun headersDefault() = headers(DefaultWebSocketEngine())
-
-  @Test
-  fun headersKtor() = headers(KtorWebSocketEngine())
+  fun headers() = headers(webSocketEngine())
 }

tests/engine/src/commonTest/kotlin/engines.kt

@@ -0,0 +1,6 @@
+import com.apollographql.apollo3.network.http.HttpEngine
+import com.apollographql.apollo3.network.ws.WebSocketEngine
+
+expect fun httpEngine(timeoutMillis: Long = 60_000): HttpEngine
+expect fun webSocketEngine(): WebSocketEngine
+expect val isKtor: Boolean

tests/engine/src/defaultTest/kotlin/engines.default.kt

@@ -0,0 +1,15 @@
+
+import com.apollographql.apollo3.network.http.DefaultHttpEngine
+import com.apollographql.apollo3.network.http.HttpEngine
+import com.apollographql.apollo3.network.ws.DefaultWebSocketEngine
+import com.apollographql.apollo3.network.ws.WebSocketEngine
+
+actual fun httpEngine(timeoutMillis: Long): HttpEngine {
+  return DefaultHttpEngine(timeoutMillis)
+}
+
+actual fun webSocketEngine(): WebSocketEngine {
+  return DefaultWebSocketEngine()
+}
+
+actual val isKtor = false

tests/engine/src/ktorTest/kotlin/engines.ktor.kt

@@ -0,0 +1,14 @@
+import com.apollographql.apollo3.network.http.HttpEngine
+import com.apollographql.apollo3.network.http.KtorHttpEngine
+import com.apollographql.apollo3.network.ws.KtorWebSocketEngine
+import com.apollographql.apollo3.network.ws.WebSocketEngine
+
+actual fun httpEngine(timeoutMillis: Long): HttpEngine {
+  return KtorHttpEngine(timeoutMillis)
+}
+
+actual fun webSocketEngine(): WebSocketEngine {
+  return KtorWebSocketEngine()
+}
+
+actual val isKtor = true