Feat(#113): 멀티모듈 테스트 환경 구축

.github/workflows/jib-build-depoly.yml

@@ -72,15 +72,6 @@ jobs:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}
 
-      - name: 🐧 create application.yml
-        run: |
-          mkdir -p ./daepiro-app/src/main/resources
-          cd ./daepiro-app/src/main/resources
-          touch ./application.yml
-          echo "${{ secrets.PROPERTIES_PROD }}" | base64 --decode > ./application.yml
-          ls -la
-        shell: bash
-
       - name: 🐧 create service-account.json
         run: |
           mkdir -p ./daepiro-api/src/main/resources

.gitignore

@@ -28,9 +28,13 @@ out/
 
 **/src/main/resources/service-account.json
 
-*.yml
-application.yml
-application.properties
+### test properties
+!daepiro-api/src/test/resources/application.yml
+!daepiro-auth/src/testFixtures/resources/application-auth-test.yml
+!daepiro-common/src/testFixtures/resources/application-common-test.yml
+!daepiro-core/src/testFixtures/resources/application-core-test.yml
+!daepiro-crawler/src/testFixtures/resources/application-crawler-test.yml
+!daepiro-redis/src/testFixtures/resources/application-redis-test.yml
 
 ### NetBeans ###
 /nbproject/private/

build.gradle

@@ -3,6 +3,7 @@ plugins {
     id 'org.springframework.boot' version '3.1.4'
     id 'io.spring.dependency-management' version '1.1.3'
     id 'com.google.cloud.tools.jib' version '3.4.0'
+    id 'java-test-fixtures'
 }
 
 group = 'com.numberone.backend'
@@ -27,6 +28,8 @@ subprojects {
     apply plugin: 'java-library'
     apply plugin: 'org.springframework.boot'
     apply plugin: 'jacoco'
+    apply plugin: 'java-test-fixtures'
+    apply plugin: 'java'
 
     configurations {
         compileOnly {
@@ -60,6 +63,25 @@ subprojects {
         // swagger
         implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.0.2'
 
+        // aws secret manager
+        implementation 'org.springframework.cloud:spring-cloud-starter-bootstrap:3.1.3'
+        implementation 'org.springframework.cloud:spring-cloud-starter-aws-secrets-manager-config:2.2.6.RELEASE'
+        implementation 'com.amazonaws.secretsmanager:aws-secretsmanager-jdbc:1.0.8'
+
+        // test container
+        testImplementation 'org.testcontainers:testcontainers:1.19.3'
+        testImplementation 'org.testcontainers:junit-jupiter:1.19.3' // junit5
+        testImplementation 'org.testcontainers:mysql' // mysql
+
+        // test
+        testImplementation 'org.springframework.boot:spring-boot-starter-test'
+        testImplementation 'org.junit.jupiter:junit-jupiter-api:5.7.0'
+        testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.7.0'
+
+        testFixturesImplementation 'org.springframework.boot:spring-boot-starter-test'
+
+        testCompileOnly 'org.projectlombok:lombok'
+        testAnnotationProcessor 'org.projectlombok:lombok'
     }
 
 }

daepiro-api/build.gradle

@@ -2,6 +2,10 @@ dependencies {
 	implementation project(':daepiro-core')
 	implementation project(':daepiro-common')
 	implementation project(':daepiro-redis')
+
+	testImplementation(testFixtures(project(':daepiro-core')))
+	testImplementation(testFixtures(project(':daepiro-common')))
+	testImplementation(testFixtures(project(':daepiro-redis')))
 }
 
 bootJar {

daepiro-api/src/main/java/com/numberone/backend/domain/shelter/service/ShelterService.java

@@ -1,10 +1,12 @@
 package com.numberone.backend.domain.shelter.service;
 
+import com.numberone.backend.domain.shelter.ShelterType;
 import com.numberone.backend.domain.shelter.dto.ShelterMapper;
 import com.numberone.backend.domain.shelter.dto.request.NearbyShelterRequest;
-import com.numberone.backend.domain.shelter.dto.response.*;
+import com.numberone.backend.domain.shelter.dto.response.GetShelterDatabaseUrlResponse;
+import com.numberone.backend.domain.shelter.dto.response.NearbyShelterListResponse;
+import com.numberone.backend.domain.shelter.dto.response.NearestShelterResponse;
 import com.numberone.backend.domain.shelter.repository.ShelterRepository;
-import com.numberone.backend.domain.shelter.ShelterType;
 import com.numberone.backend.exception.notfound.NotFoundShelterException;
 import com.numberone.backend.provider.s3.S3Provider;
 import lombok.RequiredArgsConstructor;
@@ -65,7 +67,7 @@ public NearbyShelterListResponse getNearbyShelterList(NearbyShelterRequest reque
         return NearbyShelterListResponse.of(result);
     }
 
-    public GetShelterDatabaseUrlResponse getShelterDatabaseInitUrl(){
+    public GetShelterDatabaseUrlResponse getShelterDatabaseInitUrl() {
         return GetShelterDatabaseUrlResponse.of(s3Provider.getS3FileUrl(databaseUploadPath));
     }
 }

daepiro-api/src/main/resources/application-api.yml

@@ -0,0 +1,45 @@
+spring:
+  config:
+    activate:
+      on-profile: local
+
+  kakao:
+    client-id: ${KAKAO_CLIENT_ID}
+    redirect-uri: ${KAKAO_REDIRECT_URL}
+    token-api-url: ${KAKAO_TOKEN_API_URL}
+    user-api-url: ${KAKAO_USER_API_URL}
+    map-api-url: ${KAKAO_MAP_API_URL}
+
+  naver:
+    client-id: ${NAVER_CLIENT_ID}
+    client-secret: ${NAVER_CLIENT_SECRET}
+    state: ${NAVER_STATE}
+    token-api-url: ${NAVER_TOKEN_API_URL}
+    user-api-url: ${NAVER_USER_API_URL}
+
+storage-path:
+  shelter-database-init-path: ${SHELTER_DATABASE_INIT_PATH}
+
+---
+
+spring:
+  config:
+    activate:
+      on-profile: dev
+
+  kakao:
+    client-id: ${KAKAO_CLIENT_ID}
+    redirect-uri: ${KAKAO_REDIRECT_URL}
+    token-api-url: ${KAKAO_TOKEN_API_URL}
+    user-api-url: ${KAKAO_USER_API_URL}
+    map-api-url: ${KAKAO_MAP_API_URL}
+
+  naver:
+    client-id: ${NAVER_CLIENT_ID}
+    client-secret: ${NAVER_CLIENT_SECRET}
+    state: ${NAVER_STATE}
+    token-api-url: ${NAVER_TOKEN_API_URL}
+    user-api-url: ${NAVER_USER_API_URL}
+
+storage-path:
+  shelter-database-init-path: ${SHELTER_DATABASE_INIT_PATH}

daepiro-api/src/test/java/com/numberone/backend/ServiceIntegrationTestBase.java

@@ -0,0 +1,78 @@
+package com.numberone.backend;
+
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.context.annotation.Import;
+import org.springframework.test.context.DynamicPropertyRegistry;
+import org.springframework.test.context.DynamicPropertySource;
+import org.testcontainers.containers.GenericContainer;
+import org.testcontainers.containers.MySQLContainer;
+import org.testcontainers.junit.jupiter.Container;
+
+
+@Slf4j
+@SpringBootTest(classes = ServiceIntegrationTestConfiguration.class)
+@Import({CoreTestConfiguration.class})
+public abstract class ServiceIntegrationTestBase {
+
+    private static final String REDIS_DOCKER_IMAGE = "redis:5.0.3-alpine";
+    private static final String MYSQL_DOCKER_IMAGE = "mysql:8.0";
+    private static final String MYSQL_ROOT = "root";
+    private static final String MYSQL_PASSWORD = "1234";
+
+    private static final int REDIS_PORT = 6379;
+
+    @Container
+    protected static MySQLContainer mySQLContainer;
+
+    @Container
+    protected static GenericContainer redisContainer;
+
+    @DynamicPropertySource
+    static void configureProperties(final DynamicPropertyRegistry registry) {
+        // mysql env init
+        log.info("""
+                    \n
+                    ✅ mysql property 를 주입합니다.
+                """);
+        registry.add("spring.datasource.url", mySQLContainer::getJdbcUrl);
+        registry.add("spring.datasource.username", () -> MYSQL_ROOT);
+        registry.add("spring.datasource.password", () -> MYSQL_PASSWORD);
+
+        // redis env init
+        log.info("""
+                    \n
+                    ✅ redis property 를 주입합니다.
+                """);
+        registry.add("spring.redis.host", redisContainer::getHost);
+        registry.add("spring.redis.port", () -> "" + redisContainer.getMappedPort(REDIS_PORT));
+    }
+
+    static {
+        // mysql test container init
+        mySQLContainer = (MySQLContainer) new MySQLContainer(MYSQL_DOCKER_IMAGE)
+                .withUsername(MYSQL_ROOT)
+                .withPassword(MYSQL_PASSWORD)
+                .withDatabaseName("test")
+                .withEnv("MYSQL_ROOT_PASSWORD", MYSQL_PASSWORD);
+
+        log.info("""
+                \n
+                🐳 MYSQL 테스트 컨테이너를 시작합니다.
+                - base image: {}
+                """, MYSQL_DOCKER_IMAGE);
+        mySQLContainer.start();
+
+        // redis test container init
+        redisContainer = new GenericContainer<>(REDIS_DOCKER_IMAGE)
+                .withExposedPorts(REDIS_PORT)
+                .withReuse(true);
+        log.info("""
+                \n
+                🐳 Redis 테스트 컨테이너를 시작합니다.
+                - base image: {}
+                """, REDIS_DOCKER_IMAGE);
+        redisContainer.start();
+    }
+
+}

daepiro-api/src/test/java/com/numberone/backend/ServiceIntegrationTestConfiguration.java

@@ -0,0 +1,25 @@
+package com.numberone.backend;
+
+import com.numberone.backend.config.FirebaseConfig;
+import com.numberone.backend.config.S3Config;
+import com.numberone.backend.provider.s3.S3Provider;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.test.context.TestConfiguration;
+import org.springframework.boot.test.mock.mockito.MockBean;
+import org.springframework.test.context.ActiveProfiles;
+
+@ActiveProfiles("test")
+@TestConfiguration
+@SpringBootApplication
+public class ServiceIntegrationTestConfiguration {
+
+    @MockBean
+    private S3Config s3Config;
+
+    @MockBean
+    private S3Provider s3Provider;
+
+    @MockBean
+    private FirebaseConfig firebaseConfig;
+
+}

daepiro-api/src/test/java/com/numberone/backend/domain/shelter/ServiceServiceTest.java

@@ -0,0 +1,36 @@
+package com.numberone.backend.domain.shelter;
+
+import com.numberone.backend.ServiceIntegrationTestBase;
+import com.numberone.backend.domain.shelter.dto.request.NearbyShelterRequest;
+import com.numberone.backend.domain.shelter.dto.response.NearbyShelterListResponse;
+import com.numberone.backend.domain.shelter.entity.Shelter;
+import com.numberone.backend.domain.shelter.repository.ShelterRepository;
+import com.numberone.backend.domain.shelter.service.ShelterService;
+import org.assertj.core.api.Assertions;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+
+public class ServiceServiceTest extends ServiceIntegrationTestBase {
+
+    @Autowired
+    private ShelterService shelterService;
+
+    @Autowired
+    private ShelterRepository shelterRepository;
+
+    @DisplayName("1000 m 이내에 위치한 주변 대피소 리스트를 조회할 수 있습니다.")
+    @Test
+    void getNearestShelterTest() {
+        // given
+        shelterRepository.save(Shelter.of(ShelterType.CIVIL_DEFENCE, "1000m 이내의 대피소 민방위대피소", 35.504, 35.5));
+        shelterRepository.save(Shelter.of(ShelterType.CIVIL_DEFENCE, "1000m 보다 먼 대피소", 36.504, 36.5));
+
+        // when
+        NearbyShelterListResponse response = shelterService.getNearbyShelterList(NearbyShelterRequest.of(35.5, 35.5, "민방위"));
+
+        // then
+        Assertions.assertThat(response.getCount()).isEqualTo(1);
+    }
+
+}

daepiro-api/src/test/resources/application.yml

@@ -0,0 +1,24 @@
+storage-path:
+  shelter-database-init-path: <TEST>
+
+spring:
+  profiles:
+    active: test
+    group:
+      test: core-test,redis-test,auth-test,crawler-test,common-test,api-test
+  output:
+    ansi:
+      enabled: always
+  kakao:
+    client-id: <TEST>
+    redirect-uri: <TEST>
+    token-api-url: <TEST>
+    user-api-url: <TEST>
+    map-api-url: <TEST>
+
+  naver:
+    client-id: <TEST>
+    client-secret: <TEST>
+    state: <TEST>
+    token-api-url: <TEST>
+    user-api-url: <TEST>

daepiro-app/src/main/resources/application.yml

@@ -0,0 +1,36 @@
+spring:
+  profiles:
+    active: local
+    group:
+      local: core,redis,auth,crawler,common,api
+      dev: core,redis,auth,crawler,common,api
+
+---
+
+spring:
+  config:
+    activate:
+      on-profile: local
+
+  servlet:
+    multipart:
+      max-request-size: 30MB
+      max-file-size: 30MB
+
+host:
+  url: ${EC2_HOST_URL}
+
+---
+
+spring:
+  config:
+    activate:
+      on-profile: dev
+
+  servlet:
+    multipart:
+      max-request-size: 30MB
+      max-file-size: 30MB
+
+host:
+  url: ${EC2_HOST_URL}

daepiro-app/src/main/resources/bootstrap.yml

@@ -0,0 +1,7 @@
+aws:
+  secretsmanager:
+    name: numberone
+cloud:
+  aws:
+    region:
+      static: ap-northeast-2

daepiro-auth/src/main/resources/application-auth.yml

@@ -0,0 +1,7 @@
+spring:
+  jwt:
+    secret: ${JWT_SECRET_KEY}
+
+  token:
+    refresh: ${JWT_REFRESH}
+    access: ${JWT_ACCESS}

daepiro-auth/src/testFixtures/resources/application-auth-test.yml

@@ -0,0 +1,7 @@
+spring:
+  jwt:
+    secret: <DAEPIRO_THIS_IS_A_TEST_JWT_SECRET_KEY>
+
+  token:
+    refresh: 3600000 # for test
+    access: 1800000 # for test