Introduce alternative testing infrastructure to test single render passes more directly. #349

zach-klippenstein · 2019-05-16T16:45:31Z

Given a StatefulWorkflow or StatelessWorkflow, call .testRender() on it.
Pass the InputT, and for StatefulWorkflows also pass the StateT.
This returns a TestRenderResult which provides access to the actual rendering
as well as methods to assert that children or workers were rendered and invoke
their output handlers.

zach-klippenstein · 2019-05-16T20:08:10Z

kotlin/workflow-runtime/src/main/java/com/squareup/workflow/internal/Behavior.kt

@@ -28,7 +28,7 @@ import kotlinx.coroutines.Deferred
 *
 * @see RealRenderContext
 */
-internal data class Behavior<StateT, out OutputT : Any>(
+data class Behavior<StateT, out OutputT : Any> internal constructor(


Sad to make this public, but don't want to duplicate the code in the test module.

zach-klippenstein · 2019-05-16T20:08:26Z

kotlin/workflow-runtime/src/main/java/com/squareup/workflow/internal/RealRenderContext.kt

 */
-internal class RealRenderContext<StateT, OutputT : Any>(
+class RealRenderContext<StateT, OutputT : Any>(


Very sad to make this public. See above comment.

I brought this up in the Kotlin Slack. I should file a ticket: https://kotlinlang.slack.com/archives/C0B8PUJGZ/p1555962527006200

When you do, lemme know I will vote.

zach-klippenstein · 2019-05-16T20:08:36Z

kotlin/workflow-runtime/src/main/java/com/squareup/workflow/internal/WorkflowId.kt

@@ -30,17 +30,21 @@ internal typealias AnyId = WorkflowId<*, *, *>
 * Value type that can be used to distinguish between different workflows of different types or
 * the same type (in that case using a [name]).
 */
-internal data class WorkflowId<in InputT, out OutputT : Any, out RenderingT>
+data class WorkflowId<in InputT, out OutputT : Any, out RenderingT>


rjrjr · 2019-05-16T23:25:05Z

kotlin/workflow-testing/src/main/java/com/squareup/workflow/testing/MockWorker.kt

@@ -0,0 +1,20 @@
+package com.squareup.workflow.testing


rjrjr · 2019-05-16T23:30:33Z

kotlin/workflow-testing/src/test/java/com/squareup/workflow/testing/RenderTesterTest.kt

+    val result = workflow.testRender()
+
+    result.assertNoWorkflowsRendered()
+    result.assertNoWorkersRendered()


Nit: do we really render a worker? Don't we run them?

Spent a whole 5 minutes googling the correct tenses of "to run", I think I got it right now.

rjrjr · 2019-05-16T23:33:30Z

kotlin/workflow-testing/src/test/java/com/squareup/workflow/testing/RenderTesterTest.kt

@@ -0,0 +1,144 @@
+package com.squareup.workflow.testing


vRallev · 2019-05-17T00:45:39Z

kotlin/workflow-runtime/src/main/java/com/squareup/workflow/internal/RealRenderContext.kt

 */
-internal class RealRenderContext<StateT, OutputT : Any>(
+class RealRenderContext<StateT, OutputT : Any>(


I brought this up in the Kotlin Slack. I should file a ticket: https://kotlinlang.slack.com/archives/C0B8PUJGZ/p1555962527006200

vRallev · 2019-05-17T00:46:07Z

kotlin/workflow-testing/src/main/java/com/squareup/workflow/testing/MockChildWorkflow.kt

+ * @see StatefulWorkflow.testRender
+ * @see com.squareup.workflow.StatelessWorkflow.testRender
+ */
+class MockChildWorkflow<I, R>(private val renderer: (I) -> R) : Workflow<I, Nothing, R> {


FakeChildWorkflow?

It actually records the input though so you can check it later, doesn't that make it technically a "mock"?

Yeah, Zach's right. Changed my vote.

https://blog.pragmatists.com/test-doubles-fakes-mocks-and-stubs-1a7491dfa3da

Oh, yes. This blog is handy 👍

Although we lose symmetry with the worker then, which actually is a fake…

I want to add more instrumentation on them anyway, so they'll both be mocks.

@vRallev @rjrjr I just pushed another commit that changes the API a little. Now you call assert* and execute*Output* directly on the workers/workflows themselves, from within a block. Please take another look. If people like it i'll squash before merging.

vRallev · 2019-05-17T00:46:36Z

kotlin/workflow-testing/src/main/java/com/squareup/workflow/testing/MockWorker.kt

+ * @see com.squareup.workflow.StatefulWorkflow.testRender
+ * @see com.squareup.workflow.StatelessWorkflow.testRender
+ */
+class MockWorker<T>(val name: String) : Worker<T> {


FakeWorker?

davidapgar · 2019-05-17T16:31:21Z

kotlin/workflow-testing/src/main/java/com/squareup/workflow/testing/MockWorker.kt

+/**
+ * A mock implementation of [Worker] for use in tests with `testRender` and [TestRenderResult].
+ *
+ * Not this [Worker] can not actually emit any output itself. Use


Typo on Not -> Note (I believe this should read "Note this [Worker] can not actually emit any output...")

vRallev · 2019-05-17T17:15:04Z

kotlin/workflow-testing/src/main/java/com/squareup/workflow/testing/MockChildWorkflow.kt

+ * @see StatefulWorkflow.testRender
+ * @see com.squareup.workflow.StatelessWorkflow.testRender
+ */
+class MockChildWorkflow<I, R>(private val renderer: (I) -> R) : Workflow<I, Nothing, R> {


Oh, yes. This blog is handy 👍

…sses more directly. Given a `StatefulWorkflow` or `StatelessWorkflow`, call `.testRender()` on it. Pass the `InputT`, and for `StatefulWorkflow`s also pass the `StateT`. This returns a `TestRenderResult` which provides access to the actual rendering as well as methods to assert that children or workers were rendered and invoke their output handlers.

rjrjr · 2019-05-17T19:21:52Z

Still LG with the tidier syntax (extension on the fakes).

zach-klippenstein added this to In progress in Workflow (Kotlin) via automation May 16, 2019

zach-klippenstein changed the title ~~WIP: RenderTester~~ Introduce alternative testing infrastructure to test single render passes more directly. May 16, 2019

zach-klippenstein changed the base branch from master to zachklipp/fix-bounds May 16, 2019 20:07

zach-klippenstein force-pushed the zachklipp/rendertester branch 2 times, most recently from ac47ed4 to 92584ef Compare May 16, 2019 20:26

zach-klippenstein requested a review from vRallev May 16, 2019 20:26

zach-klippenstein marked this pull request as ready for review May 16, 2019 20:26

zach-klippenstein requested review from rjrjr and davidapgar May 16, 2019 20:26

zach-klippenstein commented May 16, 2019

View reviewed changes

zach-klippenstein added this to the v0.16.0 milestone May 16, 2019

zach-klippenstein changed the base branch from zachklipp/fix-bounds to master May 16, 2019 21:41

rjrjr approved these changes May 16, 2019

View reviewed changes

zach-klippenstein force-pushed the zachklipp/rendertester branch from 92584ef to b29baf0 Compare May 17, 2019 00:00

vRallev approved these changes May 17, 2019

View reviewed changes

davidapgar reviewed May 17, 2019

View reviewed changes

vRallev approved these changes May 17, 2019

View reviewed changes

zach-klippenstein added 2 commits May 17, 2019 11:08

Move WorkflowTesterTest into testing package.

8489be8

zach-klippenstein force-pushed the zachklipp/rendertester branch from dc91197 to ac5692d Compare May 17, 2019 18:09

Change render testing API to be more discoverable.

0014ffb

zach-klippenstein force-pushed the zachklipp/rendertester branch from ac5692d to 0014ffb Compare May 17, 2019 18:30

zach-klippenstein requested a review from vRallev May 17, 2019 19:23

zach-klippenstein merged commit 459a31d into master May 17, 2019

Workflow (Kotlin) automation moved this from In progress to Done May 17, 2019

zach-klippenstein deleted the zachklipp/rendertester branch May 17, 2019 19:23

zach-klippenstein added the kotlin Affects the Kotlin library. label Mar 3, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce alternative testing infrastructure to test single render passes more directly. #349

Introduce alternative testing infrastructure to test single render passes more directly. #349

zach-klippenstein commented May 16, 2019 •

edited

zach-klippenstein May 16, 2019

zach-klippenstein May 16, 2019

vRallev May 17, 2019

zach-klippenstein May 17, 2019

zach-klippenstein May 16, 2019

rjrjr May 16, 2019

rjrjr May 16, 2019

zach-klippenstein May 17, 2019

rjrjr May 16, 2019

vRallev May 17, 2019

vRallev May 17, 2019

zach-klippenstein May 17, 2019

rjrjr May 17, 2019

vRallev May 17, 2019

zach-klippenstein May 17, 2019

zach-klippenstein May 17, 2019 •

edited

vRallev May 17, 2019

davidapgar May 17, 2019

zach-klippenstein May 17, 2019

vRallev May 17, 2019

rjrjr commented May 17, 2019 •

edited

Introduce alternative testing infrastructure to test single render passes more directly. #349

Introduce alternative testing infrastructure to test single render passes more directly. #349

Conversation

zach-klippenstein commented May 16, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zach-klippenstein May 17, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rjrjr commented May 17, 2019 • edited

zach-klippenstein commented May 16, 2019 •

edited

zach-klippenstein May 17, 2019 •

edited

rjrjr commented May 17, 2019 •

edited