컨트롤러 단위 테스트 작성 방법

[sangwonsheep]

컨트롤러 단위 테스트 방법

@Slf4j
@WebMvcTest(RestaurantController.class) // Controller 단위 테스트
@MockBean(JpaMetamodelMappingContext.class) // JPA metamodel empty 문제 해결 방법
@AutoConfigureMockMvc(addFilters = false) // 테스트 시 Security 비활성화
class RestaurantControllerTest {

    @Autowired MockMvc mockMvc;

    @MockBean RestaurantService restaurantService;
    @MockBean RestaurantHourService restaurantHourService;

@Slf4j
@Controller
@RequestMapping("/restaurants")
@RequiredArgsConstructor
public class RestaurantController {

    private final RestaurantService restaurantService;
    private final RestaurantHourService restaurantHourService;

컨트롤러 테스트 시 해당 어노테이션들이 필요합니다.
해당 어노테이션들을 붙이지 않으면 생기는 문제에 대해서는 아래에 작성하겠습니다.

@MockBean에는 실제 Controller에서 스프링에 의해 주입받는 객체들을 적어주면 됩니다.

그 후 테스트할 메서드에 대해 작성해주면 됩니다.

    @Test
    @DisplayName("식당 상세 조회 테스트")
    void view_restaurant_test() throws Exception {
        // given
        Long restaurantId = 1L;
        RestaurantResponse restaurant = getRestaurantResponse();
        List<RestaurantHourResponse> restaurantHours = getRestaurantHourResponseList();
        RestaurantHourResponse hourResponse = getRestaurantHourResponse();

        DayOfWeek currentDayOfWeek = LocalDate.now().getDayOfWeek();
        DayOfWeeks dayOfWeek = DayOfWeeks.from(currentDayOfWeek);

        when(restaurantService.findRestaurant(restaurantId)).thenReturn(restaurant);
        when(restaurantHourService.getAllRestaurantHours(restaurantId)).thenReturn(restaurantHours);
        when(restaurantHourService.getRestaurantHour(restaurantId, dayOfWeek)).thenReturn(hourResponse);

        // when
        // then
        mockMvc.perform(get("/restaurants/{restaurantId}", restaurantId))
                .andExpect(status().isOk())
                .andExpect(view().name("restaurant/restaurant"))
                .andExpect(model().attribute("restaurant", restaurant))
                .andExpect(model().attribute("restaurantHours", restaurantHours))
                .andExpect(model().attribute("hourResponse", hourResponse))
                .andExpect(model().attribute("dayOfWeek", dayOfWeek.getDescription()));
    }

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
mockMvc.perform(get())
get()는 MockMvcRequestBuilders를 import 하시면 됩니다!

실제 컨트롤러와 테스트 코드는 같은 로직을 실행해야만 합니다.
그렇지 않았을 때 생기는 문제는 아래에 타임리프 문제에 작성되어 있습니다.
Service Test와 마찬가지로 when().thenReturn()을 통해서 객체를 만들어줘야 합니다.

    @GetMapping("/{restaurantId}")
    public String viewRestaurant(
            @PathVariable Long restaurantId,
            Model model
    ) {
        DayOfWeek currentDayOfWeek = LocalDate.now().getDayOfWeek();
        DayOfWeeks dayOfWeek = DayOfWeeks.from(currentDayOfWeek);

        RestaurantResponse restaurant = restaurantService.findRestaurant(restaurantId);
        List<RestaurantHourResponse> restaurantHours = restaurantHourService.getAllRestaurantHours(restaurantId);
        RestaurantHourResponse hourResponse = restaurantHourService.getRestaurantHour(restaurantId, dayOfWeek);

        model.addAttribute("restaurant", restaurant);
        model.addAttribute("restaurantHours", restaurantHours);
        model.addAttribute("hourResponse", hourResponse);
        model.addAttribute("dayOfWeek", dayOfWeek.getDescription());
        return "restaurant/restaurant";
    }

---

JPA metamodel empty 문제

java.lang.IllegalStateException: Failed to load ApplicationContext for [WebMergedContextConfiguration@2a120c88 testClass = org.example.catch_line.restaurant.controller.RestaurantControllerTest, locations = [], classes = [org.example.catch_line.CatchLineApplication], contextInitializerClasses = [], activeProfiles = [], propertySourceDescriptors = [], propertySourceProperties = ["org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTestContextBootstrapper=true"], contextCustomizers = [org.springframework.boot.test.autoconfigure.OverrideAutoConfigurationContextCustomizerFactory$DisableAutoConfigurationContextCustomizer@5c18016b, org.springframework.boot.test.autoconfigure.actuate.observability.ObservabilityContextCustomizerFactory$DisableObservabilityContextCustomizer@1f, org.springframework.boot.test.autoconfigure.filter.TypeExcludeFiltersContextCustomizer@c277e981, org.springframework.boot.test.autoconfigure.properties.PropertyMappingContextCustomizer@4a823347, org.springframework.boot.test.autoconfigure.web.servlet.WebDriverContextCustomizer@2cae1042, [ImportsContextCustomizer@4fa0ee7e key = [org.springframework.boot.autoconfigure.task.TaskExecutionAutoConfiguration, org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration, org.springframework.boot.autoconfigure.web.servlet.HttpEncodingAutoConfiguration, org.springframework.boot.autoconfigure.validation.ValidationAutoConfiguration, org.springframework.boot.autoconfigure.context.MessageSourceAutoConfiguration, org.springframework.boot.autoconfigure.hateoas.HypermediaAutoConfiguration, org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration, org.springframework.boot.autoconfigure.data.web.SpringDataWebAutoConfiguration, org.springframework.boot.test.autoconfigure.web.reactive.WebTestClientAutoConfiguration, org.springframework.boot.autoconfigure.web.servlet.error.ErrorMvcAutoConfiguration, org.springframework.boot.test.autoconfigure.web.servlet.MockMvcAutoConfiguration, org.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration, org.springframework.boot.autoconfigure.security.servlet.SecurityFilterAutoConfiguration, org.springframework.boot.autoconfigure.http.HttpMessageConvertersAutoConfiguration, org.springframework.boot.autoconfigure.security.oauth2.client.servlet.OAuth2ClientAutoConfiguration, org.springframework.boot.test.autoconfigure.web.servlet.MockMvcSecurityConfiguration, org.springframework.boot.test.autoconfigure.web.servlet.MockMvcWebClientAutoConfiguration, org.springframework.boot.test.autoconfigure.web.servlet.MockMvcWebDriverAutoConfiguration, org.springframework.boot.autoconfigure.thymeleaf.ThymeleafAutoConfiguration, org.springframework.boot.autoconfigure.gson.GsonAutoConfiguration, org.springframework.boot.autoconfigure.jsonb.JsonbAutoConfiguration, org.springframework.boot.autoconfigure.freemarker.FreeMarkerAutoConfiguration, org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration, org.springframework.boot.autoconfigure.security.servlet.UserDetailsServiceAutoConfiguration, org.springframework.boot.autoconfigure.security.oauth2.resource.servlet.OAuth2ResourceServerAutoConfiguration, org.springframework.boot.autoconfigure.groovy.template.GroovyTemplateAutoConfiguration, org.springframework.boot.autoconfigure.mustache.MustacheAutoConfiguration]], org.springframework.boot.test.context.filter.ExcludeFilterContextCustomizer@62ea3440, org.springframework.boot.test.json.DuplicateJsonObjectContextCustomizerFactory$DuplicateJsonObjectContextCustomizer@66ce957f, org.springframework.boot.test.mock.mockito.MockitoContextCustomizer@c6429626, org.springframework.boot.test.web.reactor.netty.DisableReactorResourceFactoryGlobalResourcesContextCustomizerFactory$DisableReactorResourceFactoryGlobalResourcesContextCustomizerCustomizer@619bfe29, org.springframework.boot.test.context.SpringBootTestAnnotation@c5873897], resourceBasePath = "src/main/webapp", contextLoader = org.springframework.boot.test.context.SpringBootContextLoader, parent = null]
Caused by: org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'jpaAuditingHandler': Cannot resolve reference to bean 'jpaMappingContext' while setting constructor argument
Caused by: org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'jpaMappingContext': JPA metamodel must not be empty
Caused by: java.lang.IllegalArgumentException: JPA metamodel must not be empty
Error creating bean with name 'jpaAuditingHandler': Cannot resolve reference to bean 'jpaMappingContext' while setting constructor argument

JPA metamodel과 관련된 많은 에러들이 발생하게 됩니다.

발생하는 이유는 스프링을 띄우고 테스트하는 것이 아니기 때문에 JPA 엔티티 및 관련 빈들이 제대로 로드되지 않아서 입니다.

이를 해결할 수 있는 방안은 총 2가지가 있습니다.

1. @SpringBootTest 사용
2. @MockBean(JpaMetamodelMappingContext.class) 사용

1번의 경우 통합 테스트로 진행되어 모든 빈들을 주입 받을 수 있기 때문에 편리하다는 장점이 있습니다. 제가 원하는 테스트는 단위 테스트이기 때문에 1번 방식은 이용하지 않았습니다.

제가 해결한 방법은 2번을 사용해서 해결하였습니다.

@WebMvcTest(RestaurantController.class)
@MockBean(JpaMetamodelMappingContext.class)
class RestaurantControllerTest {

이렇게 하면 가장 빠르게 해결할 수 있지만 올바른 방법인지는 모르겠습니다.

---

시큐리티 설정 문제

시큐리티 설정이 되어 있기 때문에 401 에러가 발생합니다.

MockHttpServletResponse:
           Status = 401
    Error message = Unauthorized
          Headers = [Vary:"Origin", "Access-Control-Request-Method", "Access-Control-Request-Headers", WWW-Authenticate:"Basic realm="Realm"", X-Content-Type-Options:"nosniff", X-XSS-Protection:"0", Cache-Control:"no-cache, no-store, max-age=0, must-revalidate", Pragma:"no-cache", Expires:"0", X-Frame-Options:"DENY"]
     Content type = null
             Body = 
    Forwarded URL = null
   Redirected URL = null
          Cookies = []

이를 해결하기 위해서는 테스트 코드에서 시큐리티 비활성화가 필요합니다.

@WebMvcTest(RestaurantController.class)
@MockBean(JpaMetamodelMappingContext.class)
@AutoConfigureMockMvc(addFilters = false) // 테스트 시 Security 비활성화
class RestaurantControllerTest {

---

타임리프 문제

org.thymeleaf.exceptions.TemplateProcessingException: Exception evaluating SpringEL expression: "hourResponse.openTime" (template: "restaurant/restaurant" - line 50, col 27)
Caused by: org.springframework.expression.spel.SpelEvaluationException: EL1007E: Property or field 'openTime' cannot be found on null

@Getter
@AllArgsConstructor
@Builder
public class RestaurantHourResponse {

    private Long restaurantHourId;
    private String dayOfWeek;
    private LocalTime openTime;
    private LocalTime closeTime;
    private String openStatus;
}

class RestaurantControllerTest {

    @Autowired MockMvc mockMvc;

    @MockBean RestaurantService restaurantService;
    @MockBean RestaurantHourService restaurantHourService;
    @MockBean RestaurantRepository restaurantRepository;
    @MockBean RestaurantHourRepository restaurantHourRepository;

    @MockBean RestaurantValidator restaurantValidator;
    @MockBean ReviewService reviewService;

    @Test
    @DisplayName("식당 상세 조회 테스트")
    void view_restaurant_test() throws Exception {
        // given
        Long restaurantId = 1L;
        RestaurantResponse restaurant = getRestaurantResponse();
        List<RestaurantHourResponse> restaurantHours = getRestaurantHourResponseList();
        RestaurantHourResponse hourResponse = getRestaurantHourResponse();

        DayOfWeeks dayOfWeek = DayOfWeeks.MONDAY;

        when(restaurantService.findRestaurant(restaurantId)).thenReturn(restaurant);
        when(restaurantHourService.getAllRestaurantHours(restaurantId)).thenReturn(restaurantHours);
        when(restaurantHourService.getRestaurantHour(restaurantId, dayOfWeek)).thenReturn(hourResponse);

        log.info("response : {}", hourResponse);
        log.info("response : {}", hourResponse.getOpenTime());
        log.info("response : {}", hourResponse.getCloseTime());

        // when
        // then
        mockMvc.perform(get("/restaurants/{restaurantId}", restaurantId))
                .andDo(print())
                .andExpect(status().isOk())
                .andExpect(view().name("restaurant/restaurant"))
                .andExpect(model().attribute("restaurant", restaurant))
                .andExpect(model().attribute("restaurantHours", restaurantHours))
                .andExpect(model().attribute("hourResponse", hourResponse))
                .andExpect(model().attribute("dayOfWeek", dayOfWeek.getDescription()));
    }
    
}

    @GetMapping("/{restaurantId}")
    public String viewRestaurant(
            @PathVariable Long restaurantId,
            Model model
    ) {
        DayOfWeek currentDayOfWeek = LocalDate.now().getDayOfWeek();
        DayOfWeeks dayOfWeek = DayOfWeeks.from(currentDayOfWeek);

        RestaurantResponse restaurant = restaurantService.findRestaurant(restaurantId);
        List<RestaurantHourResponse> restaurantHours = restaurantHourService.getAllRestaurantHours(restaurantId);
        RestaurantHourResponse hourResponse = restaurantHourService.getRestaurantHour(restaurantId, dayOfWeek);

        log.info("hourResponse : {}", hourResponse);

        model.addAttribute("restaurant", restaurant);
        model.addAttribute("restaurantHours", restaurantHours);
        model.addAttribute("hourResponse", hourResponse);
        model.addAttribute("dayOfWeek", dayOfWeek.getDescription());
        return "restaurant/restaurant";
    }

hourResponse의 openTime이 null이 들어가는 문제가 계속해서 발생합니다.
log, debug를 통해서 알아본 결과, 실제 controller 부분의 hourResponse 객체 자체가 null로 나타납니다.
테스트 코드에서 hourResponse는 null이 아닌 객체 생성이 제대로 이루어져 있습니다.

Thymeleaf로 값을 제대로 변환해서 넘기지 못하는 문제인 줄 알고, 다른 코드를 고치는데 많은 시간을 소요하였습니다.

결론은 mocking이 제대로 이루어지지 않았던 것입니다.
그 이유는 컨트롤러에 있는 코드를 그대로 가져와서 테스트해야 하는데 그렇지 않았기 때문입니다.
컨트롤러에서 현재 요일을 가져오는 로직을 테스트 코드에 작성하지 않아 mocking이 제대로 이루어지지 않았던 것입니다.

DayOfWeeks dayOfWeeks = DayOfWeeks.MONDAY;
when(restaurantHourService.getRestaurantHour(restaurantId, dayOfWeek)).thenReturn(hourResponse);

[잘못된 방식]
이렇게 mocking을 하니까 제대로 값이 넘어가지 않았던 것입니다.

DayOfWeek currentDayOfWeek = LocalDate.now().getDayOfWeek();
DayOfWeeks dayOfWeek = DayOfWeeks.from(currentDayOfWeek);
when(restaurantHourService.getRestaurantHour(restaurantId, dayOfWeek)).thenReturn(hourResponse);

[올바른 방식]
위와 같이 mocking을 하면 null이 아닌 제대로 된 객체가 설정됩니다.

---

주의! 반드시 테스트 코드에 컨트롤러의 로직을 정확하게 반영해야 합니다!

컨트롤러에 작성한 처리 로직 그대로 테스트 코드에 작성해야 합니다!!!
테스트 코드와 실제 코드 간의 동작 차이를 최소화해야 합니다.

만약 테스트 코드에서 DayOfWeeks를 수동으로 설정한다면, 컨트롤러와 테스트 코드 간에 dayOfWeek 값이 일치하지 않아 모킹된 메서드가 올바르게 동작하지 않을 수 있습니다. → null이 들어갈 수 있음.