Building a Mule Application with Maven in Studio

In Studio select File > New > Mule Project.

Mark the checkbox Create POM file for project and maintain with Maven. Then, define a Group Id, Artifact Id, and Version for your new project. Click Finish.

Studio builds your Maven Project automatically. If everything works correctly, you should see a BUILD SUCCESS message on the console output.

Now try it out by running your project on the embedded server within Anypoint Studio. Click the project name, then Run As > Mule Application.

Open a browser window and go to http://localhost:8081.

You should see a "Hello World!" message in your browser.

Now it’s time to add a unit test. To do so, right-click your project’s src/test/java folder, then select New > Class.

Name your class something like HelloWorldTestCase, enter a Package name of your choice, then hit Finish.

Modify the newly created class (HelloWorldTestCase.java) with the following code:

package org.example.example;
import static org.junit.Assert.*;
import java.util.HashMap;
import java.util.Map;
import org.junit.Test;
import org.mule.api.MuleMessage;
import org.mule.api.client.MuleClient;
import org.mule.tck.junit4.FunctionalTestCase;
import org.mule.transport.NullPayload;


public class HelloWorldTestCase extends FunctionalTestCase { (1)
private static String MESSAGE = "Hello world!";


@Override
    protected String getConfigFile()
    {
        return "example.xml";
    }


@Test
    public void clientTestCase() throws Exception
    {
        MuleClient client = muleContext.getClient(); (2)
        Map<String, Object> props = new HashMap<String, Object>();
        props.put("http.method", "GET");
        MuleMessage result = client.send("http://localhost:8081", "", props); (3)
        assertNotNull(result);
        assertFalse(result.getPayload() instanceof NullPayload); (4)
        assertEquals(MESSAGE, result.getPayloadAsString());
    }
}

In the package explorer, right-click your project, then select Run As > Mule Application with Maven.

Keep an eye on the console below to see the messages that Maven posts during the build process. If you see a “BUILD SUCCESS” message, this means Maven has executed the test and deployed the application successfully.

In your package explorer, look for the pom.xml file and open it.

Add your additional dependencies. To complete this example, you’ll need to add these dependencies:

<dependency>
  <groupId>com.jayway.restassured</groupId>
  <artifactId>rest-assured</artifactId>
  <version>2.3.1</version>
  <scope>test</scope>
  <exclusions>
    <exclusion>
      <groupId>org.groovy-lang</groupId>
      <artifactId>groovy</artifactId>
    </exclusion>
  </exclusions>
</dependency>
<dependency>
  <groupId>org.groovy-lang</groupId>
  <artifactId>groovy-all</artifactId>
  <version>2.2.1</version>
  <scope>test</scope>
</dependency>
<dependency>
  <groupId>commons-cli</groupId>
  <artifactId>commons-cli</artifactId>
  <version>1.1</version>
</dependency>

Open the test class you created in a previous section, HelloWorldTestCase.java, and add a class you’ve added as a dependency. For example:

import static com.jayway.restassured.RestAssured.*;

You can now use the new Java library in your test case file. For example, add the REST-assured DSL https://code.google.com/p/rest-assured/ to your test case file.

@Test
 public void dependencyClientTestCase() throws Exception
 {
  String response = get("http://localhost:8081").body().asString();
  assertEquals(MESSAGE, response);
 }

Save your project, then run the build again by again right-clicking the project name and selecting Run As > Mule Application with Maven.

You should see in the console that Studio downloads the dependencies you added, then builds the project correctly.