Package io.kroxylicious.testing.kafka.testcontainers

Class TestcontainersKafkaCluster

java.lang.Object

io.kroxylicious.testing.kafka.testcontainers.TestcontainersKafkaCluster

All Implemented Interfaces:

KafkaCluster, KafkaListenerSource, AdminSource, AutoCloseable, org.testcontainers.lifecycle.Startable

public class TestcontainersKafkaCluster
extends Object
implements org.testcontainers.lifecycle.Startable, KafkaCluster, KafkaListenerSource, AdminSource

Provides an easy way to launch a Kafka cluster with multiple brokers in a container

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TestcontainersKafkaCluster.KafkaContainer	The type Kafka container.
static class	TestcontainersKafkaCluster.LoggingGenericContainer<C extends org.testcontainers.containers.GenericContainer<C>>	The type Logging generic container.
static class	TestcontainersKafkaCluster.OneShotContainer	Container used for running one-short commands.
static class	TestcontainersKafkaCluster.ZookeeperContainer	The type Zookeeper container.

Nested classes/interfaces inherited from interface io.kroxylicious.testing.kafka.common.KafkaListenerSource

KafkaListenerSource.Listener

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ANON_PORT	The constant ANON_PORT.
static final String	APACHE_CONTAINER_UID
static final String	APACHE_KAFKA_IMAGE_REPO	environment variable specifying the apache kafka image repository.
static final int	CLIENT_PORT	The constant CLIENT_PORT.
static final String	KAFKA_IMAGE_TAG	environment variable specifying the kafka image repository.
static final String	LEGACY_KAFKA_IMAGE_REPO	Deprecated.
static final String	LEGACY_ZOOKEEPER_IMAGE_REPO	Deprecated.
static final String	LEGACY_ZOOKEEPER_IMAGE_TAG	Deprecated.
static final String	WILDCARD_BIND_ADDRESS

Constructor Summary

Constructors

Constructor	Description
TestcontainersKafkaCluster(KafkaClusterConfig clusterConfig)	Instantiates a new Testcontainers kafka cluster.
TestcontainersKafkaCluster(org.testcontainers.utility.DockerImageName kafkaImage, org.testcontainers.utility.DockerImageName zookeeperImage, KafkaClusterConfig clusterConfig)	Deprecated, for removal: This API element is subject to removal in a future version. please use TestcontainersKafkaCluster(KafkaClusterConfig) The Image arguments have been replaced by environment variables

Method Summary

Modifier and Type	Method	Description
int	addBroker()
void	close()
org.apache.kafka.clients.admin.Admin	createAdmin()	Creates an admin client with administrator privileges.
String	getBootstrapControllers()
String	getBootstrapServers()
String	getClusterId()
Map<String,Object>	getControllerAdminClientConfiguration()
Map<String,Object>	getKafkaClientConfiguration()
Map<String,Object>	getKafkaClientConfiguration(String user, String password)
KafkaListener	getKafkaListener(KafkaListenerSource.Listener listener, int nodeId)	Gets the kafka listen for the given listener and nodeId.
String	getKafkaVersion()	Gets kafka version.
int	getNumOfBrokers()
Set<Integer>	getStoppedBrokers()
void	removeBroker(int nodeId)
void	start()
void	startNodes(IntPredicate nodeIdPredicate)
void	stop()
void	stopNodes(IntPredicate nodeIdPredicate, TerminationStyle terminationStyle)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.testcontainers.lifecycle.Startable

getDependencies

Field Details

LEGACY_ZOOKEEPER_IMAGE_TAG

@Deprecated(since="0.12.0")
public static final String LEGACY_ZOOKEEPER_IMAGE_TAG

Deprecated.

See Also:

• Constant Field Values

LEGACY_ZOOKEEPER_IMAGE_REPO

@Deprecated(since="0.12.0")
public static final String LEGACY_ZOOKEEPER_IMAGE_REPO

Deprecated.

See Also:

• Constant Field Values

LEGACY_KAFKA_IMAGE_REPO

@Deprecated(since="0.12.0")
public static final String LEGACY_KAFKA_IMAGE_REPO

Deprecated.

environment variable specifying the ogunalp native kafka image repository.

See Also:

• Constant Field Values

APACHE_KAFKA_IMAGE_REPO

public static final String APACHE_KAFKA_IMAGE_REPO

environment variable specifying the apache kafka image repository.

See Also:

• Constant Field Values

KAFKA_IMAGE_TAG

public static final String KAFKA_IMAGE_TAG

environment variable specifying the kafka image repository.

See Also:

• Constant Field Values

CLIENT_PORT

public static final int CLIENT_PORT

The constant CLIENT_PORT.

See Also:

• Constant Field Values

ANON_PORT

public static final int ANON_PORT

The constant ANON_PORT.

See Also:

• Constant Field Values

WILDCARD_BIND_ADDRESS

public static final String WILDCARD_BIND_ADDRESS

See Also:

• Constant Field Values

APACHE_CONTAINER_UID

public static final String APACHE_CONTAINER_UID

See Also:

• Constant Field Values

Constructor Details

TestcontainersKafkaCluster

public TestcontainersKafkaCluster(KafkaClusterConfig clusterConfig)

Instantiates a new Testcontainers kafka cluster.

Parameters:

clusterConfig - the cluster config

TestcontainersKafkaCluster

@Deprecated(forRemoval=true)
public TestcontainersKafkaCluster(org.testcontainers.utility.DockerImageName kafkaImage,
 org.testcontainers.utility.DockerImageName zookeeperImage,
 KafkaClusterConfig clusterConfig)

Deprecated, for removal: This API element is subject to removal in a future version.

please use TestcontainersKafkaCluster(KafkaClusterConfig) The Image arguments have been replaced by environment variables

Instantiates a new Testcontainers kafka cluster.

Parameters:

kafkaImage - IGNORED the kafka image

zookeeperImage - IGNORED the zookeeper image

clusterConfig - the cluster config

Method Details

getBootstrapServers

public String getBootstrapServers()

Specified by:

getBootstrapServers in interface KafkaCluster

getBootstrapControllers

public String getBootstrapControllers()

Specified by:

getBootstrapControllers in interface KafkaCluster

getKafkaVersion

public String getKafkaVersion()

Gets kafka version.

Returns:

the kafka version

start

public void start()

Specified by:

start in interface KafkaCluster

Specified by:

start in interface org.testcontainers.lifecycle.Startable

addBroker

public int addBroker()

Specified by:

addBroker in interface KafkaCluster

removeBroker

public void removeBroker(int nodeId)
                  throws UnsupportedOperationException,
IllegalArgumentException,
IllegalStateException

Specified by:

removeBroker in interface KafkaCluster

Throws:

UnsupportedOperationException

IllegalArgumentException

IllegalStateException

stopNodes

public void stopNodes(IntPredicate nodeIdPredicate,
 TerminationStyle terminationStyle)

Specified by:

stopNodes in interface KafkaCluster

startNodes

public void startNodes(IntPredicate nodeIdPredicate)

Specified by:

startNodes in interface KafkaCluster

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface KafkaCluster

Specified by:

close in interface org.testcontainers.lifecycle.Startable

getNumOfBrokers

public int getNumOfBrokers()

Specified by:

getNumOfBrokers in interface KafkaCluster

getStoppedBrokers

public Set<Integer> getStoppedBrokers()

Specified by:

getStoppedBrokers in interface KafkaCluster

stop

public void stop()

Specified by:

stop in interface org.testcontainers.lifecycle.Startable

getClusterId

public String getClusterId()

Specified by:

getClusterId in interface KafkaCluster

getKafkaClientConfiguration

public Map<String,Object> getKafkaClientConfiguration()

Specified by:

getKafkaClientConfiguration in interface KafkaCluster

getKafkaClientConfiguration

public Map<String,Object> getKafkaClientConfiguration(String user,
 String password)

Specified by:

getKafkaClientConfiguration in interface KafkaCluster

getControllerAdminClientConfiguration

public Map<String,Object> getControllerAdminClientConfiguration()

Specified by:

getControllerAdminClientConfiguration in interface KafkaCluster

getKafkaListener

public KafkaListener getKafkaListener(KafkaListenerSource.Listener listener,
 int nodeId)

Description copied from interface: KafkaListenerSource

Gets the kafka listen for the given listener and nodeId.

Specified by:

getKafkaListener in interface KafkaListenerSource

Parameters:

listener - listener

nodeId - kafka node.id

Returns:

kafka listener.

createAdmin

@NonNull
public org.apache.kafka.clients.admin.Admin createAdmin()

Description copied from interface: AdminSource

Creates an admin client with administrator privileges. It is the caller's responsibility to close the admin client returned.

Specified by:

createAdmin in interface AdminSource

Returns:

admin client