Packages

c

org.apache.pekko.kafka.testkit

TestcontainersKafkaTest

abstract class TestcontainersKafkaTest extends KafkaTest

JUnit 5 base class using Testcontainers to start a Kafka broker in a Docker container. The Kafka broker will be kept around across multiple test classes, unless stopKafka() is called (eg. from an @AfterAll-annotated method.

Extending classes must be annotated with @TestInstance(Lifecycle.PER_CLASS) to create a single instance of the test class with @BeforeAll and @AfterAll annotated methods called by the test framework.

The Testcontainers dependency has to be added explicitly.

Annotations
@SuppressWarnings()
Source
TestcontainersKafkaTest.java
Linear Supertypes
KafkaTest, BaseKafkaTest, KafkaTestKitClass, KafkaTestKit, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TestcontainersKafkaTest
  2. KafkaTest
  3. BaseKafkaTest
  4. KafkaTestKitClass
  5. KafkaTestKit
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TestcontainersKafkaTest(system: ActorSystem, settings: KafkaTestkitTestcontainersSettings)
    Attributes
    protected[testkit]
  2. new TestcontainersKafkaTest(system: ClassicActorSystemProvider)
    Attributes
    protected[testkit]
  3. new TestcontainersKafkaTest(system: ActorSystem, mat: Materializer)
    Attributes
    protected[testkit]
    Annotations
    @Deprecated
    Deprecated

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val DefaultKey: String
    Definition Classes
    KafkaTestKit
  5. val StringDeserializer: StringDeserializer
    Definition Classes
    KafkaTestKit
  6. val StringSerializer: StringSerializer
    Definition Classes
    KafkaTestKit
  7. def adminClient: Admin

    Access to the Kafka Admin client

    Access to the Kafka Admin client

    Definition Classes
    KafkaTestKit
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. val bootstrapServers: String
    Definition Classes
    KafkaTestKitClass → KafkaTestKit
  10. def checkForStageLeaks(): Unit
    Definition Classes
    KafkaTest
    Annotations
    @AfterEach()
  11. def cleanUpAdmin(): Unit
    Definition Classes
    KafkaTest
    Annotations
    @AfterAll()
  12. def cleanUpAdminClient(): Unit

    Close internal admin client instances.

    Close internal admin client instances.

    Definition Classes
    KafkaTestKit
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  14. def committerDefaults: CommitterSettings
    Definition Classes
    KafkaTestKit
  15. def consume[K, V](topic: String, take: Long, keyDeserializer: Deserializer[K], valueDeserializer: Deserializer[V]): DrainingControl[List[ConsumerRecord[K, V]]]
    Attributes
    protected[javadsl]
    Definition Classes
    BaseKafkaTest
  16. def consumeString(topic: String, take: Long): DrainingControl[List[ConsumerRecord[String, String]]]
    Attributes
    protected[javadsl]
    Definition Classes
    BaseKafkaTest
  17. def consumerDefaults[K, V](keyDeserializer: Deserializer[K], valueDeserializer: Deserializer[V]): ConsumerSettings[K, V]
    Definition Classes
    KafkaTestKit
  18. def consumerDefaults: ConsumerSettings[String, String]
    Definition Classes
    KafkaTestKit
  19. def createGroupId(suffix: Int): String

    Return a unique group id with a given suffix.

    Return a unique group id with a given suffix.

    Definition Classes
    KafkaTestKit
  20. def createGroupId(): String

    Return a unique group id with a default suffix.

    Return a unique group id with a default suffix.

    Definition Classes
    KafkaTestKit
  21. def createTopic(suffix: Int, partitions: Int, replication: Int, config: Map[String, String]): String

    Java Api

    Java Api

    Create a topic with given suffix, partition number, replication factor, and topic configuration.

    This method will block and return only when the topic has been successfully created.

    Definition Classes
    KafkaTestKit
  22. def createTopic(suffix: Int, partitions: Int, replication: Int, config: Map[String, String]): String

    Create a topic with given suffix, partition number, replication factor, and topic configuration.

    Create a topic with given suffix, partition number, replication factor, and topic configuration.

    This method will block and return only when the topic has been successfully created.

    Definition Classes
    KafkaTestKit
  23. def createTopic(suffix: Int, partitions: Int, replication: Int): String

    Create a topic with given suffix, partition number, replication factor, and no topic configuration.

    Create a topic with given suffix, partition number, replication factor, and no topic configuration.

    This method will block and return only when the topic has been successfully created.

    Definition Classes
    KafkaTestKit
  24. def createTopic(suffix: Int, partitions: Int): String

    Create a topic with a given suffix, partition number, a replication factor of one, and no topic configuration.

    Create a topic with a given suffix, partition number, a replication factor of one, and no topic configuration.

    This method will block and return only when the topic has been successfully created.

    Definition Classes
    KafkaTestKit
  25. def createTopic(suffix: Int): String

    Create a topic with a given suffix, single partitions, a replication factor of one, and no topic configuration.

    Create a topic with a given suffix, single partitions, a replication factor of one, and no topic configuration.

    This method will block and return only when the topic has been successfully created.

    Definition Classes
    KafkaTestKit
  26. def createTopic(): String

    Create a topic with a default suffix, single partition, a replication factor of one, and no topic configuration.

    Create a topic with a default suffix, single partition, a replication factor of one, and no topic configuration.

    This method will block and return only when the topic has been successfully created.

    Definition Classes
    KafkaTestKit
  27. def createTopicName(suffix: Int): String

    Return a unique topic name.

    Return a unique topic name.

    Definition Classes
    KafkaTestKit
  28. def createTransactionalId(suffix: Int): String

    Return a unique transactional id with a given suffix.

    Return a unique transactional id with a given suffix.

    Definition Classes
    KafkaTestKit
  29. def createTransactionalId(): String

    Return a unique transactional id with a default suffix.

    Return a unique transactional id with a default suffix.

    Definition Classes
    KafkaTestKit
  30. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  32. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  33. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  34. def getSchemaRegistryUrl(): String
    Attributes
    protected[testkit]
  35. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  36. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  37. def log(): Logger
    Definition Classes
    BaseKafkaTest → KafkaTestKit
    Annotations
    @Override()
  38. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  39. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  40. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  41. final def produce[K, V](topic: String, keySerializer: Serializer[K], valueSerializer: Serializer[V], messages: <repeated...>[Pair[K, V]]): CompletionStage[Done]
    Attributes
    protected[javadsl]
    Definition Classes
    BaseKafkaTest
    Annotations
    @SafeVarargs()
  42. def produceString(topic: String, message: String): CompletionStage[Done]
    Attributes
    protected[javadsl]
    Definition Classes
    BaseKafkaTest
  43. def produceString(topic: String, messageCount: Int, partition: Int): CompletionStage[Done]
    Attributes
    protected[javadsl]
    Definition Classes
    BaseKafkaTest
  44. def producerDefaults[K, V](keySerializer: Serializer[K], valueSerializer: Serializer[V]): ProducerSettings[K, V]
    Definition Classes
    KafkaTestKit
  45. def producerDefaults: ProducerSettings[String, String]
    Definition Classes
    KafkaTestKit
  46. def resultOf[T](stage: CompletionStage[T], timeout: Duration): T
    Attributes
    protected[javadsl]
    Definition Classes
    BaseKafkaTest
  47. def resultOf[T](stage: CompletionStage[T]): T
    Attributes
    protected[javadsl]
    Definition Classes
    BaseKafkaTest
  48. def resultOfTimeout(): Duration

    Overwrite to set different default timeout for resultOf.

    Overwrite to set different default timeout for resultOf.

    Attributes
    protected[javadsl]
    Definition Classes
    BaseKafkaTest
  49. def setUpAdminClient(): Unit

    Create internal admin clients.

    Create internal admin clients. Gives access to adminClient, be sure to call cleanUpAdminClient after the tests are done.

    Definition Classes
    KafkaTestKit
  50. val settings: KafkaTestkitSettings
    Definition Classes
    KafkaTestKit
  51. def setupAdmin(): Unit
    Definition Classes
    KafkaTest
    Annotations
    @BeforeAll()
  52. def sleepMillis(ms: Long, msg: String): Unit
    Definition Classes
    KafkaTestKit
  53. def sleepSeconds(s: Int, msg: String): Unit
    Definition Classes
    KafkaTestKit
  54. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  55. val system: ActorSystem
    Definition Classes
    KafkaTestKitClass → KafkaTestKit
  56. def toString(): String
    Definition Classes
    AnyRef → Any
  57. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  58. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  59. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  60. def waitUntilCluster(predicate: Predicate[DescribeClusterResult]): Unit

    Periodically checks if a given predicate on cluster state holds.

    Periodically checks if a given predicate on cluster state holds.

    If the predicate does not hold after configured amount of time, throws an exception.

    Definition Classes
    BaseKafkaTest
  61. def waitUntilConsumerGroup(groupId: String, predicate: Predicate[ConsumerGroupDescription]): Unit

    Periodically checks if the given predicate on consumer group state holds.

    Periodically checks if the given predicate on consumer group state holds.

    If the predicate does not hold after configured amount of time, throws an exception.

    Definition Classes
    BaseKafkaTest
  62. def waitUntilConsumerSummary(groupId: String, predicate: Predicate[Collection[MemberDescription]]): Unit

    Periodically checks if the given predicate on consumer summary holds.

    Periodically checks if the given predicate on consumer summary holds.

    If the predicate does not hold after configured amount of time, throws an exception.

    Definition Classes
    BaseKafkaTest

Inherited from KafkaTest

Inherited from BaseKafkaTest

Inherited from KafkaTestKitClass

Inherited from KafkaTestKit

Inherited from AnyRef

Inherited from Any

Ungrouped