org.testifyproject.annotation

Annotation Type VirtualResource

@Documented
 @Retention(value=RUNTIME)
 @Target(value={ANNOTATION_TYPE,TYPE})
 @Repeatable(value=VirtualResources.class)
public @interface VirtualResource

An annotation that can be placed on integration and system tests to specify virtual resources that should be configured, started, stopped before and after each test run. This is useful when performing integration and system tests using real production environment (i.e. using real PostgresSQL or Cassandra NoSQL).

Author:

saden

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value The name of the virtual resource.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	await A flag that indicate whether to wait for all virtual resource ports to be reachable.
String	cmd The command used to execute the virtual resource.
String	configKey The configuration section key in .testify.yml associated with the virtual resource.
String[]	dataFiles A list of classpath data files that should be loaded by the virtual resource prior to being used.
Class<? extends DataProvider>	dataProvider Specifies a data provider implementations that loads data into the resource prior to it being used.
long	delay The amount of time to wait between port reachability retries.
String[]	env A list of environmental variables.
boolean	link A flag that indicates whether to link the virtual resource nodes.
long	maxDelay Max delay for exponentially backoff between port reachability retries.
long	maxDuration Maximum retry duration before giving up waiting for ports to be reachable.
int	maxRetries Maximum number of retries before giving up waiting for ports to be reachable.
String	name The virtual resource instance name.
int	nodes The number of virtual resource nodes to start.
int[]	ports A list of ports exposed by the virtual resource that we should wait for to be reachable.
Class<? extends VirtualResourceProvider>	provider Specifies the virtual resource provider implementation class to use.
boolean	pull Auto pull the image from the virtual resource a registry.
Class	resourceContract Specifies the virtual resource's contract.
String	resourceName Specifies the virtual resource's name.
long	timeout Maximum duration to wait for an image to be pulled before giving up entirely.
TimeUnit	unit Time unit for delay, max delay, and duration.
String	version The version of the virtual resource.

Element Detail

value

public abstract String value

The name of the virtual resource. Note that the name of the virtual resource depends on the virtual resource provider implementation (i.e. for docker the name is the image name).

Returns:

image name

version

public abstract String version

The version of the virtual resource. Note that the version of the virtual resource depends on the virtual resource provider implementation (i.e. for docker the version is the image tag).

Returns:

the image version.

Default:

""

cmd

public abstract String cmd

The command used to execute the virtual resource.

Returns:

the command.

Default:

""

pull

public abstract boolean pull

Auto pull the image from the virtual resource a registry.

Returns:

true if the image will be pulled, false otherwise

Default:

true

name

public abstract String name

The virtual resource instance name. This useful for giving the virtual resource instance a unique name to distinguish it from other virtual resource instances.

By default if the name is not specified the image name will be used as the name of the virtual instance.

Returns:

the unique name of the virtual instance

Default:

""

configKey

public abstract String configKey

The configuration section key in .testify.yml associated with the virtual resource.

Returns:

the configKey section key.

Default:

""

dataFiles

public abstract String[] dataFiles

A list of classpath data files that should be loaded by the virtual resource prior to being used. Note that FileSystem.getPathMatcher(java.lang.String) glob patterns are supported

Returns:

an array of data file names or glob patterns.

Default:

{}

dataProvider

public abstract Class<? extends DataProvider> dataProvider

Specifies a data provider implementations that loads data into the resource prior to it being used.

Returns:

the data provider implementation class.

Default:

org.testifyproject.DataProvider.class

resourceName

public abstract String resourceName

Specifies the virtual resource's name. This useful for giving the resource instance a unique name that can be used to qualify and distinguish it from other similar resources.

Note that if the name is not specified the name provided by the virtual resource provider implementation will be used.

Returns:

the virtual resource's name.

Default:

""

resourceContract

public abstract Class resourceContract

Specifies the virtual resource's contract. This useful for getting the virtual resource by its contract.

Note that if the contract is not specified the resource instance will be injectable by its implementation class only.

Returns:

the virtual resource's contract type.

Default:

void.class

nodes

public abstract int nodes

The number of virtual resource nodes to start.

Returns:

the number of nodes.

Default:

1

link

public abstract boolean link

A flag that indicates whether to link the virtual resource nodes.

Returns:

true if the nodes should be linked.

Default:

true

env

public abstract String[] env

A list of environmental variables. Note that the the environmental variables can contain expressions.

Returns:

a list of environmental variables.

Default:

{}

await

public abstract boolean await

A flag that indicate whether to wait for all virtual resource ports to be reachable.

Returns:

wait for ports to be reachable if true, false otherwise.

Default:

true

ports

public abstract int[] ports

A list of ports exposed by the virtual resource that we should wait for to be reachable.

Returns:

a list of ports

Default:

{}

delay

public abstract long delay

The amount of time to wait between port reachability retries. By default the time unit is milliseconds and the time unit can be set via unit().

Returns:

delay time between retries

Default:

1000L

maxDelay

public abstract long maxDelay

Max delay for exponentially backoff between port reachability retries. By default the time unit is milliseconds and the time unit can be set via unit().

Returns:

max delay

Default:

8000L

maxRetries

public abstract int maxRetries

Maximum number of retries before giving up waiting for ports to be reachable.

Returns:

max retries.

Default:

5

maxDuration

public abstract long maxDuration

Maximum retry duration before giving up waiting for ports to be reachable. By default the time unit is milliseconds and the time unit can be set via unit().

Returns:

max retries.

Default:

32000L

timeout

public abstract long timeout

Maximum duration to wait for an image to be pulled before giving up entirely. By default the time unit is milliseconds and the time unit can be set via unit().

Returns:

timeout duration.

Default:

60000L

unit

public abstract TimeUnit unit

Time unit for delay, max delay, and duration.

Returns:

time unit

Default:

java.util.concurrent.TimeUnit.MILLISECONDS

provider

public abstract Class<? extends VirtualResourceProvider> provider

Specifies the virtual resource provider implementation class to use. If a provider is not specified one will be discovered in the class path.

Returns:

virtual resource provider implementation class.

Default:

org.testifyproject.VirtualResourceProvider.class