Package io.axoniq.framework.workflow.runtime.test.fixture

Class DefaultWorkflowTestDriver

java.lang.Object

io.axoniq.framework.workflow.runtime.test.fixture.DefaultWorkflowTestDriver

All Implemented Interfaces:

WorkflowTestDriver

@Internal
public class DefaultWorkflowTestDriver
extends Object
implements WorkflowTestDriver

Default implementation of WorkflowTestDriver.

Since:

5.4.0

Author:

Simon Zambrovski

Method Summary

Modifier and Type	Method	Description
AssertionFailureHandler	assertionFailureHandler()	Returns the assertion failure handler.
void	awaitEventually(String description, org.awaitility.core.ThrowingRunnable assertion)	Waits until the given condition is met, using the defined assertion failure handler.
void	executeStep(String stepName)	Waits until the given step is executed calling original action defined in the workflow definition.
void	executeStep(String stepName, PayloadProcessor payloadProcessor)	Waits until the given step is executed calling the given payload processor.
void	executeStepFailing(String stepName, StepFailedException exception)	Waits until the given step is executed throwing the given exception.
WorkflowExecution	executionExists()	Waits until an active workflow execution exists.
WorkflowExecution	executionMatches(Predicate<WorkflowExecution> predicate)	Waits until an active workflow execution matching the predicate exists.
void	executionSatisfies(Consumer<WorkflowExecution> executionConsumer)	Waits until an active workflow execution exists and applies the given consumer.
WorkflowHistory	historyExists()	Waits until a workflow history exists.
WorkflowHistory	historyMatches(Predicate<WorkflowHistory> predicate)	Waits until a workflow history matching the predicate exists.
void	historySatisfies(Consumer<WorkflowHistory> historyConsumer)	Waits until a workflow history exists and applies the given consumer.
void	noExecution()	Waits until no active workflow executions exist.
void	noHistory()	Asserts that no workflow histories exist.
void	publishEvent(Object event)	Publishes an event.
void	shutdown()	Shuts down the tester.
boolean	steppingMode()	Indicates whether this driver runs in stepping mode.
WorkflowEngineTestingState	testingState()	Returns the shared testing state.
void	timePasses(Duration duration)	Advances time by the given duration.
WorkflowTestServices	workflowTestServices()	Returns services for testing workflow runtime.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

workflowTestServices

public WorkflowTestServices workflowTestServices()

Description copied from interface: WorkflowTestDriver

Returns services for testing workflow runtime.

Specified by:

workflowTestServices in interface WorkflowTestDriver

Returns:

services for testing workflow runtime

testingState

public WorkflowEngineTestingState testingState()

Description copied from interface: WorkflowTestDriver

Returns the shared testing state.

Specified by:

testingState in interface WorkflowTestDriver

Returns:

shared testing state

assertionFailureHandler

public AssertionFailureHandler assertionFailureHandler()

Description copied from interface: WorkflowTestDriver

Returns the assertion failure handler.

Specified by:

assertionFailureHandler in interface WorkflowTestDriver

Returns:

assertion failure handler

steppingMode

public boolean steppingMode()

Description copied from interface: WorkflowTestDriver

Indicates whether this driver runs in stepping mode.

Specified by:

steppingMode in interface WorkflowTestDriver

Returns:

true if this driver runs in stepping mode, otherwise false

executionExists

public WorkflowExecution executionExists()

Description copied from interface: WorkflowTestDriver

Waits until an active workflow execution exists.

Specified by:

executionExists in interface WorkflowTestDriver

Returns:

the selected execution

executionMatches

public WorkflowExecution executionMatches(Predicate<WorkflowExecution> predicate)

Description copied from interface: WorkflowTestDriver

Waits until an active workflow execution matching the predicate exists.

Specified by:

executionMatches in interface WorkflowTestDriver

Parameters:

predicate - predicate used to select matching executions

Returns:

the selected execution

executionSatisfies

public void executionSatisfies(Consumer<WorkflowExecution> executionConsumer)

Description copied from interface: WorkflowTestDriver

Waits until an active workflow execution exists and applies the given consumer.

Specified by:

executionSatisfies in interface WorkflowTestDriver

Parameters:

executionConsumer - consumer applied to the selected execution

noExecution

public void noExecution()

Description copied from interface: WorkflowTestDriver

Waits until no active workflow executions exist.

Specified by:

noExecution in interface WorkflowTestDriver

historyMatches

public WorkflowHistory historyMatches(Predicate<WorkflowHistory> predicate)

Description copied from interface: WorkflowTestDriver

Waits until a workflow history matching the predicate exists.

Specified by:

historyMatches in interface WorkflowTestDriver

Parameters:

predicate - predicate used to select matching histories

Returns:

the selected history

historyExists

public WorkflowHistory historyExists()

Description copied from interface: WorkflowTestDriver

Waits until a workflow history exists.

Specified by:

historyExists in interface WorkflowTestDriver

Returns:

the selected history

historySatisfies

public void historySatisfies(Consumer<WorkflowHistory> historyConsumer)

Description copied from interface: WorkflowTestDriver

Waits until a workflow history exists and applies the given consumer.

Specified by:

historySatisfies in interface WorkflowTestDriver

Parameters:

historyConsumer - consumer applied to the selected history

noHistory

public void noHistory()

Description copied from interface: WorkflowTestDriver

Asserts that no workflow histories exist.

Specified by:

noHistory in interface WorkflowTestDriver

publishEvent

public void publishEvent(Object event)

Description copied from interface: WorkflowTestDriver

Publishes an event.

Specified by:

publishEvent in interface WorkflowTestDriver

Parameters:

event - event message or event payload

timePasses

public void timePasses(Duration duration)

Description copied from interface: WorkflowTestDriver

Advances time by the given duration.

Specified by:

timePasses in interface WorkflowTestDriver

Parameters:

duration - duration to advance time by

executeStep

public void executeStep(String stepName)

Description copied from interface: WorkflowTestDriver

Waits until the given step is executed calling original action defined in the workflow definition.

This works only in stepping mode.

Specified by:

executeStep in interface WorkflowTestDriver

Parameters:

stepName - step name

executeStep

public void executeStep(String stepName,
 PayloadProcessor payloadProcessor)

Description copied from interface: WorkflowTestDriver

Waits until the given step is executed calling the given payload processor.

This works only in stepping mode.

Specified by:

executeStep in interface WorkflowTestDriver

Parameters:

stepName - step name

payloadProcessor - payload processor to use instead of the workflow-defined action

executeStepFailing

public void executeStepFailing(String stepName,
 StepFailedException exception)

Description copied from interface: WorkflowTestDriver

Waits until the given step is executed throwing the given exception.

This works only in stepping mode.

Specified by:

executeStepFailing in interface WorkflowTestDriver

Parameters:

stepName - name of the step to execute

exception - exception to throw

shutdown

public void shutdown()

Description copied from interface: WorkflowTestDriver

Shuts down the tester.

Specified by:

shutdown in interface WorkflowTestDriver

awaitEventually

public void awaitEventually(String description,
 org.awaitility.core.ThrowingRunnable assertion)

Description copied from interface: WorkflowTestDriver

Waits until the given condition is met, using the defined assertion failure handler.

Specified by:

awaitEventually in interface WorkflowTestDriver

Parameters:

description - description of the assertion

assertion - assertion to execute