AbstractMuleTestCase (Mule Unit Test Framework (TCK) 4.3.0-20210823 API)

java.lang.Object
- org.mule.tck.junit4.AbstractMuleTestCase

Direct Known Subclasses:

AbstractMuleContextTestCase, AbstractRegistryTestCase
```
public abstract class AbstractMuleTestCase
extends Object
```
AbstractMuleTestCase is a base class for Mule test cases. This implementation provides services to test code for creating mock and test objects.

Field Summary

Fields
Modifier and Type	Field and Description
`org.junit.rules.TestRule`	`chain`
`static int`	`DEFAULT_TEST_TIMEOUT_SECS`
`org.junit.rules.TestName`	`name`
`static String`	`TEST_CONNECTOR`
`static org.mule.runtime.api.component.location.ComponentLocation`	`TEST_CONNECTOR_LOCATION`
`static String`	`TEST_PAYLOAD`
`static String`	`TEST_TIMEOUT_SYSTEM_PROPERTY`

Constructor Summary

Constructors
Constructor and Description

AbstractMuleTestCase()

Constructors
Constructor and Description
`AbstractMuleTestCase()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addMockComponentLocation(org.mule.runtime.api.component.Component component)` Utility method to add a mock component location.
`void`	`clearRequestContext()`
`static void`	`clearTestCaseName()`
`void`	`clearTestEvents()`
`protected static List<String>`	`collectThreadNames()`
`protected org.junit.rules.TestRule`	`createTestTimeoutRule()` Creates the timeout rule that will be used to run the test.
`static void`	`dumpFilteredThreadsInTest()`
`protected <B extends CoreEvent.Builder> B`	`getEventBuilder()` Allows subclasses to provide a builder configured in a different way
`protected FeatureFlaggingService`	`getFeatureFlaggingService()` `FeatureFlaggingService` used for testing with all the features enabled
`protected static String`	`getMavenProjectVersionProperty()` Could be useful to use it in place of hardcoding the pom project version in the tests.
`protected String`	`getTestHeader()`
`int`	`getTestTimeoutSecs()` Defines the timeout in seconds that will be used to run the test.
`protected int`	`getTimeoutSystemProperty()` Defines the number of seconds that a test has in order to run before throwing a timeout.
`void`	`initializeMuleTest()`
`protected boolean`	`isDisabledInThisEnvironment()` Subclasses can override this method to skip the execution of the entire test class.
`protected boolean`	`isDisabledInThisEnvironment(String testMethodName)` Should this test run?
`protected boolean`	`isFailOnTimeout()` Indicates whether the test should fail when a timeout is reached.
`boolean`	`isOffline(String method)`
`protected <E extends CoreEvent> E`	`newEvent()` Create a new `CoreEvent` for each invocation.
`protected CoreEvent`	`nullPayloadEvent()`
`void`	`shutdownLogging()`
`void`	`takeTestCaseName()`
`protected CoreEvent`	`testEvent()` Creates and caches a test `CoreEvent` instance for the scope of the current test method.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TEST_PAYLOAD
```
public static final String TEST_PAYLOAD
```
    See Also:
    
    Constant Field Values
  - TEST_CONNECTOR
```
public static final String TEST_CONNECTOR
```
    See Also:
    
    Constant Field Values
  - TEST_CONNECTOR_LOCATION
```
public static final org.mule.runtime.api.component.location.ComponentLocation TEST_CONNECTOR_LOCATION
```
  - DEFAULT_TEST_TIMEOUT_SECS
```
public static final int DEFAULT_TEST_TIMEOUT_SECS
```
    See Also:
    
    Constant Field Values
  - TEST_TIMEOUT_SYSTEM_PROPERTY
```
public static final String TEST_TIMEOUT_SYSTEM_PROPERTY
```
    See Also:
    
    Constant Field Values
  - name
```
public org.junit.rules.TestName name
```
  - chain
```
public final org.junit.rules.TestRule chain
```
- Constructor Detail
  - AbstractMuleTestCase
```
public AbstractMuleTestCase()
```
- Method Detail
  - createTestTimeoutRule
```
protected org.junit.rules.TestRule createTestTimeoutRule()
```
    Creates the timeout rule that will be used to run the test.
    
    Returns:
    
    the rule used to check for test execution timeouts.
  - getTimeoutSystemProperty
```
protected int getTimeoutSystemProperty()
```
    Defines the number of seconds that a test has in order to run before throwing a timeout. If the property if not defined then uses the DEFAULT_MULE_TEST_TIMEOUT_SECS constant.
    
    Returns:
    
    the timeout value expressed in seconds
  - isDisabledInThisEnvironment
```
protected boolean isDisabledInThisEnvironment()
```
    Subclasses can override this method to skip the execution of the entire test class.
    
    Returns:
    
    true if the test class should not be run.
  - isDisabledInThisEnvironment
```
protected boolean isDisabledInThisEnvironment(String testMethodName)
```
    Should this test run?
    
    Parameters:
    
    testMethodName - name of the test method
    
    Returns:
    
    whether the test should execute in the current environment
  - isOffline
```
public boolean isOffline(String method)
```
  - getTestTimeoutSecs
```
public int getTestTimeoutSecs()
```
    Defines the timeout in seconds that will be used to run the test.
    
    Returns:
    
    the timeout in seconds
  - getMavenProjectVersionProperty
```
protected static String getMavenProjectVersionProperty()
```
    Could be useful to use it in place of hardcoding the pom project version in the tests.
    
    Returns:
    
    the "project.version" maven property.
  - initializeMuleTest
```
public final void initializeMuleTest()
```
  - getTestHeader
```
protected String getTestHeader()
```
  - isFailOnTimeout
```
protected boolean isFailOnTimeout()
```
    Indicates whether the test should fail when a timeout is reached.
    This feature was added to support old test cases that depend on 3rd-party resources such as a public web service. In such cases it may be desirable to not fail the test upon timeout but rather to simply log a warning.
    
    Returns:
    
    true if it must fail on timeout and false otherwise. Default value is true.
  - clearRequestContext
```
public void clearRequestContext()
```
  - shutdownLogging
```
public void shutdownLogging()
                     throws org.mule.runtime.api.exception.MuleException
```
    Throws:
    
    org.mule.runtime.api.exception.MuleException
  - collectThreadNames
```
protected static List<String> collectThreadNames()
```
  - clearTestCaseName
```
public static void clearTestCaseName()
```
  - takeTestCaseName
```
public void takeTestCaseName()
```
  - testEvent
```
protected CoreEvent testEvent()
                       throws org.mule.runtime.api.exception.MuleException
```
    Creates and caches a test CoreEvent instance for the scope of the current test method.
    
    Returns:
    
    test event.
    
    Throws:
    
    org.mule.runtime.api.exception.MuleException
  - newEvent
```
protected <E extends CoreEvent> E newEvent()
                                    throws org.mule.runtime.api.exception.MuleException
```
    Create a new CoreEvent for each invocation. Useful if multiple distinct event instances are needed in a single test method.
    
    Returns:
    
    new test event.
    
    Throws:
    
    org.mule.runtime.api.exception.MuleException
  - getEventBuilder
```
protected <B extends CoreEvent.Builder> B getEventBuilder()
                                                   throws org.mule.runtime.api.exception.MuleException
```
    Allows subclasses to provide a builder configured in a different way
    
    Returns:
    
    a event builder to use to build a test event
    
    Throws:
    
    org.mule.runtime.api.exception.MuleException
  - nullPayloadEvent
```
protected CoreEvent nullPayloadEvent()
                              throws org.mule.runtime.api.exception.MuleException
```
    Throws:
    
    org.mule.runtime.api.exception.MuleException
  - clearTestEvents
```
public void clearTestEvents()
                     throws org.mule.runtime.api.exception.MuleException
```
    Throws:
    
    org.mule.runtime.api.exception.MuleException
  - dumpFilteredThreadsInTest
```
public static void dumpFilteredThreadsInTest()
```
  - addMockComponentLocation
```
protected void addMockComponentLocation(org.mule.runtime.api.component.Component component)
```
    Utility method to add a mock component location.
    
    Parameters:
    
    component - object to add the location.
  - getFeatureFlaggingService
```
protected FeatureFlaggingService getFeatureFlaggingService()
```
    FeatureFlaggingService used for testing with all the features enabled
    
    Returns:

Class AbstractMuleTestCase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TEST_PAYLOAD

TEST_CONNECTOR

TEST_CONNECTOR_LOCATION

DEFAULT_TEST_TIMEOUT_SECS

TEST_TIMEOUT_SYSTEM_PROPERTY

name

chain

Constructor Detail

AbstractMuleTestCase

Method Detail

createTestTimeoutRule

getTimeoutSystemProperty

isDisabledInThisEnvironment

isDisabledInThisEnvironment

isOffline

getTestTimeoutSecs

getMavenProjectVersionProperty

initializeMuleTest

getTestHeader

isFailOnTimeout

clearRequestContext

shutdownLogging

collectThreadNames

clearTestCaseName

takeTestCaseName

testEvent

newEvent

getEventBuilder

nullPayloadEvent

clearTestEvents

dumpFilteredThreadsInTest

addMockComponentLocation

getFeatureFlaggingService