Junit5 의존성 주입 에러@Autowired ParameterResolutionException 과 해결방법

Junit5 의존성 주입 에러@Autowired ParameterResolutionException 과 해결방법

보통 Spring을 사용하면 의존성 주입을 생성자 주입을 사용하여 받게 된다.

그래서 JUnit 테스트 에서도 @RequiredArgsConstructor 를 이용한 생성자 주입이 가능할 것 같지만 그렇지 않다.

만약 다음과 같이 생성자 주입을 받으려고 하면 다음과 같은 에러를 만난다

@RequiredArgsConstructor
@SpringBootTest
class ConstructorDiTest {

    private final MemberRepository memberRepository;

         private final MemberService memberService;

    ...
}

org.junit.jupiter.api.extension.ParameterResolutionException: No ParameterResolver registered for parameter [final com.ys.jpa.domain.member.MemberRepository memberRepository] in constructor [public com.ys.jpa.ConstructorDiTest(com.ys.jpa.domain.member.MemberRepository)].

줄여보면 다음과 같은 오류이다

org.junit.jupiter.api.extension.ParameterResolutionException: No ParameterResolver registered for parameter

에러로그를 읽어보는것이 중요하다. 해석해보면

Jupiter가 해당 파라미터에 대해 등록된 ParameterResolver가 없다는 예외이다.

 

가장 밑에 실제 예외가 왜 터지는지에 대한 이유, 디버그와 분석이 있다

---

 

결론부터 말하자면,

Junit5의 경우 빈 주입은 @AutoWired 어노테이션을 사용해야 한다.

main 코드의 환경 (스프링 컨테이너)과 test 코드의 환경(Jupiter)가 다르기 때문이다.

• @Autowired를 통해 스프링 컨테이너에게 빈 주입을 요청해야 한다.

그러나 @TestConstructor를 통해 @Autowired 없이 주입받을 수 있는 방법이 있다.

• https://0soo.tistory.com/138

---

 

Jupiter가 무엇인지 부터 보자.

Junit의 아키텍처 구조

JUnit Platform

테스트를 실행할 수 있는 엔진을 포함하고 여러 Tool(콘솔, 이클립스, Intellij등의 IDE)에 일관성 있는 API를 제공해주는 역할을 담당

• JUnit으로 만든 Test Code를 실행시키는 Launcher를 의미한다.
• Launcher를 통해서 콘솔에서도 테스트 실행이 가능하다.
• TestEngine API를 제공한다.

---

JUnit Vintage

JUnit Platform을 구현하는 구현체

• JUnit3과 4의 구현체이다.
• = TestEngine API 구현체이다.
• Vintage 라는 의미를 보면 하위버전의(Junit3, 4) 지원을 위한 구현체

---

JUnit Jupiter

JUnit Platform을 구현하는 구현체

• JUnit5 구현체이다.
• = TestEngine API 구현체이다.
• Spring Boot에서는 2.2 올리면서 Default로 설정되었다.

JUnit팀이 이러한 JUnit Platform을 기반으로 구현체를 만드는 방식을 사용한 이유가 있다고 한다.

Jupiter나 Vintage처럼 다른 써드파티 구현체들이 JUnit Platform의 스펙을 준수해서 API를 구현하게 해서

오픈소스 기반으로 개발자 생태계에 JUnit이 기여하고 똑똑한 개발자들이 JUnit Platform을 기반으로 한 창의적인 테스트 프레임워크를 개발하기를 바랬기 때문이라고 한다.

• 그에 따른 여러 JUnit 기반 오픈소스 테스트 프레임워크들도 속속 등장하고 있다. (Spec, Specsy 등등)
• 이는 결국 JUnit이라는 테스트 프레임워크 생태계를 구축하고 넓히려는데 그 목적이 있다고 볼 수 있다.
  • 독점이긴하지만 개발자 입장에선 편리해서 좋다.

JUnit5에서는 Vintage 가 아닌 Jupiter 를 사용한다

 

왜 Jupiter가 해당 파라미터에 대해 등록된 ParameterResolver가 없다는 예외를 발생시키는가

Junit의 ParameterResolver는 런타임시 동적으로 파라미터를 결정하는 test extension에 관한 API가 정의되어 있다.

그래서 테스트 클래스의 생성자나 메서드나 lifeCycle 메서드가 파라미터를 받고싶다면 ParameterResolver를 통해 런타임에 주입받을 수 있다.

그러나 Spring Bean에 대한 ParameterResolver는 Jupiter에 정의되어 있지 않다.

• 해당 테스트 생성자에 파라미터 주입이 가능지에 대한 여부를 확인하는 메소드 : SpringExtension.supportsParameter()
• ApplicationContext에서 Bean을 실제 꺼내서 리턴하는 메소드 : SpringExtension.resolveParameter

 

main 코드와 test 코드가 실행되는 환경이 다르다.

main 코드는 Spring 컨테이너가 실행되어 Spring 컨테이너가 Application Context에서 빈을 찾아서 주입해주지만,

test 코드는 Jupiter 컨테이너가 SpringExtension을 이용해서 주입하게 된다.

 

생성자 주입을 요구하는 경우 Jupiter가 생성자 매개변수를 주입해주기 위해 처리할 ParameterResolver를 찾지만,

처리 할 ParameterResolver가 없기 때문에 예외를 발생시키는 것이다.

 

하지만 @Autowired 어노테이션을 사용하게 되면, Jupiter가 이를 보고 Spring Container에게 빈 주입을 요청해서 정상적으로 주입할 수 있게 된다.

 

결론적으로, main 환경과 test 환경의 관리하고있는 프레임워크의 주체가 다르기 때문에, 테스트 환경을 관리하고 있는 Jupiter는 생성자를 통한 생성자 주입을 할 수 없고, @Autowired를 명시해서 Jupiter가 SpringContainer에게 요청해야만 빈 주입을 할 수 있게 된다.

 

• Spring main 환경의 경우
  • Spring Ioc 컨테이너가 등록할 Bean들을 먼저 찾아서 관리.
  • 이후 생성자 주입을 요구하는경우, 적절한 Bean을 찾아서 생성자 매개변수를 처리
• test framework 환경의 경우
  • 생성자 매개 변수 관리를 Jupiter가 하게된다.
  • 생성자 주입을 요구하는경우, 생성자 매개변수를 처리할 ParameterResolver을 찾지만, 주입할 빈들은 스프링 컨테이너가 가지고 있기때문에 처리하지 못하게 예외를 던진다.

 

1. ExecutableInvoker 클래스가 invoke() 메소드를 통해 주입을 시도한다.

 

2. invoke() 메소드에서 resolveParameters()를 호출하는데, resolveParameters() 메소드 내에서 parameters 개수 만큼 for문을 돌려서 resolveParameter()를 호출한다.

 

3. 이 resolveParameter() 내에서 extensionRegistry로 반복을돌려 stream.filter로 특정 조건에 맞는 resolver를 찾아 supportsParameter 메소드로 파라미터 주입이 지원 가능한지 확인한다.

List<ParameterResolver> matchingResolvers = extensionRegistry.stream(ParameterResolver.class)
                    .filter(resolver -> resolver.supportsParameter(parameterContext, extensionContext))
                    .collect(toList());

• parameterContext : ParameterResolver를 통해 파라미터 주입을 지원하는 데 사용.
• extensionContext : 현재 테스트 또는 컨테이너가 실행 중인 컨텍스트

 

4. 즉 현재 테스트 Context(ExtensionContext)가 parameterContext에게 파라미터 주입이 가능한 ParameterResolver 애들만 골라서, List로 모으는 것이다.

 

5. 이 때, 현재 지원할 수 있는 파라미터 Resolver가 0개라면, ParameterResolutionException을 발생시킨다.

 

실제 예외 터지는 장면 디버그

다음 코드는 @Autowired 없이 생성자 주입이 가능한지 디버그 하는 코드이다.

@RequiredArgsConstructor
@SpringBootTest
class ConstructorDiTest {

    private final MemberService memberService;

    @Test
    void test() {
    }
}

코드와 디버그 기록은 다음과 같다.

글씨가 작아서 잘 안보일 수도 있고 숫자도 못써서 잘 안보일 수도 있지만 열심히 정리해보겠다.

*잘 생각해봐야한다. 이 전에 선행 되어야 하는게, 생성자를 통한 주입을 하기 위해 해당 생성자 파라미터에 값을 넣을 Bean을 Spring의 Application Context에서 빈을 먼저 가지고 와야 한다. Application Context는 SpringExtension이 가지고 있는데 이 과정은 SpringExtension에서 해당 Bean을 찾기 전에 지원할 수 있는지 여부를 먼저 검토하는것이다. 애초에 주입이 불가능한 애라면 Application Context에서 Bean을 꺼내올 필요가 없다. *

• 해당 테스트 생성자에 파라미터 주입이 가능지에 대한 여부를 확인하는 메소드 : SpringExtension.supportsParameter()
• ApplicationContext에서 Bean을 실제 꺼내서 리턴하는 메소드 : SpringExtension.resolveParameter
  
  
  

1. 현재 ExtensionRegistry에서 (Extension들이 등록되어있는 곳) supportsParameter() 메서드로 지원하는지 filtering 해서 ParameterResolver를 찾는다
   • 그림의 a. 현재 ExtensionRegistry에는 SpringExtension 1개밖에 없다.
   • 그림의 b. 현재 생성자에 주입하려고 하는 Parameter는 MemberService이다
2. MemberService 파라미터를 현재 Extension(SpringExtension)이 처리할 수 있는지 확인한다
   • SpringExtension이 ParameterResolver 인터페이스를 구현하긴 헀다.
   • 그러나 @Autowired 어노테이션도 없고, @TestConstructor도 없으므로 supportsParameter() 는 false이다
   • SpringExtension가 처리할 수 있는 Parameter는 필드에 @Autowired가 선언되어 있거나,
   • 어떻게 처리할 수 있는 ParameterResovler를 찾는지는 https://0soo.tistory.com/138 를 참고하자.
3. matchingResolvers(처리할 수 있는 ParameterResolver) 가 isEmpty(하나도 없음)이므로 ParameterResolutionException을 던지고 테스트는 예외를 뿜으며 멈추게 된다.

그러나 @TestConstructor 어노테이션과 properties 설정을 통한 주입이 가능하긴 하다!

• https://0soo.tistory.com/138

 

참조

• https://donghyeon.dev/junit/2021/04/11/JUnit5-%EC%99%84%EB%B2%BD-%EA%B0%80%EC%9D%B4%EB%93%9C/
• https://minkukjo.github.io/framework/2020/06/28/JUnit-23/