1차 리포트 전 Dev -> Main

.github/workflows/ci-docker.yml

@@ -0,0 +1,35 @@
+name: IssueDive Docker CI
+
+on:
+  push:
+    branches: [ "dev" ] # dev 브랜치에 푸시될 때 실행
+
+jobs:
+  build-and-push:
+    name: Build and Push to Docker Hub
+    runs-on: ubuntu-latest
+    steps:
+      # 1. 소스 코드 체크아웃
+      - name: Checkout source code
+        uses: actions/checkout@v4
+
+      # 2. Docker Buildx 설정 (Docker 빌드 성능 향상)
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      # 3. Docker Hub 로그인
+      # GitHub Secrets에 저장된 정보를 이용해 Docker Hub에 로그인합니다.
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      # 4. Docker 이미지 빌드 및 푸시
+      # 빌드 과정에서 테스트가 실행되고, 성공하면 이미지를 Docker Hub에 푸시합니다.
+      - name: Build and push
+        uses: docker/build-push-action@v5
+        with:
+          context: . # Dockerfile이 있는 위치
+          push: true # Docker Hub로 푸시 활성화
+          tags: ${{ secrets.DOCKERHUB_USERNAME }}/issuedive:latest # "DockerHub계정명/이미지명:태그" 형식

.github/workflows/ci-yml.txt

@@ -0,0 +1,40 @@
+# 워크플로우의 이름
+name: IssueDive CI
+
+# 워크플로우가 언제 실행될지 정의
+on:
+  push:
+    branches: [ "dev" ] # dev 브랜치에 push될 때 실행
+  pull_request:
+    branches: [ "dev" ] # dev 브랜치로 Pull Request가 생성될 때 실행
+
+# 실행될 작업(Job)들을 정의
+jobs:
+  build-and-test: # 작업의 ID
+    name: Build and Test # 작업의 이름 (GitHub Actions UI에 표시됨)
+    runs-on: ubuntu-latest # 작업을 실행할 가상 머신 환경 (Ubuntu 최신 버전)
+
+    # 작업의 단계(Step)들을 정의
+    steps:
+      # 1. 소스 코드 체크아웃
+      # GitHub Actions가 우리 저장소의 코드에 접근할 수 있도록 내려받는 단계
+      - name: Checkout source code
+        uses: actions/checkout@v4
+
+      # 2. JDK 17 설치
+      # build.gradle에 설정된 Java 17 버전으로 빌드 환경을 설정
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+
+      # 3. gradlew 파일에 실행 권한 부여
+      # 예전에 겪었던 'permission denied' 문제를 방지하기 위해 꼭 필요!
+      - name: Grant execute permission for gradlew
+        run: chmod +x ./gradlew
+
+      # 4. Gradle로 빌드 및 테스트 실행
+      # 이 명령어가 성공하면 CI 성공, 실패하면 CI 실패
+      - name: Build with Gradle
+        run: ./gradlew build

.gitignore

@@ -36,4 +36,20 @@ out/
 ### VS Code ###
 .vscode/
 
-src/main/resources/application.properties
+# Application Properties
+application.properties
+application-test.properties
+application-dev.properties
+
+.secrets
+.env
+.java-version
+logs/
+gradle.properties
+.env.local
+.env.*.local
+
+# JWT 시크릿 키나 API 키가 포함된 파일
+**/secrets.properties
+**/*.secret
+**/jwt.properties

Dockerfile

@@ -0,0 +1,30 @@
+# 1. 빌드 및 테스트 스테이지
+FROM gradle:8.8.0-jdk17 AS builder
+
+WORKDIR /app
+
+# Gradle 캐시 최적화를 위해 의존성 관련 파일 먼저 복사
+COPY build.gradle settings.gradle gradlew ./
+COPY gradle ./gradle
+
+# 의존성 다운로드 (네트워크를 사용하는 단계이므로 먼저 실행)
+RUN ./gradlew --no-daemon dependencies
+
+# 전체 소스 복사
+COPY src ./src
+
+# assemble 대신 build 명령어를 사용해 테스트까지 함께 실행합니다.
+# Spring Boot의 테스트 프로필을 활성화하여 H2 DB를 사용하도록 합니다.
+RUN ./gradlew build --no-daemon -Dspring.profiles.active=test
+
+
+# 2. 실행 스테이지
+FROM openjdk:17-jdk-slim
+
+WORKDIR /app
+
+# 빌드 산출물(테스트가 통과된)을 복사
+COPY --from=builder /app/build/libs/*.jar app.jar
+
+# 컨테이너 실행
+ENTRYPOINT ["java", "-jar", "app.jar"]

HELP.md

@@ -0,0 +1,47 @@
+# Getting Started
+
+### Reference Documentation
+For further reference, please consider the following sections:
+
+* [Official Gradle documentation](https://docs.gradle.org)
+* [Spring Boot Gradle Plugin Reference Guide](https://docs.spring.io/spring-boot/3.5.5/gradle-plugin)
+* [Create an OCI image](https://docs.spring.io/spring-boot/3.5.5/gradle-plugin/packaging-oci-image.html)
+* [Spring Boot Testcontainers support](https://docs.spring.io/spring-boot/3.5.5/reference/testing/testcontainers.html#testing.testcontainers)
+* [Testcontainers MySQL Module Reference Guide](https://java.testcontainers.org/modules/databases/mysql/)
+* [Spring Web](https://docs.spring.io/spring-boot/3.5.5/reference/web/servlet.html)
+* [Validation](https://docs.spring.io/spring-boot/3.5.5/reference/io/validation.html)
+* [Spring Security](https://docs.spring.io/spring-boot/3.5.5/reference/web/spring-security.html)
+* [Spring Data JPA](https://docs.spring.io/spring-boot/3.5.5/reference/data/sql.html#data.sql.jpa-and-spring-data)
+* [Flyway Migration](https://docs.spring.io/spring-boot/3.5.5/how-to/data-initialization.html#howto.data-initialization.migration-tool.flyway)
+* [Spring Boot Actuator](https://docs.spring.io/spring-boot/3.5.5/reference/actuator/index.html)
+* [Testcontainers](https://java.testcontainers.org/)
+
+### Guides
+The following guides illustrate how to use some features concretely:
+
+* [Building a RESTful Web Service](https://spring.io/guides/gs/rest-service/)
+* [Serving Web Content with Spring MVC](https://spring.io/guides/gs/serving-web-content/)
+* [Building REST services with Spring](https://spring.io/guides/tutorials/rest/)
+* [Validation](https://spring.io/guides/gs/validating-form-input/)
+* [Securing a Web Application](https://spring.io/guides/gs/securing-web/)
+* [Spring Boot and OAuth2](https://spring.io/guides/tutorials/spring-boot-oauth2/)
+* [Authenticating a User with LDAP](https://spring.io/guides/gs/authenticating-ldap/)
+* [Accessing Data with JPA](https://spring.io/guides/gs/accessing-data-jpa/)
+* [Building a RESTful Web Service with Spring Boot Actuator](https://spring.io/guides/gs/actuator-service/)
+* [Accessing data with MySQL](https://spring.io/guides/gs/accessing-data-mysql/)
+
+### Additional Links
+These additional references should also help you:
+
+* [Gradle Build Scans – insights for your project's build](https://scans.gradle.com#gradle)
+
+### Testcontainers support
+
+This project uses [Testcontainers at development time](https://docs.spring.io/spring-boot/3.5.5/reference/features/dev-services.html#features.dev-services.testcontainers).
+
+Testcontainers has been configured to use the following Docker images:
+
+* [`mysql:latest`](https://hub.docker.com/_/mysql)
+
+Please review the tags of the used images and set them to the same as you're running in production.
+

build.gradle

@@ -1,48 +1,113 @@
+// buildscript 블록
+// 플러그인 자체와, 플러그인이 사용할 MySQL 라이브러리를 함께 정의.
+buildscript {
+    repositories {
+        gradlePluginPortal()
+    }
+    dependencies {
+        def flywayVersion = "11.11.2"
+        classpath "org.flywaydb:flyway-gradle-plugin:${flywayVersion}"
+        classpath "org.flywaydb:flyway-mysql:${flywayVersion}"
+    }
+}
+
 plugins {
-	id 'java'
-	id 'org.springframework.boot' version '3.5.5'
-	id 'io.spring.dependency-management' version '1.1.7'
+    id 'java'
+    id 'org.springframework.boot' version '3.5.5'
+    id 'io.spring.dependency-management' version '1.1.7'
+//    id 'org.flywaydb.flyway' version "11.11.2"
 }
 
-group = 'com.example'
+// buildscript에 정의한 플러그인 적용.
+apply plugin: 'org.flywaydb.flyway'
+
+group = 'com.issueDive'
 version = '0.0.1-SNAPSHOT'
-description = 'Demo project for Spring Boot'
+description = 'issueDive'
 
 java {
-	toolchain {
-		languageVersion = JavaLanguageVersion.of(17)
-	}
+    toolchain {
+        languageVersion = JavaLanguageVersion.of(17)
+    }
 }
 
 configurations {
-	compileOnly {
-		extendsFrom annotationProcessor
-	}
+    compileOnly {
+        extendsFrom annotationProcessor
+    }
 }
 
 repositories {
-	mavenCentral()
+    mavenCentral()
 }
 
 dependencies {
-	implementation 'org.springframework.boot:spring-boot-starter-actuator'
-	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.flywaydb:flyway-core'
-	implementation 'org.flywaydb:flyway-mysql'
-	compileOnly 'org.projectlombok:lombok'
-	runtimeOnly 'com.mysql:mysql-connector-j'
-	annotationProcessor 'org.projectlombok:lombok'
-	testImplementation 'org.springframework.boot:spring-boot-starter-test'
-	testImplementation 'org.springframework.boot:spring-boot-testcontainers'
-	testImplementation 'org.springframework.security:spring-security-test'
-	testImplementation 'org.testcontainers:junit-jupiter'
-	testImplementation 'org.testcontainers:mysql'
-	testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
+    implementation 'org.springframework.boot:spring-boot-starter-actuator'
+    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.flywaydb:flyway-core'
+    implementation 'org.flywaydb:flyway-mysql'
+    compileOnly 'org.projectlombok:lombok'
+    runtimeOnly 'com.mysql:mysql-connector-j'
+    annotationProcessor 'org.projectlombok:lombok'
+    testImplementation 'org.springframework.boot:spring-boot-starter-test'
+    testImplementation 'org.springframework.security:spring-security-test'
+    testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
+    testImplementation 'org.testcontainers:junit-jupiter'
+    testImplementation 'org.testcontainers:mysql'
+    testImplementation 'com.h2database:h2'
+//    flywayPlugin 'org.flywaydb:flyway-mysql' // flywayClean 같은 명령어 직접 사용 시 필요. 라이브러리 지정.
+
+    // QueryDsl
+    implementation 'com.querydsl:querydsl-jpa:5.0.0:jakarta'
+    annotationProcessor "com.querydsl:querydsl-apt:5.0.0:jakarta"
+    annotationProcessor "jakarta.annotation:jakarta.annotation-api"
+    annotationProcessor "jakarta.persistence:jakarta.persistence-api"
+
+    // API docs
+    implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.11'
+
+    runtimeOnly 'com.h2database:h2'
+
+    // JWT 의존성 추가
+    implementation 'io.jsonwebtoken:jjwt-api:0.11.5'
+    runtimeOnly 'io.jsonwebtoken:jjwt-impl:0.11.5'
+    runtimeOnly 'io.jsonwebtoken:jjwt-jackson:0.11.5'
+
+    // @MockitoBean 지원을 위한 의존성
+    testImplementation 'org.springframework.boot:spring-boot-testcontainers'
+    testImplementation 'org.mockito:mockito-core:5.11.0'
+
+    // Spring Boot Actuator
+    implementation 'org.springframework.boot:spring-boot-starter-actuator'
+    // Micrometer (Prometheus 연동을 위함)
+    implementation 'io.micrometer:micrometer-registry-prometheus'
+}
+
+// Query DSL 설정
+clean{
+    delete file('src/main/generated')
 }
 
 tasks.named('test') {
-	useJUnitPlatform()
+    useJUnitPlatform()
+    jvmArgs '-Xshare:off'
 }
+
+// Flyway 설정
+flyway {
+    // project.hasProperty()를 사용해 'dbUrl' 프로퍼티가 있을 때만 설정을 적용합니다.
+    // 이렇게 하면 CI 환경처럼 DB 정보가 없을 때 이 블록을 건너뛰게 됩니다.
+    // CI 환경 등에서 dbUrl 프로퍼티가 없을 수 있으므로,
+    // 해당 프로퍼티가 존재할 때만 url, user, password를 설정합니다.
+    if (project.hasProperty('dbUrl')) {
+        url = dbUrl
+        user = dbUser
+        password = dbPassword
+    }
+    locations = ['filesystem:src/main/resources/db/migration']
+    // cleanDisabled는 DB 연결 정보와 무관하므로 바깥에 두어도 안전합니다.
+    cleanDisabled = false
+}

docker-compose.yml

@@ -0,0 +1,41 @@
+version: '3.8'
+
+services:
+  mysql:
+    image: mysql:8
+    container_name: issueDive-mysql
+    environment:
+      MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD}
+      MYSQL_DATABASE: issue_dive
+    ports:
+      - "3306:3306"
+    volumes:
+      - mysql-data:/var/lib/mysql
+    healthcheck:
+      test: ["CMD", "mysqladmin" ,"ping", "-h", "localhost"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+
+  app:
+    build:
+      context: .
+      args:
+        - DB_URL=${SPRING_DATASOURCE_URL}
+        - DB_USER=${SPRING_DATASOURCE_USERNAME}
+        - DB_PASSWORD=${SPRING_DATASOURCE_PASSWORD}
+    container_name: issueDive-app
+    depends_on:
+      mysql:
+        condition: service_healthy
+    environment:
+      SPRING_DATASOURCE_URL: ${SPRING_DATASOURCE_URL}
+      SPRING_DATASOURCE_USERNAME: ${SPRING_DATASOURCE_USERNAME}
+      SPRING_DATASOURCE_PASSWORD: ${SPRING_DATASOURCE_PASSWORD}
+    ports:
+      - "8080:8080"
+    command: ./gradlew bootRun
+    tty: true
+
+volumes:
+  mysql-data: