zio-temporal-testkit
API
Generated with
zio-temporal-testkit/zio.temporal.testkit/ZWorkflowReplayer

ZWorkflowReplayer

zio.temporal.testkit.ZWorkflowReplayer$
object ZWorkflowReplayer

Replays a workflow given its history. Useful for backwards compatibility testing.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Value members

Concrete methods

def replayWorkflowExecution(historyFile: Path, workflowClass: ZWorkflowImplementationClass[_], moreClasses: ZWorkflowImplementationClass[_]*): RIO[ZTestWorkflowEnvironment[Any], Unit]

Replays workflow from a file

Replays workflow from a file

Value parameters

historyFile

file that contains a json serialized history.

moreClasses

optional additional workflow implementation classes

workflowClass

s workflow implementation class to replay

Attributes

Throws
Exception

if replay failed for any reason.

def replayWorkflowExecution(jsonSerializedHistory: String, workflowClass: ZWorkflowImplementationClass[_], moreClasses: ZWorkflowImplementationClass[_]*): RIO[ZTestWorkflowEnvironment[Any], Unit]

Replays workflow from a json serialized history. The json should be in the format:

Replays workflow from a json serialized history. The json should be in the format:

 { "workflowId": "...", "runId": "...", "events": [ ... ] }

RunId must match the one used to generate the serialized history.

Value parameters

jsonSerializedHistory

string that contains the json serialized history.

moreClasses

optional additional workflow implementation classes

workflowClass

s workflow implementation class to replay

Attributes

Throws
Exception

if replay failed for any reason.

def replayWorkflowExecution(history: ZWorkflowExecutionHistory, workflowClass: ZWorkflowImplementationClass[_], moreClasses: ZWorkflowImplementationClass[_]*): RIO[ZTestWorkflowEnvironment[Any], Unit]

Replays workflow from a ZWorkflowExecutionHistory.

Replays workflow from a ZWorkflowExecutionHistory.

Value parameters

history

object that contains the workflow ids and the events.

moreClasses

optional additional workflow implementation classes (like child or external workflows)

workflowClass

s workflow implementation class to replay

Attributes

Throws
Exception

if replay failed for any reason.

def replayWorkflowExecution(history: ZWorkflowExecutionHistory, worker: ZWorker): Task[Unit]

Replays workflow from a ZWorkflowExecutionHistory.

Replays workflow from a ZWorkflowExecutionHistory.

Value parameters

history

object that contains the workflow ids and the events.

worker

existing worker with registered workflow implementations.

Attributes

Throws
Exception

if replay failed for any reason.

def replayWorkflowExecutionFromResource(resourceName: String, workflowClass: ZWorkflowImplementationClass[_], moreClasses: ZWorkflowImplementationClass[_]*): RIO[ZTestWorkflowEnvironment[Any], Unit]

Replays workflow from a resource that contains a json serialized history.

Replays workflow from a resource that contains a json serialized history.

Value parameters

moreClasses

optional additional workflow implementation classes

resourceName

name of the resource.

workflowClass

s workflow implementation class to replay

Attributes

Throws
Exception

if replay failed for any reason.

def replayWorkflowExecutionFromResource(resourceName: String, worker: ZWorker): RIO[ZTestWorkflowEnvironment[Any], Unit]

Replays workflow from a resource that contains a json serialized history.

Replays workflow from a resource that contains a json serialized history.

Value parameters

resourceName

name of the resource.

worker

worker existing worker with the correct task queue and registered implementations.

Attributes

Throws
Exception

if replay failed for any reason.

def replayWorkflowExecutions(histories: List[ZWorkflowExecutionHistory], failFast: Boolean, workflowClass: ZWorkflowImplementationClass[_], moreClasses: ZWorkflowImplementationClass[_]*): RIO[ZTestWorkflowEnvironment[Any], ZReplayResults]

Replays workflows provided by an iterable.

Replays workflows provided by an iterable.

Value parameters

failFast

If true, throws upon the first error encountered (if any) during replay. If false, all histories will be replayed and the returned object contains information about any failures.

histories

The histories to be replayed

Attributes

Returns

If failFast is false, contains any replay failures encountered.

Throws
Exception

If replay failed and failFast is true.

def replayWorkflowExecutions(histories: List[ZWorkflowExecutionHistory], failFast: Boolean, worker: ZWorker): Task[ZReplayResults]

Replays workflows provided by an iterable using an already-initialized worker.

Replays workflows provided by an iterable using an already-initialized worker.

Value parameters

failFast

If true, throws upon the first error encountered (if any) during replay. If false, all histories will be replayed and the returned object contains information about any failures.

histories

The histories to be replayed

worker

A worker which should have registered all the workflow implementations which were used to produce (or are expected to be compatible with) the provided histories.

Attributes

Returns

If failFast is false, contains any replay failures encountered.

Throws
Exception

If replay failed and failFast is true.

Generated with