[Spring Boot] 멀티모듈 'Unable to find a @SpringBootConfiguration'

🌱 문제 상황

멀티모듈 프로젝트 테스트를 하던 중 도메인 모듈에서 @DataJpaTest를 사용하니 아래와 같은 에러가 발생했다.

java.lang.IllegalStateException: Unable to find a @SpringBootConfiguration, you need to use @ContextConfiguration or @SpringBootTest(classes=...) with your test

 

@DataJpaTest를 사용할 때, 스프링 부트는 애플리케이션이 어떻게 시작될지에 대한 정보를 제공하는 @SpringBootApplication 또는 @SpringBootConfiguration이 붙은 클래스를 통해 하위 패키지를 @ComponentScan 및 @EntityScan 등의 작업을 통해 스캔하고, 빈(bean)을 등록하여 설정을 적용하게 된다.

 

그러나 일반적으로 멀티모듈 구조를 사용하는 경우, 애플리케이션 모듈 외의 다른 모듈에서는 @SpringBootApplication 클래스를 만들지 않는다. 이로 인해 도메인 모듈에서 @DataJpaTest와 같은 스프링 부트 기반 테스트를 실행하려고 하면, 애플리케이션 컨텍스트를 설정할 수 없어 IllegalStateException: Unable to find a @SpringBootConfiguration 오류가 발생하게 되는 것이다.

 

🌱 해결 방안

테스트 레벨 최상위 패키지에 @SpringBootApplication 클래스 만들기

@SpringBootApplication
public class TestApplication {

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

위에서 언급했듯이 스프링 부트는 @SpringBootApplication이 붙은 클래스를 통해 자동 설정과 컴포넌트 스캔을 하지만 도메인 모듈에는 @SpringBootApplication 클래스가 없기 때문에 기본적인 패키지 스캔을 할 수 없다.

 

따라서 테스트 레벨 최상위 패키지에 @SpringBootApplication 어노테이션이 있는 클래스를 만들면, 스프링 부트는 이 클래스를 사용하여 애플리케이션 컨텍스트를 설정할 수 있게 된다.

 

😅 도메인 DataJpaTest를 하면서 추가적으로 설정한 것들

org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'com.querydsl.jpa.impl.JPAQueryFactory' available: expected at least 1 bean which qualifies as autowire candidate.

QueryDSL을 사용할 경우 @TestConfiguration를 통해 관련 빈 추가로 설정한 후 테스트 클래스에서 해당 config 클래스 import

@TestConfiguration
public class TestConfig {

    @PersistenceContext
    private EntityManager entityManager;

    @Bean
    public JPAQueryFactory jpaQueryFactory() {
        return new JPAQueryFactory(entityManager);
    }
}

@Import(TestConfig.class)
@DataJpaTest
class ...Test { ... }

---

IllegalStateException: Cannot load driver class: org.h2.Driver

domain 모듈의 build.gradle 파일에 h2 testImplementation 추가

dependencies {
    ...
    
    testImplementation 'com.h2database:h2'
}