org.axonframework.test.saga

Class FixtureExecutionResultImpl<T>

java.lang.Object

org.axonframework.test.saga.FixtureExecutionResultImpl<T>

All Implemented Interfaces:

FixtureExecutionResult

public class FixtureExecutionResultImpl<T>
extends Object
implements FixtureExecutionResult

Default implementation of FixtureExecutionResult.

Since:

1.1

Author:

Allard Buijze

Method Summary

Modifier and Type	Method and Description
FixtureExecutionResult	expectActiveSagas(int expected) Expect the given number of Sagas to be active (i.e.
FixtureExecutionResult	expectAssociationWith(String associationKey, Object associationValue) Asserts that at least one of the active sagas is associated with the given associationKey and associationValue.
FixtureExecutionResult	expectDeadlinesMet(Object... expected) Asserts that given expected deadlines have been met (which have passed in time).
FixtureExecutionResult	expectDeadlinesMetMatching(org.hamcrest.Matcher<? extends List<? super DeadlineMessage<?>>> matcher) Asserts that deadlines match given matcher have been met (which have passed in time) on this saga.
FixtureExecutionResult	expectDispatchedCommands(Object... expected) Asserts that the given commands have been dispatched in exactly the order given.
FixtureExecutionResult	expectDispatchedCommandsMatching(org.hamcrest.Matcher<? extends List<? super CommandMessage<?>>> matcher) Asserts that the sagas dispatched commands as defined by the given matcher.
FixtureExecutionResult	expectNoAssociationWith(String associationKey, Object associationValue) Asserts that at none of the active sagas is associated with the given associationKey and associationValue.
FixtureExecutionResult	expectNoDispatchedCommands() Asserts that the sagas did not dispatch any commands.
FixtureExecutionResult	expectNoScheduledDeadlines() Asserts that no deadlines are scheduled.
FixtureExecutionResult	expectNoScheduledEvents() Assert that no events are scheduled for publication.
FixtureExecutionResult	expectPublishedEvents(Object... expected) Assert that the saga published events on the EventBus in the exact sequence of the given expected events.
FixtureExecutionResult	expectPublishedEventsMatching(org.hamcrest.Matcher<? extends List<? super EventMessage<?>>> matcher) Assert that the saga published events on the EventBus as defined by the given matcher.
FixtureExecutionResult	expectScheduledDeadline(Duration duration, Object deadline) Asserts that a deadline equal to the given deadline has been scheduled after the given duration.
FixtureExecutionResult	expectScheduledDeadline(Instant scheduledTime, Object deadline) Asserts that a deadline equal to the given deadline has been scheduled at the given scheduledTime.
FixtureExecutionResult	expectScheduledDeadlineMatching(Duration duration, org.hamcrest.Matcher<? super DeadlineMessage<?>> matcher) Asserts that a deadline scheduled after given duration matches the given matcher.
FixtureExecutionResult	expectScheduledDeadlineMatching(Instant scheduledTime, org.hamcrest.Matcher<? super DeadlineMessage<?>> matcher) Asserts that a deadline matching the given matcher has been scheduled at the given scheduledTime.
FixtureExecutionResult	expectScheduledDeadlineOfType(Duration duration, Class<?> deadlineType) Asserts that a deadline of the given deadlineType has been scheduled after the given duration.
FixtureExecutionResult	expectScheduledDeadlineOfType(Instant scheduledTime, Class<?> deadlineType) Asserts that a deadline of the given deadlineType has been scheduled at the given scheduledTime.
FixtureExecutionResult	expectScheduledEvent(Duration duration, Object applicationEvent) Asserts that an event equal to the given ApplicationEvent has been scheduled for publication after the given duration.
FixtureExecutionResult	expectScheduledEvent(Instant scheduledTime, Object applicationEvent) Asserts that an event equal to the given ApplicationEvent has been scheduled for publication at the given scheduledTime.
FixtureExecutionResult	expectScheduledEventMatching(Duration duration, org.hamcrest.Matcher<? super EventMessage<?>> matcher) Asserts that an event matching the given matcher has been scheduled to be published after the given duration.
FixtureExecutionResult	expectScheduledEventMatching(Instant scheduledTime, org.hamcrest.Matcher<? super EventMessage<?>> matcher) Asserts that an event matching the given matcher has been scheduled to be published at the given scheduledTime.
FixtureExecutionResult	expectScheduledEventOfType(Duration duration, Class<?> eventType) Asserts that an event of the given eventType has been scheduled for publication after the given duration.
FixtureExecutionResult	expectScheduledEventOfType(Instant scheduledTime, Class<?> eventType) Asserts that an event of the given eventType has been scheduled for publication at the given scheduledTime.
void	registerStartRecordingCallback(Runnable onStartRecordingCallback) Registers a callback to be invoked when the fixture execution starts recording.
void	startRecording() Tells this class to start monitoring activity in infrastructure classes.

Methods inherited from class java.lang.Object

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

Method Detail

registerStartRecordingCallback

public void registerStartRecordingCallback(Runnable onStartRecordingCallback)

Registers a callback to be invoked when the fixture execution starts recording. This happens right before invocation of the 'when' step (stimulus) of the fixture.

Use this to manage Saga dependencies which are not an Axon first class citizen, but do require monitoring of their interactions. For example, register the callback to set a mock in recording mode.

Parameters:

onStartRecordingCallback - callback to invoke

startRecording

public void startRecording()

Tells this class to start monitoring activity in infrastructure classes.

expectActiveSagas

public FixtureExecutionResult expectActiveSagas(int expected)

Description copied from interface: FixtureExecutionResult

Expect the given number of Sagas to be active (i.e. ready to respond to incoming events.

Specified by:

expectActiveSagas in interface FixtureExecutionResult

Parameters:

expected - the expected number of active events in the repository

Returns:

the FixtureExecutionResult for method chaining

expectAssociationWith

public FixtureExecutionResult expectAssociationWith(String associationKey,
                                                    Object associationValue)

Description copied from interface: FixtureExecutionResult

Asserts that at least one of the active sagas is associated with the given associationKey and associationValue.

Specified by:

expectAssociationWith in interface FixtureExecutionResult

Parameters:

associationKey - The key of the association to verify

associationValue - The value of the association to verify

Returns:

the FixtureExecutionResult for method chaining

expectNoAssociationWith

public FixtureExecutionResult expectNoAssociationWith(String associationKey,
                                                      Object associationValue)

Description copied from interface: FixtureExecutionResult

Asserts that at none of the active sagas is associated with the given associationKey and associationValue.

Specified by:

expectNoAssociationWith in interface FixtureExecutionResult

Parameters:

associationKey - The key of the association to verify

associationValue - The value of the association to verify

Returns:

the FixtureExecutionResult for method chaining

expectScheduledEventMatching

public FixtureExecutionResult expectScheduledEventMatching(Duration duration,
                                                           org.hamcrest.Matcher<? super EventMessage<?>> matcher)

Description copied from interface: FixtureExecutionResult

Asserts that an event matching the given matcher has been scheduled to be published after the given duration.

Specified by:

expectScheduledEventMatching in interface FixtureExecutionResult

Parameters:

duration - The time to wait before the event should be published

matcher - A matcher defining the event expected to be published

Returns:

the FixtureExecutionResult for method chaining

expectScheduledDeadlineMatching

public FixtureExecutionResult expectScheduledDeadlineMatching(Duration duration,
                                                              org.hamcrest.Matcher<? super DeadlineMessage<?>> matcher)

Description copied from interface: FixtureExecutionResult

Asserts that a deadline scheduled after given duration matches the given matcher.

Specified by:

expectScheduledDeadlineMatching in interface FixtureExecutionResult

Parameters:

duration - The delay expected before the deadline is met

matcher - The matcher that must match with the deadline scheduled at the given time

Returns:

the FixtureExecutionResult for method chaining

expectScheduledEvent

public FixtureExecutionResult expectScheduledEvent(Duration duration,
                                                   Object applicationEvent)

Description copied from interface: FixtureExecutionResult

Asserts that an event equal to the given ApplicationEvent has been scheduled for publication after the given duration.

Note that the source attribute of the application event is ignored when comparing events. Events are compared using an "equals" check on all fields in the events.

Specified by:

expectScheduledEvent in interface FixtureExecutionResult

Parameters:

duration - The time to wait before the event should be published

applicationEvent - The expected event

Returns:

the FixtureExecutionResult for method chaining

expectScheduledDeadline

public FixtureExecutionResult expectScheduledDeadline(Duration duration,
                                                      Object deadline)

Description copied from interface: FixtureExecutionResult

Asserts that a deadline equal to the given deadline has been scheduled after the given duration.

Note that the source attribute of the deadline is ignored when comparing deadlines. Deadlines are compared using an "equals" check on all fields in the deadlines.

Specified by:

expectScheduledDeadline in interface FixtureExecutionResult

Parameters:

duration - The time to wait before the deadline should be met

deadline - The expected deadline

Returns:

the FixtureExecutionResult for method chaining

expectScheduledEventOfType

public FixtureExecutionResult expectScheduledEventOfType(Duration duration,
                                                         Class<?> eventType)

Description copied from interface: FixtureExecutionResult

Asserts that an event of the given eventType has been scheduled for publication after the given duration.

Specified by:

expectScheduledEventOfType in interface FixtureExecutionResult

Parameters:

duration - The time to wait before the event should be published

eventType - The type of the expected event

Returns:

the FixtureExecutionResult for method chaining

expectScheduledDeadlineOfType

public FixtureExecutionResult expectScheduledDeadlineOfType(Duration duration,
                                                            Class<?> deadlineType)

Description copied from interface: FixtureExecutionResult

Asserts that a deadline of the given deadlineType has been scheduled after the given duration.

Specified by:

expectScheduledDeadlineOfType in interface FixtureExecutionResult

Parameters:

duration - The time to wait before the deadline is met

deadlineType - The type of the expected deadline

Returns:

the FixtureExecutionResult for method chaining

expectScheduledEventMatching

public FixtureExecutionResult expectScheduledEventMatching(Instant scheduledTime,
                                                           org.hamcrest.Matcher<? super EventMessage<?>> matcher)

Description copied from interface: FixtureExecutionResult

Asserts that an event matching the given matcher has been scheduled to be published at the given scheduledTime.

If the scheduledTime is calculated based on the "current time", use the FixtureConfiguration.currentTime() to get the time to use as "current time".

Specified by:

expectScheduledEventMatching in interface FixtureExecutionResult

Parameters:

scheduledTime - The time at which the event should be published

matcher - A matcher defining the event expected to be published

Returns:

the FixtureExecutionResult for method chaining

expectScheduledDeadlineMatching

public FixtureExecutionResult expectScheduledDeadlineMatching(Instant scheduledTime,
                                                              org.hamcrest.Matcher<? super DeadlineMessage<?>> matcher)

Description copied from interface: FixtureExecutionResult

Asserts that a deadline matching the given matcher has been scheduled at the given scheduledTime.

If the scheduledTime is calculated based on the "current time", use the FixtureConfiguration.currentTime() to get the time to use as "current time".

Specified by:

expectScheduledDeadlineMatching in interface FixtureExecutionResult

Parameters:

scheduledTime - The time at which the deadline should be met

matcher - The matcher defining the deadline expected

Returns:

the FixtureExecutionResult for method chaining

expectScheduledEvent

public FixtureExecutionResult expectScheduledEvent(Instant scheduledTime,
                                                   Object applicationEvent)

Description copied from interface: FixtureExecutionResult

Asserts that an event equal to the given ApplicationEvent has been scheduled for publication at the given scheduledTime.

If the scheduledTime is calculated based on the "current time", use the FixtureConfiguration.currentTime() to get the time to use as "current time".

Note that the source attribute of the application event is ignored when comparing events. Events are compared using an "equals" check on all fields in the events.

Specified by:

expectScheduledEvent in interface FixtureExecutionResult

Parameters:

scheduledTime - The time at which the event should be published

applicationEvent - The expected event

Returns:

the FixtureExecutionResult for method chaining

expectScheduledDeadline

public FixtureExecutionResult expectScheduledDeadline(Instant scheduledTime,
                                                      Object deadline)

Description copied from interface: FixtureExecutionResult

Asserts that a deadline equal to the given deadline has been scheduled at the given scheduledTime.

If the scheduledTime is calculated based on the "current time", use the FixtureConfiguration.currentTime() to get the time to use as "current time".

Note that the source attribute of the deadline is ignored when comparing deadlines. Deadlines are compared using an "equals" check on all fields in the deadlines.

Specified by:

expectScheduledDeadline in interface FixtureExecutionResult

Parameters:

scheduledTime - The time at which the deadline is scheduled

deadline - The expected deadline

Returns:

the FixtureExecutionResult for method chaining

expectScheduledEventOfType

public FixtureExecutionResult expectScheduledEventOfType(Instant scheduledTime,
                                                         Class<?> eventType)

Description copied from interface: FixtureExecutionResult

Asserts that an event of the given eventType has been scheduled for publication at the given scheduledTime.

If the scheduledTime is calculated based on the "current time", use the FixtureConfiguration.currentTime() to get the time to use as "current time".

Specified by:

expectScheduledEventOfType in interface FixtureExecutionResult

Parameters:

scheduledTime - The time at which the event should be published

eventType - The type of the expected event

Returns:

the FixtureExecutionResult for method chaining

expectScheduledDeadlineOfType

public FixtureExecutionResult expectScheduledDeadlineOfType(Instant scheduledTime,
                                                            Class<?> deadlineType)

Description copied from interface: FixtureExecutionResult

Asserts that a deadline of the given deadlineType has been scheduled at the given scheduledTime.

Specified by:

expectScheduledDeadlineOfType in interface FixtureExecutionResult

Parameters:

scheduledTime - The time at which the deadline is scheduled

deadlineType - The type of the expected deadline

Returns:

the FixtureExecutionResult for method chaining

expectDispatchedCommands

public FixtureExecutionResult expectDispatchedCommands(Object... expected)

Description copied from interface: FixtureExecutionResult

Asserts that the given commands have been dispatched in exactly the order given. The command objects are compared using the equals method. Only commands as a result of the event in the "when" stage of the fixture are compared. If exact order doesn't matter, or the validation needs be done in another way than "equal payload", consider using FixtureExecutionResult.expectDispatchedCommandsMatching(Matcher) instead.

Specified by:

expectDispatchedCommands in interface FixtureExecutionResult

Parameters:

expected - The expected commands

Returns:

the FixtureExecutionResult for method chaining

expectDispatchedCommandsMatching

public FixtureExecutionResult expectDispatchedCommandsMatching(org.hamcrest.Matcher<? extends List<? super CommandMessage<?>>> matcher)

Description copied from interface: FixtureExecutionResult

Asserts that the sagas dispatched commands as defined by the given matcher. Only commands as a result of the event in the "when" stage of the fixture are matched.

Specified by:

expectDispatchedCommandsMatching in interface FixtureExecutionResult

Parameters:

matcher - The matcher that describes the expected list of commands

Returns:

the FixtureExecutionResult for method chaining

expectNoDispatchedCommands

public FixtureExecutionResult expectNoDispatchedCommands()

Description copied from interface: FixtureExecutionResult

Asserts that the sagas did not dispatch any commands. Only commands as a result of the event in the "when" stage of ths fixture are recorded.

Specified by:

expectNoDispatchedCommands in interface FixtureExecutionResult

Returns:

the FixtureExecutionResult for method chaining

expectNoScheduledEvents

public FixtureExecutionResult expectNoScheduledEvents()

Description copied from interface: FixtureExecutionResult

Assert that no events are scheduled for publication. This means that either no events were scheduled at all, all schedules have been cancelled or all scheduled events have been published already.

Specified by:

expectNoScheduledEvents in interface FixtureExecutionResult

Returns:

the FixtureExecutionResult for method chaining

expectNoScheduledDeadlines

public FixtureExecutionResult expectNoScheduledDeadlines()

Description copied from interface: FixtureExecutionResult

Asserts that no deadlines are scheduled. This means that either no deadlines were scheduled at all, all schedules have been cancelled or all scheduled deadlines have been met already.

Specified by:

expectNoScheduledDeadlines in interface FixtureExecutionResult

Returns:

the FixtureExecutionResult for method chaining

expectPublishedEventsMatching

public FixtureExecutionResult expectPublishedEventsMatching(org.hamcrest.Matcher<? extends List<? super EventMessage<?>>> matcher)

Description copied from interface: FixtureExecutionResult

Assert that the saga published events on the EventBus as defined by the given matcher. Only events published in the "when" stage of the tests are matched.

Specified by:

expectPublishedEventsMatching in interface FixtureExecutionResult

Parameters:

matcher - The matcher that defines the expected list of published events.

Returns:

the FixtureExecutionResult for method chaining

expectDeadlinesMetMatching

public FixtureExecutionResult expectDeadlinesMetMatching(org.hamcrest.Matcher<? extends List<? super DeadlineMessage<?>>> matcher)

Description copied from interface: FixtureExecutionResult

Asserts that deadlines match given matcher have been met (which have passed in time) on this saga.

Specified by:

expectDeadlinesMetMatching in interface FixtureExecutionResult

Parameters:

matcher - The matcher that defines the expected list of deadlines

Returns:

the FixtureExecutionResult for method chaining

expectPublishedEvents

public FixtureExecutionResult expectPublishedEvents(Object... expected)

Description copied from interface: FixtureExecutionResult

Assert that the saga published events on the EventBus in the exact sequence of the given expected events. Events are compared comparing their type and fields using equals. Sequence number, aggregate identifier (for domain events) and source (for application events) are ignored in the comparison.

Specified by:

expectPublishedEvents in interface FixtureExecutionResult

Parameters:

expected - The sequence of events expected to be published by the Saga

Returns:

the FixtureExecutionResult for method chaining

expectDeadlinesMet

public FixtureExecutionResult expectDeadlinesMet(Object... expected)

Description copied from interface: FixtureExecutionResult

Asserts that given expected deadlines have been met (which have passed in time). Deadlines are compared comparing their type and fields using "equals".

Specified by:

expectDeadlinesMet in interface FixtureExecutionResult

Parameters:

expected - The sequence of deadlines expected to be met

Returns:

the FixtureExecutionResult for method chaining