Package akka.javasdk.testkit.junit.jupiter

Class TestkitExtension

Object
akka.javasdk.testkit.junit.jupiter.TestkitExtension
All Implemented Interfaces:
org.junit.jupiter.api.extension.AfterAllCallback, org.junit.jupiter.api.extension.BeforeAllCallback, org.junit.jupiter.api.extension.Extension
public final class TestkitExtension extends Object implements org.junit.jupiter.api.extension.BeforeAllCallback, org.junit.jupiter.api.extension.AfterAllCallback
A JUnit 5 "Jupiter" Extension for TestKit, which automatically manages the lifecycle of the testkit. The testkit will be automatically stopped when the test completes or fails.

  • Constructor Details

    • TestkitExtension

      public TestkitExtension()

    • TestkitExtension

      public TestkitExtension(TestKit.Settings settings)

  • Method Details

    • afterAll

      public void afterAll(org.junit.jupiter.api.extension.ExtensionContext extensionContext) throws Exception
      JUnit5 support - extension based
      Specified by:
      afterAll in interface org.junit.jupiter.api.extension.AfterAllCallback
      Throws:
      Exception

    • beforeAll

      public void beforeAll(org.junit.jupiter.api.extension.ExtensionContext extensionContext) throws Exception
      JUnit5 support - extension based
      Specified by:
      beforeAll in interface org.junit.jupiter.api.extension.BeforeAllCallback
      Throws:
      Exception

    • getValueEntityIncomingMessages

      @Deprecated(since="3.4.2", forRemoval=true) public EventingTestKit.IncomingMessages getValueEntityIncomingMessages(String typeId)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use getValueEntityIncomingMessages(Class) instead.
      Get incoming messages for ValueEntity.
      Parameters:
      typeId - @TypeId or entity_type of the ValueEntity (depending on the used SDK)

    • getValueEntityIncomingMessages

      public EventingTestKit.IncomingMessages getValueEntityIncomingMessages(Class<? extends akka.javasdk.keyvalueentity.KeyValueEntity<?>> keyValueEntityClass)
      Get incoming messages for ValueEntity.
      Parameters:
      keyValueEntityClass - class of the KeyValueEntity

    • getEventSourcedEntityIncomingMessages

      @Deprecated(since="3.4.2", forRemoval=true) public EventingTestKit.IncomingMessages getEventSourcedEntityIncomingMessages(String typeId)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use getEventSourcedEntityIncomingMessages(Class) instead.
      Get incoming messages for EventSourcedEntity.
      Parameters:
      typeId - @TypeId or entity_type of the EventSourcedEntity (depending on the used SDK)

    • getEventSourcedEntityIncomingMessages

      public EventingTestKit.IncomingMessages getEventSourcedEntityIncomingMessages(Class<? extends akka.javasdk.eventsourcedentity.EventSourcedEntity<?,?>> eventSourcedEntityClass)
      Get incoming messages for EventSourcedEntity.
      Parameters:
      eventSourcedEntityClass - class of the EventSourcedEntity

    • getWorkflowIncomingMessages

      public EventingTestKit.IncomingMessages getWorkflowIncomingMessages(Class<? extends akka.javasdk.workflow.Workflow<?>> workflowClass)
      Get incoming messages for Workflow.
      Parameters:
      workflowClass - class of the Workflow

    • getStreamIncomingMessages

      public EventingTestKit.IncomingMessages getStreamIncomingMessages(String service, String streamId)
      Get incoming messages for Stream (eventing.in.direct in case of protobuf SDKs).
      Parameters:
      service - service name
      streamId - service stream id

    • getTopicIncomingMessages

      public EventingTestKit.IncomingMessages getTopicIncomingMessages(String topic)
      Get incoming messages for Topic.
      Parameters:
      topic - topic name

    • getTopicOutgoingMessages

      public EventingTestKit.OutgoingMessages getTopicOutgoingMessages(String topic)
      Get mocked topic destination.
      Parameters:
      topic - topic name

    • getMessageBuilder

      public EventingTestKit.MessageBuilder getMessageBuilder()
      Returns EventingTestKit.MessageBuilder utility to create EventingTestKit.Messages for the eventing testkit.

    • getHost

      public String getHost()
      Get the host name/IP address where the service is available. This is relevant in certain Continuous Integration environments.

    • getPort

      public int getPort()
      Get the local port where the Kalix service is available.

    • getMaterializer

      public akka.stream.Materializer getMaterializer()
      An Akka Stream materializer to use for running streams. Needed for example in a command handler which accepts streaming elements but returns a single async reply once all streamed elements has been consumed.

    • getActorSystem

      public akka.actor.typed.ActorSystem<?> getActorSystem()
      Get an ActorSystem for creating Akka HTTP clients.
      Returns:
      test actor system