|
| 1 | +/* |
| 2 | + * Copyright 2016-2018 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. |
| 3 | + */ |
| 4 | + |
| 5 | +@file:Suppress("NAMED_ARGUMENTS_NOT_ALLOWED", "UNREACHABLE_CODE") // KT-21913 |
| 6 | + |
| 7 | +package kotlinx.coroutines |
| 8 | + |
| 9 | +import kotlin.test.* |
| 10 | +import kotlin.time.Duration |
| 11 | +import kotlin.time.ExperimentalTime |
| 12 | +import kotlin.time.milliseconds |
| 13 | +import kotlin.time.seconds |
| 14 | + |
| 15 | +@ExperimentalTime |
| 16 | +class WithTimeoutDurationTest : TestBase() { |
| 17 | + /** |
| 18 | + * Tests a case of no timeout and no suspension inside. |
| 19 | + */ |
| 20 | + @Test |
| 21 | + fun testBasicNoSuspend() = runTest { |
| 22 | + expect(1) |
| 23 | + val result = withTimeout(10.seconds) { |
| 24 | + expect(2) |
| 25 | + "OK" |
| 26 | + } |
| 27 | + assertEquals("OK", result) |
| 28 | + finish(3) |
| 29 | + } |
| 30 | + |
| 31 | + /** |
| 32 | + * Tests a case of no timeout and one suspension inside. |
| 33 | + */ |
| 34 | + @Test |
| 35 | + fun testBasicSuspend() = runTest { |
| 36 | + expect(1) |
| 37 | + val result = withTimeout(10.seconds) { |
| 38 | + expect(2) |
| 39 | + yield() |
| 40 | + expect(3) |
| 41 | + "OK" |
| 42 | + } |
| 43 | + assertEquals("OK", result) |
| 44 | + finish(4) |
| 45 | + } |
| 46 | + |
| 47 | + /** |
| 48 | + * Tests proper dispatching of `withTimeout` blocks |
| 49 | + */ |
| 50 | + @Test |
| 51 | + fun testDispatch() = runTest { |
| 52 | + expect(1) |
| 53 | + launch { |
| 54 | + expect(4) |
| 55 | + yield() // back to main |
| 56 | + expect(7) |
| 57 | + } |
| 58 | + expect(2) |
| 59 | + // test that it does not yield to the above job when started |
| 60 | + val result = withTimeout(1.seconds) { |
| 61 | + expect(3) |
| 62 | + yield() // yield only now |
| 63 | + expect(5) |
| 64 | + "OK" |
| 65 | + } |
| 66 | + assertEquals("OK", result) |
| 67 | + expect(6) |
| 68 | + yield() // back to launch |
| 69 | + finish(8) |
| 70 | + } |
| 71 | + |
| 72 | + |
| 73 | + /** |
| 74 | + * Tests that a 100% CPU-consuming loop will react on timeout if it has yields. |
| 75 | + */ |
| 76 | + @Test |
| 77 | + fun testYieldBlockingWithTimeout() = runTest( |
| 78 | + expected = { it is CancellationException } |
| 79 | + ) { |
| 80 | + withTimeout(100.milliseconds) { |
| 81 | + while (true) { |
| 82 | + yield() |
| 83 | + } |
| 84 | + } |
| 85 | + } |
| 86 | + |
| 87 | + /** |
| 88 | + * Tests that [withTimeout] waits for children coroutines to complete. |
| 89 | + */ |
| 90 | + @Test |
| 91 | + fun testWithTimeoutChildWait() = runTest { |
| 92 | + expect(1) |
| 93 | + withTimeout(100.milliseconds) { |
| 94 | + expect(2) |
| 95 | + // launch child with timeout |
| 96 | + launch { |
| 97 | + expect(4) |
| 98 | + } |
| 99 | + expect(3) |
| 100 | + // now will wait for child before returning |
| 101 | + } |
| 102 | + finish(5) |
| 103 | + } |
| 104 | + |
| 105 | + @Test |
| 106 | + fun testBadClass() = runTest { |
| 107 | + val bad = BadClass() |
| 108 | + val result = withTimeout(100.milliseconds) { |
| 109 | + bad |
| 110 | + } |
| 111 | + assertSame(bad, result) |
| 112 | + } |
| 113 | + |
| 114 | + class BadClass { |
| 115 | + override fun equals(other: Any?): Boolean = error("Should not be called") |
| 116 | + override fun hashCode(): Int = error("Should not be called") |
| 117 | + override fun toString(): String = error("Should not be called") |
| 118 | + } |
| 119 | + |
| 120 | + @Test |
| 121 | + fun testExceptionOnTimeout() = runTest { |
| 122 | + expect(1) |
| 123 | + try { |
| 124 | + withTimeout(100.milliseconds) { |
| 125 | + expect(2) |
| 126 | + delay(1000.milliseconds) |
| 127 | + expectUnreached() |
| 128 | + "OK" |
| 129 | + } |
| 130 | + } catch (e: CancellationException) { |
| 131 | + assertEquals("Timed out waiting for 100 ms", e.message) |
| 132 | + finish(3) |
| 133 | + } |
| 134 | + } |
| 135 | + |
| 136 | + @Test |
| 137 | + fun testSuppressExceptionWithResult() = runTest( |
| 138 | + expected = { it is CancellationException } |
| 139 | + ) { |
| 140 | + expect(1) |
| 141 | + withTimeout(100.milliseconds) { |
| 142 | + expect(2) |
| 143 | + try { |
| 144 | + delay(1000.milliseconds) |
| 145 | + } catch (e: CancellationException) { |
| 146 | + finish(3) |
| 147 | + } |
| 148 | + "OK" |
| 149 | + } |
| 150 | + expectUnreached() |
| 151 | + } |
| 152 | + |
| 153 | + @Test |
| 154 | + fun testSuppressExceptionWithAnotherException() = runTest { |
| 155 | + expect(1) |
| 156 | + try { |
| 157 | + withTimeout(100.milliseconds) { |
| 158 | + expect(2) |
| 159 | + try { |
| 160 | + delay(1000.milliseconds) |
| 161 | + } catch (e: CancellationException) { |
| 162 | + expect(3) |
| 163 | + throw TestException() |
| 164 | + } |
| 165 | + expectUnreached() |
| 166 | + "OK" |
| 167 | + } |
| 168 | + expectUnreached() |
| 169 | + } catch (e: TestException) { |
| 170 | + finish(4) |
| 171 | + } |
| 172 | + } |
| 173 | + |
| 174 | + @Test |
| 175 | + fun testNegativeTimeout() = runTest { |
| 176 | + expect(1) |
| 177 | + try { |
| 178 | + withTimeout(-1.milliseconds) { |
| 179 | + expectUnreached() |
| 180 | + "OK" |
| 181 | + } |
| 182 | + } catch (e: TimeoutCancellationException) { |
| 183 | + assertEquals("Timed out immediately", e.message) |
| 184 | + finish(2) |
| 185 | + } |
| 186 | + } |
| 187 | + |
| 188 | + @Test |
| 189 | + fun testExceptionFromWithinTimeout() = runTest { |
| 190 | + expect(1) |
| 191 | + try { |
| 192 | + expect(2) |
| 193 | + withTimeout(1.seconds) { |
| 194 | + expect(3) |
| 195 | + throw TestException() |
| 196 | + } |
| 197 | + expectUnreached() |
| 198 | + } catch (e: TestException) { |
| 199 | + finish(4) |
| 200 | + } |
| 201 | + } |
| 202 | + |
| 203 | + @Test |
| 204 | + fun testIncompleteWithTimeoutState() = runTest { |
| 205 | + lateinit var timeoutJob: Job |
| 206 | + val handle = withTimeout(Duration.INFINITE) { |
| 207 | + timeoutJob = coroutineContext[Job]!! |
| 208 | + timeoutJob.invokeOnCompletion { } |
| 209 | + } |
| 210 | + |
| 211 | + handle.dispose() |
| 212 | + timeoutJob.join() |
| 213 | + assertTrue(timeoutJob.isCompleted) |
| 214 | + assertFalse(timeoutJob.isActive) |
| 215 | + assertFalse(timeoutJob.isCancelled) |
| 216 | + } |
| 217 | +} |
0 commit comments