Packages

abstract class BehaviorTestKit[T] extends AnyRef

Used for synchronous testing akka.actor.typed.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

Annotations
@DoNotInherit() @ApiMayChange()
Source
BehaviorTestKit.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BehaviorTestKit
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new BehaviorTestKit()

Abstract Value Members

  1. abstract def childInbox[U](child: typed.ActorRef[U]): TestInbox[U]

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

  2. abstract def childInbox[U](name: String): TestInbox[U]

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

  3. abstract def childTestKit[U](child: typed.ActorRef[U]): BehaviorTestKit[U]

    Get the akka.actor.typed.Behavior testkit for the given child akka.actor.typed.ActorRef.

  4. abstract def clearLog(): Unit

    Clear the log entries

  5. abstract def currentBehavior: Behavior[T]

    The current behavior, can change any time run is called

  6. abstract def expectEffect(expectedEffect: Effect): Unit

    Asserts that the oldest effect is the expectedEffect.

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

  7. abstract def expectEffectClass[U <: Effect](effectClass: Class[U]): U

    Asserts that the oldest effect is an instance of of class T.

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

  8. abstract def getAllEffects(): List[Effect]

    Requests all the effects.

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

  9. abstract def getAllLogEntries(): List[CapturedLogEvent]

    Returns all the CapturedLogEvent issued by this behavior(s)

  10. abstract def getEffect(): Effect

    Requests the oldest Effect or akka.actor.testkit.typed.javadsl.Effects.noEffects if no effects have taken place.

    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.

  11. abstract def hasEffects(): Boolean

    Returns if there have been any effects.

  12. abstract def isAlive: Boolean

    Is the current behavior alive or stopped

  13. abstract def receptionistInbox(): TestInbox[Command]

    The receptionist inbox contains messages sent to system.receptionist

  14. abstract def returnedBehavior: Behavior[T]

    Returns the current behavior as it was returned from processing the previous message.

    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.

  15. abstract def run(message: T): Unit

    Send the message to the behavior and record any Effects

  16. abstract def runAsk[Res](messageFactory: Function[typed.ActorRef[Res], T]): ReplyInbox[Res]

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

    Constructs a message using the provided 'messageFactory' to inject a single-use "reply to" akka.actor.typed.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.

  17. abstract def runAskWithStatus[Res](messageFactory: Function[typed.ActorRef[StatusReply[Res]], T]): StatusReplyInbox[Res]

    The same as runAsk but only for requests that result in a response of type akka.pattern.StatusReply.

  18. abstract def runOne(): Unit

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

  19. abstract def selfInbox(): TestInbox[T]

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

  20. abstract def signal(signal: Signal): Unit

    Send the signal to the beheavior and record any Effects

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from BehaviorTestKit[T] toany2stringadd[BehaviorTestKit[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (BehaviorTestKit[T], B)
    Implicit
    This member is added by an implicit conversion from BehaviorTestKit[T] toArrowAssoc[BehaviorTestKit[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. def ensuring(cond: (BehaviorTestKit[T]) => Boolean, msg: => Any): BehaviorTestKit[T]
    Implicit
    This member is added by an implicit conversion from BehaviorTestKit[T] toEnsuring[BehaviorTestKit[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (BehaviorTestKit[T]) => Boolean): BehaviorTestKit[T]
    Implicit
    This member is added by an implicit conversion from BehaviorTestKit[T] toEnsuring[BehaviorTestKit[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): BehaviorTestKit[T]
    Implicit
    This member is added by an implicit conversion from BehaviorTestKit[T] toEnsuring[BehaviorTestKit[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): BehaviorTestKit[T]
    Implicit
    This member is added by an implicit conversion from BehaviorTestKit[T] toEnsuring[BehaviorTestKit[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. def getRef(): typed.ActorRef[T]

    The self reference of the actor living inside this testkit.

  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. def runAsk[Res](responseClass: Class[Res], messageFactory: Function[typed.ActorRef[Res], T]): ReplyInbox[Res]

    The same as runAsk, but with the response class specified.

    The same as runAsk, 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.

    Annotations
    @nowarn()
  22. def runAskWithStatus[Res](responseClass: Class[Res], messageFactory: Function[typed.ActorRef[StatusReply[Res]], T]): StatusReplyInbox[Res]

    The same as runAskWithStatus, but with the response class specified.

    The same as runAskWithStatus, 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.

    Annotations
    @nowarn()
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from BehaviorTestKit[T] toStringFormat[BehaviorTestKit[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (BehaviorTestKit[T], B)
    Implicit
    This member is added by an implicit conversion from BehaviorTestKit[T] toArrowAssoc[BehaviorTestKit[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromBehaviorTestKit[T] to any2stringadd[BehaviorTestKit[T]]

Inherited by implicit conversion StringFormat fromBehaviorTestKit[T] to StringFormat[BehaviorTestKit[T]]

Inherited by implicit conversion Ensuring fromBehaviorTestKit[T] to Ensuring[BehaviorTestKit[T]]

Inherited by implicit conversion ArrowAssoc fromBehaviorTestKit[T] to ArrowAssoc[BehaviorTestKit[T]]

Ungrouped