final class TestKitJunitResource extends ExternalResource
A Junit external resource for the ActorTestKit, making it possible to have Junit manage the lifecycle of the testkit. The testkit will be automatically shut down when the test completes or fails.
Note that Junit is not provided as a transitive dependency of the testkit module but must be added explicitly to your project to use this.
Example:
public class MyActorTest { @ClassRule public static final TestKitResource testKit = new TestKitResource(); @Test public void testBlah() throws Exception { // spawn actors etc using the testKit ActorRef<Message> ref = testKit.spawn(behavior); } }
By default config is loaded from application-test.conf
if that exists, otherwise
using default configuration from the reference.conf resources that ship with the Akka libraries.
The application.conf of your project is not used in this case.
A specific configuration can be passed as constructor parameter.
- Alphabetic
- By Inheritance
- TestKitJunitResource
- ExternalResource
- TestRule
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new TestKitJunitResource(customConfig: Config, settings: TestKitSettings)
Use a custom config for the actor system, and a custom akka.actor.testkit.typed.TestKitSettings.
- new TestKitJunitResource(customConfig: Config)
Use a custom config for the actor system.
- new TestKitJunitResource(customConfig: String)
Use a custom config for the actor system.
- new TestKitJunitResource(system: typed.ActorSystem[_])
Use a custom akka.actor.typed.ActorSystem for the actor system.
- new TestKitJunitResource()
Config loaded from
application-test.conf
if that exists, otherwise using default configuration from the reference.conf resources that ship with the Akka libraries.Config loaded from
application-test.conf
if that exists, otherwise using default configuration from the reference.conf resources that ship with the Akka libraries. The application.conf of your project is not used in this case. - new TestKitJunitResource(_kit: ActorTestKit)
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 TestKitJunitResource toany2stringadd[TestKitJunitResource] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (TestKitJunitResource, B)
- Implicit
- This member is added by an implicit conversion from TestKitJunitResource toArrowAssoc[TestKitJunitResource] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def after(): Unit
- Definition Classes
- TestKitJunitResource → ExternalResource
- def apply(arg0: Statement, arg1: Description): Statement
- Definition Classes
- ExternalResource → TestRule
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def before(): Unit
- Attributes
- protected[rules]
- Definition Classes
- ExternalResource
- Annotations
- @throws(classOf[java.lang.Throwable])
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- def createDeadLetterProbe(): TestProbe[DeadLetter]
See corresponding method on ActorTestKit
- def createDroppedMessageProbe(): TestProbe[Dropped]
See corresponding method on ActorTestKit
- def createTestProbe[M](name: String): TestProbe[M]
See corresponding method on ActorTestKit
- def createTestProbe[M](name: String, clazz: Class[M]): TestProbe[M]
See corresponding method on ActorTestKit
- def createTestProbe[M](clazz: Class[M]): TestProbe[M]
See corresponding method on ActorTestKit
- def createTestProbe[M](): TestProbe[M]
See corresponding method on ActorTestKit
- def createUnhandledMessageProbe(): TestProbe[UnhandledMessage]
See corresponding method on ActorTestKit
- def ensuring(cond: (TestKitJunitResource) => Boolean, msg: => Any): TestKitJunitResource
- Implicit
- This member is added by an implicit conversion from TestKitJunitResource toEnsuring[TestKitJunitResource] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (TestKitJunitResource) => Boolean): TestKitJunitResource
- Implicit
- This member is added by an implicit conversion from TestKitJunitResource toEnsuring[TestKitJunitResource] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): TestKitJunitResource
- Implicit
- This member is added by an implicit conversion from TestKitJunitResource toEnsuring[TestKitJunitResource] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): TestKitJunitResource
- Implicit
- This member is added by an implicit conversion from TestKitJunitResource toEnsuring[TestKitJunitResource] 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
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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 scheduler: typed.Scheduler
See corresponding method on ActorTestKit
- def serializationTestKit: SerializationTestKit
Additional testing utilities for serialization.
- def spawn[T](behavior: Behavior[T], name: String, props: typed.Props): typed.ActorRef[T]
See corresponding method on ActorTestKit
- def spawn[T](behavior: Behavior[T], props: typed.Props): typed.ActorRef[T]
See corresponding method on ActorTestKit
- def spawn[T](behavior: Behavior[T], name: String): typed.ActorRef[T]
See corresponding method on ActorTestKit
- def spawn[T](behavior: Behavior[T]): typed.ActorRef[T]
See corresponding method on ActorTestKit
- def stop[T](ref: typed.ActorRef[T]): Unit
See corresponding method on ActorTestKit
- def stop[T](ref: typed.ActorRef[T], max: Duration): Unit
See corresponding method on ActorTestKit
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def system: typed.ActorSystem[Void]
See corresponding method on ActorTestKit
- val testKit: ActorTestKit
- def testKitSettings: TestKitSettings
See corresponding method on ActorTestKit
- def timeout: Timeout
See corresponding method on ActorTestKit
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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])
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 TestKitJunitResource toStringFormat[TestKitJunitResource] 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): (TestKitJunitResource, B)
- Implicit
- This member is added by an implicit conversion from TestKitJunitResource toArrowAssoc[TestKitJunitResource] 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.