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
|
/*
* Copyright 2016-2020 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package kotlinx.coroutines.knit
import kotlinx.coroutines.*
import kotlinx.coroutines.internal.*
import kotlinx.coroutines.scheduling.*
import kotlinx.knit.test.*
import java.util.concurrent.*
import kotlin.test.*
fun wrapTask(block: Runnable) = kotlinx.coroutines.wrapTask(block)
// helper function to dump exception to stdout for ease of debugging failed tests
private inline fun <T> outputException(name: String, block: () -> T): T =
try { block() }
catch (e: Throwable) {
println("--- Failed test$name")
e.printStackTrace(System.out)
throw e
}
private const val SHUTDOWN_TIMEOUT = 5000L // 5 sec at most to wait
private val OUT_ENABLED = systemProp("guide.tests.sout", false)
fun <R> test(name: String, block: () -> R): List<String> = outputException(name) {
try {
captureOutput(name, stdoutEnabled = OUT_ENABLED) { log ->
CommonPool.usePrivatePool()
DefaultScheduler.usePrivateScheduler()
DefaultExecutor.shutdown(SHUTDOWN_TIMEOUT)
resetCoroutineId()
val threadsBefore = currentThreads()
try {
withVirtualTimeSource(log) {
val result = block()
require(result === Unit) { "Test 'main' shall return Unit" }
}
} finally {
// the shutdown
log.println("--- shutting down")
CommonPool.shutdown(SHUTDOWN_TIMEOUT)
DefaultScheduler.shutdown(SHUTDOWN_TIMEOUT)
shutdownDispatcherPools(SHUTDOWN_TIMEOUT)
DefaultExecutor.shutdown(SHUTDOWN_TIMEOUT) // the last man standing -- cleanup all pending tasks
}
checkTestThreads(threadsBefore) // check thread if the main completed successfully
}
} finally {
CommonPool.restore()
DefaultScheduler.restore()
}
}
private fun shutdownDispatcherPools(timeout: Long) {
val threads = arrayOfNulls<Thread>(Thread.activeCount())
val n = Thread.enumerate(threads)
for (i in 0 until n) {
val thread = threads[i]
if (thread is PoolThread)
(thread.dispatcher.executor as ExecutorService).apply {
shutdown()
awaitTermination(timeout, TimeUnit.MILLISECONDS)
shutdownNow().forEach { DefaultExecutor.enqueue(it) }
}
}
}
enum class SanitizeMode {
NONE,
ARBITRARY_TIME,
FLEXIBLE_THREAD
}
private fun sanitize(s: String, mode: SanitizeMode): String {
var res = s
when (mode) {
SanitizeMode.ARBITRARY_TIME -> {
res = res.replace(Regex(" [0-9]+ ms"), " xxx ms")
}
SanitizeMode.FLEXIBLE_THREAD -> {
res = res.replace(Regex("ForkJoinPool\\.commonPool-worker-[0-9]+"), "DefaultDispatcher")
res = res.replace(Regex("ForkJoinPool-[0-9]+-worker-[0-9]+"), "DefaultDispatcher")
res = res.replace(Regex("CommonPool-worker-[0-9]+"), "DefaultDispatcher")
res = res.replace(Regex("DefaultDispatcher-worker-[0-9]+"), "DefaultDispatcher")
res = res.replace(Regex("RxComputationThreadPool-[0-9]+"), "RxComputationThreadPool")
res = res.replace(Regex("Test( worker)?"), "main")
res = res.replace(Regex("@[0-9a-f]+"), "") // drop hex address
}
SanitizeMode.NONE -> {}
}
return res
}
private fun List<String>.verifyCommonLines(expected: Array<out String>, mode: SanitizeMode = SanitizeMode.NONE) {
val n = minOf(size, expected.size)
for (i in 0 until n) {
val exp = sanitize(expected[i], mode)
val act = sanitize(get(i), mode)
assertEquals(exp, act, "Line ${i + 1}")
}
}
private fun List<String>.checkEqualNumberOfLines(expected: Array<out String>) {
if (size > expected.size)
error("Expected ${expected.size} lines, but found $size. Unexpected line '${get(expected.size)}'")
else if (size < expected.size)
error("Expected ${expected.size} lines, but found $size")
}
fun List<String>.verifyLines(vararg expected: String) = verify {
verifyCommonLines(expected)
checkEqualNumberOfLines(expected)
}
fun List<String>.verifyLinesStartWith(vararg expected: String) = verify {
verifyCommonLines(expected)
assertTrue(expected.size <= size, "Number of lines")
}
fun List<String>.verifyLinesArbitraryTime(vararg expected: String) = verify {
verifyCommonLines(expected, SanitizeMode.ARBITRARY_TIME)
checkEqualNumberOfLines(expected)
}
fun List<String>.verifyLinesFlexibleThread(vararg expected: String) = verify {
verifyCommonLines(expected, SanitizeMode.FLEXIBLE_THREAD)
checkEqualNumberOfLines(expected)
}
fun List<String>.verifyLinesStartUnordered(vararg expected: String) = verify {
val expectedSorted = expected.sorted().toTypedArray()
sorted().verifyLinesStart(*expectedSorted)
}
fun List<String>.verifyExceptions(vararg expected: String) {
val original = this
val actual = ArrayList<String>().apply {
var except = false
for (line in original) {
when {
!except && line.startsWith("\tat") -> except = true
except && !line.startsWith("\t") && !line.startsWith("Caused by: ") -> except = false
}
if (!except) add(line)
}
}
val n = minOf(actual.size, expected.size)
for (i in 0 until n) {
val exp = sanitize(expected[i], SanitizeMode.FLEXIBLE_THREAD)
val act = sanitize(actual[i], SanitizeMode.FLEXIBLE_THREAD)
assertEquals(exp, act, "Line ${i + 1}")
}
}
fun List<String>.verifyLinesStart(vararg expected: String) = verify {
val n = minOf(size, expected.size)
for (i in 0 until n) {
val exp = sanitize(expected[i], SanitizeMode.FLEXIBLE_THREAD)
val act = sanitize(get(i), SanitizeMode.FLEXIBLE_THREAD)
assertEquals(exp, act.substring(0, minOf(act.length, exp.length)), "Line ${i + 1}")
}
checkEqualNumberOfLines(expected)
}
private inline fun List<String>.verify(verification: () -> Unit) {
try {
verification()
} catch (t: Throwable) {
if (!OUT_ENABLED) {
println("Printing [delayed] test output")
forEach { println(it) }
}
throw t
}
}
|
