멀티 모듈 프로젝트 NoSuchBeanDefinitionException: No qualifying bean of type 'jakarta.persistence.EntityManagerFactory' available

🌱 문제 상황

현재 내 프로젝트는 이렇게 멀티모듈로 구성되어 있다.

admin 모듈과 app 모듈은 애플리케이션을 실행하는 모듈이며, core.domain 모듈 패키지에 있는 Entity를 모두 스캔하여 Bean으로 등록해야 한다.

 

@SpringBootApplication
@ComponentScan(basePackages = {"com.chaewsstore.core.domain"})
public class AdminApplication {

    public static void main(String[] args) {
        SpringApplication.run(AdminApplication.class, args);
    }
}

AdminApplication 클래스에 선언되어 있는 @SpringBootApplication 어노테이션은 기본적으로 애플리케이션 클래스가 위치한 패키지(com.chaewsstore.admin)와 그 하위 패키지에서만 컴포넌트를 스캔하기 때문에 'com.chaewsstore.domain' 패키지를 스캔하려면 @ComponentScan 또는 @SpringBootApplication의 scanBasePackage 속성을 사용하여 스캔 범위를 명시적으로 지정해야 한다.

 

하지만 문제는 컨트롤러 테스트에서 발생했는데 기존에는 잘 돌아가던 테스트에서 아래의 Exception이 발생하기 시작했다.

@ExtendWith(RestDocumentationExtension.class)
@WebMvcTest(ProductController.class)
class ProductControllerUnitTest {

    @MockBean
    private ProductUseCase productUseCase;

    private MockMvc mockMvc;

    private final ObjectMapper objectMapper = new ObjectMapper();

    ...
}

Caused by: org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'queryDslConfig': Injection of persistence dependencies failed.
Caused by: org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'jakarta.persistence.EntityManagerFactory' available

이는 Spring 애플리케이션이 EntityManagerFactory Bean을 찾지 못해 발생하는 에러이다. @ComponentScan을 통해 Domain 패키지에 위치한 QueryDslConfig를 Bean으로 등록해 주었는데 왜 이런 에러가 발생했을까?

 

🌱 문제 발생 이유 - @WebMvcTest

ControllerUnitTest에 사용된 @WebMvcTest는 웹 계층(컨트롤러)만 테스트하기 위해 사용되기 때문에 JPA 관련 설정이나 Bean들은 로딩하지 않는다. 따라서 AdminApplication 클래스에 선언한 어노테이션들은 테스트코드를 실행할 때 적용되지 않으며, 그 결과로 entityManagerFactory와 같은 JPA 관련 Bean들이 로딩되지 않아 테스트가 실패하게 된 것이다.

 

🌱 해결 방안

해당 설정들을 따로 분리해 Config 파일로 선언하면 해결된다.

@ComponentScan(basePackages = {"com.chaewsstore.core.domain"})
@Configuration
public class DomainConfig {

}

@SpringBootApplication
public class AdminApplication {

    public static void main(String[] args) {
        SpringApplication.run(AdminApplication.class, args);
    }
}