Packages

  • package root
    Definition Classes
    root
  • package akka
    Definition Classes
    root
  • package testkit
    Definition Classes
    akka
  • class JavaTestKit extends AnyRef

    Java API: Test kit for testing actors.

    Java API: Test kit for testing actors. Inheriting from this class enables reception of replies from actors, which are queued by an internal actor and can be examined using the expectMsg... methods. Assertions and bounds concerning timing are available in the form of Within blocks.

    Beware of two points:

    • the ActorSystem passed into the constructor needs to be shutdown, otherwise thread pools and memory will be leaked - this trait is not thread-safe (only one actor with one queue, one stack of Within blocks); take care not to run tests within a single test class instance in parallel.
    • It should be noted that for CI servers and the like all maximum Durations are scaled using the dilated method, which uses the TestKitExtension.Settings.TestTimeFactor settable via akka.conf entry "akka.test.timefactor".
    Definition Classes
    testkit
  • AwaitAssert
  • AwaitCond
  • EventFilter
  • ExpectMsg
  • IgnoreMsg
  • ReceiveWhile
  • Within

abstract class ExpectMsg[T] extends AnyRef

Receive one message from the test actor and assert that the given matching function accepts it. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.

The received object as transformed by the matching function can be retrieved with the get method.

Use this variant to implement more complicated or conditional processing.


final String out = new ExpectMsg<String>("match hint") {
  protected String match(Object in) {
    if (in instanceof Integer)
      return "match";
    else
      throw noMatch();
  }
}.get(); // this extracts the received message

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

Instance Constructors

  1. new ExpectMsg(max: Duration, hint: String)
  2. new ExpectMsg(hint: String)

Abstract Value Members

  1. abstract def match(msg: Any): T
    Attributes
    protected[akka.testkit]

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 ExpectMsg[T] to any2stringadd[ExpectMsg[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ExpectMsg[T], B)
    Implicit
    This member is added by an implicit conversion from ExpectMsg[T] to ArrowAssoc[ExpectMsg[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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def ensuring(cond: (ExpectMsg[T]) ⇒ Boolean, msg: ⇒ Any): ExpectMsg[T]
    Implicit
    This member is added by an implicit conversion from ExpectMsg[T] to Ensuring[ExpectMsg[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (ExpectMsg[T]) ⇒ Boolean): ExpectMsg[T]
    Implicit
    This member is added by an implicit conversion from ExpectMsg[T] to Ensuring[ExpectMsg[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): ExpectMsg[T]
    Implicit
    This member is added by an implicit conversion from ExpectMsg[T] to Ensuring[ExpectMsg[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): ExpectMsg[T]
    Implicit
    This member is added by an implicit conversion from ExpectMsg[T] to Ensuring[ExpectMsg[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: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ExpectMsg[T] to StringFormat[ExpectMsg[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. def get(): T
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def noMatch(): RuntimeException
    Attributes
    protected[akka.testkit]
  22. final def notify(): Unit
    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. def →[B](y: B): (ExpectMsg[T], B)
    Implicit
    This member is added by an implicit conversion from ExpectMsg[T] to ArrowAssoc[ExpectMsg[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ExpectMsg[T] to any2stringadd[ExpectMsg[T]]

Inherited by implicit conversion StringFormat from ExpectMsg[T] to StringFormat[ExpectMsg[T]]

Inherited by implicit conversion Ensuring from ExpectMsg[T] to Ensuring[ExpectMsg[T]]

Inherited by implicit conversion ArrowAssoc from ExpectMsg[T] to ArrowAssoc[ExpectMsg[T]]

Ungrouped