|
| 1 | +# 테스트 가이드 |
| 2 | + |
| 3 | +## 테스트 성능 최적화 |
| 4 | + |
| 5 | +이 프로젝트는 **Singleton Container 패턴**을 사용하여 테스트 실행 속도를 크게 향상시켰습니다. |
| 6 | + |
| 7 | +### 주요 최적화 사항 |
| 8 | + |
| 9 | +1. **Singleton PostgreSQL Container** |
| 10 | + - 모든 테스트가 하나의 Testcontainers 인스턴스를 공유 |
| 11 | + - 컨테이너는 첫 테스트 실행 시 한 번만 시작되고 JVM 종료 시까지 유지 |
| 12 | + - 테스트 클래스마다 컨테이너를 시작/중지하는 오버헤드 제거 |
| 13 | + |
| 14 | +2. **Flyway 마이그레이션 최적화** |
| 15 | + - 컨테이너당 한 번만 마이그레이션 실행 |
| 16 | + - `baseline-on-migrate: true` 설정으로 이미 마이그레이션된 DB 처리 |
| 17 | + - `clean-disabled: true`로 불필요한 스키마 삭제 방지 |
| 18 | + |
| 19 | +3. **트랜잭션 기반 테스트 격리** |
| 20 | + - `@DataJpaTest`가 자동으로 `@Transactional` 제공 |
| 21 | + - 각 테스트 메서드는 자동으로 롤백되어 독립성 보장 |
| 22 | + - 별도 데이터 정리 로직 불필요 |
| 23 | + |
| 24 | +### 성능 개선 효과 |
| 25 | + |
| 26 | +- **이전**: 리포지토리 테스트 1개당 ~8초 (컨테이너 시작 + Flyway 마이그레이션) |
| 27 | +- **현재**: 첫 테스트 ~8초, 이후 테스트 ~1-2초 |
| 28 | +- **전체 테스트 스위트**: 약 60-70% 시간 단축 |
| 29 | + |
| 30 | +## 리포지토리 테스트 작성 가이드 |
| 31 | + |
| 32 | +### 기본 구조 |
| 33 | + |
| 34 | +```java |
| 35 | +@DataJpaTest // 자동으로 @Transactional 포함 |
| 36 | +@Import(YourRepository.class) |
| 37 | +@ActiveProfiles("test") |
| 38 | +class YourRepositoryTest extends AbstractPostgresContainerTest { |
| 39 | + |
| 40 | + @Autowired |
| 41 | + TestEntityManager em; |
| 42 | + |
| 43 | + @Autowired |
| 44 | + YourRepository repository; |
| 45 | + |
| 46 | + @Test |
| 47 | + void testSomething() { |
| 48 | + // Given |
| 49 | + YourEntity entity = new YourEntity(); |
| 50 | + em.persist(entity); |
| 51 | + em.flush(); |
| 52 | + |
| 53 | + // When |
| 54 | + YourEntity found = repository.findById(entity.getId()).orElseThrow(); |
| 55 | + |
| 56 | + // Then |
| 57 | + assertThat(found).isNotNull(); |
| 58 | + |
| 59 | + // 테스트 종료 시 자동 롤백 - 데이터 정리 불필요 |
| 60 | + } |
| 61 | +} |
| 62 | +``` |
| 63 | + |
| 64 | +### 주의사항 |
| 65 | + |
| 66 | +#### ✅ DO |
| 67 | + |
| 68 | +```java |
| 69 | +@DataJpaTest |
| 70 | +class GoodTest extends AbstractPostgresContainerTest { |
| 71 | + @Test |
| 72 | + void testWithAutoRollback() { |
| 73 | + // 테스트 로직 |
| 74 | + // 자동 롤백됨 - 다음 테스트에 영향 없음 |
| 75 | + } |
| 76 | +} |
| 77 | +``` |
| 78 | + |
| 79 | +#### ❌ DON'T |
| 80 | + |
| 81 | +```java |
| 82 | +@DataJpaTest |
| 83 | +@Commit // ❌ 롤백 비활성화하지 마세요! |
| 84 | +class BadTest extends AbstractPostgresContainerTest { |
| 85 | + @Test |
| 86 | + void testWithCommit() { |
| 87 | + // 데이터가 커밋되어 다른 테스트에 영향 |
| 88 | + } |
| 89 | +} |
| 90 | +``` |
| 91 | + |
| 92 | +```java |
| 93 | +@DataJpaTest |
| 94 | +@Transactional(propagation = Propagation.NOT_SUPPORTED) // ❌ 트랜잭션 비활성화하지 마세요! |
| 95 | +class BadTest extends AbstractPostgresContainerTest { |
| 96 | + @Test |
| 97 | + void testWithoutTransaction() { |
| 98 | + // 테스트 격리 깨짐 |
| 99 | + } |
| 100 | +} |
| 101 | +``` |
| 102 | + |
| 103 | +### 통합 테스트 작성 시 주의사항 |
| 104 | + |
| 105 | +`@SpringBootTest`를 사용하는 통합 테스트에서도 Singleton Container의 혜택을 받을 수 있습니다: |
| 106 | + |
| 107 | +```java |
| 108 | +@SpringBootTest |
| 109 | +@ActiveProfiles("test") |
| 110 | +@Transactional // 명시적으로 추가 필요 |
| 111 | +class IntegrationTest extends AbstractPostgresContainerTest { |
| 112 | + |
| 113 | + @Test |
| 114 | + void integrationTest() { |
| 115 | + // 통합 테스트 로직 |
| 116 | + } |
| 117 | +} |
| 118 | +``` |
| 119 | + |
| 120 | +## 병렬 테스트 실행 |
| 121 | + |
| 122 | +Singleton Container 패턴은 병렬 테스트 실행과 호환됩니다: |
| 123 | + |
| 124 | +```bash |
| 125 | +# Gradle에서 병렬 테스트 실행 |
| 126 | +./gradlew test --parallel --max-workers=4 |
| 127 | +``` |
| 128 | + |
| 129 | +트랜잭션 격리 덕분에 각 테스트가 독립적으로 실행되므로 안전합니다. |
| 130 | + |
| 131 | +## 트러블슈팅 |
| 132 | + |
| 133 | +### Flyway 마이그레이션 충돌 |
| 134 | + |
| 135 | +테스트 실행 중 Flyway 오류가 발생하면: |
| 136 | + |
| 137 | +```yaml |
| 138 | +# application-test.yml |
| 139 | +spring: |
| 140 | + flyway: |
| 141 | + baseline-on-migrate: true |
| 142 | + clean-disabled: true |
| 143 | +``` |
| 144 | +
|
| 145 | +설정이 있는지 확인하세요. |
| 146 | +
|
| 147 | +### 테스트 간 데이터 오염 |
| 148 | +
|
| 149 | +- `@DataJpaTest`가 적용되어 있는지 확인 |
| 150 | +- `@Commit`이나 `@Transactional(propagation = NOT_SUPPORTED)` 사용 여부 확인 |
| 151 | +- 필요시 `@Sql`로 특정 데이터 초기화: |
| 152 | + |
| 153 | +```java |
| 154 | +@Test |
| 155 | +@Sql("/test-data/cleanup.sql") |
| 156 | +void testWithCleanup() { |
| 157 | + // 테스트 로직 |
| 158 | +} |
| 159 | +``` |
| 160 | + |
| 161 | +## 참고 자료 |
| 162 | + |
| 163 | +- [Testcontainers 공식 문서](https://www.testcontainers.org/) |
| 164 | +- [Spring Boot Testing Best Practices](https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#features.testing) |
0 commit comments