akka.testkit

TestKit

trait TestKit extends TestKitLight

Linear Supertypes
TestKitLight, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. TestKit
  2. TestKitLight
  3. AnyRef
  4. Any
Visibility
  1. Public
  2. All

Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any
  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  6. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any
  7. def awaitCond (p: ⇒ Boolean, max: Duration = Duration.MinusInf, interval: Duration = 100.millis): Unit

    Block until the given condition evaluates to true or the timeout expires, whichever comes first.

    Block until the given condition evaluates to true or the timeout expires, whichever comes first.

    If no timeout is given, take it from the innermost enclosing within block.

    Note that the timeout is scaled using Duration.timeFactor.

    Definition Classes
    TestKitLight
  8. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  9. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  10. def equals (arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  11. def expectMsg [T] (max: Duration, obj: T): T

    Receive one message from the test actor and assert that it equals the given object.

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

    returns

    the received object

    Definition Classes
    TestKitLight
  12. def expectMsg [T] (obj: T): T

    Same as expectMsg(remaining, obj), but correctly treating the timeFactor.

    Same as expectMsg(remaining, obj), but correctly treating the timeFactor.

    Definition Classes
    TestKitLight
  13. def expectMsgAllClassOf [T] (max: Duration, obj: Class[_ <: T]*): Seq[T]

    Receive a number of messages from the test actor matching the given number of classes and assert that for each given class one is received which is of that class (equality, not conformance).

    Receive a number of messages from the test actor matching the given number of classes and assert that for each given class one is received which is of that class (equality, not conformance). This construct is useful when the order in which the objects are received is not fixed. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.

    Definition Classes
    TestKitLight
  14. def expectMsgAllClassOf [T] (obj: Class[_ <: T]*): Seq[T]

    Same as expectMsgAllClassOf(remaining, obj...), but correctly treating the timeFactor.

    Same as expectMsgAllClassOf(remaining, obj...), but correctly treating the timeFactor.

    Definition Classes
    TestKitLight
  15. def expectMsgAllConformingOf [T] (max: Duration, obj: Class[_ <: T]*): Seq[T]

    Receive a number of messages from the test actor matching the given number of classes and assert that for each given class one is received which conforms to that class (and vice versa).

    Receive a number of messages from the test actor matching the given number of classes and assert that for each given class one is received which conforms to that class (and vice versa). This construct is useful when the order in which the objects are received is not fixed. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.

    Beware that one object may satisfy all given class constraints, which may be counter-intuitive.

    Definition Classes
    TestKitLight
  16. def expectMsgAllConformingOf [T] (obj: Class[_ <: T]*): Seq[T]

    Same as expectMsgAllConformingOf(remaining, obj...), but correctly treating the timeFactor.

    Same as expectMsgAllConformingOf(remaining, obj...), but correctly treating the timeFactor.

    Definition Classes
    TestKitLight
  17. def expectMsgAllOf [T] (max: Duration, obj: T*): Seq[T]

    Receive a number of messages from the test actor matching the given number of objects and assert that for each given object one is received which equals it and vice versa.

    Receive a number of messages from the test actor matching the given number of objects and assert that for each given object one is received which equals it and vice versa. This construct is useful when the order in which the objects are received is not fixed. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.

      dispatcher ! SomeWork1()
      dispatcher ! SomeWork2()
      expectMsgAllOf(1 second, Result1(), Result2())
    

    Definition Classes
    TestKitLight
  18. def expectMsgAllOf [T] (obj: T*): Seq[T]

    Same as expectMsgAllOf(remaining, obj...), but correctly treating the timeFactor.

    Same as expectMsgAllOf(remaining, obj...), but correctly treating the timeFactor.

    Definition Classes
    TestKitLight
  19. def expectMsgAnyClassOf [C] (max: Duration, obj: Class[_ <: C]*): C

    Receive one message from the test actor and assert that it conforms to one of the given classes.

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

    returns

    the received object

    Definition Classes
    TestKitLight
  20. def expectMsgAnyClassOf [C] (obj: Class[_ <: C]*): C

    Same as expectMsgAnyClassOf(remaining, obj...), but correctly treating the timeFactor.

    Same as expectMsgAnyClassOf(remaining, obj...), but correctly treating the timeFactor.

    Definition Classes
    TestKitLight
  21. def expectMsgAnyOf [T] (max: Duration, obj: T*): T

    Receive one message from the test actor and assert that it equals one of the given objects.

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

    returns

    the received object

    Definition Classes
    TestKitLight
  22. def expectMsgAnyOf [T] (obj: T*): T

    Same as expectMsgAnyOf(remaining, obj...), but correctly treating the timeFactor.

    Same as expectMsgAnyOf(remaining, obj...), but correctly treating the timeFactor.

    Definition Classes
    TestKitLight
  23. def expectMsgClass [C] (max: Duration, c: Class[C]): C

    Receive one message from the test actor and assert that it conforms to the given class.

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

    returns

    the received object

    Definition Classes
    TestKitLight
  24. def expectMsgClass [C] (c: Class[C]): C

    Same as expectMsgClass(remaining, c), but correctly treating the timeFactor.

    Same as expectMsgClass(remaining, c), but correctly treating the timeFactor.

    Definition Classes
    TestKitLight
  25. def expectMsgPF [T] (max: Duration = Duration.MinusInf, hint: String = "")(f: PartialFunction[Any, T]): T

    Receive one message from the test actor and assert that the given partial function accepts it.

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

    Use this variant to implement more complicated or conditional processing.

    returns

    the received object as transformed by the partial function

    Definition Classes
    TestKitLight
  26. def expectMsgType [T] (max: Duration)(implicit m: Manifest[T]): T

    Receive one message from the test actor and assert that it conforms to the given type (after erasure).

    Receive one message from the test actor and assert that it conforms to the given type (after erasure). Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.

    returns

    the received object

    Definition Classes
    TestKitLight
  27. def expectMsgType [T] (implicit m: Manifest[T]): T

    Same as expectMsgType[T](remaining), but correctly treating the timeFactor.

    Same as expectMsgType[T](remaining), but correctly treating the timeFactor.

    Definition Classes
    TestKitLight
  28. def expectNoMsg (max: Duration): Unit

    Assert that no message is received for the specified time.

    Assert that no message is received for the specified time.

    Definition Classes
    TestKitLight
  29. def expectNoMsg (): Unit

    Same as expectNoMsg(remaining), but correctly treating the timeFactor.

    Same as expectNoMsg(remaining), but correctly treating the timeFactor.

    Definition Classes
    TestKitLight
  30. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  31. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any
  32. def hashCode (): Int

    Definition Classes
    AnyRef → Any
  33. def ignoreMsg (f: PartialFunction[AnyRef, Boolean]): Unit

    Ignore all messages in the test actor for which the given partial function returns true.

    Ignore all messages in the test actor for which the given partial function returns true.

    Definition Classes
    TestKitLight
  34. def ignoreNoMsg (): Unit

    Stop ignoring messages in the test actor.

    Stop ignoring messages in the test actor.

    Definition Classes
    TestKitLight
  35. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any
  36. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  37. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  38. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  39. def now : Duration

    Obtain current time (System.nanoTime) as Duration.

    Obtain current time (System.nanoTime) as Duration.

    Definition Classes
    TestKitLight
  40. def receiveN (n: Int, max: Duration): Seq[AnyRef]

    Receive N messages in a row before the given deadline.

    Receive N messages in a row before the given deadline.

    Definition Classes
    TestKitLight
  41. def receiveN (n: Int): Seq[AnyRef]

    Same as receiveN(n, remaining) but correctly taking into account Duration.

    Same as receiveN(n, remaining) but correctly taking into account Duration.timeFactor.

    Definition Classes
    TestKitLight
  42. def receiveOne (max: Duration): AnyRef

    Receive one message from the internal queue of the TestActor.

    Receive one message from the internal queue of the TestActor. If the given duration is zero, the queue is polled (non-blocking).

    This method does NOT automatically scale its Duration parameter!

    Definition Classes
    TestKitLight
  43. def receiveWhile [T] (max: Duration = Duration.MinusInf, idle: Duration = Duration.Inf)(f: PartialFunction[AnyRef, T]): Seq[T]

    Receive a series of messages until one does not match the given partial function or the idle timeout is met (disabled by default) or the overall maximum duration is elapsed.

    Receive a series of messages until one does not match the given partial function or the idle timeout is met (disabled by default) or the overall maximum duration is elapsed. Returns the sequence of messages.

    Note that it is not an error to hit the max duration in this case.

    One possible use of this method is for testing whether messages of certain characteristics are generated at a certain rate:

    test ! ScheduleTicks(100 millis)
    val series = receiveWhile(750 millis) {
        case Tick(count) => count
    }
    assert(series == (1 to 7).toList)
    

    Definition Classes
    TestKitLight
  44. def remaining : Duration

    Obtain time remaining for execution of the innermost enclosing within block.

    Obtain time remaining for execution of the innermost enclosing within block.

    Definition Classes
    TestKitLight
  45. def reply (msg: AnyRef): Unit

    Send reply to the last dequeued message.

    Send reply to the last dequeued message. Will throw IllegalActorStateException if no message has been dequeued, yet. Dequeuing means reception of the message as part of an expect... or receive... call, not reception by the testActor.

    Definition Classes
    TestKitLight
  46. implicit val self : ActorRef

    Attributes
    implicit
  47. def setTestActorTimeout (d: Duration): Unit

    Set test actor timeout.

    Set test actor timeout. By default, the test actor shuts itself down after 5 seconds of inactivity. Set this to Duration.Inf to disable this behavior, but make sure that someone will then call stopTestActor, unless you want to leak actors, e.g. wrap test in

      try {
        ...
      } finally { stopTestActor }
    

    Definition Classes
    TestKitLight
  48. def stopTestActor (): Unit

    Stop test actor.

    Stop test actor. Should be done at the end of the test unless relying on test actor timeout.

    Definition Classes
    TestKitLight
  49. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  50. val testActor : ActorRef

    ActorRef of the test actor.

    ActorRef of the test actor. Access is provided to enable e.g. registration as message target.

    Definition Classes
    TestKitLight
  51. def toString (): String

    Definition Classes
    AnyRef → Any
  52. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  53. def wait (arg0: Long, arg1: Int): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  54. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  55. def within [T] (max: Duration)(f: ⇒ T): T

    Same as calling within(0 seconds, max)(f).

    Same as calling within(0 seconds, max)(f).

    Definition Classes
    TestKitLight
  56. def within [T] (min: Duration, max: Duration)(f: ⇒ T): T

    Execute code block while bounding its execution time between min and max.

    Execute code block while bounding its execution time between min and max. within blocks may be nested. All methods in this trait which take maximum wait times are available in a version which implicitly uses the remaining time governed by the innermost enclosing within block.

    Note that the max Duration is scaled by Duration.timeFactor while the min Duration is not.

    val ret = within(50 millis) {
            test ! "ping"
            expectMsgClass(classOf[String])
          }
    

    Definition Classes
    TestKitLight

Deprecated Value Members

  1. def receiveWhile [T] (f: PartialFunction[AnyRef, T]): Seq[T]

    Same as receiveWhile(remaining)(f), but correctly treating the timeFactor.

    Same as receiveWhile(remaining)(f), but correctly treating the timeFactor.

    Definition Classes
    TestKitLight
    Annotations
    @deprecated
    Deprecated

    insert empty first parameter list: receiveWhile()(pf)

  2. val senderOption : Some[ActorRef]

    Implicit sender reference so that replies are possible for messages sent from the test class.

    Implicit sender reference so that replies are possible for messages sent from the test class.

    Definition Classes
    TestKitLight
    Annotations
    @deprecated
    Deprecated

    will be removed after 1.2, replaced by implicit testActor

Inherited from TestKitLight

Inherited from AnyRef

Inherited from Any