main.com.squareup.workflow1.testing.RenderTestResult.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of workflow-testing-jvm Show documentation
Workflow Testing
The newest version!
package com.squareup.workflow1.testing

import com.squareup.workflow1.StatefulWorkflow
import com.squareup.workflow1.WorkflowAction
import com.squareup.workflow1.WorkflowOutput

/**
 * Result of a [RenderTester.render] call that can be used to verify that a [WorkflowAction] was
 * processed and perform assertions on that action.
 *
 * @see verifyAction
 * @see verifyActionResult
 */
public interface RenderTestResult {

  /**
   * Asserts that the render pass handled either a workflow/worker output or a rendering event, and
   * passes the resulting [WorkflowAction] to [block] for asserting.
   *
   * If the workflow didn't process any actions, [block] will be passed [WorkflowAction.noAction].
   *
   * This is useful if your actions are a sealed class or enum. If you need to test an anonymous
   * action, use [verifyActionResult].
   */
  public fun verifyAction(
    block: (WorkflowAction) -> Unit
  ): RenderTestResult

  /**
   * Asserts that the render pass handled either a workflow/worker output or a rendering event,
   * "executes" the action with the state passed to [testRender], then invokes [block] with the
   * resulting state and output values.
   *
   * If the workflow didn't process any actions, `newState` will be the initial state and `output`
   * will be null.
   *
   * Note that by using this method, you're also testing the implementation of your action. This can
   * be useful if your actions are anonymous. If they are a sealed class or enum, use [verifyAction]
   * instead and write separate unit tests for your action implementations.
   */
  public fun verifyActionResult(
    block: (newState: StateT, appliedResult: WorkflowOutput?) -> Unit
  ): RenderTestResult

  /**
   * Starts a new [RenderTester] session using the same props as the previous session started by
   * [testRender] or [testNextRenderWithProps], and the state that is a result of the latest render
   * pass (the same one you could run assertions on in [verifyActionResult]).
   *
   * This method is useful for daisy-chaining of [RenderTester] sessions, when you want to assert
   * different state transitions without [WorkflowTestRuntime] overhead.
   */
  public fun testNextRender(): RenderTester

  /**
   * Starts a new [RenderTester] session using [newProps] props, and the state that is a result
   * of the latest render pass (the same one you could run assertions on in [verifyActionResult]).
   *
   * This method is useful for daisy-chaining of [RenderTester] sessions, when you want to assert
   * different state transitions without [WorkflowTestRuntime] overhead.
   *
   * Note that if you're overriding [StatefulWorkflow.onPropsChanged] method, it'll be ran before
   * the next [RenderTester.render] pass, and [RenderTester] returned by this method will use
   * the updated `state` value.
   */
  public fun testNextRenderWithProps(
    newProps: PropsT
  ): RenderTester
}