io.strimzi.test.container

Class StrimziKafkaContainer

java.lang.Object

org.testcontainers.containers.FailureDetectingExternalResource

org.testcontainers.containers.GenericContainer<StrimziKafkaContainer>

io.strimzi.test.container.StrimziKafkaContainer

All Implemented Interfaces:

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

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

StrimziKafkaContainer is a single-node instance of Kafka using the image from quay.io/strimzi/kafka with the given version. There are two options for how to use it. The first one is using an embedded zookeeper which will run inside Kafka container. The Another option is to use @StrimziZookeeperContainer as an external Zookeeper. The additional configuration for Kafka broker can be injected via constructor. This container is a good fit for integration testing but for more hardcore testing we suggest using @StrimziKafkaCluster.

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 int	KAFKA_PORT Default Kafka port
static String	STARTER_SCRIPT The file containing the startup script.

Fields inherited from class org.testcontainers.containers.GenericContainer

CONTAINER_RUNNING_TIMEOUT_SEC, INTERNAL_HOST_HOSTNAME

Fields inherited from interface org.testcontainers.containers.ContainerState

STATE_HEALTHY

Constructor Summary

Constructors

Constructor and Description
StrimziKafkaContainer() Image name is specified lazily automatically in doStart() method
StrimziKafkaContainer(String dockerImageName) Image name is specified by dockerImageName

Method Summary

Modifier and Type	Method and Description
String	getBootstrapServers() Get bootstrap servers of @code{StrimziKafkaContainer} instance
String	getInternalZooKeeperConnect() Get internal ZooKeeper connect string, which is running in the same container as Kafka
StrimziKafkaContainer	waitForRunning() Fluent method, which sets a waiting strategy to wait until the broker is ready.
StrimziKafkaContainer	withBootstrapServers(Function<StrimziKafkaContainer,String> provider) Fluent method, assign provider for overriding bootstrap servers string
StrimziKafkaContainer	withBrokerId(int brokerId) Fluent method, which sets @code{brokerId}.
StrimziKafkaContainer	withExternalZookeeperConnect(String externalZookeeperConnect) Fluent method, which sets @code{externalZookeeperConnect}.
StrimziKafkaContainer	withKafkaConfigurationMap(Map<String,String> kafkaConfigurationMap) Fluent method, which sets @code{kafkaConfigurationMap}.
StrimziKafkaContainer	withKafkaVersion(String kafkaVersion) Fluent method, which sets @code{kafkaVersion}.
StrimziKafkaContainer	withKraft() Fluent method, which sets @code{useKraft}.
StrimziKafkaContainer	withPort(int fixedPort) Fluent method, which sets fixed exposed port.
StrimziKafkaContainer	withServerProperties(org.testcontainers.utility.MountableFile serverPropertiesFile) Fluent method, copy server properties file to the container

Methods inherited from class org.testcontainers.containers.GenericContainer

addEnv, addExposedPort, addExposedPorts, addFileSystemBind, addLink, apply, copyFileFromContainer, dependsOn, dependsOn, dependsOn, equals, getBinds, getCommandParts, getContainerId, getContainerInfo, getContainerName, getCopyToFileContainerPathMap, getCreateContainerCmdModifiers, getDependencies, getDockerClient, getDockerImageName, getEnv, getEnvMap, getExposedPorts, getExtraHosts, getImage, getIpAddress, getLabels, getLinkedContainers, getLivenessCheckPortNumbers, getLogConsumers, getNetwork, getNetworkAliases, getNetworkMode, getPortBindings, getShmSize, getStartupAttempts, getStartupCheckStrategy, getTestHostIpAddress, getTmpFsMapping, getVolumesFroms, getWorkingDirectory, hashCode, isPrivilegedMode, isShouldBeReused, setBinds, setCommand, setCommand, setCommandParts, setCopyToFileContainerPathMap, setDockerImageName, setEnv, setExposedPorts, setExtraHosts, setImage, setLabels, setLinkedContainers, setLogConsumers, setNetwork, setNetworkAliases, setNetworkMode, setPortBindings, setPrivilegedMode, setShmSize, setStartupAttempts, setStartupCheckStrategy, setTmpFsMapping, setVolumesFroms, setWaitStrategy, setWorkingDirectory, start, stop, toString, waitingFor, withClasspathResourceMapping, withClasspathResourceMapping, withCommand, withCommand, withCopyFileToContainer, 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

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, getBoundPortNumbers, getContainerIpAddress, getCurrentContainerInfo, getFirstMappedPort, getHost, getLogs, getLogs, getMappedPort, isCreated, isHealthy, isRunning

Methods inherited from interface org.testcontainers.lifecycle.Startable

close

Field Detail

STARTER_SCRIPT

public static final String STARTER_SCRIPT

The file containing the startup script.

See Also:

Constant Field Values

KAFKA_PORT

public static final int KAFKA_PORT

Default Kafka port

See Also:

Constant Field Values

Constructor Detail

StrimziKafkaContainer

public StrimziKafkaContainer()

Image name is specified lazily automatically in doStart() method

StrimziKafkaContainer

public StrimziKafkaContainer(String dockerImageName)

Image name is specified by dockerImageName

Parameters:

dockerImageName - specific docker image name provided by constructor parameter

Method Detail

waitForRunning

public StrimziKafkaContainer waitForRunning()

Fluent method, which sets a waiting strategy to wait until the broker is ready.

This method waits for a log message in the broker log. You can customize the strategy using GenericContainer.waitingFor(WaitStrategy).

Returns:

StrimziKafkaContainer instance

getInternalZooKeeperConnect

public String getInternalZooKeeperConnect()

Get internal ZooKeeper connect string, which is running in the same container as Kafka

Returns:

ZooKeeper connect string

getBootstrapServers

public String getBootstrapServers()

Get bootstrap servers of @code{StrimziKafkaContainer} instance

Returns:

bootstrap servers

withKafkaConfigurationMap

public StrimziKafkaContainer withKafkaConfigurationMap(Map<String,String> kafkaConfigurationMap)

Fluent method, which sets @code{kafkaConfigurationMap}.

Parameters:

kafkaConfigurationMap - kafka configuration

Returns:

StrimziKafkaContainer instance

withExternalZookeeperConnect

public StrimziKafkaContainer withExternalZookeeperConnect(String externalZookeeperConnect)

Fluent method, which sets @code{externalZookeeperConnect}.

If the broker was created using Kraft, this method throws an IllegalArgumentException.

Parameters:

externalZookeeperConnect - connect string

Returns:

StrimziKafkaContainer instance

withBrokerId

public StrimziKafkaContainer withBrokerId(int brokerId)

Fluent method, which sets @code{brokerId}.

Parameters:

brokerId - broker id

Returns:

StrimziKafkaContainer instance

withKafkaVersion

public StrimziKafkaContainer withKafkaVersion(String kafkaVersion)

Fluent method, which sets @code{kafkaVersion}.

Parameters:

kafkaVersion - kafka version

Returns:

StrimziKafkaContainer instance

withKraft

public StrimziKafkaContainer withKraft()

Fluent method, which sets @code{useKraft}.

Flag to signal if we deploy Kafka with ZooKeeper or not.

Returns:

StrimziKafkaContainer instance

withPort

public StrimziKafkaContainer withPort(int fixedPort)

Fluent method, which sets fixed exposed port.

Parameters:

fixedPort - fixed port to expose

Returns:

StrimziKafkaContainer instance

withServerProperties

public StrimziKafkaContainer withServerProperties(org.testcontainers.utility.MountableFile serverPropertiesFile)

Fluent method, copy server properties file to the container

Parameters:

serverPropertiesFile - the mountable config file

Returns:

StrimziKafkaContainer instance

withBootstrapServers

public StrimziKafkaContainer withBootstrapServers(Function<StrimziKafkaContainer,String> provider)

Fluent method, assign provider for overriding bootstrap servers string

Parameters:

provider - provider function for bootstrapServers string

Returns:

StrimziKafkaContainer instance