com.github.ydespreaux.testcontainers.kafka.rule

Class ConfluentKafkaContainer<S extends ConfluentKafkaContainer<S>>

java.lang.Object

org.junit.rules.ExternalResource

com.github.ydespreaux.testcontainers.kafka.rule.ConfluentKafkaContainer<S>

Type Parameters:

S -

All Implemented Interfaces:

ConfluentContainer<S>, AutoCloseable, org.junit.rules.TestRule, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.testcontainers.lifecycle.Startable

Direct Known Subclasses:

ConfluentKafkaConnectContainer

public class ConfluentKafkaContainer<S extends ConfluentKafkaContainer<S>>
extends org.junit.rules.ExternalResource
implements ConfluentContainer<S>

This class is used to start a zookeeper container, a kafka container, and a schema registry container if it is enabled.

Since:

1.0.0

Author:

Yoann Despréaux

Constructor Summary

Constructors

Constructor and Description
ConfluentKafkaContainer()
ConfluentKafkaContainer(String confluentVersion)

Method Summary

Modifier and Type	Method and Description
void	after() Stop and remove all containers.
void	afterPropertiesSet()
void	before() Start all containers.
void	destroy() Destroy all containers.
String	getBootstrapServers() Get the kafka url.
Certificates	getKafkaClientCertificates()
Certificates	getKafkaServerCertificates()
String	getSchemaRegistryServers()
String	getZookeeperConnect() Get the local zookeeper url.
String	getZookeeperServer() Get the zookeeper url.
boolean	isRunning()
boolean	isSecured()
S	self()
void	start()
void	stop()
S	withAcls(AclsOperation[] operations, String topic, String group)
S	withAcls(AclsOperation operation, String topic, String group)
S	withAcls(Certificates certificates, AclsOperation[] operations, String topic, String group)
S	withAcls(Certificates certificates, AclsOperation operation, String topic, String group)
S	withAllAcls(Certificates certificates, String topic, String group)
S	withAllAcls(String topic, String group)
S	withBrokerServersSystemProperty(String property)
S	withDescribeAcls(Certificates certificates, String topic, String group)
S	withDescribeAcls(String topic, String group)
S	withFormatMessageVersion(String version)
S	withIdentificationAlgorithmSystemProperty(String property)
S	withKafkaClientCertificates(Certificates certificates)
S	withKafkaServerCertificates(Certificates certificates)
S	withKeyPasswordSystemProperty(String property)
S	withKeystoreLocationSystemProperty(String property)
S	withKeystorePasswordSystemProperty(String property)
S	withNetwork(org.testcontainers.containers.Network network) Set the network.
S	withReadAcls(Certificates certificates, String topic, String group)
S	withReadAcls(String topic, String group)
S	withRegisterSpringbootProperties(boolean registerProperties) Register the spring boot properties.
S	withSchemaRegistry(boolean schemaRegistryEnabled) Enable the schema registry.
S	withSchemaRegistrySystemProperty(String property)
S	withSecurityProtocolSystemProperty(String property)
S	withTopic(String topicName, int partitions, boolean compact)
S	withTopic(TopicConfiguration topic)
S	withTruststoreLocationSystemProperty(String property)
S	withTruststorePasswordSystemProperty(String property)
S	withWriteAcls(Certificates certificates, String topic)
S	withWriteAcls(String topic)

Methods inherited from class org.junit.rules.ExternalResource

apply

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.junit.rules.TestRule

apply

Methods inherited from interface org.testcontainers.lifecycle.Startable

close

Constructor Detail

ConfluentKafkaContainer

public ConfluentKafkaContainer()

ConfluentKafkaContainer

public ConfluentKafkaContainer(String confluentVersion)

Parameters:

confluentVersion -

Method Detail

self

public S self()

Specified by:

self in interface ConfluentContainer<S extends ConfluentKafkaContainer<S>>

withSchemaRegistry

public S withSchemaRegistry(boolean schemaRegistryEnabled)

Enable the schema registry.

Parameters:

schemaRegistryEnabled -

Returns:

withRegisterSpringbootProperties

public S withRegisterSpringbootProperties(boolean registerProperties)

Register the spring boot properties.

Specified by:

withRegisterSpringbootProperties in interface ConfluentContainer<S extends ConfluentKafkaContainer<S>>

Parameters:

registerProperties -

Returns:

withKafkaServerCertificates

public S withKafkaServerCertificates(Certificates certificates)

withKafkaClientCertificates

public S withKafkaClientCertificates(Certificates certificates)

getKafkaServerCertificates

public Certificates getKafkaServerCertificates()

Returns:

getKafkaClientCertificates

public Certificates getKafkaClientCertificates()

Returns:

isSecured

public boolean isSecured()

Returns:

withNetwork

public S withNetwork(org.testcontainers.containers.Network network)

Set the network.

Specified by:

withNetwork in interface ConfluentContainer<S extends ConfluentKafkaContainer<S>>

Parameters:

network -

Returns:

withBrokerServersSystemProperty

public S withBrokerServersSystemProperty(String property)

withSchemaRegistrySystemProperty

public S withSchemaRegistrySystemProperty(String property)

withSecurityProtocolSystemProperty

public S withSecurityProtocolSystemProperty(String property)

withKeyPasswordSystemProperty

public S withKeyPasswordSystemProperty(String property)

withKeystoreLocationSystemProperty

public S withKeystoreLocationSystemProperty(String property)

withKeystorePasswordSystemProperty

public S withKeystorePasswordSystemProperty(String property)

withTruststoreLocationSystemProperty

public S withTruststoreLocationSystemProperty(String property)

withTruststorePasswordSystemProperty

public S withTruststorePasswordSystemProperty(String property)

withIdentificationAlgorithmSystemProperty

public S withIdentificationAlgorithmSystemProperty(String property)

withFormatMessageVersion

public S withFormatMessageVersion(String version)

Parameters:

version -

Returns:

withTopic

public S withTopic(String topicName,
                   int partitions,
                   boolean compact)

Parameters:

topicName -

partitions -

compact -

Returns:

withTopic

public S withTopic(TopicConfiguration topic)

Parameters:

topic -

Returns:

withAllAcls

public S withAllAcls(String topic,
                     String group)

withAllAcls

public S withAllAcls(Certificates certificates,
                     String topic,
                     String group)

withWriteAcls

public S withWriteAcls(String topic)

withWriteAcls

public S withWriteAcls(Certificates certificates,
                       String topic)

withDescribeAcls

public S withDescribeAcls(String topic,
                          String group)

withDescribeAcls

public S withDescribeAcls(Certificates certificates,
                          String topic,
                          String group)

withReadAcls

public S withReadAcls(String topic,
                      String group)

withReadAcls

public S withReadAcls(Certificates certificates,
                      String topic,
                      String group)

withAcls

public S withAcls(AclsOperation operation,
                  String topic,
                  String group)

withAcls

public S withAcls(Certificates certificates,
                  AclsOperation operation,
                  String topic,
                  String group)

withAcls

public S withAcls(AclsOperation[] operations,
                  String topic,
                  String group)

withAcls

public S withAcls(Certificates certificates,
                  AclsOperation[] operations,
                  String topic,
                  String group)

getZookeeperConnect

public String getZookeeperConnect()

Get the local zookeeper url.

Returns:

getZookeeperServer

public String getZookeeperServer()

Get the zookeeper url.

Returns:

getBootstrapServers

public String getBootstrapServers()

Get the kafka url.

Returns:

getSchemaRegistryServers

public String getSchemaRegistryServers()

Returns:

destroy

public void destroy()
             throws Exception

Destroy all containers.

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Throws:

Exception

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

before

public void before()

Start all containers.

Overrides:

before in class org.junit.rules.ExternalResource

after

public void after()

Stop and remove all containers.

Overrides:

after in class org.junit.rules.ExternalResource

isRunning

public boolean isRunning()

start

public void start()

Specified by:

start in interface org.testcontainers.lifecycle.Startable

stop

public void stop()

Specified by:

stop in interface org.testcontainers.lifecycle.Startable