io.micronaut.testresources.kafka

Class KafkaTestResourceProvider

java.lang.Object

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

io.micronaut.testresources.kafka.KafkaTestResourceProvider

All Implemented Interfaces:

io.micronaut.core.order.Ordered, TestResourcesResolver

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_IMAGE
static java.lang.String	KAFKA_BOOTSTRAP_SERVERS

Fields inherited from interface io.micronaut.testresources.core.TestResourcesResolver

TEST_RESOURCES_PROPERTY

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
KafkaTestResourceProvider()

Method Summary

Modifier and Type	Method and Description
protected org.testcontainers.containers.KafkaContainer	createContainer(org.testcontainers.utility.DockerImageName imageName, java.util.Map<java.lang.String,java.lang.Object> requestedProperties, java.util.Map<java.lang.String,java.lang.Object> testResourcesConfiguration) Creates the test container.
protected java.lang.String	getDefaultImageName() Returns the default image name.
java.util.List<java.lang.String>	getResolvableProperties(java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> propertyEntries, java.util.Map<java.lang.String,java.lang.Object> testResourcesConfig) Returns the list of properties that this resolver is able to support.
protected java.lang.String	getSimpleName() Returns the name of the resource resolver, for example "kafka" or "mysql".
protected java.util.Optional<java.lang.String>	resolveProperty(java.lang.String propertyName, org.testcontainers.containers.KafkaContainer container)
protected boolean	shouldAnswer(java.lang.String propertyName, java.util.Map<java.lang.String,java.lang.Object> requestedProperties, java.util.Map<java.lang.String,java.lang.Object> testResourcesConfiguration) Determines if this resolver can resolve the requested property.

Methods inherited from class io.micronaut.testresources.testcontainers.AbstractTestContainersProvider

configureContainer, getOrder, resolve, resolveWithoutContainer, stringOrNull

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.testresources.core.TestResourcesResolver

getRequiredProperties, getRequiredPropertyEntries

Field Detail

KAFKA_BOOTSTRAP_SERVERS

public static final java.lang.String KAFKA_BOOTSTRAP_SERVERS

See Also:

Constant Field Values

DEFAULT_IMAGE

public static final java.lang.String DEFAULT_IMAGE

See Also:

Constant Field Values

Constructor Detail

KafkaTestResourceProvider

public KafkaTestResourceProvider()

Method Detail

getResolvableProperties

public java.util.List<java.lang.String> getResolvableProperties(java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> propertyEntries,
                                                                java.util.Map<java.lang.String,java.lang.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

getSimpleName

protected java.lang.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.containers.KafkaContainer>

Returns:

the name of the resolver

getDefaultImageName

protected java.lang.String getDefaultImageName()

Description copied from class: AbstractTestContainersProvider

Returns the default image name.

Specified by:

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

Returns:

the default image name.

createContainer

protected org.testcontainers.containers.KafkaContainer createContainer(org.testcontainers.utility.DockerImageName imageName,
                                                                       java.util.Map<java.lang.String,java.lang.Object> requestedProperties,
                                                                       java.util.Map<java.lang.String,java.lang.Object> testResourcesConfiguration)

Description copied from class: AbstractTestContainersProvider

Creates the test container.

Specified by:

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

Parameters:

imageName - the docker image name

requestedProperties - the resolved properties

testResourcesConfiguration - the test resources configuration

Returns:

a container

resolveProperty

protected java.util.Optional<java.lang.String> resolveProperty(java.lang.String propertyName,
                                                               org.testcontainers.containers.KafkaContainer container)

Specified by:

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

shouldAnswer

protected boolean shouldAnswer(java.lang.String propertyName,
                               java.util.Map<java.lang.String,java.lang.Object> requestedProperties,
                               java.util.Map<java.lang.String,java.lang.Object> testResourcesConfiguration)

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.containers.KafkaContainer>

Parameters:

propertyName - the property to resolve

requestedProperties - the resolved properties

testResourcesConfiguration - the test resources configuration

Returns:

if this resolver should answer