OpenFeign에 INFO 레벨 로그 추가하기 (1/2): WireMock을 활용한 외부 서버 모킹

** 이번 글에서는 테스트에서 WireMock을 활용하여 외부 서버를 모킹하는 과정을 설명하며, 다음 글에서는 INFO 레벨 로그 설정 방법을 다룰 예정입니다. ** 

Clova AI의 반복적인 응답 오류 문제

고민 상담 플랫폼 프로젝트를 진행하며 네이버 Clova AI에 요청을 보내는 작업을 수행했습니다. 하지만 Clova AI로부터 오는 응답이 비즈니스 요구사항에 맞지 않아 빈번하게 오류를 발생시켰습니다. 이에 따라, Clova AI 가 어떤 응답을 주고, 어떤 오류를 유발하는지 정확히 확인할 필요가 있었습니다.

이 과정에서 OpenFeign의 로깅 기능을 활용하려 했지만, 기존 방식으로는 몇 가지 불편함이 있었습니다.

 

logger-level : FULL 을 사용하지 않는 이유

1. 실제 운영 서버에서 Feign 관련 로그를 확인하려면 docker logs를 사용해 로그를 수동으로 검색해야 했습니다.

2. OpenFeign 로그 출력을 위해 서버의 로그 레벨을 DEBUG로 설정해야 했습니다.

3. 서버에서 logback-spring.xml을 사용해 INFO 레벨과 ERROR 레벨 로그만 별도 폴더로 관리하고 있어, DEBUG 로그를 활성화하는 것이 부적합했습니다.

 

INFO 레벨 로그 출력을 위한 Feign 커스터마이징 계획

이러한 문제를 해결하기 위해 OpenFeign 로그를 INFO 레벨에서도 출력할 수 있도록 커스터마이징을 계획했습니다. 그러나, 실제 Clova AI 서버에 요청을 보내며 작업할 경우 비용이 발생하는 문제가 있었습니다. 이를 방지하기 위해 테스트 환경에서 Clova AI 서버를 모킹하고, @FeignClient를 호출하는 방식으로 진행하기로 결정했습니다.

 

1. WireMock을 활용해 Clova AI 서버를 모킹

2. INFO 레벨 로그 설정 후, WireMock을 호출하여 @FeignClient 호출 시 로그가 INFO 레벨에서도 출력되는지 확인

 

WireMock vs MockRestServiceServer

OpenFeign을 사용하여 외부 서버를 모킹(Mock)하려면 자주 등장하는 도구 중 하나가 WireMock입니다.

한편, 개인 프로젝트에서는 RestTemplate을 사용하여 외부 서버를 호출한 경험이 있었고, 이를 테스트할 때 MockRestServiceServer를 사용했습니다. 이 경험에서 출발해 WireMock과 MockRestServiceServer의 차이를 알아보고자 합니다.

 

- MockRestServiceServer

MockRestServiceServer의 Javadoc에 따르면, 이 도구는 RestTemplate을 통해 수행될 예상 요청과 응답을 설정하며, 실제 서버 없이도 테스트를 가능하게 합니다. 즉, HTTP 서버를 실행하지 않고도 RestTemplate 요청을 모의(Mock)로 설정하고, 이에 대한 응답을 정의할 수 있는 도구입니다.

MockRestServiceServer 의 Javadoc 일부

 

- WireMock

반면, WireMock은 실제 웹 서비스와 연결하는 것처럼 동작하는 HTTP 서버를 구성합니다. WireMock은 테스트 시 별도의 포트를 지정해 서버를 실행할 수 있으며, 포트를 지정하지 않으면 기본값인 8080 포트를 사용합니다. (만약, 지정하지 않는다면 8080포트를 사용하니, 부트의 기본 포트와 충돌나지 않도록 바꾸는 것이 좋아보입니다.) 그래서, WireMock 을 사용한다면 실제 네트워크 요청과 유사한 동작을 테스트할 때 장점이 있을 것 같습니다.

 

- 정리

MockRestServiceServer

• RestTemplate을 사용하는 경우 적합.
• 실제 HTTP 서버 없이 요청과 응답을 모의하여 단위 테스트를 수행.

 WireMock

• OpenFeign 및 실제 HTTP 서버와의 상호작용을 테스트하는 경우 적합.
• HTTP 서버를 실행하여 실제 네트워크 요청과 유사한 통합 테스트를 수행.

 

본론 : 테스트에서 Clova AI(외부) 서버 모킹 과정

본론으로 돌아와, WireMock 을 테스트에 사용할 수 있도록 @OpenFeign 과 Test Code 를 작성하겠습니다.

 

- 의존성 추가

Spring 에서 제공하는 openfeign 과 wiremock 을 사용하겠습니다.

WireMock의 버전 관리는 Spring Boot의 dependency-management에게 맡기도록 하겠습니다.

testImplementation 'org.springframework.cloud:spring-cloud-contract-wiremock'

 

- OpenFeign 클라이언트 준비

@FeignClient를 설정하여 외부 서버 요청을 처리합니다. URL은 외부 설정 파일(.yml)에서 읽어오도록 구성합니다.
테스트 환경에서는 실제 Clova AI 서버로 요청을 보내지 않도록, 테스트 시점에 URL을 주입할 수 있게 설정했습니다.

@FeignClient(name = "clova-service", url = "${feign.clova.url}")
public interface ClovaFeignClient {

    @PostMapping(consumes = MediaType.APPLICATION_JSON_VALUE, 
                 produces = MediaType.APPLICATION_JSON_VALUE)
    ClovaResponseDto sendToClova(
            @RequestHeader("X-NCP-CLOVASTUDIO-API-KEY") String apiKey,
            @RequestHeader("X-NCP-APIGW-API-KEY") String apigwKey,
            @RequestHeader("X-NCP-CLOVASTUDIO-REQUEST-ID") String requestId,
            @RequestBody ClovaRequestDto clovaRequestDto
    );
}

 

- 테스트 코드 작성

@ActiveProfiles("test")
@SpringBootTest   // 톰캣과 같은 HTTP 서버를 띄울 필요가 없다고 판단해서, Mock 속성을 사용했습니다.
@TestPropertySource(properties = "feign.clova.url=http://localhost:${wiremock.server.port}")
@AutoConfigureWireMock(port = 0)
class ClovaFeignClientTest {

    @Autowired
    private ClovaService clovaService;

    @DisplayName("WireMock을 사용하여 @FeignClient 호출 시 logger-Level : full을 확인합니다.")
    @Test
    void test() {
        // given, #import static com.github.tomakehurst.wiremock.client.WireMock.*;
        stubFor(post("/")
                .willReturn(aResponse()
                        .withStatus(200)));

        // when
        ClovaResponseDto result = clovaService.send("message");

        // then
        assertThat(result).isNull();
    }
}

 

@ActiveProfiles("test")

• 테스트 환경에 맞는 test.yml 설정 파일을 사용합니다.

@TestPropertySource

• @FeignClient의 URL 환경 변수를 http://localhost:${wiremock.server.port}로 주입하기 위한 설정입니다. 여기서 ${wiremock.server.port}는 별도로 .yml 에 작성하지 않아도, WireMock이 실행될 때 모킹된 서버의 포트가 자동으로 "wiremock.server.port" 속성에 바인딩됩니다. 이를 통해 테스트 애플리케이션 컨텍스트에서 해당 속성을 사용할 수 있습니다.

@AutoConfigureWireMock(port=0)

• WireMock 서버를 랜덤 포트에서 실행합니다.
• Spring Application Context의 일부로 WireMock 서버를 시작하려는 테스트 클래스에 대한 어노테이션입니다.

AutoConfigureWireMock 의 Javadoc

 

해당 어노테이션들을 왜 사용했는지는 Spring Cloud Contract WireMock Docs를 참고해주세요.

 

해당 테스트를 실행하였고, OpenFeign의 logger-level: FULL 설정으로 인해 DEBUG 레벨의 자세한 로그가 출력됨을 확인할 수 있었습니다.

* feign log 를 debug 로 출력하는 방법 -> feign logging Docs

2024-12-21 DEBUG 16948 --- [ClovaFeignClient#sendToClova] ---> POST http://localhost:12410 HTTP/1.1
2024-12-21 DEBUG 16948 --- [ClovaFeignClient#sendToClova] Accept: application/json
2024-12-21 DEBUG 16948 --- [ClovaFeignClient#sendToClova] Content-Length: 5571
2024-12-21 DEBUG 16948 --- [ClovaFeignClient#sendToClova] Content-Type: application/json
2024-12-21 DEBUG 16948 --- [ClovaFeignClient#sendToClova] 
2024-12-21 DEBUG 16948 --- [ClovaFeignClient#sendToClova] 5571에 해당하는 body
2024-12-21 DEBUG 16948 --- [ClovaFeignClient#sendToClova] ---> END HTTP (5571-byte body)

...(중략)

2024-12-21 DEBUG 16948 --- [ClovaFeignClient#sendToClova] <--- HTTP/1.1 200 OK (196ms)
2024-12-21 DEBUG 16948 --- [ClovaFeignClient#sendToClova] matched-stub-id: f1b4d2e2-83eb-4138-9554-4fa7934d42d8
2024-12-21 DEBUG 16948 --- [ClovaFeignClient#sendToClova] transfer-encoding: chunked
2024-12-21 DEBUG 16948 --- [ClovaFeignClient#sendToClova] vary: Accept-Encoding, User-Agent
2024-12-21 DEBUG 16948 --- [ClovaFeignClient#sendToClova] 
2024-12-21 DEBUG 16948 --- [ClovaFeignClient#sendToClova] <--- END HTTP (0-byte body)

 

정리

이번 글에서는 테스트 환경에서 WireMock을 사용하여 Clova AI(외부) 서버를 모킹하는 방법을 다뤘습니다. 이를 통해 Feign 클라이언트를 안전하게 테스트하고, logger-level: FULL 설정으로 DEBUG 로그를 확인할 수 있었습니다.

다음 글에서는 INFO 레벨에서도 Feign 로그를 출력하도록 커스터마이징하는 방법을 소개하겠습니다.

 

출처

- Spring Cloud Contract WireMock Docs

- Baeldung 의 Introduction WireMock

- 우아한기술블로그 : 야, 너두 WireMock 으로 테스트할 수 있어

- https://devnm.tistory.com/34 

 

추가로, WireMock을 활용하며 테스트를 작성하는 과정에서 다양한 테스트 어노테이션을 접하게 되었고, 이를 정리하여 공유하고자 합니다.

---

@TestInstance

@TestInstance는 JUnit 5에서 테스트 클래스의 인스턴스 라이프사이클을 설정하기 위해 사용됩니다.
다음 두 가지 옵션이 있습니다.

 

PER_METHOD (DEFAULT)

• 테스트 메서드마다 새로운 클래스 인스턴스를 생성
• 각 테스트는 독립적으로 실행
• 단위 테스트에 적합

PER_CLASS

• 테스트 클래스당 하나의 인스턴스만 생성
• 테스트 메서드가 클래스의 상태를 공유해야 할 때.
• 테스트가 순차적으로 실행되며 상태를 업데이트
• @BeforeAll과 @AfterAll을 사용할 때 static을 붙이지 않아도 됩니다.

참고 : @TestInstance Annotation in JUnit 5

 

@SpringBootTest

WebEnvironment.MOCK (DEFAULT)

• 모의(Mock) 서블릿 환경에서 애플리케이션 컨텍스트를 로드합니다.
• 실제 HTTP 서버를 실행하지 않고, 요청과 응답은 MockMvc와 같은 도구로 처리됩니다.
• 컨트롤러 단위 테스트 또는 특정 웹 계층 동작만 테스트할 때 적합.

WebEnvironment.RANDOM_PORT

• 실제 HTTP 서버를 실행하지만, 충돌을 방지하기 위해 랜덤 포트에서 구동합니다.
• Spring Boot의 내장 서버(Tomcat, Jetty 등)를 사용하여 애플리케이션을 실행합니다.
• TestRestTemplate와 같은 도구를 사용해 HTTP 요청 및 응답을 테스트.
• Mock보다 실행 시간이 길 수 있음.

WebEnvironment.DEFINED_PORT

• 실제 HTTP 서버를 실행하며, application.properties 또는 application.yml에 정의된 고정 포트에서 애플리케이션을 실행합니다.
• 외부 클라이언트나 서비스가 특정 포트로 테스트 서버와 상호작용해야 할 때.
• 테스트 환경에서 포트 충돌 가능성 존재.

WebEnvironment.NONE

• 웹 환경을 비활성화하고, 순수한 ApplicationContext만 로드합니다.
• 내장 HTTP 서버를 실행하지 않으며, 웹 관련 빈(@Controller, @RestController 등)은 생성되지 않습니다.
• Spring의 웹 계층 빈은 테스트 컨텍스트에 포함되지 않음.

참고 : Difference between webEnvironment = RANDOM_PORT and webEnvironment = MOCK