Packages

trait 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.

For asynchronous testing of Behaviors running see ActorTestKit

Not for user extension. See BehaviorTestKit.apply factory methods

Annotations
@DoNotInherit()
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. All

Abstract Value Members

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

    Get the child inbox for the child ActorRef, or fail if there is no such child.

  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 expectEffectPF[R](f: PartialFunction[Effect, R]): R

    Asserts that the oldest effect matches the given partial function.

  8. abstract def expectEffectType[E <: Effect](implicit classTag: ClassTag[E]): E

    Asserts that the oldest effect is of type T.

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

  9. abstract def hasEffects(): Boolean

    Returns if there have been any effects.

  10. abstract def isAlive: Boolean

    Is the current behavior alive or stopped

  11. abstract def logEntries(): Seq[CapturedLogEvent]

    Returns all the CapturedLogEvent issued by this behavior(s)

  12. abstract def retrieveAllEffects(): Seq[Effect]

    Requests all the effects.

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

  13. abstract def retrieveEffect(): Effect

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

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

  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 Behavior.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 runOne(): Unit

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

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

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

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

    Send the signal to the behavior and record any Effects

Concrete Value Members

  1. def ref: typed.ActorRef[T]

    The self reference of the actor living inside this testkit.