Feat/Test Container #364

ChungPlusPlus · 2025-05-07T14:33:44Z

Test Container 추가

한줄 요약

테스트 컨테이너 적용했습니다

상세 설명

testcontainer는 테스트 실행시 컨테이너를 도커로 자동으로 띄워줘 사용할 수 있게 하는 라이브러리입니다
외부 의존성 없이 실제 prod과 유사한 환경에서 테스트 진행이 가능합니다

~~TestContainerInitializer를 사용해서 테스트가 실행 될 때 환경변수를 바꿔주었습니다~~

@ContextConfiguration(initializers = [TestContainerInitializer::class])
어노테이션을 적어준다면 MySQL을 이용해 테스트가 진행됩니다

ServiceConnection 어노테이션을 사용하면 Spring이 자동으로 TestContainer로 띄워진 컨테이너에 연결이 된다고 합니다

@Import(MySQLTestContainerConfig::class)

앞으로 모든 테스트 클래스마다 위 어노테이션을 사용해야 합니다

[9d3e478]: 테스트 환경에서 getLoginUser()가 2번 이상 실행되면 데이터베이스에 같은 이름의 사람을 2번 이상 저장하게 되어 Unique 때문에 오류가 발생해서 고쳤습니다.

TODO

테스트컨테이너 인스턴스를 하나 만들어서 공유하는 방식이라 한 테스트에서 사용했던 데이터가 남아있다는 문제가 있습니다.
예를 들어서, 공지를 추가하고 공지가 1개 있음을 확인하는 테스트가 2개 있다고 해보겠습니다. 현재는 테스트 하나가 끝나도 데이터베이스에는 데이터가 계속 남아있어 다음 테스트에는 공지가 1개 더 추가되어 2개가 생겨버립니다.
이렇게 테스트 코드끼리 서로 간섭할 수 있는 부분을 해결해야 합니다.
reservationService에 동시성 문제가 조금 있는 것 같아 일단 테스트에 주석 처리해뒀습니다

# Conflicts: # src/main/kotlin/com/wafflestudio/csereal/core/main/api/v2/MainController.kt # src/main/kotlin/com/wafflestudio/csereal/core/main/service/MainService.kt

github-actions · 2025-05-07T14:37:18Z

Test Results

16 files 16 suites 1s ⏱️
63 tests 63 ✔️ 0 💤 0 ❌
67 runs 67 ✔️ 0 💤 0 ❌

Results for commit 1f0f499.

♻️ This comment has been updated with latest results.

src/test/kotlin/com/wafflestudio/csereal/global/config/TestMySQLcontainersConfig.kt

huGgW · 2025-05-10T07:56:45Z

테스트컨테이너 인스턴스를 하나 만들어서 공유하는 방식이라 한 테스트에서 사용했던 데이터가 남아있다는 문제가 있습니다.

이 부분은 SpringTestLifeCycle 설정을 통해서 해결될 수 있는 것으로 알고 있습니다..! (확실하진 않음) (다른 서비스 레이어 테스트 코드 참고해주세요..!)

leeeryboy · 2025-05-11T10:28:48Z

src/test/kotlin/com/wafflestudio/csereal/core/main/service/TotalSearchTest.kt

+@SpringBootTest
+@ActiveProfiles("test")
+@ContextConfiguration(initializers = [TestContainerInitializer::class])
+@TestInstance(TestInstance.Lifecycle.PER_CLASS)


TestInstance 어노테이션은 JUnit꺼라 lifecycle이 제대로 적용될지 모르겠네요

추가로 테스트 격리성에 문제가 있으면 kotest 공식 문서랑 아래 블로그 글들 참고해보시면 좋을거 같아요
https://kth990303.tistory.com/374
https://velog.io/@glencode/Kotest%EC%9D%98-Lifecycle-Hook-IsolationMode
testcontainer와 호환이 잘 되는지는 아마 테스트 해봐야할것 같구요

ChungPlusPlus · 2025-05-13T15:56:08Z

Transactional 어노테이션과 extensions(SpringTestExtension(SpringTestLifecycleMode.Root))를 사용해 문제를 해결하려 했으나, 생성한 엔티티가 아예 조회가 안되는 문제가 생겼습니다
이유를 알아보니: 테스트에서 생기는 트랜잭션 속에서 생성한 데이터는 commit되기 전까지 다른 트랜잭션에선 조회되지 않는다. 테스트가 돌아가는 중에 totalSearch가 호출되면 totalSearch는 새로운 트랜잭션에서 이루어진다. 데이터를 생성하는 트랜잭션이 끝나기 전에 다른 트랜잭션에서 totalSearch로 조회를 해보니 조회가 안 된다.

이 문제를 해결하려면 테스트에 트랜잭션을 쓰지 말고, 대신 afterContainer를 이용해 테스트가 끝나고 데이터베이스를 초기화해줘야 한다 생각했습니다.
해당 테스트 코드에서 어느 레퍼지토리를 수정했는지는 알기 힘들기 때문에 CleanUp을 구성해서 전부 truncate를 해주는 방식으로 만들어봤습니다

huGgW · 2025-05-14T15:26:55Z

src/test/kotlin/com/wafflestudio/csereal/common/util/CleanUp.kt

+        return camelCase.replace(Regex("([a-z])([A-Z])"), "$1_$2")
+            .lowercase(Locale.getDefault())


(사실 저희 케이스 정도는 만족해서 마이너 코멘트입니다.)

엣지케이스가 있는 구현인거 같아요.

https://www.baeldung.com/java-camel-snake-case-conversion 에 나온 방법으로 보완하던가

https://github.com/google/guava/wiki/StringsExplained#caseformat 라이브러리 사용이 필요해 보입니다.

(엣지케이스 커버하려면 라이브러리가 나을거 같긴 한데 두 방법 다 괜찮아 보여요)

huGgW · 2025-05-14T15:35:47Z

Transactional 어노테이션과 extensions(SpringTestExtension(SpringTestLifecycleMode.Root))를 사용해 문제를 해결하려 했으나, 생성한 엔티티가 아예 조회가 안되는 문제가 생겼습니다 이유를 알아보니: 테스트에서 생기는 트랜잭션 속에서 생성한 데이터는 commit되기 전까지 다른 트랜잭션에선 조회되지 않는다. 테스트가 돌아가는 중에 totalSearch가 호출되면 totalSearch는 새로운 트랜잭션에서 이루어진다. 데이터를 생성하는 트랜잭션이 끝나기 전에 다른 트랜잭션에서 totalSearch로 조회를 해보니 조회가 안 된다.

이 문제를 해결하려면 테스트에 트랜잭션을 쓰지 말고, 대신 afterContainer를 이용해 테스트가 끝나고 데이터베이스를 초기화해줘야 한다 생각했습니다. 해당 테스트 코드에서 어느 레퍼지토리를 수정했는지는 알기 힘들기 때문에 CleanUp을 구성해서 전부 truncate를 해주는 방식으로 만들어봤습니다

테스트 코드 봤을 때는 내부에서 별도의 transaction을 생성하는 코드는 없는 것으로 보이는데, 어느 부분에서 다른 transaction이 생성된다는 것일까요?
transactional strategy가 별도로 설정된 것도 아니고 async event listener도 아니라서 기존 트렌젝션을 그대로 사용하는 것으로 기억해서요..!

ChungPlusPlus · 2025-05-15T08:02:30Z

Transactional 어노테이션과 extensions(SpringTestExtension(SpringTestLifecycleMode.Root))를 사용해 문제를 해결하려 했으나, 생성한 엔티티가 아예 조회가 안되는 문제가 생겼습니다 이유를 알아보니: 테스트에서 생기는 트랜잭션 속에서 생성한 데이터는 commit되기 전까지 다른 트랜잭션에선 조회되지 않는다. 테스트가 돌아가는 중에 totalSearch가 호출되면 totalSearch는 새로운 트랜잭션에서 이루어진다. 데이터를 생성하는 트랜잭션이 끝나기 전에 다른 트랜잭션에서 totalSearch로 조회를 해보니 조회가 안 된다.
이 문제를 해결하려면 테스트에 트랜잭션을 쓰지 말고, 대신 afterContainer를 이용해 테스트가 끝나고 데이터베이스를 초기화해줘야 한다 생각했습니다. 해당 테스트 코드에서 어느 레퍼지토리를 수정했는지는 알기 힘들기 때문에 CleanUp을 구성해서 전부 truncate를 해주는 방식으로 만들어봤습니다

테스트 코드 봤을 때는 내부에서 별도의 transaction을 생성하는 코드는 없는 것으로 보이는데, 어느 부분에서 다른 transaction이 생성된다는 것일까요? transactional strategy가 별도로 설정된 것도 아니고 async event listener도 아니라서 기존 트렌젝션을 그대로 사용하는 것으로 기억해서요..!

트랜잭션이 새로 생기면 조회가 안 되는 게 설명이 되어서 그렇게 생각했는데, 제가 잘못 생각한 것 같습니다
다시 찾아보니 FULL TEXT INDEX가 트랜잭션이 커밋이 되어야지 생겨서 조회가 안됩니다

ChungPlusPlus · 2025-05-15T15:55:41Z

ServiceConnection 어노테이션을 사용하면 Spring이 자동으로 TestContainer로 띄워진 컨테이너에 연결이 된다고 합니다

@Import(MySQLTestContainerConfig::class)

앞으로 모든 테스트 클래스마다 위 어노테이션을 사용해야 합니다

TODO : reservationService에 동시성 문제가 조금 있는 것 같아 일단 테스트에 주석 처리해뒀습니다

…ch_api

leeeryboy

getLoginUser()에서 동시에 유저 생성할때 이슈가 되어서 해당 함수에서는 test user를 찾도록 하고 각 테스트 내에서 loginUser가 필요한 경우 beforeSpec에서 유저를 미리 생성해서 테스트 진행하도록 리팩토링하였습니다. 필요하시면 [1c70642] 확인하시면 됩니다.

ChungPlusPlus added 8 commits May 7, 2025 23:16

feat: totalSearchApi

03f5761

# Conflicts: # src/main/kotlin/com/wafflestudio/csereal/core/main/api/v2/MainController.kt # src/main/kotlin/com/wafflestudio/csereal/core/main/service/MainService.kt

refactor: TotalSearchResponse

3499eae

feat: searchTotal test code

443bcf0

fix: disable test code

a51f732

feat: TODO

4046ac6

fix: remove unused dependencies

63c0cd2

feat: test container

60d35a1

fix: user could only provided once due to db uniqueness

9d3e478

ChungPlusPlus requested review from leeeryboy and huGgW May 7, 2025 14:33

ChungPlusPlus self-assigned this May 7, 2025

huGgW reviewed May 10, 2025

View reviewed changes

src/test/kotlin/com/wafflestudio/csereal/global/config/TestMySQLcontainersConfig.kt Outdated Show resolved Hide resolved

leeeryboy reviewed May 11, 2025

View reviewed changes

fix: test data reset

b61949e

style: ktlint

ca50fcc

huGgW reviewed May 14, 2025

View reviewed changes

fix: use guava to change CaseFormat

615fa2a

fix: use testcontainer for all test

7ea751d

ChungPlusPlus and others added 4 commits May 16, 2025 01:13

Merge remote-tracking branch 'origin/develop' into feat/combined_sear…

e89a345

…ch_api

fix: apply changes

25d6073

refactor: create test-user beforeSpec if needed

1c70642

ktlint

1f0f499

leeeryboy approved these changes May 18, 2025

View reviewed changes

ChungPlusPlus merged commit efccd3e into develop May 19, 2025
3 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Feat/Test Container #364

Feat/Test Container #364

Uh oh!

ChungPlusPlus commented May 7, 2025 •

edited

Loading

Uh oh!

github-actions bot commented May 7, 2025 •

edited

Loading

Uh oh!

Uh oh!

huGgW commented May 10, 2025 •

edited

Loading

Uh oh!

leeeryboy May 11, 2025 •

edited

Loading

Uh oh!

ChungPlusPlus commented May 13, 2025 •

edited

Loading

Uh oh!

huGgW May 14, 2025

Uh oh!

huGgW commented May 14, 2025

Uh oh!

ChungPlusPlus commented May 15, 2025 •

edited

Loading

Uh oh!

ChungPlusPlus commented May 15, 2025

Uh oh!

leeeryboy left a comment

Uh oh!

Uh oh!

Uh oh!

		return camelCase.replace(Regex("([a-z])([A-Z])"), "$1_$2")
		.lowercase(Locale.getDefault())

Feat/Test Container #364

Feat/Test Container #364

Uh oh!

Conversation

ChungPlusPlus commented May 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Container 추가

한줄 요약

상세 설명

TODO

Uh oh!

github-actions bot commented May 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

Uh oh!

huGgW commented May 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

leeeryboy May 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ChungPlusPlus commented May 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

huGgW May 14, 2025

Choose a reason for hiding this comment

Uh oh!

huGgW commented May 14, 2025

Uh oh!

ChungPlusPlus commented May 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ChungPlusPlus commented May 15, 2025

Uh oh!

leeeryboy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ChungPlusPlus commented May 7, 2025 •

edited

Loading

github-actions bot commented May 7, 2025 •

edited

Loading

huGgW commented May 10, 2025 •

edited

Loading

leeeryboy May 11, 2025 •

edited

Loading

ChungPlusPlus commented May 13, 2025 •

edited

Loading

ChungPlusPlus commented May 15, 2025 •

edited

Loading