io.micronaut.testresources.r2dbc.core

Class AbstractR2DBCTestResourceProvider<T extends org.testcontainers.containers.GenericContainer<? extends T>>

java.lang.Object

io.micronaut.testresources.testcontainers.AbstractTestContainersProvider<T>

io.micronaut.testresources.r2dbc.core.AbstractR2DBCTestResourceProvider<T>

Type Parameters:

T - the container type

All Implemented Interfaces:

io.micronaut.core.order.Ordered, TestResourcesResolver

Direct Known Subclasses:

R2DBCMariaDBTestResourceProvider, R2DBCMSSQLTestResourceProvider, R2DBCMySQLTestResourceProvider, R2DBCOracleXETestResourceProvider, R2DBCPostgreSQLTestResourceProvider

public abstract class AbstractR2DBCTestResourceProvider<T extends org.testcontainers.containers.GenericContainer<? extends T>>
extends AbstractTestContainersProvider<T>

Base class for R2DBC test resources. Unlike JDBC test resources, this resolver is capable of reusing an existing JDBC test resources and expose it via R2DBC: this can be useful for Flyway database migrations which work over JDBC for example. For this to work, a datasource of the same name must exist, in which case it would be resolved first. If no such datasource exists, then a new container will be created.

Field Summary

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
AbstractR2DBCTestResourceProvider()

Method Summary

Modifier and Type	Method and Description
protected abstract java.util.Optional<io.r2dbc.spi.ConnectionFactoryOptions>	extractOptions(org.testcontainers.containers.GenericContainer<?> container)
protected java.util.List<java.lang.String>	getDbTypes() Returns the list of db-types supported by this provider.
java.util.List<java.lang.String>	getRequiredProperties(java.lang.String expression) Returns the list of properties which should be read before resolving an expression: this can be used if the resolver itself needs some configuration properties.
java.util.List<java.lang.String>	getRequiredPropertyEntries()
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.util.Optional<java.lang.String>	resolveProperty(java.lang.String expression, T container)
protected java.util.Optional<java.lang.String>	resolveWithoutContainer(java.lang.String propertyName, java.util.Map<java.lang.String,java.lang.Object> properties, java.util.Map<java.lang.String,java.lang.Object> testResourcesConfiguration) Lets a resolver provide a value for the requested property without triggering the creation of a test 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, createContainer, getDefaultImageName, getOrder, getSimpleName, resolve, stringOrNull

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractR2DBCTestResourceProvider

public AbstractR2DBCTestResourceProvider()

Method Detail

getDbTypes

protected java.util.List<java.lang.String> getDbTypes()

Returns the list of db-types supported by this provider.

Returns:

the list of db types

getRequiredPropertyEntries

public java.util.List<java.lang.String> getRequiredPropertyEntries()

getRequiredProperties

public java.util.List<java.lang.String> getRequiredProperties(java.lang.String expression)

Description copied from interface: TestResourcesResolver

Returns the list of properties which should be read before resolving an expression: this can be used if the resolver itself needs some configuration properties.

Parameters:

expression - the expression which needs to be resolved.

Returns:

the list of configuration properties this resolver requires

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

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<T extends org.testcontainers.containers.GenericContainer<? extends T>>

Parameters:

propertyName - the property to resolve

requestedProperties - the resolved properties

testResourcesConfiguration - the test resources configuration

Returns:

if this resolver should answer

resolveWithoutContainer

protected java.util.Optional<java.lang.String> resolveWithoutContainer(java.lang.String propertyName,
                                                                       java.util.Map<java.lang.String,java.lang.Object> properties,
                                                                       java.util.Map<java.lang.String,java.lang.Object> testResourcesConfiguration)

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<T extends org.testcontainers.containers.GenericContainer<? extends T>>

Parameters:

propertyName - the name of the property to resolve

properties - the properties used to resolve

testResourcesConfiguration - the test resources configuration

Returns:

a resolved property

resolveProperty

protected final java.util.Optional<java.lang.String> resolveProperty(java.lang.String expression,
                                                                     T container)

Specified by:

resolveProperty in class AbstractTestContainersProvider<T extends org.testcontainers.containers.GenericContainer<? extends T>>

extractOptions

protected abstract java.util.Optional<io.r2dbc.spi.ConnectionFactoryOptions> extractOptions(org.testcontainers.containers.GenericContainer<?> container)