Packages

o

zio.kafka.testkit

KafkaTestUtils

object KafkaTestUtils

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. KafkaTestUtils
  2. AnyRef
  3. 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 adminSettings: ZIO[Kafka, Nothing, AdminClientSettings]

    Default AdminClient settings.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. def consumeWithStrings(clientId: String, groupId: Option[String] = None, subscription: Subscription)(r: (ConsumerRecord[String, String]) => URIO[Any, Unit]): RIO[Kafka, Unit]

    Utility function consume a stream of ConsumerRecords.

    Utility function consume a stream of ConsumerRecords.

    For each consumed record, the provided r function will be called.

  8. def consumer(clientId: String, groupId: Option[String] = None, clientInstanceId: Option[String] = None, offsetRetrieval: OffsetRetrieval = OffsetRetrieval.Auto(AutoOffsetStrategy.Earliest), allowAutoCreateTopics: Boolean = true, diagnostics: Diagnostics = Diagnostics.NoOp, restartStreamOnRebalancing: Boolean = false, rebalanceSafeCommits: Boolean = false, maxRebalanceDuration: zio.Duration = 3.minutes, commitTimeout: zio.Duration = ConsumerSettings.defaultCommitTimeout, properties: Map[String, String] = Map.empty): ZLayer[Kafka, Throwable, Consumer]

    Utility function to make a Consumer.

  9. def consumerSettings(clientId: String, groupId: Option[String] = None, clientInstanceId: Option[String] = None, allowAutoCreateTopics: Boolean = true, offsetRetrieval: OffsetRetrieval = OffsetRetrieval.Auto(AutoOffsetStrategy.Earliest), restartStreamOnRebalancing: Boolean = false, rebalanceSafeCommits: Boolean = false, maxRebalanceDuration: zio.Duration = 3.minutes, maxPollInterval: zio.Duration = 5.minutes, max.poll.records: Int = 100, commitTimeout: zio.Duration = ConsumerSettings.defaultCommitTimeout, properties: Map[String, String] = Map.empty): URIO[Kafka, ConsumerSettings]

    Utility function to make a Consumer settings set.

  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def minimalConsumer(diagnostics: Diagnostics = Diagnostics.NoOp): ZLayer[ConsumerSettings, Throwable, Consumer]

    Utility function to make a Consumer.

    Utility function to make a Consumer. It requires a ConsumerSettings layer.

    "minimal" because, unlike the other functions returning a ZLayer[..., ..., Consumer] of this file, you need to provide the ConsumerSettings layer yourself.

  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  19. def produceMany(topic: String, kvs: Iterable[(String, String)]): ZIO[Producer, Throwable, Chunk[RecordMetadata]]

    Utility function to produce many messages in a Topic.

  20. def produceMany(topic: String, partition: Int, kvs: Iterable[(String, String)]): ZIO[Producer, Throwable, Chunk[RecordMetadata]]

    Utility function to produce many messages in give Partition of a Topic.

  21. def produceOne(topic: String, key: String, message: String): ZIO[Producer, Throwable, RecordMetadata]

    Utility function to produce a single message in a Topic.

  22. val producer: ZLayer[Kafka, Throwable, Producer]

    Producer instance you can use in your tests.

    Producer instance you can use in your tests. It uses the default Producer settings.

  23. val producerSettings: ZIO[Kafka, Nothing, ProducerSettings]

    Default Producer settings you can use in your tests

  24. def saslAdminSettings(username: String, password: String): ZIO[Sasl, Nothing, AdminClientSettings]

    Utility function to make an AdminClient settings set using SASL_PLAINTEXT security protocol.

  25. def scheduledProduce[R](topic: String, schedule: Schedule[R, Any, Long]): ZStream[R with Producer, Throwable, RecordMetadata]

    A stream that produces messages to a Topic on a schedule for as long as it is running.

  26. val sslAdminSettings: ZIO[Kafka, Nothing, AdminClientSettings]

    Default AdminClient settings using SSL security protocol.

  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. def transactionalConsumer(clientId: String, groupId: String, clientInstanceId: Option[String] = None, offsetRetrieval: OffsetRetrieval = OffsetRetrieval.Auto(AutoOffsetStrategy.Earliest), allowAutoCreateTopics: Boolean = true, diagnostics: Diagnostics = Diagnostics.NoOp, restartStreamOnRebalancing: Boolean = false, rebalanceSafeCommits: Boolean = false, properties: Map[String, String] = Map.empty, rebalanceListener: RebalanceListener = RebalanceListener.noop): ZLayer[Kafka, Throwable, Consumer]

    Utility function to make a transactional Consumer.

  30. def transactionalConsumerSettings(groupId: String, clientId: String, clientInstanceId: Option[String] = None, allowAutoCreateTopics: Boolean = true, offsetRetrieval: OffsetRetrieval = OffsetRetrieval.Auto(AutoOffsetStrategy.Earliest), restartStreamOnRebalancing: Boolean = false, rebalanceSafeCommits: Boolean = false, properties: Map[String, String] = Map.empty): URIO[Kafka, ConsumerSettings]

    Utility function to make a transactional Consumer settings set.

  31. def transactionalProducer(transactionalId: String): ZLayer[Kafka, Throwable, TransactionalProducer]
  32. val transactionalProducer: ZLayer[Kafka, Throwable, TransactionalProducer]

    Transactional producer instance you can use in your tests.

    Transactional producer instance you can use in your tests. It uses the default transactional producer settings.

    Note: to run multiple tests in parallel, you need to use different transactional ids via transactionalProducer(transactionalId).

  33. def transactionalProducerSettings(transactionalId: String): ZIO[Kafka, Nothing, TransactionalProducerSettings]
  34. val transactionalProducerSettings: ZIO[Kafka, Nothing, TransactionalProducerSettings]

    Default transactional producer settings you can use in your tests.

    Default transactional producer settings you can use in your tests.

    Note: to run multiple tests in parallel, you need to use different transactional ids via transactionalProducerSettings(transactionalId).

  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  37. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. def withAdmin[T](f: (AdminClient) => RIO[Kafka, T]): ZIO[Kafka, Throwable, T]

    Utility function to execute something with an AdminClient instance configure with the default settings.

  39. def withSaslAdmin[T](username: String = "admin", password: String = "admin-secret")(f: (AdminClient) => RIO[Sasl, T]): ZIO[Sasl, Throwable, T]

    Utility function to execute something with an AdminClient instance configured to use the SASL_PLAINTEXT security protocol.

  40. def withSslAdmin[T](f: (AdminClient) => RIO[Kafka, T]): ZIO[Kafka, Throwable, T]

    Utility function to execute something with an AdminClient instance configured to use the SSL security protocol.

Deprecated Value Members

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

    (Since version 9)

  2. def simpleConsumer(diagnostics: Diagnostics = Diagnostics.NoOp): ZLayer[ConsumerSettings, Throwable, Consumer]

    Utility function to make a Consumer.

    Utility function to make a Consumer. It requires a ConsumerSettings layer.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.3.1) Use KafkaTestUtils.minimalConsumer instead

Inherited from AnyRef

Inherited from Any

Ungrouped