Package org.apache.pekko.persistence.testkit.scaladsl

Interface EventSourcedBehaviorTestKit<Command,Event,State>

public interface EventSourcedBehaviorTestKit<Command,Event,State>

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears the in-memory journal and snapshot storage and restarts the behavior.
State	getState()	Retrieve the current state of the Behavior.
void	initialize(scala.collection.immutable.Seq<Event> 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(scala.Function1<ActorRef<R>,Command> creator)	Run one command with a replyTo: ActorRef[R] through the behavior.
scala.Option<SnapshotTestKit>	snapshotTestKit()	The underlying SnapshotTestKit for snapshot storage.

Method Details

runCommand

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

<R>
EventSourcedBehaviorTestKit.CommandResultWithReply<Command,Event,State,R> runCommand(scala.Function1<ActorRef<R>,Command> creator)

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

getState

State getState()

Retrieve the current state of the Behavior.

restart

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

void clear()

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

persistenceTestKit

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

scala.Option<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.

initialize

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

Initializes behavior from provided state and/or events.

initialize

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