910: Integrate WorkerTester with TestScope #918
Conversation
steve-the-edwards
force-pushed
the
sedwards/910-tester-refactor
branch
from
f927ad7 to
d1c2fac
Compare
| * This can be used to advance virtual time for the [CoroutineDispatcher] that the the Worker's | ||
| * flow is flowing on. | ||
| */ | ||
| public val testCoroutineScheduler: TestCoroutineScheduler |
There was a problem hiding this comment.
This is added to control virtual time on the scope in which the Turbine is launched and thus where the Worker's upstream flow is producing values.
| @@ -31,7 +39,7 @@ public interface WorkerTester<T> { | |||
| /** | |||
| * Suspends until the worker emits an output or finishes. | |||
| * | |||
| * Throws an [AssertionError] if an output was emitted. | |||
| * Throws an [AssertionError] if an output was emitted or the Worker has an error. | |||
There was a problem hiding this comment.
| if (!channel.isEmpty && !channel.isClosedForReceive) { | ||
| try { | ||
| expectNoEvents() | ||
| } catch (e: AssertionError) { | ||
| throw AssertionError("Expected no output to have been emitted.") | ||
| } | ||
| } | ||
|
|
||
| override suspend fun assertFinished() { |
There was a problem hiding this comment.
This mapping is the most complicated in order to get the same error messages in the AssertionError as before.
There was a problem hiding this comment.
Seems worth saying so in a comment, e.g. "Complicated because these messages predate our Turbine integration and we wanted to keep them stable."
steve-the-edwards
requested review from
a team and
zach-klippenstein
as code owners
| if (!channel.isEmpty && !channel.isClosedForReceive) { | ||
| try { | ||
| expectNoEvents() | ||
| } catch (e: AssertionError) { | ||
| throw AssertionError("Expected no output to have been emitted.") | ||
| } | ||
| } | ||
|
|
||
| override suspend fun assertFinished() { |
There was a problem hiding this comment.
Seems worth saying so in a comment, e.g. "Complicated because these messages predate our Turbine integration and we wanted to keep them stable."
|
|
||
| worker.test { | ||
| assertNoOutput() | ||
| assertNotFinished() | ||
|
|
||
| testDispatcher.scheduler.advanceTimeBy(999) | ||
| testDispatcher.scheduler.runCurrent() | ||
| testCoroutineScheduler.advanceTimeBy(999) |
There was a problem hiding this comment.
Nice. Great argument in favor of the API change.
**Note this contains minor BREAKING changes to the WorkerTester API** Closes #910
steve-the-edwards
force-pushed
the
sedwards/910-tester-refactor
branch
from
d1c2fac to
00b3789
Compare
Closes #910. We do not allow a
CoroutineContext/CoroutineDispatcherto be passed in, instead favouring keeping the API forWorkerTester.testself contained. Within the test though you can now access theTestCoroutineSchedulerto control virtual time.We drive the flow backing the Worker with a Turbine rather than our own handle around a channel.