abstract class KafkaSpec extends TestKit with KafkaTestKit
- Alphabetic
- By Inheritance
- KafkaSpec
- KafkaTestKit
- TestKit
- TestKitBase
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
Abstract Value Members
- abstract def bootstrapServers: String
- Definition Classes
- KafkaTestKit
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val DefaultKey: String
- Definition Classes
- KafkaTestKit
- val StringDeserializer: StringDeserializer
- Definition Classes
- KafkaTestKit
- val StringSerializer: StringSerializer
- Definition Classes
- KafkaTestKit
- implicit val adapter: LoggingAdapter
- def adminClient: Admin
Access to the Kafka Admin client
Access to the Kafka Admin client
- Definition Classes
- KafkaTestKit
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def assertForDuration[A](a: => A, max: FiniteDuration, interval: Duration): A
- Definition Classes
- TestKitBase
- def awaitAssert[A](a: => A, max: Duration, interval: Duration): A
- Definition Classes
- TestKitBase
- def awaitCond(p: => Boolean, max: Duration, interval: Duration, message: String): Unit
- Definition Classes
- TestKitBase
- def awaitMultiple[T](d: FiniteDuration, futures: Future[T]*): Seq[T]
- def awaitProduce(futures: Future[Done]*): Unit
- def batchMessagesExpected(topics: Seq[String], batches: Int, batchSize: Int): (Seq[String], Long)
Messages expected from #produceBatches generation.
- def childActorOf(props: Props): ActorRef
- Definition Classes
- TestKitBase
- def childActorOf(props: Props, name: String): ActorRef
- Definition Classes
- TestKitBase
- def childActorOf(props: Props, supervisorStrategy: SupervisorStrategy): ActorRef
- Definition Classes
- TestKitBase
- def childActorOf(props: Props, name: String, supervisorStrategy: SupervisorStrategy): ActorRef
- Definition Classes
- TestKitBase
- def cleanUp(): Unit
- def cleanUpAdminClient(): Unit
Close internal admin client instances.
Close internal admin client instances.
- Definition Classes
- KafkaTestKit
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def committerDefaults: CommitterSettings
- Definition Classes
- KafkaTestKit
- def consumerDefaults[K, V](keyDeserializer: Deserializer[K], valueDeserializer: Deserializer[V]): ConsumerSettings[K, V]
- Definition Classes
- KafkaTestKit
- def consumerDefaults: ConsumerSettings[String, String]
- Definition Classes
- KafkaTestKit
- 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
- def createGroupId(): String
Return a unique group id with a default suffix.
Return a unique group id with a default suffix.
- Definition Classes
- KafkaTestKit
- def createProbe(consumerSettings: ConsumerSettings[String, String], topic: String*): (Control, Probe[String])
- 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
- 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
- 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
- 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
- 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
- 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
- def createTopicName(suffix: Int): String
Return a unique topic name.
Return a unique topic name.
- Definition Classes
- KafkaTestKit
- def createTopics(topics: Int*): Seq[String]
- implicit val ec: ExecutionContext
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def expectMsg[T](max: FiniteDuration, hint: String, obj: T): T
- Definition Classes
- TestKitBase
- def expectMsg[T](max: FiniteDuration, obj: T): T
- Definition Classes
- TestKitBase
- def expectMsg[T](obj: T): T
- Definition Classes
- TestKitBase
- def expectMsgAllClassOf[T](max: FiniteDuration, obj: Class[_ <: T]*): Seq[T]
- Definition Classes
- TestKitBase
- def expectMsgAllClassOf[T](obj: Class[_ <: T]*): Seq[T]
- Definition Classes
- TestKitBase
- def expectMsgAllConformingOf[T](max: FiniteDuration, obj: Class[_ <: T]*): Seq[T]
- Definition Classes
- TestKitBase
- def expectMsgAllConformingOf[T](obj: Class[_ <: T]*): Seq[T]
- Definition Classes
- TestKitBase
- def expectMsgAllOf[T](max: FiniteDuration, obj: T*): Seq[T]
- Definition Classes
- TestKitBase
- def expectMsgAllOf[T](obj: T*): Seq[T]
- Definition Classes
- TestKitBase
- def expectMsgAnyClassOf[C](max: FiniteDuration, obj: Class[_ <: C]*): C
- Definition Classes
- TestKitBase
- def expectMsgAnyClassOf[C](obj: Class[_ <: C]*): C
- Definition Classes
- TestKitBase
- def expectMsgAnyOf[T](max: FiniteDuration, obj: T*): T
- Definition Classes
- TestKitBase
- def expectMsgAnyOf[T](obj: T*): T
- Definition Classes
- TestKitBase
- def expectMsgClass[C](max: FiniteDuration, c: Class[C]): C
- Definition Classes
- TestKitBase
- def expectMsgClass[C](c: Class[C]): C
- Definition Classes
- TestKitBase
- def expectMsgPF[T](max: Duration, hint: String)(f: PartialFunction[Any, T]): T
- Definition Classes
- TestKitBase
- def expectMsgType[T](max: FiniteDuration)(implicit t: ClassTag[T]): T
- Definition Classes
- TestKitBase
- def expectMsgType[T](implicit t: ClassTag[T]): T
- Definition Classes
- TestKitBase
- def expectNoMessage(): Unit
- Definition Classes
- TestKitBase
- def expectNoMessage(max: FiniteDuration): Unit
- Definition Classes
- TestKitBase
- def expectTerminated(target: ActorRef, max: Duration): Terminated
- Definition Classes
- TestKitBase
- def fishForMessage(max: Duration, hint: String)(f: PartialFunction[Any, Boolean]): Any
- Definition Classes
- TestKitBase
- def fishForSpecificMessage[T](max: Duration, hint: String)(f: PartialFunction[Any, T]): T
- Definition Classes
- TestKitBase
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def ignoreMsg(f: PartialFunction[Any, Boolean]): Unit
- Definition Classes
- TestKitBase
- def ignoreNoMsg(): Unit
- Definition Classes
- TestKitBase
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def kafkaPort: Int
- def lastSender: ActorRef
- Definition Classes
- TestKitBase
- val log: Logger
- Definition Classes
- KafkaSpec → KafkaTestKit
- implicit val mat: Materializer
- def msgAvailable: Boolean
- Definition Classes
- TestKitBase
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def now: FiniteDuration
- Definition Classes
- TestKitBase
- val partition0: Int
- def periodicalCheck[T](description: String, maxTries: Int, sleepInBetween: FiniteDuration)(data: () => T)(predicate: (T) => Boolean): Unit
- 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.
- 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.
- def produceBatches(topics: Seq[String], batches: Int, batchSize: Int): Future[Seq[Done]]
Produce batches over several topics.
- def produceString(topic: String, range: Seq[String], partition: Int = partition0): Future[Done]
- def produceTimestamped(topic: String, timestampedRange: Seq[(Int, Long)]): Future[Done]
- def producerDefaults[K, V](keySerializer: Serializer[K], valueSerializer: Serializer[V]): ProducerSettings[K, V]
- Definition Classes
- KafkaTestKit
- def producerDefaults: ProducerSettings[String, String]
- Definition Classes
- KafkaTestKit
- def receiveN(n: Int, max: FiniteDuration): Seq[AnyRef]
- Definition Classes
- TestKitBase
- def receiveN(n: Int): Seq[AnyRef]
- Definition Classes
- TestKitBase
- def receiveOne(max: Duration): AnyRef
- Definition Classes
- TestKitBase
- def receiveWhile[T](max: Duration, idle: Duration, messages: Int)(f: PartialFunction[AnyRef, T]): Seq[T]
- Definition Classes
- TestKitBase
- def remaining: FiniteDuration
- Definition Classes
- TestKitBase
- def remainingOr(duration: FiniteDuration): FiniteDuration
- Definition Classes
- TestKitBase
- def remainingOrDefault: FiniteDuration
- Definition Classes
- TestKitBase
- implicit val scheduler: Scheduler
- def setAutoPilot(pilot: AutoPilot): Unit
- Definition Classes
- TestKitBase
- def setUp(): Unit
- def setUpAdminClient(): Unit
Create internal admin clients.
Create internal admin clients. Gives access to
adminClient
, be sure to callcleanUpAdminClient
after the tests are done.- Definition Classes
- KafkaTestKit
- val settings: KafkaTestkitSettings
- Definition Classes
- KafkaTestKit
- def shutdown(actorSystem: ActorSystem, duration: Duration, verifySystemShutdown: Boolean): Unit
- Definition Classes
- TestKitBase
- def sleep(time: FiniteDuration, msg: String = ""): Unit
- def sleepAfterProduce: FiniteDuration
- def sleepMillis(ms: Long, msg: String): Unit
- Definition Classes
- KafkaTestKit
- def sleepQuietly(time: FiniteDuration): Unit
- def sleepSeconds(s: Int, msg: String): Unit
- Definition Classes
- KafkaTestKit
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- implicit val system: ActorSystem
- Definition Classes
- TestKit → TestKitBase
- lazy val testActor: ActorRef
- Definition Classes
- TestKitBase
- def testActorName: String
- Attributes
- protected
- Definition Classes
- TestKitBase
- def testKitSettings: TestKitSettings
- Definition Classes
- TestKitBase
- var testProducer: Producer[String, String]
- def toString(): String
- Definition Classes
- AnyRef → Any
- def unwatch(ref: ActorRef): ActorRef
- Definition Classes
- TestKitBase
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- 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.
- 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.
- 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.
- def watch(ref: ActorRef): ActorRef
- Definition Classes
- TestKitBase
- def within[T](max: FiniteDuration)(f: => T): T
- Definition Classes
- TestKitBase
- def within[T](min: FiniteDuration, max: FiniteDuration)(f: => T): T
- Definition Classes
- TestKitBase
- val zooKeeperPort: Int
Deprecated Value Members
- 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
- Annotations
- @deprecated
- Deprecated
Use flows and sinks that does not require an explicit transaction id
- def createTransactionalId(): String
Return a unique transactional id with a default suffix.
Return a unique transactional id with a default suffix.
- Definition Classes
- KafkaTestKit
- Annotations
- @deprecated
- Deprecated
Use flows and sinks that does not require an explicit transaction id
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)