서비스 단위 테스트 작성 방법

[sangwonsheep]

given-when-then 패턴

    @Test
    @DisplayName("식당 상세 조회 테스트 - 리뷰 3개, 평균 평점 4.5")
    void restaurant_find_with_reviews_3() {
        // given
        Long restaurantId = 1L;
        Long reviewCount = 3L;
        double averageRating = 4.5;
        
        // 앞에 넣은 메서드가 호출되면, 뒤에 적은 객체 또는 값을 반환한다.
        when(restaurantValidator.checkIfRestaurantPresent(restaurantId)).thenReturn(restaurantEntity);
        when(reviewService.getAverageRating(restaurantId)).thenReturn(new Rating(BigDecimal.valueOf(averageRating)));
        when(reviewService.getReviewCount(restaurantId)).thenReturn(reviewCount);

        // when
        // when().thenReturn() 스터빙을 통해,
        // restaurantService.findRestaurant() 에서 필요한 모든 외부 의존성을 미리 정의된 값으로 대체하여 사용함
        // 그렇기 때문에 'RestaurantResponse'에 예상된 값들이 포함되게 된다.
        RestaurantResponse restaurant = restaurantService.findRestaurant(restaurantId);

        // then
        assertThat(restaurant).isNotNull();
        assertThat(restaurant.getName()).isEqualTo(restaurantEntity.getName());
        assertThat(restaurant.getDescription()).isEqualTo(restaurantEntity.getDescription());
        assertThat(restaurant.getAverageRating()).isEqualTo(BigDecimal.valueOf(averageRating)); // 4.5
        assertThat(restaurant.getReviewCount()).isEqualTo(3L);
    }

하나의 테스트 메서드 안에는 given, when, then 절로 나뉩니다.

• given : 무언가 주어졌다. (enttiy, dto 등이 주어졌음.)
• when : 이렇게 수행하면 (service의 메서드 실행)
• then : 이런 결과가 나타난다. (주로, Assertion)

---

단위 테스트를 위한 기초 설정

// 해당 어노테이션을 붙여야 @Mock으로 선언된 객체들이 초기화된다.
// 붙이지 않으면 객체들이 모두 null로 들어가서 NullPointerException 발생
@ExtendWith(MockitoExtension.class)
class RestaurantServiceTest {

    // RestaurantService에서 사용할 가짜 객체 생성
    @Mock ReviewService reviewService;
    @Mock RestaurantValidator restaurantValidator;

    // RestaurantService에 위에서 만든 가짜 객체 넣어주기
    @InjectMocks RestaurantService restaurantService;

    RestaurantEntity restaurantEntity;

    @BeforeEach
    void setUp() {
        restaurantEntity = RestaurantEntity.builder()
                .name("새마을식당")
                .description("백종원의 새마을식당")
                .phoneNumber(new PhoneNumber("02-1234-1234"))
                .rating(new Rating(BigDecimal.ZERO))
                .serviceType(ServiceType.WAITING)
                .foodType(FoodType.KOREAN)
                .build();
    }

---

Mockito

public void deleteRestaurant(Long restaurantId) {
        restaurantRepository.deleteById(restaurantId);
 }

    @Test
    @DisplayName("식당 삭제 테스트")
    void restaurant_delete() {
        // given
        Long restaurantId = 1L;

        // 제거해야 함.
        when(restaurantRepository.save(any())).thenReturn(restaurantEntity);

        // when
        restaurantService.deleteRestaurant(restaurantId);

        // then
        verify(restaurantRepository, times(1)).deleteById(restaurantId);
    }

Unnecessary stubbings detected.
Clean & maintainable test code requires zero unnecessary code.
Following stubbings are unnecessary (click to navigate to relevant line of code):
  1. -> at org.example.catch_line.restaurant.service.RestaurantServiceTest.restaurant_delete(RestaurantServiceTest.java:175)
Please remove unnecessary stubbings or use 'lenient' strictness. More info: javadoc for UnnecessaryStubbingException class.
org.mockito.exceptions.misusing.UnnecessaryStubbingException: 

when()의 경우 실제 service 코드에서 사용하는 부분만 작성해야 합니다.

delete를 하기 위해서는 db에 데이터가 있어야 하지 않을까? 라는 생각에 save()를 먼저하고자 하였습니다.
Mockito를 이용하면 실제 db에 있는 데이터를 사용하지 않기 때문에 이런 과정이 필요가 없습니다.
그렇기 때문에 실제 service에 없는 코드를 stubbing? 하려고 하니 위와 같은 에러가 발생하였습니다.
해결법은 when() 관련된 코드만 제거해주면 됩니다.

Mock을 이용하여 테스트를 진행하면 실제 db에서 삭제되는 것은 확인이 불가능합니다.
제 생각에는 테스트하고자 하는 메서드가 잘 실행되는지만 확인하는 것 같습니다...
올바른 테스트인지는 아직 모르겠지만 restaurant 관련 coverage는 100%가 나오는 것을 확인했습니다.

---

Coverage 측정 방법

---

멤버 entity 생성 시 비밀번호 암호화

BCryptPasswordEncoder passwordEncoder = new BCryptPasswordEncoder();

MemberEntity memberEntity = MemberEntity.builder()
                .email(new Email("[email protected]"))
                .name("홍길동")
                .nickname("hong")
                .password(new Password(passwordEncoder.encode("123qwe!@Q")))
                .phoneNumber(new PhoneNumber("010-1234-1234"))
                .role(Role.USER)
                .build();

혹시 member entity 생성 중에 비밀번호 암호화 exception 떴을 때 쉽게 해결하기 위한 방법 올려둡니다!

---

CreatedAt null 값 들어가는 경우

@Getter
@MappedSuperclass
@EntityListeners(AuditingEntityListener.class)
public class BaseTimeEntity {
    @CreatedDate
    @Column(name = "created_at", updatable = false, nullable = false)
    private LocalDateTime createdAt;

    @LastModifiedDate
    @Column(name = "modified_at", nullable = false)
    private LocalDateTime modifiedAt;

}

• createdAt이 null이 발생하는 이유 : Spring의 Auditing 기능을 통해 자동으로 설정해주지 않기 때문입니다.

Mockito를 이용하는 단위 테스트에서는 위 기능이 작동하지 않기 때문에 null 값이 들어가게 됩니다.
이를 해결하기 위해선 반드시 수동으로 값을 넣어주어야만 합니다.
해결 방법은 아래에 코드와 함께 적도록 하겠습니다.

private List<ReviewEntity> getReviewList() {

        LocalDateTime now = LocalDateTime.now();
        RestaurantEntity restaurantEntity = getRestaurantEntity();

        ReviewEntity review1 = ReviewEntity.builder()
                .rating(5)
                .content("맛있어요")
                .member(memberEntity)
                .restaurant(restaurantEntity)
                .build();

        setCreatedAt(review1, now);
}

private void setCreatedAt(ReviewEntity reviewEntity, LocalDateTime createdAt) {
        try {
            Field createdAtField = BaseTimeEntity.class.getDeclaredField("createdAt");
            createdAtField.setAccessible(true);
            createdAtField.set(reviewEntity, createdAt);
        } catch (NoSuchFieldException | IllegalAccessException e) {
            e.printStackTrace();
        }
    }

로직 중에 createdAt을 사용하는 곳이 있다면 테스트 실행하면서 createdAt이 null이라는 에러를 터트릴 것입니다. (NullPointerException)

이를 해결하기 위한 방안이 2가지 있습니다.

1. entity를 직접 만들어서 넣어야 하는 경우에 위와 같은 방법으로 해결할 수 있습니다.
   리플렉션을 이용해 BaseTimeEntity에 접근해서 createdAt 값을 직접 설정해줍니다.

    @Test
    @DisplayName("리뷰 작성 테스트")
    void review_create_test() {
        // given
        Long memberId = 1L;
        Long restaurantId = 1L;
        ReviewCreateRequest request = getCreateRequest();

        when(memberValidator.checkIfMemberPresent(memberId)).thenReturn(getMemberEntity());
        when(restaurantValidator.checkIfRestaurantPresent(restaurantId)).thenReturn(getRestaurantEntity());

        // Mockito의 doAnswer를 사용하여 생성된 ReviewEntity의 createdAt 필드를 설정합니다.
        doAnswer(invocation -> {
            ReviewEntity reviewEntity = invocation.getArgument(0);
            setCreatedAt(reviewEntity, LocalDateTime.now());
            return reviewEntity;
        }).when(reviewRepository).save(any(ReviewEntity.class));

        // when
        ReviewResponse review = reviewService.createReview(memberId, restaurantId, request);

        // then
        assertThat(review).isNotNull();
        assertThat(review.getRating()).isEqualTo(5);
        assertThat(review.getContent()).isEqualTo("맛있어요");
    }

2. entity를 직접 만드는 것이 아닌 service의 entity를 활용해야 할 때 위와 같은 방법으로 해결할 수 있다.
   Mockito의 doAnswer를 이용해서 createdAt 값을 직접 설정할 수 있습니다.

우선은 서비스 테스트만 부탁드려요!

컨트롤러 테스트는 다른 글로 작성했습니다!

[soeunnPark]

와 감사합니다!!! 😄 😸

[I-migi]

감사합니다!! 참조해서 저도 내일까지 테스트 코드 PR올리겠습니다!! 👍