org.testifyproject

Interface RemoteResourceProvider<T,C>

Type Parameters:

T - the configuration type

C - the client type

public interface RemoteResourceProvider<T,C>

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

Author:

saden

Method Summary

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

Method Detail

configure

T configure(TestContext testContext,
            RemoteResource remoteResource,
            PropertiesReader configReader)

A method to configure a remote resource. Configuring a remote 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 remote resource as that should be handled in start(org.testifyproject.TestContext, org.testifyproject.annotation.RemoteResource, 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 RemoteResource.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.RemoteResource, java.lang.Object) method

Parameters:

testContext - the test context

remoteResource - test class remote resource annotation

configReader - a configuration properties reader

Returns:

the remote resource configuration object

start

RemoteResourceInstance<C> start(TestContext testContext,
                                RemoteResource remoteResource,
                                T config)
                         throws Exception

Start the remote resource with the given testContext and configuration.

Parameters:

testContext - the test context

remoteResource - test class remote resource annotation

config - the remote resource configuration

Returns:

a remote resource instance

Throws:

Exception - an exception thrown while starting

load

default void load(TestContext testContext,
                  RemoteResource remoteResource,
                  RemoteResourceInstance<C> 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

remoteResource - test class remote resource annotation

instance - the remote resource instance

dataFiles - a data files that should be loaded

Throws:

Exception - an exception thrown while loading data

stop

void stop(TestContext testContext,
          RemoteResource remoteResource,
          RemoteResourceInstance<C> instance)
   throws Exception

Stop the remote resource.

Parameters:

testContext - the test context

remoteResource - test class remote resource annotation

instance - the remote resource instance

Throws:

Exception - an exception thrown while stopping