org.testifyproject.annotation

Annotation Type Application

@Documented
 @Retention(value=RUNTIME)
 @Target(value={ANNOTATION_TYPE,TYPE})
public @interface Application

An annotation that can be placed on system test to specify an application that should be loaded, configured, started, and stopped before and after each test run (i.e. Jersey 2, Spring Boot, Spring MVC, etc).

Author:

saden

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<?>	value The class of the application under test that will be configured, started and stopped before and after each test run.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class	clientContract Specifies the contract implemented by the client.
String	clientName Specifies the client name.
Class<? extends ClientProvider>	clientProvider Specifies the class that provides client provider implementation.
Class	clientProviderHint Specifies a class that aids in the construction of a client.
Class	clientSupplierContract Specifies the contract implemented by the client supplier.
String	clientSupplierName Specifies the client supplier name.
Class	serverContract Specifies the contract implemented by the server.
String	serverName Specifies the server name.
Class<? extends ServerProvider>	serverProvider Specifies the class that provides server provider implementation.
String	start Specifies the name of the method on the application that will called to start the application.
String	stop Specifies the name of the method on the application that will called to stop the application.

Element Detail

value

public abstract Class<?> value

The class of the application under test that will be configured, started and stopped before and after each test run.

Returns:

the application class.

clientProvider

public abstract Class<? extends ClientProvider> clientProvider

Specifies the class that provides client provider implementation. If a provider is not specified one will be discovered in the class path.

Returns:

client provider implementation class.

Default:

org.testifyproject.ClientProvider.class

clientName

public abstract String clientName

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

Note that the default client name is "applicationClient".

Returns:

a the client name.

Default:

"applicationClient"

clientContract

public abstract Class clientContract

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

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

Returns:

the client contract class

Default:

void.class

clientSupplierName

public abstract String clientSupplierName

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

Returns:

a the client supplier name.

Default:

"applicationClientSupplier"

clientSupplierContract

public abstract Class clientSupplierContract

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

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

Returns:

the client supplier contract class

Default:

void.class

clientProviderHint

public abstract Class clientProviderHint

Specifies a class that aids in the construction of a client. This is useful when the application being tested is an RPC application and the creation of a client requires we construct the client from stubs (i.e. gRPC).

Returns:

the client supplier hint class

Default:

void.class

serverProvider

public abstract Class<? extends ServerProvider> serverProvider

Specifies the class that provides server provider implementation. If a provider is not specified one will be discovered in the class path.

Returns:

server provider implementation class.

Default:

org.testifyproject.ServerProvider.class

serverName

public abstract String serverName

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

Note that the default server name is "applicationServer".

Returns:

a the server name.

Default:

"applicationServer"

serverContract

public abstract Class serverContract

Specifies the contract implemented by the server. This useful for getting the server instance by its contract.

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

Returns:

the server contract class

Default:

void.class

start

public abstract String start

Specifies the name of the method on the application that will called to start the application. This is useful for managing the lifecycle of a generic application for testing purpose.

Note that the method specified must public, return a void and take no parameters (i.e. public void start().

Alternatively, the start method can be set to "main" which means public static void main(String[] args) method will be called. Using the main method as the start of course implies that the stop() method must be a static method (i.e. public static void stop().

Returns:

the application start method name

See Also:

stop()

Default:

""

stop

public abstract String stop

Specifies the name of the method on the application that will called to stop the application. This is useful for managing the lifecycle of a generic application for testing purpose.

Note that the method must be public, return a void and take no arguments (i.e. public void start()). In the event that the start() method is a "main" method then this method must also be a static method (i.e. public static void start()).

Returns:

the application stop method name

See Also:

start()

Default:

""