Package org.apache.pekko.actor.testkit.typed.scaladsl

Class ActorTestKitBase

java.lang.Object

org.apache.pekko.actor.testkit.typed.scaladsl.ActorTestKitBase

Direct Known Subclasses:

ScalaTestWithActorTestKit

public abstract class ActorTestKitBase
extends java.lang.Object

A base class for the ActorTestKit, making it possible to have testing framework (e.g. ScalaTest) manage the lifecycle of the testkit.

An implementation for ScalaTest is ScalaTestWithActorTestKit.

Another abstract class that is testing framework specific should extend this class and automatically shut down the testKit when the test completes or fails by implementing afterAll().

Constructor Summary

Constructors

Constructor	Description
ActorTestKitBase()
ActorTestKitBase(com.typesafe.config.Config config)	Use a custom config for the actor system.
ActorTestKitBase(com.typesafe.config.Config config, TestKitSettings settings)	Use a custom config for the actor system, and a custom pekko.actor.testkit.typed.TestKitSettings.
ActorTestKitBase(java.lang.String config)	Use a custom config for the actor system.
ActorTestKitBase(ActorTestKit testKit)

Method Summary

Modifier and Type	Method	Description
protected abstract void	afterAll()	To be implemented by "more" concrete class that can mixin BeforeAndAfterAll or similar, for example FlatSpecLike with BeforeAndAfterAll.
TestProbe<DeadLetter>	createDeadLetterProbe()	See corresponding method on ActorTestKit
TestProbe<Dropped>	createDroppedMessageProbe()	See corresponding method on ActorTestKit
<M> TestProbe<M>	createTestProbe()	See corresponding method on ActorTestKit
<M> TestProbe<M>	createTestProbe(java.lang.String name)	See corresponding method on ActorTestKit
TestProbe<UnhandledMessage>	createUnhandledMessageProbe()	See corresponding method on ActorTestKit
SerializationTestKit	serializationTestKit()	Additional testing utilities for serialization.
<T> ActorRef<T>	spawn(Behavior<T> behavior)	See corresponding method on ActorTestKit
<T> ActorRef<T>	spawn(Behavior<T> behavior, java.lang.String name)	See corresponding method on ActorTestKit
<T> ActorRef<T>	spawn(Behavior<T> behavior, java.lang.String name, Props props)	See corresponding method on ActorTestKit
<T> ActorRef<T>	spawn(Behavior<T> behavior, Props props)	See corresponding method on ActorTestKit
ActorSystem<scala.runtime.Nothing$>	system()	See corresponding method on ActorTestKit
ActorTestKit	testKit()
TestKitSettings	testKitSettings()	See corresponding method on ActorTestKit
static java.lang.String	testNameFromCallStack()
Timeout	timeout()	See corresponding method on ActorTestKit

Methods inherited from class java.lang.Object

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

Constructor Detail

ActorTestKitBase

public ActorTestKitBase(ActorTestKit testKit)

ActorTestKitBase

public ActorTestKitBase()

ActorTestKitBase

public ActorTestKitBase(java.lang.String config)

Use a custom config for the actor system.

ActorTestKitBase

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

Use a custom config for the actor system.

ActorTestKitBase

public ActorTestKitBase(com.typesafe.config.Config config,
                        TestKitSettings settings)

Use a custom config for the actor system, and a custom pekko.actor.testkit.typed.TestKitSettings.

Method Detail

testNameFromCallStack

public static java.lang.String testNameFromCallStack()

testKit

public ActorTestKit testKit()

system

public ActorSystem<scala.runtime.Nothing$> system()

See corresponding method on ActorTestKit

testKitSettings

public TestKitSettings testKitSettings()

See corresponding method on ActorTestKit

timeout

public Timeout timeout()

See corresponding method on ActorTestKit

spawn

public <T> ActorRef<T> spawn(Behavior<T> behavior)

See corresponding method on ActorTestKit

spawn

public <T> ActorRef<T> spawn(Behavior<T> behavior,
                             java.lang.String name)

See corresponding method on ActorTestKit

spawn

public <T> ActorRef<T> spawn(Behavior<T> behavior,
                             Props props)

See corresponding method on ActorTestKit

spawn

public <T> ActorRef<T> spawn(Behavior<T> behavior,
                             java.lang.String name,
                             Props props)

See corresponding method on ActorTestKit

createTestProbe

public <M> TestProbe<M> createTestProbe()

See corresponding method on ActorTestKit

createTestProbe

public <M> TestProbe<M> createTestProbe(java.lang.String name)

See corresponding method on ActorTestKit

createDroppedMessageProbe

public TestProbe<Dropped> createDroppedMessageProbe()

See corresponding method on ActorTestKit

createDeadLetterProbe

public TestProbe<DeadLetter> createDeadLetterProbe()

See corresponding method on ActorTestKit

createUnhandledMessageProbe

public TestProbe<UnhandledMessage> createUnhandledMessageProbe()

See corresponding method on ActorTestKit

serializationTestKit

public SerializationTestKit serializationTestKit()

Additional testing utilities for serialization.

afterAll

protected abstract void afterAll()

To be implemented by "more" concrete class that can mixin BeforeAndAfterAll or similar, for example FlatSpecLike with BeforeAndAfterAll. Implement by calling testKit.shutdownTestKit().