org.adroitlogic.x.test.util

Class ElementTestUtils

java.lang.Object

org.adroitlogic.x.test.util.ElementTestUtils

public class ElementTestUtils
extends Object

This class contains utility methods to be used for unit tests of connectors and processing elements

Since:

17.01

Author:

Udith Gunaratna

Constructor Summary

Constructors

Constructor and Description
ElementTestUtils()

Method Summary

Modifier and Type	Method and Description
static XMessageContext	getBasicMessageContext(org.springframework.context.ApplicationContext applicationContext) This method can be used to retrieve an instance of XMessageContext with only the global scope and XPlatform set.
static XMessage	getEmptyMessage() This method can be used to retrieve an instance of XMessage with empty payload
static Optional<String>	getMessageProperty(XMessageView messageView, String propertyKey) This method can be used to retrieve the message property with the given propertyKey from the given messageView
static IntegrationFlow	getMockIntegrationFlow(org.springframework.context.ApplicationContext context) Returns a mock instance of IntegrationFlow with the flow name "sample-flow" and belongs to a mock project created with getMockProject(ApplicationContext) method
static IntegrationFlow	getMockIntegrationFlow(Project project) Returns a mock instance of IntegrationFlow with the flow name "sample-flow" and belongs to the provided project
static IntegrationFlow	getMockIntegrationFlow(Project project, String flowName) Returns a mock instance of IntegrationFlow with the provided name and belongs to the provided project
static Project	getMockProject(org.springframework.context.ApplicationContext context) Returns a mock instance of Project with the following basic properties set Project ID : 1 Project Name : sample-project Project Version : 1.0
static ProjectConfig	getMockProjectConfig()
static Optional<String>	getTransportHeader(XMessageView messageView, String headerKey) This method can be used to retrieve the transport header with the given headerKey from the given messageView
static boolean	hasMessageProperty(XMessageView messageView, String propertyKey) This method can be used to check whether the given messageView has a message property with the given propertyKey
static boolean	hasTransportHeader(XMessageView messageView, String headerKey) This method can be used to check whether the given messageView has a transport header with the given headerKey
static File	readFileFromClassPath(ClassLoader classLoader, String filePath) Utility method to read a file from the classpath to be used in tests

Methods inherited from class java.lang.Object

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

Constructor Detail

ElementTestUtils

public ElementTestUtils()

Method Detail

getBasicMessageContext

public static XMessageContext getBasicMessageContext(org.springframework.context.ApplicationContext applicationContext)

This method can be used to retrieve an instance of XMessageContext with only the global scope and XPlatform set. It also contains an instance of XMessage with empty payload.

The concrete test class is responsible for setting all the necessary properties to both XMessageContext and XMessage before using them in a test.

Parameters:

applicationContext - the spring application context to create a new message context

Returns:

instance of XMessageContext

getEmptyMessage

public static XMessage getEmptyMessage()

This method can be used to retrieve an instance of XMessage with empty payload

The concrete test class is responsible for setting all the necessary properties to the XMessage before using it in a test.

Returns:

instance of XMessage

hasTransportHeader

public static boolean hasTransportHeader(XMessageView messageView,
                                         String headerKey)

This method can be used to check whether the given messageView has a transport header with the given headerKey

Parameters:

messageView - instance of XMessageView to be checked for the transport header

headerKey - key of the header as String to be checked

Returns:

true if present, false otherwise

getTransportHeader

public static Optional<String> getTransportHeader(XMessageView messageView,
                                                  String headerKey)

This method can be used to retrieve the transport header with the given headerKey from the given messageView

Parameters:

messageView - instance of XMessageView from which the transport header should be retrieved

headerKey - key of the header as String to be retrieved

Returns:

instance of Optional of type String containing the header value if present, Optional.EMPTY otherwise

hasMessageProperty

public static boolean hasMessageProperty(XMessageView messageView,
                                         String propertyKey)

This method can be used to check whether the given messageView has a message property with the given propertyKey

Parameters:

messageView - instance of XMessageView to be checked for the message property

propertyKey - key of the message property as String to be checked

Returns:

true if present, false otherwise

getMessageProperty

public static Optional<String> getMessageProperty(XMessageView messageView,
                                                  String propertyKey)

This method can be used to retrieve the message property with the given propertyKey from the given messageView

Parameters:

messageView - instance of XMessageView from which the message property should be retrieved

propertyKey - key of the message property as String to be retrieved

Returns:

instance of Optional of type String containing the message property value if present, Optional.EMPTY otherwise

getMockProject

public static Project getMockProject(org.springframework.context.ApplicationContext context)

Returns a mock instance of Project with the following basic properties set

• Project ID : 1
• Project Name : sample-project
• Project Version : 1.0

Parameters:

context - ApplicationContext to be used

Returns:

instance of Project

getMockProjectConfig

public static ProjectConfig getMockProjectConfig()

getMockIntegrationFlow

public static IntegrationFlow getMockIntegrationFlow(org.springframework.context.ApplicationContext context)

Returns a mock instance of IntegrationFlow with the flow name "sample-flow" and belongs to a mock project created with getMockProject(ApplicationContext) method

Parameters:

context - ApplicationContext to be used

Returns:

instance of IntegrationFlow belongs to a mock project

getMockIntegrationFlow

public static IntegrationFlow getMockIntegrationFlow(Project project)

Returns a mock instance of IntegrationFlow with the flow name "sample-flow" and belongs to the provided project

Parameters:

project - instance of Project to which this integration flow should belong to

Returns:

instance of IntegrationFlow belongs to the given project

getMockIntegrationFlow

public static IntegrationFlow getMockIntegrationFlow(Project project,
                                                     String flowName)

Returns a mock instance of IntegrationFlow with the provided name and belongs to the provided project

Parameters:

project - instance of Project to which this integration flow should belong to

flowName - name of the integration flow

Returns:

instance of IntegrationFlow with the given name and belongs to the given project

readFileFromClassPath

public static File readFileFromClassPath(ClassLoader classLoader,
                                         String filePath)
                                  throws URISyntaxException

Utility method to read a file from the classpath to be used in tests

Parameters:

classLoader - classloader to be used to read the file as a classpath resource

filePath - path to the file location

Returns:

a File instance if the resource was found

Throws:

URISyntaxException - if the provided file path is not valid

IllegalArgumentException - if a resource with the provided file path cannot be found