Merge pull request #56 from Re-4aliens/develop

2024-02-12 [Release Note]
Re-4aliens · Feb 12, 2024 · 7fc4972 · 7fc4972
2 parents 13eafb0 + aca32a1
commit 7fc4972
Show file tree

Hide file tree

Showing 151 changed files with 5,477 additions and 460 deletions.
diff --git a/.github/workflows/friendship-pipeline.yml b/.github/workflows/friendship-pipeline.yml
@@ -18,33 +18,39 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
-      - name: Set up JDK 17
+      - name: JDK 17 설치
         uses: actions/setup-java@v3
         with:
           java-version: '17'
           distribution: 'temurin'
 
       # 설정 파일 추가
-      - name: make application-secret.yml
+      - name: application-secret.yml 구성
         run: |
           cd ./src/main/resources
           touch ./application-secret.yml
           echo "${{ secrets.APPLICATION_SECRET }}" > ./application-secret.yml
 
-      - name: Grant execute permission for gradlew
+      - name: firebase_service_key.json 구성
+        run: |
+          cd ./src/main/resources
+          touch ./firebase_service_key.json
+          echo "${{ secrets.FCM_KEY }}" > ./firebase_service_key.json
+
+      - name: gradlew 실행 권한 부여
         run: chmod +x gradlew
 
-      - name: Build with Gradle
-        run: ./gradlew build
+      - name: Gradle 빌드
+        run: ./gradlew build -x test
 
-      - name: Docker build
+      - name: Docker 이미지 파일 PUSH
         run: |
           docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_PASSWORD }}
           docker build --platform linux/arm64/v8 -t app .
           docker tag app ${{ secrets.DOCKER_USERNAME }}/${{ env.APP_NAME }}:latest
           docker push ${{ secrets.DOCKER_USERNAME }}/${{ env.APP_NAME }}:latest
 
-      - name: Deploy
+      - name: AWS 배포
         uses: appleboy/ssh-action@master
         with:
           host: ${{ secrets.HOST }} # EC2 인스턴스 퍼블릭 DNS

diff --git a/.github/workflows/test-pipeline.yml b/.github/workflows/test-pipeline.yml
@@ -0,0 +1,53 @@
+name: test
+
+on:
+  push:
+    branches: [ develop ]
+  pull_request:
+    branches: [ develop ]
+
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: JDK 17 설치
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+
+      - name: secret 설정 파일(yml) 추가
+        run: |
+          cd ./src/main/resources
+          touch ./application-secret.yml
+          echo "${{ secrets.APPLICATION_SECRET }}" > ./application-secret.yml
+          ls -a .
+
+      - name: firebase_service_key.json 구성
+        run: |
+          cd ./src/main/resources
+          touch ./firebase_service_key.json
+          echo "${{ secrets.FCM_KEY }}" > ./firebase_service_key.json
+          ls -a .
+
+      - name: firebase_service_key.json 파일 생성
+        id: create-json
+        uses: jsdaniell/[email protected]
+        with:
+          name: "firebase_service_key.json"
+          json: ${{ secrets.FCM_KEY }}
+
+
+      - name: JSON 파일 이동 및 로그 확인
+        run: |
+          mv ./firebase_service_key.json ./src/main/resources/firebase_service_key.json
+          cd ./src/main/resources
+          ls -a .
+
+      - name: Gradle 권한 허용
+        run: chmod +x gradlew
+      - name: PR 및 PUSH 전, 테스트 확인
+        run: ./gradlew test
diff --git a/.gitignore b/.gitignore
@@ -5,6 +5,7 @@ build/
 !**/src/main/**/build/
 !**/src/test/**/build/
 src/main/resources/application-secret.yml
+src/main/resources/firebase_service_key.json
 
 ### STS ###
 .apt_generated

diff --git a/build.gradle b/build.gradle
@@ -46,6 +46,15 @@ dependencies {
 
     //SMTP
     implementation 'org.springframework.boot:spring-boot-starter-mail'
+
+    //WEBSOCKET
+    implementation 'org.springframework.boot:spring-boot-starter-websocket'
+
+    //MONGO_DB
+    implementation 'org.springframework.boot:spring-boot-starter-data-mongodb'
+
+    //FCM
+    implementation 'com.google.firebase:firebase-admin:9.1.1'
 }
 
 ext {
@@ -71,4 +80,4 @@ bootJar {
 
 tasks.named('test') {
     useJUnitPlatform()
-}
+}
diff --git a/src/docs/asciidoc/member.adoc b/src/docs/asciidoc/member.adoc
@@ -0,0 +1,158 @@
+= Spring REST Docs
+:toc: left
+:toclevels: 2
+:sectlinks:
+
+[[resources-post]]
+== 회원
+
+[[resources-post-create]]
+=== 회원 가입
+
+==== HTTP request
+include::{snippets}/member-signup/http-request.adoc[]
+
+
+==== HTTP response
+include::{snippets}/member-signup/http-response.adoc[]
+
+==== response-body 설명
+include::{snippets}/member-signup/response-fields.adoc[]
+
+
+
+=== 프로필 이미지 변경
+
+==== HTTP request
+include::{snippets}/member-change-profile-image/http-request.adoc[]
+
+==== HTTP response
+include::{snippets}/member-change-profile-image/http-response.adoc[]
+
+==== response-body 설명
+include::{snippets}/member-change-profile-image/response-fields.adoc[]
+
+
+=== 임시 비밀번호 발급
+
+==== HTTP request
+include::{snippets}/member-temporary-password/http-request.adoc[]
+
+==== request-body 설명
+include::{snippets}/member-temporary-password/request-fields.adoc[]
+
+==== HTTP response
+include::{snippets}/member-temporary-password/http-response.adoc[]
+
+==== response-body 설명
+include::{snippets}/email-verification-send/response-fields.adoc[]
+
+
+=== 비밀번호 변경
+
+==== HTTP request
+
+include::{snippets}/member-change-password/http-request.adoc[]
+
+==== request-body 설명
+include::{snippets}/member-change-password/request-fields.adoc[]
+
+==== HTTP response
+
+include::{snippets}/member-change-password/http-response.adoc[]
+
+==== response-body 설명
+include::{snippets}/member-change-password/response-fields.adoc[]
+
+
+
+
+=== 회원 탈퇴
+
+==== HTTP request
+
+include::{snippets}/member-withdraw/http-request.adoc[]
+
+
+==== HTTP response
+
+include::{snippets}/member-withdraw/http-response.adoc[]
+
+==== response-body 설명
+include::{snippets}/member-withdraw/response-fields.adoc[]
+
+
+
+
+
+=== 회원 상태
+
+==== HTTP request
+
+include::{snippets}/member-get-status/http-request.adoc[]
+
+
+==== HTTP response
+
+include::{snippets}/member-get-status/http-response.adoc[]
+
+==== response-body 설명
+include::{snippets}/member-get-status/response-fields.adoc[]
+
+
+
+
+=== 개인 정보 조회
+
+==== HTTP request
+
+include::{snippets}/member-get-member-page/http-request.adoc[]
+
+
+==== HTTP response
+
+include::{snippets}/member-get-member-page/http-response.adoc[]
+
+==== response-body 설명
+include::{snippets}/member-get-member-page/response-fields.adoc[]
+
+
+
+
+=== 자기소개 변경
+
+==== HTTP request
+
+include::{snippets}/member-change-about-me/http-request.adoc[]
+
+==== request-body 설명
+include::{snippets}/member-change-about-me/request-fields.adoc[]
+
+
+
+==== HTTP response
+
+include::{snippets}/member-change-about-me/http-response.adoc[]
+
+==== response-body 설명
+include::{snippets}/member-change-about-me/response-fields.adoc[]
+
+
+
+=== MBTI 변경
+
+==== HTTP request
+
+include::{snippets}/member-change-mbti/http-request.adoc[]
+
+==== request-body 설명
+include::{snippets}/member-change-mbti/request-fields.adoc[]
+
+
+
+==== HTTP response
+
+include::{snippets}/member-change-mbti/http-response.adoc[]
+
+==== response-body 설명
+include::{snippets}/member-change-mbti/response-fields.adoc[]
diff --git a/src/main/java/com/aliens/backend/BackendApplication.java b/src/main/java/com/aliens/backend/BackendApplication.java
@@ -2,7 +2,9 @@
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.scheduling.annotation.EnableScheduling;
 
+@EnableScheduling
 @SpringBootApplication
 public class BackendApplication {
 

diff --git a/src/main/java/com/aliens/backend/auth/controller/AuthController.java b/src/main/java/com/aliens/backend/auth/controller/AuthController.java
@@ -3,7 +3,8 @@
 import com.aliens.backend.auth.service.AuthService;
 import com.aliens.backend.auth.controller.dto.AuthToken;
 import com.aliens.backend.auth.controller.dto.LoginRequest;
-import org.springframework.http.ResponseEntity;
+import com.aliens.backend.global.response.success.AuthSuccess;
+import com.aliens.backend.global.response.SuccessResponse;
 import org.springframework.web.bind.annotation.*;
 
 
@@ -17,20 +18,29 @@ public AuthController(final AuthService authService) {
     }
 
     @PostMapping
-    public ResponseEntity<AuthToken> login(@RequestBody final LoginRequest loginRequest) {
-        AuthToken authToken = authService.login(loginRequest);
-        return ResponseEntity.ok(authToken);
+    public SuccessResponse<AuthToken> login(@RequestBody final LoginRequest loginRequest) {
+
+        return SuccessResponse.of(
+                AuthSuccess.GENERATE_TOKEN_SUCCESS,
+                authService.login(loginRequest)
+        );
     }
 
     @PostMapping("/logout")
-    public ResponseEntity<String> logout(@RequestBody final AuthToken authToken) {
-        String result = authService.logout(authToken);
-        return ResponseEntity.ok(result);
+    public SuccessResponse<String> logout(@RequestBody final AuthToken authToken) {
+
+        return SuccessResponse.of(
+                AuthSuccess.LOGOUT_SUCCESS,
+                authService.logout(authToken)
+        );
     }
 
     @PostMapping("/reissue")
-    public ResponseEntity<AuthToken> reissue(@RequestBody final AuthToken authToken) {
-        AuthToken newAuthToken = authService.reissue(authToken);
-        return ResponseEntity.ok(newAuthToken);
+    public SuccessResponse<AuthToken> reissue(@RequestBody final AuthToken authToken) {
+
+        return SuccessResponse.of(
+                AuthSuccess.REISSUE_TOKEN_SUCCESS,
+                authService.reissue(authToken)
+        );
     }
 }