org.mule.functional.junit4

Class ArtifactFunctionalTestCase

java.lang.Object

org.mule.tck.junit4.AbstractMuleTestCase

org.mule.tck.junit4.AbstractMuleContextTestCase

org.mule.functional.junit4.FunctionalTestCase

org.mule.functional.junit4.ArtifactFunctionalTestCase

Direct Known Subclasses:

MuleArtifactFunctionalTestCase

public abstract class ArtifactFunctionalTestCase
extends FunctionalTestCase

Base class for running FunctionalTestCase with class loader isolation using ArtifactClassLoaderRunner, a JUnit Runner. ArtifactClassLoaderRunner classifies the classpath provided by IDE/surfire-maven-plugin generates an equivalent ClassLoader hierarchy as standalone mode.

The classification is based on the maven dependencies declared by the pom maven artifact that the test belongs to. In order to classify the URLs from the classpath it will use a dependency tree that holds also duplicates relationship for the dependency graph.

The classification for ClassLoaders would be based on dependencies scope, provided will go to the container, compile to plugin and test to the application. For more information about the classification process see ClassPathClassifier.

For plugins it will scan the plugin set of URLs to search for classes annotated with org.mule.runtime.extension.api.annotation.Extension, if a class is annotated it will generate the metadata for the extension in runtime and it will also register it to the ExtensionManager. Non extension plugins will set its filter based on mule-module.properties file.

By default this test runs internally with a BlockJUnit4ClassRunner runner. On those cases where the test has to be run with another runner the RunnerDelegateTo should be used to define it.

PluginClassLoadersAware will define that this class also needs to get access to plugin ArtifactClassLoader in order to load extension classes (they are not exposed to the application) for registering them to the ExtensionManager.

Due to the cost of reading the classpath, scanning the dependencies and classes to generate the ClassLoader is high, this runner will hold an static reference to the ClassLoader created for the first test and will use the same during the whole execution of the tests that are marked with the RunWith ArtifactClassLoaderRunner, so be aware that static initializations or things related to this could be an issue and tests should be aware of this.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ArtifactFunctionalTestCase.TestClassLoaderRepository Defines a ClassLoaderRepository with all the class loaders configured in the ArtifactFunctionalTestCase class.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MULE_SPRING_CONFIG_FILE
static String	SPRING_CONFIG_FILES_PROPERTIES

Fields inherited from class org.mule.functional.junit4.FunctionalTestCase

muleDisableAsyncRetryPolicyOnSourcesProperty, registry

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

BLOCK_TIMEOUT, componentLocator, IGNORED_DOT_MULE_DIRS, LOCK_TIMEOUT, muleContext, NON_GRACEFUL_SHUTDOWN_TIMEOUT, RECEIVE_TIMEOUT, TEST_MESSAGE, testServicesConfigurationBuilder, testServicesConfigurationBuilderSupplier, WORKING_DIRECTORY_SYSTEM_PROPERTY_KEY, workingDirectory

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

chain, DEFAULT_TEST_TIMEOUT_SECS, name, TEST_CONNECTOR, TEST_CONNECTOR_LOCATION, TEST_PAYLOAD, TEST_TIMEOUT_SYSTEM_PROPERTY

Constructor Summary

Constructors

Constructor and Description
ArtifactFunctionalTestCase()

Method Summary

Modifier and Type	Method and Description
protected void	addBuilders(List<org.mule.runtime.core.api.config.ConfigurationBuilder> builders) Adds a ConfigurationBuilder that sets the ExtensionManager into the AbstractMuleContextTestCase.muleContext.
void	clearRequestContext()
static void	configureClassLoaderRepository()
protected void	configureSpringXmlConfigurationBuilder(org.mule.runtime.core.api.config.ConfigurationBuilder builder)
protected org.mule.runtime.core.api.config.ConfigurationBuilder	getBuilder()
protected ClassLoader	getExecutionClassLoader()
protected org.mule.runtime.api.serialization.ObjectSerializer	getObjectSerializer()
protected <T extends org.mule.runtime.api.service.Service> T	getService(Class<T> serviceClass) Returns an instance of a given service if available
protected boolean	mustRegenerateExtensionModels() Subclasses can override this method so that extension models used are regenerated before running its tests.

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

artifactProperties, clearFlowAssertions, disableXmlValidations, doTearDown, enableLazyInit, flowRunner, getConfigFile, getConfigFiles, getConfigResources, getFlowConstruct, loadResource, loadResourceAsString, runFlow, stopFlowConstruct

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

awaitLatch, configureMuleContext, createMuleContext, createMuleContext, disposeContext, disposeContextPerTest, disposeOnlyMuleContext, doSetUp, doSetUpBeforeMuleContextCreation, doTearDownAfterMuleContextDispose, doTestClassInjection, getAppleFlowComponentLocationAnnotations, getConfigurationResources, getDeploymentProperties, getEventBuilder, getFileInsideWorkingDirectory, getFlowComponentLocationAnnotations, getPayload, getPayload, getPayloadAsBytes, getPayloadAsString, getSensingNullMessageProcessor, getStartUpRegistryObjects, getTriggerableMessageSource, getWorkingDirectory, isDisposeContextPerClass, isGracefulShutdown, isStartContext, mockExprExecutorService, mockHttpService, process, recordSchedulersOnInit, setDisposeContextPerClass, setStartContext, setUpMuleContext, sleepFor, verifyAndStopSchedulers

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

addMockComponentLocation, clearTestCaseName, clearTestEvents, collectThreadNames, createTestTimeoutRule, dumpFilteredThreadsInTest, getFeatureFlaggingService, 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

SPRING_CONFIG_FILES_PROPERTIES

public static final String SPRING_CONFIG_FILES_PROPERTIES

See Also:

Constant Field Values

MULE_SPRING_CONFIG_FILE

public static final String MULE_SPRING_CONFIG_FILE

See Also:

Constant Field Values

Constructor Detail

ArtifactFunctionalTestCase

public ArtifactFunctionalTestCase()

Method Detail

configureClassLoaderRepository

public static void configureClassLoaderRepository()

clearRequestContext

public final void clearRequestContext()

Overrides:

clearRequestContext in class AbstractMuleTestCase

getObjectSerializer

protected org.mule.runtime.api.serialization.ObjectSerializer getObjectSerializer()

Overrides:

getObjectSerializer in class AbstractMuleContextTestCase

getExecutionClassLoader

protected ClassLoader getExecutionClassLoader()

Overrides:

getExecutionClassLoader in class FunctionalTestCase

Returns:

thread context class loader has to be the application ClassLoader created by the runner.

getBuilder

protected org.mule.runtime.core.api.config.ConfigurationBuilder getBuilder()
                                                                    throws Exception

Overrides:

getBuilder in class FunctionalTestCase

Throws:

Exception

getService

protected <T extends org.mule.runtime.api.service.Service> T getService(Class<T> serviceClass)

Returns an instance of a given service if available

Type Parameters:

T - service class

Parameters:

serviceClass - class of service to look for. Non null.

Returns:

an instance of the provided service type if it was declared as a dependency on the test, null otherwise.

configureSpringXmlConfigurationBuilder

protected void configureSpringXmlConfigurationBuilder(org.mule.runtime.core.api.config.ConfigurationBuilder builder)

addBuilders

protected void addBuilders(List<org.mule.runtime.core.api.config.ConfigurationBuilder> builders)

Adds a ConfigurationBuilder that sets the ExtensionManager into the AbstractMuleContextTestCase.muleContext. This ConfigurationBuilder is set as the first element of the builders List

Overrides:

addBuilders in class AbstractMuleContextTestCase

Parameters:

builders - the list of ConfigurationBuilders that will be used to initialise the AbstractMuleContextTestCase.muleContext

mustRegenerateExtensionModels

protected boolean mustRegenerateExtensionModels()

Subclasses can override this method so that extension models used are regenerated before running its tests. For example, some part of a extension model might only be created if a certain system property is in place, so the test classes that test that feature will have to generate the extension model when the property is already set.

Returns:

whether the tests on this class need for extensions model to be generated again.