io.micronaut.testresources.testcontainers

Class GenericTestContainerProvider

java.lang.Object

io.micronaut.testresources.testcontainers.GenericTestContainerProvider

All Implemented Interfaces:

io.micronaut.core.order.Ordered, TestResourcesResolver

public class GenericTestContainerProvider
extends java.lang.Object
implements TestResourcesResolver

A generic test containers provider. This provider is special in the sense that it requires user provided configuration in order to spawn containers. Therefore, the application configuration must contain entries under the "test-resources.containers" property prefix. A generic container is represented with a name, a container image, and exposes a number of ports. For example, imagine that a service requires an SMTP server to work property. Then it is likely that some configuration property needs to point to the server port. If that property is smtp.port, then it is possible to expose a test container which will resolve that property using the following configuration:

 test-resources:
   containers:
     fakesmtp:
       image-name: ghusta/fakesmtp:2.0
       hostnames:
         - smtp.host
       exposed-ports:
         - smtp.port: 25
 

The mapped port from test containers will then be automatically be assigned to the smtp.port property, and the host name of the running test container will automatically be assigned to the smtp.host property.

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

Method Summary

Modifier and Type	Method and Description
int	getOrder()
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 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

Constructor Detail

GenericTestContainerProvider

public GenericTestContainerProvider()

Method Detail

getOrder

public int getOrder()

Specified by:

getOrder in interface io.micronaut.core.order.Ordered

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.

Specified by:

getResolvableProperties in interface TestResourcesResolver

Parameters:

propertyEntries - the property entries

testResourcesConfig - the test resources configuration

Returns:

the list of properties

resolve

public 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)

Description copied from interface: TestResourcesResolver

Resolves the given property.

Specified by:

resolve in interface TestResourcesResolver

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