Improve FeignClient AOP Unit Test
0. 들어가면서
Annotation based AOP(Aspect Oriented Programming) 포스트를 작성할 당시에는 적절한 테스트 코드를 작성했다고 생각했습니다. 다음 날 출근해서 포스트에 정리했던 내용을 바탕으로 테스트와 클래스를 구현하다보니 허점이 많았는데, 이번 포스트에서는 부족했던 부분을 어떻게 개선하였는지 정리하였습니다.
1. 첫 테스트 코드와 구현 클래스
처음 작성한 테스트 코드를 살펴보면서 코드의 내용가 작성한 의도에 대해 먼저 살펴보겠습니다.
1.1. 첫 테스트 코드
- AOP 기능을 테스트해야하기 때문에
@SpringBootTest애너테이션을 사용하였습니다. SimpleClient빈(bean)을 주입 받아서 테스트에서 호출합니다.SimpleClient빈의 메소드를 호출할 때마다 AOP 로직에서 이력 성격의 데이터를 추가합니다.InterfaceHistoryRepository빈을 주입 받아서 AOP 로직에서 데이터베이스에 추가된 데이터가 있는지 확인합니다.@Transactional애너테이션를 통해 테스트 종료 후 데이터베이스를 롤백합니다.
package blog.in.action.openfeign.simple;
import blog.in.action.client.SimpleClient;
import blog.in.action.repository.InterfaceHistoryRepository;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.transaction.annotation.Transactional;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.greaterThan;
@SpringBootTest
public class SimpleClientIT {
@Autowired
private SimpleClient simpleClient;
@Autowired
private InterfaceHistoryRepository repository;
@Test
@Transactional
public void whenCallHomeMethod_thenExistsHistoryData() {
simpleClient.home();
assertThat(repository.count(), greaterThan(0L));
}
@Test
@Transactional
public void whenCallAboutMethod_thenExistsHistoryData() {
simpleClient.about();
assertThat(repository.count(), greaterThan(0L));
}
}
1.2. SimpleClient 인터페이스
FeignClient구현체가 주입됩니다.home()-Junhyunny블로그 홈 정보를 요청합니다.about()- 블로그 주인의 자기 소개 페이지를 요청합니다.
package blog.in.action.client;
import blog.in.action.annotation.InterfaceMeta;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
@FeignClient(name = "simple-client", url = "https://junhyunny.github.io")
public interface SimpleClient {
@InterfaceMeta(explainText = "블로그 홈", serviceId = "0001")
@GetMapping(path = "/")
String home();
@InterfaceMeta(explainText = "자기소개", serviceId = "0002")
@GetMapping(path = "/about/")
String about();
}
1.3. InterfaceHistoryInterceptor 클래스
- AOP 기능을 이용하여 특정 기능 호출 시점을 가로채어 실행합니다.
@InterfaceMeta애너테이션이 붙은 메소드 호출 시aroundCallFeignClient메소드가 실행됩니다.- 필요한 정보를 추출하여 이력성 테이블에 추가합니다.
package blog.in.action.aop;
import blog.in.action.annotation.InterfaceMeta;
import blog.in.action.repository.InterfaceHistory;
import blog.in.action.repository.InterfaceHistoryRepository;
import lombok.RequiredArgsConstructor;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.*;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.sql.Timestamp;
import java.time.LocalDateTime;
@Aspect
@Component
@RequiredArgsConstructor
public class InterfaceHistoryInterceptor {
private final InterfaceHistoryRepository repository;
private String[] getPath(Annotation[] annotations) {
for (Annotation annotation : annotations) {
if (annotation instanceof GetMapping) {
return ((GetMapping) annotation).path();
} else if (annotation instanceof PostMapping) {
return ((PostMapping) annotation).path();
} else if (annotation instanceof PutMapping) {
return ((PutMapping) annotation).path();
} else if (annotation instanceof DeleteMapping) {
return ((DeleteMapping) annotation).path();
} else if (annotation instanceof RequestMapping) {
return ((RequestMapping) annotation).path();
}
}
return null;
}
@Around("@annotation(blog.in.action.annotation.InterfaceMeta)")
public Object aroundCallFeignClient(ProceedingJoinPoint pjp) throws Throwable {
Timestamp requestTime = Timestamp.valueOf(LocalDateTime.now());
Object result = pjp.proceed();
try {
Timestamp responseTime = Timestamp.valueOf(LocalDateTime.now());
MethodSignature signature = (MethodSignature) pjp.getSignature();
Method method = signature.getMethod();
InterfaceMeta interfaceMeta = method.getAnnotation(InterfaceMeta.class);
Annotation[] annotations = method.getDeclaredAnnotations();
InterfaceHistory interfaceHistory = InterfaceHistory
.builder()
.serviceId(interfaceMeta.serviceId())
.explainText(interfaceMeta.explainText())
.path(getPath(annotations))
.response(String.valueOf(result))
.requestTime(requestTime)
.responseTime(responseTime)
.build();
repository.save(interfaceHistory);
} catch (Exception e) {
System.out.println(e.getMessage());
}
return result;
}
}
2. 첫 테스트 코드의 문제점과 개선
2.1. 첫 테스트 코드의 문제점
이제 첫 번째 테스트 코드를 작성하고, 구현체를 만들면서 몇 가지 문제점이 있다고 느꼈습니다.
- 결합 테스트이기 때문에 실제 빈(bean) 객체가 필요하기 때문에 테스트가 무겁습니다.
FeignClient객체가 실제로 API 요청을 수행하기 때문에 네트워크에 대한 의존성이 존재합니다.
테스트는 빠르고, 독립적이어야하고, 어떤 환경에서도 다시 동작하여 같은 결과를 얻을 수 있어야 합니다. 극단적으로 테스트 코드들은 네트워크가 없는 폐쇄망에서도 동작할 수 있어야 합니다. 그런 관점에서 봤을 때 처음 작성한 테스트 코드는 네트워크 상황에 따라 결과가 달리질 수 있었고, 실제 데이터베이스에 삽입되는 데이터 값에 대한 검증도 이뤄지지 않았습니다. 일단 몇 가지 문제점들을 개선하였습니다.
2.2. 1차 테스트 코드 개선
- 테스트 빈을 생성하여 실제 네트워크 동작을 수행하지 않습니다.
- 실제 데이터베이스에 추가된 데이터 값에 대한 검증을 수행하였습니다.
package blog.in.action.openfeign.simple;
import blog.in.action.annotation.InterfaceMeta;
import blog.in.action.client.SimpleClient;
import blog.in.action.repository.InterfaceHistory;
import blog.in.action.repository.InterfaceHistoryRepository;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mockito.MockedStatic;
import org.mockito.Mockito;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.Transactional;
import org.springframework.web.bind.annotation.GetMapping;
import java.sql.Timestamp;
import java.time.LocalDateTime;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.equalTo;
@SpringBootTest
public class SimpleClientIT {
@Autowired
@Qualifier("testClient")
SimpleClient simpleClient;
@Autowired
InterfaceHistoryRepository repository;
LocalDateTime requestTime;
LocalDateTime responseTime;
@BeforeEach
void setUp() {
requestTime = LocalDateTime.now();
responseTime = requestTime.plusSeconds(1);
}
@Test
@Transactional
void whenCallHomeMethod_thenExistsHistoryData() {
MockedStatic<LocalDateTime> mockedStatic = Mockito.mockStatic(LocalDateTime.class);
Mockito.when(LocalDateTime.now())
.thenReturn(requestTime, responseTime)
.thenCallRealMethod();
simpleClient.home();
mockedStatic.close();
InterfaceHistory entity = repository.findAll().get(0);
assertThat(entity.getServiceId(), equalTo("0001"));
assertThat(entity.getPath(), equalTo(new String[]{"/"}));
assertThat(entity.getExplainText(), equalTo("블로그 홈"));
assertThat(entity.getResponse(), equalTo("home"));
assertThat(entity.getRequestTime(), equalTo(Timestamp.valueOf(requestTime)));
assertThat(entity.getResponseTime(), equalTo(Timestamp.valueOf(responseTime)));
}
@Test
@Transactional
void whenCallAboutMethod_thenExistsHistoryData() {
MockedStatic<LocalDateTime> mockedStatic = Mockito.mockStatic(LocalDateTime.class);
Mockito.when(LocalDateTime.now())
.thenReturn(requestTime, responseTime)
.thenCallRealMethod();
simpleClient.about();
mockedStatic.close();
InterfaceHistory entity = repository.findAll().get(0);
assertThat(entity.getServiceId(), equalTo("0002"));
assertThat(entity.getPath(), equalTo(new String[]{"/about/"}));
assertThat(entity.getExplainText(), equalTo("자기소개"));
assertThat(entity.getResponse(), equalTo("about"));
assertThat(entity.getRequestTime(), equalTo(Timestamp.valueOf(requestTime)));
assertThat(entity.getResponseTime(), equalTo(Timestamp.valueOf(responseTime)));
}
}
@Configuration
class TestConfig {
@Bean(name = "testClient")
public SimpleClient testClient() {
return new SimpleClient() {
@InterfaceMeta(explainText = "블로그 홈", serviceId = "0001")
@GetMapping(path = "/")
@Override
public String home() {
return "home";
}
@InterfaceMeta(explainText = "자기소개", serviceId = "0002")
@GetMapping(path = "/about/")
@Override
public String about() {
return "about";
}
};
}
}
3. 1차 테스트 코드 개선의 문제점
일부 테스트 코드가 개선되었지만, 여전히 불합리한 부분이 보였습니다.
- 여전히 결합 테스트가 동작하기 때문에 무겁습니다.
- 테스트를 위한
FeignClient가 별도로 존재합니다.
실제 네트워크 호출에 대한 의존성을 제거한 것에 타협하고 남은 테스트들을 작성하였지만, 참을 수 없는 문제점을 하나 발견했습니다. 메소드 위에 요청 방법을 결정하는 애너테이션들은 요청 경로 값을 넣는 방법에 따라 다른 속성에 값으로 저장합니다.
예를 들면 다음과 같습니다.
- ”/” 경로 정보가
@GetMapping애너테이션의path속성에 저장됩니다.
@GetMapping(path = "/")
public String home() {
return "home";
}
- ”/” 경로 정보가
@GetMapping애너테이션의value속성에 저장됩니다.
@GetMapping("/")
public String home() {
return "home";
}
구현한 사람마다 경로를 넣어주는 방법이 달랐는데, 이렇다 보니 어떤 케이스는 테스트가 실패하는 경우가 발생했습니다. 테스트 통과를 위해 경로 지정 방법을 바꾸기만 하면 되지만, 문제는 테스트 통과를 위해 만든 빈을 고칠 뿐 실제 사용하는 클라이언트를 수정한 것이 아니라는 점이었습니다. 작성한 테스트 코드는 실제 사용하는 클라이언트에 대한 검증을 해주지 못 했습니다.
4. 2차 테스트 코드 개선
빈을 사용하지 않고 AOP 기능을 테스트하는 방법을 찾다가 좋은 예시를 찾아 적용하였습니다.
AspectJProxyFactory 클래스를 사용하면 빈을 만들지 않아도 AOP 기능을 제공하는 프록시 객체를 만들 수 있습니다.
이를 통해 다음과 같은 내용들을 개선하였습니다.
- 빈 주입을 받지 않고
SimpleClient객체를 mock 객체로 생성하였습니다.- 실제 API 요청 없이 필요한 응답 값을 확인할 수 있도록 스터빙(stubbing)이 가능해졌습니다.
- 빈 주입을 받지 않고
InterfaceHistoryRepository객체를 mock 객체로 생성하였습니다.- 데이터베이스에 직접 조회하지 않고
save(entity)메소드에 전달된 엔티티 객체의 속성 값들 확인이 가능해졌습니다.
- 데이터베이스에 직접 조회하지 않고
- 빈 주입이 필요 없기 때문에 결합 테스트가 아닌 단위 테스트로 변경하였습니다.
package blog.in.action.openfeign.simple;
import blog.in.action.aop.InterfaceHistoryInterceptor;
import blog.in.action.client.SimpleClient;
import blog.in.action.repository.InterfaceHistory;
import blog.in.action.repository.InterfaceHistoryRepository;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mockito.ArgumentCaptor;
import org.mockito.MockedStatic;
import org.mockito.Mockito;
import org.springframework.aop.aspectj.annotation.AspectJProxyFactory;
import java.sql.Timestamp;
import java.time.LocalDateTime;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.equalTo;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
public class SimpleClientTests {
AspectJProxyFactory factory;
SimpleClient mockClient;
InterfaceHistoryRepository mockRepository;
InterfaceHistoryInterceptor interceptor;
LocalDateTime requestTime;
LocalDateTime responseTime;
@BeforeEach
void setUp() {
mockClient = Mockito.mock(SimpleClient.class);
mockRepository = Mockito.mock(InterfaceHistoryRepository.class);
interceptor = new InterfaceHistoryInterceptor(mockRepository);
factory = new AspectJProxyFactory(mockClient);
factory.addAspect(interceptor);
requestTime = LocalDateTime.now();
responseTime = requestTime.plusSeconds(1);
}
@Test
void whenCallHomeMethod_thenExistsHistoryData() {
MockedStatic<LocalDateTime> mockedStatic = Mockito.mockStatic(LocalDateTime.class);
when(LocalDateTime.now())
.thenReturn(requestTime, responseTime)
.thenCallRealMethod();
when(mockClient.home()).thenReturn("home");
SimpleClient proxy = factory.getProxy();
proxy.home();
ArgumentCaptor<InterfaceHistory> argumentCaptor = ArgumentCaptor.forClass(InterfaceHistory.class);
verify(mockRepository).save(argumentCaptor.capture());
InterfaceHistory entity = argumentCaptor.getValue();
assertThat(entity.getServiceId(), equalTo("0001"));
assertThat(entity.getPath(), equalTo(new String[]{"/"}));
assertThat(entity.getExplainText(), equalTo("블로그 홈"));
assertThat(entity.getResponse(), equalTo("home"));
assertThat(entity.getRequestTime(), equalTo(Timestamp.valueOf(requestTime)));
assertThat(entity.getResponseTime(), equalTo(Timestamp.valueOf(responseTime)));
mockedStatic.close();
}
@Test
void whenCallAboutMethod_thenExistsHistoryData() {
MockedStatic<LocalDateTime> mockedStatic = Mockito.mockStatic(LocalDateTime.class);
when(LocalDateTime.now())
.thenReturn(requestTime, responseTime)
.thenCallRealMethod();
when(mockClient.about()).thenReturn("about");
SimpleClient proxy = factory.getProxy();
proxy.about();
ArgumentCaptor<InterfaceHistory> argumentCaptor = ArgumentCaptor.forClass(InterfaceHistory.class);
verify(mockRepository).save(argumentCaptor.capture());
InterfaceHistory entity = argumentCaptor.getValue();
assertThat(entity.getServiceId(), equalTo("0002"));
assertThat(entity.getPath(), equalTo(new String[]{"/about/"}));
assertThat(entity.getExplainText(), equalTo("자기소개"));
assertThat(entity.getResponse(), equalTo("about"));
assertThat(entity.getRequestTime(), equalTo(Timestamp.valueOf(requestTime)));
assertThat(entity.getResponseTime(), equalTo(Timestamp.valueOf(responseTime)));
mockedStatic.close();
}
}
CLOSING
좋지 않은 테스트 코드를 보완하기 위해 많은 시간이 소요되었지만, 새로운 테스트 방법을 찾은 것만으로 크게 만족했습니다.
댓글남기기