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.
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(remaining, obj)
, but correctly treating the timeFactor.
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(remaining, obj...)
, but correctly treating the timeFactor.
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.
Same as expectMsgAllConformingOf(remaining, obj...)
, but correctly treating the timeFactor.
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())
Same as expectMsgAllOf(remaining, obj...)
, but correctly treating the timeFactor.
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(remaining, obj...)
, but correctly treating the timeFactor.
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(remaining, obj...)
, but correctly treating the timeFactor.
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(remaining, c)
, but correctly treating the timeFactor.
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
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.
the received object
Same as expectMsgType[T](remaining)
, but correctly treating the timeFactor.
Assert that no message is received for the specified time.
Same as expectNoMsg(remaining)
, but correctly treating the timeFactor.
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.nanoTime
) as Duration.
Receive N messages in a row before the given deadline.
Same as receiveN(n, remaining)
but correctly taking into account
Duration.
Same as receiveN(n, remaining)
but correctly taking into account
Duration.timeFactor.
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!
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)
Obtain time remaining for execution of the innermost enclosing within
block.
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.
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.
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]) }
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
use expectMsgPF instead
Same as expectMsg(remaining)(f)
, but correctly treating the timeFactor.
Same as expectMsg(remaining)(f)
, but correctly treating the timeFactor.
use expectMsgPF instead
Same as receiveWhile(remaining)(f)
, but correctly treating the timeFactor.
Same as receiveWhile(remaining)(f)
, but correctly treating the timeFactor.
insert empty first parameter list: receiveWhile()(pf)
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.
will be removed after 1.2, replaced by implicit testActor
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 ofwithin
blocks.Beware of two points:
stopTestActor
or implicitly by using its internal inactivity timeout, seesetTestActorTimeout
within
blocks); 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.It should be noted that for CI servers and the like all maximum Durations are scaled using their Duration.dilated method, which uses the Duration.timeFactor settable via akka.conf entry "akka.test.timefactor".
1.1