io.micronaut.build.testresources

Class AbstractTestResourcesMojo

java.lang.Object

io.micronaut.build.testresources.TestResourcesConfiguration

io.micronaut.build.testresources.AbstractTestResourcesMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

RunMojo, StartTestResourcesServerMojo, StopTestResourcesServerMojo

public abstract class AbstractTestResourcesMojo
extends TestResourcesConfiguration
implements org.apache.maven.plugin.Mojo, org.apache.maven.plugin.ContextEnabled

Base mojo for Micronaut test resources service handling.

Field Summary

Fields

Modifier and Type	Field and Description
protected File	buildDirectory
protected Boolean	classpathInference If set to true, Micronaut will attempt to infer which dependencies should be added to the Test Resources server classpath, based on the project dependencies.
protected Integer	clientTimeout Configures the maximum amount of time to wait for the server to start a test resource.
protected Integer	explicitPort By default, the Test Resources server will be started on a random (available) port, but it can be set a fixed port by using this parameter.
protected org.apache.maven.plugin.logging.Log	log Instance logger.
protected Map	pluginContext Plugin container context.
protected List<org.apache.maven.model.Dependency>	testResourcesDependencies Additional dependencies to add to the Test Resources server classpath when not using classpath inference, or when the inference doesn't produce the desired result.
protected String	testResourcesVersion Micronaut Test Resources version.

Fields inherited from class io.micronaut.build.testresources.TestResourcesConfiguration

CONFIG_PROPERTY_PREFIX, DISABLED, keepAlive, shared, sharedServerNamespace, testResourcesEnabled

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractTestResourcesMojo()

Method Summary

Modifier and Type	Method and Description
org.apache.maven.plugin.logging.Log	getLog() Returns the logger that has been injected into this mojo.
Map	getPluginContext()
static Path	serverSettingsDirectoryOf(Path buildDir)
void	setLog(org.apache.maven.plugin.logging.Log log)
void	setPluginContext(Map pluginContext)

Methods inherited from class io.micronaut.build.testresources.TestResourcesConfiguration

getSharedServerNamespace, isKeepAlive, isShared, isTestResourcesEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.maven.plugin.Mojo

execute

Field Detail

log

protected org.apache.maven.plugin.logging.Log log

Instance logger.

pluginContext

protected Map pluginContext

Plugin container context.

buildDirectory

@Parameter(defaultValue="${project.build.directory}",
           required=true)
protected File buildDirectory

testResourcesVersion

@Parameter(property="micronaut.test.resources.version",
           required=true)
protected String testResourcesVersion

Micronaut Test Resources version. Should be defined by the Micronaut BOM, but this parameter can be used to define a different version.

classpathInference

@Parameter(defaultValue="true")
protected Boolean classpathInference

If set to true, Micronaut will attempt to infer which dependencies should be added to the Test Resources server classpath, based on the project dependencies. In general the result will consist of modules from the test-resources project, but it may consist of additional entries, for example database drivers.

testResourcesDependencies

@Parameter
protected List<org.apache.maven.model.Dependency> testResourcesDependencies

Additional dependencies to add to the Test Resources server classpath when not using classpath inference, or when the inference doesn't produce the desired result.

explicitPort

@Parameter(property="micronaut.test.resources.port")
protected Integer explicitPort

By default, the Test Resources server will be started on a random (available) port, but it can be set a fixed port by using this parameter.

clientTimeout

@Parameter(property="micronaut.test.resources.client-timeout",
           defaultValue="60")
protected Integer clientTimeout

Configures the maximum amount of time to wait for the server to start a test resource. Some containeres may take a long amount of time to start with slow internet connections.

Constructor Detail

AbstractTestResourcesMojo

public AbstractTestResourcesMojo()

Method Detail

serverSettingsDirectoryOf

public static Path serverSettingsDirectoryOf(Path buildDir)

setLog

public void setLog(org.apache.maven.plugin.logging.Log log)

Specified by:

setLog in interface org.apache.maven.plugin.Mojo

See Also:

Mojo.setLog(org.apache.maven.plugin.logging.Log)

getLog

public org.apache.maven.plugin.logging.Log getLog()

Returns the logger that has been injected into this mojo. If no logger has been setup yet, a SystemStreamLog logger will be created and returned. Note: The logger returned by this method must not be cached in an instance field during the construction of the mojo. This would cause the mojo to use a wrongly configured default logger when being run by Maven. The proper logger gets injected by the Plexus container after the mojo has been constructed. Therefore, simply call this method directly whenever you need the logger, it is fast enough and needs no caching.

Specified by:

getLog in interface org.apache.maven.plugin.Mojo

See Also:

Mojo.getLog()

getPluginContext

public Map getPluginContext()

Specified by:

getPluginContext in interface org.apache.maven.plugin.ContextEnabled

See Also:

ContextEnabled.getPluginContext()

setPluginContext

public void setPluginContext(Map pluginContext)

Specified by:

setPluginContext in interface org.apache.maven.plugin.ContextEnabled

See Also:

ContextEnabled.setPluginContext(java.util.Map)