org.testifyproject

Interface LocalResourceProvider<T,R,C>

Type Parameters:

T - the configuration type

R - the resource type

C - the client type

public interface LocalResourceProvider<T,R,C>

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

Author:

saden

Method Summary

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

Method Detail

configure

T configure(TestContext testContext,
            LocalResource localResource,
            PropertiesReader configReader)

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

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 local resource as that should be handled in start(org.testifyproject.TestContext, org.testifyproject.annotation.LocalResource, 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 LocalResource.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.LocalResource, java.lang.Object) method

Parameters:

testContext - the test context

localResource - test class local resource annotation

configReader - the value of configReader

Returns:

the T

start

LocalResourceInstance<R,C> start(TestContext testContext,
                                 LocalResource localResource,
                                 T config)
                          throws Exception

Start the local resource with the given testContext and configuration.

Parameters:

testContext - the test context

localResource - test class local resource annotation

config - the local resource configuration

Returns:

a local resource instance

Throws:

Exception - an exception thrown while starting

load

default void load(TestContext testContext,
                  LocalResource localResource,
                  LocalResourceInstance<R,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

localResource - test class local resource annotation

instance - the local resource instance

dataFiles - a data files that should be loaded

Throws:

Exception - an exception thrown while loading data

stop

void stop(TestContext testContext,
          LocalResource localResource,
          LocalResourceInstance<R,C> instance)
   throws Exception

Stop the local resource.

Parameters:

testContext - the test context

localResource - test class local resource annotation

instance - the local resource instance

Throws:

Exception - an exception thrown while stopping