org.mule.tck.junit4

Class AbstractMuleContextTestCase

java.lang.Object

org.mule.tck.junit4.AbstractMuleTestCase

org.mule.tck.junit4.AbstractMuleContextTestCase

Direct Known Subclasses:

AbstractAddVariablePropertyProcessorTestCase, AbstractObjectStoreContractTestCase, AbstractReactiveProcessorTestCase, AbstractRemoveVariablePropertyProcessorTestCase, AbstractSerializerProtocolContractTestCase, AbstractTransactionQueueManagerTestCase, AbstractTransformerTestCase, AbstractTxThreadAssociationTestCase, QueueStoreTestCase

public abstract class AbstractMuleContextTestCase
extends AbstractMuleTestCase

Extends AbstractMuleTestCase providing access to a MuleContext instance and tools for manage it.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BLOCK_TIMEOUT Default timeout used when blocking on Publisher completion.
protected Latch	callbackCalled Use this as a semaphore to the unit test to indicate when a callback has successfully been called.
static String[]	IGNORED_DOT_MULE_DIRS Top-level directories under .mule which are not deleted on each test case recycle.
static long	LOCK_TIMEOUT Default timeout for multithreaded tests (using CountDownLatch, WaitableBoolean, etc.), in milliseconds.
protected static MuleContext	muleContext The context used to run this test.
static String	REACTOR_BLOCK_TIMEOUT_EXCEPTION_MESSAGE
static int	RECEIVE_TIMEOUT Default timeout for waiting for responses
static String	TEST_MESSAGE Convenient test message for unit testing.
TestServicesConfigurationBuilder	testServicesConfigurationBuilder
Supplier<TestServicesConfigurationBuilder>	testServicesConfigurationBuilderSupplier
static String	WORKING_DIRECTORY_SYSTEM_PROPERTY_KEY
org.junit.rules.TemporaryFolder	workingDirectory

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

DEFAULT_TEST_TIMEOUT_SECS, globalTimeout, name, TEST_CONNECTOR, TEST_CONNECTOR_LOCATION, TEST_PAYLOAD, TEST_TIMEOUT_SYSTEM_PROPERTY, TESTING_MODE_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractMuleContextTestCase()

Method Summary

Modifier and Type	Method and Description
protected void	addBuilders(List<ConfigurationBuilder> builders)
protected void	configureMuleContext(MuleContextBuilder contextBuilder) Override this method to set properties of the MuleContextBuilder before it is used to create the MuleContext.
protected MuleContext	createMuleContext()
protected <T> T	createObject(Class<T> clazz) Create an object of instance clazz.
protected <T> T	createObject(Class<T> clazz, Object... args) Create an object of instance clazz.
static void	disposeContext()
void	disposeContextPerTest()
protected void	doSetUp() Enables the adding of extra behavior on the set up stage of a test right after the creation of the mule context in setUpMuleContext().
protected void	doSetUpBeforeMuleContextCreation()
protected void	doTearDown() Enables the adding of extra behavior on the tear down stage of a test before the mule context is disposed in disposeContextPerTest().
protected void	doTearDownAfterMuleContextDispose()
protected static Event.Builder	eventBuilder() Creates a basic event builder with its context already set.
protected ConfigurationBuilder	getBuilder()
protected String	getConfigurationResources()
protected ClassLoader	getExecutionClassLoader()
protected File	getFileInsideWorkingDirectory(String fileName)
protected ObjectSerializer	getObjectSerializer()
protected <T> T	getPayload(org.mule.runtime.api.message.Message message, Class<T> clazz) Uses TransformationService to get representation of a message for a given Class
protected Object	getPayload(org.mule.runtime.api.message.Message message, org.mule.runtime.api.metadata.DataType dataType) Uses TransformationService to get representation of a message for a given DataType
protected byte[]	getPayloadAsBytes(org.mule.runtime.api.message.Message message) Uses TransformationService to get byte[] representation of a message.
protected String	getPayloadAsString(org.mule.runtime.api.message.Message message) Uses TransformationService to get a String representation of a message.
SensingNullMessageProcessor	getSensingNullMessageProcessor()
protected Properties	getStartUpProperties()
static Flow	getTestFlowWithComponent(String name, Class<?> clazz)
TriggerableMessageSource	getTriggerableMessageSource()
protected File	getWorkingDirectory()
protected void	initialiseObject(Object o) A convenience method that will register an object in the registry using its hashcode as the key.
protected boolean	isDisposeContextPerClass()
protected boolean	isGracefulShutdown() Determines if the test case should perform graceful shutdown or not.
protected boolean	isStartContext()
protected boolean	mockExprExecutorService() Defines if a mock should be used for the ExpressionExecutor.
protected boolean	mockHttpService() Defines if a mock should be used for the HttpService.
protected Event	process(Processor processor, Event event)
protected static void	recordSchedulersOnInit(MuleContext context)
protected void	setDisposeContextPerClass(boolean val)
protected void	setStartContext(boolean startContext)
void	setUpMuleContext()
protected static void	verifyAndStopSchedulers()

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

clearRequestContext, clearTestCaseName, clearTestEvents, collectThreadNames, createTestTimeoutRule, dumpFilteredThreadsInTest, getMavenProjectVersionProperty, getTestHeader, getTestTimeoutSecs, getTimeoutSystemProperty, initializeMuleTest, isDisabledInThisEnvironment, isDisabledInThisEnvironment, isFailOnTimeout, isOffline, newEvent, nullPayloadEvent, takeTestCaseName, testEvent

Methods inherited from class java.lang.Object

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

Field Detail

WORKING_DIRECTORY_SYSTEM_PROPERTY_KEY

public static final String WORKING_DIRECTORY_SYSTEM_PROPERTY_KEY

See Also:

Constant Field Values

REACTOR_BLOCK_TIMEOUT_EXCEPTION_MESSAGE

public static final String REACTOR_BLOCK_TIMEOUT_EXCEPTION_MESSAGE

See Also:

Constant Field Values

testServicesConfigurationBuilder

public TestServicesConfigurationBuilder testServicesConfigurationBuilder

testServicesConfigurationBuilderSupplier

public Supplier<TestServicesConfigurationBuilder> testServicesConfigurationBuilderSupplier

workingDirectory

public org.junit.rules.TemporaryFolder workingDirectory

IGNORED_DOT_MULE_DIRS

public static final String[] IGNORED_DOT_MULE_DIRS

Top-level directories under .mule which are not deleted on each test case recycle. This is required, e.g. to play nice with transaction manager recovery service object store.

muleContext

protected static MuleContext muleContext

The context used to run this test. Context will be created per class or per method depending on disposeContextPerClass. The context will be started only when startContext is true.

TEST_MESSAGE

public static final String TEST_MESSAGE

Convenient test message for unit testing.

See Also:

Constant Field Values

LOCK_TIMEOUT

public static final long LOCK_TIMEOUT

Default timeout for multithreaded tests (using CountDownLatch, WaitableBoolean, etc.), in milliseconds. The higher this value, the more reliable the test will be, so it should be set high for Continuous Integration. However, this can waste time during day-to-day development cycles, so you may want to temporarily lower it while debugging.

See Also:

Constant Field Values

RECEIVE_TIMEOUT

public static final int RECEIVE_TIMEOUT

Default timeout for waiting for responses

See Also:

Constant Field Values

BLOCK_TIMEOUT

public static final int BLOCK_TIMEOUT

Default timeout used when blocking on Publisher completion.

See Also:

Constant Field Values

callbackCalled

protected Latch callbackCalled

Use this as a semaphore to the unit test to indicate when a callback has successfully been called.

Constructor Detail

AbstractMuleContextTestCase

public AbstractMuleContextTestCase()

Method Detail

isDisposeContextPerClass

protected boolean isDisposeContextPerClass()

setDisposeContextPerClass

protected void setDisposeContextPerClass(boolean val)

setUpMuleContext

public final void setUpMuleContext()
                            throws Exception

Throws:

Exception

doSetUpBeforeMuleContextCreation

protected void doSetUpBeforeMuleContextCreation()
                                         throws Exception

Throws:

Exception

doSetUp

protected void doSetUp()
                throws Exception

Enables the adding of extra behavior on the set up stage of a test right after the creation of the mule context in setUpMuleContext().

Under normal circumstances this method could be replaced by a @Before annotated method.

Throws:

Exception - if something fails that should halt the test case

createMuleContext

protected MuleContext createMuleContext()
                                 throws Exception

Throws:

Exception

getObjectSerializer

protected ObjectSerializer getObjectSerializer()

Returns:

the ObjectSerializer to use on the test's MuleContext

getExecutionClassLoader

protected ClassLoader getExecutionClassLoader()

addBuilders

protected void addBuilders(List<ConfigurationBuilder> builders)

mockHttpService

protected boolean mockHttpService()

Defines if a mock should be used for the HttpService. If false an implementation will need to be provided.

Returns:

whether or not the HttpService should be mocked.

mockExprExecutorService

protected boolean mockExprExecutorService()

Defines if a mock should be used for the ExpressionExecutor. If false an implementation will need to be provided.

Returns:

whether or not the ExpressionExecutor should be mocked.

configureMuleContext

protected void configureMuleContext(MuleContextBuilder contextBuilder)

Override this method to set properties of the MuleContextBuilder before it is used to create the MuleContext.

getBuilder

protected ConfigurationBuilder getBuilder()
                                   throws Exception

Throws:

Exception

getConfigurationResources

protected String getConfigurationResources()

getStartUpProperties

protected Properties getStartUpProperties()

disposeContextPerTest

public final void disposeContextPerTest()
                                 throws Exception

Throws:

Exception

doTearDownAfterMuleContextDispose

protected void doTearDownAfterMuleContextDispose()
                                          throws Exception

Throws:

Exception

disposeContext

public static void disposeContext()
                           throws RegistrationException,
                                  org.mule.runtime.api.exception.MuleException

Throws:

RegistrationException

org.mule.runtime.api.exception.MuleException

recordSchedulersOnInit

protected static void recordSchedulersOnInit(MuleContext context)

verifyAndStopSchedulers

protected static void verifyAndStopSchedulers()
                                       throws org.mule.runtime.api.exception.MuleException

Throws:

org.mule.runtime.api.exception.MuleException

doTearDown

protected void doTearDown()
                   throws Exception

Enables the adding of extra behavior on the tear down stage of a test before the mule context is disposed in disposeContextPerTest().

Under normal circumstances this method could be replace with a @After annotated method.

Throws:

Exception - if something fails that should halt the testcase

getTestFlowWithComponent

public static Flow getTestFlowWithComponent(String name,
                                            Class<?> clazz)
                                     throws Exception

Throws:

Exception

eventBuilder

protected static Event.Builder eventBuilder()
                                     throws org.mule.runtime.api.exception.MuleException

Creates a basic event builder with its context already set.

Returns:

a basic event builder with its context already set.

Throws:

org.mule.runtime.api.exception.MuleException

isStartContext

protected boolean isStartContext()

setStartContext

protected void setStartContext(boolean startContext)

isGracefulShutdown

protected boolean isGracefulShutdown()

Determines if the test case should perform graceful shutdown or not. Default is false so that tests run more quickly.

createObject

protected <T> T createObject(Class<T> clazz)
                      throws Exception

Create an object of instance clazz. It will then register the object with the registry so that any dependencies are injected and then the object will be initialised. Note that if the object needs to be configured with additional state that cannot be passed into the constructor you should create an instance first set any additional data on the object then call initialiseObject(Object).

Type Parameters:

T - Object of this type will be returned

Parameters:

clazz - the class to create an instance of.

Returns:

an initialised instance of class

Throws:

Exception - if there is a problem creating or initializing the object

createObject

protected <T> T createObject(Class<T> clazz,
                             Object... args)
                      throws Exception

Create an object of instance clazz. It will then register the object with the registry so that any dependencies are injected and then the object will be initialised. Note that if the object needs to be configured with additional state that cannot be passed into the constructor you should create an instance first set any additional data on the object then call initialiseObject(Object).

Type Parameters:

T - Object of this type will be returned

Parameters:

clazz - the class to create an instance of.

args - constructor parameters

Returns:

an initialised instance of class

Throws:

Exception - if there is a problem creating or initializing the object

initialiseObject

protected void initialiseObject(Object o)
                         throws RegistrationException

A convenience method that will register an object in the registry using its hashcode as the key. This will cause the object to have any objects injected and lifecycle methods called. Note that the object lifecycle will be called to the same current lifecycle as the MuleContext

Parameters:

o - the object to register and initialise it

Throws:

RegistrationException

getSensingNullMessageProcessor

public SensingNullMessageProcessor getSensingNullMessageProcessor()

getTriggerableMessageSource

public TriggerableMessageSource getTriggerableMessageSource()

getWorkingDirectory

protected File getWorkingDirectory()

Returns:

the mule application working directory where the app data is stored

getFileInsideWorkingDirectory

protected File getFileInsideWorkingDirectory(String fileName)

Parameters:

fileName - name of the file. Can contain subfolders separated by File.separator

Returns:

a File inside the working directory of the application.

getPayloadAsString

protected String getPayloadAsString(org.mule.runtime.api.message.Message message)
                             throws Exception

Uses TransformationService to get a String representation of a message.

Parameters:

message - message to get payload from

Returns:

String representation of the message payload

Throws:

Exception - if there is an unexpected error obtaining the payload representation

getPayloadAsBytes

protected byte[] getPayloadAsBytes(org.mule.runtime.api.message.Message message)
                            throws Exception

Uses TransformationService to get byte[] representation of a message.

Parameters:

message - message to get payload from

Returns:

byte[] representation of the message payload

Throws:

Exception - if there is an unexpected error obtaining the payload representation

getPayload

protected Object getPayload(org.mule.runtime.api.message.Message message,
                            org.mule.runtime.api.metadata.DataType dataType)
                     throws Exception

Uses TransformationService to get representation of a message for a given DataType

Parameters:

message - message to get payload from

dataType - dataType to be transformed to

Returns:

representation of the message payload of the required dataType

Throws:

Exception - if there is an unexpected error obtaining the payload representation

getPayload

protected <T> T getPayload(org.mule.runtime.api.message.Message message,
                           Class<T> clazz)
                    throws Exception

Uses TransformationService to get representation of a message for a given Class

Parameters:

message - message to get payload from

clazz - type of the payload to be transformed to

Returns:

representation of the message payload of the required class

Throws:

Exception - if there is an unexpected error obtaining the payload representation

process

protected Event process(Processor processor,
                        Event event)
                 throws Exception

Throws:

Exception