TO BE DEFINED BY USER: Defines the number of participants required for starting the test. This might not be equals to the number of nodes available to the test.

Must be a def:

def initialParticipants = 5

Override this method to do something when the whole test is terminating.

Evaluate the given assert every interval until exception is thrown or max timeout is expired.

Returns the result of last evaluation of the assertion.

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".

Override this method to do something when the whole test is starting up.

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.

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 a stopping supervisor strategy, 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.

Spawns an actor as a child of this test actor, and returns the child's ActorRef.

Enter the named barriers in the order given. Use the remaining duration from the innermost enclosing within block or the passed max timeout.

Note that the max timeout is scaled using Duration.dilated, which uses the configuration entry "akka.test.timefactor".

Enter the named barriers in the order given. Use the remaining duration from the innermost enclosing within block or the default BarrierTimeout.

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.

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.

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). 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). 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. 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. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.

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. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.

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. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.

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. 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.

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.

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

Assert that no message is received. Waits for the default period configured as akka.test.expect-no-message-default. That timeout is scaled using the configuration entry "akka.test.timefactor".

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. 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.

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.

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.

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.

Call this after the all test cases have run. NOT after every test case.

Call this before the start of the test run. NOT before every test case.

Query the controller for the transport address of the given node (by role name) and return that as an ActorPath for easy composition:

val serviceA = system.actorSelection(node("master") / "user" / "serviceA")

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. 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. 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. Each invocation must return the AutoPilot for the next round.

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.

This method starts a new ActorSystem with the same configuration as the previous one on the current node, including deployments. It also creates a new TestConductor client and registers itself with the conductor so that it is possible to use barriers etc. normally after this method has been called.

NOTICE: you MUST start a new system before trying to enter a barrier or otherwise using the TestConductor after having terminated this node’s system.

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

Defines the testActor name.

Access to the barriers, failure injection, etc. The extension will have been started either in Conductor or Player mode when the constructor of MultiNodeSpec finishes, i.e. do not call the start*() methods yourself!

Have the testActor stop watching someone (i.e. context.unwatch(...)).

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. 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])
}