Class MySQLTestResourceProvider

java.lang.Object

io.micronaut.testresources.testcontainers.AbstractTestContainersProvider<org.testcontainers.mysql.MySQLContainer>

io.micronaut.testresources.jdbc.AbstractJdbcTestResourceProvider<org.testcontainers.mysql.MySQLContainer>

io.micronaut.testresources.mysql.MySQLTestResourceProvider

All Implemented Interfaces:

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

public class MySQLTestResourceProvider
extends AbstractJdbcTestResourceProvider<org.testcontainers.mysql.MySQLContainer>

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

Nested Class Summary

Nested classes/interfaces inherited from class AbstractTestContainersProvider

AbstractTestContainersProvider.ContainerCommand

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_X_PROTOCOL_PORT
static final String	DISPLAY_NAME
static final String	DOCKER_OFFICIAL_IMAGE
static final String	MYSQL_OFFICIAL_IMAGE
static final String	SIMPLE_NAME
static final String	X_PROTOCOL_URL

Fields inherited from class AbstractJdbcTestResourceProvider

PREFIX, RESOURCE_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
MySQLTestResourceProvider()

Method Summary

Modifier and Type	Method	Description
protected void	configureContainer(org.testcontainers.mysql.MySQLContainer container, Map<String,Object> properties, Map<String,Object> testResourcesConfig)
protected void	createAdditionalDatabase(org.testcontainers.mysql.MySQLContainer container, String databaseName)	Creates an additional logical database inside an already started container.
protected org.testcontainers.mysql.MySQLContainer	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 String	jdbcUrlFor(org.testcontainers.mysql.MySQLContainer container, String databaseName)	Builds a JDBC URL that targets the supplied logical database on the running container.
protected String	resolveDbSpecificProperty(String propertyName, org.testcontainers.containers.JdbcDatabaseContainer<?> container, Map<String,Object> properties, Map<String,Object> testResourcesConfig)	Resolves vendor-specific properties using the started container plus the original requested-property map.
protected boolean	supportsMultipleDatabases()	Indicates whether this provider can create additional logical databases inside the same running container.

Methods inherited from class AbstractJdbcTestResourceProvider

datasourceExpressionOf, datasourceNameFrom, datasourcePropertyFrom, findRequestedDatabaseName, getContainerOwnerKey, getContainerQuery, getDbTypes, getRequiredProperties, getRequiredPropertyEntries, isDatasourceExpression, prepareContainer, resolveDbSpecificProperty, resolveJdbcUrl, resolveProperty, resolveProperty, shouldAnswer

Methods inherited from class AbstractTestContainersProvider

executeInContainer, getName, getOrder, resolve, resolveWithoutContainer, stringOrNull

Methods inherited from class Object

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

Methods inherited from interface TestResourcesResolver

getId

Methods inherited from interface ToggableTestResourcesResolver

isEnabled

Field Details

DISPLAY_NAME

public static final String DISPLAY_NAME

See Also:

• Constant Field Values

MYSQL_OFFICIAL_IMAGE

public static final String MYSQL_OFFICIAL_IMAGE

See Also:

• Constant Field Values

DOCKER_OFFICIAL_IMAGE

public static final String DOCKER_OFFICIAL_IMAGE

See Also:

• Constant Field Values

SIMPLE_NAME

public static final String SIMPLE_NAME

See Also:

• Constant Field Values

X_PROTOCOL_URL

public static final String X_PROTOCOL_URL

See Also:

• Constant Field Values

DEFAULT_X_PROTOCOL_PORT

public static final int DEFAULT_X_PROTOCOL_PORT

See Also:

• Constant Field Values

Constructor Details

MySQLTestResourceProvider

public MySQLTestResourceProvider()

Method Details

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<org.testcontainers.mysql.MySQLContainer>

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<org.testcontainers.mysql.MySQLContainer>

Returns:

the default image name.

supportsMultipleDatabases

protected boolean supportsMultipleDatabases()

Description copied from class: AbstractJdbcTestResourceProvider

Indicates whether this provider can create additional logical databases inside the same running container. Subclasses overriding this method must also implement the database-creation hooks consistently for the same container type.

Overrides:

supportsMultipleDatabases in class AbstractJdbcTestResourceProvider<org.testcontainers.mysql.MySQLContainer>

Returns:

true when additional logical databases are supported

createAdditionalDatabase

protected void createAdditionalDatabase(org.testcontainers.mysql.MySQLContainer container,
 String databaseName)

Description copied from class: AbstractJdbcTestResourceProvider

Creates an additional logical database inside an already started container. This is only invoked when AbstractJdbcTestResourceProvider.supportsMultipleDatabases() returns true, so subclasses overriding one hook should override the other as a matching pair.

Overrides:

createAdditionalDatabase in class AbstractJdbcTestResourceProvider<org.testcontainers.mysql.MySQLContainer>

Parameters:

container - the running container

databaseName - the database to create

jdbcUrlFor

protected String jdbcUrlFor(org.testcontainers.mysql.MySQLContainer container,
 String databaseName)

Description copied from class: AbstractJdbcTestResourceProvider

Builds a JDBC URL that targets the supplied logical database on the running container. Subclasses overriding this method should return a URL compatible with the driver exposed by the container.

Overrides:

jdbcUrlFor in class AbstractJdbcTestResourceProvider<org.testcontainers.mysql.MySQLContainer>

Parameters:

container - the running container

databaseName - the logical database name requested by the caller

Returns:

the JDBC URL for that database

createContainer

protected org.testcontainers.mysql.MySQLContainer 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<org.testcontainers.mysql.MySQLContainer>

Parameters:

imageName - the docker image name

requestedProperties - the resolved properties

testResourcesConfig - the test resources configuration

Returns:

a container

configureContainer

protected void configureContainer(org.testcontainers.mysql.MySQLContainer container,
 Map<String,Object> properties,
 Map<String,Object> testResourcesConfig)

Overrides:

configureContainer in class AbstractJdbcTestResourceProvider<org.testcontainers.mysql.MySQLContainer>

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.

Specified by:

getResolvableProperties in interface TestResourcesResolver

Overrides:

getResolvableProperties in class AbstractJdbcTestResourceProvider<org.testcontainers.mysql.MySQLContainer>

Parameters:

propertyEntries - the property entries

testResourcesConfig - the test resources configuration

Returns:

the list of properties

resolveDbSpecificProperty

protected String resolveDbSpecificProperty(String propertyName,
 org.testcontainers.containers.JdbcDatabaseContainer<?> container,
 Map<String,Object> properties,
 Map<String,Object> testResourcesConfig)

Description copied from class: AbstractJdbcTestResourceProvider

Resolves vendor-specific properties using the started container plus the original requested-property map. Subclasses may override when the resolved value depends on request metadata in addition to the container state.

Overrides:

resolveDbSpecificProperty in class AbstractJdbcTestResourceProvider<org.testcontainers.mysql.MySQLContainer>

Parameters:

propertyName - the property to resolve

container - the started container

properties - the resolved properties for the request

testResourcesConfig - the test resources configuration

Returns:

the resolved property, or null if not resolvable