org.testifyproject.annotation

Annotation Type LocalResource

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

An annotation that can be placed on integration and system tests to specify resources that must be loaded, configured, started, stopped before and after each test case (i.e. an in-memory database).

Note that an local resource consists of a server component and client component (optional). For example, if a test class requires an in-memory database then the database DataSource can be thought of as the server component and the Connection to the DataSource as the client component.

Author:

saden

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<? extends LocalResourceProvider>	value Specifies the local resource's implementation provider class.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class	clientContract Specifies the contract implemented by the resource client.
String	clientName Specifies the resource's client name.
String	configKey The configuration section key in .testify.yml associated with the local resource.
String[]	dataFiles A list of classpath data files that should be loaded into the local 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.
String	name Specifies the name of the LocalResourceInstance provided by value().
Class	resourceContract Specifies the contract implemented by the underlying local resource.
String	resourceName Specifies the underlying local resource name.

Element Detail

value

public abstract Class<? extends LocalResourceProvider> value

Specifies the local resource's implementation provider class.

Returns:

the local resource implementation provider class.

name

public abstract String name

Specifies the name of the LocalResourceInstance provided by value().

Note that if a test class requires multiple resources that provide similar resources then name must be specified to resolve ambiguity as to which resource instance should be injected into your test code.

Returns:

the resource instance name.

Default:

""

configKey

public abstract String configKey

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

Returns:

the configKey section key.

Default:

""

dataFiles

public abstract String[] dataFiles

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

Returns:

an array of data file names or 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 underlying local resource name. This useful for giving the underlying resource a unique name that can be used to qualify and distinguish it from other similar services.

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

Returns:

the underlying local resource name.

Default:

""

resourceContract

public abstract Class resourceContract

Specifies the contract implemented by the underlying local resource. This useful for getting the underlying resource by its contract.

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

Returns:

the contract implemented by the underlying local resource.

Default:

void.class

clientName

public abstract String clientName

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

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

Returns:

the resource's client name.

Default:

""

clientContract

public abstract Class clientContract

Specifies the contract implemented by the resource client. This useful for getting the client resource by its contract.

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

Returns:

the resource's client contract class.

Default:

void.class