Introduce TestScope.test(RibCoroutineWorker) test helper utility.
#620
Conversation
psteiger
force-pushed
the
testrbw
branch
6 times, most recently
from
6b7511f
to
82c1f2b
Compare
| * or completed, otherwise, the aforementioned time advancing API must be used. | ||
| */ | ||
| @OptIn(ExperimentalCoroutinesApi::class) | ||
| public inline fun <T : RibCoroutineWorker> TestScope.test( |
There was a problem hiding this comment.
Curious, why not place this function somewhere in rib-coroutines-test instead of here?
There was a problem hiding this comment.
Also, this file has the same name as the private class TestRibCoroutineWorker in RibCouroutineWorkerTest.kt (no immediate suggestion, just saying that I had to do a double-take.)
There was a problem hiding this comment.
Curious, why not place this function somewhere in
rib-coroutines-testinstead of here?
Because RibCoroutineWorker is in rib-base, not rib-coroutines.
Also, this file has the same name as the private class TestRibCoroutineWorker in RibCouroutineWorkerTest.kt (no immediate suggestion, just saying that I had to do a double-take.)
Hm. Maybe it's reasonable to rename the private class to something like TestWorker
This helper utility is meant to be used in tests inside `runTest { }` blocks
and should facilitate `RibCoroutineWorker` testing by automatically binding
and unbinding the worker in the scope of the lambda.
```
@test fun test() = runTest {
test(worker) {
// Worker is bound. Make assertions
}
// Worker is unbound.
}
```
This helper utility is meant to be used in tests inside
runTest { }blocks and should facilitateRibCoroutineWorkertesting by automatically binding and unbinding the worker.StandardTestDispatcher), so the test shall work even whenRibCoroutinesRuleis not used to override theRibDispatchers.Defaultdispatcher with a test dispatcher.test(RibCoroutineWorker), hence tests never timeout with uncompleted coroutines because of a bound worker.