Làm thế nào để Test Jersey Rest API với JUnit?

Trong bài này tôi sẽ hướng dẫn các bạn cách viết Unit Test để test Jersey REST API sử dụng Jersey Test.

Một số kiến thức bạn cần nắm trước khi xem phần tiếp theo của bài viết này:

• Unit Test là gì và cách viết JUnit test

• Tạo ứng dụng Java RESTful API với Jersey

Test REST API cần test những gì?

Khi test một resource REST API, thông thường có một vài thứ cần test như sau:

• HTTP response code : 200 OK, 201 Created, 204 NO Content, …
• HTTP headers trong response: Content-Type, Content-Encoding, Content-Length, Content-Language, …
• Payload (JSON, XML).

Tạo Jersey Project

Tương tự như các bài viết trước, chúng ta sẽ tạo Jersey project với cấu trúc như sau:

Thêm thư viện Jersey test sau vào file pom.xml:

<!-- https://mvnrepository.com/artifact/org.glassfish.jersey.test-framework.providers/jersey-test-framework-provider-grizzly2 -->
		<dependency>
		    <groupId>org.glassfish.jersey.test-framework.providers</groupId>
		    <artifactId>jersey-test-framework-provider-grizzly2</artifactId>
		    <version>2.29</version>
		</dependency>

Xây dựng Jersey Rest API

Giả sử chúng ta có các API sau:

Jersey implement các API như sau:

package com.gpcoder.api;

import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status;
import javax.ws.rs.core.SecurityContext;

import com.gpcoder.model.Order;

// URI:
// http(s)://<domain>:(port)/<YourApplicationName>/<UrlPattern in web.xml>/<path>
// http://localhost:8080/api/orders
@Path("/orders")
public class OrderService {

	@GET
	@Path("/{id}")
	public Response get(@PathParam("id") int id) {
		Order order = new Order();
		order.setId(1);
		order.setName("gpcoder");
		return Response.ok(order).build();
	}

	@POST
	public Response insert(Order order, @Context SecurityContext securityContext) {
		int newOrderId = 999;
		return Response.status(Status.CREATED).entity(newOrderId).build();
	}

	@PUT
	@Path("/{id}")
	public Response update(@PathParam("id") int id, Order order) {
		return Response.ok().build();
	}

	@DELETE
	@Path("/{id}")
	public Response delete(@PathParam("id") int id) {
		return Response.status(Status.NO_CONTENT).build();
	}
}

Test Jersey Rest API với JUnit và JerseyTest

Để test Jersey REST API chúng ta sẽ sử dụng thư viện JUnit Test và Jersey Test .

package com.gpcoder.api;

import static org.hamcrest.CoreMatchers.containsString;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertThat;

import javax.ws.rs.client.Entity;
import javax.ws.rs.core.Application;
import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;

import org.glassfish.jersey.server.ResourceConfig;
import org.glassfish.jersey.test.JerseyTest;
import org.junit.Test;

import com.gpcoder.model.Order;

public class OrderServiceTest extends JerseyTest {

	@Override
	public Application configure() {
		return new ResourceConfig(OrderService.class);
	}

	@Test
	public void testGetById() {
		Response response = target("/orders/1").request().accept(MediaType.APPLICATION_JSON).get();
		assertEquals("Should return status 200", 200, response.getStatus());
		assertNotNull("Should return user object as json", response.getEntity());
		assertEquals("Http Content-Type should be: ", MediaType.APPLICATION_JSON, 
				response.getHeaderString(HttpHeaders.CONTENT_TYPE));
		assertThat("Should return new order contains gpcoder string", 
				response.readEntity(String.class), containsString("gpcoder"));
	}

	@Test
	public void testCreate() {
		Order order = new Order(1, "gpcoder");
		Response response = target("/orders").request().post(Entity.entity(order, MediaType.APPLICATION_JSON));
		assertEquals("Should return status 201", 201, response.getStatus());
		assertNotNull("Should return new order id", response.readEntity(Integer.class));
	}

	@Test
	public void testUpdate() {
		Order order = new Order(1, "gpcoder edited");
		Response response = target("/orders/1").request().put(Entity.entity(order, MediaType.APPLICATION_JSON));
		assertEquals("Should return status 200", 200, response.getStatus());
	}

	@Test
	public void testDelete() {
		Response response = target("/orders/1").request().delete();
		assertEquals("Should return status 204", 204, response.getStatus());
	}
}

Giải thích đôi chút về chương trình trên:

• Đầu tiên, chúng ta tạo một class Test extend từ JerseyTest. Đây là bắt buộc nếu muốn test JAX-RS và Jersey-based applications sử dụng Jersey test framework.
• Override phương thức configure() : chỉ định resource cần test.
• Tiếp theo viết các method JUnit test.
• Để call các REST API, chúng ta sẽ sử dụng phương thức target(), request() để tạo WebTarget, Builder tương tự như cách sử dụng Jersey Client.
• Cuối cùng gửi các request thông qua các phương thức: post(), get(), put(), delete().

Trên đây là một số hướng dẫn cơ bản để test REST API sử dụng thư viện Jersey test. Trong bài viết tiếp theo, tôi sẽ hướng dẫn các bạn một thư viện khác rất mạnh mẽ để test web service là REST Assured.

Tài liệu tham khảo:

• https://jersey.github.io/documentation/latest/test-framework.html
• https://www.baeldung.com/jersey-test

Chuyên mục: Java Webservice, REST, Unit Test Được gắn thẻ: JUnit, REST, Unit Test, Webservice

Bình luận

bình luận