org.testcontainers.containers

Class KafkaContainer

java.lang.Object

org.testcontainers.containers.FailureDetectingExternalResource

org.testcontainers.containers.GenericContainer<KafkaContainer>

org.testcontainers.containers.KafkaContainer

All Implemented Interfaces:

java.lang.AutoCloseable, org.junit.rules.TestRule, org.testcontainers.containers.Container<KafkaContainer>, org.testcontainers.containers.ContainerState, org.testcontainers.containers.traits.LinkableContainer, org.testcontainers.containers.wait.strategy.WaitStrategyTarget, org.testcontainers.lifecycle.Startable

public class KafkaContainer
extends org.testcontainers.containers.GenericContainer<KafkaContainer>

Testcontainers implementation for Apache Kafka. Zookeeper can be optionally configured.

Supported image: confluentinc/cp-kafka

Exposed ports:

• Kafka: 9093
• Zookeeper: 2181

Nested Class Summary

Nested classes/interfaces inherited from interface org.testcontainers.containers.Container

org.testcontainers.containers.Container.ExecResult

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CLUSTER_ID
protected java.lang.String	externalZookeeperConnect
static int	KAFKA_PORT
static int	ZOOKEEPER_PORT

Fields inherited from class org.testcontainers.containers.GenericContainer

CONTAINER_RUNNING_TIMEOUT_SEC, dependencies, dockerClient, INTERNAL_HOST_HOSTNAME, waitStrategy

Fields inherited from interface org.testcontainers.containers.ContainerState

STATE_HEALTHY

Constructor Summary

Constructors

Constructor and Description
KafkaContainer() Deprecated. use KafkaContainer(DockerImageName) instead
KafkaContainer(org.testcontainers.utility.DockerImageName dockerImageName)
KafkaContainer(java.lang.String confluentPlatformVersion) Deprecated. use KafkaContainer(DockerImageName) instead

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	brokerAdvertisedListener(com.github.dockerjava.api.command.InspectContainerResponse containerInfo)
protected java.lang.String	commandKraft()
protected java.lang.String	commandZookeeper()
protected void	configure()
protected void	configureKraft()
protected void	configureZookeeper()
protected void	containerIsStarting(com.github.dockerjava.api.command.InspectContainerResponse containerInfo)
java.lang.String	getBootstrapServers()
KafkaContainer	withClusterId(java.lang.String clusterId)
KafkaContainer	withEmbeddedZookeeper()
KafkaContainer	withExternalZookeeper(java.lang.String connectString)
KafkaContainer	withKraft()
KafkaContainer	withListener(java.util.function.Supplier<java.lang.String> listenerSupplier) Add a Supplier that will provide a listener with format host:port.

Methods inherited from class org.testcontainers.containers.GenericContainer

addEnv, addExposedPort, addExposedPorts, addFileSystemBind, addFixedExposedPort, addFixedExposedPort, addLink, apply, canBeReused, containerIsCreated, containerIsStarted, containerIsStarted, containerIsStarting, containerIsStopped, containerIsStopping, copyFileFromContainer, createVolumeDirectory, dependsOn, dependsOn, dependsOn, doStart, equals, failed, finished, getBinds, getCommandParts, getContainerId, getContainerInfo, getContainerName, getCopyToFileContainerPathMap, getCreateContainerCmdModifiers, getDependencies, getDockerClient, getDockerImageName, getEnv, getEnvMap, getExposedPorts, getExtraHosts, getImage, getIpAddress, getLabels, getLinkedContainers, getLivenessCheckPort, getLivenessCheckPortNumbers, getLivenessCheckPorts, getLogConsumers, getNetwork, getNetworkAliases, getNetworkMode, getPortBindings, getShmSize, getStartupAttempts, getStartupCheckStrategy, getTestHostIpAddress, getTmpFsMapping, getVolumesFroms, getWaitStrategy, getWorkingDirectory, hashCode, isHostAccessible, isPrivilegedMode, isShouldBeReused, logger, setBinds, setCommand, setCommand, setCommandParts, setContainerDef, setCopyToFileContainerPathMap, setDockerImageName, setEnv, setExposedPorts, setExtraHosts, setHostAccessible, setImage, setLabels, setLinkedContainers, setLogConsumers, setNetwork, setNetworkAliases, setNetworkMode, setPortBindings, setPrivilegedMode, setShmSize, setStartupAttempts, setStartupCheckStrategy, setTmpFsMapping, setVolumesFroms, setWaitStrategy, setWorkingDirectory, start, starting, stop, succeeded, toString, waitingFor, waitUntilContainerStarted, withAccessToHost, withClasspathResourceMapping, withClasspathResourceMapping, withCommand, withCommand, withCopyFileToContainer, withCopyToContainer, withCreateContainerCmdModifier, withEnv, withEnv, withExposedPorts, withExtraHost, withFileSystemBind, withImagePullPolicy, withLabel, withLabels, withLogConsumer, withMinimumRunningDuration, withNetwork, withNetworkAliases, withNetworkMode, withPrivilegedMode, withReuse, withSharedMemorySize, withStartupAttempts, withStartupCheckStrategy, withStartupTimeout, withTmpFs, withVolumesFrom, withWorkingDirectory

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.testcontainers.containers.Container

addFileSystemBind, followOutput, followOutput, self, withEnv, withFileSystemBind

Methods inherited from interface org.testcontainers.containers.ContainerState

copyFileFromContainer, copyFileToContainer, copyFileToContainer, execInContainer, execInContainer, execInContainerWithUser, execInContainerWithUser, getBoundPortNumbers, getContainerIpAddress, getCurrentContainerInfo, getFirstMappedPort, getHost, getLogs, getLogs, getMappedPort, isCreated, isHealthy, isRunning

Methods inherited from interface org.testcontainers.lifecycle.Startable

close

Field Detail

KAFKA_PORT

public static final int KAFKA_PORT

See Also:

Constant Field Values

ZOOKEEPER_PORT

public static final int ZOOKEEPER_PORT

See Also:

Constant Field Values

DEFAULT_CLUSTER_ID

public static final java.lang.String DEFAULT_CLUSTER_ID

See Also:

Constant Field Values

externalZookeeperConnect

protected java.lang.String externalZookeeperConnect

Constructor Detail

KafkaContainer

@Deprecated
public KafkaContainer()

Deprecated. use KafkaContainer(DockerImageName) instead

KafkaContainer

@Deprecated
public KafkaContainer(java.lang.String confluentPlatformVersion)

Deprecated. use KafkaContainer(DockerImageName) instead

KafkaContainer

public KafkaContainer(org.testcontainers.utility.DockerImageName dockerImageName)

Method Detail

withEmbeddedZookeeper

public KafkaContainer withEmbeddedZookeeper()

withExternalZookeeper

public KafkaContainer withExternalZookeeper(java.lang.String connectString)

withKraft

public KafkaContainer withKraft()

withClusterId

public KafkaContainer withClusterId(java.lang.String clusterId)

getBootstrapServers

public java.lang.String getBootstrapServers()

configure

protected void configure()

Overrides:

configure in class org.testcontainers.containers.GenericContainer<KafkaContainer>

configureKraft

protected void configureKraft()

configureZookeeper

protected void configureZookeeper()

containerIsStarting

protected void containerIsStarting(com.github.dockerjava.api.command.InspectContainerResponse containerInfo)

Overrides:

containerIsStarting in class org.testcontainers.containers.GenericContainer<KafkaContainer>

commandKraft

protected java.lang.String commandKraft()

commandZookeeper

protected java.lang.String commandZookeeper()

withListener

public KafkaContainer withListener(java.util.function.Supplier<java.lang.String> listenerSupplier)

Add a Supplier that will provide a listener with format host:port. Host will be added as a network alias.

The listener will be added to the list of default listeners.

Default listeners:

• 0.0.0.0:9092
• 0.0.0.0:9093

Default advertised listeners:

• container.getHost():container.getMappedPort(9093)
• container.getConfig().getHostName():9092

Parameters:

listenerSupplier - a supplier that will provide a listener

Returns:

this KafkaContainer instance

brokerAdvertisedListener

protected java.lang.String brokerAdvertisedListener(com.github.dockerjava.api.command.InspectContainerResponse containerInfo)