Packages

c

akka.actor.testkit.typed.javadsl

TestKitJunitResource

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.

Source
TestKitJunitResource.scala
Linear Supertypes
ExternalResource, TestRule, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TestKitJunitResource
  2. ExternalResource
  3. TestRule
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TestKitJunitResource(customConfig: Config, settings: TestKitSettings)

    Use a custom config for the actor system, and a custom akka.actor.testkit.typed.TestKitSettings.

  2. new TestKitJunitResource(customConfig: Config)

    Use a custom config for the actor system.

  3. new TestKitJunitResource(customConfig: String)

    Use a custom config for the actor system.

  4. new TestKitJunitResource(system: typed.ActorSystem[_])

    Use a custom akka.actor.typed.ActorSystem for the actor system.

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

  6. new TestKitJunitResource(_kit: ActorTestKit)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. 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
  4. 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()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def after(): Unit
    Definition Classes
    TestKitJunitResource → ExternalResource
  7. def apply(arg0: Statement, arg1: Description): Statement
    Definition Classes
    ExternalResource → TestRule
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def before(): Unit
    Attributes
    protected[org.junit.rules]
    Definition Classes
    ExternalResource
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  11. def createDeadLetterProbe(): TestProbe[DeadLetter]

    See corresponding method on ActorTestKit

  12. def createDroppedMessageProbe(): TestProbe[Dropped]

    See corresponding method on ActorTestKit

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

    See corresponding method on ActorTestKit

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

    See corresponding method on ActorTestKit

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

    See corresponding method on ActorTestKit

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

    See corresponding method on ActorTestKit

  17. def createUnhandledMessageProbe(): TestProbe[UnhandledMessage]

    See corresponding method on ActorTestKit

  18. 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
  19. 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
  20. 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
  21. 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
  22. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  24. 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
    @inline()
  25. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  31. def scheduler: typed.Scheduler

    See corresponding method on ActorTestKit

  32. def serializationTestKit: SerializationTestKit

    Additional testing utilities for serialization.

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

    See corresponding method on ActorTestKit

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

    See corresponding method on ActorTestKit

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

    See corresponding method on ActorTestKit

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

    See corresponding method on ActorTestKit

  37. def stop[T](ref: typed.ActorRef[T]): Unit

    See corresponding method on ActorTestKit

  38. def stop[T](ref: typed.ActorRef[T], max: Duration): Unit

    See corresponding method on ActorTestKit

  39. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  40. def system: typed.ActorSystem[Void]

    See corresponding method on ActorTestKit

  41. val testKit: ActorTestKit
  42. def testKitSettings: TestKitSettings

    See corresponding method on ActorTestKit

  43. def timeout: Timeout

    See corresponding method on ActorTestKit

  44. def toString(): String
    Definition Classes
    AnyRef → Any
  45. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  46. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  47. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

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

Inherited from ExternalResource

Inherited from TestRule

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromTestKitJunitResource to any2stringadd[TestKitJunitResource]

Inherited by implicit conversion StringFormat fromTestKitJunitResource to StringFormat[TestKitJunitResource]

Inherited by implicit conversion Ensuring fromTestKitJunitResource to Ensuring[TestKitJunitResource]

Inherited by implicit conversion ArrowAssoc fromTestKitJunitResource to ArrowAssoc[TestKitJunitResource]

Ungrouped