org.mule.modules.tests

Class ConnectorTestCase

java.lang.Object

org.mule.tck.junit4.AbstractMuleTestCase

org.mule.tck.junit4.AbstractMuleContextTestCase

org.mule.tck.junit4.FunctionalTestCase

org.mule.modules.tests.ConnectorTestCase

public class ConnectorTestCase
extends org.mule.tck.junit4.FunctionalTestCase

Connector Tests Framework Parent Class

Author:

Mulesoft, Inc

Field Summary

Fields

Modifier and Type	Field and Description
protected static Properties	automationCredentials
protected static String	DEFAULT_SPRING_CONFIG_FILE
protected static List<String>	SPRING_CONFIG_FILES

Fields inherited from class org.mule.tck.junit4.AbstractMuleContextTestCase

callbackCalled, CLASSNAME_ANNOTATIONS_CONFIG_BUILDER, IGNORED_DOT_MULE_DIRS, LOCK_TIMEOUT, muleContext, RECEIVE_TIMEOUT, TEST_MESSAGE, TEST_PAYLOAD, WORKING_DIRECTORY_SYSTEM_PROPERTY_KEY, workingDirectory

Fields inherited from class org.mule.tck.junit4.AbstractMuleTestCase

DEFAULT_TEST_TIMEOUT_SECS, globalTimeout, logger, name, TEST_TIMEOUT_SYSTEM_PROPERTY, TESTING_MODE_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
ConnectorTestCase()

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	addConfigSpringFile(String fileLocation) Add a file to be loaded on the spring context.
void	assertFirstLevelInputMetaDataSuccess(String flowName, org.mule.common.metadata.datatype.DataType expectedDataType) Asserts first level input MetaData was successfully retrieved for the processor under test and matches an expectedDataType
void	assertFirstLevelOutputMetaDataSuccess(String flowName, org.mule.common.metadata.datatype.DataType expectedDataType) Asserts first level output MetaData was successfully retrieved for the processor under test and matches an expectedDataType
void	assertGetMetaDataKeysSuccess(String configName) Asserts successful getMetaDataKeys result
void	assertIsMetaDataEnabled(String flowName) Asserts processor contained in an automation-test-flows.xml flow is MetaDataEnabled
void	assertListFirstLevelOutputMetaDataSuccess(String flowName, String expectedImplementationType) Asserts first level List output MetaData was successfully retrieved for the processor under test and it's elements are of specific class
void	assertMetaDataKeysContainsKeys(String configName, List<HashMap<String,String>> expectedMetaDataKeyList) Asserts selected MetaDataKeys are found among connector MetaDataKeys and their contents are correct
void	assertNotMetaDataEnabled(String flowName) Asserts processor contained in an automation-test-flows.xml flow is not MetaDataEnabled
void	assertNullInputMetaDataSuccess(String flowName) Asserts no input MetaData for the processor under test
void	assertNullOutputMetaDataSuccess(String flowName) Asserts no output MetaData for the processor under test
void	assertPOJOOutputMetaDataSuccess(String flowName, String expectedImplementationType) Asserts first level POJO output MetaData was successfully retrieved for the processor under test and is of specific class
void	clearTestData()
<T> T	getBeanFromContext(String beanId)
protected String	getConfigResources()
protected static String[]	getConfigSpringFiles()
protected String	getConfigXmlFile()
protected org.mule.common.Testable	getGlobalElementTestable(String globalElementName) Returns a Testable to exercise the test connection code on a test
org.mule.common.Result<org.mule.common.metadata.MetaData>	getInputMetaData(String flowName) Returns the MetaData Result of the input MetaData retrieved of the processor under test
org.mule.common.metadata.MetaDataModel	getInputMetaDataPayload(String flowName) Returns the MetaDataModel of the input MetaData retrieved of the processor under test
List<org.mule.common.metadata.MetaDataKey>	getMetaDataKeyList(String configName) Retrieves a List containing all of the connector's MetaDataKeys
org.mule.common.Result<org.mule.common.metadata.MetaData>	getOutputMetaData(String flowName) Returns the MetaData Result of the output MetaData retrieved of the processor under test
org.mule.common.metadata.MetaDataModel	getOutputMetaDataPayload(String flowName) Returns the MetaDataModel of the output MetaData retrieved of the processor under test
Set<String>	getTestRunMessageKeySet()
<T> T	getTestRunMessagePayload()
<T> T	getTestRunMessageValue(String key)
protected void	initializeTestRunMessage()
void	initializeTestRunMessage(Object data)
protected void	initializeTestRunMessage(String beanId) If beanId belongs to a POJO it is set as payloadContent.
void	initializeTestRunMessage(String key, Object value) Use payloadContent as key if you want a Map to be stored in the payload
boolean	keyContainedInTestRunMessage(Object key)
protected static void	loadTestFlows(String configResources)
void	loadTestRunMessage(Map<String,Object> data) Deprecated.
protected void	loadTestRunMessage(String beanId) Deprecated.
protected org.mule.construct.Flow	lookupFlowConstruct(String name)
void	removeFromTestRunMessage(String key)
protected <T> T	runFlowAndGetInvocationProperty(String flowName, String invocationProperty)
protected org.mule.api.MuleMessage	runFlowAndGetMessage(String flowName) TestRunMessage is already loaded with values for the operation
protected org.mule.api.MuleMessage	runFlowAndGetMessage(String flowName, String beanId) Returns the MuleMessage containing the payload of the operation.
protected <T> T	runFlowAndGetPayload(String flowName) TestRunMessage is already loaded with values for the operation
protected <T> T	runFlowAndGetPayload(String flowName, String beanId) Returns the Payload of the flowName operation.
protected <T> T	runFlowAndWaitForResponseVM(String messageFlow, String vmQueueName, long timeoutMs) Runs the flow named messageFlow and waits until a response is received on the VM queue named vmQueueName or a timeout is reached.
protected void	runFlowIgnoringPayload(String flowName)
protected static void	setConfigSpringFiles(List<String> configFilesLocation) Replace the list of spring beans to be loaded into the context.
static void	setUpBeforeClass()
void	upsertBeanFromContextOnTestRunMessage(String beanId)
void	upsertBeanFromContextOnTestRunMessage(String key, String beanId)
void	upsertOnTestRunMessage(Map<String,Object> data)
void	upsertOnTestRunMessage(String key, Object value)
void	upsertPayloadContentOnTestRunMessage(Object payloadContent)
protected void	verifyTestRunMessageIsInitialized()

Methods inherited from class org.mule.tck.junit4.FunctionalTestCase

clearFlowAssertions, getBuilder, getComponent, getComponent, getConfigFile, getConfigFiles, getFlowConstruct, getFunctionalTestComponent, getSubFlow, loadResource, loadResourceAsString, runFlow, runFlow, runFlow, runFlowAndExpect, runFlowAndExpectProperty, runFlowWithPayloadAndExpect, runSchedulersOnce, stopFlowConstruct, stopFlowSchedulers, testFlow, testFlow

Methods inherited from class org.mule.tck.junit4.AbstractMuleContextTestCase

addBuilders, configureMuleContext, createMuleContext, createObject, createObject, disposeContext, disposeContextPerTest, doSetUp, doSetUpBeforeMuleContextCreation, doTearDown, doTearDownAfterMuleContextDispose, getConfigurationResources, getFileInsideWorkingDirectory, getSensingNullMessageProcessor, getStartUpProperties, getTestConnector, getTestEvent, getTestEvent, getTestEvent, getTestEvent, getTestEvent, getTestEvent, getTestEvent, getTestEvent, getTestEventContext, getTestEventContext, getTestEventUsingFlow, getTestInboundEndpoint, getTestInboundEndpoint, getTestInboundEndpoint, getTestInboundEndpoint, getTestInboundEndpoint, getTestMuleMessage, getTestOutboundEndpoint, getTestOutboundEndpoint, getTestOutboundEndpoint, getTestOutboundEndpoint, getTestOutboundEndpoint, getTestService, getTestService, getTestService, getTestSession, getTestTransactedInboundEndpoint, getTestTransformer, getTriggerableMessageSource, getTriggerableMessageSource, getWorkingDirectory, initialiseObject, isDisposeContextPerClass, isGracefulShutdown, isStartContext, setDisposeContextPerClass, setStartContext, setUpMuleContext

Methods inherited from class org.mule.tck.junit4.AbstractMuleTestCase

clearExcludedFlag, clearRequestContext, clearTestCaseName, createTestTimeoutRule, dumpFilteredThreadsInTest, getTestHeader, getTestTimeoutSecs, getTimeoutSystemProperty, initializeMuleTest, isDisabledInThisEnvironment, isDisabledInThisEnvironment, isExcluded, isFailOnTimeout, isOffline, isTestIncludedInExclusionFile, takeTestCaseName

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SPRING_CONFIG_FILE

protected static final String DEFAULT_SPRING_CONFIG_FILE

See Also:

Constant Field Values

SPRING_CONFIG_FILES

protected static List<String> SPRING_CONFIG_FILES

automationCredentials

protected static Properties automationCredentials

Constructor Detail

ConnectorTestCase

public ConnectorTestCase()

Method Detail

loadTestFlows

protected static void loadTestFlows(String configResources)

setUpBeforeClass

public static void setUpBeforeClass()
                             throws Exception

Throws:

Exception

clearTestData

public final void clearTestData()

getConfigSpringFiles

protected static String[] getConfigSpringFiles()

addConfigSpringFile

protected static void addConfigSpringFile(String fileLocation)

Add a file to be loaded on the spring context.

Note:This method must be called from a static initializer static \{...\}

Parameters:

fileLocation - The location of the file containing the spring beans definitions

setConfigSpringFiles

protected static void setConfigSpringFiles(List<String> configFilesLocation)

Replace the list of spring beans to be loaded into the context.

Note:This method must be called from a static initializer static \{...\}

Parameters:

configFilesLocation - The list with the files location containing the spring beans definitions

getConfigResources

protected String getConfigResources()

Overrides:

getConfigResources in class org.mule.tck.junit4.FunctionalTestCase

getConfigXmlFile

protected String getConfigXmlFile()

verifyTestRunMessageIsInitialized

protected void verifyTestRunMessageIsInitialized()
                                          throws Exception

Throws:

Exception

lookupFlowConstruct

protected org.mule.construct.Flow lookupFlowConstruct(String name)

Overrides:

lookupFlowConstruct in class org.mule.tck.junit4.FunctionalTestCase

loadTestRunMessage

@Deprecated
protected void loadTestRunMessage(String beanId)

Deprecated.

Use initializeTestRunMessage instead

Parameters:

beanId -

loadTestRunMessage

@Deprecated
public void loadTestRunMessage(Map<String,Object> data)

Deprecated.

Use initializeTestRunMessage instead

Parameters:

data -

initializeTestRunMessage

protected void initializeTestRunMessage()

initializeTestRunMessage

protected void initializeTestRunMessage(String beanId)

If beanId belongs to a POJO it is set as payloadContent. What if Map needs to be set as payload, needs to be analysed.

initializeTestRunMessage

public void initializeTestRunMessage(String key,
                            Object value)

Use payloadContent as key if you want a Map to be stored in the payload

initializeTestRunMessage

public void initializeTestRunMessage(Object data)

getBeanFromContext

public <T> T getBeanFromContext(String beanId)
                     throws org.springframework.beans.BeansException

Throws:

org.springframework.beans.BeansException

upsertBeanFromContextOnTestRunMessage

public void upsertBeanFromContextOnTestRunMessage(String beanId)

upsertBeanFromContextOnTestRunMessage

public void upsertBeanFromContextOnTestRunMessage(String key,
                                         String beanId)

upsertOnTestRunMessage

public void upsertOnTestRunMessage(String key,
                          Object value)

upsertOnTestRunMessage

public void upsertOnTestRunMessage(Map<String,Object> data)

upsertPayloadContentOnTestRunMessage

public void upsertPayloadContentOnTestRunMessage(Object payloadContent)

getTestRunMessagePayload

public <T> T getTestRunMessagePayload()

getTestRunMessageValue

public <T> T getTestRunMessageValue(String key)

removeFromTestRunMessage

public void removeFromTestRunMessage(String key)

keyContainedInTestRunMessage

public boolean keyContainedInTestRunMessage(Object key)

getTestRunMessageKeySet

public Set<String> getTestRunMessageKeySet()

runFlowAndGetPayload

protected <T> T runFlowAndGetPayload(String flowName)
                          throws Exception

TestRunMessage is already loaded with values for the operation

Parameters:

flowName -

Returns:

Throws:

Exception

runFlowAndGetMessage

protected org.mule.api.MuleMessage runFlowAndGetMessage(String flowName)
                                                 throws Exception

TestRunMessage is already loaded with values for the operation

Parameters:

flowName -

Returns:

Throws:

Exception

runFlowAndGetInvocationProperty

protected <T> T runFlowAndGetInvocationProperty(String flowName,
                                    String invocationProperty)
                                     throws Exception

Parameters:

flowName -

invocationProperty -

Returns:

Throws:

Exception

runFlowAndGetMessage

protected org.mule.api.MuleMessage runFlowAndGetMessage(String flowName,
                                            String beanId)
                                                 throws Exception

Returns the MuleMessage containing the payload of the operation. TestRunMessage is not the source of data for this method. Meant for retrieving auxiliary information or when test involves a single call to the operation under test.

Parameters:

flowName -

beanId - is the id of a map Spring bean declared in the AutomationSpringBeans

Returns:

Throws:

Exception

runFlowAndGetPayload

protected <T> T runFlowAndGetPayload(String flowName,
                         String beanId)
                          throws Exception

Returns the Payload of the flowName operation. TestRunMessage is not the source of data for this method. Meant for retrieving auxiliary information or when test involves a single call to the operation under test.

Parameters:

flowName -

beanId - is the id of a map Spring bean declared in the AutomationSpringBeans

Returns:

Throws:

Exception

runFlowIgnoringPayload

protected void runFlowIgnoringPayload(String flowName)
                               throws Exception

Throws:

Exception

runFlowAndWaitForResponseVM

protected <T> T runFlowAndWaitForResponseVM(String messageFlow,
                                String vmQueueName,
                                long timeoutMs)
                                 throws Exception

Runs the flow named messageFlow and waits until a response is received on the VM queue named vmQueueName or a timeout is reached. This method is used to test inbound endpoints.

A vm:outbound-endpoint must manually be appended to the flow under test before calling this method.

Parameters:

messageFlow - The name of the flow to run which will generate the expected message.

vmQueueName - The name of the queue to listen for messages on after running the flow. If the queue's URL is vm://foo, then this parameter should be foo.

timeoutMs - Time in milliseconds to wait for a message before throwing a TimeoutException.

Returns:

The payload received at the specified VM queue.

Throws:

Exception

getGlobalElementTestable

protected org.mule.common.Testable getGlobalElementTestable(String globalElementName)

Returns a Testable to exercise the test connection code on a test

Parameters:

globalElementName - Name attribute value of the Global Element for which connectivity is been tested

Returns:

A Testable object whose test() method can be invoked on the test

assertGetMetaDataKeysSuccess

public final void assertGetMetaDataKeysSuccess(String configName)

Asserts successful getMetaDataKeys result

Parameters:

configName - Name attribute value of the Global Element for which connectivity is been tested

getMetaDataKeyList

public final List<org.mule.common.metadata.MetaDataKey> getMetaDataKeyList(String configName)

Retrieves a List containing all of the connector's MetaDataKeys

Parameters:

configName - Name attribute value of the Global Element for which connectivity is been tested

Returns:

A List containing all of the connector's MetaDataKeys

assertMetaDataKeysContainsKeys

public final void assertMetaDataKeysContainsKeys(String configName,
                                  List<HashMap<String,String>> expectedMetaDataKeyList)

Asserts selected MetaDataKeys are found among connector MetaDataKeys and their contents are correct

Parameters:

configName - Name attribute value of the Global Element for which connectivity is been tested

expectedMetaDataKeyList - List containing MetaDataKeys as maps whose values are meant to be found among the connector MetaDataKeys

assertIsMetaDataEnabled

public final void assertIsMetaDataEnabled(String flowName)

Asserts processor contained in an automation-test-flows.xml flow is MetaDataEnabled

Parameters:

flowName - Name attribute value of the flow containing the processor under test

assertNotMetaDataEnabled

public final void assertNotMetaDataEnabled(String flowName)

Asserts processor contained in an automation-test-flows.xml flow is not MetaDataEnabled

Parameters:

flowName - Name attribute value of the flow containing the processor under test

getInputMetaData

public final org.mule.common.Result<org.mule.common.metadata.MetaData> getInputMetaData(String flowName)

Returns the MetaData Result of the input MetaData retrieved of the processor under test

Parameters:

flowName - Name attribute value of the flow containing the processor under test

Returns:

A Result containing the processor's input MetaData

getInputMetaDataPayload

public final org.mule.common.metadata.MetaDataModel getInputMetaDataPayload(String flowName)

Returns the MetaDataModel of the input MetaData retrieved of the processor under test

Parameters:

flowName - Name attribute value of the flow containing the processor under test

Returns:

A MetaDataModel containing the processor's input MetaData

getOutputMetaData

public final org.mule.common.Result<org.mule.common.metadata.MetaData> getOutputMetaData(String flowName)

Returns the MetaData Result of the output MetaData retrieved of the processor under test

Parameters:

flowName - Name attribute value of the flow containing the processor under test

Returns:

A Result containing the processor's output MetaData

getOutputMetaDataPayload

public final org.mule.common.metadata.MetaDataModel getOutputMetaDataPayload(String flowName)

Returns the MetaDataModel of the output MetaData retrieved of the processor under test

Parameters:

flowName - Name attribute value of the flow containing the processor under test

Returns:

A MetaDataModel containing the processor's output MetaData

assertNullInputMetaDataSuccess

public final void assertNullInputMetaDataSuccess(String flowName)

Asserts no input MetaData for the processor under test

Parameters:

flowName - Name attribute value of the flow containing the processor under test

assertFirstLevelInputMetaDataSuccess

public final void assertFirstLevelInputMetaDataSuccess(String flowName,
                                        org.mule.common.metadata.datatype.DataType expectedDataType)

Asserts first level input MetaData was successfully retrieved for the processor under test and matches an expectedDataType

Parameters:

flowName - Name attribute value of the flow containing the processor under test

expectedDataType - first level MetaData DataType expected to be retrieved

assertNullOutputMetaDataSuccess

public final void assertNullOutputMetaDataSuccess(String flowName)

Asserts no output MetaData for the processor under test

Parameters:

flowName - Name attribute value of the flow containing the processor under test

assertFirstLevelOutputMetaDataSuccess

public final void assertFirstLevelOutputMetaDataSuccess(String flowName,
                                         org.mule.common.metadata.datatype.DataType expectedDataType)

Asserts first level output MetaData was successfully retrieved for the processor under test and matches an expectedDataType

Parameters:

flowName - Name attribute value of the flow containing the processor under test

expectedDataType - first level MetaData DataType expected to be retrieved

assertPOJOOutputMetaDataSuccess

public final void assertPOJOOutputMetaDataSuccess(String flowName,
                                   String expectedImplementationType)

Asserts first level POJO output MetaData was successfully retrieved for the processor under test and is of specific class

Parameters:

flowName - Name attribute value of the flow containing the processor under test

expectedDataType - first level MetaData DataType expected to be retrieved

assertListFirstLevelOutputMetaDataSuccess

public final void assertListFirstLevelOutputMetaDataSuccess(String flowName,
                                             String expectedImplementationType)

Asserts first level List output MetaData was successfully retrieved for the processor under test and it's elements are of specific class

Parameters:

flowName - Name attribute value of the flow containing the processor under test

expectedDataType - first level MetaData DataType expected to be retrieved