[SETTING] Spring Security & Cloud Open Feign Client

[yummygyudon]

About Issue 🚀

전역적인 어플리케이션 인증/인가 Filter를 구축하고 기본적인 서버간 통신에 사용할 client를 구현합니다.

Progress ✔️

• [ ] support module
  • [ ] implement Authentication Fileter
  • [ ] implement Exception Filter
  • [ ] extend UsernamePasswordAuthenticationToken
• [ ] infra module
  • [ ] external client
  • [ ] OpenFeign Config for Playground API Client
  • [ ] OpenFeign Client for Playground API
  • [ ] jwt
  • [ ] jwt provider interface : 단순 메서드 명만 정의한 후, Security Filter 구축에 활용합니다.

[yummygyudon]

[시도했지만 실패한 것]

OpenFeign - Test

• RestTemplate은 객체로서 사용이 가능하지만 OpenFeign은 Interface 이기에 Autowired나 Lombok을 통한 의존성 주입이 불가능함
  • 다만 해결책은 있어보여서 우선 구현을 완료한 후, 차후에 적용할 수 있도록 할 예정
• 멀티모듈 환경에서 제한된 의존성 라이브러리와 분리된 설정 파일을 사용한다는 점에서 설정이 매우 어려웠음. (ex. springboot web이 없는 환경에서의 SpringBoot Test + Fake API 활용 하는 부분, 각 모듈마다 관리하는 yaml&properties 파일이 분리되어 있다보니 @Value를 통한 값 주입이 원활하지 않은 부분 -> not resolve 에러 발생)
  • 기존에 사용하는 방식인 Class를 선언하고 생성자를 통해 Feign Interface를 주입 받은 후, 해당 Class를 AutoWired해도 작동하지 않는다.

Trade-Off

• 물론 안정성 측면에서 완벽한 Test를 거치는 것이 좋지만 오로지 Test로 인해 기능 구현이 연기되는 것이 더 바람직하지 않다고 생각됨
• 테스트 고도화는 추후 리팩토링 시점에 진행하고자 함.

Ref.

• SpringDocs::Spring-Cloud-Feign
• SpringDocs::Spring-Cloud-Contract-WireMock
• OpenSource_WIRE-MOCK::API Mocking with Java and JUnit4
• OpenSource_WIRE-MOCK::JUnit5+Jupiter
• Blog::WIRE-MOCK+Fake-API
• Blog::WIRE-MOCK-활용
• Blog::WIRE-MOCK-활용-Kotlin.ver
• 망나니개발자::Blog
• 망나니개발자::Reference-GitHub
• 우아한기술블로그

[yummygyudon]

시도하고자 했던 방식은 바로 아래오 같은 코드이나 해당 코드는 Spring 에서의 @Retryable과 @Recover 를 통한 구현에 적합한 방식으로 보여진다. 이유는 실제 타 서버로부터의 결과에 따른 동적 처리에 대해서 테스트하는 것이 아닌 단순 행위만 지정해주는 것이기에 의미가 없는 테스트가 될 수 밖에 없다.

...
BDDMockito
        .willThrow(new RuntimeException("", new Exception()))
        .willThrow(new RuntimeException("", new Exception()))
        .willReturn(expected)
        .given(playgroundClient).getHealthStatus();

// when
Assertions.assertThatThrownBy(() -> playgroundClient.getHealthStatus())
                    .isInstanceOf(RetryableException.class);

// then 
Mockito.verify(playgroundClient, Mockito.times(3)).getHealthStatus();

추후 아래와 같은 방식으로 검증할 필요가 있습니다.

 // 이와 같은 RetryableException을 활용하기 위해선 실제 MockServer에서의 테스트가 필요할 것으로 예상됩니다.
/*
WireMock(Open Feign) / MockRestServiceServer(RestTemplate) 을 활용한 테스트
*/

// when - RetryableException을 잡기위해선 `thenThrow()`Mocking이 아닌 실제 Feign 호출을 통해서 Retry을 유도해야합니다.
Assertions.assertThatThrownBy(() -> playgroundClient.getHealthStatus())
                    .isInstanceOf(RetryableException.class);

// then 
Mockito.verify(playgroundClient, Mockito.times(3)).getHealthStatus();