Packages

t

akka.kafka.testkit.scaladsl

TestcontainersKafkaLike

trait TestcontainersKafkaLike extends KafkaSpec with Spec

Uses Testcontainers to start a Kafka cluster in a Docker container. This trait will start Kafka only once per test session. To create a Kafka cluster per test class see TestcontainersKafkaPerClassLike.

The Testcontainers dependency has to be added explicitly.

Source
TestcontainersKafkaLike.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TestcontainersKafkaLike
  2. Spec
  3. KafkaSpec
  4. KafkaTestKit
  5. TestKit
  6. TestKitBase
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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. implicit val adapter: LoggingAdapter
    Definition Classes
    KafkaSpec
  8. def adminClient: AdminClient

    Access to the Kafka AdminClient which life

    Access to the Kafka AdminClient which life

    Definition Classes
    KafkaTestKit
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def awaitAssert[A](a: => A, max: Duration, interval: Duration): A
    Definition Classes
    TestKitBase
  11. def awaitCond(p: => Boolean, max: Duration, interval: Duration, message: String): Unit
    Definition Classes
    TestKitBase
  12. def awaitMultiple[T](d: FiniteDuration, futures: Future[T]*): Seq[T]
    Definition Classes
    KafkaSpec
  13. def awaitProduce(futures: Future[Done]*): Unit
    Definition Classes
    KafkaSpec
  14. def batchMessagesExpected(topics: Seq[String], batches: Int, batchSize: Int): (Seq[String], Long)

    Messages expected from #produceBatches generation.

    Messages expected from #produceBatches generation.

    Definition Classes
    KafkaSpec
  15. def bootstrapServers: String
    Definition Classes
    TestcontainersKafkaLikeSpecKafkaTestKit
  16. def brokerContainers: Vector[AlpakkaKafkaContainer]
    Definition Classes
    TestcontainersKafkaLikeSpec
  17. def childActorOf(props: Props): ActorRef
    Definition Classes
    TestKitBase
  18. def childActorOf(props: Props, name: String): ActorRef
    Definition Classes
    TestKitBase
  19. def childActorOf(props: Props, supervisorStrategy: SupervisorStrategy): ActorRef
    Definition Classes
    TestKitBase
  20. def childActorOf(props: Props, name: String, supervisorStrategy: SupervisorStrategy): ActorRef
    Definition Classes
    TestKitBase
  21. def cleanUp(): Unit
    Definition Classes
    TestcontainersKafkaLikeKafkaSpec
  22. def cleanUpAdminClient(): Unit

    Close internal admin client instances.

    Close internal admin client instances.

    Definition Classes
    KafkaTestKit
  23. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  24. def committerDefaults: CommitterSettings
    Definition Classes
    KafkaTestKit
  25. def consumerDefaults[K, V](keyDeserializer: Deserializer[K], valueDeserializer: Deserializer[V]): ConsumerSettings[K, V]
    Definition Classes
    KafkaTestKit
  26. def consumerDefaults(): ConsumerSettings[String, String]
    Definition Classes
    KafkaTestKit
  27. 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
  28. def createGroupId(): String

    Return a unique group id with a default suffix.

    Return a unique group id with a default suffix.

    Definition Classes
    KafkaTestKit
  29. def createProbe(consumerSettings: ConsumerSettings[String, String], topic: String*): (Control, Probe[String])
    Definition Classes
    KafkaSpec
  30. 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
  31. 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
  32. 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
  33. 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
  34. 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
  35. 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
  36. def createTopicName(suffix: Int): String

    Return a unique topic name.

    Return a unique topic name.

    Definition Classes
    KafkaTestKit
  37. def createTopics(topics: Int*): Seq[String]
    Definition Classes
    KafkaSpec
  38. 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
  39. def createTransactionalId(): String

    Return a unique transactional id with a default suffix.

    Return a unique transactional id with a default suffix.

    Definition Classes
    KafkaTestKit
  40. implicit val ec: ExecutionContext
    Definition Classes
    KafkaSpec
  41. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  42. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  43. def expectMsg[T](max: FiniteDuration, hint: String, obj: T): T
    Definition Classes
    TestKitBase
  44. def expectMsg[T](max: FiniteDuration, obj: T): T
    Definition Classes
    TestKitBase
  45. def expectMsg[T](obj: T): T
    Definition Classes
    TestKitBase
  46. def expectMsgAllClassOf[T](max: FiniteDuration, obj: Class[_ <: T]*): Seq[T]
    Definition Classes
    TestKitBase
  47. def expectMsgAllClassOf[T](obj: Class[_ <: T]*): Seq[T]
    Definition Classes
    TestKitBase
  48. def expectMsgAllConformingOf[T](max: FiniteDuration, obj: Class[_ <: T]*): Seq[T]
    Definition Classes
    TestKitBase
  49. def expectMsgAllConformingOf[T](obj: Class[_ <: T]*): Seq[T]
    Definition Classes
    TestKitBase
  50. def expectMsgAllOf[T](max: FiniteDuration, obj: T*): Seq[T]
    Definition Classes
    TestKitBase
  51. def expectMsgAllOf[T](obj: T*): Seq[T]
    Definition Classes
    TestKitBase
  52. def expectMsgAnyClassOf[C](max: FiniteDuration, obj: Class[_ <: C]*): C
    Definition Classes
    TestKitBase
  53. def expectMsgAnyClassOf[C](obj: Class[_ <: C]*): C
    Definition Classes
    TestKitBase
  54. def expectMsgAnyOf[T](max: FiniteDuration, obj: T*): T
    Definition Classes
    TestKitBase
  55. def expectMsgAnyOf[T](obj: T*): T
    Definition Classes
    TestKitBase
  56. def expectMsgClass[C](max: FiniteDuration, c: Class[C]): C
    Definition Classes
    TestKitBase
  57. def expectMsgClass[C](c: Class[C]): C
    Definition Classes
    TestKitBase
  58. def expectMsgPF[T](max: Duration, hint: String)(f: PartialFunction[Any, T]): T
    Definition Classes
    TestKitBase
  59. def expectMsgType[T](max: FiniteDuration)(implicit t: ClassTag[T]): T
    Definition Classes
    TestKitBase
  60. def expectMsgType[T](implicit t: ClassTag[T]): T
    Definition Classes
    TestKitBase
  61. def expectNoMessage(): Unit
    Definition Classes
    TestKitBase
  62. def expectNoMessage(max: FiniteDuration): Unit
    Definition Classes
    TestKitBase
  63. def expectTerminated(target: ActorRef, max: Duration): Terminated
    Definition Classes
    TestKitBase
  64. def fishForMessage(max: Duration, hint: String)(f: PartialFunction[Any, Boolean]): Any
    Definition Classes
    TestKitBase
  65. def fishForSpecificMessage[T](max: Duration, hint: String)(f: PartialFunction[Any, T]): T
    Definition Classes
    TestKitBase
  66. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  67. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  68. def ignoreMsg(f: PartialFunction[Any, Boolean]): Unit
    Definition Classes
    TestKitBase
  69. def ignoreNoMsg(): Unit
    Definition Classes
    TestKitBase
  70. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  71. def kafkaPort: Int
    Definition Classes
    TestcontainersKafkaLikeSpecKafkaSpec
  72. def lastSender: ActorRef
    Definition Classes
    TestKitBase
  73. val log: Logger
    Definition Classes
    KafkaSpecKafkaTestKit
  74. implicit val mat: Materializer
    Definition Classes
    KafkaSpec
  75. def msgAvailable: Boolean
    Definition Classes
    TestKitBase
  76. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  77. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  78. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  79. def now: FiniteDuration
    Definition Classes
    TestKitBase
  80. val partition0: Int
    Definition Classes
    KafkaSpec
  81. def periodicalCheck[T](description: String, maxTries: Int, sleepInBetween: FiniteDuration)(data: () => T)(predicate: (T) => Boolean): Unit
    Definition Classes
    KafkaSpec
  82. def produce(topic: String, range: Range, settings: ProducerSettings[String, String]): Future[Done]

    Produce messages to topic using specified range and return a Future so the caller can synchronize consumption.

    Produce messages to topic using specified range and return a Future so the caller can synchronize consumption.

    Definition Classes
    KafkaSpec
  83. def produce(topic: String, range: Seq[Int], partition: Int = partition0): Future[Done]

    Produce messages to topic using specified range and return a Future so the caller can synchronize consumption.

    Produce messages to topic using specified range and return a Future so the caller can synchronize consumption.

    Definition Classes
    KafkaSpec
  84. def produceBatches(topics: Seq[String], batches: Int, batchSize: Int): Future[Seq[Done]]

    Produce batches over several topics.

    Produce batches over several topics.

    Definition Classes
    KafkaSpec
  85. def produceString(topic: String, range: Seq[String], partition: Int = partition0): Future[Done]
    Definition Classes
    KafkaSpec
  86. def produceTimestamped(topic: String, timestampedRange: Seq[(Int, Long)]): Future[Done]
    Definition Classes
    KafkaSpec
  87. def producerDefaults[K, V](keySerializer: Serializer[K], valueSerializer: Serializer[V]): ProducerSettings[K, V]
    Definition Classes
    KafkaTestKit
  88. def producerDefaults: ProducerSettings[String, String]
    Definition Classes
    KafkaTestKit
  89. def receiveN(n: Int, max: FiniteDuration): Seq[AnyRef]
    Definition Classes
    TestKitBase
  90. def receiveN(n: Int): Seq[AnyRef]
    Definition Classes
    TestKitBase
  91. def receiveOne(max: Duration): AnyRef
    Definition Classes
    TestKitBase
  92. def receiveWhile[T](max: Duration, idle: Duration, messages: Int)(f: PartialFunction[AnyRef, T]): Seq[T]
    Definition Classes
    TestKitBase
  93. def remaining: FiniteDuration
    Definition Classes
    TestKitBase
  94. def remainingOr(duration: FiniteDuration): FiniteDuration
    Definition Classes
    TestKitBase
  95. def remainingOrDefault: FiniteDuration
    Definition Classes
    TestKitBase
  96. implicit val scheduler: Scheduler
    Definition Classes
    KafkaSpec
  97. def setAutoPilot(pilot: AutoPilot): Unit
    Definition Classes
    TestKitBase
  98. def setUp(): Unit
    Definition Classes
    TestcontainersKafkaLikeKafkaSpec
  99. 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
  100. val settings: KafkaTestkitSettings
    Definition Classes
    KafkaTestKit
  101. def shutdown(actorSystem: ActorSystem, duration: Duration, verifySystemShutdown: Boolean): Unit
    Definition Classes
    TestKitBase
  102. def sleep(time: FiniteDuration, msg: String = ""): Unit
    Definition Classes
    KafkaSpec
  103. def sleepAfterProduce: FiniteDuration
    Definition Classes
    KafkaSpec
  104. def sleepMillis(ms: Long, msg: String): Unit
    Definition Classes
    KafkaTestKit
  105. def sleepQuietly(time: FiniteDuration): Unit
    Definition Classes
    KafkaSpec
  106. def sleepSeconds(s: Int, msg: String): Unit
    Definition Classes
    KafkaTestKit
  107. def startKafka(settings: KafkaTestkitTestcontainersSettings): String
    Definition Classes
    TestcontainersKafkaLikeSpec
  108. def stopKafka(): Unit
    Definition Classes
    TestcontainersKafkaLikeSpec
  109. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  110. implicit val system: ActorSystem
    Definition Classes
    TestKit → TestKitBase
  111. val testActor: ActorRef
    Definition Classes
    TestKitBase
  112. def testActorName: String
    Attributes
    protected
    Definition Classes
    TestKitBase
  113. val testKitSettings: TestKitSettings
    Definition Classes
    TestKitBase
  114. var testProducer: Producer[String, String]
    Definition Classes
    KafkaSpec
  115. val testcontainersSettings: KafkaTestkitTestcontainersSettings

    Override this to change default settings for starting the Kafka testcontainers cluster.

    Override this to change default settings for starting the Kafka testcontainers cluster.

    Definition Classes
    Spec
  116. def toString(): String
    Definition Classes
    AnyRef → Any
  117. def unwatch(ref: ActorRef): ActorRef
    Definition Classes
    TestKitBase
  118. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  119. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  120. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  121. def waitUntilCluster()(predicate: (DescribeClusterResult) => Boolean): 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
    KafkaSpec
  122. def waitUntilConsumerGroup(groupId: String)(predicate: (ConsumerGroupDescription) => Boolean): 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
    KafkaSpec
  123. def waitUntilConsumerSummary(groupId: String)(predicate: PartialFunction[List[MemberDescription], Boolean]): 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
    KafkaSpec
  124. def watch(ref: ActorRef): ActorRef
    Definition Classes
    TestKitBase
  125. def within[T](max: FiniteDuration)(f: => T): T
    Definition Classes
    TestKitBase
  126. def within[T](min: FiniteDuration, max: FiniteDuration)(f: => T): T
    Definition Classes
    TestKitBase
  127. val zooKeeperPort: Int
    Definition Classes
    KafkaSpec
  128. def zookeeperContainer: GenericContainer[_]
    Definition Classes
    TestcontainersKafkaLikeSpec

Deprecated Value Members

  1. def confluentPlatformVersion: String

    Override this to select a different Kafka version be choosing the desired version of Confluent Platform: Available Docker images, Kafka versions in Confluent Platform

    Override this to select a different Kafka version be choosing the desired version of Confluent Platform: Available Docker images, Kafka versions in Confluent Platform

    Deprecated: set Confluent Platform version in KafkaTestkitTestcontainersSettings

    Definition Classes
    Spec
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) Use testcontainersSettings instead.

  2. def expectNoMsg(max: FiniteDuration): Unit
    Definition Classes
    TestKitBase
    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.5) Use expectNoMessage instead

  3. def expectNoMsg(): Unit
    Definition Classes
    TestKitBase
    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.5) Use expectNoMessage instead

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from Spec

Inherited from KafkaSpec

Inherited from KafkaTestKit

Inherited from TestKit

Inherited from TestKitBase

Inherited from AnyRef

Inherited from Any

Ungrouped