void 메서드 stubbing

Mockito와 BDDMockito를 이용해 테스팅하는 방법의 가장 큰 차이점은 BDDMockito를 이용하면,

상태 변화에 초점을 맞추는 흐름에 조금 더 가깝게 테스트 코드를 작성할 수 있다는 것이었다.

Mockito를 이용하면, when().thenReturn() 을, BDDMockito를 이용하면 given().willReturn() 을 사용했다.

기본적으로 Mockito든 BDDMocktio든 when() 혹은 given()을 통해 동작을 지정한다.

하지만, void()를 리턴 형식으로 갖는 메소드는 stubbing하는 법이 약간 다르다.

위에서 설명한 일반 stubbing은 when(mock.method()).thenReturn(value) 형식인데, mock.method()가 void값을 가지면 when(void)처럼 되기 때문에 Java 문법에 맞지 않는다.

대신 doNothing().when(mock).method()처럼 사용한다.

Mockito와 BDDMockito 각각을 이용해서 void 메서드를 테스팅하는 방법을 좀 더 자세히 살펴보겠다.

1. Mockito 사용 시

---

postService의 update메서드는 다음과 같이 파라미터 변수로 세가지 값을 가지며 리턴 타입이 void이다.

public void update(Integer id, String userName, PostUpdateRequest request) {
    Post post = validatePost(id, userName);
    post.updatePost(request.getTitle(),request.getBody());
}

update 메서드는 포스트를 수정하는 메서드이며 성공 테스트는 다음과 같다.

한가지 달라진 점은 doNothing() 을 사용했다는 점이다.

성공 테스트시 void 타입의 경우 반환값이 없기 때문에 doNothing() 으로 동작의 결과를 지정하고, 그 뒤에 동작의 조건을 설정한다.

@Test
@DisplayName("포스트 수정 성공")
@WithMockCustomUser
public void post_update_success() throws Exception {

    doNothing().when(postService).update(any(),any(),any());

    mockMvc.perform(put("/api/v1/posts/1")
                    .with(csrf())
                    .contentType(MediaType.APPLICATION_JSON)
                    .content(objectMapper.writeValueAsBytes(postUpdateRequest)))
            .andExpect(status().isOk())
            .andExpect(jsonPath("$.resultCode").value("SUCCESS"))
            .andExpect(jsonPath("$.result.postId").value(1))
            .andExpect(jsonPath("$.result.message").value("포스트 수정 완료"))
            .andDo(print());

    verify(postService, times(1)).update(any(), any(), any());
}

이번엔 void 타입의 실패 테스트를 진행해보겠다.

기존의 when().willThrow() 가 아니라 doThrow() 로 시작한 뒤, 동작의 조건을 설정한다.

@Test
@DisplayName("포스트 수정 실패(2) : 포스트 내용 없음")
@WithMockCustomUser
public void post_update_fail2() throws Exception {

    doThrow(new AppException(ErrorCode.POST_NOT_FOUND)).when(postService).update(any(),any(), any());

    mockMvc.perform(put("/api/v1/posts/1")
                    .with(csrf())
                    .contentType(MediaType.APPLICATION_JSON)
                    .content(objectMapper.writeValueAsBytes(postUpdateRequest)))
            .andExpect(status().is(ErrorCode.POST_NOT_FOUND.getStatus().value()))
            .andExpect(status().isNotFound())
            .andExpect(jsonPath("$.resultCode").value("ERROR"))
            .andExpect(jsonPath("$.result.errorCode").value("POST_NOT_FOUND"))
            .andExpect(jsonPath("$.result.message").value("해당 포스트가 없습니다."))
            .andDo(print());

    verify(postService, times(1)).update(any(), any(), any());
}

2. BDDMockito 사용 시

---

BDDMockito의 경우에도 크게 다르지 않다.

마찬가지로 포스트 수정 성공 테스트에선 willDoNothing() 을 통해 결과를 먼저 지정하고 시작한다.

@Test
@DisplayName("포스트 수정 성공")
@WithMockCustomUser
public void post_update_success() throws Exception {

    willDoNothing().given(postService).update(any(),any(),any());

    mockMvc.perform(put("/api/v1/posts/1")
                    .with(csrf())
                    .contentType(MediaType.APPLICATION_JSON)
                    .content(objectMapper.writeValueAsBytes(postUpdateRequest)))
            .andExpect(status().isOk())
            .andExpect(jsonPath("$.resultCode").value("SUCCESS"))
            .andExpect(jsonPath("$.result.postId").value(1))
            .andExpect(jsonPath("$.result.message").value("포스트 수정 완료"))
            .andDo(print());

    then(postService).should(times(1)).update(any(), any(), any());
}

실패 테스트도 Mockito가 사용한 doThrow 가 아닌 willThrow() 를 사용했다.

@Test
@DisplayName("포스트 수정 실패(2) : 포스트 내용 없음")
@WithMockCustomUser
public void post_update_fail2() throws Exception {

    willThrow(new AppException(ErrorCode.POST_NOT_FOUND)).given(postService).update(any(),any(), any());

    mockMvc.perform(put("/api/v1/posts/1")
                    .with(csrf())
                    .contentType(MediaType.APPLICATION_JSON)
                    .content(objectMapper.writeValueAsBytes(postUpdateRequest)))
            .andExpect(status().is(ErrorCode.POST_NOT_FOUND.getStatus().value()))
            .andExpect(status().isNotFound())
            .andExpect(jsonPath("$.resultCode").value("ERROR"))
            .andExpect(jsonPath("$.result.errorCode").value("POST_NOT_FOUND"))
            .andExpect(jsonPath("$.result.message").value("해당 포스트가 없습니다."))
            .andDo(print());

    then(postService).should(times(1)).update(any(), any(), any());
}

추가적으로, BDDMockito를 사용하면 Mockito의 verify 부분도 조금 다르다.

Mockito

verify(postService, times(1)).update(any(), any(), any());

BDDMockito

then(postService).should(times(1)).update(any(), any(), any());

References

• Mockito 공식문서
• BDDMockito 공식문서
• Mocking Void Methods with Mockito
• Mocking Exception Throwing using Mockito
• [SPRING] SPRING TEST MOCKITO MOCKITO와 BDDMOCKITO 구분해서 사용하기
• Java - Mockito를 이용하여 테스트 코드 작성하는 방법