Given-When-Then 패턴과 given()&when()

Given - When - Then 패턴

 

📖 Given-When-Then 패턴이란?

테스트 코드를 표현하는 방식 중 하나로, TDD(Test-Driven Development; 테스트 주도 개발)에서 파생된 BDD(Behavior-Driven-Development; 행위 주도 개발)를 통해 탄생한 테스트 접근 방식

 

1️⃣ Given

테스트 수행 전 테스트에 필요한 환경 설정을 하는 단계로, 테스트에 필요한 변수 정의 또는 Mock객체를 활용한 특정 상황에 대한 행동 정의를 하는 단계

 

2️⃣ When

테스트의 목적을 보여주는 단계로, 실제 테스트 코드를 포함하여 테스트를 통한 결괏값을 가져오는 단계

 

3️⃣ Then

테스트 결과를 검증하는 단계로, When 단계 또는 테스트를 통해 나온 결과 중 검증이 필요한 부분에 대해 검증

 

 

📌 given()과 when() 메서드

given()

Mokito에서 제공하는 given() 메서드를 통해 어떤 객체에서, 어떤 메서드가 호출되고 어떤 파라미터를 주입 받는지 가정한 후 willReturn() 또는 willThrow() 등을 이용하여 결과를 미리 정의해놓기 위해 사용

@WebMvcTest
class UserRestControllerTest {

    @Autowired
    private MockMvc mockMvc;
    @Autowired
    private ObjectMapper objectMapper;

    @MockBean
    UserService userService;

    @Test
    @DisplayName("getUser 테스트")
    void getUserTest() throws Exception {
        given(userService.getUser(1L)).willReturn(new UserResponseDto(1L, "user", "유저 찾기 성공"));

        Long userId = 1L;

        mockMvc.perform(get(String.format("/api/v1/users/%d", userId)))
                .andExpect(status().isOk())
                .andExpect(jsonPath("$.id").exists())
                .andExpect(jsonPath("$.username").value("user"))
                .andExpect(jsonPath("$.message").value("유저 찾기 성공"))
                .andDo(print());

        verify(userService).getUser(1L);
    }
}

 

when()

테스트에 사용될 엔티티 객체를 생성한 후, when() 메서드를 통해 어떤 메서드가 호출되고 어떤 파라미터를 주입 받는지 가정한 후 thenReturn() 메서드를 이용하여 동작에 대한 결괏값 리턴을 설정하기 위해 사용

@WebMvcTest
class UserRestControllerTest {

    @Autowired
    private MockMvc mockMvc;
    @Autowired
    private ObjectMapper objectMapper;

    @MockBean
    UserService userService;

    @Test
    @DisplayName("getUser 테스트")
    void getUserTest() throws Exception {
        when(userService.getUser(1L)).thenReturn(new UserResponseDto(1L, "user", "유저 찾기 성공"));

        Long userId = 1L;

        mockMvc.perform(get(String.format("/api/v1/users/%d", userId)))
                .andExpect(status().isOk())
                .andExpect(jsonPath("$.id").exists())
                .andExpect(jsonPath("$.username").value("Soyeong"))
                .andExpect(jsonPath("$.message").value("유저 찾기 성공"))
                .andDo(print());

        verify(userService).getUser(1L);
    }
}

 

 

❓ Given-given(), When-when() 동일한 역할일까?

답은 ❌ 이다.

앞서 설명한 바와 같이 given() 과 when() 모두 Given-When-Then 중 Given의 역할을 담당하는 메서드로, 어떠한 메서드가 호출되고 어떤 파라미터를 주입받는지 가정한 후 이에 대한 결괏값을 미리 정의하기 위해 사용한다.

다만, given()의 경우 willReturn(), willThrow() 등의 메서드로 결괏값을 정의할 수 있고 when()의 경우 thenReturn(), thenThrow() 등의 메서드로 결괏값을 정의할 수 있다는 차이점이 있다.