Skip to content

kafka.md

Latest commit

 

History

History
75 lines (53 loc) · 3.23 KB

kafka.md

File metadata and controls

75 lines (53 loc) · 3.23 KB
Raw

Kafka Containers

Testcontainers can be used to automatically instantiate and manage Apache Kafka containers. More precisely Testcontainers uses the official Docker images for Confluent OSS Platform

Benefits

  • Running a single node Kafka installation with just one line of code
  • No need to manage external Zookeeper installation, required by Kafka. But see below

Example

Create a KafkaContainer to use it in your tests:

Creating a KafkaContainer inside_block:constructorWithVersion

The correspondence between Confluent Platform versions and Kafka versions can be seen in Confluent documentation

Now your tests or any other process running on your machine can get access to running Kafka broker by using the following bootstrap server location:

Bootstrap Servers inside_block:getBootstrapServers

Options

Using external Zookeeper

If for some reason you want to use an externally running Zookeeper, then just pass its location during construction:

External Zookeeper inside_block:withExternalZookeeper

Using Kraft mode

The self-managed (Kraft) mode is available as a preview feature since version 3.0 (confluentinc/cp-kafka:7.0.x) and declared as a production ready in 3.3.1 (confluentinc/cp-kafka:7.3.x).

Kraft mode inside_block:withKraftMode

See the versions interoperability matrix for more details.

Multi-container usage

If your test needs to run some other Docker container which needs access to Kafka, do the following:

  • Run your other container on the same network as Kafka container, e.g.:

Network inside_block:withKafkaNetwork

  • Use kafka.getNetworkAliases().get(0)+":9092" as bootstrap server location. Or just give your Kafka container a network alias of your liking.

You will need to explicitly create a network and set it on the Kafka container as well as on your other containers that need to communicate with Kafka.

Adding this module to your project dependencies

Add the following dependency to your pom.xml/build.gradle file:

=== "Gradle" groovy testImplementation "org.testcontainers:kafka:{{latest_version}}" === "Maven" xml <dependency> <groupId>org.testcontainers</groupId> <artifactId>kafka</artifactId> <version>{{latest_version}}</version> <scope>test</scope> </dependency>