Java / Gradle

Using Micronaut Test REST-Assured in a Micronaut application

Learn how to use Micronaut Test REST-Assured to test the REST API of your Micronaut application.

Sergio del Amo, Dean Wette
On this guide
In this section

Getting Started

In this guide, we will create a Micronaut application written in Java.

REST-assured

In this guide, you will test a Micronaut application using REST-assured.

Testing and validating REST services in Java is harder than in dynamic languages such as Ruby and Groovy. REST Assured brings the simplicity of using these languages into the Java domain.

The Micronaut Test REST Assured module makes it easier to integrate the REST-assured library. Using it eliminates the need to hard code the version, and simplifies test fixtures by supporting injection of RequestSpecification into test fields or method parameters (parameters are only supported with JUnit 5):

What you will need

To complete this guide, you will need the following:

Solution

We recommend that you follow the instructions in the next sections and create the application step by step. However, you can go right to the completed example.

Writing the Application

Create an application using the Micronaut Command Line Interface or with Micronaut Launch.

mn create-app example.micronaut.micronautguide --build=gradle --lang=java
Note
 If you don’t specify the --build argument, Gradle with the Kotlin DSL is used as the build tool.
If you don’t specify the --lang argument, Java is used as the language.
If you don’t specify the --test argument, JUnit is used for Java and Kotlin, and Spock is used for Groovy.

The previous command creates a Micronaut application with the default package example.micronaut in a directory named micronautguide.

Setup IntelliJ IDEA to develop Micronaut Applications.

Controller

To create a microservice that responds with "Hello World", you first need a controller.

Create a controller:

src/main/java/example/micronaut/HelloController.java
package example.micronaut;

import io.micronaut.http.MediaType;
import io.micronaut.http.annotation.Controller;
import io.micronaut.http.annotation.Get;
import io.micronaut.http.annotation.Produces;

@Controller("/hello") // 
public class HelloController {
    @Get // 
    @Produces(MediaType.TEXT_PLAIN) // 
    public String index() {
        return "Hello World"; // 
    }
}
1 The class is defined as a controller with the @Controller annotation mapped to the path /hello.
2 The @Get annotation maps the index method to an HTTP GET request on /hello.
3 By default, a Micronaut response uses application/json as Content-Type. We are returning a String, not a JSON object, so we set it to text/plain with the @Produces annotation.
4 A String "Hello World" is returned as the result.

Dependencies

To use REST-assured, add the following dependency on the Micronaut Test REST-assured module:

build.gradle
testImplementation("io.micronaut.test:micronaut-test-rest-assured")

Test

java/src/test/java/example/micronaut/HelloControllerTest.java
package example.micronaut;

import io.micronaut.test.extensions.junit5.annotation.MicronautTest;
import io.restassured.specification.RequestSpecification;
import org.junit.jupiter.api.Test;

import static org.hamcrest.CoreMatchers.is;

@MicronautTest // 
public class HelloControllerTest {

    @Test
    public void testHelloEndpoint(RequestSpecification spec) { // 
        spec    // 
            .when()
                .get("/hello")
            .then()
                .statusCode(200)
                .body(is("Hello World"));
    }
}
1 Annotate the class with @MicronautTest so the Micronaut framework will initialize the application context and the embedded server. More info.
2 Inject an instance of RequestSpecification.
3 Micronaut Test sets the embedded server port on spec, so it’s unnecessary to inject EmbeddedServer and retrieve it explicitly.

Testing the Application

To run the tests:

./gradlew test

Then open build/reports/tests/test/index.html in a browser to see the results.

Next Steps

Explore more features with Micronaut Guides.

Learn more about Micronaut Test.

Help with the Micronaut Framework

The Micronaut Foundation sponsored the creation of this Guide. A variety of consulting and support services are available.

License

Note
 All guides are released with an Apache License 2.0 for the code and a Creative Commons Attribution 4.0 license for the writing and media (images).