[Spring/Test Code] Unnecessary stubbings detected, UnnecessaryStubbingException

문제

@ParameterizedTest
@MethodSource("invalidCreatePostArgs")
void createPost_예외(
    Long userId,
    Long problemNumber,
    List<String> categories,
    Class<? extends RuntimeException> expectedException,
    ErrorMessage errorMessage) {

    PostCreateEditRequestDto requestDto = PostFixture.requestDto(problemNumber, categories, PostFixture.TEST_TITLE, PostFixture.TEST_CONTENT);

    // 존재하지 않는 사용자 ID라면 empty
    given(userRepository.findById(userId)).willReturn(
        userId.equals(VALID_USER_ID) ? Optional.of(user) : Optional.empty()
    );

    // 존재하지 않는 문제번호라면 empty
    given(problemRepository.findByNumber(problemNumber)).willReturn(
        problemNumber.equals(VALID_PROBLEM_NUMBER) ? Optional.of(problem) : Optional.empty()
    );

    given(categoryRepository.findByNameIn(categories)).willReturn(List.of(category));

    assertThatThrownBy(() -> postService.createPost(userId, requestDto))
        .isInstanceOf(expectedException)
        .hasMessage(errorMessage.getMessage());
}

static Stream<Arguments> invalidCreatePostArgs() {
    return Stream.of(
        // 존재하지 않는 사용자
        Arguments.of(INVALID_USER_ID, VALID_PROBLEM_NUMBER, VALID_CATEGORIES, ForbiddenException.class, ErrorMessage.USER_NOT_FOUND),

        // 존재하지 않는 문제번호
        Arguments.of(VALID_USER_ID, INVALID_PROBLEM_NUMBER, VALID_CATEGORIES, BadRequestException.class, ErrorMessage.INVALID_PROBLEM_INCLUDED),

        // 존재하지 않는 카테고리
        Arguments.of(VALID_USER_ID, VALID_PROBLEM_NUMBER, INVALID_CATEGORIES, BadRequestException.class, ErrorMessage.INVALID_CATEGORY_INCLUDED)
    );
}

에러메세지

nnecessary stubbings detected.
Clean & maintainable test code requires zero unnecessary code.
Following stubbings are unnecessary (click to navigate to relevant line of code):
  1. -> at icet.koco.post.PostServiceTest$createPostTest.createPost_예외(PostServiceTest.java:154)
  2. -> at icet.koco.post.PostServiceTest$createPostTest.createPost_예외(PostServiceTest.java:158)
Please remove unnecessary stubbings or use 'lenient' strictness. More info: javadoc for UnnecessaryStubbingException class.

---

원인

존재하지 않는 사용자의 경우 첫번째 given 때 error가 발생하면서 문제 번호, 카테고리 관련 stub가 사용되지 않는다.

// userId가 INVALID_USER_ID인 경우
given(userRepository.findById(userId)) // ← 여기서 Optional.empty() 반환 → 예외 발생
// 아래 두 given은 실행되지 않음
given(problemRepository.findByNumber(problemNumber))
given(categoryRepository.findByNameIn(categories))

이러할 경우에 Mockito Core 3.x 버전을 사용할 때 위와 같이 UnnecessaryStubbingException 에러가 발생한다.

---

해결

테스트 클래스에 다음 애노테이션을 붙여 Mockito의 strict 모드를 완화해주었다.

@MockitoSettings(strictness = Strictness.LENIENT)