9. 為RestController編寫單元測試

當我們需要對一個Rest Controller進行單元測試時，我們只想啟動和SpringMVC相關的組件，而不必要啟動所有的Web組件。我們可以使用WebMvcTest註解來解決這樣的測試需求。此註解將禁用Spring Boot的自動化配置，僅僅啟動與MVC相關的配置。下面將對測試用例中的幾個核心註解做一下介紹：

• @RunWith(SpringRunner.class) : SpringRunner是SpringJUnit4ClassRunner的簡寫，它擴展了BlockJUnit4ClassRunner類，用於提供測試時的Spring應用上下文信息。
• @WebMvcTest(value=UserController.class,secure = false) : 該註解用於測試Spring MVC應用程序，使用此註解的好處是我們只需要載入UserController類並對其中的方法進行單元測試，而不需要載入其他的控制器。
• MockMvc : MockMvc是測試Spring MVC應用程序的主要入口，它將為我們的測試提供一個模擬的應用上下文環境。
• @MockBean : MockBean主要是模擬向Spring應用上下文注入一個Bean對象，並使該Bean對象可以在控制器中被訪問到。

下面是測試用例的源代碼：

package com.ramostear.spring.boot.test.restservice;

import com.ramostear.spring.boot.test.restservice.controller.UserController;
import com.ramostear.spring.boot.test.restservice.model.Role;
import com.ramostear.spring.boot.test.restservice.model.User;
import com.ramostear.spring.boot.test.restservice.service.UserService;
import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mockito;
import org.skyscreamer.jsonassert.JSONAssert;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.boot.test.mock.mockito.MockBean;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.mock.web.MockHttpServletResponse;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.MvcResult;
import org.springframework.test.web.servlet.RequestBuilder;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;

import java.util.ArrayList;
import java.util.List;

@RunWith(SpringRunner.class)
@WebMvcTest(value = UserController.class,secure = false)
public class UserControllerTests {
private static Logger logger = LoggerFactory.getLogger(UserControllerTests.class);
@Autowired
private MockMvc mockMvc;

@MockBean
private UserService userService;

@Test
public void findAllUsers() throws Exception{
User user = new User();
user.setId("1001");
user.setName("ramostear");
user.setAlias("譚朝紅");

Role role = new Role();
role.setId("1001");
role.setName("admin");
role.setDescription("all permissions for this role.");
List<Role> roles = new ArrayList<>();
roles.add(role);
user.setRoles(roles);
List<User> users = new ArrayList<>();
users.add(user);

Mockito.when(userService.findAllUsers()).thenReturn(users);
RequestBuilder requestBuilder = MockMvcRequestBuilders.get("/users");
MvcResult result = mockMvc.perform(requestBuilder).andReturn();
String expected = "[{"id":"1001","name":"ramostear","alias":"譚朝紅","roles":[{"id":"1001","name":"admin","description":"all permissions for this role."}]}]";
logger.info(result.getResponse().getContentAsString());
JSONAssert.assertEquals(expected,result.getResponse().getContentAsString(),false);
}

@Test
public void findAllUserRoles() throws Exception{
Role role = new Role();
role.setId("1001");
role.setName("admin");
role.setDescription("all permissions for this role.");
List<Role> roles = new ArrayList<>();
roles.add(role);
Mockito.when(userService.findUserAllRoles("1001")).thenReturn(roles);
RequestBuilder requestBuilder = MockMvcRequestBuilders.get("/users/1001/roles");
MvcResult result = mockMvc.perform(requestBuilder).andReturn();
String expected = "[{"id":"1001","name":"admin","description":"all permissions for this role."}]";
logger.info(result.getResponse().getContentAsString());
JSONAssert.assertEquals(expected,result.getResponse().getContentAsString(),false);
}
}

Mockito.when().thenReturn():用於測試UserService在被調用時是否返回和預期一致的結果

mockMvc.perform().andReturn():mockMvc主要用於執行請求並返迴響應數據

下面我們執行上述兩個方法，看看測試結果：

兩個方法均測試通過，且控制台也輸出了如下的日誌信息：

2019-05-10 05:36:40.567 INFO 18268 --- [ main] c.r.s.b.t.r.UserControllerTests : [{"id":"1001","name":"admin","description":"all permissions for this role."}]
2019-05-10 05:36:40.585 INFO 18268 --- [ main] c.r.s.b.t.r.UserControllerTests : [{"id":"1001","name":"ramostear","alias":"譚朝紅","roles":[{"id":"1001","name":"admin","description":"all permissions for this role."}]}]

10 . 添加POST請求方法

現在我們在Rest Controller中新增一個為用戶添加新角色的方法，當角色被成功設置後將返回狀態碼為201的一個創建資源狀態。代碼如下：

@PostMapping(value = "/users/{id}")
public ResponseEntity<Object> setUserRole(@PathVariable(value = "id")String id, @RequestBody Role role){
userService.addUserRole(id,role);
return new ResponseEntity<>(role, HttpStatus.CREATED);
}

使用Postman對此介面進行請求，獲得如下的響應信息：

{
"id": "1002",
"name": "editor",
"description": "content editor"
}

下圖時使用Postman請求的實際結果：

11. 為Post方法提供單元測試用例

在接下來的測試中，我們將使用MockMvcRequestBuilders.post()方法來模擬請求添加用戶角色的方法，並使用accept()方法來設置數據格式，另外還需斷言請求響應的狀態值是否為CREATED且返回的角色信息是否與預期的一致。Post方法的測試源碼如下：

@Test
public void addUserRole() throws Exception{
String JSON = "{"id":"1002","name":"editor","description":"content editor"}";
RequestBuilder requestBuilder = MockMvcRequestBuilders.post("/users/1001")
.accept(MediaType.APPLICATION_JSON).content(JSON)
.contentType(MediaType.APPLICATION_JSON);
MvcResult result = mockMvc.perform(requestBuilder).andReturn();
MockHttpServletResponse response = result.getResponse();
Assert.assertEquals(HttpStatus.CREATED.value(),response.getStatus());
String expected = "{"id":"1002","name":"editor","description":"content editor"}";
logger.info(result.getResponse().getContentAsString());
JSONAssert.assertEquals(expected,result.getResponse().getContentAsString(),false);
}

最後，我們執行此測試用例方法，觀察測試結構：

通過圖我們可以看到，Post方法已成功通過測試。

今天的課程分享到這裡就結束了，在本次課程中，給出了如何測試Rest Controller的方法，同時還使用Postman來進行輔助測試。所有的測試都達到了預期的測試效果。

原文：

（第三講）使用JUnit對Spring Boot中的Rest Controller進行單元測試?

www.ramostear.com
推薦閱讀：