Package org.apache.pekko.persistence.testkit.javadsl

Class EventSourcedBehaviorTestKit<Command,Event,State>

java.lang.Object

org.apache.pekko.persistence.testkit.javadsl.EventSourcedBehaviorTestKit<Command,Event,State>

public final class EventSourcedBehaviorTestKit<Command,Event,State>
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EventSourcedBehaviorTestKit.CommandResult<Command,Event,State>	The result of running a command.
static final class	EventSourcedBehaviorTestKit.CommandResultWithReply<Command,Event,State,Reply>	The result of running a command with a ActorRef replyTo, i.e.
static final class	EventSourcedBehaviorTestKit.RestartResult<State>	The result of restarting the behavior.
static final class	EventSourcedBehaviorTestKit.SerializationSettings	Customization of which serialization checks that are performed.

Constructor Summary

Constructors

Constructor	Description
EventSourcedBehaviorTestKit(EventSourcedBehaviorTestKit<Command,Event,State> delegate)

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears the in-memory journal and snapshot storage and restarts the behavior.
static com.typesafe.config.Config	config()	The configuration to be included in the configuration of the ActorSystem.
static <Command, Event, State> EventSourcedBehaviorTestKit<Command,Event,State>	create(ActorSystem<?> system, Behavior<Command> behavior)	Factory method to create a new EventSourcedBehaviorTestKit.
static <Command, Event, State> EventSourcedBehaviorTestKit<Command,Event,State>	create(ActorSystem<?> system, Behavior<Command> behavior, EventSourcedBehaviorTestKit.SerializationSettings serializationSettings)	Factory method to create a new EventSourcedBehaviorTestKit with custom EventSourcedBehaviorTestKit.SerializationSettings.
static EventSourcedBehaviorTestKit.SerializationSettings	disabledSerializationSettings()
static EventSourcedBehaviorTestKit.SerializationSettings	enabledSerializationSettings()
State	getState()	Retrieve the current state of the Behavior.
void	initialize(Object... events)
void	initialize(scala.collection.immutable.Seq<Event> events)
void	initialize(State state, Object... events)	Initializes behavior from provided state and/or events.
void	initialize(State state, scala.collection.immutable.Seq<Event> events)	Initializes behavior from provided state and/or events.
PersistenceTestKit	persistenceTestKit()	The underlying PersistenceTestKit for the in-memory journal.
EventSourcedBehaviorTestKit.RestartResult<State>	restart()	Restart the behavior, which will then recover from stored snapshot and events.
EventSourcedBehaviorTestKit.CommandResult<Command,Event,State>	runCommand(Command command)	Run one command through the behavior.
<R> EventSourcedBehaviorTestKit.CommandResultWithReply<Command,Event,State,R>	runCommand(Function<ActorRef<R>,Command> creator)	Run one command with a replyTo: ActorRef through the behavior.
Optional<SnapshotTestKit>	snapshotTestKit()	The underlying SnapshotTestKit for snapshot storage.

Methods inherited from class java.lang.Object

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

Constructor Details

EventSourcedBehaviorTestKit

public EventSourcedBehaviorTestKit(EventSourcedBehaviorTestKit<Command,Event,State> delegate)

Method Details

config

public static com.typesafe.config.Config config()

The configuration to be included in the configuration of the ActorSystem. Typically used as constructor parameter to TestKitJunitResource. The configuration enables the in-memory journal and snapshot storage.

enabledSerializationSettings

public static EventSourcedBehaviorTestKit.SerializationSettings enabledSerializationSettings()

disabledSerializationSettings

public static EventSourcedBehaviorTestKit.SerializationSettings disabledSerializationSettings()

create

public static <Command,
Event,
State>
EventSourcedBehaviorTestKit<Command,Event,State> create(ActorSystem<?> system,
 Behavior<Command> behavior)

Factory method to create a new EventSourcedBehaviorTestKit.

create

public static <Command,
Event,
State>
EventSourcedBehaviorTestKit<Command,Event,State> create(ActorSystem<?> system,
 Behavior<Command> behavior,
 EventSourcedBehaviorTestKit.SerializationSettings serializationSettings)

Factory method to create a new EventSourcedBehaviorTestKit with custom EventSourcedBehaviorTestKit.SerializationSettings.

Note that equals must be implemented in the commands, events and state if verifyEquality is enabled.

initialize

public void initialize(State state,
 Object... events)

Initializes behavior from provided state and/or events.

initialize

public void initialize(Object... events)

runCommand

public EventSourcedBehaviorTestKit.CommandResult<Command,Event,State> runCommand(Command command)

Run one command through the behavior. The returned result contains emitted events and the state after applying the events.

runCommand

public <R>
EventSourcedBehaviorTestKit.CommandResultWithReply<Command,Event,State,R> runCommand(Function<ActorRef<R>,Command> creator)

Run one command with a replyTo: ActorRef through the behavior. The returned result contains emitted events, the state after applying the events, and the reply.

getState

public State getState()

Retrieve the current state of the Behavior.

restart

public EventSourcedBehaviorTestKit.RestartResult<State> restart()

Restart the behavior, which will then recover from stored snapshot and events. Can be used for testing that the recovery is correct.

clear

public void clear()

Clears the in-memory journal and snapshot storage and restarts the behavior.

initialize

public void initialize(State state,
 scala.collection.immutable.Seq<Event> events)

Initializes behavior from provided state and/or events.

initialize

public void initialize(scala.collection.immutable.Seq<Event> events)

persistenceTestKit

public PersistenceTestKit persistenceTestKit()

The underlying PersistenceTestKit for the in-memory journal. Can be useful for advanced testing scenarios, such as simulating failures or populating the journal with events that are used for replay.

snapshotTestKit

public Optional<SnapshotTestKit> snapshotTestKit()

The underlying SnapshotTestKit for snapshot storage. Present only if snapshots are enabled. Can be useful for advanced testing scenarios, such as simulating failures or populating the storage with snapshots that are used for replay.