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

Class SnapshotTestKit

java.lang.Object

org.apache.pekko.persistence.testkit.scaladsl.SnapshotTestKit

All Implemented Interfaces:

ClearOps, CommonTestKitOps<scala.Tuple2<SnapshotMetadata,Object>,SnapshotOperation>, ExpectOps<scala.Tuple2<SnapshotMetadata,Object>>, HasStorage<SnapshotOperation,scala.Tuple2<SnapshotMetadata,Object>>, PolicyOpsTestKit<SnapshotOperation>

public class SnapshotTestKit
extends Object
implements CommonTestKitOps<scala.Tuple2<SnapshotMetadata,Object>,SnapshotOperation>, PolicyOpsTestKit<SnapshotOperation>, ExpectOps<scala.Tuple2<SnapshotMetadata,Object>>, HasStorage<SnapshotOperation,scala.Tuple2<SnapshotMetadata,Object>>

Class for testing snapshots of persistent actors.

NOTE! ActorSystem must be configured with PersistenceTestKitSnapshotPlugin. The configuration can be retrieved with PersistenceTestKitSnapshotPlugin.config.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SnapshotTestKit.Settings
static class	SnapshotTestKit.Settings$

Constructor Summary

Constructors

Constructor	Description
SnapshotTestKit(ActorSystem system)

Method Summary

Modifier and Type	Method	Description
static SnapshotTestKit	apply(ActorSystem system)
static SnapshotTestKit	apply(ActorSystem<?> system)
<A> A	expectNextPersisted(String persistenceId, A event)	Check that event has been saved in the storage.
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, Throwable cause)	Fail next n delete from storage attempts with cause exception for particular 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, Throwable cause)	Fail next n write operations with the cause exception for particular 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, Throwable cause)	Fail next n read from storage (recovery) attempts with cause exception for particular persistence id.
scala.Option<Object>	getItem(String persistenceId, int nextInd)
scala.collection.immutable.Seq<scala.Tuple2<SnapshotMeta,Object>>	persistedInStorage(String persistenceId)	Retrieve snapshots and their metadata from storage by persistence id.
void	persistForRecovery(String persistenceId, scala.collection.immutable.Seq<scala.Tuple2<SnapshotMeta,Object>> elems)	Persist elems pairs of (snapshot metadata, snapshot payload) into storage.
void	persistForRecovery(String persistenceId, scala.Tuple2<SnapshotMeta,Object> elem)	Persist a pair of (snapshot metadata, snapshot payload) into storage.
protected SnapshotStorage	storage()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.pekko.persistence.testkit.scaladsl.ClearOps

clearAll, clearByPersistenceId

Methods inherited from interface org.apache.pekko.persistence.testkit.scaladsl.CommonTestKitOps

expectNextPersisted, expectNothingPersisted, expectNothingPersisted, failNextDelete, failNextDelete, failNextDelete, failNextDelete, failNextNDeletes, failNextNDeletes, failNextNPersisted, failNextNPersisted, failNextNReads, failNextNReads, failNextPersisted, failNextPersisted, failNextPersisted, failNextPersisted, failNextRead, failNextRead, failNextRead, failNextRead

Methods inherited from interface org.apache.pekko.persistence.testkit.scaladsl.ExpectOps

expectNextPersisted, expectNextPersistedClass, expectNextPersistedClass, expectNextPersistedType, expectNextPersistedType, expectNothingPersisted, expectNothingPersisted, receivePersisted, receivePersisted, receivePersisted, receivePersisted

Methods inherited from interface org.apache.pekko.persistence.testkit.scaladsl.HasStorage

addToIndex, clearIndexStorage, nextIndex, nextIndexByPersistenceId_$eq, removeLastIndex, setIndex

Methods inherited from interface org.apache.pekko.persistence.testkit.scaladsl.PolicyOpsTestKit

failNextNOps, failNextNOps, failNextNOpsCond, failNextNOpsCond, resetPolicy, withPolicy

Constructor Details

SnapshotTestKit

public SnapshotTestKit(ActorSystem system)

Method Details

apply

public static SnapshotTestKit apply(ActorSystem system)

apply

public static SnapshotTestKit apply(ActorSystem<?> system)

storage

protected SnapshotStorage storage()

Specified by:

storage in interface HasStorage<SnapshotOperation,scala.Tuple2<SnapshotMetadata,Object>>

getItem

public scala.Option<Object> getItem(String persistenceId,
 int nextInd)

Specified by:

getItem in interface ExpectOps<scala.Tuple2<SnapshotMetadata,Object>>

expectNextPersisted

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

Description copied from interface: CommonTestKitOps

Check that event has been saved in the storage.

Specified by:

expectNextPersisted in interface CommonTestKitOps<scala.Tuple2<SnapshotMetadata,Object>,SnapshotOperation>

Specified by:

expectNextPersisted in interface ExpectOps<scala.Tuple2<SnapshotMetadata,Object>>

failNextNPersisted

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

Description copied from interface: CommonTestKitOps

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

Specified by:

failNextNPersisted in interface CommonTestKitOps<scala.Tuple2<SnapshotMetadata,Object>,SnapshotOperation>

failNextNPersisted

public void failNextNPersisted(int n,
 Throwable cause)

Description copied from interface: CommonTestKitOps

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

Specified by:

failNextNPersisted in interface CommonTestKitOps<scala.Tuple2<SnapshotMetadata,Object>,SnapshotOperation>

failNextNReads

public void failNextNReads(int n,
 Throwable cause)

Description copied from interface: CommonTestKitOps

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

Specified by:

failNextNReads in interface CommonTestKitOps<scala.Tuple2<SnapshotMetadata,Object>,SnapshotOperation>

failNextNReads

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

Description copied from interface: CommonTestKitOps

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

Specified by:

failNextNReads in interface CommonTestKitOps<scala.Tuple2<SnapshotMetadata,Object>,SnapshotOperation>

failNextNDeletes

public void failNextNDeletes(int n,
 Throwable cause)

Description copied from interface: CommonTestKitOps

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

Specified by:

failNextNDeletes in interface CommonTestKitOps<scala.Tuple2<SnapshotMetadata,Object>,SnapshotOperation>

failNextNDeletes

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

Description copied from interface: CommonTestKitOps

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

Specified by:

failNextNDeletes in interface CommonTestKitOps<scala.Tuple2<SnapshotMetadata,Object>,SnapshotOperation>

persistForRecovery

public void persistForRecovery(String persistenceId,
 scala.collection.immutable.Seq<scala.Tuple2<SnapshotMeta,Object>> elems)

Persist elems pairs of (snapshot metadata, snapshot payload) into storage.

persistForRecovery

public void persistForRecovery(String persistenceId,
 scala.Tuple2<SnapshotMeta,Object> elem)

Persist a pair of (snapshot metadata, snapshot payload) into storage.

persistedInStorage

public scala.collection.immutable.Seq<scala.Tuple2<SnapshotMeta,Object>> persistedInStorage(String persistenceId)

Retrieve snapshots and their metadata from storage by persistence id.