Packages

final class ActorTestKit extends AnyRef

Testkit for asynchronous testing of typed actors, meant for mixing into the test class.

Provides a typed actor system started on creation, used for all test cases and shut down when shutdown is called.

The actor system has a custom guardian that allows for spawning arbitrary actors using the spawn methods.

Designed to work with any test framework, but framework glue code that calls shutdown after all tests has run needs to be provided by the user.

For synchronous testing of a Behavior see BehaviorTestKit

Source
ActorTestKit.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ActorTestKit
  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

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 ActorTestKit toany2stringadd[ActorTestKit] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ActorTestKit, B)
    Implicit
    This member is added by an implicit conversion from ActorTestKit toArrowAssoc[ActorTestKit] 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]) @native() @HotSpotIntrinsicCandidate()
  8. val config: Config
  9. def createDeadLetterProbe(): TestProbe[DeadLetter]

    returns

    A test probe that is subscribed to dead letters from the system event bus. Subscription will be completed and verified so any dead letter after it will be caught by the probe.

  10. def createDroppedMessageProbe(): TestProbe[Dropped]

    returns

    A test probe that is subscribed to dropped letters from the system event bus. Subscription will be completed and verified so any dropped letter after it will be caught by the probe.

  11. def createTestProbe[M](name: String): TestProbe[M]

    Shortcut for creating a new named test probe for the testkit actor system

    Shortcut for creating a new named test probe for the testkit actor system

    M

    the type of messages the probe should accept

  12. def createTestProbe[M](): TestProbe[M]

    Shortcut for creating a new test probe for the testkit actor system

    Shortcut for creating a new test probe for the testkit actor system

    M

    the type of messages the probe should accept

  13. def createUnhandledMessageProbe(): TestProbe[UnhandledMessage]

    returns

    A test probe that is subscribed to unhandled messages from the system event bus. Subscription will be completed and verified so any unhandled message after it will be caught by the probe.

  14. def ensuring(cond: (ActorTestKit) => Boolean, msg: => Any): ActorTestKit
    Implicit
    This member is added by an implicit conversion from ActorTestKit toEnsuring[ActorTestKit] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: (ActorTestKit) => Boolean): ActorTestKit
    Implicit
    This member is added by an implicit conversion from ActorTestKit toEnsuring[ActorTestKit] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean, msg: => Any): ActorTestKit
    Implicit
    This member is added by an implicit conversion from ActorTestKit toEnsuring[ActorTestKit] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean): ActorTestKit
    Implicit
    This member is added by an implicit conversion from ActorTestKit toEnsuring[ActorTestKit] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. val internalSystem: typed.ActorSystem[_]
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. val name: String
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. def scheduler: typed.Scheduler
  29. val serializationTestKit: SerializationTestKit

    Additional testing utilities for serialization.

  30. def shutdownTestKit(): Unit
  31. def spawn[T](behavior: Behavior[T], name: String, props: typed.Props): typed.ActorRef[T]

    Spawn the given behavior.

    Spawn the given behavior. This is created as a child of the test kit guardian

  32. def spawn[T](behavior: Behavior[T], name: String): typed.ActorRef[T]

    Spawn the given behavior.

    Spawn the given behavior. This is created as a child of the test kit guardian

  33. def spawn[T](behavior: Behavior[T], props: typed.Props): typed.ActorRef[T]

    Spawn the given behavior.

    Spawn the given behavior. This is created as a child of the test kit guardian

  34. def spawn[T](behavior: Behavior[T]): typed.ActorRef[T]

    Spawn the given behavior.

    Spawn the given behavior. This is created as a child of the test kit guardian

  35. def stop[T](ref: typed.ActorRef[T], max: FiniteDuration = timeout.duration): Unit

    Stop the actor under test and wait until it terminates.

    Stop the actor under test and wait until it terminates. It can only be used for actors that were spawned by this ActorTestKit. Other actors will not be stopped by this method.

  36. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  37. implicit def system: typed.ActorSystem[Nothing]

    INTERNAL API

  38. implicit def testKitSettings: TestKitSettings
  39. implicit val timeout: Timeout
  40. def toString(): String
    Definition Classes
    AnyRef → Any
  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  43. 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
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ActorTestKit toStringFormat[ActorTestKit] 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): (ActorTestKit, B)
    Implicit
    This member is added by an implicit conversion from ActorTestKit toArrowAssoc[ActorTestKit] 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 fromActorTestKit to any2stringadd[ActorTestKit]

Inherited by implicit conversion StringFormat fromActorTestKit to StringFormat[ActorTestKit]

Inherited by implicit conversion Ensuring fromActorTestKit to Ensuring[ActorTestKit]

Inherited by implicit conversion ArrowAssoc fromActorTestKit to ArrowAssoc[ActorTestKit]

Ungrouped