Test REST Web Service đơn giản hơn với REST Assured

Test REST API sử dụng REST Assured

Do các API cần phải được chứng thực user trước khi sử dụng, nên chúng ta cần chứng thực trước để nhận một Token (JWT), sau đó gửi chúng vào header ở mỗi request.

• getBearerToken() : gửi request authentication để lấy token (JWT).
• testGetById_Way1() : sử dụng để test GET /api/orders/{id}, trong ví dụ này tôi sẽ verify trực tiếp response thông qua phương thức body của REST Assured.
• testGetById_Way2() : sử dụng để test GET /api/orders/{id}, trong ví dụ này tôi sẽ tạo một POJO object để nhận response và verify kết quả thông qua các phương thức của JUnit.
• testCreate() : sử dụng để test POST /api/orders
• testUpdate() : sử dụng để test PUT /api/orders/{id}
• testDelete() : sử dụng để test DELETE /api/orders/{id}

Xem thêm các việc làm REST API hấp dẫn trên TopDev

OrderServiceRestAssuredTest.java

package com.gpcoder.api;

import static io.restassured.RestAssured.given;
import static org.hamcrest.Matchers.equalTo;

import javax.ws.rs.core.Response.Status;

import org.junit.Assert;
import org.junit.BeforeClass;
import org.junit.Test;

import com.gpcoder.model.Order;

import io.restassured.RestAssured;
import io.restassured.http.ContentType;
import io.restassured.response.Response;

public class OrderServiceRestAssuredTest {

    private static String BEARER_TOKEN = "";

    @BeforeClass
    public static void setUp() {
        RestAssured.enableLoggingOfRequestAndResponseIfValidationFails();
        RestAssured.baseURI = "http://localhost";
        RestAssured.port = 8080;
        BEARER_TOKEN = getBearerToken();
    }

    public static String getBearerToken() {
        Response response = 
            given()
                .header("Content-Type", "application/x-www-form-urlencoded")
                .formParam("username", "gpcoder")
                .formParam("password", "gpcoder")
                .request()
            .when()
                .post("/api/auth")
            .then()
                .assertThat()
                .statusCode(Status.OK.getStatusCode())
                .extract()
                .response();
        return response.asString();

    }

    @Test
    public void testGetById_Way1() {
        given()
             .headers("Authorization", "Bearer " + BEARER_TOKEN)
             .accept(ContentType.JSON)
        .when()
             .get("/api/orders/1")
        .then()
             .statusCode(Status.OK.getStatusCode())
             .contentType(ContentType.JSON)
             .body("id", equalTo(1)) // Verify JSON Path
             .body("name", equalTo("gpcoder"));
    }

    @Test
    public void testGetById_Way2() {
        Order order = 
            given()
                .headers("Authorization", "Bearer " + BEARER_TOKEN)
                .accept(ContentType.JSON)
            .when()
                .get("/api/orders/1")
            .then()
               .statusCode(Status.OK.getStatusCode())
               .contentType(ContentType.JSON)
               .extract().as(Order.class); // Use POJOs and Object Mapping

        Assert.assertEquals(1, order.getId().intValue());
        Assert.assertEquals("gpcoder", order.getName());
    }

    @Test
    public void testCreate() {
        Order order = new Order(1, "gpcoder");

        Integer newOrderId =
            given()
                .headers("Authorization", "Bearer " + BEARER_TOKEN)
                .contentType(ContentType.JSON)
                .accept(ContentType.JSON)
                .body(order)
           .when()
                .post("/api/orders")
           .then()
               .assertThat()
               .statusCode(Status.CREATED.getStatusCode())
               .extract().as(Integer.class);

        Assert.assertEquals(999, newOrderId.intValue());
    }

    @Test
    public void testUpdate() {
        Order order = new Order(1, "gpcoder edited");
        given()
            .headers("Authorization", "Bearer " + BEARER_TOKEN)
            .contentType(ContentType.JSON)
            .body(order)
        .when()
            .put("/api/orders/{id}/", order.getId())
        .then()
            .assertThat()
            .statusCode(Status.OK.getStatusCode());
    }

    @Test
    public void testDelete() {
        given()
            .headers("Authorization", "Bearer " + BEARER_TOKEN)
        .when()
            .delete("/api/orders/{id}/", 1)
        .then()
           .assertThat()
           .statusCode(Status.NO_CONTENT.getStatusCode());
    }
}

Các bạn có thể chạy thử để xem kết quả.

Lưu ý: Phải start server REST API lên trước khi chạy Unit Test.

Như bạn thấy, REST Assured hỗ trợ cú pháp rất quen thuộc từ Behavior-Driven Development (BDD) khi viết Unit Test là Given/ When/ Then. Nhờ vậy mà Unit test của chúng ta rất dễ đọc và dễ kiểm tra tất cả mọi thứ (setup, execution, and verification) với chỉ vài dòng code.

• Given: Thiết lập các điều kiện cần thiết: khởi tạo các đối tượng, xác định tài nguyên cần thiết, xây dựng các dữ liệu giả, …
• When: Triệu gọi các phương thức cần kiểm tra.
• Then: Kiểm tra sự hoạt động đúng đắn của các phương thức.

Trên đây là một số ví dụ cơ bản về viết Unit Test cho REST web server sử dụng thư viện REST Assured, còn rất nhiều phương thức khác hỗ trợ chúng ta viết test dễ dàng hơn và nhanh chóng hơn, các bạn hãy tham khảo thêm trên document của REST Assured.