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
|
/*
* Copyright 2016-2020 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package kotlinx.coroutines.debug.junit5
import org.assertj.core.api.*
import org.junit.Ignore
import org.junit.Assert.*
import org.junit.Test
import org.junit.platform.engine.*
import org.junit.platform.engine.discovery.DiscoverySelectors.*
import org.junit.platform.testkit.engine.*
import org.junit.platform.testkit.engine.EventConditions.*
import java.io.*
// note that these tests are run using JUnit4 in order not to mix the testing systems.
class CoroutinesTimeoutTest {
// This test is ignored because it just checks an example.
@Test
@Ignore
fun testRegisterExtensionExample() {
val capturedOut = ByteArrayOutputStream()
eventsForSelector(selectClass(RegisterExtensionExample::class.java), capturedOut)
.testTimedOut("testThatHangs", 5000)
}
@Test
fun testCoroutinesTimeoutSimple() {
val capturedOut = ByteArrayOutputStream()
eventsForSelector(selectClass(CoroutinesTimeoutSimpleTest::class.java), capturedOut)
.testFinishedSuccessfully("ignoresClassTimeout")
.testFinishedSuccessfully("fitsInClassTimeout")
.testTimedOut("usesClassTimeout1", 100)
.testTimedOut("usesMethodTimeout", 200)
.testTimedOut("usesClassTimeout2", 100)
assertEquals(capturedOut.toString(), 3, countDumps(capturedOut))
}
@Test
fun testCoroutinesTimeoutMethod() {
val capturedOut = ByteArrayOutputStream()
eventsForSelector(selectClass(CoroutinesTimeoutMethodTest::class.java), capturedOut)
.testFinishedSuccessfully("fitsInMethodTimeout")
.testFinishedSuccessfully("noClassTimeout")
.testTimedOut("usesMethodTimeoutWithNoClassTimeout", 100)
assertEquals(capturedOut.toString(), 1, countDumps(capturedOut))
}
@Test
fun testCoroutinesTimeoutNested() {
val capturedOut = ByteArrayOutputStream()
eventsForSelector(selectClass(CoroutinesTimeoutNestedTest::class.java), capturedOut)
.testFinishedSuccessfully("fitsInOuterClassTimeout")
.testTimedOut("usesOuterClassTimeout", 200)
assertEquals(capturedOut.toString(), 1, countDumps(capturedOut))
}
@Test
fun testCoroutinesTimeoutInheritanceWithNoTimeoutInDerived() {
val capturedOut = ByteArrayOutputStream()
eventsForSelector(selectClass(CoroutinesTimeoutInheritanceTest.InheritedWithNoTimeout::class.java), capturedOut)
.testFinishedSuccessfully("methodOverridesBaseClassTimeoutWithGreaterTimeout")
.testTimedOut("usesBaseClassTimeout", 100)
.testTimedOut("methodOverridesBaseClassTimeoutWithLesserTimeout", 10)
assertEquals(capturedOut.toString(), 2, countDumps(capturedOut))
}
@Test
fun testCoroutinesTimeoutInheritanceWithGreaterTimeoutInDerived() {
val capturedOut = ByteArrayOutputStream()
eventsForSelector(
selectClass(CoroutinesTimeoutInheritanceTest.InheritedWithGreaterTimeout::class.java),
capturedOut
)
.testFinishedSuccessfully("classOverridesBaseClassTimeout1")
.testTimedOut("classOverridesBaseClassTimeout2", 300)
assertEquals(capturedOut.toString(), 1, countDumps(capturedOut))
}
/* Currently there's no ability to replicate [TestFailureValidation] as is for JUnit5:
https://github.com/junit-team/junit5/issues/506. So, the test mechanism is more ad-hoc. */
@Test
fun testCoroutinesTimeoutExtensionDisabledTraces() {
val capturedOut = ByteArrayOutputStream()
eventsForSelector(selectClass(CoroutinesTimeoutExtensionTest.DisabledStackTracesTest::class.java), capturedOut)
.testTimedOut("hangingTest", 500)
assertEquals(false, capturedOut.toString().contains("Coroutine creation stacktrace"))
assertEquals(capturedOut.toString(), 1, countDumps(capturedOut))
}
@Test
fun testCoroutinesTimeoutExtensionEager() {
val capturedOut = ByteArrayOutputStream()
eventsForSelector(selectClass(CoroutinesTimeoutExtensionTest.EagerTest::class.java), capturedOut)
.testTimedOut("hangingTest", 500)
for (expectedPart in listOf("hangForever", "waitForHangJob", "BlockingCoroutine{Active}")) {
assertEquals(expectedPart, true, capturedOut.toString().contains(expectedPart))
}
assertEquals(capturedOut.toString(), 1, countDumps(capturedOut))
}
@Test
fun testCoroutinesTimeoutExtensionSimple() {
val capturedOut = ByteArrayOutputStream()
eventsForSelector(selectClass(CoroutinesTimeoutExtensionTest.SimpleTest::class.java), capturedOut)
.testFinishedSuccessfully("successfulTest")
.testTimedOut("hangingTest", 1000)
.haveExactly(1, event(
test("throwingTest"),
finishedWithFailure(Condition({ it is RuntimeException}, "is RuntimeException"))
))
for (expectedPart in listOf("suspendForever", "invokeSuspend", "BlockingCoroutine{Active}")) {
assertEquals(expectedPart, true, capturedOut.toString().contains(expectedPart))
}
for (nonExpectedPart in listOf("delay", "throwingTest")) {
assertEquals(nonExpectedPart, false, capturedOut.toString().contains(nonExpectedPart))
}
assertEquals(capturedOut.toString(), 1, countDumps(capturedOut))
}
}
private fun eventsForSelector(selector: DiscoverySelector, capturedOut: OutputStream): ListAssert<Event> {
val systemOut: PrintStream = System.out
val systemErr: PrintStream = System.err
return try {
System.setOut(PrintStream(capturedOut))
System.setErr(PrintStream(capturedOut))
EngineTestKit.engine("junit-jupiter")
.selectors(selector)
.execute()
.testEvents()
.assertThatEvents()
} finally {
System.setOut(systemOut)
System.setErr(systemErr)
}
}
private fun ListAssert<Event>.testFinishedSuccessfully(testName: String): ListAssert<Event> =
haveExactly(1, event(
test(testName),
finishedSuccessfully()
))
private fun ListAssert<Event>.testTimedOut(testName: String, after: Long): ListAssert<Event> =
haveExactly(1, event(
test(testName),
finishedWithFailure(Condition({ it is CoroutinesTimeoutException && it.timeoutMs == after },
"is CoroutinesTimeoutException($after)"))
))
/** Counts the number of occurrences of "Coroutines dump" in [capturedOut] */
private fun countDumps(capturedOut: ByteArrayOutputStream): Int {
var result = 0
val outStr = capturedOut.toString()
val header = "Coroutines dump"
var i = 0
while (i < outStr.length - header.length) {
if (outStr.substring(i, i + header.length) == header) {
result += 1
i += header.length
} else {
i += 1
}
}
return result
}
|
