Merge pull request #1 from Principes-Artis-Mechanicae/develop

Merge First Release Version (v1.0.0)

Author: lsmin3388

.gitignore

@@ -0,0 +1,4 @@
+FROM openjdk:17-jdk 
+ARG JAR_FILE=build/libs/*.jar
+ADD ${JAR_FILE} app.jar
+ENTRYPOINT ["java", "-Duser.timezone=GMT+9", "-Djava.security.egd=file:/dev/./urandom", "-Dspring.profiles.active=dev", "-jar", "/app.jar"]

Dockerfile

@@ -1,2 +1,2 @@
-# k-lock-server
+# k-cse-server
 Integrated management service for CSE lockers at Kyungpook National University

HELP.md

@@ -4,7 +4,7 @@ plugins {
 	id 'io.spring.dependency-management' version '1.1.5'
 }
 
-group = 'knu.univ'
+group = 'knu.univ.cse.server'
 version = '0.0.1-SNAPSHOT'
 
 java {
@@ -23,19 +23,57 @@ repositories {
 	mavenCentral()
 }
 
+test {
+	testLogging {
+		events "started", "passed", "skipped", "failed"
+		exceptionFormat "full"
+		showStandardStreams = true
+
+		afterTest { descriptor, result ->
+			def testResult = result.resultType
+			if (testResult == TestResult.ResultType.SUCCESS) {
+				println "\u001B[32m✔ 테스트 성공: ${descriptor.parent.displayName} > ${descriptor.displayName}\u001B[0m"
+			} else if (testResult == TestResult.ResultType.FAILURE) {
+				println "\u001B[31m✖ 테스트 실패: ${descriptor.parent.displayName} > ${descriptor.displayName}\u001B[0m"
+			} else if (testResult == TestResult.ResultType.SKIPPED) {
+				println "\u001B[33m- 테스트 스킵됨: ${descriptor.parent.displayName} > ${descriptor.displayName}\u001B[0m"
+			}
+		}
+	}
+}
+
 dependencies {
+	// Spring Boot Starters
 	implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
 	implementation 'org.springframework.boot:spring-boot-starter-security'
 	implementation 'org.springframework.boot:spring-boot-starter-validation'
 	implementation 'org.springframework.boot:spring-boot-starter-web'
+	implementation 'org.springframework.boot:spring-boot-starter-oauth2-client'
+
+	// JSON Web Token (JWT)
+	implementation 'io.jsonwebtoken:jjwt-api:0.11.5'
+	implementation 'io.jsonwebtoken:jjwt-impl:0.11.5'
+	implementation 'io.jsonwebtoken:jjwt-jackson:0.11.5'
+
+	// Lombok
 	compileOnly 'org.projectlombok:lombok'
-	runtimeOnly 'org.postgresql:postgresql'
 	annotationProcessor 'org.projectlombok:lombok'
+
+	// Database
+	implementation 'com.mysql:mysql-connector-j'
+
+	// Testing
 	testImplementation 'org.springframework.boot:spring-boot-starter-test'
-	testImplementation 'org.springframework.security:spring-security-test'
 	testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
+
+	// Api Documentation
+	implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.3.0'
+
+	// CSV
+	implementation 'com.opencsv:opencsv:5.7.1'
 }
 
+
 tasks.named('test') {
 	useJUnitPlatform()
 }

README.md

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+# 출력 파일 지정
+output_file="$1.code_output.txt"
+
+# 상대 경로로 지정한 폴더를 첫 번째 인자로 받음
+folder_path=$2
+
+# 기존에 존재하는 output.txt 파일 삭제 (있을 경우)
+if [ -f "$output_file" ]; then
+  rm "$output_file"
+fi
+
+# 재귀적으로 폴더 안의 모든 .java 파일을 찾고, 각 파일의 내용을 output.txt에 추가
+find "$folder_path" -type f -name "*.java" | while read java_file; do
+  echo "Processing $java_file"
+
+  # 파일 이름 출력
+  echo "$(basename "$java_file")" >> "$output_file"
+
+  # 파일 내용 중 import 및 package 구문을 제외하고 출력
+  grep -Ev '^\s*(import)\s' "$java_file" >> "$output_file"
+
+  # 파일 간에 구분을 위한 빈 줄 추가
+  echo -e "\n" >> "$output_file"
+done
+
+echo "All .java files have been processed and saved in $output_file"

build.gradle

@@ -0,0 +1,91 @@
+#!/bin/bash
+
+# Constants
+SUBMODULE_DIR="k-cse-server-module"
+DEVELOP_ENV_FILE=".env.develop"
+RELEASE_ENV_FILE=".env.release"
+
+# Global variables
+DEV_VERSION=""
+REL_VERSION=""
+ENV_FILE=""
+IS_DEV_BUILD=false
+
+# Functions
+get_version() {
+  local env_file=$1
+  grep '^# Version' "$env_file" | head -n 1 | cut -d' ' -f3-
+}
+
+select_build_type() {
+  echo "Select build type:"
+  echo "1) Development (Current Version: $DEV_VERSION)"
+  echo "2) Release (Current Version: $REL_VERSION)"
+  read -p "Choice build type: " build_type
+
+  case $build_type in
+    1)
+       ENV_FILE="$SUBMODULE_DIR/$DEVELOP_ENV_FILE"
+       IS_DEV_BUILD=true
+       ;;
+    2)
+       ENV_FILE="$SUBMODULE_DIR/$RELEASE_ENV_FILE"
+       IS_DEV_BUILD=false
+       ;;
+    *)
+       echo "deploy.sh: Invalid choice. Exiting script." && exit 1
+       ;;
+  esac
+}
+
+check_env_file() {
+  if [ ! -f "$ENV_FILE" ]; then
+    echo "deploy.sh: File $ENV_FILE not found. Exiting script."
+    exit 1
+  fi
+}
+
+source_env_file() {
+  if [ -f "$ENV_FILE" ]; then
+    # shellcheck disable=SC1090
+    source "$ENV_FILE"
+    echo "deploy.sh: Environment variables from $ENV_FILE:"
+  else
+    echo "deploy.sh: File $ENV_FILE not found. Exiting script."
+    exit 1
+  fi
+}
+
+# Main script execution
+DEV_VERSION=$(get_version "$SUBMODULE_DIR/$DEVELOP_ENV_FILE")
+REL_VERSION=$(get_version "$SUBMODULE_DIR/$RELEASE_ENV_FILE")
+select_build_type
+check_env_file
+source_env_file
+
+echo ""
+
+# Java Build
+echo "---------------------------------"
+echo "deploy.sh: Starting Java build..."
+
+if [ "$IS_DEV_BUILD" = true ]; then
+  ./gradlew clean build
+else
+  ./gradlew clean build -x test
+fi
+
+echo "deploy.sh: Java build completed."
+echo "---------------------------------"
+
+echo ""
+
+# Run Docker Compose
+echo "---------------------------------"
+echo "deploy.sh: Starting Docker Compose..."
+sudo docker compose --env-file "$ENV_FILE" up -d --build
+echo "deploy.sh: Docker Compose up and running."
+echo "---------------------------------"
+
+echo ""
+echo "deploy.sh: deploy complete"

codeExtractor.sh

@@ -0,0 +1,53 @@
+version: "3"
+
+services:
+  app:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    container_name: k-cse-server
+    environment:
+      - SPRING_PORT=${SPRING_PORT}
+      - DB_HOST=${DB_HOST}
+      - DB_PORT=${DB_PORT}
+      - DB_DATABASE=${DB_DATABASE}
+      - DB_USERNAME=${DB_USERNAME}
+      - DB_PASSWORD=${DB_PASSWORD}
+      - DB_ROOT_PASSWORD=${DB_ROOT_PASSWORD}
+      - JWT_SECRET=${JWT_SECRET}
+      - GOOGLE_CLIENT_ID=${GOOGLE_CLIENT_ID}
+      - GOOGLE_CLIENT_SECRET=${GOOGLE_CLIENT_SECRET}
+      - GOOGLE_REDIRECT_URI=${GOOGLE_REDIRECT_URI}
+      - CORS_ALLOWED_ORIGINS=${CORS_ALLOWED_ORIGINS}
+      - OAUTH2_REDIRECT_URI=${OAUTH2_REDIRECT_URI}
+    depends_on:
+      - database
+    ports:
+      - ${SPRING_PORT}:${SPRING_PORT}
+    restart: always
+
+  database:
+    image: mysql:8.0
+    container_name: k-cse-database
+    environment:
+      TZ: Asia/Seoul
+      LANG: C.UTF-8
+      MYSQL_DATABASE: ${DB_DATABASE}
+      MYSQL_USER: ${DB_USERNAME}
+      MYSQL_PASSWORD: ${DB_PASSWORD}
+      MYSQL_ROOT_PASSWORD: ${DB_ROOT_PASSWORD}
+    command:
+      - --port=${DB_PORT}
+      - --character-set-server=utf8mb4
+      - --collation-server=utf8mb4_unicode_ci
+      - --skip-character-set-client-handshake
+    expose:
+      - ${DB_PORT}
+    ports:
+      - ${DB_PORT}:${DB_PORT}
+    restart: always
+    volumes:
+      - k-cse-database:/var/lib/mysql
+
+volumes:
+  k-cse-database:

deploy.sh

@@ -0,0 +1 @@
+Subproject commit 893b7879fc7fd4b0774499f9952cfad4af33aa2b

docker-compose.yml

@@ -0,0 +1,31 @@
+#-------------------------------------------------------------------------------#
+#               Qodana analysis is configured by qodana.yaml file               #
+#             https://www.jetbrains.com/help/qodana/qodana-yaml.html            #
+#-------------------------------------------------------------------------------#
+version: "1.0"
+
+#Specify inspection profile for code analysis
+profile:
+  name: qodana.starter
+
+#Enable inspections
+#include:
+#  - name: <SomeEnabledInspectionId>
+
+#Disable inspections
+#exclude:
+#  - name: <SomeDisabledInspectionId>
+#    paths:
+#      - <path/where/not/run/inspection>
+
+projectJDK: 17 #(Applied in CI/CD pipeline)
+
+#Execute shell command before Qodana execution (Applied in CI/CD pipeline)
+#bootstrap: sh ./prepare-qodana.sh
+
+#Install IDE plugins before Qodana execution (Applied in CI/CD pipeline)
+#plugins:
+#  - id: <plugin.id> #(plugin id can be found at https://plugins.jetbrains.com)
+
+#Specify Qodana linter for analysis (Applied in CI/CD pipeline)
+linter: jetbrains/qodana-jvm:latest