RestTemplateを使ったコントローラーのテストでI/O error on POST requestが発生する

Question

Spring Bootのコントローラー内でRestTemplateを使った外部HTTPアクセスを実装しています。
JUnitで正常系のテストを実行したのですが、RestClientExceptionが発生し、メソッドの最後まで到達ができません。
デバックしてみると、下記のようなエラーメッセージがでてきたのですが、解決方法がよくわかりません。
どのように対処すればよいのでしょうか。

I/O error on POST request for "外部URL": Connection refused: connect

@RunWith(SpringRunner.class)
@SpringBootTest
public class SampleControllerTest {
	private MockMvc mockMvc;
	
	@InjectMocks
	private SampleController controller;

	@Before
	public void setUp() throws Exception {
		MockitoAnnotations.initMocks(this);
		mockMvc = MockMvcBuilders.standaloneSetup(controller).build();
	}

	@Test
	public void sample() throws Exception {
		Map<String, String> map =  new LinkedHashMap<String, String>();
		
		MockRestServiceServer mockServer = MockRestServiceServer.createServer(new RestTemplate());
		mockServer
        .expect(requestTo("外部URL"))
        .andExpect(method(HttpMethod.POST))
        .andRespond(withSuccess(map.toString(), MediaType.APPLICATION_JSON_UTF8));
	
		mockMvc.perform(post("/"))
		.andExpect(status().isOk())
		.andExpect(view().name("index"));
	}

}

@Controller
public class SampleController {
	@RequestMapping(value = "/", method = RequestMethod.POST)
	public ModelAndView index() {
		ModelAndView modelAndView = new ModelAndView();

		MultiValueMap<String, String> formParams = new LinkedMultiValueMap<>();
		formParams.add("data", "data");

		HttpHeaders httpHeaders = new HttpHeaders();
		httpHeaders.add(HttpHeaders.AUTHORIZATION, "Basic XXXXXXXXXX");
		httpHeaders.add(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_FORM_URLENCODED_VALUE);
		RequestEntity<MultiValueMap<String, String>> requestEntity = new RequestEntity<>(formParams, httpHeaders,
		HttpMethod.POST, URI.create("外部URL"));

		RestTemplate restTemplate = new RestTemplate();

		ResponseEntity<Map<String, String>> responseEntity = null;
		try {
			responseEntity = restTemplate.exchange(requestEntity, new ParameterizedTypeReference<Map<String, String>>() {});
		} catch (RestClientException e) {
			modelAndView.setViewName("error");
			return modelAndView;
		}
		
		modelAndView.setViewName("index");
		return modelAndView;
	}
}

Comments

[退会済みユーザー]

モックサーバーに向けてるからでは？
外部サーバーのテストは不要かと

[退会済みユーザー]

テストクラスでパラメータを設定した内容がresponseEntityで取得できることを想定したのですが、
モックサーバーを使わずに、対象のサーバーを立ち上げてのテストのほうがよろしいのでしょうか。

Answer 1

SampleController内で、RestTemplateのインスタンスを new から作り出しているのでSpring管理にならず、そのためテスト実行時にMockServerを指定してもSampleControllerはMockServerを使いません。

例えば、

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestOperations;

import lombok.Data;
import lombok.RequiredArgsConstructor;

@RestController
@RequestMapping("/outbound")
@RequiredArgsConstructor
public class OutBoundSampleController {

	private final RestOperations restOperations;

	@GetMapping("")
	public SampleModel findOne() {
		return restOperations.getForObject("https://api.domain/sample/{id}", SampleModel.class, 123);
	}

	@Data
	public static class SampleModel {
		private String name;
	}
}

このControllerに対し、Mockitoを使ったControllerのテストを書くならば、

import static org.hamcrest.MatcherAssert.*;
import static org.hamcrest.Matchers.*;
import static org.springframework.test.web.client.match.MockRestRequestMatchers.*;
import static org.springframework.test.web.client.response.MockRestResponseCreators.*;

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.MockitoAnnotations;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.HttpMethod;
import org.springframework.http.MediaType;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.client.MockRestServiceServer;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.web.client.RestTemplate;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.github.apz.springsample.controller.OutBoundSampleController;
import com.github.apz.springsample.controller.OutBoundSampleController.SampleModel;

@RunWith(SpringRunner.class)
@SpringBootTest
public class OutBoundSampleControllerTest {

	@Autowired
	private RestTemplate restTemplate;


	private MockMvc mockMvc;

	@Autowired
	private OutBoundSampleController controller;

	@Before
    public void setUp() throws Exception {
        MockitoAnnotations.initMocks(this);
        mockMvc = MockMvcBuilders.standaloneSetup(controller).build();
    }

	@Test
	public void モックサーバテスト() {

		SampleModel testResult = new  SampleModel();
		ObjectMapper mapper = new ObjectMapper();
		String result = null;
		try {
			result = mapper.writeValueAsString(testResult);
		} catch (JsonProcessingException e) {
			e.printStackTrace();
		}

		MockRestServiceServer mockServer = MockRestServiceServer.createServer(restTemplate);
		mockServer.expect(requestTo("https://api.domain/sample/123"))
		.andExpect(method(HttpMethod.GET))
		.andRespond(withSuccess(result, MediaType.APPLICATION_JSON));

		SampleModel response = controller.findOne();

		assertThat(response, is(testResult));

		mockServer.verify();

	}
}

実際にController内部からリクエストされるであろうURLの情報を設定するところと、MockServerの設定方法の考え方はあっていますので、RestTemplateの扱い方ですね。

Comments

[退会済みユーザー]

ご回答ありがとうございました。