forked from Kotlin/kotlinx.coroutines
/
TestCoroutineContext.kt
260 lines (221 loc) · 10.2 KB
/
TestCoroutineContext.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
/*
* Copyright 2016-2021 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package kotlinx.coroutines.test
import kotlinx.coroutines.*
import kotlinx.coroutines.CancellationException
import kotlinx.coroutines.internal.*
import java.util.concurrent.*
import kotlin.coroutines.*
/** @suppress */
@Deprecated("This API has been deprecated to integrate with Structured Concurrency.",
ReplaceWith("TestCoroutineScope", "kotlin.coroutines.test"),
level = DeprecationLevel.ERROR) // ERROR in 1.6.0, removed in 1.7.0
public class TestCoroutineContext(private val name: String? = null) : CoroutineContext {
private val uncaughtExceptions = mutableListOf<Throwable>()
private val ctxDispatcher = Dispatcher()
private val ctxHandler = CoroutineExceptionHandler { _, exception ->
uncaughtExceptions += exception
}
// The ordered queue for the runnable tasks.
private val queue = ThreadSafeHeap<TimedRunnableObsolete>()
// The per-scheduler global order counter.
private var counter = 0L
// Storing time in nanoseconds internally.
private var time = 0L
/**
* Exceptions that were caught during a [launch][CoroutineScope.launch] or a [async][CoroutineScope.async] + [Deferred.await].
*/
public val exceptions: List<Throwable> get() = uncaughtExceptions
// -- CoroutineContext implementation
public override fun <R> fold(initial: R, operation: (R, CoroutineContext.Element) -> R): R =
operation(operation(initial, ctxDispatcher), ctxHandler)
@Suppress("UNCHECKED_CAST")
public override fun <E : CoroutineContext.Element> get(key: CoroutineContext.Key<E>): E? = when {
key === ContinuationInterceptor -> ctxDispatcher as E
key === CoroutineExceptionHandler -> ctxHandler as E
else -> null
}
public override fun minusKey(key: CoroutineContext.Key<*>): CoroutineContext = when {
key === ContinuationInterceptor -> ctxHandler
key === CoroutineExceptionHandler -> ctxDispatcher
else -> this
}
/**
* Returns the current virtual clock-time as it is known to this CoroutineContext.
*
* @param unit The [TimeUnit] in which the clock-time must be returned.
* @return The virtual clock-time
*/
public fun now(unit: TimeUnit = TimeUnit.MILLISECONDS): Long=
unit.convert(time, TimeUnit.NANOSECONDS)
/**
* Moves the CoroutineContext's virtual clock forward by a specified amount of time.
*
* The returned delay-time can be larger than the specified delay-time if the code
* under test contains *blocking* Coroutines.
*
* @param delayTime The amount of time to move the CoroutineContext's clock forward.
* @param unit The [TimeUnit] in which [delayTime] and the return value is expressed.
* @return The amount of delay-time that this CoroutineContext's clock has been forwarded.
*/
public fun advanceTimeBy(delayTime: Long, unit: TimeUnit = TimeUnit.MILLISECONDS): Long {
val oldTime = time
advanceTimeTo(oldTime + unit.toNanos(delayTime), TimeUnit.NANOSECONDS)
return unit.convert(time - oldTime, TimeUnit.NANOSECONDS)
}
/**
* Moves the CoroutineContext's clock-time to a particular moment in time.
*
* @param targetTime The point in time to which to move the CoroutineContext's clock.
* @param unit The [TimeUnit] in which [targetTime] is expressed.
*/
public fun advanceTimeTo(targetTime: Long, unit: TimeUnit = TimeUnit.MILLISECONDS) {
val nanoTime = unit.toNanos(targetTime)
triggerActions(nanoTime)
if (nanoTime > time) time = nanoTime
}
/**
* Triggers any actions that have not yet been triggered and that are scheduled to be triggered at or
* before this CoroutineContext's present virtual clock-time.
*/
public fun triggerActions(): Unit = triggerActions(time)
/**
* Cancels all not yet triggered actions. Be careful calling this, since it can seriously
* mess with your coroutines work. This method should usually be called on tear-down of a
* unit test.
*/
public fun cancelAllActions() {
// An 'is-empty' test is required to avoid a NullPointerException in the 'clear()' method
if (!queue.isEmpty) queue.clear()
}
/**
* This method does nothing if there is one unhandled exception that satisfies the given predicate.
* Otherwise it throws an [AssertionError] with the given message.
*
* (this method will clear the list of unhandled exceptions)
*
* @param message Message of the [AssertionError]. Defaults to an empty String.
* @param predicate The predicate that must be satisfied.
*/
public fun assertUnhandledException(message: String = "", predicate: (Throwable) -> Boolean) {
if (uncaughtExceptions.size != 1 || !predicate(uncaughtExceptions[0])) throw AssertionError(message)
uncaughtExceptions.clear()
}
/**
* This method does nothing if there are no unhandled exceptions or all of them satisfy the given predicate.
* Otherwise it throws an [AssertionError] with the given message.
*
* (this method will clear the list of unhandled exceptions)
*
* @param message Message of the [AssertionError]. Defaults to an empty String.
* @param predicate The predicate that must be satisfied.
*/
public fun assertAllUnhandledExceptions(message: String = "", predicate: (Throwable) -> Boolean) {
if (!uncaughtExceptions.all(predicate)) throw AssertionError(message)
uncaughtExceptions.clear()
}
/**
* This method does nothing if one or more unhandled exceptions satisfy the given predicate.
* Otherwise it throws an [AssertionError] with the given message.
*
* (this method will clear the list of unhandled exceptions)
*
* @param message Message of the [AssertionError]. Defaults to an empty String.
* @param predicate The predicate that must be satisfied.
*/
public fun assertAnyUnhandledException(message: String = "", predicate: (Throwable) -> Boolean) {
if (!uncaughtExceptions.any(predicate)) throw AssertionError(message)
uncaughtExceptions.clear()
}
/**
* This method does nothing if the list of unhandled exceptions satisfy the given predicate.
* Otherwise it throws an [AssertionError] with the given message.
*
* (this method will clear the list of unhandled exceptions)
*
* @param message Message of the [AssertionError]. Defaults to an empty String.
* @param predicate The predicate that must be satisfied.
*/
public fun assertExceptions(message: String = "", predicate: (List<Throwable>) -> Boolean) {
if (!predicate(uncaughtExceptions)) throw AssertionError(message)
uncaughtExceptions.clear()
}
private fun enqueue(block: Runnable) =
queue.addLast(TimedRunnableObsolete(block, counter++))
private fun postDelayed(block: Runnable, delayTime: Long) =
TimedRunnableObsolete(block, counter++, time + TimeUnit.MILLISECONDS.toNanos(delayTime))
.also {
queue.addLast(it)
}
private fun processNextEvent(): Long {
val current = queue.peek()
if (current != null) {
// Automatically advance time for EventLoop callbacks
triggerActions(current.time)
}
return if (queue.isEmpty) Long.MAX_VALUE else 0L
}
private fun triggerActions(targetTime: Long) {
while (true) {
val current = queue.removeFirstIf { it.time <= targetTime } ?: break
// If the scheduled time is 0 (immediate) use current virtual time
if (current.time != 0L) time = current.time
current.run()
}
}
public override fun toString(): String = name ?: "TestCoroutineContext@$hexAddress"
private inner class Dispatcher : EventLoop(), Delay {
init {
incrementUseCount() // this event loop is never completed
}
override fun dispatch(context: CoroutineContext, block: Runnable) {
this@TestCoroutineContext.enqueue(block)
}
// override runBlocking to process this event loop
override fun shouldBeProcessedFromContext(): Boolean = true
override fun scheduleResumeAfterDelay(timeMillis: Long, continuation: CancellableContinuation<Unit>) {
postDelayed(Runnable {
with(continuation) { resumeUndispatched(Unit) }
}, timeMillis)
}
override fun invokeOnTimeout(timeMillis: Long, block: Runnable, context: CoroutineContext): DisposableHandle {
val node = postDelayed(block, timeMillis)
return object : DisposableHandle {
override fun dispose() {
queue.remove(node)
}
}
}
override fun processNextEvent() = this@TestCoroutineContext.processNextEvent()
public override fun toString(): String = "Dispatcher(${this@TestCoroutineContext})"
}
}
private class TimedRunnableObsolete(
private val run: Runnable,
private val count: Long = 0,
@JvmField internal val time: Long = 0
) : Comparable<TimedRunnableObsolete>, Runnable by run, ThreadSafeHeapNode {
override var heap: ThreadSafeHeap<*>? = null
override var index: Int = 0
override fun run() = run.run()
override fun compareTo(other: TimedRunnableObsolete) = if (time == other.time) {
count.compareTo(other.count)
} else {
time.compareTo(other.time)
}
override fun toString() = "TimedRunnable(time=$time, run=$run)"
}
/** @suppress */
@Deprecated("This API has been deprecated to integrate with Structured Concurrency.",
ReplaceWith("testContext.runBlockingTest(testBody)", "kotlin.coroutines.test"),
level = DeprecationLevel.ERROR) // ERROR in 1.6.0, removed in 1.7.0
@Suppress("DEPRECATION_ERROR")
public fun withTestContext(testContext: TestCoroutineContext = TestCoroutineContext(), testBody: TestCoroutineContext.() -> Unit) {
with (testContext) {
testBody()
if (!exceptions.all { it is CancellationException }) {
throw AssertionError("Coroutine encountered unhandled exceptions:\n$exceptions")
}
}
}