Over a million developers have joined DZone.

Mule MUnit Testing With Variables and Properties

DZone's Guide to

Mule MUnit Testing With Variables and Properties

Learn how to set up and use MUnit to test variables in your Mule flows and subflows.

· Integration Zone ·
Free Resource

The State of API Integration 2018: Get Cloud Elements’ report for the most comprehensive breakdown of the API integration industry’s past, present, and future.

Who doesn't love a good test? When it comes to integrating moving parts, testing is one of the most important phases of any project. Flow Variables, Session Variables, and Inbound/Outbound properties are very common in Mule flows. Fortunately, Mule MUnit framework makes it very easy to unit test any Mule Flow and subflows. In this post, we will see how we can unit test our flows involving variables and properties.

Let's consider a simple Mule flow that reads a file and then sets a flow variable and session variable:

Mule Munit Flow

<flow name="SampleMuleFlow">
    <file:inbound-endpoint path="input" responseTimeout="10000" doc:name="File"/>
    <set-variable variableName="fileName" value="#[message.inboundProperties.originalFilename]" doc:name="Variable"/>
    <set-session-variable variableName="sessFileName" value="#[flowVars.fileName]" doc:name="Session Variable"/&gt
    <logger message="#[payload]" level="INFO" doc:name="Logger"/>

Creating an XML MUnit Test Case

If you are using Anypoint Studio, then you can right click our flow, choose MUnit –> Create New Suite. Studio will automatically create an MUnit Test suite under /src/test/munit and add a test case to it. It should look like:


What We Will Do Here

  1. MUnit mocks all inbound connectors and endpoints, so we will need to manually set the test message for the flow. We will do that by adding a <munit:set> component. We will also set an inbound property originalFilename and invocation/flow variable on the message.
  2. Call our main flow with using flow-ref.
  3. After the main flow is executed, we will verify that flow variable value is same as what we set on message.

Our final XML Unit Test:

<munit:test name="testmule-test-suite-SampleMuleFlowTest" description="Test">
    <munit:set payload="#[getResources('test.txt').asStream()]" doc:name="Set Message">
            <munit:invocation-property key="fileName2" value="test2.txt"/>
            <munit:inbound-property key="originalFilename" value="test.txt"/>
        <flow-ref name="SampleMuleFlow" doc:name="Flow-ref to SampleMuleFlow"/>
        <munit:assert-on-equals expectedValue="#[flowVars.fileName2]" actualValue="#['test2.txt']" doc:name="Assert Equals"/>

We can then run this as a MUnit Test in studio.

Creating Java MUnit Test Case

For those who prefer writing Java instead of XML, MUnit framework provides fluent Java APIs for JUnit. You can create java class by extending FunctionalMunitSuite class.

Below is our java test case:

package testmule;

import java.io.InputStream;

import org.junit.Assert;
import org.junit.Test;
import org.mule.api.MuleEvent;
import org.mule.api.MuleMessage;
import org.mule.api.transport.PropertyScope;
import org.mule.munit.runner.functional.FunctionalMunitSuite;

public class SampleTestCase extends FunctionalMunitSuite {

    protected String getConfigResources() {
        return "testmule2.xml";

    public void testSampleFlow(){
        InputStream is = Thread.currentThread().getContextClassLoader().getResourceAsStream("test.txt");
        MuleMessage msg = muleMessageWithPayload(is);
        try {
            msg.setProperty("originalFileName", "test.txt", PropertyScope.INBOUND);
            MuleEvent test = testEvent(msg);

            test.setFlowVariable("fileName2", "test2.txt");

            MuleEvent reply = runFlow("SampleMuleFlow", test);

            Assert.assertEquals("Verify Flow Variable", "test2.txt", reply.getFlowVariable("fileName2"));

        } catch (Exception e) {
            // TODO Auto-generated catch block


Points to note:

  1. Create a MuleMessage using muleMessageWithPayload function provided by the FunctionalMunitSuite super class.
  2. Create a MuleEvent using testEvent function provided by FunctionalMunitSuite super class.
  3. Inbound and Outbound properties can be set on the Message we created. For flow variables and session variables, we will use the test MuleEvent. The testEvent(msg) method does not copy flow variables and session variables into test events, so setting anything will get lost while creating that test event.
  4. Finally, we call our main flow and verify the value of our flow variable in the returned message. So, keep testing your code!

More Reading:

MUnit Documentation

Your API is not enough. Learn why (and how) leading SaaS providers are turning their products into platforms with API integration in the ebook, Build Platforms, Not Products from Cloud Elements.

munit ,mule esb ,unit testing

Published at DZone with permission of

Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}