org.axonframework.test.aggregate

Class ResultValidatorImpl<T>

java.lang.Object

org.axonframework.test.aggregate.ResultValidatorImpl<T>

All Implemented Interfaces:

CommandCallback<Object,Object>, ResultValidator<T>

public class ResultValidatorImpl<T>
extends Object
implements ResultValidator<T>, CommandCallback<Object,Object>

Implementation of the ResultValidator. It also acts as a CommandCallback, and registers the actual result.

Since:

0.7

Author:

Allard Buijze

Constructor Summary

Constructors

Constructor and Description
ResultValidatorImpl(List<EventMessage<?>> publishedEvents, FieldFilter fieldFilter, Supplier<Aggregate<T>> aggregateState, StubDeadlineManager stubDeadlineManager) Initialize the ResultValidatorImpl with the given storedEvents and publishedEvents.

Method Summary

Modifier and Type	Method and Description
void	assertValidRecording() Makes sure the execution phase has finishes without any Errors ir FixtureExecutionExceptions.
ResultValidator<T>	expectDeadlinesMet(Object... expected) Asserts that given expected deadlines have been met (which have passed in time).
ResultValidator<T>	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 aggregate.
ResultValidator<T>	expectEvents(EventMessage... expectedEvents) Expect the given set of events to have been published.
ResultValidator<T>	expectEvents(Object... expectedEvents) Expect the given set of events to have been published.
ResultValidator<T>	expectEventsMatching(org.hamcrest.Matcher<? extends List<? super EventMessage<?>>> matcher) Expect the published events to match the given matcher.
ResultValidator<T>	expectException(Class<? extends Throwable> expectedException) Expect the given expectedException to occur during command handler execution.
ResultValidator<T>	expectException(org.hamcrest.Matcher<?> matcher) Expect an exception to occur during command handler execution that matches with the given matcher.
ResultValidator<T>	expectExceptionMessage(org.hamcrest.Matcher<?> exceptionMessageMatcher) Expect an exception message to occur during command handler execution that matches with the given matcher.
ResultValidator<T>	expectExceptionMessage(String exceptionMessage) Expect the given exceptionMessage to occur during command handler execution.
ResultValidator<T>	expectNoScheduledDeadlines() Asserts that no deadlines are scheduled.
ResultValidator<T>	expectReturnValue(Object expectedReturnValue) Expect the command handler to return the given expectedReturnValue after execution.
ResultValidator<T>	expectReturnValueMatching(org.hamcrest.Matcher<?> matcher) Expect the command handler to return a value that matches the given matcher after execution.
ResultValidator<T>	expectScheduledDeadline(Duration duration, Object deadline) Asserts that a deadline equal to the given deadline has been scheduled after the given duration.
ResultValidator<T>	expectScheduledDeadline(Instant scheduledTime, Object deadline) Asserts that a deadline equal to the given deadline has been scheduled at the given scheduledTime.
ResultValidator<T>	expectScheduledDeadlineMatching(Duration duration, org.hamcrest.Matcher<? super DeadlineMessage<?>> matcher) Asserts that a deadline scheduled after given duration matches the given matcher.
ResultValidator<T>	expectScheduledDeadlineMatching(Instant scheduledTime, org.hamcrest.Matcher<? super DeadlineMessage<?>> matcher) Asserts that a deadline matching the given matcher has been scheduled at the given scheduledTime.
ResultValidator<T>	expectScheduledDeadlineOfType(Duration duration, Class<?> deadlineType) Asserts that a deadline of the given deadlineType has been scheduled after the given duration.
ResultValidator<T>	expectScheduledDeadlineOfType(Instant scheduledTime, Class<?> deadlineType) Asserts that a deadline of the given deadlineType has been scheduled at the given scheduledTime.
ResultValidator<T>	expectState(Consumer<T> aggregateStateValidator) Provides access the the state of the Aggregate as it was stored in the repository, allowing for validation of the state of the aggregate, as it was left in the repository.
ResultValidator<T>	expectSuccessfulHandlerExecution() Expect a successful execution of the given command handler, regardless of the actual return value.
void	onFailure(CommandMessage<?> commandMessage, Throwable cause) Invoked when command handling execution resulted in an error.
void	onSuccess(CommandMessage<?> commandMessage, Object result) Invoked when command handling execution was successful.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.test.aggregate.ResultValidator

expectNoEvents

Constructor Detail

ResultValidatorImpl

public ResultValidatorImpl(List<EventMessage<?>> publishedEvents,
                           FieldFilter fieldFilter,
                           Supplier<Aggregate<T>> aggregateState,
                           StubDeadlineManager stubDeadlineManager)

Initialize the ResultValidatorImpl with the given storedEvents and publishedEvents.

Parameters:

publishedEvents - The events that were published during command execution

fieldFilter - The filter describing which fields to include in the comparison

Method Detail

expectEvents

public ResultValidator<T> expectEvents(Object... expectedEvents)

Description copied from interface: ResultValidator

Expect the given set of events to have been published.

All events are compared for equality using a shallow equals comparison on all the fields of the events. This means that all assigned values on the events' fields should have a proper equals implementation.

Note that the event identifier is ignored in the comparison.

Specified by:

expectEvents in interface ResultValidator<T>

Parameters:

expectedEvents - The expected events, in the exact order they are expected to be dispatched and stored.

Returns:

the current ResultValidator, for fluent interfacing

expectEvents

public ResultValidator<T> expectEvents(EventMessage... expectedEvents)

Description copied from interface: ResultValidator

Expect the given set of events to have been published.

All events are compared for equality using a shallow equals comparison on all the fields of the events. This means that all assigned values on the events' fields should have a proper equals implementation.
Additionally the metadata will be compared too.

Note that the event identifier is ignored in the comparison.

Specified by:

expectEvents in interface ResultValidator<T>

Parameters:

expectedEvents - The expected events, in the exact order they are expected to be dispatched and stored.

Returns:

the current ResultValidator, for fluent interfacing

expectEventsMatching

public ResultValidator<T> expectEventsMatching(org.hamcrest.Matcher<? extends List<? super EventMessage<?>>> matcher)

Description copied from interface: ResultValidator

Expect the published events to match the given matcher.

Note: if no events were published, the matcher receives an empty List.

Specified by:

expectEventsMatching in interface ResultValidator<T>

Parameters:

matcher - The matcher to match with the actually published events

Returns:

the current ResultValidator, for fluent interfacing

expectSuccessfulHandlerExecution

public ResultValidator<T> expectSuccessfulHandlerExecution()

Description copied from interface: ResultValidator

Expect a successful execution of the given command handler, regardless of the actual return value.

Specified by:

expectSuccessfulHandlerExecution in interface ResultValidator<T>

Returns:

the current ResultValidator, for fluent interfacing

expectState

public ResultValidator<T> expectState(Consumer<T> aggregateStateValidator)

Description copied from interface: ResultValidator

Provides access the the state of the Aggregate as it was stored in the repository, allowing for validation of the state of the aggregate, as it was left in the repository.

Note that validating state on Event Sourced Aggregate is highly discouraged. Event Sourced aggregates should measure behavior exclusively by measuring emitted events.

Specified by:

expectState in interface ResultValidator<T>

Parameters:

aggregateStateValidator - a consumer that is provided with the aggregate instance, allowing it to make assertions based on the aggregate's state.

Returns:

the current ResultValidator, for fluent interfacing

expectScheduledDeadlineMatching

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

Description copied from interface: ResultValidator

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

Specified by:

expectScheduledDeadlineMatching in interface ResultValidator<T>

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 current ResultValidator, for fluent interfacing

expectScheduledDeadline

public ResultValidator<T> expectScheduledDeadline(Duration duration,
                                                  Object deadline)

Description copied from interface: ResultValidator

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 ResultValidator<T>

Parameters:

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

deadline - The expected deadline

Returns:

the current ResultValidator, for fluent interfacing

expectScheduledDeadlineOfType

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

Description copied from interface: ResultValidator

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

Specified by:

expectScheduledDeadlineOfType in interface ResultValidator<T>

Parameters:

duration - The time to wait before the deadline is met

deadlineType - The type of the expected deadline

Returns:

the current ResultValidator, for fluent interfacing

expectScheduledDeadlineMatching

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

Description copied from interface: ResultValidator

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 TestExecutor.currentTime() to get the time to use as "current time".

Specified by:

expectScheduledDeadlineMatching in interface ResultValidator<T>

Parameters:

scheduledTime - The time at which the deadline should be met

matcher - The matcher defining the deadline expected

Returns:

the current ResultValidator, for fluent interfacing

expectScheduledDeadline

public ResultValidator<T> expectScheduledDeadline(Instant scheduledTime,
                                                  Object deadline)

Description copied from interface: ResultValidator

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 TestExecutor.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 ResultValidator<T>

Parameters:

scheduledTime - The time at which the deadline is scheduled

deadline - The expected deadline

Returns:

the current ResultValidator, for fluent interfacing

expectScheduledDeadlineOfType

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

Description copied from interface: ResultValidator

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

Specified by:

expectScheduledDeadlineOfType in interface ResultValidator<T>

Parameters:

scheduledTime - The time at which the deadline is scheduled

deadlineType - The type of the expected deadline

Returns:

the current ResultValidator, for fluent interfacing

expectNoScheduledDeadlines

public ResultValidator<T> expectNoScheduledDeadlines()

Description copied from interface: ResultValidator

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 ResultValidator<T>

Returns:

the current ResultValidator, for fluent interfacing

expectDeadlinesMetMatching

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

Description copied from interface: ResultValidator

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

Specified by:

expectDeadlinesMetMatching in interface ResultValidator<T>

Parameters:

matcher - The matcher that defines the expected list of deadlines

Returns:

the current ResultValidator, for fluent interfacing

expectDeadlinesMet

public ResultValidator<T> expectDeadlinesMet(Object... expected)

Description copied from interface: ResultValidator

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 ResultValidator<T>

Parameters:

expected - The sequence of deadlines expected to be met

Returns:

the current ResultValidator, for fluent interfacing

expectReturnValue

public ResultValidator<T> expectReturnValue(Object expectedReturnValue)

Description copied from interface: ResultValidator

Expect the command handler to return the given expectedReturnValue after execution. The actual and expected values are compared using their equals methods.

Specified by:

expectReturnValue in interface ResultValidator<T>

Parameters:

expectedReturnValue - The expected return value of the command execution

Returns:

the current ResultValidator, for fluent interfacing

expectReturnValueMatching

public ResultValidator<T> expectReturnValueMatching(org.hamcrest.Matcher<?> matcher)

Description copied from interface: ResultValidator

Expect the command handler to return a value that matches the given matcher after execution.

Specified by:

expectReturnValueMatching in interface ResultValidator<T>

Parameters:

matcher - The matcher to verify the actual return value against

Returns:

the current ResultValidator, for fluent interfacing

expectExceptionMessage

public ResultValidator<T> expectExceptionMessage(org.hamcrest.Matcher<?> exceptionMessageMatcher)

Description copied from interface: ResultValidator

Expect an exception message to occur during command handler execution that matches with the given matcher.

Specified by:

expectExceptionMessage in interface ResultValidator<T>

Parameters:

exceptionMessageMatcher - The matcher to validate the actual exception message

Returns:

the current ResultValidator, for fluent interfacing

expectExceptionMessage

public ResultValidator<T> expectExceptionMessage(String exceptionMessage)

Description copied from interface: ResultValidator

Expect the given exceptionMessage to occur during command handler execution. The actual exception message should be exactly the same as exceptionMessage.

Specified by:

expectExceptionMessage in interface ResultValidator<T>

Parameters:

exceptionMessage - The exception message expected from the command handler execution

Returns:

the current ResultValidator, for fluent interfacing

expectException

public ResultValidator<T> expectException(Class<? extends Throwable> expectedException)

Description copied from interface: ResultValidator

Expect the given expectedException to occur during command handler execution. The actual exception should be exactly of that type, subclasses are not accepted.

Specified by:

expectException in interface ResultValidator<T>

Parameters:

expectedException - The type of exception expected from the command handler execution

Returns:

the current ResultValidator, for fluent interfacing

expectException

public ResultValidator<T> expectException(org.hamcrest.Matcher<?> matcher)

Description copied from interface: ResultValidator

Expect an exception to occur during command handler execution that matches with the given matcher.

Specified by:

expectException in interface ResultValidator<T>

Parameters:

matcher - The matcher to validate the actual exception

Returns:

the current ResultValidator, for fluent interfacing

onSuccess

public void onSuccess(CommandMessage<?> commandMessage,
                      Object result)

Description copied from interface: CommandCallback

Invoked when command handling execution was successful.

Specified by:

onSuccess in interface CommandCallback<Object,Object>

Parameters:

commandMessage - The message that was dispatched

result - The result of the command handling execution, if any.

onFailure

public void onFailure(CommandMessage<?> commandMessage,
                      Throwable cause)

Description copied from interface: CommandCallback

Invoked when command handling execution resulted in an error.

Specified by:

onFailure in interface CommandCallback<Object,Object>

Parameters:

commandMessage - The message that was dispatched

cause - The exception raised during command handling

assertValidRecording

public void assertValidRecording()

Makes sure the execution phase has finishes without any Errors ir FixtureExecutionExceptions. If an error was recorded, it will be thrown immediately. This allow one to distinguish between failed tests, and tests in error.