Package org.springframework.modulith.test

Class Scenario.When<T>

java.lang.Object

org.springframework.modulith.test.Scenario.When<T>

Enclosing class:

Scenario

public class Scenario.When<T>
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	Scenario.When.EventResult<E>	The result of an expected event publication.
class	Scenario.When.StateChangeResult<S>	The result of an expected state change.

Constructor Summary

Constructors

Constructor	Description
When(BiFunction<TransactionOperations,ApplicationEventPublisher,T> stimulus, Consumer<T> cleanup, Function<org.awaitility.core.ConditionFactory,org.awaitility.core.ConditionFactory> customizer)

Method Summary

Modifier and Type	Method	Description
Scenario.When<T>	andCleanup(Runnable runnable)	Registers the given Runnable as cleanup callback to always run after completion of the Scenario, no matter the outcome of its execution (error or success).
Scenario.When<T>	andCleanup(Consumer<T> consumer)	Registers the given Consumer as cleanup callback to always run after completion of the Scenario, no matter the outcome of its execution (error or success).
Scenario.When<T>	andWaitAtMost(Duration duration)	Configures the Scenario to wait for at most the given duration for an event of the subsequent specification to arrive.
<E> Scenario.When<T>.EventResult<E>	andWaitForEventOfType(Class<E> type)	Expects an event of the given type to arrive.
<S> Scenario.When<T>.StateChangeResult<S>	andWaitForStateChange(Supplier<S> supplier)	Expects a particular state change on the module to produce a result.
<S> Scenario.When<T>.StateChangeResult<S>	andWaitForStateChange(Supplier<S> supplier, Predicate<? super S> acceptanceCriteria)	Expects a particular state change on the module to produce a result and uses the given Predicate to determine whether the value is conclusive.
Scenario.When<T>	customize(Function<org.awaitility.core.ConditionFactory,org.awaitility.core.ConditionFactory> customizer)	Customize the execution of the scenario.
<E> Scenario.When<T>.EventResult<E>	forEventOfType(Class<E> type)	Alternative to andWaitForEventOfType(Class) for better readability if execution customizations have been applied before.
<S> Scenario.When<T>.StateChangeResult<S>	forStateChange(Supplier<S> supplier)	Alternative to andWaitForStateChange(Supplier) for better readability if execution customizations have been applied before.
<S> Scenario.When<T>.StateChangeResult<S>	forStateChange(Supplier<S> supplier, Predicate<? super S> acceptanceCriteria)	Alternative to andWaitForStateChange(Supplier, Predicate) for better readability if execution customizations have been applied before.

Methods inherited from class java.lang.Object

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

Constructor Details

When

When(BiFunction<TransactionOperations,ApplicationEventPublisher,T> stimulus,
 Consumer<T> cleanup,
 Function<org.awaitility.core.ConditionFactory,org.awaitility.core.ConditionFactory> customizer)

Parameters:

stimulus - must not be null.

cleanup - must not be null.

customizer - must not be null.

Method Details

andCleanup

@CheckReturnValue
public Scenario.When<T> andCleanup(Runnable runnable)

Registers the given Runnable as cleanup callback to always run after completion of the Scenario, no matter the outcome of its execution (error or success).

Parameters:

runnable - must not be null.

Returns:

will never be null.

andCleanup

@CheckReturnValue
public Scenario.When<T> andCleanup(Consumer<T> consumer)

Registers the given Consumer as cleanup callback to always run after completion of the Scenario, no matter the outcome of its execution (error or success).

Parameters:

consumer - must not be null.

Returns:

will never be null.

andWaitAtMost

@CheckReturnValue
public Scenario.When<T> andWaitAtMost(Duration duration)

Configures the Scenario to wait for at most the given duration for an event of the subsequent specification to arrive.

Parameters:

duration - must not be null.

Returns:

will never be null.

customize

@CheckReturnValue
public Scenario.When<T> customize(Function<org.awaitility.core.ConditionFactory,org.awaitility.core.ConditionFactory> customizer)

Customize the execution of the scenario. The given customizer will be added to the default one registered via a ScenarioCustomizer. In other words, multiple invocations will replace registrations made in previous calls but always be chained after the default customizations registered.

Parameters:

customizer - must not be null.

Returns:

will never be null.

forEventOfType

@CheckReturnValue
public <E> Scenario.When<T>.EventResult<E> forEventOfType(Class<E> type)

Alternative to andWaitForEventOfType(Class) for better readability if execution customizations have been applied before.

Type Parameters:

E - the type of the event.

Parameters:

type - must not be null.

Returns:

will never be null.

See Also:

• andWaitForEventOfType(Class)

forStateChange

@CheckReturnValue
public <S> Scenario.When<T>.StateChangeResult<S> forStateChange(Supplier<S> supplier)

Alternative to andWaitForStateChange(Supplier) for better readability if execution customizations have been applied before.

Type Parameters:

S - the type of the state change result

Parameters:

supplier - must not be null.

Returns:

will never be null.

See Also:

• andWaitForStateChange(Supplier)

forStateChange

@CheckReturnValue
public <S> Scenario.When<T>.StateChangeResult<S> forStateChange(Supplier<S> supplier,
 Predicate<? super S> acceptanceCriteria)

Alternative to andWaitForStateChange(Supplier, Predicate) for better readability if execution customizations have been applied before.

Type Parameters:

S - the type of the state change result

Parameters:

supplier - must not be null.

acceptanceCriteria - must not be null.

Returns:

will never be null.

See Also:

• andWaitForStateChange(Supplier, Predicate)

andWaitForEventOfType

@CheckReturnValue
public <E> Scenario.When<T>.EventResult<E> andWaitForEventOfType(Class<E> type)

Expects an event of the given type to arrive. Use API on the returned Scenario.When.EventResult to specify more detailed expectations and conclude those with a call a flavor of Scenario.When.EventResult.toArrive().

Type Parameters:

E - the type of the event.

Parameters:

type - must not be null.

Returns:

will never be null.

See Also:

• forEventOfType(Class)

andWaitForStateChange

@CheckReturnValue
public <S> Scenario.When<T>.StateChangeResult<S> andWaitForStateChange(Supplier<S> supplier)

Expects a particular state change on the module to produce a result. By default, a non-null value would indicate success, except for Optionals, in which case we'd check for the presence of a value and booleans, for which we accept true as conclusive signal. For more control about the result matching, use andWaitForStateChange(Supplier, Predicate).

Type Parameters:

S - the type of the result.

Parameters:

supplier - must not be null.

Returns:

will never be null.

See Also:

• forStateChange(Supplier)

andWaitForStateChange

@CheckReturnValue
public <S> Scenario.When<T>.StateChangeResult<S> andWaitForStateChange(Supplier<S> supplier,
 Predicate<? super S> acceptanceCriteria)

Expects a particular state change on the module to produce a result and uses the given Predicate to determine whether the value is conclusive.

Type Parameters:

S - the type of the result for the state change

Parameters:

supplier - must not be null.

acceptanceCriteria - must not be null.

Returns:

will never be null.

See Also:

• andWaitForStateChange(Supplier, Predicate)