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

Class PersistenceTestKit

java.lang.Object

org.apache.pekko.persistence.testkit.javadsl.PersistenceTestKit

public class PersistenceTestKit
extends Object

Class for testing persisted events in persistent actors.

Constructor Summary

Constructors

Constructor	Description
PersistenceTestKit(ActorSystem system)
PersistenceTestKit(PersistenceTestKit scalaTestkit)

Method Summary

Modifier and Type	Method	Description
void	clearAll()	Clear all data from storage.
void	clearAllPreservingSeqNumbers()	Clear all data in storage preserving sequence numbers.
void	clearByIdPreservingSeqNumbers(String persistenceId)	Clear all data in storage for particular persistence id preserving sequence numbers.
void	clearByPersistenceId(String persistenceId)	Clear all data from storage for particular persistence id.
static PersistenceTestKit	create(ActorSystem system)
static PersistenceTestKit	create(ActorSystem<?> system)
<A> A	expectNextPersisted(String persistenceId, A event)	Check that event has been saved in the storage.
<A> A	expectNextPersisted(String persistenceId, A event, Duration max)	Check for max time that event has been saved in the storage.
<A> A	expectNextPersistedClass(String persistenceId, Class<A> cla)	Check that next persisted in storage for particular persistence id event has expected type.
<A> A	expectNextPersistedClass(String persistenceId, Class<A> cla, Duration max)	Check for max time that next persisted in storage for particular persistence id event has expected type.
void	expectNothingPersisted(String persistenceId)	Check that nothing has been saved in the storage.
void	expectNothingPersisted(String persistenceId, Duration max)	Check for max time that nothing has been saved in the storage.
void	failNextDelete()	Fail next delete from storage attempt with default exception for any persistence id.
void	failNextDelete(String persistenceId)	Fail next delete from storage attempt with default exception for particular persistence id.
void	failNextDelete(String persistenceId, Throwable cause)	Fail next delete from storage attempt with cause exception for particular persistence id.
void	failNextDelete(Throwable cause)	Fail next delete from storage attempt with cause exception for any persistence id.
void	failNextNDeletes(int n)	Fail next n delete from storage attempts with default exception for any persistence id.
void	failNextNDeletes(int n, Throwable cause)	Fail next n delete from storage attempts with cause exception for any persistence id.
void	failNextNDeletes(String persistenceId, int n)	Fail next n delete from storage attempts with default exception for particular persistence id.
void	failNextNDeletes(String persistenceId, int n, Throwable cause)	Fail next n delete from storage attempts with cause exception for particular persistence id.
void	failNextNOps(int n)	Fail n following journal operations regardless of their type.
void	failNextNOps(int n, Throwable cause)	Fail n following journal operations depending on the condition cond.
void	failNextNOpsCond(BiFunction<String,JournalOperation,Object> cond, int n)	Fail n following journal operations depending on the condition cond.
void	failNextNOpsCond(BiFunction<String,JournalOperation,Object> cond, int n, Throwable cause)	Fail n following journal operations depending on the condition cond.
void	failNextNPersisted(int n)	Fail next n write operations with default exception for any persistence id.
void	failNextNPersisted(int n, Throwable cause)	Fail next n write operations with the cause exception for any persistence id.
void	failNextNPersisted(String persistenceId, int n)	Fail next n write operations for particular persistence id.
void	failNextNPersisted(String persistenceId, int n, Throwable cause)	Fail next n write operations with the cause exception for particular persistence id.
void	failNextNReads(int n)	Fail next n read from storage (recovery) attempts with default exception for any persistence id.
void	failNextNReads(int n, Throwable cause)	Fail next n read from storage (recovery) attempts with cause exception for any persistence id.
void	failNextNReads(String persistenceId, int n)	Fail next n read from storage (recovery) attempts with default exception for particular persistence id.
void	failNextNReads(String persistenceId, int n, Throwable cause)	Fail next n read from storage (recovery) attempts with cause exception for particular persistence id.
void	failNextPersisted()	Fail next write operation with default exception for any persistence id.
void	failNextPersisted(String persistenceId)	Fail next write operation with default exception for particular persistence id.
void	failNextPersisted(String persistenceId, Throwable cause)	Fail next write operation with cause exception for particular persistence id.
void	failNextPersisted(Throwable cause)	Fail next write operation event with cause exception for any persistence id.
void	failNextRead()	Fail next read from storage (recovery) attempt with default exception for any persistence id.
void	failNextRead(String persistenceId)	Fail next read from storage (recovery) attempt with default exception for any persistence id.
void	failNextRead(String persistenceId, Throwable cause)	Fail next read from storage (recovery) attempt with cause exception for particular persistence id.
void	failNextRead(Throwable cause)	Fail next read from storage (recovery) attempt with cause exception for any persistence id.
List<Object>	persistedInStorage(String persistenceId)	Retrieve all events saved in storage by persistence id.
void	persistForRecovery(String persistenceId, List<Object> events)	Persist events into storage in order.
<A> List<A>	receivePersisted(String persistenceId, int n, Class<A> cla)	Receive next n events from the storage.
<A> List<A>	receivePersisted(String persistenceId, int n, Class<A> cla, Duration max)	Receive for max time next n events from the storage.
void	rejectNextDelete()	Reject next delete from storage operation for any persistence id with default exception.
void	rejectNextDelete(String persistenceId)	Reject next delete from storage operations for particular persistence id with default exception.
void	rejectNextDelete(String persistenceId, Throwable cause)	Reject next delete from storage operations for particular persistence id with cause exception.
void	rejectNextDelete(Throwable cause)	Reject next delete from storage operation for any persistence id with cause exception.
void	rejectNextNDeletes(int n)	Reject next n delete from storage operations for any persistence id with default exception.
void	rejectNextNDeletes(int n, Throwable cause)	Reject next n delete from storage operations for any persistence id with cause exception.
void	rejectNextNDeletes(String persistenceId, int n)	Reject next n delete from storage operations for particular persistence id with default exception.
void	rejectNextNDeletes(String persistenceId, int n, Throwable cause)	Reject next n delete from storage operations for particular persistence id with cause exception.
void	rejectNextNOps(int n)	Reject n following journal operations regardless of their type.
void	rejectNextNOps(int n, Throwable cause)	Reject n following journal operations regardless of their type.
void	rejectNextNOpsCond(BiFunction<String,JournalOperation,Object> cond, int n)	Reject n following journal operations depending on the condition cond.
void	rejectNextNOpsCond(BiFunction<String,JournalOperation,Object> cond, int n, Throwable cause)	Reject n following journal operations depending on the condition cond.
void	rejectNextNPersisted(int n)	Reject next n save in storage operations for any persistence id with default exception.
void	rejectNextNPersisted(int n, Throwable cause)	Reject next n save in storage operations for any persistence id with cause exception.
void	rejectNextNPersisted(String persistenceId, int n)	Reject next n save in storage operations for particular persistence id with default exception.
void	rejectNextNPersisted(String persistenceId, int n, Throwable cause)	Reject next n save in storage operations for particular persistence id with cause exception.
void	rejectNextNReads(int n)	Reject next n read from storage operations for any persistence id with default exception.
void	rejectNextNReads(int n, Throwable cause)	Reject next n read from storage operations for any persistence id with cause exception.
void	rejectNextNReads(String persistenceId, int n)	Reject next n read from storage operations for particular persistence id with default exception.
void	rejectNextNReads(String persistenceId, int n, Throwable cause)	Reject next n read from storage operations for particular persistence id with cause exception.
void	rejectNextPersisted()	Reject next save in storage operation for any persistence id with default exception.
void	rejectNextPersisted(String persistenceId)	Reject next save in storage operation for particular persistence id with default exception.
void	rejectNextPersisted(String persistenceId, Throwable cause)	Reject next save in storage operation for particular persistence id with cause exception.
void	rejectNextPersisted(Throwable cause)	Reject next save in storage operation for any persistence id with cause exception.
void	rejectNextRead()	Reject next read from storage operation for any persistence id with default exception.
void	rejectNextRead(String persistenceId)	Reject next read from storage operation for particular persistence id with default exception.
void	rejectNextRead(String persistenceId, Throwable cause)	Reject next read from storage operation for particular persistence id with cause exception.
void	rejectNextRead(Throwable cause)	Reject next read from storage operation for any persistence id with cause exception.
void	resetPolicy()	Returns default policy if it was changed by withPolicy(org.apache.pekko.persistence.testkit.ProcessingPolicy<org.apache.pekko.persistence.testkit.JournalOperation>).
PersistenceTestKit	withPolicy(ProcessingPolicy<JournalOperation> policy)	Set new processing policy for journal operations.

Methods inherited from class java.lang.Object

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

Constructor Details

PersistenceTestKit

public PersistenceTestKit(PersistenceTestKit scalaTestkit)

PersistenceTestKit

public PersistenceTestKit(ActorSystem system)

Method Details

create

public static PersistenceTestKit create(ActorSystem system)

create

public static PersistenceTestKit create(ActorSystem<?> system)

expectNothingPersisted

public void expectNothingPersisted(String persistenceId)

Check that nothing has been saved in the storage.

expectNothingPersisted

public void expectNothingPersisted(String persistenceId,
 Duration max)

Check for max time that nothing has been saved in the storage.

expectNextPersisted

public <A> A expectNextPersisted(String persistenceId,
 A event)

Check that event has been saved in the storage.

expectNextPersisted

public <A> A expectNextPersisted(String persistenceId,
 A event,
 Duration max)

Check for max time that event has been saved in the storage.

expectNextPersistedClass

public <A> A expectNextPersistedClass(String persistenceId,
 Class<A> cla)

Check that next persisted in storage for particular persistence id event has expected type.

expectNextPersistedClass

public <A> A expectNextPersistedClass(String persistenceId,
 Class<A> cla,
 Duration max)

Check for max time that next persisted in storage for particular persistence id event has expected type.

failNextNPersisted

public void failNextNPersisted(String persistenceId,
 int n,
 Throwable cause)

Fail next n write operations with the cause exception for particular persistence id.

failNextNPersisted

public void failNextNPersisted(String persistenceId,
 int n)

Fail next n write operations for particular persistence id.

failNextNPersisted

public void failNextNPersisted(int n,
 Throwable cause)

Fail next n write operations with the cause exception for any persistence id.

failNextNPersisted

public void failNextNPersisted(int n)

Fail next n write operations with default exception for any persistence id.

failNextPersisted

public void failNextPersisted(String persistenceId,
 Throwable cause)

Fail next write operation with cause exception for particular persistence id.

failNextPersisted

public void failNextPersisted(String persistenceId)

Fail next write operation with default exception for particular persistence id.

failNextPersisted

public void failNextPersisted(Throwable cause)

Fail next write operation event with cause exception for any persistence id.

failNextPersisted

public void failNextPersisted()

Fail next write operation with default exception for any persistence id.

failNextRead

public void failNextRead(Throwable cause)

Fail next read from storage (recovery) attempt with cause exception for any persistence id.

failNextRead

public void failNextRead()

Fail next read from storage (recovery) attempt with default exception for any persistence id.

failNextRead

public void failNextRead(String persistenceId,
 Throwable cause)

Fail next read from storage (recovery) attempt with cause exception for particular persistence id.

failNextRead

public void failNextRead(String persistenceId)

Fail next read from storage (recovery) attempt with default exception for any persistence id.

failNextNReads

public void failNextNReads(int n,
 Throwable cause)

Fail next n read from storage (recovery) attempts with cause exception for any persistence id.

failNextNReads

public void failNextNReads(int n)

Fail next n read from storage (recovery) attempts with default exception for any persistence id.

failNextNReads

public void failNextNReads(String persistenceId,
 int n,
 Throwable cause)

Fail next n read from storage (recovery) attempts with cause exception for particular persistence id.

failNextNReads

public void failNextNReads(String persistenceId,
 int n)

Fail next n read from storage (recovery) attempts with default exception for particular persistence id.

failNextDelete

public void failNextDelete(Throwable cause)

Fail next delete from storage attempt with cause exception for any persistence id.

failNextDelete

public void failNextDelete()

Fail next delete from storage attempt with default exception for any persistence id.

failNextDelete

public void failNextDelete(String persistenceId,
 Throwable cause)

Fail next delete from storage attempt with cause exception for particular persistence id.

failNextDelete

public void failNextDelete(String persistenceId)

Fail next delete from storage attempt with default exception for particular persistence id.

failNextNDeletes

public void failNextNDeletes(int n,
 Throwable cause)

Fail next n delete from storage attempts with cause exception for any persistence id.

failNextNDeletes

public void failNextNDeletes(int n)

Fail next n delete from storage attempts with default exception for any persistence id.

failNextNDeletes

public void failNextNDeletes(String persistenceId,
 int n,
 Throwable cause)

Fail next n delete from storage attempts with cause exception for particular persistence id.

failNextNDeletes

public void failNextNDeletes(String persistenceId,
 int n)

Fail next n delete from storage attempts with default exception for particular persistence id.

receivePersisted

public <A> List<A> receivePersisted(String persistenceId,
 int n,
 Class<A> cla)

Receive next n events from the storage.

receivePersisted

public <A> List<A> receivePersisted(String persistenceId,
 int n,
 Class<A> cla,
 Duration max)

Receive for max time next n events from the storage.

rejectNextNPersisted

public void rejectNextNPersisted(String persistenceId,
 int n,
 Throwable cause)

Reject next n save in storage operations for particular persistence id with cause exception.

rejectNextNPersisted

public void rejectNextNPersisted(String persistenceId,
 int n)

Reject next n save in storage operations for particular persistence id with default exception.

rejectNextNPersisted

public void rejectNextNPersisted(int n)

Reject next n save in storage operations for any persistence id with default exception.

rejectNextNPersisted

public void rejectNextNPersisted(int n,
 Throwable cause)

Reject next n save in storage operations for any persistence id with cause exception.

rejectNextPersisted

public void rejectNextPersisted(String persistenceId)

Reject next save in storage operation for particular persistence id with default exception.

rejectNextPersisted

public void rejectNextPersisted(String persistenceId,
 Throwable cause)

Reject next save in storage operation for particular persistence id with cause exception.

rejectNextPersisted

public void rejectNextPersisted(Throwable cause)

Reject next save in storage operation for any persistence id with cause exception.

rejectNextPersisted

public void rejectNextPersisted()

Reject next save in storage operation for any persistence id with default exception.

rejectNextRead

public void rejectNextRead()

Reject next read from storage operation for any persistence id with default exception.

rejectNextRead

public void rejectNextRead(Throwable cause)

Reject next read from storage operation for any persistence id with cause exception.

rejectNextNReads

public void rejectNextNReads(int n)

Reject next n read from storage operations for any persistence id with default exception.

rejectNextNReads

public void rejectNextNReads(int n,
 Throwable cause)

Reject next n read from storage operations for any persistence id with cause exception.

rejectNextRead

public void rejectNextRead(String persistenceId)

Reject next read from storage operation for particular persistence id with default exception.

rejectNextRead

public void rejectNextRead(String persistenceId,
 Throwable cause)

Reject next read from storage operation for particular persistence id with cause exception.

rejectNextNReads

public void rejectNextNReads(String persistenceId,
 int n)

Reject next n read from storage operations for particular persistence id with default exception.

rejectNextNReads

public void rejectNextNReads(String persistenceId,
 int n,
 Throwable cause)

Reject next n read from storage operations for particular persistence id with cause exception.

rejectNextDelete

public void rejectNextDelete()

Reject next delete from storage operation for any persistence id with default exception.

rejectNextDelete

public void rejectNextDelete(Throwable cause)

Reject next delete from storage operation for any persistence id with cause exception.

rejectNextNDeletes

public void rejectNextNDeletes(int n)

Reject next n delete from storage operations for any persistence id with default exception.

rejectNextNDeletes

public void rejectNextNDeletes(int n,
 Throwable cause)

Reject next n delete from storage operations for any persistence id with cause exception.

rejectNextDelete

public void rejectNextDelete(String persistenceId)

Reject next delete from storage operations for particular persistence id with default exception.

rejectNextDelete

public void rejectNextDelete(String persistenceId,
 Throwable cause)

Reject next delete from storage operations for particular persistence id with cause exception.

rejectNextNDeletes

public void rejectNextNDeletes(String persistenceId,
 int n)

Reject next n delete from storage operations for particular persistence id with default exception.

rejectNextNDeletes

public void rejectNextNDeletes(String persistenceId,
 int n,
 Throwable cause)

Reject next n delete from storage operations for particular persistence id with cause exception.

rejectNextNOpsCond

public void rejectNextNOpsCond(BiFunction<String,JournalOperation,Object> cond,
 int n)

Reject n following journal operations depending on the condition cond. Rejection triggers, when cond returns true. Reject operations with default ExpectedRejection exception.

rejectNextNOpsCond

public void rejectNextNOpsCond(BiFunction<String,JournalOperation,Object> cond,
 int n,
 Throwable cause)

Reject n following journal operations depending on the condition cond. Rejection triggers, when cond returns true. Rejects operations with the cause exception.

rejectNextNOps

public void rejectNextNOps(int n)

Reject n following journal operations regardless of their type. Rejects operations with default ExpectedRejection exception.

rejectNextNOps

public void rejectNextNOps(int n,
 Throwable cause)

Reject n following journal operations regardless of their type. Rejects operations with the cause exception.

persistForRecovery

public void persistForRecovery(String persistenceId,
 List<Object> events)

Persist events into storage in order.

persistedInStorage

public List<Object> persistedInStorage(String persistenceId)

Retrieve all events saved in storage by persistence id.

clearAll

public void clearAll()

Clear all data from storage.

NOTE! Also clears sequence numbers in storage!

See Also:

• clearAllPreservingSeqNumbers()

clearByPersistenceId

public void clearByPersistenceId(String persistenceId)

Clear all data from storage for particular persistence id.

NOTE! Also clears sequence number in storage!

See Also:

• clearByIdPreservingSeqNumbers(java.lang.String)

clearAllPreservingSeqNumbers

public void clearAllPreservingSeqNumbers()

Clear all data in storage preserving sequence numbers.

See Also:

• clearAll()

clearByIdPreservingSeqNumbers

public void clearByIdPreservingSeqNumbers(String persistenceId)

Clear all data in storage for particular persistence id preserving sequence numbers.

See Also:

• clearByPersistenceId(java.lang.String)

failNextNOpsCond

public void failNextNOpsCond(BiFunction<String,JournalOperation,Object> cond,
 int n)

Fail n following journal operations depending on the condition cond. Failure triggers, when cond returns true. Fails operations with default ExpectedFailure exception.

failNextNOpsCond

public void failNextNOpsCond(BiFunction<String,JournalOperation,Object> cond,
 int n,
 Throwable cause)

Fail n following journal operations depending on the condition cond. Failure triggers, when cond returns true. Fails operations with the cause exception.

failNextNOps

public void failNextNOps(int n)

Fail n following journal operations regardless of their type. Fails operations with default ExpectedFailure exception.

failNextNOps

public void failNextNOps(int n,
 Throwable cause)

Fail n following journal operations depending on the condition cond. Failure triggers, when cond returns true. Fails operations with the cause exception.

withPolicy

public PersistenceTestKit withPolicy(ProcessingPolicy<JournalOperation> policy)

Set new processing policy for journal operations. NOTE! Overrides previously invoked failNext... or rejectNext...

resetPolicy

public void resetPolicy()

Returns default policy if it was changed by withPolicy(org.apache.pekko.persistence.testkit.ProcessingPolicy<org.apache.pekko.persistence.testkit.JournalOperation>).