[Spring] MockMvc를 이용하여 controller 테스트하기

ResultActions result = mockMvc.perform(
                post("/search")
                 .contentType(MediaType.APPLICATION_FORM_URLENCODED) // @ModelAttribute 매핑 검증을 위한 content type 지정
                 .content("address=서울 성북구 종암동"))

/**
 * Main entry point for server-side Spring MVC test support.
 *
 * import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
 * import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;
 * import static org.springframework.test.web.servlet.setup.MockMvcBuilders.*;
 *
 * // ...
 *
 * WebApplicationContext wac = ...;
 *
 * MockMvc mockMvc = webAppContextSetup(wac).build();
 *
 * mockMvc.perform(get("/form"))
 *     .andExpect(status().isOk())
 *     .andExpect(content().mimeType("text/html"))
 *     .andExpect(forwardedUrl("/WEB-INF/layouts/main.jsp"));
 *
 * @since 3.2
 */
public final class MockMvc {
    //...
}

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;
import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.*;  

@Controller
@RequiredArgsConstructor
public class FormController {
    private final PharmacyRecommendationService pharmacyRecommendationService;

    @GetMapping("/")
    public String main() {
        return "main";
    }

    @PostMapping("/search")
    public ModelAndView postDirection(@ModelAttribute InputDto inputDto)  {

        ModelAndView modelAndView = new ModelAndView();
        modelAndView.setViewName("output");
        modelAndView.addObject("outputFormList",
                pharmacyRecommendationService.recommendPharmacyList(inputDto.getAddress()));

        return modelAndView;
    }
}

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;
import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.*;

class FormControllerTest extends Specification {

    private MockMvc mockMvc
    private PharmacyRecommendationService pharmacyRecommendationService = Mock()

    def setup() {
        // FormController를 MockMvc 객체로 만든다.
        mockMvc = MockMvcBuilders.standaloneSetup(new FormController(pharmacyRecommendationService)).build();
    }
    def "GET /"() {

        expect:
        // FormController 의 "/" URI를 get방식으로 호출
        mockMvc.perform(get("/"))
                .andExpect(handler().handlerType(FormController.class))
                .andExpect(handler().methodName("main"))
                .andExpect(status().isOk()) // 예상 값을 검증한다.
                .andExpect(view().name("main")) // 호출한 view의 이름이 main인지 검증(확장자는 생략)   
                .andDo(log())
    }
}

this.mockMvc.perform(get("/")) // basic
this.mockMvc.perform(post("/")) // send post
this.mockMvc.perform(get("/?foo={var}", "1")) // query string
this.mockMvc.perform(get("/").param("bar", "2")) // using param
this.mockMvc.perform(get("/").accept(MediaType.ALL)) // select media type

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*
import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.*

class FormControllerTest extends Specification {

    private MockMvc mockMvc
    private PharmacyRecommendationService pharmacyRecommendationService = Mock()
    private List<OutputDto> outputDtoList

    def setup() {
        // FormController를 MockMvc 객체로 만든다.
        mockMvc = MockMvcBuilders.standaloneSetup(new FormController(pharmacyRecommendationService))
                .build()

        outputDtoList = Lists.newArrayList(
                OutputDto.builder()
                        .pharmacyName("pharmacy1")
                        .build(),
                OutputDto.builder()
                        .pharmacyName("pharmacy2")
                        .build()
        )
    }
    def "POST /search"() {
        given:
        String address = "서울 성북구 종암동"

        when:
        ResultActions result = mockMvc.perform(post("/search")
                        .contentType(MediaType.APPLICATION_FORM_URLENCODED) // @ModelAttribute 매핑 검증을 위한 content type 지정
                        .content("address="+address))   // ex) "address=서울 성북구&name=은혜약국" 형태의 쿼리 스트링    

        then:
        1 * pharmacyRecommendationService.recommendPharmacyList(argument -> {
            assert argument == address // mock 객체의 argument 검증    
        }) >> outputDtoList

        def result = resultActions
                .andExpect(MockMvcResultMatchers.status().isOk())
                .andExpect(MockMvcResultMatchers.view().name("output"))
                .andExpect(MockMvcResultMatchers.model().attributeExists("outputFormList")) // model에 outputFormList라는 key가 존재하는지 확인
                .andExpect(MockMvcResultMatchers.model().attribute("outputFormList", outputDtoList))
                .andDo(MockMvcResultHandlers.print())
                .andReturn()

        def outputFormList = (List<OutputDto>) result.getModelAndView().getModel().get("outputFormList") // model 값을 직접 검증   
        outputFormList.size() == 2 
    }
}

when:
def resultActions = mockMvc.perform(post("/search")
       .param("address", inputAddress))

// param 에 대한 주석 

/**
 * Add a request parameter to {@link MockHttpServletRequest#getParameterMap()}.
* <p>In the Servlet API, a request parameter may be parsed from the query
 * string and/or from the body of an {@code application/x-www-form-urlencoded}
 * request. This method simply adds to the request parameter map. You may
 * also use add Servlet request parameters by specifying the query or form
 * data through one of the following:
 * <ul>
 * <li>Supply a URL with a query to {@link MockMvcRequestBuilders}.
 * <li>Add query params via {@link #queryParam} or {@link #queryParams}.
 * <li>Provide {@link #content} with {@link #contentType}
 * {@code application/x-www-form-urlencoded}.
 * </ul>
 * @param name the parameter name
 * @param values one or more values
 */
public MockHttpServletRequestBuilder param(String name, String... values) {
	addToMultiValueMap(this.parameters, name, values);
	return this;
}

@GetMapping("/dir/{encodedId}")
public String searchDirection(@PathVariable("encodedId") String encodedId) {

    Direction resultDirection = directionService.findById(encodedId);

    String result = buildRedirectUrl(resultDirection);

    return "redirect:"+result;
}

mockMvc.perform(get("/dir/{encodedId}", "r"))
        .andExpect(redirectedUrl("https://map.kakao.com/link/map/address,38.11,128.11"));
        .andExpect(status().is3xxRedirection());