Class RedisTestResourceProvider

java.lang.Object

io.micronaut.testresources.testcontainers.AbstractTestContainersProvider<com.redis.testcontainers.RedisContainer>

io.micronaut.testresources.redis.RedisTestResourceProvider

All Implemented Interfaces:

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

public class RedisTestResourceProvider
extends AbstractTestContainersProvider<com.redis.testcontainers.RedisContainer>

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

Nested Class Summary

Nested classes/interfaces inherited from class AbstractTestContainersProvider

AbstractTestContainersProvider.ContainerCommand

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_IMAGE
static final String	DISPLAY_NAME
static final String	REDIS_URI
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
RedisTestResourceProvider()

Method Summary

Modifier and Type	Method	Description
protected com.redis.testcontainers.RedisContainer	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, com.redis.testcontainers.RedisContainer 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, getDefaultStartupTimeout, getName, getOrder, prepareContainer, resolve, resolveProperty, resolveWithoutContainer, 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

REDIS_URI

public static final String REDIS_URI

See Also:

• Constant Field Values

DEFAULT_IMAGE

public static final String DEFAULT_IMAGE

See Also:

• Constant Field Values

SIMPLE_NAME

public static final String SIMPLE_NAME

See Also:

• Constant Field Values

DISPLAY_NAME

public static final String DISPLAY_NAME

See Also:

• Constant Field Values

Constructor Details

RedisTestResourceProvider

public RedisTestResourceProvider()

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<com.redis.testcontainers.RedisContainer>

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<com.redis.testcontainers.RedisContainer>

Returns:

the default image name.

createContainer

protected com.redis.testcontainers.RedisContainer 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<com.redis.testcontainers.RedisContainer>

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,
 com.redis.testcontainers.RedisContainer container)

Specified by:

resolveProperty in class AbstractTestContainersProvider<com.redis.testcontainers.RedisContainer>

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<com.redis.testcontainers.RedisContainer>

Parameters:

propertyName - the property to resolve

requestedProperties - the resolved properties

testResourcesConfig - the test resources configuration

Returns:

if this resolver should answer