Merge pull request #442 from woowacourse-teams/dev

release v1.0.0

.github/workflows/backend.yml

@@ -1,7 +1,7 @@
 name: sonar backend
 on:
   pull_request:
-    branches: [main]
+    branches: [dev]
     paths: ["backend/**"]
     types: [opened, synchronize, reopened]
 defaults:
@@ -35,4 +35,4 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
-        run: ./gradlew build sonarqube --info
+        run: ./gradlew build

.github/workflows/frontend.yml

@@ -1,7 +1,7 @@
 name: sonar frontend
 on:
   pull_request:
-    branches: [main]
+    branches: [dev]
     paths: ["frontend/**"]
     types: [opened, synchronize, reopened]
 defaults:
@@ -13,10 +13,5 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-        with:
-          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
-      - name: SonarCloud Scan
-        uses: SonarSource/sonarcloud-github-action@master
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
-          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+      - run: npm ci
+      - run: npm run build

.github/workflows/imagestorage.yml

@@ -0,0 +1,38 @@
+name: sonar imagestorage
+on:
+  pull_request:
+    branches: [dev]
+    paths: ["imagestorage/**"]
+    types: [opened, synchronize, reopened]
+defaults:
+  run:
+    working-directory: imagestorage
+jobs:
+  build:
+    name: sonar imagestorage
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+      - name: Set up JDK 11
+        uses: actions/setup-java@v1
+        with:
+          java-version: 11
+      - name: Cache SonarCloud packages
+        uses: actions/cache@v1
+        with:
+          path: ~/.sonar/cache
+          key: ${{ runner.os }}-sonar
+          restore-keys: ${{ runner.os }}-sonar
+      - name: Cache Gradle packages
+        uses: actions/cache@v1
+        with:
+          path: ~/.gradle/caches
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle') }}
+          restore-keys: ${{ runner.os }}-gradle
+      - name: Build and analyze
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        run: ./gradlew build

.gitmodules

@@ -2,3 +2,8 @@
 	path = backend/submodule
 	url = https://github.com/gong-check/submodule.git
     branch = main
+
+[submodule "frontend/frontend-security"]
+	path = frontend/frontend-security
+	url = https://github.com/gong-check/frontend-security.git
+	branch = main

backend/.gitignore

@@ -25,7 +25,9 @@ bin/
 out/
 !**/src/main/**/out/
 !**/src/test/**/out/
-application-oauth.yml
+application-dev.yml
+application-local.yml
+application-prod.yml
 
 ### NetBeans ###
 /nbproject/private/
@@ -39,3 +41,9 @@ application-oauth.yml
 
 ### Rest docs ###
 /src/main/resources/static/index.html
+
+### logging ###
+/logs/**
+
+### upload image ###
+/src/test/resources/static/images/**

backend/build.gradle

@@ -30,13 +30,20 @@ dependencies {
     implementation 'org.springframework.boot:spring-boot-starter-web'
     testImplementation 'org.springframework.boot:spring-boot-starter-test'
 
+    // webflux
+    implementation 'org.springframework.boot:spring-boot-starter-webflux'
+
     // database-driver
+    runtimeOnly 'mysql:mysql-connector-java'
     runtimeOnly 'com.h2database:h2'
 
     // lombok
     compileOnly 'org.projectlombok:lombok'
     annotationProcessor 'org.projectlombok:lombok'
 
+    // log
+    implementation 'dev.akkinoc.spring.boot:logback-access-spring-boot-starter:3.3.2'
+
     // jwt
     implementation 'io.jsonwebtoken:jjwt-api:0.11.5'
     runtimeOnly 'io.jsonwebtoken:jjwt-impl:0.11.5'
@@ -55,12 +62,13 @@ dependencies {
     implementation 'com.squareup.okhttp3:okhttp:4.10.0'
     implementation 'com.slack.api:slack-app-backend:1.22.2'
     implementation 'com.slack.api:slack-api-model:1.22.2'
+    implementation "com.github.maricn:logback-slack-appender:1.6.1"
 }
 
 processResources.dependsOn('copySecret')
 
 task copySecret(type: Copy) {
-    from '../backend/submodule/application-oauth.yml'
+    from '../backend/submodule'
     into 'src/main/resources'
 }
 
@@ -92,8 +100,16 @@ task createDocument(type: Copy) {
     into file("src/main/resources/static")
 }
 
+task displaceDocument(type: Copy) {
+    dependsOn asciidoctor
+
+    from ("${asciidoctor.outputDir}")
+    into ("build/resources/main/static")
+}
+
 bootJar {
     dependsOn createDocument
+    dependsOn displaceDocument
 }
 
 jacocoTestReport {

backend/src/docs/asciidoc/guest.adoc

@@ -2,4 +2,5 @@
 == 게스트
 
 === 공간 입장
-operation::guests/auth/success[snippets='http-request,http-response']
+
+operation::guests/auth/success[snippets='http-request,http-response,path-parameters,request-fields,response-fields']

backend/src/docs/asciidoc/hosts.adoc

@@ -0,0 +1,8 @@
+[[Hosts]]
+== 호스트
+
+=== 호스트 비밀번호 변경
+operation::hosts/spacePassword_update/success[snippets='http-request,http-response']
+
+=== 입장코드 조회
+operation::hosts/entranceCode[snippets='http-request,http-response,response-fields']

backend/src/docs/asciidoc/image-upload.adoc

@@ -0,0 +1,3 @@
+[[Image-upload]]
+== 이미지 업로드
+operation::image-upload[snippets='http-request,http-response,request-parts,response-fields']

backend/src/docs/asciidoc/index.adoc

@@ -7,7 +7,10 @@
 == Gong-Check
 
 include::guest.adoc[]
+include::hosts.adoc[]
 include::space.adoc[]
 include::job.adoc[]
 include::task.adoc[]
+include::runningTask.adoc[]
 include::submission.adoc[]
+include::image-upload.adoc[]

backend/src/docs/asciidoc/job.adoc

@@ -2,4 +2,25 @@
 == job
 
 === job 목록 조회
-operation::jobs/list[snippets='http-request,http-response']
+
+operation::jobs/list[snippets='http-request,http-response,path-parameters,response-fields']
+
+=== job의 slack url 조회
+
+operation::jobs/slack_url[snippets='http-request,http-response,path-parameters,response-fields']
+
+=== job의 slack url 수정
+
+operation::jobs/change_slack_url/success[snippets='http-request,http-response,path-parameters,request-fields']
+
+=== 새로운 job 생성
+
+operation::jobs/create/success[snippets='http-request,http-response,path-parameters,request-fields']
+
+=== job 수정
+
+operation::jobs/change/success[snippets='http-request,http-response,path-parameters,request-fields']
+
+=== job 삭제
+
+operation::jobs/delete[snippets='http-request,http-response,path-parameters']

backend/src/docs/asciidoc/runningTask.adoc

@@ -0,0 +1,18 @@
+[[RunningTask]]
+== RunningTask
+
+=== RunningTask 정보 조회
+
+operation::runningTasks/find/success[snippets='http-request,http-response,path-parameters,response-fields']
+
+=== RunningTask 완료 여부 확인
+
+operation::runningTasks/active/success[snippets='http-request,http-response,path-parameters,response-fields']
+
+=== RunningTask check 상태 변환
+
+operation::runningTasks/check/success[snippets='http-request,http-response,path-parameters']
+
+=== RunningTask 생성
+
+operation::runningTasks/create/success[snippets='http-request,http-response,path-parameters']

backend/src/docs/asciidoc/space.adoc

@@ -2,4 +2,21 @@
 == space
 
 === space 목록 조회
-operation::spaces/list[snippets='http-request,http-response']
+
+operation::spaces/list[snippets='http-request,http-response,response-fields']
+
+=== 단일 space 조회
+
+operation::spaces/find[snippets='http-request,path-parameters,http-response,response-fields']
+
+=== 새로운 space 생성
+
+operation::spaces/create/success[snippets='http-request,http-response,request-fields']
+
+=== space 수정
+
+operation::spaces/change/success[snippets='http-request,http-response,path-parameters,request-fields']
+
+=== space 삭제
+
+operation::spaces/delete[snippets='http-request,http-response,path-parameters']

backend/src/docs/asciidoc/submission.adoc

@@ -1,5 +1,10 @@
 [[Submission]]
 == submission
 
-=== 제출
-operation::submissions/submit/success[snippets='http-request,http-response']
+=== submission 목록 조회
+
+operation::submissions/list[snippets='http-request,http-response,path-parameters,response-fields']
+
+=== 완료된 job tasks의 submission 제출
+
+operation::submissions/submit/success[snippets='http-request,http-response,path-parameters,request-fields']

backend/src/docs/asciidoc/task.adoc

@@ -1,11 +1,6 @@
 [[Task]]
 == task
 
-=== tasks 정보 조회
-operation::tasks/find/success[snippets='http-request,http-response']
-=== task 완료 여부 확인
-operation::tasks/active/success[snippets='http-request,http-response']
-=== task check 상태 변환
-operation::tasks/check/success[snippets='http-request,http-response']
-=== runningtask 생성
-operation::tasks/create/success[snippets='http-request,http-response']
+=== Task 정보 조회
+
+operation::tasks/find/success[snippets='http-request,http-response,path-parameters,response-fields']