[DEVLOG] JUnit5를 활용한 테스트 코드 작성과 @DataJpaTest 사용시 발생한 문제 해결

 

🤔 Spring Data JPA를 사용하면서 JPA 관련 테스트만 진행하고 싶을 때

 

모든 빈을 등록하는 @SpringBootTest 어노테이션을 사용하면 애플리케이션의 규모가 커질 수록 속도가 느려집니다.

하지만, JPA 관련 테스트만 진행하고 싶은 경우가 분명하게 존재합니다.

이와 같은 경우에는, @DataJpaTest 어노테이션을 사용합니다.

 

@DataJpaTest
class GTMemberEntityTest{

    @Autowired
    private GTAccountInfoRepository accountInfoRepository;

    @Autowired
    private GTMemberInfoRepository memberInfoRepository;

    @Autowired
    private GTAccountUserRoleInfoRepository accountUserRoleInfoRepository;

    @Test
    @DisplayName("🤔 1. 계정정보 생성 및 저장 테스트 : 성공 케이스")
    @Transactional
    public void testForCreateNewAccountInfoAndSave(){
        GTAccountInfo mockAccountInfo = GTAccountInfo.builder()
                .accountEmail("test@example.com")
                .accountPW("1234")
                .build();

        GTAccountInfo savedAccountInfo = accountInfoRepository.save(mockAccountInfo);

        assertEquals(savedAccountInfo.getAccountEmail(), "test@example.com");
        assertEquals(savedAccountInfo.getAccountPW(), "1234");
        assertEquals(savedAccountInfo.getRoles().size(), 0);

    }
    
}

 

위와 같이 작성하면, 아래와 같은 오류를 마주쳤습니다.

org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'dataSourceScriptDatabaseInitializer' defined in class path resource [org/springframework/boot/autoconfigure/sql/init/DataSourceInitializationConfiguration.class]: Unsatisfied dependency expressed through method 'dataSourceScriptDatabaseInitializer' parameter 0; nested exception is org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'dataSource': Invocation of init method failed; nested exception is java.lang.IllegalStateException: Failed to replace DataSource with an embedded database for tests. If you want an embedded database please put a supported one on the classpath or tune the replace attribute of @AutoConfigureTestDatabase.

테스트를 위한 임베디드 데이터베이스에 대한 DataSource를 교체하는데 실패했다는 메시지를 발견했습니다.

임베디드 데이터베이스를 설정한 적이 없지만, 임베디드 데이터베이스를 사용하길 원한다면 classpath에 저장된, 지원하는 것을 사용하거나 @AutoConfigureTestDatabase 어노테이션의 replace 옵션을 조정하기를 바라고 있습니다.

 

이러한 오류가 나타난 이유를 살펴보기 위해, @DataJpaTest 어노테이션을 살펴보도록 하겠습니다.

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@BootstrapWith(DataJpaTestContextBootstrapper.class)
@ExtendWith(SpringExtension.class)
@OverrideAutoConfiguration(enabled = false)
@TypeExcludeFilters(DataJpaTypeExcludeFilter.class)
@Transactional
@AutoConfigureCache
@AutoConfigureDataJpa
@AutoConfigureTestDatabase
@AutoConfigureTestEntityManager
@ImportAutoConfiguration
public @interface DataJpaTest {
}

 

기본적으로, @DataJpaTest에는 @AutoConfigureTestDatabase라는 어노테이션이 달려있습니다.

그래서 위와 같은 에러메시지가, @DataJpaTest 어노테이션 내부 로직을 처리하면서 발생했다는 사실을 알게 되었습니다.

 

@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@ImportAutoConfiguration
@PropertyMapping("spring.test.database")
public @interface AutoConfigureTestDatabase {

	/**
	 * Determines what type of existing DataSource bean can be replaced.
	 * @return the type of existing DataSource to replace
	 */
	@PropertyMapping(skip = SkipPropertyMapping.ON_DEFAULT_VALUE)
	Replace replace() default Replace.ANY;

	/**
	 * The type of connection to be established when {@link #replace() replacing} the
	 * DataSource. By default will attempt to detect the connection based on the
	 * classpath.
	 * @return the type of connection to use
	 */
	EmbeddedDatabaseConnection connection() default EmbeddedDatabaseConnection.NONE;

	/**
	 * What the test database can replace.
	 */
	enum Replace {

		/**
		 * Replace the DataSource bean whether it was auto-configured or manually defined.
		 */
		ANY,

		/**
		 * Only replace the DataSource if it was auto-configured.
		 */
		AUTO_CONFIGURED,

		/**
		 * Don't replace the application default DataSource.
		 */
		NONE

	}

}

 

내부를 살펴봅시다. 에러 메시지에서 replace attribute를 조정하라고 하였으므로, replace를 먼저 확인해봅시다. @AutoConfigureTestDatabase의 replace의 default값은 Replace.ANY;에 해당합니다. 

replace는 아래의 EmbeddedDatabase에 관한 설정을 결정합니다.

ANY → 자동 구성되었든, 수동으로 정의했든 상관없이 DataSource 빈을 교체하는 Enum 값
AUTO_CONFIGURED → 자동 구성된 경우에만 DataSource 빈 교체하는 Enum 값
NONE → DataSource를 교체 하지 않음

따라서, 지금 상태로는 테스트를 위한 DataSource 빈이 교체된다는 사실을 알게되었습니다.

 

EmbeddedDatabaseConnection은 default 값으로 EmbeddedDatabaseConnection.NONE;을 갖습니다.

EmbeddedDatabaseConnection은, H2, DERBY, HSQLDB 등을 지원합니다.

public enum EmbeddedDatabaseConnection {

	/**
	 * No Connection.
	 */
	NONE(null, null, null, (url) -> false),

	/**
	 * H2 Database Connection.
	 */
	H2(EmbeddedDatabaseType.H2, DatabaseDriver.H2.getDriverClassName(),
			"jdbc:h2:mem:%s;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE", (url) -> url.contains(":h2:mem")),

	/**
	 * Derby Database Connection.
	 */
	DERBY(EmbeddedDatabaseType.DERBY, DatabaseDriver.DERBY.getDriverClassName(), "jdbc:derby:memory:%s;create=true",
			(url) -> true),

	/**
	 * HSQL Database Connection.
	 * @since 2.4.0
	 */
	HSQLDB(EmbeddedDatabaseType.HSQL, DatabaseDriver.HSQLDB.getDriverClassName(), "org.hsqldb.jdbcDriver",
			"jdbc:hsqldb:mem:%s", (url) -> url.contains(":hsqldb:mem:"));
  }

 

그 중, default로 None을 가지므로,

private final EmbeddedDatabaseType type;

private final String driverClass;

private final String alternativeDriverClass;

private final String url;

의 값은 모두 null인 Enum값이 선택되었네요.

 

@AutoConfigureTestDatabase의 주석을 살펴보면, TestDatabaseAutoConfiguration에 See Also가 되어있는 것을 확인할 수 있습니다. 마찬가지로 확인해보도록 하겠습니다.

 

@Configuration(proxyBeanMethods = false)
@AutoConfigureBefore(DataSourceAutoConfiguration.class)
public class TestDatabaseAutoConfiguration {

	@Bean
	@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
	@ConditionalOnProperty(prefix = "spring.test.database", name = "replace", havingValue = "ANY",
			matchIfMissing = true)
	static EmbeddedDataSourceBeanFactoryPostProcessor embeddedDataSourceBeanFactoryPostProcessor() {
		return new EmbeddedDataSourceBeanFactoryPostProcessor();
	}

}

TestDatabaseAutoConfiguration은 테스트 데이터베이스를 위한 Auto-configuration이라고 합니다.

그 중, @ConditionalOnProperty 어노테이션에서 replace 값에 대하여 ANY 값을 갖는다면 새로운 EmbeddedDataSourceBeanFactoryPostProcessor를 동적할당해서 빈으로 등록하는 모습을 볼 수 있습니다.

 

EmbeddedDataSourceBeanFactoryPostProcessor는 BeanDefinitionRegistryPostProcessor를 구현하고 있고,

이 인터페이스에 대한 설명은 아래의 링크에서 확인할 수 있었습니다

BeanDefinitionRegistryPostProcessor의 사용

 

postProcessBeanDefinitionRegistry를 오버라이딩해서 BeanFactory를 통해서 빈 정보를 등록시킬 수 있습니다.

process(registry, (ConfigurableListableBeanFactory) registry);

위와 같이 해당 메소드에서 EmbeddedDataSourceBeanFactoryPostProcessor.process를 호출하고,

 

registry.registerBeanDefinition(beanName, createEmbeddedBeanDefinition(primary));

process 메소드에서는 createEmbeddedBeanDefinition을 호출합니다.

 

createEmbeddedBeanDefinition에서 RootBeanDefinition을 설정하면서

EmbeddedDataSourceFactoryBean.class

를 파라미터로 넣습니다.

 

EmbeddedDataSourceFactoryBean은 InitializingBean을 구현하고 있고, afterPropertiesSet을 오버라이딩 함으로써 BeanFactory에 의해 모든 property 가 설정되고 난 뒤 해당 메소드가 실행됩니다.

 

해당 메소드에서는 

@Override
public void afterPropertiesSet() throws Exception {
   this.embeddedDatabase = this.factory.getEmbeddedDatabase();
}

와 같이 getEmbeddedDatabase 메소드를 호출하고 있습니다.

 

마침내, 오류에서 발견한 문구가 보이기 시작합니다.

EmbeddedDatabase getEmbeddedDatabase() {
   EmbeddedDatabaseConnection connection = this.environment.getProperty("spring.test.database.connection",
         EmbeddedDatabaseConnection.class, EmbeddedDatabaseConnection.NONE);
   if (EmbeddedDatabaseConnection.NONE.equals(connection)) {
      connection = EmbeddedDatabaseConnection.get(getClass().getClassLoader());
   }
   Assert.state(connection != EmbeddedDatabaseConnection.NONE,
         "Failed to replace DataSource with an embedded database for tests. If "
               + "you want an embedded database please put a supported one "
               + "on the classpath or tune the replace attribute of @AutoConfigureTestDatabase.");
   return new EmbeddedDatabaseBuilder().generateUniqueName(true).setType(connection.getType()).build();
}

Assert.state에서 EmbeddedDatabaseConnection.NONE이 아님을 보장하고 있으나,

위에서 봤듯이, EmbeddedDatabaseConnection 값은 EmbeddedDatabaseConnection.NONE으로 설정되어 있습니다. 따라서 이 부분에서 에러가 난 것을 확인할 수 있었습니다.

 

따라서 이 문제를 해결하고, 테스트 데이터베이스가 아닌 실제 데이터베이스를 사용하고자 한다면,

@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)

과 같이 replace 값을 NONE으로 변경해주면 됩니다. ANY가 Default 였기 때문에 발생한 문제임을 알 수 있었습니다.

 

@DataJpaTest
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)
class GTMemberEntityTest{

    @Autowired
    private GTAccountInfoRepository accountInfoRepository;

    @Autowired
    private GTMemberInfoRepository memberInfoRepository;

    @Autowired
    private GTAccountUserRoleInfoRepository accountUserRoleInfoRepository;

    @Test
    @DisplayName("🤔 1. 계정정보 생성 및 저장 테스트 : 성공 케이스")
    @Transactional
    public void testForCreateNewAccountInfoAndSave(){
        GTAccountInfo mockAccountInfo = GTAccountInfo.builder()
                .accountEmail("test@example.com")
                .accountPW("1234")
                .build();

        GTAccountInfo savedAccountInfo = accountInfoRepository.save(mockAccountInfo);

        assertEquals(savedAccountInfo.getAccountEmail(), "test@example.com");
        assertEquals(savedAccountInfo.getAccountPW(), "1234");
        assertEquals(savedAccountInfo.getRoles().size(), 0);

    }
    
}

 

 

 

Spring Bean이 어떻게 등록되는지 정확한 과정을 잘 몰랐기에 대략적으로밖에 문제의 원인을 파악하지 못했습니다.

나중에 추가적인 학습을 통해서 Spring Bean이 어떻게 등록되는지 자세히 공부할 필요성을 느꼈습니다.