Continuum.Test (continuum v0.5.0)

Public helpers for testing Continuum workflows.

The helpers in this module are deliberately small and stable. They cover the v0.1 testing loop:

run workflows against the in-memory journal
load or persist event histories
replay a committed golden history
inject signals and timers in deterministic tests
check out an Ecto SQL Sandbox connection for Postgres-backed tests

The in-memory journal is process-local and not durable. Use unique run IDs or call reset_in_memory!/0 between tests that need a clean journal.

Summary

Types

replay_result()

Functions

assert_replays(workflow_module, input, history)

Assert that a workflow replays from history without drift.

assert_replays(workflow_module, input, history, expected)

Assert that a workflow replays from history to expected.

checkout_sandbox(repo \\ Application.get_env(:continuum, :repo), opts \\ [])

Check out an Ecto SQL Sandbox connection.

dump_history!(run_id, path, opts \\ [])

Persist a run history to path as an Erlang external term.

fire_timer(run_id, opts \\ [])

Inject a fired timer event for the latest pending timer in a run's history.

history(run_id, opts \\ [])

Load a run's event history from a journal.

inject_signal(run_id, name, payload, opts \\ [])

Inject a signal into a run and wake its local engine when one exists.

load_history!(path)

Load a history previously written by dump_history!/3.

replay(workflow_module, input, history, opts \\ [])

Replay a workflow from an existing history.

reset_in_memory!()

Reset the in-memory journal.

start_postgres(workflow_module, input, opts \\ [])

Start a workflow run against the Postgres journal.

start_synchronous(workflow_module, input, opts \\ [])

Start a workflow run synchronously against the in-memory journal.

Types

replay_result()

@type replay_result() ::
  {:ok, term()}
  | {:suspended, term()}
  | {:continued, binary()}
  | {:error, term()}

Functions

assert_replays(workflow_module, input, history)

@spec assert_replays(module(), term(), [map()]) :: term()

Assert that a workflow replays from history without drift.

Returns the replayed result.

assert_replays(workflow_module, input, history, expected)

@spec assert_replays(module(), term(), [map()], term()) :: term()

Assert that a workflow replays from history to expected.

checkout_sandbox(repo \\ Application.get_env(:continuum, :repo), opts \\ [])

@spec checkout_sandbox(
  module() | nil,
  keyword()
) :: :ok

Check out an Ecto SQL Sandbox connection.

Pass shared: true when workflow engines or workers need to use the test process' checked-out connection.

dump_history!(run_id, path, opts \\ [])

@spec dump_history!(binary(), Path.t(), keyword()) :: :ok

Persist a run history to path as an Erlang external term.

The resulting file is intended for golden-history tests committed to the repository.

fire_timer(run_id, opts \\ [])

@spec fire_timer(
  binary(),
  keyword()
) :: :ok | {:error, term()}

Inject a fired timer event for the latest pending timer in a run's history.

history(run_id, opts \\ [])

@spec history(
  binary(),
  keyword()
) :: [map()]

Load a run's event history from a journal.

inject_signal(run_id, name, payload, opts \\ [])

@spec inject_signal(binary(), atom(), term(), keyword()) :: :ok | {:error, term()}

Inject a signal into a run and wake its local engine when one exists.

load_history!(path)

@spec load_history!(Path.t()) :: [map()]

Load a history previously written by dump_history!/3.

replay(workflow_module, input, history, opts \\ [])

@spec replay(module(), term(), [map()], keyword()) :: replay_result()

Replay a workflow from an existing history.

Returns {:ok, result} when the workflow completes from history, or {:suspended, reason} if the history ends at a pending effect.

reset_in_memory!()

@spec reset_in_memory!() :: :ok

Reset the in-memory journal.

start_postgres(workflow_module, input, opts \\ [])

@spec start_postgres(module(), term(), keyword()) ::
  {:ok, binary()} | {:error, term()}

Start a workflow run against the Postgres journal.

start_synchronous(workflow_module, input, opts \\ [])

@spec start_synchronous(module(), term(), keyword()) ::
  {:ok, binary()} | {:error, term()}

Start a workflow run synchronously against the in-memory journal.