전체 통합 테스트 시간 속도를 증가시키는 Spring Test Context Caching

😂  배경

필자는 프로젝트를 진행하면서 통합 테스트 코드를 작성할 때 각 케이스마다 테스트 메서드를 작성하고 실행하고, 메서드 작성이 적당히 마무리되면 클래스 내에 있는 모든 테스트 메서드를 실행시켜 보는 방식으로 진행해 왔다.

 

그러다가 테스트 코드가 어느 정도 양이 쌓였을 때 전체 테스트를 돌렸는데, 시간이 굉장히 오래 걸리는 것을 확인하고는 충격을 받았다. 그렇게 전체 테스트 코드 수행 속도에 대해 고민을 하게 되었고, Context Caching에 대해 알게 되었다.

[ Context Caching ]

스프링 테스트 프레임워크는 ApplicationContext가 생성되면 이를 캐시에 저장하고, 만약 재사용이 가능한 경우라면 다른 테스트를 돌릴 때 이를 재사용한다. 이처럼 테스트에서 띄운 컨텍스트를 테스트마다 생성하지 않고 캐싱해 둔 컨텍스트를 재사용하는 것을 Context Caching이라고 한다.

 

Context Caching을 사용하면 많은 스프링 통합(Integration) 테스트 코드를 빠르게 실행시킴으로써 생산성을 증가시킨다는 장점이 있다.

 

그럼 Context를 재사용이 가능한 경우는 어떤 것일까?

바로, 테스트가 동일한 환경을 유지하는 경우이다. 

스프링은 동일한 환경이라는 것은 어떻게 판별할까? 이것은 Context Caching에서 cache key가 무엇으로 구성되는지와 관련이 있다. 스프링 테스트 컨텍스트 프레임워크는 다음 구성 매개 변수를 사용하여 컨텍스트 cache key를 구성한다.

• locations (from @ContextConfiguration)
• classes (from @ContextConfiguration)
• contextInitializerClasses (from @ContextConfiguration)
• contextCustomizers (from ContextCustomizerFactory) – this includes @DynamicPropertySource methods as well as various features from Spring Boot’s testing support such as @MockBean and @SpyBean.
• contextLoader (from @ContextConfiguration)
• parent (from @ContextHierarchy)
• activeProfiles (from @ActiveProfiles)
• propertySourceLocations (from @TestPropertySource)
• propertySourceProperties (from @TestPropertySource)
• resourceBasePath (from @WebAppConfiguration)

이 중에서 가장 주의해야 할 점은 @MockBean, @SpyBean을 사용하는 것이 재사용 여부에 영향을 미친다는 것이다.

즉, @MockBean, @SpyBean을 사용하면 다른 환경으로 인식하여 새롭게 컨텍스트가 뜨게 된다.

[ 활용 Tip ]

1. 테스트 코드 상속 활용

동일한 환경을 유지시키는 좋은 방법 중 하나는 부모 클래스에 동일한 설정을 넣고 상속해서 사용하는 방법이다.

 

자식 클래스에서 무언가 다른 환경 설정을 하지 않는 이상 동일한 환경을 간편하게 유지할 수 있어서 테스트 코드를 작성할 때  편리하다.

2. @MockBean/@SpyBean 또한 상속 활용

@MockBean 또는 @SpyBean이 필요하다고 판단되면, 여러 테스트 코드에서 필요한 @MockBean/@SpyBean을 모두 하나의 상위 클래스에 선언하고 해당 클래스를 상속시켜서 사용한다.

 

점점 클래스가 커지겠지만 필자는 Context Caching이 주는 이점이 더 크다고 생각된다.

REFERENCE

https://docs.spring.io/spring-framework/reference/testing/testcontext-framework/ctx-management/caching.html

https://medium.com/@inzuael/how-to-optimize-the-runtime-of-your-springboot-integration-tests-2a13584f577e