[4팀] 백엔드 코드리뷰용 PR

.github/ISSUE_TEMPLATE/issue_template.md

@@ -0,0 +1,20 @@
+---
+name: "\bIssue 생성 템플릿"
+about: 해당 Issue 생성 템플릿을 통하여 Issue를 생성해주세요.
+title: 'Feat: Issue 제목'
+labels: ''
+assignees: ''
+
+---
+
+### 📝 Description
+
+- 구현할 내용 1
+- 구현할 내용 2
+
+---
+
+### 📝 Todo
+
+- [ ] 구현할 내용 1
+- [ ] 구현할 내용 2

.github/pull_request_template.md

@@ -0,0 +1,35 @@
+## ✅ PR 유형
+어떤 변경 사항이 있었나요?
+
+- [ ] 새로운 기능 추가
+- [ ] 버그 수정
+- [ ] 코드에 영향을 주지 않는 변경사항(오타 수정, 탭 사이즈 변경, 변수명 변경)
+- [ ] 코드 리팩토링
+- [ ] 주석 추가 및 수정
+- [ ] 문서 수정
+- [ ] 빌드 부분 혹은 패키지 매니저 수정
+- [ ] 파일 혹은 폴더명 수정
+- [ ] 파일 혹은 폴더 삭제
+
+---
+
+## 📝 작업 내용
+이번 PR에서 작업한 내용을 간략히 설명해주세요(이미지 첨부 가능)
+
+- 작업한 내용 1
+- 작업한 내용 2
+
+---
+
+## ✏️ 관련 이슈
+본인이 작업한 내용이 어떤 Issue Number와 관련이 있는지만 작성해주세요
+
+ex)
+- Fixes : #00 (수정중인 이슈)
+- Resolves : #100 (무슨 이슈를 해결했는지)
+- Ref : #00 #01 (참고할 이슈)
+- Related to : #00 #01 (해당 커밋과 관련)
+
+---
+
+## 🎸 기타 사항 or 추가 코멘트

.github/workflows/deploy.yml

@@ -0,0 +1,114 @@
+name: Sarang Backend CI/CD
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v4
+
+      - name: Set up SSH key
+        uses: webfactory/[email protected]
+        with:
+          ssh-private-key: ${{ secrets.EC2_SSH_PRIVATE_KEY }}
+
+      - name: Gradle 캐시 적용
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.gradle/caches
+            ~/.gradle/wrapper
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
+          restore-keys: |
+            ${{ runner.os }}-gradle
+
+      - name: JDK 17 세팅
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+
+      - name: YML 파일 세팅 및 fcm.json 주입
+        env:
+          APPLICATION_PROPERTIES: ${{ secrets.APPLICATION_PROPERTIES }}
+          TEST_APPLICATION_PROPERTIES: ${{ secrets.TEST_APPLICATION_PROPERTIES }}
+          ERROR_MESSAGES_PROPERTIES: ${{ secrets.ERROR_MESSAGES_PROPERTIES }}
+          FCM_JSON: ${{secrets.FCM_JSON}}
+        run: |
+          cd ./src
+          rm -rf main/resources/application.yml
+          mkdir -p test/resources
+          mkdir -p main/resources
+          mkdir -p main/resources/firebase
+          echo "$APPLICATION_PROPERTIES" > main/resources/application.yml
+          echo "$ERROR_MESSAGES_PROPERTIES" > main/resources/api-error-messages.properties
+          echo "$FCM_JSON" > main/resources/firebase/fcm.json
+          echo "$TEST_APPLICATION_PROPERTIES" > test/resources/application.yml
+
+      - name: gradlew 권한 부여
+        run: chmod +x gradlew
+
+      - name: 테스트 수행
+        run: ./gradlew test
+
+      - name: 테스트 리포트 아티팩트 업로드
+        if: failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-report
+          path: build/reports/tests/test
+
+      - name: 스프링부트 빌드
+        run: ./gradlew build
+
+      - name: Docker Buildx 세팅
+        uses: docker/setup-buildx-action@v3
+
+      - name: 도커 로그
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+
+      - name: 도커 이미지 빌드 후 푸시
+        if: success()
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: ./Dockerfile
+          push: true
+          tags: ${{ secrets.DOCKERHUB_USERNAME }}/sarang-backend:${{ github.sha }}
+          platforms: linux/amd64,linux/arm64
+
+      - name: Docker Compose 파일 EC2 서버로 전송
+        run: scp -o StrictHostKeyChecking=no -P ${{ secrets.EC2_PORT }} docker-compose.yml ${{ secrets.EC2_USER }}@${{ secrets.EC2_HOST }}:./
+
+      - name: Docker Compose Mornitoring 파일 EC2 서버로 전송
+        run: scp -o StrictHostKeyChecking=no -P ${{ secrets.EC2_PORT }} ./observability/docker-compose.monitoring.yml ${{ secrets.EC2_USER }}@${{ secrets.EC2_HOST }}:~/observability/
+
+      - name: EC2 접속 후 이미지 다운로드 및 배포
+        if: success()
+        uses: appleboy/ssh-action@master
+        with:
+          host: ${{ secrets.EC2_HOST }}
+          username: ${{ secrets.EC2_USER }}
+          key: ${{ secrets.EC2_SSH_PRIVATE_KEY }}
+          port: ${{ secrets.EC2_PORT }}
+          script: |
+            echo "DOCKER_CONTAINER_REGISTRY=${{ secrets.DOCKERHUB_USERNAME }}" > .env
+            echo "DOCKERHUB_PASSWORD=${{secrets.DOCKERHUB_PASSWORD}}" >> .env
+            echo "GITHUB_SHA=${{ github.sha }}" >> .env
+            echo "MINIO_ROOT_USER=${{secrets.MINIO_ROOT_USER}}" >> .env
+            echo "MINIO_ROOT_PASSWORD=${{secrets.MINIO_ROOT_PASSWORD}}" >> .env
+            echo "MINIO_SERVER_URL=${{secrets.MINIO_SERVER_URL}}" >> .env
+            echo "MINIO_BROWSER_REDIRECT_URL=${{secrets.MINIO_BROWSER_REDIRECT_URL}}" >> .env
+            echo "GF_SECURITY_ADMIN_PASSWORD=${{secrets.GF_SECURITY_ADMIN_PASSWORD}}" >> .env
+            echo "HOST_LOG_DIR=${{secrets.HOST_LOG_DIR}}" >> .env
+            chmod 600 .env
+            sudo chmod +x ./deploy.sh
+            ./deploy.sh

.gitignore

@@ -48,3 +48,4 @@ src/test/resources/application-test.yml
 .env
 
 api-error-messages.properties
+.json

Dockerfile

@@ -0,0 +1,6 @@
+FROM openjdk:17.0.1-jdk-slim
+WORKDIR /app
+COPY ./build/libs/backend-0.0.1-SNAPSHOT.jar /app/backend.jar
+EXPOSE 80
+ENTRYPOINT ["java"]
+CMD ["-jar", "backend.jar"]

build.gradle.kts

@@ -1,14 +1,19 @@
 plugins {
-    kotlin("jvm") version "1.9.25"
-    kotlin("plugin.spring") version "1.9.25"
-    kotlin("plugin.jpa") version "1.9.25"
+    kotlin("jvm") version "2.1.0"
+    kotlin("plugin.spring") version "2.1.0"
+    kotlin("plugin.jpa") version "2.1.0"
+    kotlin("plugin.allopen") version "2.1.0"
+    kotlin("plugin.serialization") version "2.1.0"
     id("org.springframework.boot") version "3.4.3"
     id("io.spring.dependency-management") version "1.1.7"
 }
 
 group = "gomushin"
 version = "0.0.1-SNAPSHOT"
 
+val mockkVersion = "1.13.10"
+val kotestVersion = "5.5.4"
+
 java {
     toolchain {
         languageVersion = JavaLanguageVersion.of(17)
@@ -32,18 +37,65 @@ dependencies {
     // mysql
     runtimeOnly("mysql:mysql-connector-java:8.0.33")
 
+    // h2
+    runtimeOnly("com.h2database:h2")
+
     // swagger
-    implementation("org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.1")
+    implementation("org.springdoc:springdoc-openapi-starter-webmvc-ui:2.7.0")
 
     // mail
     implementation("org.springframework.boot:spring-boot-starter-mail")
 
     // logging
     implementation("io.github.microutils:kotlin-logging:2.0.11")
 
+    // cache
+    implementation("org.springframework.boot:spring-boot-starter-cache:3.3.10")
+    implementation("com.github.ben-manes.caffeine:caffeine:3.1.8")
+
+    // redis
+    implementation("org.springframework.boot:spring-boot-starter-data-redis:3.3.10")
+    implementation("org.redisson:redisson:3.44.0")
+
+    //security
+    implementation("org.springframework.boot:spring-boot-starter-security")
+
+    //jwt
+    implementation("io.jsonwebtoken:jjwt-api:0.12.6")
+    implementation("io.jsonwebtoken:jjwt-impl:0.12.6")
+    implementation("io.jsonwebtoken:jjwt-jackson:0.12.6")
+
+    // oauth2
+    implementation("org.springframework.boot:spring-boot-starter-oauth2-client")
+
+    // configuration processor
+    annotationProcessor("org.springframework.boot:spring-boot-configuration-processor")
+
+    // aws
+    implementation("software.amazon.awssdk:s3:2.30.38")
+
+    //okhttp3
+    implementation("com.squareup.okhttp3:okhttp:4.12.0")
+
+    //google auth
+    implementation("com.google.auth:google-auth-library-oauth2-http:1.33.1")
+
+    //coroutine
+    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.3")
+
+    //serializable
+    implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.8.1")
+
+    //logback-encoder
+    implementation ("net.logstash.logback:logstash-logback-encoder:7.4")
+
     implementation("org.springframework.boot:spring-boot-starter-validation")
     testImplementation("org.springframework.boot:spring-boot-starter-test")
+    testImplementation("org.mockito.kotlin:mockito-kotlin:5.0.0")
     testImplementation("org.jetbrains.kotlin:kotlin-test-junit5")
+    testImplementation("io.mockk:mockk:${mockkVersion}")
+    testImplementation("io.kotest:kotest-runner-junit5:$kotestVersion")
+    testImplementation("io.kotest:kotest-assertions-core:$kotestVersion")
     testRuntimeOnly("org.junit.platform:junit-platform-launcher")
 }
 
@@ -55,8 +107,9 @@ kotlin {
 
 allOpen {
     annotation("jakarta.persistence.Entity")
-    annotation("jakarta.persistence.MappedSuperclass")
     annotation("jakarta.persistence.Embeddable")
+    annotation("jakarta.persistence.MappedSuperclass")
+    annotation("org.springframework.stereotype.Component")
 }
 
 tasks.withType<Test> {

docker-compose-minio.yml

@@ -0,0 +1,16 @@
+version: '3.8'
+services:
+  minio:
+    image: quay.io/minio/minio
+    command: server /data --console-address ":9001"
+    environment:
+      - MINIO_ROOT_USER=admin
+      - MINIO_ROOT_PASSWORD=12345678
+    volumes:
+      - minio_data:/data
+    ports:
+      - "9000:9000"
+      - "9001:9001"
+    restart: always
+volumes:
+  minio_data:

docker-compose.yml

@@ -0,0 +1,83 @@
+version: "3.8"
+
+services:
+  blue:
+    image: "${DOCKER_CONTAINER_REGISTRY}/sarang-backend:${GITHUB_SHA}"
+    container_name: sarang-backend-blue
+    environment:
+      TZ: Asia/Seoul
+    ports:
+      - '8080:8080'
+    volumes:
+      - ${HOST_LOG_DIR:-./logs}:/my/logs
+    depends_on:
+      - redis
+      - minio
+    networks:
+      - sarang-backend-network
+
+  green:
+    image: "${DOCKER_CONTAINER_REGISTRY}/sarang-backend:${GITHUB_SHA}"
+    container_name: sarang-backend-green
+    environment:
+      TZ: Asia/Seoul
+    ports:
+      - '8081:8080'
+    volumes:
+      - ${HOST_LOG_DIR:-./logs}:/my/logs
+    depends_on:
+      - redis
+      - minio
+    networks:
+      - sarang-backend-network
+
+  redis:
+    image: redis:6.0.9
+    container_name: redis
+    ports:
+      - '6379:6379'
+    volumes:
+      - redis-data:/data
+    networks:
+      - sarang-backend-network
+
+  minio:
+    image: quay.io/minio/minio
+    container_name: minio
+    command: server /data --console-address ":9001"
+    environment:
+      MINIO_ROOT_USER: ${MINIO_ROOT_USER}
+      MINIO_ROOT_PASSWORD: ${MINIO_ROOT_PASSWORD}
+      MINIO_SERVER_URL: ${MINIO_SERVER_URL}
+      MINIO_BROWSER_REDIRECT_URL: ${MINIO_BROWSER_REDIRECT_URL}
+
+    volumes:
+      - minio_data:/data
+    ports:
+      - "9002:9000"
+      - "9003:9001"
+    networks:
+      - sarang-backend-network
+    restart: unless-stopped
+
+  mc:
+    image: minio/mc
+    depends_on:
+      - minio
+    entrypoint: >
+      /bin/sh -c "
+        until mc alias set myminio http://minio:9000 ${MINIO_ROOT_USER} ${MINIO_ROOT_PASSWORD}; do echo 'MinIO 아직 준비 안됨...'; sleep 5; done;
+        mc mb -p myminio/gomushin;
+        mc anonymous set download myminio/gomushin;
+        exit 0;
+      "
+    networks:
+      - sarang-backend-network
+
+volumes:
+  redis-data:
+  minio_data:
+
+networks:
+  sarang-backend-network:
+    driver: bridge