<div id="readability-page-1" class="page"><div>
                <p><a href="/m/category/JAVA/spring"><span>JAVA/spring</span></a></p><h3>[Test] h2대신 postgresql을 DB로 대체해본.ssul</h3>
              </div><p><cite>Berno</cite>
                <span> 2023. 11. 4. 15:06</span>
              </p><div>
                                <h3 data-ke-size="size23"><b>0. 이 글의 목적</b></h3>
<p data-ke-size="size16">테스트 환경에서 H2를 사용하다 보니 jsonb같은 dialect를 이해하지 못하는 상황이 발생함</p>
<p data-ke-size="size16">Postgresql95Dialect로 dialect에 대해 설정하는 등 다양한 방법을 시도해 보았으나 실패하다 테스트 DB자체를 바꾸면 되는 거 아닌가 하는 생각으로 구글링과 함께 스타트</p>

<h3 data-ke-size="size23"><b>1. 동작 방식 요약</b></h3>
<p data-ke-size="size16">postgresql 도커 컨테이너를 내부적으로 띄워서 h2가 아닌 이 컨테이너와 통신하며 테스트를 진행하는 방식입니다.</p>
<p data-ke-size="size16">초기 이미지 pulling으로 인해 시간이 조금 더 걸릴 수 있습니다.</p>

<h3 data-ke-size="size23"><b>2. gradle 설정</b></h3>
<pre id="code_1699076605805" data-ke-language="bash" data-ke-type="codeblock"><code>testImplementation("org.testcontainers:testcontainers:1.17.3")
testImplementation("org.testcontainers:postgresql:1.17.3")</code></pre>

<h3 data-ke-size="size23"><b>3. application properties 설정</b></h3>
<pre id="code_1699076627999" data-ke-language="bash" data-ke-type="codeblock"><code>//spring-jpa
jpa:
    hibernate:
      ddl-auto: create-drop

//spring-datasource
datasource:
    schema: classpath:init.sql
    driver-class-name: org.testcontainers.jdbc.ContainerDatabaseDriver
    url: jdbc:tc:postgresql:///test-database</code></pre>

<h3 data-ke-size="size23"><b>4. test code - 일부 코드는 비공개처리하였습니다.</b></h3>
<pre id="code_1699076758011" data-ke-language="kotlin" data-ke-type="codeblock"><code>@ActiveProfiles("test")
@DataJpaTest
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)
class ItemRepositoryTest {

    companion object {

        var postgres: PostgreSQLContainer&lt;*&gt; = PostgreSQLContainer(
            "postgres:15-alpine"
        ).apply {
            withDatabaseName("test-database")
        }

        @JvmStatic
        @BeforeAll
        fun beforeAll() {
            postgres.start()
        }

        @JvmStatic
        @AfterAll
        fun afterAll() {
            postgres.stop()
        }
    }

    @Autowired
    private lateinit var entityManager: EntityManager

    private val itemRepository by lazy {
        ItemRepository(
            entityManager
        )
    }

    @Test
    fun `find_all_test`() {
    	val userId = 142L;
        itemRepository.findAllItemByUserId(
        )
    }
}</code></pre>

<h3 data-ke-size="size23"><b>5. 부분 설명 시작</b></h3>
<h4 data-ke-size="size20"><b>5-1. 어노테이션</b></h4>
<pre id="code_1699076791865" data-ke-language="kotlin" data-ke-type="codeblock"><code>@ActiveProfiles("test")
@DataJpaTest
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)
class ItemRepositoryTest {</code></pre>
<p data-ke-size="size16">@DataJpaTest를 사용하는 경우 자동으로 embed된 datasource를 찾게 됩니다. 하지만 우리는 별도의 datasource를 사용하기 때문에 이에 대해 @AutoConfiguraeTesetDatabase를 오버라이딩해서 이를 막아줍니다.</p>

<h4 data-ke-size="size20"><b>5-2. PostgreSqlContainer 설정</b></h4>
<pre id="code_1699076838049" data-ke-language="kotlin" data-ke-type="codeblock"><code>companion object {

        var postgres: PostgreSQLContainer&lt;*&gt; = PostgreSQLContainer(
            "postgres:15-alpine"
        ).apply {
            withDatabaseName("test-database")
        }

        @JvmStatic
        @BeforeAll
        fun beforeAll() {
            postgres.start()
        }

        @JvmStatic
        @AfterAll
        fun afterAll() {
            postgres.stop()
        }
    }</code></pre>
<p data-ke-size="size16">본디 static으로 실행해야 하는 탓에 companion object와 @JvmStatic의 조합으로 이를 가능하게 해 줍니다.</p>
<p data-ke-size="size16">여기서 container는 alpine으로 진행했는데 다른 걸로 해도 별 문제는 없습니다.(아마도)</p>
<p data-ke-size="size16">db의 이름을 test-database라 했는데 별도로 db의 이름이 명시적으로 필요한 경우 위에서의 properties와 함께 수정해서 사용하시면 됩니다.</p>
<p data-ke-size="size16">postgres.start()와 postgres.stop()으로 테스트의 lifecycle에 맞춰 컨테이너에 대한 시작, 종료를 설정합니다.</p>

<h4 data-ke-size="size20"><b>5-3. 아마도..?</b></h4>
<p data-ke-size="size16">필요한 어노테이션과 각 테스트마다 container에 대한 컨트롤이 필요해서 모듈화 시킨 후 진행이 가능하지 않을까 하는 예상이 있습니다.</p>

<h3 data-ke-size="size23"><b>6. 그래서 TestContainer가 뭔데?</b></h3>
<figure data-ke-mobilestyle="widthOrigin" data-origin-width="1462" data-origin-height="1424">
    <span data-url="https://blog.kakaocdn.net/dn/b3gkZ6/btszM2u3qvu/1lYEo1KQEqdxp9Yl0CdRh1/img.png" data-lightbox="lightbox">
        <img src="https://blog.kakaocdn.net/dn/b3gkZ6/btszM2u3qvu/1lYEo1KQEqdxp9Yl0CdRh1/img.png" onerror="this.onerror=null; this.src='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png'; this.srcset='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png';" width="583" height="568" data-origin-width="1462" data-origin-height="1424">
    </span>
    
</figure>

<p data-ke-size="size16">컨테이너를 띄워 테스트를 할 수 있게 해주는 좋은 도구입니다. 근데 이 컨테이너를 java로 띄워서 진행한다는 것이 가장 큰 메리트로 작용합니다. 우리는 별도의 docker설치 없이 dependency를 채워주는 것만으로도 이 편리함을 누릴 수 있습니다.</p>



<p data-ke-size="size16">ref</p>
<p data-ke-size="size16"><a href="https://testcontainers.com/" target="_blank" rel="noopener&nbsp;noreferrer">https://testcontainers.com/</a></p>
<figure id="og_1699077687707" contenteditable="false" data-ke-type="opengraph" data-ke-align="alignCenter" data-og-type="website" data-og-title="Testcontainers" data-og-description="Testcontainers is an opensource framework for providing lightweight, throwaway instances of common databases, Selenium web browsers, or anything else that can run in a Docker container." data-og-host="testcontainers.com" data-og-source-url="https://testcontainers.com/" data-og-url="https://testcontainers.com/" data-og-image="https://scrap.kakaocdn.net/dn/bSy2ts/hyUnNlmRkS/odF8EA2KkeKBVZZ8ISZT70/img.png?width=1200&amp;height=577&amp;face=0_0_1200_577"><a href="https://testcontainers.com/" target="_blank" rel="noopener" data-source-url="https://testcontainers.com/">

<div>
<p data-ke-size="size16">Testcontainers</p>
<p data-ke-size="size16">Testcontainers is an opensource framework for providing lightweight, throwaway instances of common databases, Selenium web browsers, or anything else that can run in a Docker container.</p>
<p data-ke-size="size16">testcontainers.com</p>
</div>
</a><img src="https://scrap.kakaocdn.net/dn/bSy2ts/hyUnNlmRkS/odF8EA2KkeKBVZZ8ISZT70/img.png?width=1200&amp;height=577&amp;face=0_0_1200_577"></figure>

            
            
                </div></div>

흔한 컴공출신 개발자

bernoyoun

0. 이 글의 목적
테스트 환경에서 H2를 사용하다 보니 jsonb같은 dialect를 이해하지 못하는 상황이 발생함
Postgresql95Dialect로 dialect에 대해 설정하는 등 다양한 방법을 시도해 보았으나 실패하다 테스트 DB자체를 바꾸면 되는 거 아닌가 하는 생각으로 구글링과 함께 스타트
 
1. 동작 방식 요약
postgresql 도커 컨테이너를 내부적으로 띄워서 h2가 아닌 이 컨테이너와 통신하며 테스트를 진행하는 방식입니다.
초기 이미지 pulling으로 인해 시간이 조금 더 걸릴 수 있습니다.
 
2. gradle 설정
testImplementation("org.testcontainers:testcontainers:1.17.3")
testImplementation("org.testcontainers:postgresql:1.17.3")
 
3. application properties 설정
//spring-jpa
jpa:
    hibernate:
      ddl-auto: create-drop
//spring-datasource
datasource:
    schema: classpath:init.sql
    driver-class-name: org.testcontainers.jdbc.ContainerDatabaseDriver
    url: jdbc:tc:postgresql:///test-database
 
4. test code - 일부 코드는 비공개처리하였습니다.
@ActiveProfiles("test")
@DataJpaTest
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)
class ItemRepositoryTest {
    companion object {
        var postgres: PostgreSQLContainer<*> = PostgreSQLContainer(
            "postgres:15-alpine"
        ).apply {
            withDatabaseName("test-database")
        }
        @JvmStatic
        @BeforeAll
        fun beforeAll() {
            postgres.start()
        }
        @JvmStatic
        @AfterAll
        fun afterAll() {
            postgres.stop()
        }
    }
    @Autowired
    private lateinit var entityManager: EntityManager
    private val itemRepository by lazy {
        ItemRepository(
            entityManager
        )
    }
    @Test
    fun `find_all_test`() {
    	val userId = 142L;
        itemRepository.findAllItemByUserId(
        )
    }
}
 
5. 부분 설명 시작
5-1. 어노테이션
@ActiveProfiles("test")
@DataJpaTest
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)
class ItemRepositoryTest {
@DataJpaTest를 사용하는 경우 자동으로 embed된 datasource를 찾게 됩니다. 하지만 우리는 별도의 datasource를 사용하기 때문에 이에 대해 @AutoConfiguraeTesetDatabase를 오버라이딩해서 이를 막아줍니다.
 
5-2. PostgreSqlContainer 설정
companion object {
        var postgres: PostgreSQLContainer<*> = PostgreSQLContainer(
            "postgres:15-alpine"
        ).apply {
            withDatabaseName("test-database")
        }
        @JvmStatic
        @BeforeAll
        fun beforeAll() {
            postgres.start()
        }
        @JvmStatic
        @AfterAll
        fun afterAll() {
            postgres.stop()
        }
    }
본디 static으로 실행해야 하는 탓에 companion object와 @JvmStatic의 조합으로 이를 가능하게 해 줍니다.
여기서 container는 alpine으로 진행했는데 다른 걸로 해도 별 문제는 없습니다.(아마도)
db의 이름을 test-database라 했는데 별도로 db의 이름이 명시적으로 필요한 경우 위에서의 properties와 함께 수정해서 사용하시면 됩니다.
postgres.start()와 postgres.stop()으로 테스트의 lifecycle에 맞춰 컨테이너에 대한 시작, 종료를 설정합니다.
 
5-3. 아마도..?
필요한 어노테이션과 각 테스트마다 container에 대한 컨트롤이 필요해서 모듈화 시킨 후 진행이 가능하지 않을까 하는 예상이 있습니다.
 
6. 그래서 TestContainer가 뭔데?
 
컨테이너를 띄워 테스트를 할 수 있게 해주는 좋은 도구입니다. 근데 이 컨테이너를 java로 띄워서 진행한다는 것이 가장 큰 메리트로 작용합니다. 우리는 별도의 docker설치 없이 dependency를 채워주는 것만으로도 이 편리함을 누릴 수 있습니다.
 
 
 
ref
https://testcontainers.com/

[Test] h2대신 postgresql을 DB로 대체해본.ssul

댓글