forked from androidx/androidx
/
TestUtils.kt
147 lines (132 loc) · 4.88 KB
/
TestUtils.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
/*
* Copyright 2021 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package androidx.compose.ui.window
import androidx.compose.runtime.Composable
import androidx.compose.runtime.Recomposer
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.setValue
import androidx.compose.runtime.snapshots.Snapshot
import java.awt.GraphicsEnvironment
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.ExperimentalCoroutinesApi
import kotlinx.coroutines.Job
import kotlinx.coroutines.delay
import kotlinx.coroutines.flow.collect
import kotlinx.coroutines.flow.takeWhile
import kotlinx.coroutines.runBlocking
import kotlinx.coroutines.withTimeout
import kotlinx.coroutines.yield
import org.jetbrains.skiko.MainUIDispatcher
import org.junit.Assume.assumeFalse
@OptIn(ExperimentalCoroutinesApi::class)
internal fun runApplicationTest(
/**
* Use delay(500) additionally to `yield` in `await*` functions
*
* Set this property only if you sure that you can't easily make the test deterministic
* (non-flaky).
*
* We have to use `useDelay` in some Linux Tests, because Linux can behave in
* non-deterministic way when we change position/size very fast (see the snippet below)
*/
useDelay: Boolean = false,
body: suspend WindowTestScope.() -> Unit
) {
assumeFalse(GraphicsEnvironment.getLocalGraphicsEnvironment().isHeadlessInstance)
runBlocking(MainUIDispatcher) {
withTimeout(30000) {
val exceptionHandler = TestExceptionHandler()
withExceptionHandler(exceptionHandler) {
val scope = WindowTestScope(this, useDelay, exceptionHandler)
scope.body()
scope.exitTestApplication()
}
exceptionHandler.throwIfCaught()
}
}
}
private inline fun withExceptionHandler(
handler: Thread.UncaughtExceptionHandler,
body: () -> Unit
) {
val old = Thread.currentThread().uncaughtExceptionHandler
Thread.currentThread().uncaughtExceptionHandler = handler
try {
body()
} finally {
Thread.currentThread().uncaughtExceptionHandler = old
}
}
internal class TestExceptionHandler : Thread.UncaughtExceptionHandler {
private var exception: Throwable? = null
fun throwIfCaught() {
exception?.also {
throw it
}
}
override fun uncaughtException(thread: Thread, throwable: Throwable) {
if (exception != null) {
exception?.addSuppressed(throwable)
} else {
exception = throwable
}
}
}
internal class WindowTestScope(
private val scope: CoroutineScope,
private val useDelay: Boolean,
private val exceptionHandler: TestExceptionHandler
) : CoroutineScope by CoroutineScope(scope.coroutineContext + Job()) {
var isOpen by mutableStateOf(true)
private val initialRecomposers = Recomposer.runningRecomposers.value
// TODO(demin) replace launchApplication to launchTestApplication in all tests,
// because we don't close the window with simple launchApplication
fun launchTestApplication(
content: @Composable ApplicationScope.() -> Unit
) = launchApplication {
if (isOpen) {
content()
}
}
// TODO(demin) remove when we migrate from launchApplication to launchTestApplication (see TODO above)
fun exitApplication() {
isOpen = false
}
fun exitTestApplication() {
isOpen = false
}
suspend fun awaitIdle() {
if (useDelay) {
delay(500)
}
// TODO(demin): It seems this not-so-good synchronization
// doesn't cause flakiness in our window tests.
// But more robust solution will be to use something like
// TestCoroutineDispatcher/FlushCoroutineDispatcher (but we can't use it in a pure form,
// because there are Swing/system events that we don't control).
// Most of the work usually is done after the first yield(), almost all of the work -
// after fourth yield()
repeat(100) {
yield()
}
Snapshot.sendApplyNotifications()
for (recomposerInfo in Recomposer.runningRecomposers.value - initialRecomposers) {
recomposerInfo.state.takeWhile { it > Recomposer.State.Idle }.collect()
}
exceptionHandler.throwIfCaught()
}
}