org.axonframework.test.aggregate

Interface TestExecutor<T>

Type Parameters:

T - The type of Aggregate under test

All Known Implementing Classes:

AggregateTestFixture

public interface TestExecutor<T>

Interface describing the operations available on a test fixture in the execution stage. In this stage, there is only on operation: when(Object), which dispatches a command on this fixture's Command Bus.

Since:

0.6

Author:

Allard Buijze

Method Summary

Modifier and Type	Method and Description
TestExecutor<T>	andGiven(List<?> domainEvents) Configures the given domainEvents as the "given" events.
TestExecutor<T>	andGiven(Object... domainEvents) Configures the given domainEvents as the "given" events.
TestExecutor<T>	andGivenCommands(List<?> commands) Configures the given commands as the command that will provide the "given" events.
TestExecutor<T>	andGivenCommands(Object... commands) Configures the given commands as the command that will provide the "given" events.
TestExecutor<T>	andGivenCurrentTime(Instant currentTime) Use this method to indicate a specific moment as the initial current time "known" by the fixture at the start of the given state.
ResultValidator	andThenTimeAdvancesTo(Instant newDateTime) Simulates time shifts in the current given state.
ResultValidator	andThenTimeElapses(Duration elapsedTime) Simulates time shifts in the current given state.
Instant	currentTime() Returns the time as "known" by the fixture.
ResultValidator<T>	when(Object command) Dispatches the given command to the appropriate command handler and records all activity in the fixture for result validation.
ResultValidator<T>	when(Object command, Map<String,?> metaData) Dispatches the given command and meta data to the appropriate command handler and records all activity in the fixture for result validation.

Method Detail

when

ResultValidator<T> when(Object command)

Dispatches the given command to the appropriate command handler and records all activity in the fixture for result validation. If the given command is a CommandMessage instance, it will be dispatched as-is. Any other object will cause the given command to be wrapped in a CommandMessage as its payload.

Parameters:

command - The command to execute

Returns:

a ResultValidator that can be used to validate the resulting actions of the command execution

when

ResultValidator<T> when(Object command,
                        Map<String,?> metaData)

Dispatches the given command and meta data to the appropriate command handler and records all activity in the fixture for result validation. If the given command is a CommandMessage instance, it will be dispatched as-is, with given additional metaData. Any other object will cause the given command to be wrapped in a CommandMessage as its payload.

Parameters:

command - The command to execute

metaData - The meta data to attach to the

Returns:

a ResultValidator that can be used to validate the resulting actions of the command execution

andGiven

TestExecutor<T> andGiven(Object... domainEvents)

Configures the given domainEvents as the "given" events. These are the events returned by the event store when an aggregate is loaded.

If an item in the given domainEvents implements Message, the payload and meta data from that message are copied into a newly created Domain Event Message. Otherwise, a Domain Event Message with the item as payload and empty meta data is created.

Parameters:

domainEvents - the domain events the event store should return

Returns:

a TestExecutor instance that can execute the test with this configuration

andGiven

TestExecutor<T> andGiven(List<?> domainEvents)

Configures the given domainEvents as the "given" events. These are the events returned by the event store when an aggregate is loaded.

If an item in the list implements Message, the payload and meta data from that message are copied into a newly created Domain Event Message. Otherwise, a Domain Event Message with the item as payload and empty meta data is created.

Parameters:

domainEvents - the domain events the event store should return

Returns:

a TestExecutor instance that can execute the test with this configuration

andGivenCommands

TestExecutor<T> andGivenCommands(Object... commands)

Configures the given commands as the command that will provide the "given" events. The commands are executed, and the resulting stored events are captured.

Parameters:

commands - the domain events the event store should return

Returns:

a TestExecutor instance that can execute the test with this configuration

andGivenCommands

TestExecutor<T> andGivenCommands(List<?> commands)

Configures the given commands as the command that will provide the "given" events. The commands are executed, and the resulting stored events are captured.

Parameters:

commands - the domain events the event store should return

Returns:

a TestExecutor instance that can execute the test with this configuration

andGivenCurrentTime

TestExecutor<T> andGivenCurrentTime(Instant currentTime)

Use this method to indicate a specific moment as the initial current time "known" by the fixture at the start of the given state.

Parameters:

currentTime - The simulated "current time" at which the given state is initialized

Returns:

a TestExecutor instance that can execute the test with this configuration

currentTime

Instant currentTime()

Returns the time as "known" by the fixture. This is the time at which the fixture was created, plus the amount of time the fixture was told to simulate a "wait".

Returns:

the simulated "current time" of the fixture.

andThenTimeElapses

ResultValidator andThenTimeElapses(Duration elapsedTime)

Simulates time shifts in the current given state. This can be useful when the time between given events is of importance.

Parameters:

elapsedTime - The amount of time that will elapse

Returns:

a ResultValidator that can be used to validate the resulting actions of the command execution

andThenTimeAdvancesTo

ResultValidator andThenTimeAdvancesTo(Instant newDateTime)

Simulates time shifts in the current given state. This can be useful when the time between given events is of importance.

Parameters:

newDateTime - The time to advance the clock to

Returns:

a ResultValidator that can be used to validate the resulting actions of the command execution