Class KafkaTestResourceProvider

java.lang.Object

io.micronaut.testresources.testcontainers.AbstractTestContainersProvider<org.testcontainers.kafka.KafkaContainer>

io.micronaut.testresources.kafka.KafkaTestResourceProvider

All Implemented Interfaces:

io.micronaut.core.order.Ordered, TestResourcesResolver, ToggableTestResourcesResolver

public class KafkaTestResourceProvider
extends AbstractTestContainersProvider<org.testcontainers.kafka.KafkaContainer>

A test resource provider which will spawn a Kafka test container.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final record	KafkaTestResourceProvider.TopicProvisioningConfiguration

Nested classes/interfaces inherited from class AbstractTestContainersProvider

AbstractTestContainersProvider.ContainerCommand

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_IMAGE
static final int	DEFAULT_PARTITIONS
static final String	DISPLAY_NAME
static final String	KAFKA_BOOTSTRAP_SERVERS
static final String	KAFKA_PARTITIONS
static final String	KAFKA_TOPICS
static final String	SIMPLE_NAME

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Fields inherited from interface TestResourcesResolver

TEST_RESOURCES_PROPERTY

Constructor Summary

Constructors

Constructor	Description
KafkaTestResourceProvider()

Method Summary

Modifier and Type	Method	Description
protected void	beforeCreateTopics(org.testcontainers.kafka.KafkaContainer container, KafkaTestResourceProvider.TopicProvisioningConfiguration configuration, List<org.apache.kafka.clients.admin.NewTopic> topicsToCreate)
protected org.testcontainers.kafka.KafkaContainer	createContainer(org.testcontainers.utility.DockerImageName imageName, Map<String,Object> requestedProperties, Map<String,Object> testResourcesConfig)	Creates the test container.
protected String	getDefaultImageName()	Returns the default image name.
String	getDisplayName()	Returns a display name for a test resources resolver, used for debugging purposes.
List<String>	getResolvableProperties(Map<String, Collection<String>> propertyEntries, Map<String,Object> testResourcesConfig)	Returns the list of properties that this resolver is able to support.
protected String	getSimpleName()	Returns the name of the resource resolver, for example "kafka" or "mysql".
protected Optional<String>	resolveProperty(String propertyName, org.testcontainers.kafka.KafkaContainer container)
protected Optional<String>	resolveWithoutContainer(String propertyName, Map<String,Object> properties, Map<String,Object> testResourcesConfig)	Lets a resolver provide a value for the requested property without triggering the creation of a test container.
protected boolean	shouldAnswer(String propertyName, Map<String,Object> requestedProperties, Map<String,Object> testResourcesConfig)	Determines if this resolver can resolve the requested property.

Methods inherited from class AbstractTestContainersProvider

configureContainer, executeInContainer, getContainerOwnerKey, getContainerQuery, getName, getOrder, prepareContainer, resolve, resolveProperty, stringOrNull

Methods inherited from class Object

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

Methods inherited from interface TestResourcesResolver

getId, getRequiredProperties, getRequiredPropertyEntries

Methods inherited from interface ToggableTestResourcesResolver

isEnabled

Field Details

KAFKA_BOOTSTRAP_SERVERS

public static final String KAFKA_BOOTSTRAP_SERVERS

See Also:

• Constant Field Values

KAFKA_TOPICS

public static final String KAFKA_TOPICS

See Also:

• Constant Field Values

KAFKA_PARTITIONS

public static final String KAFKA_PARTITIONS

See Also:

• Constant Field Values

DEFAULT_IMAGE

public static final String DEFAULT_IMAGE

See Also:

• Constant Field Values

DEFAULT_PARTITIONS

public static final int DEFAULT_PARTITIONS

See Also:

• Constant Field Values

DISPLAY_NAME

public static final String DISPLAY_NAME

See Also:

• Constant Field Values

SIMPLE_NAME

public static final String SIMPLE_NAME

See Also:

• Constant Field Values

Constructor Details

KafkaTestResourceProvider

public KafkaTestResourceProvider()

Method Details

getResolvableProperties

public List<String> getResolvableProperties(Map<String, Collection<String>> propertyEntries,
 Map<String,Object> testResourcesConfig)

Description copied from interface: TestResourcesResolver

Returns the list of properties that this resolver is able to support. The property entries map is a map which keys are the property entries retrieved from calling TestResourcesResolver.getRequiredPropertyEntries() and values are those property entries resolved.

Parameters:

propertyEntries - the property entries

testResourcesConfig - the test resources configuration

Returns:

the list of properties

getDisplayName

public String getDisplayName()

Description copied from interface: TestResourcesResolver

Returns a display name for a test resources resolver, used for debugging purposes.

Returns:

the display name

getSimpleName

protected String getSimpleName()

Description copied from class: AbstractTestContainersProvider

Returns the name of the resource resolver, for example "kafka" or "mysql".

Specified by:

getSimpleName in class AbstractTestContainersProvider<org.testcontainers.kafka.KafkaContainer>

Returns:

the name of the resolver

getDefaultImageName

protected String getDefaultImageName()

Description copied from class: AbstractTestContainersProvider

Returns the default image name.

Specified by:

getDefaultImageName in class AbstractTestContainersProvider<org.testcontainers.kafka.KafkaContainer>

Returns:

the default image name.

createContainer

protected org.testcontainers.kafka.KafkaContainer createContainer(org.testcontainers.utility.DockerImageName imageName,
 Map<String,Object> requestedProperties,
 Map<String,Object> testResourcesConfig)

Description copied from class: AbstractTestContainersProvider

Creates the test container.

Specified by:

createContainer in class AbstractTestContainersProvider<org.testcontainers.kafka.KafkaContainer>

Parameters:

imageName - the docker image name

requestedProperties - the resolved properties

testResourcesConfig - the test resources configuration

Returns:

a container

resolveProperty

protected Optional<String> resolveProperty(String propertyName,
 org.testcontainers.kafka.KafkaContainer container)

Specified by:

resolveProperty in class AbstractTestContainersProvider<org.testcontainers.kafka.KafkaContainer>

shouldAnswer

protected boolean shouldAnswer(String propertyName,
 Map<String,Object> requestedProperties,
 Map<String,Object> testResourcesConfig)

Description copied from class: AbstractTestContainersProvider

Determines if this resolver can resolve the requested property. It is used in order to make sure that a "Postgres" resolver wouldn't provide a value if the requested container type is for MySQL, for example.

Overrides:

shouldAnswer in class AbstractTestContainersProvider<org.testcontainers.kafka.KafkaContainer>

Parameters:

propertyName - the property to resolve

requestedProperties - the resolved properties

testResourcesConfig - the test resources configuration

Returns:

if this resolver should answer

resolveWithoutContainer

protected Optional<String> resolveWithoutContainer(String propertyName,
 Map<String,Object> properties,
 Map<String,Object> testResourcesConfig)

Description copied from class: AbstractTestContainersProvider

Lets a resolver provide a value for the requested property without triggering the creation of a test container. This can be used in case a resolver wants to check existing containers first.

Overrides:

resolveWithoutContainer in class AbstractTestContainersProvider<org.testcontainers.kafka.KafkaContainer>

Parameters:

propertyName - the name of the property to resolve

properties - the properties used to resolve

testResourcesConfig - the test resources configuration

Returns:

a resolved property

beforeCreateTopics

protected void beforeCreateTopics(org.testcontainers.kafka.KafkaContainer container,
 KafkaTestResourceProvider.TopicProvisioningConfiguration configuration,
 List<org.apache.kafka.clients.admin.NewTopic> topicsToCreate)