io.micronaut.testresources.core

Interface TestResourcesResolver

All Superinterfaces:

io.micronaut.core.order.Ordered

All Known Subinterfaces:

TestResourcesClient

All Known Implementing Classes:

AbstractHibernateReactiveTestResourceProvider, AbstractJdbcTestResourceProvider, AbstractR2DBCTestResourceProvider, AbstractTestContainersProvider, DefaultTestResourcesClient, ElasticsearchTestResourceProvider, GenericTestContainerProvider, HibernateReactiveMariaDBTestResourceProvider, HibernateReactiveMSSQLTestResourceProvider, HibernateReactiveMySQLTestResourceProvider, HibernateReactiveOracleXETestResourceProvider, HibernateReactivePostgreSQLTestResourceProvider, HiveMQTestResourceProvider, KafkaTestResourceProvider, MariaDBTestResourceProvider, MongoDBTestResourceProvider, MSSQLTestResourceProvider, MySQLTestResourceProvider, Neo4jTestResourceProvider, OracleXETestResourceProvider, PostgreSQLTestResourceProvider, R2DBCMariaDBTestResourceProvider, R2DBCMSSQLTestResourceProvider, R2DBCMySQLTestResourceProvider, R2DBCOracleXETestResourceProvider, R2DBCPoolTestResourceProvider, R2DBCPostgreSQLTestResourceProvider, RabbitMQTestResourceProvider, RedisTestResourceProvider, TestResourcesController, VaultTestResourceProvider

public interface TestResourcesResolver
extends io.micronaut.core.order.Ordered

A test resources resolver is responsible for resolving test resources. This should be done when the resolve(String, Map, Map) method is called. This method is called with a property, corresponding to a property which doesn't exist in the user configuration. For example, if the "jdbc.driver" property is missing, a resolver may declare that it can resolve that property. As part of the process, it may start a test container for example.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TEST_RESOURCES_PROPERTY The name of the top-level test resources property configuration key.

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method and Description
default 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.
default 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.
java.util.Optional<java.lang.String>	resolve(java.lang.String propertyName, java.util.Map<java.lang.String,java.lang.Object> properties, java.util.Map<java.lang.String,java.lang.Object> testResourcesConfiguration) Resolves the given property.

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

getOrder

Field Detail

TEST_RESOURCES_PROPERTY

static final java.lang.String TEST_RESOURCES_PROPERTY

The name of the top-level test resources property configuration key.

See Also:

Constant Field Values

Method Detail

getResolvableProperties

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. The property entries map is a map which keys are the property entries retrieved from calling getRequiredPropertyEntries() and values are those property entries resolved.

Parameters:

propertyEntries - the property entries

testResourcesConfig - the test resources configuration

Returns:

the list of properties

getRequiredProperties

default 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.

Parameters:

expression - the expression which needs to be resolved.

Returns:

the list of configuration properties this resolver requires

getRequiredPropertyEntries

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

resolve

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

Resolves the given property.

Parameters:

propertyName - the property to resolve

properties - the resolved required properties

testResourcesConfiguration - the test resources configuration

Returns:

the resolved property or empty if not found