commonTest.CancellableResumeTest.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlinx-coroutines-core
Show all versions of kotlinx-coroutines-core
Coroutines support libraries for Kotlin
/*
* Copyright 2016-2020 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
@file:Suppress("NAMED_ARGUMENTS_NOT_ALLOWED") // KT-21913
package kotlinx.coroutines
import kotlin.test.*
/**
* Test for [CancellableContinuation.resume] with `onCancellation` parameter.
*/
class CancellableResumeTest : TestBase() {
@Test
fun testResumeImmediateNormally() = runTest {
expect(1)
val ok = suspendCancellableCoroutine { cont ->
expect(2)
cont.invokeOnCancellation { expectUnreached() }
cont.resume("OK") { expectUnreached() }
expect(3)
}
assertEquals("OK", ok)
finish(4)
}
@Test
fun testResumeImmediateAfterCancel() = runTest(
expected = { it is TestException }
) {
expect(1)
suspendCancellableCoroutine { cont ->
expect(2)
cont.invokeOnCancellation { expect(3) }
cont.cancel(TestException("FAIL"))
expect(4)
cont.resume("OK") { cause ->
expect(5)
assertTrue(cause is TestException)
}
finish(6)
}
expectUnreached()
}
@Test
fun testResumeImmediateAfterCancelWithHandlerFailure() = runTest(
expected = { it is TestException },
unhandled = listOf(
{ it is CompletionHandlerException && it.cause is TestException2 },
{ it is CompletionHandlerException && it.cause is TestException3 }
)
) {
expect(1)
suspendCancellableCoroutine { cont ->
expect(2)
cont.invokeOnCancellation {
expect(3)
throw TestException2("FAIL") // invokeOnCancellation handler fails with exception
}
cont.cancel(TestException("FAIL"))
expect(4)
cont.resume("OK") { cause ->
expect(5)
assertTrue(cause is TestException)
throw TestException3("FAIL") // onCancellation block fails with exception
}
finish(6)
}
expectUnreached()
}
@Test
fun testResumeImmediateAfterIndirectCancel() = runTest(
expected = { it is CancellationException }
) {
expect(1)
val ctx = coroutineContext
suspendCancellableCoroutine { cont ->
expect(2)
cont.invokeOnCancellation { expect(3) }
ctx.cancel()
expect(4)
cont.resume("OK") {
expect(5)
}
finish(6)
}
expectUnreached()
}
@Test
fun testResumeImmediateAfterIndirectCancelWithHandlerFailure() = runTest(
expected = { it is CancellationException },
unhandled = listOf(
{ it is CompletionHandlerException && it.cause is TestException2 },
{ it is CompletionHandlerException && it.cause is TestException3 }
)
) {
expect(1)
val ctx = coroutineContext
suspendCancellableCoroutine { cont ->
expect(2)
cont.invokeOnCancellation {
expect(3)
throw TestException2("FAIL") // invokeOnCancellation handler fails with exception
}
ctx.cancel()
expect(4)
cont.resume("OK") {
expect(5)
throw TestException3("FAIL") // onCancellation block fails with exception
}
finish(6)
}
expectUnreached()
}
@Test
fun testResumeLaterNormally() = runTest {
expect(1)
lateinit var cc: CancellableContinuation
launch(start = CoroutineStart.UNDISPATCHED) {
expect(2)
val ok = suspendCancellableCoroutine { cont ->
expect(3)
cont.invokeOnCancellation { expectUnreached() }
cc = cont
}
assertEquals("OK", ok)
finish(6)
}
expect(4)
cc.resume("OK") { expectUnreached() }
expect(5)
}
@Test
fun testResumeLaterAfterCancel() = runTest {
expect(1)
lateinit var cc: CancellableContinuation
val job = launch(start = CoroutineStart.UNDISPATCHED) {
expect(2)
try {
suspendCancellableCoroutine { cont ->
expect(3)
cont.invokeOnCancellation { expect(5) }
cc = cont
}
expectUnreached()
} catch (e: CancellationException) {
finish(9)
}
}
expect(4)
job.cancel(TestCancellationException())
expect(6)
cc.resume("OK") { cause ->
expect(7)
assertTrue(cause is TestCancellationException)
}
expect(8)
}
@Test
fun testResumeLaterAfterCancelWithHandlerFailure() = runTest(
unhandled = listOf(
{ it is CompletionHandlerException && it.cause is TestException2 },
{ it is CompletionHandlerException && it.cause is TestException3 }
)
) {
expect(1)
lateinit var cc: CancellableContinuation
val job = launch(start = CoroutineStart.UNDISPATCHED) {
expect(2)
try {
suspendCancellableCoroutine { cont ->
expect(3)
cont.invokeOnCancellation {
expect(5)
throw TestException2("FAIL") // invokeOnCancellation handler fails with exception
}
cc = cont
}
expectUnreached()
} catch (e: CancellationException) {
finish(9)
}
}
expect(4)
job.cancel(TestCancellationException())
expect(6)
cc.resume("OK") { cause ->
expect(7)
assertTrue(cause is TestCancellationException)
throw TestException3("FAIL") // onCancellation block fails with exception
}
expect(8)
}
@Test
fun testResumeCancelWhileDispatched() = runTest {
expect(1)
lateinit var cc: CancellableContinuation
val job = launch(start = CoroutineStart.UNDISPATCHED) {
expect(2)
try {
suspendCancellableCoroutine { cont ->
expect(3)
// resumed first, dispatched, then cancelled, but still got invokeOnCancellation call
cont.invokeOnCancellation { cause ->
// Note: invokeOnCancellation is called before cc.resume(value) { ... } handler
expect(7)
assertTrue(cause is TestCancellationException)
}
cc = cont
}
expectUnreached()
} catch (e: CancellationException) {
expect(9)
}
}
expect(4)
cc.resume("OK") { cause ->
// Note: this handler is called after invokeOnCancellation handler
expect(8)
assertTrue(cause is TestCancellationException)
}
expect(5)
job.cancel(TestCancellationException()) // cancel while execution is dispatched
expect(6)
yield() // to coroutine -- throws cancellation exception
finish(10)
}
@Test
fun testResumeCancelWhileDispatchedWithHandlerFailure() = runTest(
unhandled = listOf(
{ it is CompletionHandlerException && it.cause is TestException2 },
{ it is CompletionHandlerException && it.cause is TestException3 }
)
) {
expect(1)
lateinit var cc: CancellableContinuation
val job = launch(start = CoroutineStart.UNDISPATCHED) {
expect(2)
try {
suspendCancellableCoroutine { cont ->
expect(3)
// resumed first, dispatched, then cancelled, but still got invokeOnCancellation call
cont.invokeOnCancellation { cause ->
// Note: invokeOnCancellation is called before cc.resume(value) { ... } handler
expect(7)
assertTrue(cause is TestCancellationException)
throw TestException2("FAIL") // invokeOnCancellation handler fails with exception
}
cc = cont
}
expectUnreached()
} catch (e: CancellationException) {
expect(9)
}
}
expect(4)
cc.resume("OK") { cause ->
// Note: this handler is called after invokeOnCancellation handler
expect(8)
assertTrue(cause is TestCancellationException)
throw TestException3("FAIL") // onCancellation block fails with exception
}
expect(5)
job.cancel(TestCancellationException()) // cancel while execution is dispatched
expect(6)
yield() // to coroutine -- throws cancellation exception
finish(10)
}
@Test
fun testResumeUnconfined() = runTest {
val outerScope = this
withContext(Dispatchers.Unconfined) {
val result = suspendCancellableCoroutine {
outerScope.launch {
it.resume("OK") {
expectUnreached()
}
}
}
assertEquals("OK", result)
}
}
}