인프런 커뮤니티 질문&답변

안녕하세요. 우빈님

시간대에 따라 다른 결과를 주는 로직을 테스트 하는 과정에서 고민이 있어 질문을 드립니다.

우빈님이 강의에서도 언급하셨지만, 시간과 같이 관측할 때마다 달라지는 영역은 외부로 분리하면 테스트하기 쉬워진다고 말씀하셨습니다.!

하지만, 현재 서비스 레이어 까지만 분리가 가능하고 컨트롤러에서 LocalDateTime을 파라미터로 받지 못하는 상황입니다.

그래서 컨트롤러를 테스트할 때 어떻게 해야할까 고민을 좀 해봤는데요.

저의 결론은 TimeProvider라는 클래스를 하나 만들어서

컨트롤러를 테스트할 때는 이를 mocking하는 방식으로 테스트 코드를 작성했습니다.

TimeProvider

/**
 * 시간을 고정하여 테스트하기 위해 사용
 */
@Component
public class TimeProvider {
    public LocalDateTime getCurrentLocalDateTime() {
        return LocalDateTime.now();
    }
}

Controller

• GET을 사용하고 싶은데, 외부와 연동해야해서 POST를 사용할 수 밖에 없습니다. ㅠㅠ

/**
 * 인기 메뉴 조회
 * 현재 시간대의 식사종류와 일치하는 가장 조회수가 많은 금일 식사 메뉴 조회
 */
@PostMapping("/menu/top1-view")
public ResponseEntity<SkillResponse> getTop1RestaurantMenuByView(@RequestBody SkillPayload payload, @PageableDefault(size = 1) Pageable pageable) {
    log.info("request={}", payload);

    Page<RestaurantMenuResponse> top1RestaurantMenuByView = restaurantService.findTop1RestaurantMenuByView(pageable, timeProvider.getCurrentLocalDateTime());
    RestaurantsMenuResponse response = new RestaurantsMenuResponse(top1RestaurantMenuByView.getContent());

    return new ResponseEntity<>(response.toSkillResponseUseTextCard(apiVersion), HttpStatus.OK);
}

Test Code

@Test
@DisplayName("추천수 가장 많은 메뉴를 1개 조회한다.")
void getTop1UosRestaurantMenuByView() throws Exception {
    // given
    // 현재 시간을 고정할 시간 생성
    LocalDateTime fixedDateTime = LocalDateTime.of(2023, 8, 16, 10, 59, 59);
    when(timeProvider.getCurrentLocalDateTime()).thenReturn(fixedDateTime);

    String date = CrawlingUtils.toDateString(fixedDateTime);
    restaurant restaurant1 = createUosRestaurant(date, STUDENT_HALL, MealType.BREAKFAST, "라면", 0, 0);
    restaurant restaurant2 = createUosRestaurant(date, MAIN_BUILDING, MealType.BREAKFAST, "김밥", 1, 0);
    restaurant restaurant3 = createUosRestaurant(date, WESTERN_RESTAURANT, MealType.BREAKFAST, "돈까스", 2, 0);
    restaurant restaurant4 = createUosRestaurant(date, MUSEUM_OF_NATURAL_SCIENCE, MealType.BREAKFAST, "제육", 2, 1);
    restaurantRepository.saveAll(List.of(restaurant1, restaurant2, restaurant3, restaurant4));

    SkillPayload skillPayload = createSkillPayload(RestaurantName.STUDENT_HALL.name(), MealType.BREAKFAST.name());

    // when // then
    mockMvc.perform(post("/api/v1/text-card/restaurant/menu/top1-view")
                    .contentType(MediaType.APPLICATION_JSON)
                    .content(om.writeValueAsBytes(skillPayload))
                    .content(om.writeValueAsString(PageRequest.of(0, 1))))
            .andDo(print())
            .andExpect(status().isOk())
            .andExpect(jsonPath("$.version").value(SkillResponse.apiVersion))
            .andExpect(jsonPath("$.template").isNotEmpty())
            .andExpect(jsonPath("$.template.outputs").isArray())
            .andExpect(jsonPath("$.template.outputs[0].textCard").isNotEmpty())
            .andExpect(jsonPath("$.template.outputs[0].textCard.text").isString());
}

이런식으로 작성하는 것이 최선일까요?

LocalDateTime fixedDateTime = LocalDateTime.of(2023, 8, 16, 10, 59, 59);
when(timeProvider.getCurrentLocalDateTime()).thenReturn(fixedDateTime);

TimeProvider 클래스를 만들어서 mocking 하는 방법이 최선일까요?

혹시 더 좋은 방법을 말씀주시면 감사하겠습니다.!

좋은 강의 만들어 주셔서 감사합니다.^^