Move common test dispatcher to top-level

ktorio · Nov 19, 2019 · 3ce3906 · 3ce3906
1 parent 951f1e3
commit 3ce3906
Show file tree

Hide file tree

Showing 21 changed files with 64 additions and 20 deletions.
diff --git a/ktor-client/ktor-client-tests/build.gradle.kts b/ktor-client/ktor-client-tests/build.gradle.kts
@@ -41,7 +41,7 @@ kotlin.sourceSets {
         dependencies {
             api(project(":ktor-client:ktor-client-core"))
             api(project(":ktor-client:ktor-client-mock"))
-            api(project(":ktor-client:ktor-client-tests:ktor-client-tests-dispatcher"))
+            api(project(":ktor-test-dispatcher"))
             api(project(":ktor-client:ktor-client-features:ktor-client-json:ktor-client-serialization"))
         }
     }

diff --git a/ktor-client/ktor-client-tests/common/src/io/ktor/client/tests/utils/CommonClientTestUtils.kt b/ktor-client/ktor-client-tests/common/src/io/ktor/client/tests/utils/CommonClientTestUtils.kt
@@ -6,7 +6,7 @@ package io.ktor.client.tests.utils
 
 import io.ktor.client.*
 import io.ktor.client.engine.*
-import io.ktor.client.tests.utils.dispatcher.*
+import io.ktor.test.dispatcher.*
 import io.ktor.util.*
 import kotlinx.coroutines.*
 import io.ktor.utils.io.core.*

diff --git a/ktor-io/build.gradle b/ktor-io/build.gradle
@@ -11,4 +11,7 @@ kotlin {
             }
         }
     }
+    sourceSets.commonTest.dependencies {
+        api project(":ktor-test-dispatcher")
+    }
 }
diff --git a/ktor-io/common/src/io/ktor/utils/io/ByteChannelSequential.kt b/ktor-io/common/src/io/ktor/utils/io/ByteChannelSequential.kt
@@ -675,7 +675,9 @@ abstract class ByteChannelSequentialBase(
 
     protected suspend fun awaitFreeSpace() {
         afterWrite()
-        return notFull.await { flush() }
+        notFull.await {
+            flush()
+        }
     }
 
     final override suspend fun peekTo(

diff --git a/ktor-io/common/src/io/ktor/utils/io/Coroutines.kt b/ktor-io/common/src/io/ktor/utils/io/Coroutines.kt
@@ -113,7 +113,8 @@ private fun <S : CoroutineScope> CoroutineScope.launchChannel(
     context: CoroutineContext,
     channel: ByteChannel,
     attachJob: Boolean,
-    block: suspend S.() -> Unit): ChannelJob {
+    block: suspend S.() -> Unit
+): ChannelJob {
 
     val job = launch(context) {
         if (attachJob) {
@@ -130,10 +131,14 @@ private fun <S : CoroutineScope> CoroutineScope.launchChannel(
     return ChannelJob(job, channel)
 }
 
-private class ChannelScope(delegate: CoroutineScope,
-                           override val channel: ByteChannel) : ReaderScope, WriterScope, CoroutineScope by delegate
+private class ChannelScope(
+    delegate: CoroutineScope,
+    override val channel: ByteChannel
+) : ReaderScope, WriterScope, CoroutineScope by delegate
 
 private class ChannelJob(
-    delegate: Job,
+    private val delegate: Job,
     override val channel: ByteChannel
-) : ReaderJob, WriterJob, Job by delegate
+) : ReaderJob, WriterJob, Job by delegate {
+    override fun toString(): String = "ChannelJob[$delegate]"
+}
diff --git a/ktor-io/common/test/io/ktor/utils/io/tests/ByteChannelBuildersTest.kt b/ktor-io/common/test/io/ktor/utils/io/tests/ByteChannelBuildersTest.kt
@@ -0,0 +1,31 @@
+/*
+ * Copyright 2014-2019 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package io.ktor.utils.io.tests
+
+import io.ktor.utils.io.*
+import kotlinx.coroutines.*
+import kotlin.test.*
+import io.ktor.test.dispatcher.*
+
+class ByteChannelBuildersTest {
+    @Test
+    fun testWriterCancelledByChannel() = testSuspend {
+        val context = Job()
+        val scope = CoroutineScope(context)
+
+        val task = scope.writer {
+            val data = ByteArray(8 * 1024)
+            while (true) {
+                channel.writeFully(data)
+            }
+        }
+
+        context.complete()
+        task.channel.cancel()
+        task.join()
+        assertTrue(task.isCancelled)
+        assertTrue(context.isCompleted)
+    }
+}
diff --git a/ktor-io/js/src/io/ktor/utils/io/ByteChannelJS.kt b/ktor-io/js/src/io/ktor/utils/io/ByteChannelJS.kt
@@ -125,4 +125,6 @@ internal class ByteChannelJS(initial: IoBuffer, autoFlush: Boolean) : ByteChanne
             remaining -= rc
         }
     }
+
+    override fun toString(): String = "ByteChannel[$attachedJob, ${hashCode()}]"
 }
diff --git a/ktor-io/js/src/io/ktor/utils/io/ByteReadChannel.kt b/ktor-io/js/src/io/ktor/utils/io/ByteReadChannel.kt
@@ -1,6 +1,6 @@
 package io.ktor.utils.io
 
-import io.ktor.utils.io.bits.Memory
+import io.ktor.utils.io.bits.*
 import io.ktor.utils.io.core.*
 import org.khronos.webgl.*
 
@@ -57,6 +57,7 @@ actual interface ByteReadChannel {
      * Suspends if not enough bytes available.
      */
     actual suspend fun readFully(dst: ByteArray, offset: Int, length: Int)
+
     actual suspend fun readFully(dst: IoBuffer, n: Int)
 
     suspend fun readFully(dst: ArrayBuffer, offset: Int, length: Int)

diff --git a/...-client-tests-dispatcher/build.gradle.kts → ktor-test-dispatcher/build.gradle.kts b/...-client-tests-dispatcher/build.gradle.kts → ktor-test-dispatcher/build.gradle.kts
diff --git a/...tests-dispatcher/common/src/TestCommon.kt → ...-test-dispatcher/common/src/TestCommon.kt b/...tests-dispatcher/common/src/TestCommon.kt → ...-test-dispatcher/common/src/TestCommon.kt
@@ -2,7 +2,7 @@
  * Copyright 2014-2019 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
  */
 
-package io.ktor.client.tests.utils.dispatcher
+package io.ktor.test.dispatcher
 
 import kotlinx.coroutines.*
 import kotlin.coroutines.*

diff --git a/...s-dispatcher/iosArm32/src/TestIosArm32.kt → ...t-dispatcher/iosArm32/src/TestIosArm32.kt b/...s-dispatcher/iosArm32/src/TestIosArm32.kt → ...t-dispatcher/iosArm32/src/TestIosArm32.kt
@@ -1,6 +1,6 @@
 @file:Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")
 
-package io.ktor.client.tests.utils.dispatcher
+package io.ktor.test.dispatcher
 
 import kotlinx.coroutines.*
 import kotlin.coroutines.*

diff --git a/...s-dispatcher/iosArm64/src/TestIosArm64.kt → ...t-dispatcher/iosArm64/src/TestIosArm64.kt b/...s-dispatcher/iosArm64/src/TestIosArm64.kt → ...t-dispatcher/iosArm64/src/TestIosArm64.kt
@@ -1,6 +1,6 @@
 @file:Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")
 
-package io.ktor.client.tests.utils.dispatcher
+package io.ktor.test.dispatcher
 
 import kotlinx.coroutines.*
 import kotlin.coroutines.*

diff --git a/...tests-dispatcher/iosX64/src/TestIosX64.kt → ...-test-dispatcher/iosX64/src/TestIosX64.kt b/...tests-dispatcher/iosX64/src/TestIosX64.kt → ...-test-dispatcher/iosX64/src/TestIosX64.kt
@@ -1,6 +1,6 @@
 @file:Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")
 
-package io.ktor.client.tests.utils.dispatcher
+package io.ktor.test.dispatcher
 
 import kotlinx.coroutines.*
 import kotlin.coroutines.*

diff --git a/...-client-tests-dispatcher/js/src/TestJs.kt → ktor-test-dispatcher/js/src/TestJs.kt b/...-client-tests-dispatcher/js/src/TestJs.kt → ktor-test-dispatcher/js/src/TestJs.kt
@@ -2,7 +2,7 @@
  * Copyright 2014-2019 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
  */
 
-package io.ktor.client.tests.utils.dispatcher
+package io.ktor.test.dispatcher
 
 import kotlinx.coroutines.*
 import kotlin.coroutines.*

diff --git a/...lient-tests-dispatcher/jvm/src/TestJvm.kt → ktor-test-dispatcher/jvm/src/TestJvm.kt b/...lient-tests-dispatcher/jvm/src/TestJvm.kt → ktor-test-dispatcher/jvm/src/TestJvm.kt
@@ -2,7 +2,7 @@
  * Copyright 2014-2019 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
  */
 
-package io.ktor.client.tests.utils.dispatcher
+package io.ktor.test.dispatcher
 
 import kotlinx.coroutines.*
 import kotlin.coroutines.*

diff --git a/...s-dispatcher/linuxX64/src/TestLinuxX64.kt → ...t-dispatcher/linuxX64/src/TestLinuxX64.kt b/...s-dispatcher/linuxX64/src/TestLinuxX64.kt → ...t-dispatcher/linuxX64/src/TestLinuxX64.kt
@@ -1,4 +1,4 @@
-package io.ktor.client.tests.utils.dispatcher
+package io.ktor.test.dispatcher
 
 import kotlinx.coroutines.*
 import kotlin.coroutines.*

diff --git a/...s-dispatcher/macosX64/src/TestMacosX64.kt → ...t-dispatcher/macosX64/src/TestMacosX64.kt b/...s-dispatcher/macosX64/src/TestMacosX64.kt → ...t-dispatcher/macosX64/src/TestMacosX64.kt
@@ -1,6 +1,6 @@
 @file:Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")
 
-package io.ktor.client.tests.utils.dispatcher
+package io.ktor.test.dispatcher
 
 import kotlinx.coroutines.*
 import kotlin.coroutines.*

diff --git a/...s-dispatcher/mingwX64/src/TestMingwX64.kt → ...t-dispatcher/mingwX64/src/TestMingwX64.kt b/...s-dispatcher/mingwX64/src/TestMingwX64.kt → ...t-dispatcher/mingwX64/src/TestMingwX64.kt
@@ -1,4 +1,4 @@
-package io.ktor.client.tests.utils.dispatcher
+package io.ktor.test.dispatcher
 
 import kotlinx.coroutines.*
 import kotlin.coroutines.*

diff --git a/...lient-tests-dispatcher/posix/src/.gitkeep → ktor-test-dispatcher/posix/src/.gitkeep b/...lient-tests-dispatcher/posix/src/.gitkeep → ktor-test-dispatcher/posix/src/.gitkeep
diff --git a/...-tests-dispatcher/posixIde/src/TestIde.kt → ktor-test-dispatcher/posixIde/src/TestIde.kt b/...-tests-dispatcher/posixIde/src/TestIde.kt → ktor-test-dispatcher/posixIde/src/TestIde.kt
@@ -2,7 +2,7 @@
  * Copyright 2014-2019 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
  */
 
-package io.ktor.client.tests.utils.dispatcher
+package io.ktor.test.dispatcher
 
 import kotlinx.coroutines.*
 import kotlin.coroutines.*

diff --git a/settings.gradle b/settings.gradle
@@ -32,7 +32,6 @@ include ':ktor-server'
 include ':ktor-client'
 include ':ktor-client:ktor-client-core'
 include ':ktor-client:ktor-client-tests'
-include ':ktor-client:ktor-client-tests:ktor-client-tests-dispatcher'
 include ':ktor-client:ktor-client-apache'
 include ':ktor-client:ktor-client-android'
 include ':ktor-client:ktor-client-cio'
@@ -80,3 +79,4 @@ include ':ktor-network'
 include ':ktor-network:ktor-network-tls'
 include ':ktor-network:ktor-network-tls:ktor-network-tls-certificates'
 include ':ktor-bom'
+include ':ktor-test-dispatcher'