Feat: Security 작업 및 Request Response Logging (#11)

* feat: Add Security Config * feat: Create Request Response Log * chore: re setting module * feat: Add BadRequest Exception * feat: Add BusinessException * feat: Add Unauthorized * feat: separate sealed class * feat: Add Conflict Exception * feat: Add NotFound Exception * feat: Add ServiceUnavailable Exception * feat: Add InternalServerError Exception * feat: Add NotAcceptable Exception * feat: Add UnsupportedMediaType Exception * feat: Add Bad Request Detail Case * feat: Add Unauthorized Detail Case * feat: Add Sns Auth Type * feat: Add SnsType * feat: Add SnsType attribute convertor * feat: Add UserEntity * feat: Add UserEntity * feat: Add User detail for security * feat: Add user domain model * feat: Add user mapper * style: add comma * feat: change private id to public * feat: Create LoadUserInputBoundary * feat: Create UserGateway * feat: Add User find feature * build: Add jwt category bundle * build: Add springdoc dependency * feat: Add JwtConfig file * feat: Add jwt value property in JwtConfig * style: fix style * style: fix typo * build: Add Mockk Dependency mockito 의존성 제거 및 mockK 의존성 추가 * build: Add JwtConfigContract * build: Add mockK in version catalog * feat: Add AuthToken Domain Model * feat: Add BeIssuedAuthTokenUseCase * feat: Add BeIssuedAuthTokenUseCase * feat: Move ZoneId to JwtConfigContract Companion * feat: Add jwt validate usecase * feat: Move ZoneId to JwtConfigContract Companion * test: Add unexpired token verification test * feat: Add AuthenticationToken * chore: Fix file name * test: Add Unauthorized Case Test * feat: move magic string to companion object * feat: change magic string to const * feat: Change Validate Use Case to Extract Token Use Case * feat: Fix Extract token throw method * feat: Add Jwt Authentication with Security * chore: Fix CI action * chore: Fix CI action * chore: Fix CI action * chore: Fix CI action * chore: Fix CI action test files path
U-is-Ni-in-Korea · Sep 20, 2023 · afc5bc9 · afc5bc9
1 parent f4679cd
commit afc5bc9
Show file tree

Hide file tree

Showing 87 changed files with 1,377 additions and 614 deletions.
diff --git a/.github/workflows/gradle_task.yml b/.github/workflows/gradle_task.yml
@@ -0,0 +1,41 @@
+on:
+    workflow_call:
+        inputs:
+            tasks:
+                description: gradle execute option
+                type: string
+
+jobs:
+    gradle-task:
+        strategy:
+            matrix:
+                gradle: ${{ fromJSON(inputs.tasks) }}
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+              with:
+                  token: ${{ secrets.CI_TOKEN }}
+                  submodules: true
+
+            - name: Gradle cache
+              uses: actions/cache@v2
+              with:
+                  path: |
+                      ~/.gradle/caches
+                      ~/.gradle/wrapper
+                  key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}
+                  restore-keys: |
+                      ${{ runner.os }}-gradle-
+
+            - name: set up JDK 17
+              uses: actions/setup-java@v3
+              with:
+                  java-version: '17'
+                  distribution: 'temurin'
+                  cache: gradle
+
+            - name: Grant execute permission for gradlew
+              run: chmod +x gradlew
+
+            - name: Run Gradle Task
+              run: ./gradlew ${{matrix.gradle}}
diff --git a/.github/workflows/pr_ci_checker.yml b/.github/workflows/pr_ci_checker.yml
@@ -11,95 +11,57 @@ permissions:
     pull-requests: write
 
 jobs:
-    ktlint:
+    ci:
+        uses: ./.github/workflows/gradle_task.yml
+        with:
+            tasks: '["ktlintCheck", "build -x test -x ktlintCheck", "test"]'
+        secrets: inherit
+
+    publish-test-result:
+        needs:
+            - ci
         runs-on: ubuntu-latest
         steps:
-            -   uses: actions/checkout@v3
+            -   name: Publish Test Results
+                uses: EnricoMi/publish-unit-test-result-action@v1
                 with:
-                    token: ${{ secrets.CI_TOKEN }}
-                    submodules: true
+                    files: |
+                        module-domain/build/test-results/**/*.xml
+                        module-infrastructure/build/test-results/**/*.xml
+                        module-usecase/build/test-results/**/*.xml
 
-            -   name: Gradle cache
-                uses: actions/cache@v2
-                with:
-                    path: |
-                        ~/.gradle/caches
-                        ~/.gradle/wrapper
-                    key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}
-                    restore-keys: |
-                        ${{ runner.os }}-gradle-
-
-            -   name: set up JDK 17
-                uses: actions/setup-java@v3
-                with:
-                    java-version: '17'
-                    distribution: 'temurin'
-                    cache: gradle
-
-            -   name: Grant execute permission for gradlew
-                run: chmod +x gradlew
-
-            -   name: ktlintCheck
-                run: ./gradlew ktlintCheck
 
-    build:
+    result-success:
+        needs:
+            - ci
+        if: success()
         runs-on: ubuntu-latest
         steps:
-            -   uses: actions/checkout@v3
-                with:
-                    token: ${{ secrets.CI_TOKEN }}
-                    submodules: true
-
-            -   name: Gradle cache
-                uses: actions/cache@v2
-                with:
-                    path: |
-                        ~/.gradle/caches
-                        ~/.gradle/wrapper
-                    key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}
-                    restore-keys: |
-                        ${{ runner.os }}-gradle-
-
-            -   name: set up JDK 17
-                uses: actions/setup-java@v3
-                with:
-                    java-version: '17'
-                    distribution: 'temurin'
-                    cache: gradle
-
-            -   name: Grant execute permission for gradlew
-                run: chmod +x gradlew
-
-            -   name: build
-                run: ./gradlew build -x test -x ktlintCheck
-
-    test:
+            -   name: On Success!! Congratulations
+                uses: rtCamp/action-slack-notify@v2
+                env:
+                    SLACK_COLOR: '#53A551'
+                    SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK_URL }}
+                    SLACK_TITLE: 'Uni/PR Check S.U.C.C.E.S.S 🎉🎉🎉'
+                    SLACK_ICON: ${{ github.event.org.avatar_url }}
+                    MSG_MINIMAL: event,actions url, commit
+                    SLACK_USERNAME: Uni-server
+                    SLACK_MESSAGE: '${{ github.server_url }}/${{ github.repository }}/pull/${{ github.event.number}}'
+
+    result-failure:
+        needs:
+            - ci
+        if: failure()
         runs-on: ubuntu-latest
         steps:
-            -   uses: actions/checkout@v3
-                with:
-                    token: ${{ secrets.CI_TOKEN }}
-                    submodules: true
-
-            -   name: Gradle cache
-                uses: actions/cache@v2
-                with:
-                    path: |
-                        ~/.gradle/caches
-                        ~/.gradle/wrapper
-                    key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}
-                    restore-keys: |
-                        ${{ runner.os }}-gradle-
-
-            -   name: set up JDK 17
-                uses: actions/setup-java@v3
-                with:
-                    java-version: '17'
-                    distribution: 'temurin'
-                    cache: gradle
-
-            -   name: Grant execute permission for gradlew
-                run: chmod +x gradlew
-
-            -   name: test
-                run: ./gradlew test
+            -   name: On Failed, Notify in Slack
+                if: ${{ failure() }}
+                uses: rtCamp/action-slack-notify@v2
+                env:
+                    SLACK_COLOR: '#ff0000'
+                    SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK_URL }}
+                    SLACK_TITLE: 'Uni/Server Debug build Fail❌ 에러를 확인해주세요'
+                    SLACK_ICON: ${{ github.event.org.avatar_url }}
+                    MSG_MINIMAL: event,actions url, commit
+                    SLACK_USERNAME: Uni-server
+                    SLACK_MESSAGE: '${{ github.server_url }}/${{ github.repository }}/pull/${{ github.event.number}}'
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -6,6 +6,7 @@ springdoc = "2.1.0"
 jjwt = "0.11.5"
 kotlin = "1.8.22"
 ktlint = "11.0.0"
+mockk = "1.13.7"
 
 service = "0.0.1-SNAPSHOT"
 
@@ -47,6 +48,7 @@ test-spring-boot-starter = { module = "org.springframework.boot:spring-boot-star
 test-spring-security = { module = "org.springframework.security:spring-security-test" }
 test-junit5-api = { module = "org.junit.jupiter:junit-jupiter-api", version.ref = "junit5" }
 test-junit5-engine = { module = "org.junit.jupiter:junit-jupiter-engine", version.ref = "junit5" }
+test-mockk = { module = "io.mockk:mockk", version.ref = "mockk" }
 
 [plugins]
 # common
@@ -62,3 +64,8 @@ ktlint = { id = "org.jlleitschuh.gradle.ktlint", version.ref = "ktlint" }
 # kotlin
 
 [bundles]
+jjwt = [
+    "jjwt-api",
+    "jjwt-impl",
+    "jjwt-jackson"
+]
diff --git a/module-api/src/main/kotlin/universe/sparkle/moduleapi/ModuleApiApplication.kt b/module-api/src/main/kotlin/universe/sparkle/moduleapi/ModuleApiApplication.kt
diff --git a/module-api/src/test/kotlin/universe/sparkle/moduleapi/ModuleApiApplicationTests.kt b/module-api/src/test/kotlin/universe/sparkle/moduleapi/ModuleApiApplicationTests.kt
diff --git a/...e-domain/src/main/kotlin/universe/sparkle/modulecoredomain/ModuleCoreDomainApplication.kt b/...e-domain/src/main/kotlin/universe/sparkle/modulecoredomain/ModuleCoreDomainApplication.kt
diff --git a/module-data/build.gradle b/module-data/build.gradle
diff --git a/module-data/settings.gradle b/module-data/settings.gradle
diff --git a/module-data/src/main/kotlin/universe/sparkle/moduledata/ModuleDataApplication.kt b/module-data/src/main/kotlin/universe/sparkle/moduledata/ModuleDataApplication.kt
diff --git a/module-data/src/main/resources/application.properties b/module-data/src/main/resources/application.properties
diff --git a/module-data/src/test/kotlin/universe/sparkle/moduledata/ModuleDataApplicationTests.kt b/module-data/src/test/kotlin/universe/sparkle/moduledata/ModuleDataApplicationTests.kt
diff --git a/module-api/.gitignore → module-domain/.gitignore b/module-api/.gitignore → module-domain/.gitignore
diff --git a/module-core-domain/build.gradle → module-domain/build.gradle b/module-core-domain/build.gradle → module-domain/build.gradle
diff --git a/module-api/gradle/wrapper/gradle-wrapper.jar → ...-domain/gradle/wrapper/gradle-wrapper.jar b/module-api/gradle/wrapper/gradle-wrapper.jar → ...-domain/gradle/wrapper/gradle-wrapper.jar
diff --git a/.../gradle/wrapper/gradle-wrapper.properties → .../gradle/wrapper/gradle-wrapper.properties b/.../gradle/wrapper/gradle-wrapper.properties → .../gradle/wrapper/gradle-wrapper.properties
diff --git a/module-api/gradlew → module-domain/gradlew b/module-api/gradlew → module-domain/gradlew
diff --git a/module-api/gradlew.bat → module-domain/gradlew.bat b/module-api/gradlew.bat → module-domain/gradlew.bat
diff --git a/module-core-domain/settings.gradle → module-domain/settings.gradle b/module-core-domain/settings.gradle → module-domain/settings.gradle
diff --git a/module-domain/src/main/kotlin/universe/sparkle/domain/JwtConfigContract.kt b/module-domain/src/main/kotlin/universe/sparkle/domain/JwtConfigContract.kt
@@ -0,0 +1,13 @@
+package universe.sparkle.domain
+
+import java.time.ZoneId
+
+interface JwtConfigContract {
+    fun getSecret(): String
+    fun getAccessExpiryPeriodDay(): Long
+    fun getRefreshExpiryPeriodDay(): Long
+
+    companion object {
+        val zoneIdKST = ZoneId.of("Asia/Seoul")
+    }
+}
diff --git a/module-domain/src/main/kotlin/universe/sparkle/domain/SnsType.kt b/module-domain/src/main/kotlin/universe/sparkle/domain/SnsType.kt
@@ -0,0 +1,12 @@
+package universe.sparkle.domain
+
+enum class SnsType {
+    KAKAO, GOOGLE, APPLE;
+
+    companion object {
+        fun findSnsTypeBy(snsTypeName: String): SnsType {
+            return values().find { it.name == snsTypeName }
+                ?: throw IllegalArgumentException("Unsupported social login type: $snsTypeName")
+        }
+    }
+}
diff --git a/module-domain/src/main/kotlin/universe/sparkle/domain/exception/BadRequest.kt b/module-domain/src/main/kotlin/universe/sparkle/domain/exception/BadRequest.kt
@@ -0,0 +1,34 @@
+package universe.sparkle.domain.exception
+
+sealed class BadRequest(
+    code: Int,
+    message: String,
+) : BusinessException(code, message) {
+    data class InvalidRequestMethod(
+        override val message: String = "잘못된 방식의 요청입니다.",
+    ) : BadRequest(1001, message)
+
+    data class AlreadyGameCreated(
+        override val message: String = "이미 승부가 생성되었습니다.",
+    ) : BadRequest(1002, message)
+
+    data class UserNotExistent(
+        override val message: String = "존재하지 않는 유저의 요청입니다.",
+    ) : BadRequest(1003, message)
+
+    data class AlreadyGameDone(
+        override val message: String = "이미 게임이 종료 되었습니다.",
+    ) : BadRequest(1004, message)
+
+    data class CoupleNotExistent(
+        override val message: String = "존재하지 않는 커플의 요청입니다.",
+    ) : BadRequest(1005, message)
+
+    data class InvalidInviteCode(
+        override val message: String = "올바르지 않은 초대 코드입니다.",
+    ) : BadRequest(1006, message)
+
+    data class PartnerResultNotEntered(
+        override val message: String = "상대방이 아직 결과를 입력하지 않았습니다.",
+    ) : BadRequest(1007, message)
+}
diff --git a/module-domain/src/main/kotlin/universe/sparkle/domain/exception/BusinessException.kt b/module-domain/src/main/kotlin/universe/sparkle/domain/exception/BusinessException.kt
@@ -0,0 +1,6 @@
+package universe.sparkle.domain.exception
+
+sealed class BusinessException(
+    open val code: Int,
+    override val message: String,
+) : RuntimeException(message)