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.
the received object as transformed by the partial function
Same as expectMsg, but takes the maximum wait time from the innermost
enclosing within block.
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.
the received object
Same as expectMsg, but takes the maximum wait time from the innermost
enclosing within block.
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.
Same as expectMsgAllClassOf, but takes the maximum wait time from the innermost
enclosing within block.
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.
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. 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.
Same as expectMsgAllConformingOf, but takes the maximum wait time from the innermost
enclosing within block.
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.
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. 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.
within(1 second) {
dispatcher ! SomeWork1()
dispatcher ! SomeWork2()
expectMsgAllOf(Result1(), Result2())
}
Same as expectMsgAllOf, but takes the maximum wait time from the innermost
enclosing within block.
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.
the received object
Same as expectMsgAnyClassOf, but takes the maximum wait time from the innermost
enclosing within block.
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.
the received object
Same as expectMsgAnyOf, but takes the maximum wait time from the innermost
enclosing within block.
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.
the received object
Same as expectMsgClass, but takes the maximum wait time from the innermost
enclosing within block.
Assert that no message is received for the specified time.
Same as expectNoMsg, but takes the maximum wait time from the innermost
enclosing within block.
Ignore all messages in the test actor for which the given partial function returns true.
Stop ignoring messages in the test actor.
Obtain current time (System.currentTimeMillis) as Duration.
Receive a series of messages as long as the given partial function accepts them or the idle timeout is met or the overall maximum duration is elapsed.
Receive a series of messages as long as the given partial function accepts them or the idle timeout is met or the overall maximum duration is elapsed. Returns the sequence of messages.
Beware that the maximum duration is not implicitly bounded by or taken
from the innermost enclosing within block, as 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)
Same as receiveWhile, but takes the maximum wait time from the innermost
enclosing within block.
Obtain time remaining for execution of the innermost enclosing within block.
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.
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 }
Stop test actor.
Stop test actor. Should be done at the end of the test unless relying on test actor timeout.
ActorRef of the test actor.
ActorRef of the test actor. Access is provided to enable e.g. registration as message target.
Same as calling within(0 seconds, max)(f).
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.
val ret = within(50 millis) {
test ! "ping"
expectMsgClass(classOf[String])
}
Test kit for testing actors. Inheriting from this trait 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 ofwithinblocks.class Test extends TestKit { val test = actorOf[SomeActor].start() within (1 second) { test ! SomeWork expectMsg(Result1) // bounded to 1 second expectMsg(Result2) // bounded to the remainder of the 1 second } }Beware of two points:
stopTestActoror implicitly by using its internal inactivity timeout, seesetTestActorTimeoutwithinblocks); it is expected that the code is executed from a constructor as shown above, which makes this a non-issue, otherwise take care not to run tests within a single test class instance in parallel.1.1