Mockito와 BDDMockito

Service 테스트 코드 작성 시 단순히 서비스 로직이 돌아가는지 확인하기 위해서는, 모든 계층과 관계를 끊고, 오로지 로직만 테스트 할 수 있도록 환경을 구성하는 것이 좋다.

그렇기에, mock 객체를 생성하고, stubbing 과정을 통해 검증하는 것이 좋다.

그런데, 잘 찾아보면 when().thenReturn() 을 사용하기도 하고, given().willReturn() 을 사용하기도 한다.

둘 간의 차이를 알아보자.

1. Mock

---

Mock이란 모듈의 겉모양이 실제 모듈과 비슷하도록 만든 가짜 객체이다.

위에 상술한대로, Service 계층에서 의존성을 제거한 상태로 테스트 작성이 어려워 의존성을 단절시키는데 도움을 주는 객체라고 생각하면 된다.

2. Mockito

---

Mock 객체를 직접 만들고 관리하는 대표적인 Framework 중에 하나가 바로 Mockito이다.

Mockito를 사용하기 위해서는 @ExtendWith(MockitoExtention.class) 를 테스트 클래스 상단에 지정해주면 된다.

그러면 @Mock 어노테이션을 통해 간단하게 Mock 객체를 만들어 사용할 수 있다.

다음과 같은 예시를 보자.

@ExtendWith(MockitoExtension.class)
class PostServiceTest {

    @Mock
    private PostRepository postRepository;

    @InjectMocks
    private PostService postService;

    private Post post;

    @BeforeEach
    void setup() {
        post = Post.builder().id(1).title("title").body("body").user(user).build();
    }

    @Test
    @DisplayName("포스트 상세 조회 성공")
    void findPost_success() throws Exception {
        when(postRepository.findById(post.getId())).thenReturn(Optional.of(post));

        PostDetailResponse postDetail = postService.findPost(1);
        assertThat(postDetail.getId()).isEqualTo(1);
        assertThat(postDetail.getTitle()).isEqualTo("title");
        assertThat(postDetail.getBody()).isEqualTo("body");
        assertThat(postDetail.getUserName()).isEqualTo("user");

        verify(postRepository, times(1)).findById(post.getId());
    }
}

위 예시는 포스트 상세 조회 성공 테스트 상황이다.

@Mock 어노테이션을 통해 mock PostRepository 객체를 생성하고,

@InjectMocks 어노테이션을 통해 @Mock 이 붙은 목객체를 @InjectMocks 이 붙은 객체에 주입한다.

그리고, when 메서드를 통해 원하는 동작을 정할 수 있다.

즉, 어떤 상황에서 Mock 객체가 어떤 값을 리턴하도록 만들 수 있다는 말이다.

이것을 Stubbing 이라고 한다.

assertThat을 통해 실제값과 예측값을 검증하고, 마지막으로 verify 메서드를 통해 mock 객체에 내가 동작을 지정한 메서드가 사용됐는지 확인 할 수 있다.

이제 BDDMockito에 대해 알아보자.

3. BDDMockito

---

BDD 란 Behavior-Driven Development의 약어로, 무엇을 테스트할 것인가 에 초점이 맞춰져 있다.

테스트 대상의 상태 변화를 최우선으로 하기에 Given(조건), When(기능 수행), Then(예상 결과) 의 시나리오 패턴으로 이루어져 있다.

그렇다면, 위의 코드에서 어색한 부분을 바로 찾을 수 있다.

바로, Stubbing 하는 부분이 문제가 된다.

when(postRepository.findById(post.getId())).thenReturn(Optional.of(post));

테스트 코드 흐름 상, when().thenReturn() 부분은 테스트 시작 지점인 조건을 거는 상황이다.

시나리오 패턴 상 Given 지점이다.

그런데, when으로 시작하니 분명히 어색하다.

이런 부분을 해결하기 위해, 시나리오에 맞게끔 테스트 코드 흐름이 이어질 수 있게 이름을 변경해준 프레임워크가 바로 BDDMockito라고 생각하면 된다.

사실 BDDMockito 코드를 살펴보면 별도의 프레임워크가 아니라 Mockito를 상속한 클래스이다.

세부 동작에는 차이가 없고, 테스트 코드의 가독성을 높이기 위한 프레임워크라고 보면 된다.

위의 전체 코드를 변경해보면, 다음과 같다.

@ExtendWith(MockitoExtension.class)
class PostServiceTest {

    @Mock
    private PostRepository postRepository;

    @InjectMocks
    private PostService postService;

    private Post post;

    @BeforeEach
    void setup() {
        post = Post.builder().id(1).title("title").body("body").user(user).build();
    }

    @Test
    @DisplayName("포스트 상세 조회 성공")
    void findPost_success() throws Exception {
        given(postRepository.findById(post.getId())).willReturn(Optional.of(post));

        PostDetailResponse postDetail = postService.findPost(1);
        assertThat(postDetail.getId()).isEqualTo(1);
        assertThat(postDetail.getTitle()).isEqualTo("title");
        assertThat(postDetail.getBody()).isEqualTo("body");
        assertThat(postDetail.getUserName()).isEqualTo("user");

        verify(postRepository, times(1)).findById(post.getId());
    }
}

---

References

• Mockito와 BDDMockito는 뭐가 다를까?
• Java - Mockito를 이용하여 테스트 코드 작성하는 방법
• Mockito 사용하기 1
• [TDD] Test code 접근 방식, Mock, Mockito, BDD
• Mockito vs BDDMockito