org.testifyproject

Interface VirtualResourceProvider<T>

Type Parameters:

T - the type virtual resource configuration object

public interface VirtualResourceProvider<T>

A contract that defines methods to configure, start an stop a virtual resource.

Author:

saden

Method Summary

Modifier and Type	Method and Description
T	configure(TestContext testContext, VirtualResource virtualResource, PropertiesReader configReader) A method to configure a virtual resource.
default void	load(TestContext testContext, VirtualResource virtualResource, VirtualResourceInstance instance, Set<String> dataFiles) Load the given list of data file into the local resource prior to the resource being used.
VirtualResourceInstance	start(TestContext testContext, VirtualResource virtualResource, T configuration) Start the virtual resource with the given testContext and configuration.
void	stop(TestContext testContext, VirtualResource virtualResource, VirtualResourceInstance instance) Stop the virtual resource.

Method Detail

configure

T configure(TestContext testContext,
            VirtualResource virtualResource,
            PropertiesReader configReader)

A method to configure a virtual resource. Configuring a virtual resource typically involves creating a default configuration object that can be further configured by a ConfigHandler method. Please note:

• Implementation of this method should not do any work beyond returning configuration object. It should be stateless and should not perform instantiation of the virtual resource as that should be handled in start(org.testifyproject.TestContext, org.testifyproject.annotation.VirtualResource, java.lang.Object) method.
• The value of PropertiesReader by default encapsulates .testify.yml configuration properties. A specific section in .testify.yml can be specified through VirtualResource.configKey().
• The configuration object returned by this method is simply default configuration. It can be updated or replaced with entirely new configuration object by the ConfigHandler method before it is passed to start(org.testifyproject.TestContext, org.testifyproject.annotation.VirtualResource, java.lang.Object) method

Parameters:

testContext - the test context

virtualResource - test class virtual resource annotation

configReader - the value of configReader

Returns:

the virtual resource configuration object

start

VirtualResourceInstance start(TestContext testContext,
                              VirtualResource virtualResource,
                              T configuration)
                       throws Exception

Start the virtual resource with the given testContext and configuration.

Parameters:

testContext - the test context

virtualResource - test class virtual resource annotation

configuration - the virtual resource configuration object

Returns:

a virtual resource instance

Throws:

Exception - an exception thrown while starting

load

default void load(TestContext testContext,
                  VirtualResource virtualResource,
                  VirtualResourceInstance instance,
                  Set<String> dataFiles)
           throws Exception

Load the given list of data file into the local resource prior to the resource being used. Note that by default this method does not have to be implemented.

Parameters:

testContext - the test context

virtualResource - test class remote resource annotation

instance - the virtual resource instance

dataFiles - a data files that should be loaded

Throws:

Exception - an exception thrown while loading data

stop

void stop(TestContext testContext,
          VirtualResource virtualResource,
          VirtualResourceInstance instance)
   throws Exception

Stop the virtual resource.

Parameters:

testContext - the test context

virtualResource - test class virtual resource annotation

instance - the value of instance

Throws:

Exception - an exception thrown while stopping