@SpringBootTest를 쓰면서 JPA 테스트 같이 하기

@SpringBootTest를 이용해서 integration test를 할 때 data jpa test도 같이 겸하게 되면 대충 다음과 같은 에러가 난다.

java.lang.IllegalStateException: Failed to load ApplicationContext

 at org.springframework.test.context.cache.DefaultCacheAwareContextLoaderDelegate.loadContext(DefaultCacheAwareContextLoaderDelegate.java:125)
 at org.springframework.test.context.support.DefaultTestContext.getApplicationContext(DefaultTestContext.java:108)
 at org.springframework.test.context.web.ServletTestExecutionListener.setUpRequestContextIfNecessary(ServletTestExecutionListener.java:190)
 at org.springframework.test.context.web.ServletTestExecutionListener.prepareTestInstance(ServletTestExecutionListener.java:132)
 at org.springframework.test.context.TestContextManager.prepareTestInstance(TestContextManager.java:246)
 at org.springframework.test.context.junit.jupiter.SpringExtension.postProcessTestInstance(SpringExtension.java:91)
 at org.junit.jupiter.engine.descriptor.ClassTestDescriptor.lambda$invokeTestInstancePostProcessors$5(ClassTestDescriptor.java:349)
 at org.junit.jupiter.engine.descriptor.JupiterTestDescriptor.executeAndMaskThrowable(JupiterTestDescriptor.java:215)
 at org.junit.jupiter.engine.descriptor.ClassTestDescriptor.lambda$invokeTestInstancePostProcessors$6(ClassTestDescriptor.java:349)
 at java.util.stream.ReferencePipeline$3$1.accept(ReferencePipeline.java:193)
 at java.util.stream.ReferencePipeline$2$1.accept(ReferencePipeline.java:175)
 at java.util.ArrayList$ArrayListSpliterator.forEachRemaining(ArrayList.java:1382)
 at java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:481)
 at java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:471)
 at java.util.stream.StreamSpliterators$WrappingSpliterator.forEachRemaining(StreamSpliterators.java:312)
 at java.util.stream.Streams$ConcatSpliterator.forEachRemaining(Streams.java:743)
 at java.util.stream.Streams$ConcatSpliterator.forEachRemaining(Streams.java:742)
 at java.util.stream.ReferencePipeline$Head.forEach(ReferencePipeline.java:580)
 at org.junit.jupiter.engine.descriptor.ClassTestDescriptor.invokeTestInstancePostProcessors(ClassTestDescriptor.java:348)
 at org.junit.jupiter.engine.descriptor.ClassTestDescriptor.instantiateAndPostProcessTestInstance(ClassTestDescriptor.java:270)
 at org.junit.jupiter.engine.descriptor.ClassTestDescriptor.lambda$testInstanceProvider$2(ClassTestDescriptor.java:259)
 at org.junit.jupiter.engine.descriptor.ClassTestDescriptor.lambda$testInstanceProvider$3(ClassTestDescriptor.java:263)
 at java.util.Optional.orElseGet(Optional.java:267)
 at org.junit.jupiter.engine.descriptor.ClassTestDescriptor.lambda$testInstanceProvider$4(ClassTestDescriptor.java:262)
 at org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.prepare(TestMethodTestDescriptor.java:82)
 at org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.prepare(TestMethodTestDescriptor.java:59)
 at org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$prepare$0(NodeTestTask.java:80)
 at org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:72)
 at org.junit.platform.engine.support.hierarchical.NodeTestTask.prepare(NodeTestTask.java:80)
 at org.junit.platform.engine.support.hierarchical.NodeTestTask.execute(NodeTestTask.java:66)
 at java.util.ArrayList.forEach(ArrayList.java:1257)
 at org.junit.platform.engine.support.hierarchical.SameThreadHierarchicalTestExecutorService.invokeAll(SameThreadHierarchicalTestExecutorService.java:38)
 at org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$5(NodeTestTask.java:110)
 at org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:72)
 at org.junit.platform.engine.support.hierarchical.NodeTestTask.executeRecursively(NodeTestTask.java:95)
 at org.junit.platform.engine.support.hierarchical.NodeTestTask.execute(NodeTestTask.java:71)
 at java.util.ArrayList.forEach(ArrayList.java:1257)
 at org.junit.platform.engine.support.hierarchical.SameThreadHierarchicalTestExecutorService.invokeAll(SameThreadHierarchicalTestExecutorService.java:38)
 at org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$5(NodeTestTask.java:110)
 at org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:72)
 at org.junit.platform.engine.support.hierarchical.NodeTestTask.executeRecursively(NodeTestTask.java:95)
 at org.junit.platform.engine.support.hierarchical.NodeTestTask.execute(NodeTestTask.java:71)
 at org.junit.platform.engine.support.hierarchical.SameThreadHierarchicalTestExecutorService.submit(SameThreadHierarchicalTestExecutorService.java:32)
 at org.junit.platform.engine.support.hierarchical.HierarchicalTestExecutor.execute(HierarchicalTestExecutor.java:57)
 at org.junit.platform.engine.support.hierarchical.HierarchicalTestEngine.execute(HierarchicalTestEngine.java:51)
 at org.junit.platform.launcher.core.DefaultLauncher.execute(DefaultLauncher.java:220)
 at org.junit.platform.launcher.core.DefaultLauncher.lambda$execute$6(DefaultLauncher.java:188)
 at org.junit.platform.launcher.core.DefaultLauncher.withInterceptedStreams(DefaultLauncher.java:202)
 at org.junit.platform.launcher.core.DefaultLauncher.execute(DefaultLauncher.java:181)
 at org.junit.platform.launcher.core.DefaultLauncher.execute(DefaultLauncher.java:128)
 at com.intellij.junit5.JUnit5IdeaTestRunner.startRunnerWithArgs(JUnit5IdeaTestRunner.java:69)
 at com.intellij.rt.execution.junit.IdeaTestRunner$Repeater.startRunnerWithArgs(IdeaTestRunner.java:47)
 at com.intellij.rt.execution.junit.JUnitStarter.prepareStreamsAndStart(JUnitStarter.java:242)
 at com.intellij.rt.execution.junit.JUnitStarter.main(JUnitStarter.java:70)
Caused by: org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'SampleRepository': Instantiation of bean failed; nested exception is org.springframework.beans.BeanInstantiationException: Failed to instantiate [com.kakaomobility.airport.vender.domain.industry.infrastructure.SampleRepository]: Specified class is an interface
 at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.instantiateBean(AbstractAutowireCapableBeanFactory.java:1287)
 at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.createBeanInstance(AbstractAutowireCapableBeanFactory.java:1181)
 at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.doCreateBean(AbstractAutowireCapableBeanFactory.java:555)
 at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.createBean(AbstractAutowireCapableBeanFactory.java:515)
 at org.springframework.beans.factory.support.AbstractBeanFactory.lambda$doGetBean$0(AbstractBeanFactory.java:320)
 at org.springframework.beans.factory.support.DefaultSingletonBeanRegistry.getSingleton(DefaultSingletonBeanRegistry.java:222)
 at org.springframework.beans.factory.support.AbstractBeanFactory.doGetBean(AbstractBeanFactory.java:318)
 at org.springframework.beans.factory.support.AbstractBeanFactory.getBean(AbstractBeanFactory.java:199)
 at org.springframework.beans.factory.support.DefaultListableBeanFactory.preInstantiateSingletons(DefaultListableBeanFactory.java:849)
 at org.springframework.context.support.AbstractApplicationContext.finishBeanFactoryInitialization(AbstractApplicationContext.java:877)
 at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:549)
 at org.springframework.boot.SpringApplication.refresh(SpringApplication.java:775)
 at org.springframework.boot.SpringApplication.refreshContext(SpringApplication.java:397)
 at org.springframework.boot.SpringApplication.run(SpringApplication.java:316)
 at org.springframework.boot.test.context.SpringBootContextLoader.loadContext(SpringBootContextLoader.java:127)
 at org.springframework.test.context.cache.DefaultCacheAwareContextLoaderDelegate.loadContextInternal(DefaultCacheAwareContextLoaderDelegate.java:99)
 at org.springframework.test.context.cache.DefaultCacheAwareContextLoaderDelegate.loadContext(DefaultCacheAwareContextLoaderDelegate.java:117)
 ... 53 more
Caused by: org.springframework.beans.BeanInstantiationException: Failed to instantiate [com.kakaomobility.airport.vender.domain.industry.infrastructure.SampleRepository]: Specified class is an interface
 at org.springframework.beans.factory.support.SimpleInstantiationStrategy.instantiate(SimpleInstantiationStrategy.java:70)
 at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.instantiateBean(AbstractAutowireCapableBeanFactory.java:1279)
 ... 69 more

이유는 여러 블로그에 설명이 되어있으니 그걸 보면 되고 이걸 트릭을 이용해 우회해 보자.

@EntityScan(basePackages = ["com.5dolstory.sample"])
@EnableJpaRepositories(basePackages = ["com.5dolstory.sample"])
@Configuration
class SampleConfiguration

이런식으로 일단 jpaRepository를 scan 할 수 있도록 configuration을 만들고 이걸 SpringBootTest가 load해서 applicationContext에 올리도록 한다.
그리고 jpa test를 위해 몇가지 annotation을 추가해서 테스트용 DB를 사용할 수 있게 하자.

@EnableConfigurationProperties(AppEnvironment::class)
@SpringBootTest(classes = [
    SampleService::class,
    SampleConfiguration::class
])
@AutoConfigureDataJpa
@AutoConfigureTestDatabase
@AutoConfigureTestEntityManager
internal class SampleControllerTest {
}

이런식으로 하면 우회해서 테스트 가능하다.
이게 동작하는 이유를 간단히 설명하면 test 코드 동작 시 JPA를 이용 할 때 필요한 요소들을 다 등록하는 것이다.

Embedded Mysql for springboot

나는 개인적으로 local 작업시 db, redis 같은 걸 별도로 인스톨해서 쓰지 않고 embedded하는 편이다.

일단 시간이 없으니 볼론으로 들어가서 mysql을 embedded하는 건 다음과 같다. (참고로 코드는 kotlin이다.)

일단 라이브러리 추가.

compile("com.wix:wix-embedded-mysql:4.2.0")

그리고 다음 configration을 추가

@Profile(value = ["default"])
@Component
@EnableConfigurationProperties(value = [DataSourceProperties::class])
class DefaultEmbeddedMysql(
    private val properties: DataSourceProperties
) {
    private val log = LoggerFactory.getLogger(javaClass)
    private lateinit var mysqlServer: EmbeddedMysql

    @PostConstruct
    @Throws(IOException::class)
    fun start() {
        log.info("Initializing embedded Mysql instance")

        val uri = URI.create(properties.url.substring(5))
        val config = MysqldConfig.aMysqldConfig(Version.v5_7_19)
            .withCharset(Charset.UTF8)
            .withPort(uri.port)
            .withTimeZone(TimeZone.getTimeZone("Asia/Seoul"))
            .withUser(properties.username, properties.password)
            .build()

        val path = uri.path.removePrefix("/")

        mysqlServer = EmbeddedMysql.anEmbeddedMysql(config)
            .addSchema(SchemaConfig.aSchemaConfig(path).withCharset(Charset.UTF8).build())
            .start()
    }

    @PreDestroy
    @Throws(InterruptedException::class)
    fun stop() {
        mysqlServer.stop()
    }

    @Bean
    fun dataSource(): DataSource {
        return properties.initializeDataSourceBuilder().build()
    }
}

이러면 springboot가 뜰 때 mysql을 다운받고 mysqld로 mysql을 기동하는 걸 로그로 볼 수 있다.
local에서만 사용하도록 꼭 @Profile을 추가해주자.