ActorTestKit

Java API: Test kit for asynchronous testing of typed actors. Provides a typed actor system started on creation, that can be used for multiple test cases and is shut down when shutdown is called.

The actor system has a custom guardian that allows for spawning arbitrary actors using the spawn methods.

Designed to work with any test framework, but framework glue code that calls shutdownTestKit after all tests has run needs to be provided by the user or with TestKitJunitResource.

Use TestKit.create factories to construct manually or TestKitJunitResource to use together with JUnit tests

For synchronous testing of a Behavior see BehaviorTestKit

Source: ActorTestKit.scala

Linear Supertypes

AnyRef, Any

Type Hierarchy

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from ActorTestKit to any2stringadd[ActorTestKit] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (ActorTestKit, B)

Implicit information
This member is added by an implicit conversion from ActorTestKit to ArrowAssoc[ActorTestKit] 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 clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def createTestProbe[M](name: String, clazz: Class[M]): TestProbe[M]

Shortcut for creating a new named test probe for the testkit actor system
Shortcut for creating a new named test probe for the testkit actor system
M
the type of messages the probe should accept
def createTestProbe[M](name: String): TestProbe[M]

Shortcut for creating a new named test probe for the testkit actor system
Shortcut for creating a new named test probe for the testkit actor system
M
the type of messages the probe should accept
def createTestProbe[M](clazz: Class[M]): TestProbe[M]

Shortcut for creating a new test probe for the testkit actor system
Shortcut for creating a new test probe for the testkit actor system
M
the type of messages the probe should accept
def createTestProbe[M](): TestProbe[M]

Shortcut for creating a new test probe for the testkit actor system
Shortcut for creating a new test probe for the testkit actor system
M
the type of messages the probe should accept
def ensuring(cond: (ActorTestKit) ⇒ Boolean, msg: ⇒ Any): ActorTestKit

Implicit information
This member is added by an implicit conversion from ActorTestKit to Ensuring[ActorTestKit] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (ActorTestKit) ⇒ Boolean): ActorTestKit

Implicit information
This member is added by an implicit conversion from ActorTestKit to Ensuring[ActorTestKit] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): ActorTestKit

Implicit information
This member is added by an implicit conversion from ActorTestKit to Ensuring[ActorTestKit] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): ActorTestKit

Implicit information
This member is added by an implicit conversion from ActorTestKit to Ensuring[ActorTestKit] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from ActorTestKit to StringFormat[ActorTestKit] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def scheduler: Scheduler

The scheduler of the testkit actor system
def shutdownTestKit(): Unit

Terminate the actor system and the testkit
def spawn[T](behavior: Behavior[T], name: String, props: typed.Props): typed.ActorRef[T]

Spawn a new named actor under the testkit user guardian with the given props and return the ActorRef for the spawned actor, note that spawning actors with the same name in multiple test cases will cause failures.
def spawn[T](behavior: Behavior[T], props: typed.Props): typed.ActorRef[T]

Spawn a new auto-named actor under the testkit user guardian with the given props and return the ActorRef for the spawned actor
def spawn[T](behavior: Behavior[T], name: String): typed.ActorRef[T]

Spawn a new named actor under the testkit user guardian and return the ActorRef for the spawned actor, note that spawning actors with the same name in multiple test cases will cause failures.
def spawn[T](behavior: Behavior[T]): typed.ActorRef[T]

Spawn a new auto-named actor under the testkit user guardian and return the ActorRef for the spawned actor
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def system: typed.ActorSystem[Void]

The actor system running for this testkit.
The actor system running for this testkit. Interaction with the user guardian is done through methods on the testkit which is why it is typed to Void.
def testKitSettings: TestKitSettings
def timeout: Timeout

The default timeout as specified with the config/akka.actor.testkit.typed.TestKitSettings
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (ActorTestKit, B)

Implicit information
This member is added by an implicit conversion from ActorTestKit to ArrowAssoc[ActorTestKit] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Related Docs: object ActorTestKit | package javadsl

final class ActorTestKit extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (ActorTestKit, B)

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def createTestProbe[M](name: String, clazz: Class[M]): TestProbe[M]

def createTestProbe[M](name: String): TestProbe[M]

def createTestProbe[M](clazz: Class[M]): TestProbe[M]

def createTestProbe[M](): TestProbe[M]

def ensuring(cond: (ActorTestKit) ⇒ Boolean, msg: ⇒ Any): ActorTestKit

def ensuring(cond: (ActorTestKit) ⇒ Boolean): ActorTestKit

def ensuring(cond: Boolean, msg: ⇒ Any): ActorTestKit

def ensuring(cond: Boolean): ActorTestKit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def scheduler: Scheduler

def shutdownTestKit(): Unit

def spawn[T](behavior: Behavior[T], name: String, props: typed.Props): typed.ActorRef[T]

def spawn[T](behavior: Behavior[T], props: typed.Props): typed.ActorRef[T]

def spawn[T](behavior: Behavior[T], name: String): typed.ActorRef[T]

def spawn[T](behavior: Behavior[T]): typed.ActorRef[T]

final def synchronized[T0](arg0: ⇒ T0): T0

def system: typed.ActorSystem[Void]

def testKitSettings: TestKitSettings

def timeout: Timeout

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def →[B](y: B): (ActorTestKit, B)

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ActorTestKit to any2stringadd[ActorTestKit]

Inherited by implicit conversion StringFormat from ActorTestKit to StringFormat[ActorTestKit]

Inherited by implicit conversion Ensuring from ActorTestKit to Ensuring[ActorTestKit]

Inherited by implicit conversion ArrowAssoc from ActorTestKit to ArrowAssoc[ActorTestKit]

Ungrouped