org.testifyproject

Interface TestContext

All Superinterfaces:

PropertiesReader, PropertiesTrait, PropertiesWriter

public interface TestContext
extends PropertiesReader, PropertiesWriter

A small context class that contains reference to the test testInstance, the test testDescriptor, and helper methods.

Author:

saden

Method Summary

Modifier and Type	Method and Description
TestContext	addError(Boolean condition, String messageFormat, Object... args) Add an error message to the test context if the given condition is true.
TestContext	addError(String messageFormat, Object... args) Add an error message to the test context.
TestContext	addWarning(Boolean condition, String messageFormat, Object... args) Add an warning message to the test context if the given condition is true.
TestContext	addWarning(String messageFormat, Object... args) Add an warning message to the test context.
Collection<String>	getErrors() Get the error messages associated with the test context.
Collection<LocalResourceInfo>	getLocalResources() Get the local resource instances associated with the test.
String	getMethodName() Get the name of the test method associated with the test context.
MockProvider	getMockProvider() Get the mock provider associated with the test context.
String	getName() Get a unique name to identify the test context.
Collection<RemoteResourceInfo>	getRemoteResources() Get the remote resource instances associated with the test.
Optional<ServiceInstance>	getServiceInstance() Get the service instance associated with the test context.
Optional<SutDescriptor>	getSutDescriptor() Get the system under test descriptor.
<T> Optional<T>	getSutInstance() get the sut class instance.
Class<? extends Annotation>	getTestCategory() Get the test category associated with the test.
Class<?>	getTestClass() Get test class associated with the test context.
ClassLoader	getTestClassLoader() The class loader associated with the test class.
TestConfigurer	getTestConfigurer() Get the test configurer associated with the test context.
TestDescriptor	getTestDescriptor() Get the test class descriptor.
Object	getTestInstance() Get the test class instance.
MethodDescriptor	getTestMethodDescriptor() Get the test method descriptor associated with the test context.
String	getTestName() Get the simple name of the test class.
TestRunner	getTestRunner() Get the test runner associated with the test context.
Collection<VirtualResourceInfo>	getVirtualResources() Get the virtual resource instances associated with the test.
Collection<String>	getWarnings() Get the warning messages associated with the test context.
void	verify() Verify the integrity test context.

Methods inherited from interface org.testifyproject.trait.PropertiesReader

findCollection, findMap, findProperty, getPropertiesReader, getProperty

Methods inherited from interface org.testifyproject.trait.PropertiesWriter

addCollectionElement, addMapEntry, addProperty, computeIfAbsent

Methods inherited from interface org.testifyproject.trait.PropertiesTrait

getProperties, isEmpty

Method Detail

getName

String getName()

Get a unique name to identify the test context.

Returns:

a unique test context name

getTestName

String getTestName()

Get the simple name of the test class.

Returns:

the test class simple name

getMethodName

String getMethodName()

Get the name of the test method associated with the test context.

Returns:

test method name

getTestMethodDescriptor

MethodDescriptor getTestMethodDescriptor()

Get the test method descriptor associated with the test context.

Returns:

test method descriptor

getTestClass

Class<?> getTestClass()

Get test class associated with the test context.

Returns:

the test class instance

getTestClassLoader

ClassLoader getTestClassLoader()

The class loader associated with the test class.

Returns:

the test class classloader

getTestDescriptor

TestDescriptor getTestDescriptor()

Get the test class descriptor.

Returns:

the test class descriptor.

getSutDescriptor

Optional<SutDescriptor> getSutDescriptor()

Get the system under test descriptor.

Returns:

an optional with sut descriptor, empty optional otherwise

getTestInstance

Object getTestInstance()

Get the test class instance.

Returns:

an instance of the test class.

getSutInstance

<T> Optional<T> getSutInstance()

get the sut class instance.

Type Parameters:

T - sut instance type

Returns:

an instance of the sut class.

getTestRunner

TestRunner getTestRunner()

Get the test runner associated with the test context.

Returns:

test runner instance

getTestConfigurer

TestConfigurer getTestConfigurer()

Get the test configurer associated with the test context.

Returns:

test configurer instance

getMockProvider

MockProvider getMockProvider()

Get the mock provider associated with the test context.

Returns:

mock provider instance

getServiceInstance

Optional<ServiceInstance> getServiceInstance()

Get the service instance associated with the test context.

Returns:

an optional with service instance, empty optional otherwise

getTestCategory

Class<? extends Annotation> getTestCategory()

Get the test category associated with the test. Note that the annotation returned will be UnitCategory, IntegrationCategory, or SystemCategory.

Returns:

the test category annotation

getLocalResources

Collection<LocalResourceInfo> getLocalResources()

Get the local resource instances associated with the test.

Returns:

a collection of local resource instances, empty list otherwise

getVirtualResources

Collection<VirtualResourceInfo> getVirtualResources()

Get the virtual resource instances associated with the test.

Returns:

a collection of virtual resource instances, empty list otherwise

getRemoteResources

Collection<RemoteResourceInfo> getRemoteResources()

Get the remote resource instances associated with the test.

Returns:

a collection of remote resource instances, empty list otherwise

addError

TestContext addError(String messageFormat,
                     Object... args)

Add an error message to the test context.

Parameters:

messageFormat - the message format

args - message format arguments

Returns:

this object

addError

TestContext addError(Boolean condition,
                     String messageFormat,
                     Object... args)

Add an error message to the test context if the given condition is true.

Parameters:

condition - the condition that will used to determine if the condition is added

messageFormat - the message format

args - message format arguments

Returns:

this object

getErrors

Collection<String> getErrors()

Get the error messages associated with the test context.

Returns:

a list of error messages, empty list otherwise.

addWarning

TestContext addWarning(String messageFormat,
                       Object... args)

Add an warning message to the test context.

Parameters:

messageFormat - the message format

args - message format arguments

Returns:

this object

addWarning

TestContext addWarning(Boolean condition,
                       String messageFormat,
                       Object... args)

Add an warning message to the test context if the given condition is true.

Parameters:

condition - the condition that will used to determine if the condition is added

messageFormat - the message format

args - message format arguments

Returns:

this object

getWarnings

Collection<String> getWarnings()

Get the warning messages associated with the test context.

Returns:

a list of warning messages, empty list otherwise.

verify

void verify()

Verify the integrity test context. This method checks to see if the test has any errors or warning. If errors are found they are reported and the test is terminated. If warnings are found they are reported and the test continues to execute.