Package io.micronaut.maven.testresources

Class TestResourcesConfiguration

java.lang.Object

io.micronaut.maven.testresources.TestResourcesConfiguration

Direct Known Subclasses:

AbstractTestResourcesMojo

public class TestResourcesConfiguration
extends Object

Base configuration class for Test Resources.

Since:

3.5.1

Author:

Álvaro Sánchez-Mariscal

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_PROPERTY_PREFIX
protected boolean	debugServer	Allows starting the test resources server in debug mode.
static final String	DISABLED
protected boolean	foreground	Whether the test resources server should be started in the foreground.
protected boolean	shared	Whether the test resources service should be shared between independent builds (e.g. different projects, even built with different build tools).
protected String	sharedServerNamespace	Allows configuring a namespace for the shared test-resources server.
static final String	TEST_RESOURCES_ENABLED_PROPERTY
protected boolean	testResourcesEnabled	Whether to enable or disable Micronaut test resources support.

Constructor Summary

Constructors

Constructor	Description
TestResourcesConfiguration()

Method Summary

Modifier and Type	Method	Description
String	getSharedServerNamespace()
boolean	isShared()
boolean	isTestResourcesEnabled()
void	setDebugServer(boolean debugServer)	Whether to start the test resources server in debug mode.
void	setShared(boolean shared)	Whether the test resources service should be shared between independent builds.
void	setSharedServerNamespace(String sharedServerNamespace)	The shared server namespace (if any).
void	setTestResourcesEnabled(boolean testResourcesEnabled)	Whether to enable or disable Micronaut test resources support.

Methods inherited from class java.lang.Object

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

Field Details

DISABLED

public static final String DISABLED

See Also:

• Constant Field Values

CONFIG_PROPERTY_PREFIX

public static final String CONFIG_PROPERTY_PREFIX

See Also:

• Constant Field Values

TEST_RESOURCES_ENABLED_PROPERTY

public static final String TEST_RESOURCES_ENABLED_PROPERTY

See Also:

• Constant Field Values

testResourcesEnabled

@Parameter(property="micronaut.test.resources.enabled",
           defaultValue="false")
protected boolean testResourcesEnabled

Whether to enable or disable Micronaut test resources support.

shared

@Parameter(property="micronaut.test.resources.shared",
           defaultValue="false")
protected boolean shared

Whether the test resources service should be shared between independent builds (e.g. different projects, even built with different build tools).

sharedServerNamespace

@Parameter(property="micronaut.test.resources.namespace")
protected String sharedServerNamespace

Allows configuring a namespace for the shared test-resources server. This can be used in case it makes sense to have different instances of shared services, for example when independent builds sets share different services.

Since:

3.5.1

debugServer

@Parameter(property="micronaut.test.resources.debug-server",
           defaultValue="false")
protected boolean debugServer

Allows starting the test resources server in debug mode. The server will be started with the ability to attach a remote debugger on port 8000.

Since:

4.2.0

foreground

@Parameter(property="micronaut.test.resources.foreground",
           defaultValue="false")
protected boolean foreground

Whether the test resources server should be started in the foreground.

Since:

4.7.0

Constructor Details

TestResourcesConfiguration

public TestResourcesConfiguration()

Method Details

isTestResourcesEnabled

public boolean isTestResourcesEnabled()

Returns:

Whether to enable or disable Micronaut test resources support.

isShared

public boolean isShared()

Returns:

Whether the test resources service should be shared between independent builds.

getSharedServerNamespace

public String getSharedServerNamespace()

Returns:

The shared server namespace (if any).

setTestResourcesEnabled

public void setTestResourcesEnabled(boolean testResourcesEnabled)

Whether to enable or disable Micronaut test resources support.

Parameters:

testResourcesEnabled - enabled flag

setShared

public void setShared(boolean shared)

Whether the test resources service should be shared between independent builds.

Parameters:

shared - shared flag

setSharedServerNamespace

public void setSharedServerNamespace(String sharedServerNamespace)

The shared server namespace (if any).

Parameters:

sharedServerNamespace - the shared server namespace to be set

setDebugServer

public void setDebugServer(boolean debugServer)

Whether to start the test resources server in debug mode.

Parameters:

debugServer - debug flag