Package com.opencqrs.framework.command

Class CommandHandlingTestFixture.Given<C extends Command>

java.lang.Object

com.opencqrs.framework.command.CommandHandlingTestFixture.Given<C>

Type Parameters:

C - the command type

Enclosing class:

CommandHandlingTestFixture<C extends Command>

public class CommandHandlingTestFixture.Given<C extends Command>
extends Object

Fluent API helper class encapsulating the current state stubbing prior to executing the CommandHandler under test.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CommandHandlingTestFixture.Given.GivenEvent	Fluent API helper class for fine granular specification of a single given event.

Method Summary

Modifier and Type	Method	Description
CommandHandlingTestFixture<C>.Given<C>	andGiven(Object... events)	Applies further events in order to the configured StateRebuildingHandlerDefinitions to update the instance state.
CommandHandlingTestFixture<C>.Given<C>	andGiven(Consumer<CommandHandlingTestFixture.Given.GivenEvent> event)	Applies a further event using the CommandHandlingTestFixture.Given.GivenEvent consumer for more fine-grained event specification of the event and its meta-data to update the instance state.
<AnotherCommand extends Command> CommandHandlingTestFixture<C>.Given<C>	andGivenCommand(CommandHandlingTestFixture<AnotherCommand> fixture, AnotherCommand command)	Uses any previously configured stubbings to execute the given Command without meta-data using the CommandHandlerDefinition encapsulated within the given fixture to capture any new events published, which in turn will be applied to this.
<AnotherCommand extends Command> CommandHandlingTestFixture<C>.Given<C>	andGivenCommand(CommandHandlingTestFixture<AnotherCommand> fixture, AnotherCommand command, Map<String,?> metaData)	Uses any previously configured stubbings to execute the given Command with meta-data using the CommandHandlerDefinition encapsulated within the given fixture to capture any new events published, which in turn will be applied to this.
CommandHandlingTestFixture<C>.Given<C>	andGivenTime(Instant time)	Configures a (new) time-stamp to be used, if further events shall be applied with that Event.time().
CommandHandlingTestFixture<C>.Given<C>	andGivenTimeDelta(Duration duration)	Shifts the previously configured time-stamp by given duration, if further events shall be applied with that Event.time().
CommandHandlingTestFixture<C>.Given<C>	usingCommandSubject()	Resets any previously specified event subject falling back to the Command.getSubject() or null.
CommandHandlingTestFixture<C>.Given<C>	usingSubject(String subject)	Specifies the Event.subject() to be used for subsequent calls to andGiven(Object...).
CommandHandlingTestFixture<C>.Expect	when(C command)	Executes the CommandHandlingTestFixture.Builder.using(Class, CommandHandler) configured} CommandHandler using the previously initialized instance state.
CommandHandlingTestFixture<C>.Expect	when(C command, Map<String,?> metaData)	Executes the CommandHandlingTestFixture.Builder.using(Class, CommandHandler) configured} CommandHandler using the previously initialized instance state.

Methods inherited from class java.lang.Object

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

Method Details

andGivenCommand

public <AnotherCommand extends Command>
CommandHandlingTestFixture<C>.Given<C> andGivenCommand(CommandHandlingTestFixture<AnotherCommand> fixture,
 AnotherCommand command)
                                                throws AssertionError

Uses any previously configured stubbings to execute the given Command without meta-data using the CommandHandlerDefinition encapsulated within the given fixture to capture any new events published, which in turn will be applied to this. This is mostly used for CommandHandlers publishing a lot or more complex events, in favor of stubbing the events directly.

Be aware that stubbed events can be specified more precisely than captured ones, since the encapsulated CommandHandler is responsible for event publication using the CommandEventPublisher. Hence, CommandHandlingTestFixture.Given.GivenEvent.time(Instant) and CommandHandlingTestFixture.Given.GivenEvent.id(String) cannot be specified using this approach.

Type Parameters:

AnotherCommand - generic command type to execute

Parameters:

fixture - the fixture holding the command to execute

command - the command to execute for event capturing

Returns:

a this for further fluent API calls

Throws:

AssertionError - in case the given command did not execute successfully

andGivenCommand

public <AnotherCommand extends Command>
CommandHandlingTestFixture<C>.Given<C> andGivenCommand(CommandHandlingTestFixture<AnotherCommand> fixture,
 AnotherCommand command,
 Map<String,?> metaData)
                                                throws AssertionError

Uses any previously configured stubbings to execute the given Command with meta-data using the CommandHandlerDefinition encapsulated within the given fixture to capture any new events published, which in turn will be applied to this. This is mostly used for CommandHandlers publishing a lot or more complex events, in favor of stubbing the events directly.

Be aware that stubbed events can be specified more precisely than captured ones, since the encapsulated CommandHandler is responsible for event publication using the CommandEventPublisher. Hence, CommandHandlingTestFixture.Given.GivenEvent.time(Instant) and CommandHandlingTestFixture.Given.GivenEvent.id(String) cannot be specified using this approach.

Type Parameters:

AnotherCommand - generic command type to execute

Parameters:

fixture - the fixture holding the command to execute

command - the command to execute for event capturing

metaData - the command meta-data

Returns:

a this for further fluent API calls

Throws:

AssertionError - in case the given command did not execute successfully

usingSubject

public CommandHandlingTestFixture<C>.Given<C> usingSubject(String subject)

Specifies the Event.subject() to be used for subsequent calls to andGiven(Object...).

This is a convenience method to be used in favor of specifying event subjects using CommandHandlingTestFixture.Given.GivenEvent.subject(String), which, if used, however, takes precedence over the subject defined using this method. Notice, that the event subject specified by this method does not affect calls to andGivenCommand(CommandHandlingTestFixture, Command).

Parameters:

subject - the event subject to be applied to any subsequent given events

Returns:

a this for further fluent API calls

See Also:

• usingCommandSubject()

usingCommandSubject

public CommandHandlingTestFixture<C>.Given<C> usingCommandSubject()

Resets any previously specified event subject falling back to the Command.getSubject() or null.

Returns:

a this for further fluent API calls

See Also:

• usingSubject(String)

andGivenTime

public CommandHandlingTestFixture<C>.Given<C> andGivenTime(Instant time)

Configures a (new) time-stamp to be used, if further events shall be applied with that Event.time().

Parameters:

time - the new time-stamp to be used

Returns:

a this for further fluent API calls

andGivenTimeDelta

public CommandHandlingTestFixture<C>.Given<C> andGivenTimeDelta(Duration duration)

Shifts the previously configured time-stamp by given duration, if further events shall be applied with that Event.time().

Parameters:

duration - the time-stamp delta to be applied

Returns:

a this for further fluent API calls

andGiven

public CommandHandlingTestFixture<C>.Given<C> andGiven(Object... events)

Applies further events in order to the configured StateRebuildingHandlerDefinitions to update the instance state.

Parameters:

events - the events to be applied

Returns:

a this for further fluent API calls

andGiven

public CommandHandlingTestFixture<C>.Given<C> andGiven(Consumer<CommandHandlingTestFixture.Given.GivenEvent> event)

Applies a further event using the CommandHandlingTestFixture.Given.GivenEvent consumer for more fine-grained event specification of the event and its meta-data to update the instance state.

Parameters:

event - event specification consumer, at least CommandHandlingTestFixture.Given.GivenEvent.payload(Object) must be called

Returns:

a this for further fluent API calls

when

public CommandHandlingTestFixture<C>.Expect when(C command)

Executes the CommandHandlingTestFixture.Builder.using(Class, CommandHandler) configured} CommandHandler using the previously initialized instance state. All events published as part of the execution as well as any exceptions thrown will be captured in-memory for further assertion.

Events will get applied to the current instance state using the configured StateRebuildingHandlerDefinitions, if and only if the CommandHandler terminates non exceptionally. This mimics the CommandRouter behaviour, as events will only be published to the event store for successful executions.Be aware, however, that instance mutability cannot be enforced. Hence, CommandHandlers publishing events, which result in mutated instance state, cannot be rolled back.

Parameters:

command - the Command to execute

Returns:

an CommandHandlingTestFixture<C extends Command>.Expect instance for further fluent API calls

when

public CommandHandlingTestFixture<C>.Expect when(C command,
 Map<String,?> metaData)

Executes the CommandHandlingTestFixture.Builder.using(Class, CommandHandler) configured} CommandHandler using the previously initialized instance state. All events published as part of the execution as well as any exceptions thrown will be captured in-memory for further assertion.

Events will get applied to the current instance state using the configured StateRebuildingHandlerDefinitions, if and only if the CommandHandler terminates non exceptionally. This mimics the CommandRouter behaviour, as events will only be published to the event store for successful executions.Be aware, however, that instance mutability cannot be enforced. Hence, CommandHandlers publishing events, which result in mutated instance state, cannot be rolled back.

Parameters:

command - the Command to execute

metaData - additional command meta-data supplied to the CommandHandler

Returns:

an CommandHandlingTestFixture<C extends Command>.Expect instance for further fluent API calls