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

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

    Access to the Kafka AdminClient which life

    Access to the Kafka AdminClient which life

    Definition Classes
    KafkaTestKit
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def awaitAssert[A](a: ⇒ A, max: Duration, interval: Duration): A
    Definition Classes
    TestKitBase
  9. def awaitCond(p: ⇒ Boolean, max: Duration, interval: Duration, message: String): Unit
    Definition Classes
    TestKitBase
  10. def awaitMultiple[T](d: FiniteDuration, futures: Future[T]*): Seq[T]
    Definition Classes
    KafkaSpec
  11. def awaitProduce(futures: Future[Done]*): Unit
    Definition Classes
    KafkaSpec
  12. 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
  13. def bootstrapServers: String
    Definition Classes
    TestcontainersKafkaLikeSpecKafkaTestKit
  14. def brokerContainers: Vector[AlpakkaKafkaContainer]
    Definition Classes
    TestcontainersKafkaLikeSpec
  15. def childActorOf(props: Props): ActorRef
    Definition Classes
    TestKitBase
  16. def childActorOf(props: Props, name: String): ActorRef
    Definition Classes
    TestKitBase
  17. def childActorOf(props: Props, supervisorStrategy: SupervisorStrategy): ActorRef
    Definition Classes
    TestKitBase
  18. def childActorOf(props: Props, name: String, supervisorStrategy: SupervisorStrategy): ActorRef
    Definition Classes
    TestKitBase
  19. def cleanUp(): Unit
    Definition Classes
    TestcontainersKafkaLikeKafkaSpec
  20. def cleanUpAdminClient(): Unit

    Close internal admin client instances.

    Close internal admin client instances.

    Definition Classes
    KafkaTestKit
  21. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  22. def committerDefaults: CommitterSettings
    Definition Classes
    KafkaTestKit
  23. def consumerDefaults: ConsumerSettings[String, String]
    Definition Classes
    KafkaTestKit
  24. 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
  25. def createGroupId(): String

    Return a unique group id with a default suffix.

    Return a unique group id with a default suffix.

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

    Return a unique topic name.

    Return a unique topic name.

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

    Return a unique transactional id with a default suffix.

    Return a unique transactional id with a default suffix.

    Definition Classes
    KafkaTestKit
  37. implicit val ec: ExecutionContext
    Definition Classes
    KafkaSpec
  38. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  39. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  40. def expectMsg[T](max: FiniteDuration, hint: String, obj: T): T
    Definition Classes
    TestKitBase
  41. def expectMsg[T](max: FiniteDuration, obj: T): T
    Definition Classes
    TestKitBase
  42. def expectMsg[T](obj: T): T
    Definition Classes
    TestKitBase
  43. def expectMsgAllClassOf[T](max: FiniteDuration, obj: Class[_ <: T]*): Seq[T]
    Definition Classes
    TestKitBase
  44. def expectMsgAllClassOf[T](obj: Class[_ <: T]*): Seq[T]
    Definition Classes
    TestKitBase
  45. def expectMsgAllConformingOf[T](max: FiniteDuration, obj: Class[_ <: T]*): Seq[T]
    Definition Classes
    TestKitBase
  46. def expectMsgAllConformingOf[T](obj: Class[_ <: T]*): Seq[T]
    Definition Classes
    TestKitBase
  47. def expectMsgAllOf[T](max: FiniteDuration, obj: T*): Seq[T]
    Definition Classes
    TestKitBase
  48. def expectMsgAllOf[T](obj: T*): Seq[T]
    Definition Classes
    TestKitBase
  49. def expectMsgAnyClassOf[C](max: FiniteDuration, obj: Class[_ <: C]*): C
    Definition Classes
    TestKitBase
  50. def expectMsgAnyClassOf[C](obj: Class[_ <: C]*): C
    Definition Classes
    TestKitBase
  51. def expectMsgAnyOf[T](max: FiniteDuration, obj: T*): T
    Definition Classes
    TestKitBase
  52. def expectMsgAnyOf[T](obj: T*): T
    Definition Classes
    TestKitBase
  53. def expectMsgClass[C](max: FiniteDuration, c: Class[C]): C
    Definition Classes
    TestKitBase
  54. def expectMsgClass[C](c: Class[C]): C
    Definition Classes
    TestKitBase
  55. def expectMsgPF[T](max: Duration, hint: String)(f: PartialFunction[Any, T]): T
    Definition Classes
    TestKitBase
  56. def expectMsgType[T](max: FiniteDuration)(implicit t: ClassTag[T]): T
    Definition Classes
    TestKitBase
  57. def expectMsgType[T](implicit t: ClassTag[T]): T
    Definition Classes
    TestKitBase
  58. def expectNoMessage(): Unit
    Definition Classes
    TestKitBase
  59. def expectNoMessage(max: FiniteDuration): Unit
    Definition Classes
    TestKitBase
  60. def expectTerminated(target: ActorRef, max: Duration): Terminated
    Definition Classes
    TestKitBase
  61. def fishForMessage(max: Duration, hint: String)(f: PartialFunction[Any, Boolean]): Any
    Definition Classes
    TestKitBase
  62. def fishForSpecificMessage[T](max: Duration, hint: String)(f: PartialFunction[Any, T]): T
    Definition Classes
    TestKitBase
  63. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  64. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  65. def ignoreMsg(f: PartialFunction[Any, Boolean]): Unit
    Definition Classes
    TestKitBase
  66. def ignoreNoMsg(): Unit
    Definition Classes
    TestKitBase
  67. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  68. def kafkaPort: Int
    Definition Classes
    TestcontainersKafkaLikeSpecKafkaSpec
  69. def lastSender: ActorRef
    Definition Classes
    TestKitBase
  70. val log: Logger
    Definition Classes
    KafkaSpecKafkaTestKit
  71. implicit val mat: Materializer
    Definition Classes
    KafkaSpec
  72. def msgAvailable: Boolean
    Definition Classes
    TestKitBase
  73. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  74. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  75. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  76. def now: FiniteDuration
    Definition Classes
    TestKitBase
  77. val partition0: Int
    Definition Classes
    KafkaSpec
  78. def periodicalCheck[T](description: String, maxTries: Int, sleepInBetween: FiniteDuration)(data: () ⇒ T)(predicate: (T) ⇒ Boolean): Unit
    Definition Classes
    KafkaSpec
  79. 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
  80. 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
  81. 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
  82. def produceString(topic: String, range: Seq[String], partition: Int = partition0): Future[Done]
    Definition Classes
    KafkaSpec
  83. def produceTimestamped(topic: String, timestampedRange: Seq[(Int, Long)]): Future[Done]
    Definition Classes
    KafkaSpec
  84. def producerDefaults: ProducerSettings[String, String]
    Definition Classes
    KafkaTestKit
  85. def receiveN(n: Int, max: FiniteDuration): Seq[AnyRef]
    Definition Classes
    TestKitBase
  86. def receiveN(n: Int): Seq[AnyRef]
    Definition Classes
    TestKitBase
  87. def receiveOne(max: Duration): AnyRef
    Definition Classes
    TestKitBase
  88. def receiveWhile[T](max: Duration, idle: Duration, messages: Int)(f: PartialFunction[AnyRef, T]): Seq[T]
    Definition Classes
    TestKitBase
  89. def remaining: FiniteDuration
    Definition Classes
    TestKitBase
  90. def remainingOr(duration: FiniteDuration): FiniteDuration
    Definition Classes
    TestKitBase
  91. def remainingOrDefault: FiniteDuration
    Definition Classes
    TestKitBase
  92. implicit val scheduler: Scheduler
    Definition Classes
    KafkaSpec
  93. def setAutoPilot(pilot: AutoPilot): Unit
    Definition Classes
    TestKitBase
  94. def setUp(): Unit
    Definition Classes
    TestcontainersKafkaLikeKafkaSpec
  95. 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
  96. val settings: KafkaTestkitSettings
    Definition Classes
    KafkaTestKit
  97. def shutdown(actorSystem: ActorSystem, duration: Duration, verifySystemShutdown: Boolean): Unit
    Definition Classes
    TestKitBase
  98. def sleep(time: FiniteDuration, msg: String = ""): Unit
    Definition Classes
    KafkaSpec
  99. def sleepAfterProduce: FiniteDuration
    Definition Classes
    KafkaSpec
  100. def sleepMillis(ms: Long, msg: String): Unit
    Definition Classes
    KafkaTestKit
  101. def sleepQuietly(time: FiniteDuration): Unit
    Definition Classes
    KafkaSpec
  102. def sleepSeconds(s: Int, msg: String): Unit
    Definition Classes
    KafkaTestKit
  103. def startKafka(settings: KafkaTestkitTestcontainersSettings): String
    Definition Classes
    TestcontainersKafkaLikeSpec
  104. def stopKafka(): Unit
    Definition Classes
    TestcontainersKafkaLikeSpec
  105. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  106. implicit val system: ActorSystem
    Definition Classes
    TestKit → TestKitBase
  107. val testActor: ActorRef
    Definition Classes
    TestKitBase
  108. def testActorName: String
    Attributes
    protected
    Definition Classes
    TestKitBase
  109. val testKitSettings: TestKitSettings
    Definition Classes
    TestKitBase
  110. var testProducer: Producer[String, String]
    Definition Classes
    KafkaSpec
  111. 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
  112. def toString(): String
    Definition Classes
    AnyRef → Any
  113. def unwatch(ref: ActorRef): ActorRef
    Definition Classes
    TestKitBase
  114. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  115. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  116. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  117. 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
  118. 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
  119. 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
  120. def watch(ref: ActorRef): ActorRef
    Definition Classes
    TestKitBase
  121. def within[T](max: FiniteDuration)(f: ⇒ T): T
    Definition Classes
    TestKitBase
  122. def within[T](min: FiniteDuration, max: FiniteDuration)(f: ⇒ T): T
    Definition Classes
    TestKitBase
  123. val zooKeeperPort: Int
    Definition Classes
    KafkaSpec
  124. 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