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

Class TestKitJunitResource

java.lang.Object

org.junit.rules.ExternalResource

org.apache.pekko.actor.testkit.typed.javadsl.TestKitJunitResource

All Implemented Interfaces:

org.junit.rules.TestRule

public final class TestKitJunitResource
extends org.junit.rules.ExternalResource

A Junit external resource for the ActorTestKit, making it possible to have Junit manage the lifecycle of the testkit. The testkit will be automatically shut down when the test completes or fails.

Note that Junit is not provided as a transitive dependency of the testkit module but must be added explicitly to your project to use this.

Example:

 public class MyActorTest {
   @ClassRule
   public static final TestKitResource testKit = new TestKitResource();

   @Test
   public void testBlah() throws Exception {
     // spawn actors etc using the testKit
     ActorRef<Message> ref = testKit.spawn(behavior);
   }
 }
 

By default config is loaded from application-test.conf if that exists, otherwise using default configuration from the reference.conf resources that ship with the Akka libraries. The application.conf of your project is not used in this case. A specific configuration can be passed as constructor parameter.

Constructor Summary

Constructors

Constructor	Description
TestKitJunitResource()	Config loaded from application-test.conf if that exists, otherwise using default configuration from the reference.conf resources that ship with the Akka libraries.
TestKitJunitResource(com.typesafe.config.Config customConfig)	Use a custom config for the actor system.
TestKitJunitResource(com.typesafe.config.Config customConfig, TestKitSettings settings)	Use a custom config for the actor system, and a custom pekko.actor.testkit.typed.TestKitSettings.
TestKitJunitResource(String customConfig)	Use a custom config for the actor system.
TestKitJunitResource(ActorTestKit _kit)
TestKitJunitResource(ActorSystem<?> system)	Use a custom pekko.actor.typed.ActorSystem for the actor system.

Method Summary

Modifier and Type	Method	Description
void	after()
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(Class<M> clazz)	See corresponding method on ActorTestKit
<M> TestProbe<M>	createTestProbe(String name)	See corresponding method on ActorTestKit
<M> TestProbe<M>	createTestProbe(String name, Class<M> clazz)	See corresponding method on ActorTestKit
TestProbe<UnhandledMessage>	createUnhandledMessageProbe()	See corresponding method on ActorTestKit
Scheduler	scheduler()	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, String name)	See corresponding method on ActorTestKit
<T> ActorRef<T>	spawn(Behavior<T> behavior, String name, Props props)	See corresponding method on ActorTestKit
<T> ActorRef<T>	spawn(Behavior<T> behavior, Props props)	See corresponding method on ActorTestKit
<T> void	stop(ActorRef<T> ref)	See corresponding method on ActorTestKit
<T> void	stop(ActorRef<T> ref, Duration max)	See corresponding method on ActorTestKit
ActorSystem<Void>	system()	See corresponding method on ActorTestKit
ActorTestKit	testKit()
TestKitSettings	testKitSettings()	See corresponding method on ActorTestKit
Timeout	timeout()	See corresponding method on ActorTestKit

Methods inherited from class org.junit.rules.ExternalResource

apply, before

Methods inherited from class java.lang.Object

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

Constructor Details

TestKitJunitResource

public TestKitJunitResource(ActorTestKit _kit)

TestKitJunitResource

public TestKitJunitResource()

Config loaded from application-test.conf if that exists, otherwise using default configuration from the reference.conf resources that ship with the Akka libraries. The application.conf of your project is not used in this case.

TestKitJunitResource

public TestKitJunitResource(ActorSystem<?> system)

Use a custom pekko.actor.typed.ActorSystem for the actor system.

TestKitJunitResource

public TestKitJunitResource(String customConfig)

Use a custom config for the actor system.

TestKitJunitResource

public TestKitJunitResource(com.typesafe.config.Config customConfig)

Use a custom config for the actor system.

TestKitJunitResource

public TestKitJunitResource(com.typesafe.config.Config customConfig,
 TestKitSettings settings)

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

Method Details

after

public void after()

Overrides:

after in class org.junit.rules.ExternalResource

createDeadLetterProbe

public TestProbe<DeadLetter> createDeadLetterProbe()

See corresponding method on ActorTestKit

createDroppedMessageProbe

public TestProbe<Dropped> createDroppedMessageProbe()

See corresponding method on ActorTestKit

createTestProbe

public <M> TestProbe<M> createTestProbe()

See corresponding method on ActorTestKit

createTestProbe

public <M> TestProbe<M> createTestProbe(Class<M> clazz)

See corresponding method on ActorTestKit

createTestProbe

public <M> TestProbe<M> createTestProbe(String name,
 Class<M> clazz)

See corresponding method on ActorTestKit

createTestProbe

public <M> TestProbe<M> createTestProbe(String name)

See corresponding method on ActorTestKit

createUnhandledMessageProbe

public TestProbe<UnhandledMessage> createUnhandledMessageProbe()

See corresponding method on ActorTestKit

scheduler

public Scheduler scheduler()

See corresponding method on ActorTestKit

serializationTestKit

public SerializationTestKit serializationTestKit()

Additional testing utilities for serialization.

spawn

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

See corresponding method on ActorTestKit

spawn

public <T> ActorRef<T> spawn(Behavior<T> behavior,
 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,
 String name,
 Props props)

See corresponding method on ActorTestKit

stop

public <T> void stop(ActorRef<T> ref,
 Duration max)

See corresponding method on ActorTestKit

stop

public <T> void stop(ActorRef<T> ref)

See corresponding method on ActorTestKit

system

public ActorSystem<Void> system()

See corresponding method on ActorTestKit

testKit

public ActorTestKit testKit()

testKitSettings

public TestKitSettings testKitSettings()

See corresponding method on ActorTestKit

timeout

public Timeout timeout()

See corresponding method on ActorTestKit