Package org.springframework.modulith.test

Class Scenario

java.lang.Object

org.springframework.modulith.test.Scenario

@API(status=EXPERIMENTAL)
public class Scenario
extends Object

A DSL to define integration testing scenarios for application modules. A Scenario starts with a stimulus on the system, usually a component invocation (see stimulate(Function) or event publication (see publish(Object...)) and a definition of the expected outcome. That can be a state change observed by invoking application module components (see Scenario.When.andWaitForStateChange(Supplier)) or another event being published (see Scenario.When.andWaitForEventOfType(Class)), concluded by additional verifications.

Scenario can be used as JUnit test method parameter in ApplicationModuleTests.

Author:

Oliver Drotbohm

See Also:

• ApplicationModuleTest

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	Scenario.When<T>

Constructor Summary

Constructors

Constructor	Description
Scenario(TransactionTemplate transactionTemplate, ApplicationEventPublisher publisher, AssertablePublishedEvents events)	Creates a new Scenario for the given TransactionTemplate, ApplicationEventPublisher and AssertablePublishedEvents.

Method Summary

Modifier and Type	Method	Description
Scenario.When<Void>	publish(Object event)	Publishes the given event.
Scenario.When<Void>	publish(Supplier<Object> event)	Publishes the event provided by the given Supplier.
(package private) Scenario	setDefaultCustomizer(Function<org.awaitility.core.ConditionFactory,org.awaitility.core.ConditionFactory> customizer)	Extension hook to allow registration of a global customizer.
Scenario.When<Void>	stimulate(Runnable runnable)	Stimulates the system by executing the given Runnable.
Scenario.When<Void>	stimulate(BiConsumer<TransactionOperations,ApplicationEventPublisher> stimulus)	Stimulate the system using the given TransactionOperations and ApplicationEventPublisher.
<S> Scenario.When<S>	stimulate(BiFunction<TransactionOperations,ApplicationEventPublisher,S> stimulus)	Stimulate the system using the given TransactionOperations and ApplicationEventPublisher and produce a result.
<S> Scenario.When<S>	stimulate(Function<TransactionOperations,S> function)	Stimulates the system using the given function providing access to the TransactionOperations and keeping the supplied value around for later verification.
<S> Scenario.When<S>	stimulate(Supplier<S> supplier)	Stimulates the system using the given Supplier and keeping the supplied value around for later verification.

Methods inherited from class java.lang.Object

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

Constructor Details

Scenario

Scenario(TransactionTemplate transactionTemplate,
 ApplicationEventPublisher publisher,
 AssertablePublishedEvents events)

Creates a new Scenario for the given TransactionTemplate, ApplicationEventPublisher and AssertablePublishedEvents.

Parameters:

transactionTemplate - must not be null.

publisher - must not be null.

events - must not be null.

Method Details

publish

public Scenario.When<Void> publish(Object event)

Publishes the given event. The event will be published in a transaction to make sure that transactional event listeners are invoked as well.

Parameters:

event - must not be null.

Returns:

will never be null.

publish

public Scenario.When<Void> publish(Supplier<Object> event)

Publishes the event provided by the given Supplier. The event will be published in a transaction to make sure that transactional event listeners are invoked as well.

Parameters:

event - must not be null.

Returns:

will never be null.

stimulate

public Scenario.When<Void> stimulate(Runnable runnable)

Stimulates the system by executing the given Runnable.

Parameters:

runnable - must not be null.

Returns:

will never be null.

stimulate

public <S> Scenario.When<S> stimulate(Supplier<S> supplier)

Stimulates the system using the given Supplier and keeping the supplied value around for later verification.

Type Parameters:

S - the type of the value returned by the stimulus.

Parameters:

supplier - must not be null.

Returns:

will never be null.

See Also:

• Scenario.When.StateChangeResult.andVerify(Consumer)
• Scenario.When.EventResult.toArriveAndVerify(Consumer)

stimulate

public <S> Scenario.When<S> stimulate(Function<TransactionOperations,S> function)

Stimulates the system using the given function providing access to the TransactionOperations and keeping the supplied value around for later verification.

Type Parameters:

S - the type of the value returned by the stimulus.

Parameters:

function - must not be null.

Returns:

will never be null.

stimulate

public Scenario.When<Void> stimulate(BiConsumer<TransactionOperations,ApplicationEventPublisher> stimulus)

Stimulate the system using the given TransactionOperations and ApplicationEventPublisher. Usually a method on some application service or event publication is triggered.

Parameters:

stimulus - must not be null.

Returns:

will never be null.

stimulate

public <S> Scenario.When<S> stimulate(BiFunction<TransactionOperations,ApplicationEventPublisher,S> stimulus)

Stimulate the system using the given TransactionOperations and ApplicationEventPublisher and produce a result. Usually a method on some application service or event publication is triggered.

Type Parameters:

S - the type of the result.

Parameters:

stimulus - must not be null.

Returns:

will never be null.

setDefaultCustomizer

Scenario setDefaultCustomizer(Function<org.awaitility.core.ConditionFactory,org.awaitility.core.ConditionFactory> customizer)

Extension hook to allow registration of a global customizer. If none configured we will fall back to Function.identity().

Parameters:

customizer - must not be null.

See Also:

• ScenarioCustomizer