모의서버(Mock server)를 이용하여 서버 to 서버에서 통신하기

[myrhymetree]

contoroller에서 server to server test

controller에서 외부서버와 통신하는지 여부만 테스트 코드로 작성하고 싶다면 아래와 같은 방법들이 있는데요.

1. 모의 서버 (Mock Server) 사용:

   • 테스트 중에 외부 서버의 동작을 모방하는 모의 서버를 사용할 수 있습니다. 이러한 모의 서버를 사용하면 실제 외부 서버에 의존하지 않고 테스트를 수행할 수 있습니다.
   • 예를 들어 WireMock, MockServer 등의 모의 서버를 사용할 수 있습니다. 이러한 모의 서버를 구성하여 테스트 중에 원하는 응답을 제공하도록 설정할 수 있습니다.

2. 외부 서버의 테스트 환경 사용:

   • 테스트 환경에서는 실제 외부 서버의 테스트 버전 또는 개발 버전을 사용하여 통신할 수 있습니다. 이를 통해 실제 서버와 비슷한 환경에서 테스트를 수행할 수 있습니다.
   • 테스트 환경에서는 보안 및 데이터 무결성 등을 고려해야 하므로 주의가 필요합니다.

3. 테스트 더블 (Test Double) 사용:

   • 실제 외부 서버 대신 테스트 더블 (예: 스파이, 대역)을 사용하여 외부 서버와의 통신을 대신할 수 있습니다.
   • 테스트 더블은 테스트 중에 외부 서버의 동작을 대체하고, 테스트 시나리오를 제어할 수 있도록 도와줍니다.

4. 인터페이스 추상화 및 의존성 주입:

   • 외부 서버와의 통신을 위한 클라이언트를 인터페이스로 추상화하고, 컨트롤러에 의존성 주입을 통해 실제 구현체를 제어할 수 있습니다.
   • 테스트 시에는 모의 구현체를 주입하여 컨트롤러의 테스트를 수행할 수 있습니다.

아래는 Spring Framework를 사용하는 경우의 예시 코드입니다:

@RestController
public class MyController {
    private final ExternalServiceClient externalServiceClient;

    @Autowired
    public MyController(ExternalServiceClient externalServiceClient) {
        this.externalServiceClient = externalServiceClient;
    }

    @GetMapping("/data")
    public ResponseEntity<String> getDataFromExternalServer() {
        // 외부 서버와 통신하는 코드
        String response = externalServiceClient.fetchData();
        return ResponseEntity.ok(response);
    }
}

@Component
public class ExternalServiceClient {
    public String fetchData() {
        // 실제 외부 서버와 통신하는 코드
        // ...
        return "Response from external server";
    }
}

이러한 방식으로 테스트 가능한 코드를 작성하고, 테스트 시에는 Mock 또는 가짜 구현체를 주입하여 외부 서버와의 통신을 대체할 수 있습니다. 이렇게 하면 통합 테스트나 단위 테스트를 수행할 때 외부 서버와의 의존성을 줄일 수 있습니다.

모의서버 구현 방법

크게 네가지 방법이 있고, 그 중 모의 서버를 이용하여 테스트하는 방법에 대해서 설명하려고 합니다.
MockServer를 구현하는 것은 테스트 중에 외부 서버의 동작을 모방하고 응답을 제어하는 중요한 작업입니다. Spring Boot를 사용하고 있다면 WireMock 또는 MockServer와 같은 라이브러리를 사용하여 MockServer를 구현할 수 있습니다. 아래는 WireMock를 사용한 MockServer를 구현하는 간단한 예제입니다.

1. 의존성 추가:
   WireMock 라이브러리를 Gradle 프로젝트에 추가합니다.

   Gradle:

   testImplementation 'com.github.tomakehurst:wiremock-jre8:2.33.0' // 최신 버전으로 업데이트 가능

2. WireMock 설정:
   테스트 클래스에서 WireMock 서버를 설정하고, 원하는 동작 및 응답을 정의합니다.

   import com.github.tomakehurst.wiremock.WireMockServer;
   import com.github.tomakehurst.wiremock.client.WireMock;
   
   @RunWith(SpringRunner.class)
   @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
   public class MyControllerIntegrationTest {
   
       @Autowired
       private MyController myController;
   
       private WireMockServer wireMockServer;
   
       @Value("${server.port}")
       private int serverPort;
   
       @Before
       public void setUp() {
           // WireMock 서버 초기화 및 설정
           wireMockServer = new WireMockServer(WireMockConfiguration.options().port(8080));
           wireMockServer.start();
           WireMock.configureFor("localhost", wireMockServer.port());
       }
   
       @After
       public void tearDown() {
           // WireMock 서버 종료
           wireMockServer.stop();
       }
   
       @Test
       public void testGetDataFromMockServer() {
           // WireMock을 사용하여 원하는 동작 및 응답 설정
           WireMock.stubFor(WireMock.get(WireMock.urlEqualTo("/data"))
                   .willReturn(WireMock.aResponse()
                           .withStatus(200)
                           .withBody("Mocked response from WireMock")));
   
           ResponseEntity<String> response = myController.getDataFromExternalServer();
   
           // 테스트 검증 로직 추가
           Assert.assertEquals(HttpStatus.OK, response.getStatusCode());
           Assert.assertEquals("Mocked response from WireMock", response.getBody());
       }
   }

3. 테스트 수행:
   테스트 클래스를 실행하여 MockServer와 컨트롤러의 상호 작용을 테스트합니다. WireMock을 사용하면 외부 서버의 응답을 제어하고 테스트 시나리오를 테스트할 수 있습니다.

WireMock를 사용한 MockServer 구현은 테스트 중에 외부 서버와의 의존성을 제어하고 테스트 케이스를 작성하는 데 유용합니다. 이를 통해 테스트 중에 외부 서버에 대한 응답을 원하는 대로 제어하고, 다양한 시나리오를 시뮬레이션할 수 있습니다.

모의서버 테스트

    @Test
    @DisplayName("문제 응답")
    void testReadQuestion() {
        WireMock.stubFor(WireMock.get(WireMock.urlEqualTo("/data"))
                .willReturn(WireMock.aResponse()
                        .withStatus(200)
                        .withBody("{\"main\":\"As a system for transmitting specific factual information without any distortion or ambiguity, the sign system of honey-bees would probably win easily over human language every time. However, language offers something more valuable than mere information exchange. Because the meanings of words are not invariable and because understanding always involves interpretation, the act of communicating is always a joint, creative effort. Words can carry meanings beyond those consciously intended by speakers or writers because listeners or readers bring their own perspectives to the language they encounter. Ideas expressed imprecisely may be more intellectually stimulating for listeners or readers than simple facts. The fact that language is not always reliable for causing precise meanings to be generated in someone else’s mind is a reflection of its powerful strength as a medium for creating new understanding. It is the inherent ambiguity and adaptability of language as a meaning-making system that makes the relationship between language and thinking so special.\"," +
                                  "\"answer\":\"4\"," +
                                  "\"subject\":\"다음 빈칸에 들어갈 말로 가장 적절한 것을 고르시오.\"," +
                                  "\"class\":\"blank\"," +
                                  "\"view1\":\"be selected for general purposes\"," +
                                  "\"view2\":\"meet the requirements of your inquiry\"," +
                                  "\"view3\":\"be as high as possible for any occasion\"," +
                                  "\"view4\":\"be applied to new technology by experts\"," +
                                  "\"view5\":\"rely exclusively upon satellite information\"" +
                                  "}")
                        .withHeader("Content-Type", MediaType.APPLICATION_JSON_VALUE))
        );

        String mockServerUrl = "http://localhost:" + wireMockServer.port() + "/data";
        ResponseEntity<String> responseEntity = restTemplate.getForEntity(mockServerUrl, String.class);

        String classification;
        try {
            JSONParser jsonParser = new JSONParser();
            JSONObject jsonObject = (JSONObject) jsonParser.parse(responseEntity.getBody().toString());
            classification = (String) jsonObject.get("class");
        } catch (ParseException e) {
            throw new RuntimeException(e);
        }

        // 응답을 확인합니다.
        assertEquals(200, responseEntity.getStatusCodeValue());
        assertEquals("blank", classification);
    }

테스트에서 성공적으로 응답을 해줬을때, 문제가 다음과 같은 json 포맷으로 올것으로 가정하고 문자열을 json으로 변환하였고, 응답상태와 json의 일부 속성이 예상하는 값과 일치하는지를 검증하였습니다.

Postman으로 Mock서버 구축하여 통신 테스트

테스트코드에서는 정상적으로 응답하는것을 확인했지만, 실제 비즈니스로직에서도 요청/응답이 원할히 이루어지는지 확인하고 싶었습니다.
그래서 다음과 같이 Postman으로 Mock서버를 구축하였는데요.
모의서버는 요청 1000회 이하만 무료버전에서 지원하기 때문에 주의가 필요합니다.

Mock서버 구현은 간단합니다.

다음과 같이 request의 example에 응답 Body에 예상되는 응답값을 json 형식으로 작성하고 저장합니다.

그런 다음 Mock Servers의 환경을 설정할 때 MockServer구현에 사용한 요청이 담긴 컬렉션을 지정하면 됩니다.
지정하면 Mock Server의 url을 카피해서 다음과 같이 요청을 보내면 정상적으로 값을 응답 받는 것을 확인할 수 있습니다.

외부 서버에 요청해야하는 작업이 있는 경우, 먼저 테스트를 해보고 싶다면 이와 같은 방법을 사용하면 좋을 것 같습니다.

참고
https://antdevhistory.tistory.com/3

[bbbbooo]

확인했습니다!!!!!!