深度揭秘JUnit5与Mockito的单元测试神秘面纱

<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-test</artifactId>
      <version>3.1.6</version>
      <!-- 排除 JUnit 4 -->
      <exclusions>
          <exclusion>
              <groupId>org.junit.vintage</groupId>
              <artifactId>junit-vintage-engine</artifactId>
          </exclusion>
      </exclusions>
  </dependency>

  <dependency>
      <groupId>org.hamcrest</groupId>
      <artifactId>hamcrest</artifactId>
      <version>2.2</version>
  </dependency>

package com.icoderoad.springboot60days.day9.controller;

import static org.hamcrest.Matchers.hasSize;
import static org.hamcrest.Matchers.is;
import static org.mockito.Mockito.*;
import static org.mockito.ArgumentMatchers.any;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.icoderoad.springboot60days.day9.entity.User;
import com.icoderoad.springboot60days.day9.service.UserService;

import org.junit.jupiter.api.*;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.http.MediaType;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.mock.mockito.MockBean;

import java.util.Arrays;
import java.util.List;

@ExtendWith(MockitoExtension.class)
@WebMvcTest(UserController.class)
@TestMethodOrder(MethodOrderer.OrderAnnotation.class)
public class UserControllerTest {

    @Autowired
    private MockMvc mockMvc;

    @MockBean
    private UserService userService;

    @Autowired
    private ObjectMapper objectMapper;

    private User user;

    @BeforeEach
    void setUp() {
        user = new User();
        user.setId(1L);
        user.setUsername("Test User");
        user.setEmail("test@example.com");
    }

   /**
     * 验证UserController的getAllUsers方法正常获取所有用户信息。
     */
    @Test
    @Order(4)
    public void getAllUsersTest() throws Exception {
        List<User> users = Arrays.asList(user);
        when(userService.list()).thenReturn(users);

        mockMvc.perform(get("/users"))
                .andExpect(status().isOk())
                .andExpect(jsonPath("$", hasSize(1)))
                .andExpect(jsonPath("$[0].username", is(user.getUsername())));
    }

   /**
     * 验证UserController的createUser方法正常创建用户。
     */
    @Test
    @Order(1)
    public void createUserTest() throws Exception {
        when(userService.saveOrUpdate(any(User.class))).thenReturn(true);;

        mockMvc.perform(post("/users")
                        .contentType(MediaType.APPLICATION_JSON)
                        .content(objectMapper.writeValueAsString(user)))
                .andExpect(status().isOk());

        verify(userService, times(1)).save(any(User.class));
    }

   /**
     * 验证UserController的getUserById方法正常获取指定ID的用户信息。
     */
    @Test
    @Order(2)
    public void getUserByIdTest() throws Exception {
        when(userService.getById(user.getId())).thenReturn(user);

        mockMvc.perform(get("/users/{id}", user.getId()))
                .andExpect(status().isOk())
                .andExpect(jsonPath("$.username", is(user.getUsername())));
    }
        
  /**
     * 验证UserController的updateUserById方法正常更新指定ID的用户信息。
     */
    @Test
    @Order(3)
    public void updateUserByIdTest() throws Exception {
      when(userService.saveOrUpdate(any(User.class))).thenReturn(true);;

        mockMvc.perform(put("/users/{id}", user.getId())
                        .contentType(MediaType.APPLICATION_JSON)
                        .content(objectMapper.writeValueAsString(user)))
                .andExpect(status().isOk());

        verify(userService, times(1)).updateById(any(User.class));
    }
        
  /**
     * 验证UserController的deleteUserById方法正常删除指定ID的用户。
     */
    @Test
    @Order(5)
    public void deleteUserByIdTest() throws Exception {
      when(userService.removeById(user.getId())).thenReturn(true);;

        mockMvc.perform(delete("/users/{id}", user.getId()))
                .andExpect(status().isOk());

        verify(userService, times(1)).removeById(user.getId());
    }
}