Bài 12: Testing Web Layer Với WebMvcTest

1. Mục tiêu của test Controller

Controller là tầng giao tiếp giữa client và backend.

Nhiệm vụ chính của controller:

• nhận request HTTP
• gọi service để xử lý logic
• trả về response JSON đúng format, đúng status code

Khi test controller, ta chỉ muốn test hành vi web.

Ta không muốn:

• gọi service thật
• gọi database thật
• khởi động toàn bộ ứng dụng Spring Boot

Vì vậy, ta mock các tầng bên dưới controller.

Trong ví dụ UserController, tầng bên dưới thường là:

Khi test UserController, bạn sẽ:

• mock UserService bằng @MockBean
• vì controller gọi service, ta thay service thật bằng mock
• service đó nội bộ có thể gọi repository, nhưng trong test này nó không bao giờ được thực thi thật

Nói ngắn gọn:

• test controller thì mock service
• service bị mock thì repository cũng bị bỏ qua gián tiếp

2. Các annotation thường gặp trong Controller Test

@Import(TestSecurityConfig.class) thường hữu ích khi project có Spring Security và bạn muốn cấu hình security đơn giản hơn cho test.

3. @WebMvcTest là gì?

@WebMvcTest tạo một Spring context nhẹ, chỉ tập trung vào web layer.

Ví dụ:

@WebMvcTest(UserController.class)
class UserControllerTest {
    @Autowired
    private MockMvc mockMvc;

    @MockBean
    private UserService userService;
}

@WebMvcTest load những gì?

Nó thường load:

• @Controller
• @RestController
• @ControllerAdvice
• Jackson ObjectMapper
• MVC config
• MockMvc

@WebMvcTest không load những gì?

Nó không load:

• @Service
• @Repository
• repository thật
• database
• JPA layer
• toàn bộ application context như khi dùng @SpringBootTest

Mục tiêu là test nhanh và chỉ tập trung vào API endpoint.

4. MockMvc là gì?

MockMvc là một đối tượng giả lập HTTP client.

Nó cho phép bạn gọi controller mà không cần khởi động server thật.

Khi bạn viết:

mockMvc.perform(get("/api/users/1"))

Spring sẽ:

• gọi vào UserController.getUserById()
• chạy qua web layer
• nếu service đã mock thì chỉ chạy đến mock service
• trả về một response ảo để bạn kiểm tra

Response đó có thể được kiểm tra bằng:

• HTTP status
• response body
• JSON field
• content type

5. Cấu trúc của .andExpect(...)

Sau khi gọi perform(), bạn nối thêm .andExpect() để kiểm tra kết quả trả về.

Ví dụ:

mockMvc.perform(get("/api/users"))
       .andExpect(status().isOk())
       .andExpect(jsonPath("$[0].name").value("Alice"));

Giải nghĩa:

6. jsonPath() là gì?

jsonPath là cách duyệt vào JSON response.

Bạn có thể hiểu đơn giản:

• XPath dùng cho XML
• jsonPath dùng cho JSON

Ví dụ JSON object

Response:

{
  "id": 1,
  "name": "Alice",
  "email": "[email protected]"
}

Ví dụ JSON array

Response:

[
  { "id": 1, "name": "Alice" },
  { "id": 2, "name": "Bob" }
]

7. Khi nào dùng $.email, khi nào dùng $[0].name?

Cách viết jsonPath phụ thuộc vào JSON mà controller trả về.

Nếu API trả về object:

{
  "email": "[email protected]"
}

thì dùng:

jsonPath("$.email")

Nếu API trả về list:

[
  { "name": "Alice" }
]

thì dùng:

jsonPath("$[0].name")

Cách dễ nhất để biết JSON thật

Thêm .andDo(print()) vào test:

mockMvc.perform(get("/api/users"))
       .andDo(print());

Spring sẽ in toàn bộ response JSON ra console.

Bạn nhìn vào JSON thật, rồi viết jsonPath() tương ứng.

8. Cách viết .andExpect() tự nhiên

Giả sử controller như sau:

@GetMapping("/api/users/{id}")
public ResponseEntity<UserDto> getUser(@PathVariable Long id) {
    return ResponseEntity.ok(new UserDto(1L, "Alice", "[email protected]"));
}

Test có thể viết:

mockMvc.perform(get("/api/users/{id}", 1L))
        .andExpect(status().isOk())
        .andExpect(jsonPath("$.name").value("Alice"))
        .andExpect(jsonPath("$.email").value("[email protected]"));

Ý nghĩa:

• status().isOk() kiểm tra HTTP 200 OK
• jsonPath("$.name").value("Alice") kiểm tra field name
• jsonPath("$.email").value("[email protected]") kiểm tra field email

9. Mẹo học nhanh

Luôn thêm .andDo(print()) lúc mới viết test

mockMvc.perform(get("/api/users"))
       .andDo(print());

Cách này giúp bạn nhìn JSON thật trong console.

Viết test từ ngoài vào trong

Thứ tự dễ nhớ:

1. test status trước
2. test content type
3. test dữ liệu cụ thể bằng jsonPath

Ví dụ:

mockMvc.perform(get("/api/users"))
       .andExpect(status().isOk())
       .andExpect(content().contentType(MediaType.APPLICATION_JSON))
       .andExpect(jsonPath("$[0].name").value("Alice"));

Nhớ quy tắc object và list

Nếu API trả object:

$.fieldName

Nếu API trả list:

$[index].fieldName

10. Tổng kết dễ nhớ

11. Kết luận

@WebMvcTest giúp bạn test controller một cách gọn và nhanh.

Nó phù hợp khi bạn muốn kiểm tra:

• endpoint có trả đúng status code không
• response JSON có đúng format không
• controller có gọi service mock đúng flow không
• API có behave đúng ở web layer không

Điểm quan trọng:

• test controller thì không cần database
• test controller thì mock service
• dùng MockMvc để gọi endpoint
• dùng andExpect() để kiểm tra response
• dùng jsonPath() để kiểm tra JSON