Package akka.actor.testkit.typed.javadsl

Class BehaviorTestKit<T>

java.lang.Object

akka.actor.testkit.typed.javadsl.BehaviorTestKit<T>

public abstract class BehaviorTestKit<T>
extends java.lang.Object

Used for synchronous testing Behaviors. Stores all effects e.g. Spawning of children, watching and offers access to what effects have taken place.

Not for user extension or instantiation. See BehaviorTestKit.create factory methods

For asynchronous testing of Behaviors running see ActorTestKit

Constructor Summary

Constructors

Constructor	Description
BehaviorTestKit()

Method Summary

Modifier and Type	Method	Description
static com.typesafe.config.Config	applicationTestConfig()	JAVA API
abstract <U> TestInbox<U>	childInbox(ActorRef<U> child)	Get the child inbox for the child with the given name, or fail if there is no child with the given name spawned
abstract <U> TestInbox<U>	childInbox(java.lang.String name)	Get the child inbox for the child with the given name, or fail if there is no child with the given name spawned
abstract <U> BehaviorTestKit<U>	childTestKit(ActorRef<U> child)	Get the Behavior testkit for the given child ActorRef.
abstract void	clearLog()	Clear the log entries
static <T> BehaviorTestKit<T>	create(Behavior<T> initialBehavior)	JAVA API
static <T> BehaviorTestKit<T>	create(Behavior<T> initialBehavior, java.lang.String name)	JAVA API
static <T> BehaviorTestKit<T>	create(Behavior<T> initialBehavior, java.lang.String name, com.typesafe.config.Config config)	JAVA API
abstract Behavior<T>	currentBehavior()	The current behavior, can change any time run is called
abstract void	expectEffect(Effect expectedEffect)	Asserts that the oldest effect is the expectedEffect.
abstract <U extends Effect> U	expectEffectClass(java.lang.Class<U> effectClass)	Asserts that the oldest effect is an instance of of class T.
abstract java.util.List<Effect>	getAllEffects()	Requests all the effects.
abstract java.util.List<CapturedLogEvent>	getAllLogEntries()	Returns all the CapturedLogEvent issued by this behavior(s)
abstract Effect	getEffect()	Requests the oldest Effect or akka.actor.testkit.typed.javadsl.Effects.noEffects if no effects have taken place.
ActorRef<T>	getRef()	The self reference of the actor living inside this testkit.
abstract boolean	hasEffects()	Returns if there have been any effects.
abstract boolean	isAlive()	Is the current behavior alive or stopped
abstract TestInbox<Receptionist.Command>	receptionistInbox()	The receptionist inbox contains messages sent to system.receptionist
abstract Behavior<T>	returnedBehavior()	Returns the current behavior as it was returned from processing the previous message.
abstract void	run(T message)	Send the message to the behavior and record any Effects
abstract <Res> ReplyInbox<Res>	runAsk(Function<ActorRef<Res>,T> messageFactory)	Constructs a message using the provided 'messageFactory' to inject a single-use "reply to" ActorRef, and sends the constructed message to the behavior, recording any Effects.
<Res> ReplyInbox<Res>	runAsk(java.lang.Class<Res> responseClass, Function<ActorRef<Res>,T> messageFactory)	The same as <Res>runAsk(akka.japi.function.Function<akka.actor.typed.ActorRef<Res>,T>), but with the response class specified.
abstract <Res> StatusReplyInbox<Res>	runAskWithStatus(Function<ActorRef<StatusReply<Res>>,T> messageFactory)	The same as <Res>runAsk(akka.japi.function.Function<akka.actor.typed.ActorRef<Res>,T>) but only for requests that result in a response of type StatusReply.
<Res> StatusReplyInbox<Res>	runAskWithStatus(java.lang.Class<Res> responseClass, Function<ActorRef<StatusReply<Res>>,T> messageFactory)	The same as <Res>runAskWithStatus(akka.japi.function.Function<akka.actor.typed.ActorRef<akka.pattern.StatusReply<Res>>,T>), but with the response class specified.
abstract void	runOne()	Send the first message in the selfInbox to the behavior and run it, recording Effects.
abstract TestInbox<T>	selfInbox()	The self inbox contains messages the behavior sent to context.self
abstract void	signal(Signal signal)	Send the signal to the beheavior and record any Effects

Methods inherited from class java.lang.Object

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

Constructor Detail

BehaviorTestKit

public BehaviorTestKit()

Method Detail

applicationTestConfig

public static com.typesafe.config.Config applicationTestConfig()

JAVA API

create

public static <T> BehaviorTestKit<T> create(Behavior<T> initialBehavior,
                                            java.lang.String name,
                                            com.typesafe.config.Config config)

JAVA API

create

public static <T> BehaviorTestKit<T> create(Behavior<T> initialBehavior,
                                            java.lang.String name)

JAVA API

create

public static <T> BehaviorTestKit<T> create(Behavior<T> initialBehavior)

JAVA API

runAsk

public abstract <Res> ReplyInbox<Res> runAsk(Function<ActorRef<Res>,T> messageFactory)

Constructs a message using the provided 'messageFactory' to inject a single-use "reply to" ActorRef, and sends the constructed message to the behavior, recording any Effects.

The returned ReplyInbox allows the message sent to the "reply to" ActorRef to be asserted on.

runAsk

public <Res> ReplyInbox<Res> runAsk(java.lang.Class<Res> responseClass,
                                    Function<ActorRef<Res>,T> messageFactory)

The same as <Res>runAsk(akka.japi.function.Function<akka.actor.typed.ActorRef<Res>,T>), but with the response class specified. This improves type inference in Java when asserting on the reply in the same statement as the runAsk as in:

testkit.runAsk(Done.class, DoSomethingCommand::new).expectReply(Done.getInstance());

If explicitly saving the ReplyInbox in a variable, the version without the class may be preferred.

runAskWithStatus

public abstract <Res> StatusReplyInbox<Res> runAskWithStatus(Function<ActorRef<StatusReply<Res>>,T> messageFactory)

The same as <Res>runAsk(akka.japi.function.Function<akka.actor.typed.ActorRef<Res>,T>) but only for requests that result in a response of type StatusReply.

runAskWithStatus

public <Res> StatusReplyInbox<Res> runAskWithStatus(java.lang.Class<Res> responseClass,
                                                    Function<ActorRef<StatusReply<Res>>,T> messageFactory)

The same as <Res>runAskWithStatus(akka.japi.function.Function<akka.actor.typed.ActorRef<akka.pattern.StatusReply<Res>>,T>), but with the response class specified. This improves type inference in Java when asserting on the reply in the same statement as the runAskWithStatus as in:

testkit.runAskWithStatus(Done.class, DoSomethingWithStatusCommand::new).expectValue(Done.getInstance());

If explicitly saving the StatusReplyInbox in a variable, the version without the class may be preferred.

getEffect

public abstract Effect getEffect()

Requests the oldest Effect or akka.actor.testkit.typed.javadsl.Effects.noEffects if no effects have taken place. The effect is consumed, subsequent calls won't will not include this effect.

childInbox

public abstract <U> TestInbox<U> childInbox(java.lang.String name)

Get the child inbox for the child with the given name, or fail if there is no child with the given name spawned

childInbox

public abstract <U> TestInbox<U> childInbox(ActorRef<U> child)

Get the child inbox for the child with the given name, or fail if there is no child with the given name spawned

childTestKit

public abstract <U> BehaviorTestKit<U> childTestKit(ActorRef<U> child)

Get the Behavior testkit for the given child ActorRef.

selfInbox

public abstract TestInbox<T> selfInbox()

The self inbox contains messages the behavior sent to context.self

getRef

public ActorRef<T> getRef()

The self reference of the actor living inside this testkit.

getAllEffects

public abstract java.util.List<Effect> getAllEffects()

Requests all the effects. The effects are consumed, subsequent calls will only see new effects.

hasEffects

public abstract boolean hasEffects()

Returns if there have been any effects.

expectEffect

public abstract void expectEffect(Effect expectedEffect)

Asserts that the oldest effect is the expectedEffect. Removing it from further assertions.

expectEffectClass

public abstract <U extends Effect> U expectEffectClass(java.lang.Class<U> effectClass)

Asserts that the oldest effect is an instance of of class T. Consumes and returns the concrete effect for further direct assertions.

currentBehavior

public abstract Behavior<T> currentBehavior()

The current behavior, can change any time run is called

returnedBehavior

public abstract Behavior<T> returnedBehavior()

Returns the current behavior as it was returned from processing the previous message. For example if Behaviors.unhandled is returned it will be kept here, but not in currentBehavior().

isAlive

public abstract boolean isAlive()

Is the current behavior alive or stopped

run

public abstract void run(T message)

Send the message to the behavior and record any Effects

runOne

public abstract void runOne()

Send the first message in the selfInbox to the behavior and run it, recording Effects.

signal

public abstract void signal(Signal signal)

Send the signal to the beheavior and record any Effects

getAllLogEntries

public abstract java.util.List<CapturedLogEvent> getAllLogEntries()

Returns all the CapturedLogEvent issued by this behavior(s)

clearLog

public abstract void clearLog()

Clear the log entries

receptionistInbox

public abstract TestInbox<Receptionist.Command> receptionistInbox()

The receptionist inbox contains messages sent to system.receptionist