com.consol.citrus.context

Class TestContext

java.lang.Object

com.consol.citrus.context.TestContext

public class TestContext
extends Object

Class holding and managing test variables. The test context also provides utility methods for replacing dynamic content(variables and functions) in message payloads and headers.

Author:

Christoph Deppisch

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,StopTimer>	timers Timers registered in test context, that can be stopped
protected Map<String,Object>	variables Local variables

Constructor Summary

Constructors

Constructor and Description
TestContext() Default constructor

Method Summary

Modifier and Type	Method and Description
void	addException(CitrusRuntimeException exception) Add new exception to the context marking the test as failed.
void	addVariables(Map<String,Object> variablesToSet) Add several new variables to test context.
void	addVariables(String[] variableNames, Object[] variableValues) Add variables to context.
void	clear() Clears variables in this test context.
org.springframework.context.ApplicationContext	getApplicationContext() Gets the Spring bean application context.
EndpointFactory	getEndpointFactory() Gets the endpoint factory.
List<CitrusRuntimeException>	getExceptions() Gets the value of the exceptions property.
FunctionRegistry	getFunctionRegistry() Get the current function registry.
GlobalMessageConstructionInterceptors	getGlobalMessageConstructionInterceptors() Gets the global message construction interceptors.
Map<String,Object>	getGlobalVariables() Set global variables.
MessageListeners	getMessageListeners() Gets the message listeners.
MessageStore	getMessageStore() Gets the value of the messageStore property.
MessageValidatorRegistry	getMessageValidatorRegistry() Get the message validator registry.
NamespaceContextBuilder	getNamespaceContextBuilder() Gets the namespace context builder.
ReferenceResolver	getReferenceResolver() Gets the value of the referenceResolver property.
TestListeners	getTestListeners() Gets the test listeners.
ValidationMatcherRegistry	getValidationMatcherRegistry() Get the current validation matcher registry
String	getVariable(String variableExpression) Gets the value for the given variable expression.
<T> T	getVariable(String variableExpression, Class<T> type) Gets typed variable value.
Object	getVariableObject(String variableExpression) Gets the value for the given variable as object representation.
Map<String,Object>	getVariables() Getter for test variables in this context.
CitrusRuntimeException	handleError(String testName, String packageName, String message, Exception cause) Handles error creating a new CitrusRuntimeException and informs test listeners.
boolean	hasVariables() Checks if variables are present right now.
void	onInboundMessage(Message receivedMessage) Informs message listeners if present that inbound message was received.
void	onOutboundMessage(Message message) Informs message listeners if present that new outbound message is about to be sent.
void	registerTimer(String timerId, StopTimer timer) Registers a StopTimer in the test context, so that the associated timer can be stopped later on.
String	replaceDynamicContentInString(String str) Method replacing variable declarations and place holders as well as function expressions in a string
String	replaceDynamicContentInString(String str, boolean enableQuoting) Method replacing variable declarations and functions in a string, optionally the variable values get surrounded with single quotes.
String	resolveDynamicValue(String expression) Checks weather the given expression is a variable or function and resolves the value accordingly
<T> T[]	resolveDynamicValuesInArray(T[] array) Replaces variables and functions in array with respective values and returns the new array representation.
<T> List<T>	resolveDynamicValuesInList(List<T> list) Replaces variables and functions in a list with respective values and returns the new list representation.
<T> Map<String,T>	resolveDynamicValuesInMap(Map<String,T> map) Replaces variables and functions inside a map with respective values and returns a new map representation.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext) Sets the Spring bean application context.
void	setEndpointFactory(EndpointFactory endpointFactory) Sets the endpoint factory.
void	setFunctionRegistry(FunctionRegistry functionRegistry) Set the function registry.
void	setGlobalMessageConstructionInterceptors(GlobalMessageConstructionInterceptors messageConstructionInterceptors) Sets the global messsage construction interceptors.
void	setGlobalVariables(GlobalVariables globalVariables) Get global variables.
void	setMessageListeners(MessageListeners messageListeners) Set the message listeners.
void	setMessageStore(MessageStore messageStore) Sets the messageStore property.
void	setMessageValidatorRegistry(MessageValidatorRegistry messageValidatorRegistry) Set the message validator registry.
void	setNamespaceContextBuilder(NamespaceContextBuilder namespaceContextBuilder) Sets the namespace context builder.
void	setReferenceResolver(ReferenceResolver referenceResolver) Sets the referenceResolver property.
void	setTestListeners(TestListeners testListeners) Set the test listeners.
void	setValidationMatcherRegistry(ValidationMatcherRegistry validationMatcherRegistry) Set the validation matcher registry
void	setVariable(String variableName, Object value) Creates a new variable in this test context with the respective value.
void	setVariables(Map<String,Object> variables) Setter for test variables in this context.
boolean	stopTimer(String timerId) Stops the timer matching the supplied id
void	stopTimers() Stops all timers

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

variables

protected Map<String,Object> variables

Local variables

timers

protected Map<String,StopTimer> timers

Timers registered in test context, that can be stopped

Constructor Detail

TestContext

public TestContext()

Default constructor

Method Detail

getVariable

public String getVariable(String variableExpression)

Gets the value for the given variable expression. Expression usually is the simple variable name, with optional expression prefix/suffix. In case variable is not known to the context throw runtime exception.

Parameters:

variableExpression - expression to search for.

Returns:

value of the variable

Throws:

CitrusRuntimeException

getVariable

public <T> T getVariable(String variableExpression,
                         Class<T> type)

Gets typed variable value.

Type Parameters:

T -

Parameters:

variableExpression -

type -

Returns:

getVariableObject

public Object getVariableObject(String variableExpression)

Gets the value for the given variable as object representation. Use this method if you seek for test objects stored in the context.

Parameters:

variableExpression - expression to search for.

Returns:

value of the variable as object

Throws:

CitrusRuntimeException

setVariable

public void setVariable(String variableName,
                        Object value)

Creates a new variable in this test context with the respective value. In case variable already exists variable is overwritten.

Parameters:

variableName - the name of the new variable

value - the new variable value

Throws:

CitrusRuntimeException

addVariables

public void addVariables(String[] variableNames,
                         Object[] variableValues)

Add variables to context.

Parameters:

variableNames - the variable names to set

variableValues - the variable values to set

addVariables

public void addVariables(Map<String,Object> variablesToSet)

Add several new variables to test context. Existing variables will be overwritten.

Parameters:

variablesToSet - the list of variables to set.

resolveDynamicValuesInMap

public <T> Map<String,T> resolveDynamicValuesInMap(Map<String,T> map)

Replaces variables and functions inside a map with respective values and returns a new map representation.

Parameters:

map - optionally having variable entries.

Returns:

the constructed map without variable entries.

resolveDynamicValuesInList

public <T> List<T> resolveDynamicValuesInList(List<T> list)

Replaces variables and functions in a list with respective values and returns the new list representation.

Parameters:

list - having optional variable entries.

Returns:

the constructed list without variable entries.

resolveDynamicValuesInArray

public <T> T[] resolveDynamicValuesInArray(T[] array)

Replaces variables and functions in array with respective values and returns the new array representation.

Parameters:

array - having optional variable entries.

Returns:

the constructed list without variable entries.

clear

public void clear()

Clears variables in this test context. Initially adds all global variables.

hasVariables

public boolean hasVariables()

Checks if variables are present right now.

Returns:

boolean flag to mark existence

replaceDynamicContentInString

public String replaceDynamicContentInString(String str)

Method replacing variable declarations and place holders as well as function expressions in a string

Parameters:

str - the string to parse.

Returns:

resulting string without any variable place holders.

replaceDynamicContentInString

public String replaceDynamicContentInString(String str,
                                            boolean enableQuoting)

Method replacing variable declarations and functions in a string, optionally the variable values get surrounded with single quotes.

Parameters:

str - the string to parse for variable place holders.

enableQuoting - flag marking surrounding quotes should be added or not.

Returns:

resulting string without any variable place holders.

resolveDynamicValue

public String resolveDynamicValue(String expression)

Checks weather the given expression is a variable or function and resolves the value accordingly

Parameters:

expression - the expression to resolve

Returns:

the resolved expression value

handleError

public CitrusRuntimeException handleError(String testName,
                                          String packageName,
                                          String message,
                                          Exception cause)

Handles error creating a new CitrusRuntimeException and informs test listeners.

Parameters:

testName -

packageName -

message -

cause -

Returns:

setVariables

public void setVariables(Map<String,Object> variables)

Setter for test variables in this context.

Parameters:

variables -

getVariables

public Map<String,Object> getVariables()

Getter for test variables in this context.

Returns:

test variables for this test context.

setGlobalVariables

public void setGlobalVariables(GlobalVariables globalVariables)

Get global variables.

Parameters:

globalVariables -

getGlobalVariables

public Map<String,Object> getGlobalVariables()

Set global variables.

Returns:

the globalVariables

setMessageStore

public void setMessageStore(MessageStore messageStore)

Sets the messageStore property.

Parameters:

messageStore -

getMessageStore

public MessageStore getMessageStore()

Gets the value of the messageStore property.

Returns:

the messageStore

getFunctionRegistry

public FunctionRegistry getFunctionRegistry()

Get the current function registry.

Returns:

the functionRegistry

setFunctionRegistry

public void setFunctionRegistry(FunctionRegistry functionRegistry)

Set the function registry.

Parameters:

functionRegistry - the functionRegistry to set

setMessageValidatorRegistry

public void setMessageValidatorRegistry(MessageValidatorRegistry messageValidatorRegistry)

Set the message validator registry.

Parameters:

messageValidatorRegistry - the messageValidatorRegistry to set

getMessageValidatorRegistry

public MessageValidatorRegistry getMessageValidatorRegistry()

Get the message validator registry.

Returns:

the messageValidatorRegistry

getValidationMatcherRegistry

public ValidationMatcherRegistry getValidationMatcherRegistry()

Get the current validation matcher registry

Returns:

setValidationMatcherRegistry

public void setValidationMatcherRegistry(ValidationMatcherRegistry validationMatcherRegistry)

Set the validation matcher registry

Parameters:

validationMatcherRegistry -

getMessageListeners

public MessageListeners getMessageListeners()

Gets the message listeners.

Returns:

setMessageListeners

public void setMessageListeners(MessageListeners messageListeners)

Set the message listeners.

Parameters:

messageListeners -

getTestListeners

public TestListeners getTestListeners()

Gets the test listeners.

Returns:

setTestListeners

public void setTestListeners(TestListeners testListeners)

Set the test listeners.

Parameters:

testListeners -

getGlobalMessageConstructionInterceptors

public GlobalMessageConstructionInterceptors getGlobalMessageConstructionInterceptors()

Gets the global message construction interceptors.

Returns:

setGlobalMessageConstructionInterceptors

public void setGlobalMessageConstructionInterceptors(GlobalMessageConstructionInterceptors messageConstructionInterceptors)

Sets the global messsage construction interceptors.

Parameters:

messageConstructionInterceptors -

getEndpointFactory

public EndpointFactory getEndpointFactory()

Gets the endpoint factory.

Returns:

setEndpointFactory

public void setEndpointFactory(EndpointFactory endpointFactory)

Sets the endpoint factory.

Parameters:

endpointFactory -

getReferenceResolver

public ReferenceResolver getReferenceResolver()

Gets the value of the referenceResolver property.

Returns:

the referenceResolver

setReferenceResolver

public void setReferenceResolver(ReferenceResolver referenceResolver)

Sets the referenceResolver property.

Parameters:

referenceResolver -

setNamespaceContextBuilder

public void setNamespaceContextBuilder(NamespaceContextBuilder namespaceContextBuilder)

Sets the namespace context builder.

Parameters:

namespaceContextBuilder -

getNamespaceContextBuilder

public NamespaceContextBuilder getNamespaceContextBuilder()

Gets the namespace context builder.

Returns:

getApplicationContext

public org.springframework.context.ApplicationContext getApplicationContext()

Gets the Spring bean application context.

Returns:

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Sets the Spring bean application context.

Parameters:

applicationContext -

onInboundMessage

public void onInboundMessage(Message receivedMessage)

Informs message listeners if present that inbound message was received.

Parameters:

receivedMessage -

onOutboundMessage

public void onOutboundMessage(Message message)

Informs message listeners if present that new outbound message is about to be sent.

Parameters:

message -

registerTimer

public void registerTimer(String timerId,
                          StopTimer timer)

Registers a StopTimer in the test context, so that the associated timer can be stopped later on.

Parameters:

timerId - a unique timer id

stopTimer

public boolean stopTimer(String timerId)

Stops the timer matching the supplied id

Parameters:

timerId -

Returns:

true if time found and stopped, matching the supplied timerId

stopTimers

public void stopTimers()

Stops all timers

addException

public void addException(CitrusRuntimeException exception)

Add new exception to the context marking the test as failed. This is usually used by actions to mark exceptions during forked operations.

Parameters:

exception -

getExceptions

public List<CitrusRuntimeException> getExceptions()

Gets the value of the exceptions property.

Returns:

the exceptions