trait TestKitBase extends AnyRef
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:
class MyTest extends TestKitBase { implicit lazy val system = ActorSystem() // may add arguments here ... }
- Source
- TestKit.scala
- Alphabetic
- By Inheritance
- TestKitBase
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- implicit abstract def system: ActorSystem
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from TestKitBase toany2stringadd[TestKitBase] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (TestKitBase, B)
- Implicit
- This member is added by an implicit conversion from TestKitBase toArrowAssoc[TestKitBase] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def assertForDuration[A](a: => A, max: FiniteDuration, interval: Duration = 100.millis): A
Evaluate the given assert every
interval
until exception is thrown ormax
timeout is expired.Evaluate the given assert every
interval
until exception is thrown ormax
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".
- def awaitAssert[A](a: => A, max: Duration = Duration.Undefined, interval: Duration = 100.millis): A
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".
- def awaitCond(p: => Boolean, max: Duration = Duration.Undefined, interval: Duration = 100.millis, message: String = ""): Unit
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".
- def childActorOf(props: Props): 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.
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
Props to create the child actor
- def childActorOf(props: Props, name: String): 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 a stopping supervisor strategy, and returns the child's ActorRef.
- props
Props to create the child actor
- name
Actor name for the child actor
- def childActorOf(props: Props, supervisorStrategy: SupervisorStrategy): 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 with an auto-generated name, and returns the child's ActorRef.
- props
Props to create the child actor
- supervisorStrategy
Strategy should decide what to do with failures in the actor.
- def childActorOf(props: Props, name: String, supervisorStrategy: SupervisorStrategy): ActorRef
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
Props to create the child actor
- name
Actor name for the child actor
- supervisorStrategy
Strategy should decide what to do with failures in the actor.
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- def ensuring(cond: (TestKitBase) => Boolean, msg: => Any): TestKitBase
- Implicit
- This member is added by an implicit conversion from TestKitBase toEnsuring[TestKitBase] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (TestKitBase) => Boolean): TestKitBase
- Implicit
- This member is added by an implicit conversion from TestKitBase toEnsuring[TestKitBase] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): TestKitBase
- Implicit
- This member is added by an implicit conversion from TestKitBase toEnsuring[TestKitBase] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): TestKitBase
- Implicit
- This member is added by an implicit conversion from TestKitBase toEnsuring[TestKitBase] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def expectMsg[T](max: FiniteDuration, hint: String, 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
- def expectMsg[T](max: FiniteDuration, 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
- def expectMsg[T](obj: T): T
Same as
expectMsg(remainingOrDefault, obj)
, but correctly treating the timeFactor. - def expectMsgAllClassOf[T](max: FiniteDuration, 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.
- def expectMsgAllClassOf[T](obj: Class[_ <: T]*): Seq[T]
Same as
expectMsgAllClassOf(remainingOrDefault, obj...)
, but correctly treating the timeFactor. - def expectMsgAllConformingOf[T](max: FiniteDuration, 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.
- def expectMsgAllConformingOf[T](obj: Class[_ <: T]*): Seq[T]
Same as
expectMsgAllConformingOf(remainingOrDefault, obj...)
, but correctly treating the timeFactor. - def expectMsgAllOf[T](max: FiniteDuration, 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())
- def expectMsgAllOf[T](obj: T*): Seq[T]
Same as
expectMsgAllOf(remainingOrDefault, obj...)
, but correctly treating the timeFactor. - def expectMsgAnyClassOf[C](max: FiniteDuration, 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
- def expectMsgAnyClassOf[C](obj: Class[_ <: C]*): C
Same as
expectMsgAnyClassOf(remainingOrDefault, obj...)
, but correctly treating the timeFactor. - def expectMsgAnyOf[T](max: FiniteDuration, 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
- def expectMsgAnyOf[T](obj: T*): T
Same as
expectMsgAnyOf(remainingOrDefault, obj...)
, but correctly treating the timeFactor. - def expectMsgClass[C](max: FiniteDuration, 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
- def expectMsgClass[C](c: Class[C]): C
Same as
expectMsgClass(remainingOrDefault, c)
, but correctly treating the timeFactor. - def expectMsgPF[T](max: Duration = Duration.Undefined, 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
- def expectMsgType[T](max: FiniteDuration)(implicit t: ClassTag[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
- def expectMsgType[T](implicit t: ClassTag[T]): T
Same as
expectMsgType[T](remainingOrDefault)
, but correctly treating the timeFactor. - def expectNoMessage(): Unit
Assert that no message is received.
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". - def expectNoMessage(max: FiniteDuration): Unit
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.
- def expectTerminated(target: ActorRef, max: Duration = Duration.Undefined): Terminated
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.- target
the actor ref expected to be Terminated
- max
wait no more than max time, otherwise throw AssertionFailure
- returns
the received Terminated message
- def fishForMessage(max: Duration = Duration.Undefined, hint: String = "")(f: PartialFunction[Any, Boolean]): Any
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.
- returns
the last received message, i.e. the first one for which the partial function returned true
- def fishForSpecificMessage[T](max: Duration = Duration.Undefined, hint: String = "")(f: PartialFunction[Any, T]): T
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.
- returns
result of applying partial function to the last received message, i.e. the first one for which the partial function is defined
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def ignoreMsg(f: PartialFunction[Any, Boolean]): Unit
Ignore all messages in the test actor for which the given partial function returns true.
- def ignoreNoMsg(): Unit
Stop ignoring messages in the test actor.
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def lastSender: ActorRef
- def msgAvailable: Boolean
Query queue status.
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def now: FiniteDuration
Obtain current time (
System.nanoTime
) as Duration. - def receiveN(n: Int, max: FiniteDuration): Seq[AnyRef]
Receive N messages in a row before the given deadline.
- def receiveN(n: Int): Seq[AnyRef]
Same as
receiveN(n, remaining)
but correctly taking into account Duration.timeFactor. - 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!
- def receiveWhile[T](max: Duration = Duration.Undefined, idle: Duration = Duration.Inf, messages: Int = Int.MaxValue)(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 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)
- def remaining: FiniteDuration
Obtain time remaining for execution of the innermost enclosing
within
block or throw an AssertionError if nowithin
block surrounds this call. - def remainingOr(duration: FiniteDuration): FiniteDuration
Obtain time remaining for execution of the innermost enclosing
within
block or missing that it returns the given duration. - def remainingOrDefault: FiniteDuration
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"). - def setAutoPilot(pilot: AutoPilot): Unit
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.
- def shutdown(actorSystem: ActorSystem = system, duration: Duration = Duration.Undefined, verifySystemShutdown: Boolean = false): Unit
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.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- lazy val testActor: ActorRef
ActorRef of the test actor.
ActorRef of the test actor. Access is provided to enable e.g. registration as message target.
- def testActorName: String
Defines the testActor name.
Defines the testActor name.
- Attributes
- protected
- def testKitSettings: TestKitSettings
- def toString(): String
- Definition Classes
- AnyRef → Any
- def unwatch(ref: ActorRef): ActorRef
Have the testActor stop watching someone (i.e.
Have the testActor stop watching someone (i.e.
context.unwatch(...)
). - final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def watch(ref: ActorRef): ActorRef
Have the testActor watch someone (i.e.
Have the testActor watch someone (i.e.
context.watch(...)
). - def within[T](max: FiniteDuration)(f: => T): T
Same as calling
within(0 seconds, max)(f)
. - def within[T](min: FiniteDuration, max: FiniteDuration)(f: => T): T
Execute code block while bounding its execution time between
min
andmax
.Execute code block while bounding its execution time between
min
andmax
.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 enclosingwithin
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]) }
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from TestKitBase toStringFormat[TestKitBase] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (TestKitBase, B)
- Implicit
- This member is added by an implicit conversion from TestKitBase toArrowAssoc[TestKitBase] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->
instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.