Evaluate the given assert every interval
until it does not throw an exception and return the
result.
Evaluate the given assert every interval
until it does not throw an exception and return the
result.
If the max
timeout expires the last exception is thrown.
If no timeout is given, take it from the innermost enclosing within
block.
Note that the timeout is scaled using Duration.dilated, which uses the configuration entry "akka.test.timefactor".
Await until the given condition evaluates to true
or the timeout
expires, whichever comes first.
Await 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.dilated, which uses the configuration entry "akka.test.timefactor".
Spawns an actor as a child of this test actor with an auto-generated name and stopping supervisor strategy, returning the child's ActorRef.
Spawns an actor as a child of this test actor with an auto-generated name and stopping supervisor strategy, returning the child's ActorRef.
Props to create the child actor
Spawns an actor as a child of this test actor with a stopping supervisor strategy, and returns the child's ActorRef.
Spawns an actor as a child of this test actor with a stopping supervisor strategy, and returns the child's ActorRef.
Props to create the child actor
Actor name for the child actor
Spawns an actor as a child of this test actor with an auto-generated name, and returns the child's ActorRef.
Spawns an actor as a child of this test actor with an auto-generated name, and returns the child's ActorRef.
Props to create the child actor
Strategy should decide what to do with failures in the actor.
Spawns an actor as a child of this test actor, and returns the child's ActorRef.
Spawns an actor as a child of this test actor, and returns the child's ActorRef.
Props to create the child actor
Actor name for the child actor
Strategy should decide what to do with failures in the actor.
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
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(remainingOrDefault, 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(remainingOrDefault, 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(remainingOrDefault, 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(remainingOrDefault, 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(remainingOrDefault, 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(remainingOrDefault, 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(remainingOrDefault, 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](remainingOrDefault)
, but correctly treating the timeFactor.
Same as expectNoMessage(remainingOrDefault)
, but correctly treating the timeFactor.
Assert that no message is received for the specified time.
Assert that no message is received for the specified time. Supplied value is not dilated.
Receive one message from the test actor and assert that it is the Terminated message of the given ActorRef.
Receive one message from the test actor and assert that it is the Terminated message of the given ActorRef.
Before calling this method, you have to watch
the target actor ref.
Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.
the actor ref expected to be Terminated
wait no more than max time, otherwise throw AssertionFailure
the received Terminated message
Hybrid of expectMsgPF and receiveWhile: receive messages while the partial function matches and returns false.
Hybrid of expectMsgPF and receiveWhile: receive messages while the partial function matches and returns false. Use it to ignore certain messages while waiting for a specific message.
the last received message, i.e. the first one for which the partial function returned true
Waits for specific message that partial function matches while ignoring all other messages coming in the meantime.
Waits for specific message that partial function matches while ignoring all other messages coming in the meantime. Use it to ignore any number of messages while waiting for a specific one.
result of applying partial function to the last received message, i.e. the first one for which the partial function is defined
Ignore all messages in the test actor for which the given partial function returns true.
Stop ignoring messages in the test actor.
Query queue status.
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.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 or expected messages count is reached.
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 or expected messages count is reached. 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 or throw an AssertionError if no within
block surrounds this
call.
Obtain time remaining for execution of the innermost enclosing within
block or missing that it returns the given duration.
Obtain time remaining for execution of the innermost enclosing within
block or missing that it returns the properly dilated default for this
case from settings (key "akka.test.single-expect-default").
Install an AutoPilot to drive the testActor: the AutoPilot will be run for each received message and can be used to send or forward messages, etc.
Install an AutoPilot to drive the testActor: the AutoPilot will be run for each received message and can be used to send or forward messages, etc. Each invocation must return the AutoPilot for the next round.
Shut down an actor system and wait for termination.
Shut down an actor system and wait for termination. On failure debug output will be logged about the remaining actors in the system.
If verifySystemShutdown is true, then an exception will be thrown on failure.
ActorRef of the test actor.
ActorRef of the test actor. Access is provided to enable e.g. registration as message target.
Defines the testActor name.
Defines the testActor name.
Have the testActor stop watching someone (i.e.
Have the testActor stop watching someone (i.e. context.unwatch(...)
).
Have the testActor watch someone (i.e.
Have the testActor watch someone (i.e. context.watch(...)
).
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 timeout is scaled using Duration.dilated, which uses the configuration entry "akka.test.timefactor", while the min Duration is not.
val ret = within(50 millis) { test ! "ping" expectMsgClass(classOf[String]) }
Assert that no message is received for the specified time.
Assert that no message is received for the specified time. NOTE! Supplied value is always dilated.
(Since version 2.5.5) Use expectNoMessage instead
Same as expectNoMsg(remainingOrDefault)
, but correctly treating the timeFactor.
Same as expectNoMsg(remainingOrDefault)
, but correctly treating the timeFactor.
(Since version 2.5.5) Use expectNoMessage instead
Implementation trait behind the akka.testkit.TestKit class: you may use this if inheriting from a concrete class is not possible.
This trait requires the concrete class mixing it in to provide an akka.actor.ActorSystem which is available before this traits’s constructor is run. The recommended way is this: