[Test] TestContainers와 H2로 DB 테스트하기

.github/workflows/pr-ci.yaml

@@ -0,0 +1,59 @@
+name: PR 시 CI 테스트 자동화
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+
+    permissions:
+      checks: write
+      pull-requests: write
+
+    steps:
+      - name: 레포지토리 체크아웃
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GIT_TOKEN }}
+      - run: touch ./src/main/resources/security.properties
+      - run: echo "${{ secrets.SECURITY_PROP }}" > ./src/main/resources/security.properties
+
+      - name: JDK 17 설치
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'oracle'
+          java-version: '17'
+          cache: 'gradle'
+
+      - name: Gradle 종속성 캐시
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.gradle/caches
+            ~/.gradle/wrapper
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
+          restore-keys: |
+            ${{ runner.os }}-gradle-
+
+      - name: Gradle 명령 실행 권한 부여
+        run: chmod +x ./gradlew
+        shell: bash
+
+      - name: Gradle로 프로젝트 Build
+        run: ./gradlew build
+
+      - name: 테스트 결과를 PR 코멘트로 출력
+        uses: EnricoMi/publish-unit-test-result-action@v2
+        if: always()
+        with:
+          files: '**/build/test-results/test/TEST-*.xml'
+
+      - name: 테스트 실패 시, 오류가 발생한 코드 라인에 코멘트 추가
+        uses: mikepenz/action-junit-report@v4
+        if: always()
+        with:
+          report_paths: '**/build/test-results/test/TEST-*.xml'

build.gradle

@@ -36,35 +36,41 @@ dependencies {
 
 	// Mail
 	implementation 'org.springframework.boot:spring-boot-starter-mail'
+	testImplementation 'com.icegreen:greenmail-junit5:2.1.1'
+	testImplementation 'commons-codec:commons-codec:1.17.1'
 
 	// Security
 	implementation 'org.springframework.boot:spring-boot-starter-security'
 
 	// DB
 	implementation 'org.mariadb.jdbc:mariadb-java-client:3.1.2'
+	runtimeOnly 'com.h2database:h2'
 
-	// Redis 추가
+	// Redis 
 	implementation 'org.springframework.boot:spring-boot-starter-data-redis'
 
 	// Swagger
 	implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.1.0'
 
-	//jwt
+	// JWT
 	implementation 'io.jsonwebtoken:jjwt-api:0.11.5'
 	implementation 'io.jsonwebtoken:jjwt-impl:0.11.5'
 	implementation 'io.jsonwebtoken:jjwt-jackson:0.11.5'
 
-	// mybatis
+	// MyBatis
 	implementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter:3.0.4'
 
-	// lombok
+	// Lombok
 	annotationProcessor 'org.projectlombok:lombok'
 	compileOnly 'org.projectlombok:lombok'
 
-	// test
+	// Test
 	testImplementation 'org.springframework.boot:spring-boot-starter-test'
 	testImplementation 'org.springframework.security:spring-security-test'
 	testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
+	testImplementation 'org.springframework.boot:spring-boot-testcontainers'
+	testImplementation 'org.testcontainers:testcontainers'
+	testImplementation 'org.testcontainers:junit-jupiter'
 
 	//Querydsl 추가
 	implementation 'com.querydsl:querydsl-jpa:5.0.0:jakarta'

src/main/java/com/example/shop/ShopApplication.java

@@ -7,7 +7,6 @@
 import org.springframework.data.jpa.repository.config.EnableJpaAuditing;
 
 @SpringBootApplication
-@EnableJpaAuditing
 @PropertySource("classpath:security.properties")
 public class ShopApplication {
 

src/main/java/com/example/shop/auth/controller/AuthController.java

@@ -12,7 +12,7 @@
 import org.springframework.web.bind.annotation.*;
 
 @Tag(name="Auth")
-@RestController()
+@RestController
 @RequiredArgsConstructor
 @RequestMapping(value = "/api/auth")
 public class AuthController {

src/main/java/com/example/shop/global/config/db/JpaConfig.java

@@ -0,0 +1,9 @@
+package com.example.shop.global.config.db;
+
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.jpa.repository.config.EnableJpaAuditing;
+
+@Configuration
+@EnableJpaAuditing
+public class JpaConfig {
+}

src/main/java/com/example/shop/global/config/db/RedisConfig.java

@@ -4,6 +4,7 @@
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Profile;
 import org.springframework.data.redis.connection.RedisConnectionFactory;
 import org.springframework.data.redis.connection.RedisStandaloneConfiguration;
 import org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory;
@@ -12,6 +13,7 @@
 import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
 import org.springframework.data.redis.serializer.StringRedisSerializer;
 
+@Profile("!test")
 @Configuration
 @EnableRedisRepositories
 public class RedisConfig {

src/test/java/com/example/shop/ShopApplicationTests.java

@@ -1,9 +1,11 @@
 package com.example.shop;
 
 import org.junit.jupiter.api.Test;
+import org.springframework.boot.test.autoconfigure.jdbc.AutoConfigureTestDatabase;
 import org.springframework.boot.test.context.SpringBootTest;
 
 @SpringBootTest
+@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.ANY)
 class ShopApplicationTests {
 
 	@Test

src/test/java/com/example/shop/admin/dao/OrderDeliveryRepositoryTest.java

@@ -1,21 +1,25 @@
 package com.example.shop.admin.dao;
 
 import com.example.shop.admin.dto.OrderDeliveryRequest;
+import com.example.shop.global.setting.RedisTest;
 import org.assertj.core.api.SoftAssertions;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.jdbc.AutoConfigureTestDatabase;
 import org.springframework.boot.test.context.SpringBootTest;
 
 import java.util.Set;
 
 import static com.example.shop.batch.util.OrderDeliveryBatchUtil.getOrderKeyYesterday;
 import static org.assertj.core.api.Assertions.assertThat;
 
+
 @SpringBootTest
-class OrderDeliveryRepositoryTest {
+@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.ANY)
+class OrderDeliveryRepositoryTest extends RedisTest {
 
     @Autowired
     private OrderDeliveryRepository orderDeliveryRepository;

src/test/java/com/example/shop/batch/OrderUpdateSenderWriterTest.java

@@ -7,55 +7,45 @@
 import com.example.shop.domain.order.Order;
 import com.example.shop.domain.order.OrderRepository;
 import com.example.shop.domain.order.OrderStatus;
-import com.example.shop.domain.user.Role;
-import com.example.shop.domain.user.User;
-import com.example.shop.domain.user.UserRepository;
+import com.example.shop.global.setting.ServiceTest;
 import org.apache.ibatis.session.ExecutorType;
 import org.apache.ibatis.session.SqlSession;
 import org.apache.ibatis.session.SqlSessionFactory;
 import org.assertj.core.api.SoftAssertions;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.junit.jupiter.MockitoExtension;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.boot.test.context.SpringBootTest;
-import org.springframework.transaction.annotation.Transactional;
+import org.springframework.boot.test.mock.mockito.MockBean;
+import org.springframework.test.context.jdbc.Sql;
 
-import java.util.ArrayList;
 import java.util.List;
 
 import static com.example.shop.batch.util.OrderDeliveryBatchUtil.getOrderKeyYesterday;
+import static org.mockito.Mockito.doNothing;
 
-@Transactional
-@SpringBootTest
-class OrderUpdateSenderWriterTest {
 
-    @Autowired
+@ExtendWith(MockitoExtension.class)
+@Sql(scripts = "classpath:/sql/order-data.sql",
+        executionPhase = Sql.ExecutionPhase.BEFORE_TEST_METHOD)
+class OrderUpdateSenderWriterTest extends ServiceTest {
+
+    @MockBean
     private AdminOrderService adminOrderService;
     @Autowired
     private OrderDeliveryRepository orderDeliveryRepository;
     @Autowired
     private SqlSessionFactory sqlSessionFactory;
     @Autowired
     private OrderRepository orderRepository;
-    @Autowired
-    private UserRepository userRepository;
 
     @BeforeEach
     void setup() {
-        User user = User.builder()
-                .email("[email protected]")
-                .password("test")
-                .userRole(Role.ROLE_USER)
-                .orders(new ArrayList<>())
-                .userName("tester")
-                .build();
-
-        user = userRepository.save(user);
-
-        for (long i = 1; i <= 532; i++) {
+        for (long i = 1; i <= 5; i++) {
             orderDeliveryRepository.addOrderEmail(getOrderKeyYesterday(),
-                    new OrderDeliveryRequest(user.getEmail(), i+"test"));
+                    new OrderDeliveryRequest("[email protected]", i+"test"));
         }
     }
 
@@ -70,7 +60,7 @@ void write() {
             sqlSession.flushStatements();
 
         } finally {
-            orderDeliveryRequestList.forEach(adminOrderService::sendDeliveryAlertEmail);
+            orderDeliveryRequestList.forEach(doNothing().when(adminOrderService)::sendDeliveryAlertEmail);
             orderDeliveryRepository.removeOrderEmail(getOrderKeyYesterday(), orderDeliveryRequestList.toArray());
         }
 

src/test/java/com/example/shop/global/config/RedisTestConfig.java

@@ -0,0 +1,30 @@
+package com.example.shop.global.config;
+
+import com.example.shop.admin.dto.OrderDeliveryRequest;
+import org.springframework.boot.test.context.TestConfiguration;
+import org.springframework.context.annotation.Bean;
+import org.springframework.data.redis.connection.RedisConnectionFactory;
+import org.springframework.data.redis.core.RedisTemplate;
+import org.springframework.data.redis.repository.configuration.EnableRedisRepositories;
+import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
+import org.springframework.data.redis.serializer.StringRedisSerializer;
+
+@TestConfiguration
+@EnableRedisRepositories
+public class RedisTestConfig {
+
+    @Bean
+    public RedisTemplate<?, ?> redisTemplate(RedisConnectionFactory connectionFactory) {
+        RedisTemplate<byte[], byte[]> redisTemplate = new RedisTemplate<>();
+        redisTemplate.setConnectionFactory(connectionFactory);
+
+        // JSON 형식으로 직렬화
+        Jackson2JsonRedisSerializer<OrderDeliveryRequest> serializer = new Jackson2JsonRedisSerializer<>(OrderDeliveryRequest.class);
+        redisTemplate.setKeySerializer(new StringRedisSerializer());
+        redisTemplate.setValueSerializer(serializer);
+        redisTemplate.setHashKeySerializer(new StringRedisSerializer());
+        redisTemplate.setHashValueSerializer(serializer);
+
+        return redisTemplate;
+    }
+}

src/test/java/com/example/shop/global/config/RedisTestContainer.java

@@ -0,0 +1,28 @@
+package com.example.shop.global.config;
+
+import org.springframework.test.context.DynamicPropertyRegistry;
+import org.springframework.test.context.DynamicPropertySource;
+import org.testcontainers.containers.GenericContainer;
+import org.testcontainers.junit.jupiter.Testcontainers;
+import org.testcontainers.utility.DockerImageName;
+
+@Testcontainers
+public class RedisTestContainer {
+
+    private static final String REDIS_IMAGE = "redis:7.4.1-alpine";
+    private static final int REDIS_PORT = 6379;
+    private static final GenericContainer<?> REDIS_CONTAINER;
+
+    static {
+        REDIS_CONTAINER = new GenericContainer<>(DockerImageName.parse(REDIS_IMAGE))
+                .withExposedPorts(REDIS_PORT)
+                .withReuse(true);
+        REDIS_CONTAINER.start();
+    }
+
+    @DynamicPropertySource
+    private static void registerRedisProperties(DynamicPropertyRegistry registry) {
+        registry.add("spring.data.redis.host", REDIS_CONTAINER::getHost);
+        registry.add("spring.data.redis.port", () -> REDIS_CONTAINER.getMappedPort(REDIS_PORT));
+    }
+}

src/test/java/com/example/shop/global/setting/ControllerTest.java

@@ -0,0 +1,63 @@
+package com.example.shop.global.setting;
+
+import com.example.shop.admin.controller.AdminOrderController;
+import com.example.shop.admin.controller.AdminProductController;
+import com.example.shop.admin.service.AdminOrderService;
+import com.example.shop.admin.service.AdminProductService;
+import com.example.shop.auth.controller.AuthController;
+import com.example.shop.auth.service.AuthService;
+import com.example.shop.global.config.auth.JwtAuthenticationFilter;
+import com.example.shop.user.controller.CartController;
+import com.example.shop.user.controller.OrderController;
+import com.example.shop.user.controller.ProductController;
+import com.example.shop.user.service.CartService;
+import com.example.shop.user.service.OrderService;
+import com.example.shop.user.service.ProductService;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.junit.jupiter.MockitoExtension;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
+import org.springframework.boot.test.mock.mockito.MockBean;
+import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.web.servlet.MockMvc;
+
+@ActiveProfiles("test")
+@ExtendWith(MockitoExtension.class)
+@WebMvcTest({
+        AdminOrderController.class,
+        AdminProductController.class,
+        AuthController.class,
+        CartController.class,
+        OrderController.class,
+        ProductController.class
+})
+public abstract class ControllerTest {
+
+    @Autowired
+    protected MockMvc mockMvc;
+
+    @Autowired
+    protected ObjectMapper objectMapper;
+
+    @MockBean
+    protected JwtAuthenticationFilter jwtAuthenticationFilter;
+
+    @MockBean
+    protected AdminOrderService adminOrderService;
+
+    @MockBean
+    protected AdminProductService adminProductService;
+
+    @MockBean
+    protected AuthService authService;
+
+    @MockBean
+    protected CartService cartService;
+
+    @MockBean
+    protected OrderService orderService;
+
+    @MockBean
+    protected ProductService productService;
+}