chore: JaCoCo와 SonarCloud를 연동한 Gradle 빌드 및 품질 관리 시스템 구축 (#30)

* [BOOK-94] refactor: root - 프로젝트 root 이름 변경

* [BOOK-94] chore: SonarCloud와 JaCoCo를 활용한 코드 품질 및 테스트 커버리지 관리 기능 추가

* [BOOK-94] refactor: CI 워크플로우에 fullCheck 태스크 적용

* [BOOK-94] fix: executionData 설정 방식을 각 하위 모듈의 build/jacoco/test.exec 파일 경로를 지연된 방식으로 참조하도록 수정

* [BOOK-94] refactor: 코드레빗 리뷰 반영

* [BOOK-94] chore: (임시) info -> debug로 빌드 실패 원인 파악

* [BOOK-94] chore: debug -> info로 변경

* [BOOK-94] refactor: classesDirs를 사용하여 JaCoCo 분석 대상 경로 명시

- 현재 프로젝트는 Kotlin으로만 작성되어 'build/classes/java/main' 디렉토리가 존재하지 않습니다.
- 하지만 JaCoCo는 기본적으로 이 경로를 확인하려 시도하여 불필요한 "not found" 경고가 발생했습니다.
- 이를 해결하기 위해, classDirectories가 실제로 컴파일된 클래스 파일이 있는 경로('classesDirs')만 참조하도록 설정을 최적화하여 경고 로그를 제거했습니다.

* [BOOK-94] fix: 중복 인덱싱 방지 로직 추가

* [BOOK-94] fix: 테스트하지 않는 코드 패턴을 명시하여 중복 인덱싱 방지

* [BOOK-94] fix: classes/kotlin/main로 경로 명확히 지정

* [BOOK-94] fix: 자동 탐지와 수동 설정 충돌 해결

* [BOOK-94] chore: 주석 제거

* [BOOK-94] chore: 코드레빗 리뷰 반영

* [BOOK-94] chore: 코드레빗 리뷰 반영

* [BOOK-94] fix: 패턴 수정

* [BOOK-94] refactor: 코드레빗 리뷰 반영

Author: move-hoon

.github/workflows/ci-pr.yml

@@ -17,7 +17,7 @@ concurrency:
 jobs:
   build-validation:
     runs-on: ubuntu-24.04
-    timeout-minutes: 10
+    timeout-minutes: 15
 
     steps:
       - name: Checkout code
@@ -44,8 +44,18 @@ jobs:
         with:
           gradle-home-cache-cleanup: true
 
+      - name: Cache SonarCloud packages
+        uses: actions/cache@v4
+        with:
+          path: ~/.sonar/cache
+          key: ${{ runner.os }}-sonar
+          restore-keys: ${{ runner.os }}-sonar
+
       - name: Grant execute permission for gradlew
         run: chmod +x gradlew
 
-      - name: Run Gradle check (fast validation)
-        run: ./gradlew check --parallel --build-cache
+      - name: Run full check and SonarCloud analysis
+        env:
+          GITHUB_TOKEN: ${{ secrets.PAT_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        run: ./gradlew fullCheck --parallel --build-cache --info --stacktrace

build.gradle.kts

@@ -8,7 +8,8 @@ plugins {
     kotlin(Plugins.Kotlin.Short.SPRING) version Versions.KOTLIN
     kotlin(Plugins.Kotlin.Short.JPA) version Versions.KOTLIN
     id(Plugins.DETEKT) version Versions.DETEKT
-    id(Plugins.KOVER) version Versions.KOVER
+    id(Plugins.JACOCO)
+    id(Plugins.SONAR_QUBE) version Versions.SONAR_QUBE
 }
 
 allprojects {
@@ -19,29 +20,41 @@ allprojects {
     }
 }
 
+// 테스트하지 않는 코드 패턴 (JaCoCo + SonarQube 커버리지 + CPD 공통)
+val testExclusionPatterns = listOf(
+    "**/*Application*",
+    "**/config/**",
+    "**/*Config*",
+    "**/exception/**",
+    "**/*Exception*",
+    "**/*ErrorCode*",
+    "**/dto/**",
+    "**/*Request*",
+    "**/*Response*",
+    "**/*Entity*",
+    "**/annotation/**",
+    "**/generated/**"
+)
+
+// SonarQube 전체 분석 제외 패턴 (분석 자체가 의미 없는 파일들)
+val sonarGlobalExclusions = listOf(
+    "**/build/**",
+)
+
 subprojects {
     apply(plugin = Plugins.SPRING_BOOT)
     apply(plugin = Plugins.SPRING_DEPENDENCY_MANAGEMENT)
     apply(plugin = Plugins.Kotlin.SPRING)
     apply(plugin = Plugins.Kotlin.JPA)
     apply(plugin = Plugins.Kotlin.JVM)
+    apply(plugin = Plugins.JACOCO)
 
     java {
         toolchain {
             languageVersion.set(JavaLanguageVersion.of(Versions.JAVA_VERSION.toInt()))
         }
     }
 
-    dependencyManagement {
-        imports {
-            mavenBom("org.springframework.cloud:spring-cloud-dependencies:2025.0.0")
-        }
-    }
-
-    tasks.withType<Test> {
-        useJUnitPlatform()
-    }
-
     plugins.withId(Plugins.Kotlin.ALLOPEN) {
         extensions.configure<org.jetbrains.kotlin.allopen.gradle.AllOpenExtension> {
             annotation("jakarta.persistence.Entity")
@@ -53,14 +66,150 @@ subprojects {
     // Configure Kotlin compiler options
     tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {
         kotlinOptions {
-            freeCompilerArgs = listOf("-Xjsr305=strict")
+            freeCompilerArgs += listOf(
+                "-Xjsr305=strict",
+                "-Xconsistent-data-class-copy-visibility"
+            )
             jvmTarget = Versions.JAVA_VERSION
-            freeCompilerArgs += "-Xconsistent-data-class-copy-visibility"
         }
     }
 }
 
+// 루트 프로젝트에서 모든 JaCoCo 설정 관리
+configure(subprojects) {
+    jacoco {
+        toolVersion = Versions.JACOCO
+    }
+
+    tasks.withType<Test> {
+        useJUnitPlatform()
+        finalizedBy("jacocoTestReport")
+
+        testLogging {
+            events("passed", "skipped", "failed")
+            showStandardStreams = false
+        }
+    }
+
+    // 각 서브모듈의 JaCoCo 테스트 리포트 설정
+    tasks.withType<JacocoReport> {
+        dependsOn("test")
+        reports {
+            xml.required.set(true)
+            csv.required.set(false)
+            html.required.set(true)
+        }
+
+        classDirectories.setFrom(fileTree(layout.buildDirectory.dir("classes/kotlin/main")) {
+            exclude(testExclusionPatterns)
+        })
+
+        executionData.setFrom(fileTree(layout.buildDirectory) {
+            include("jacoco/*.exec")
+        })
+    }
+}
+
 tasks {
     withType<Jar> { enabled = true }
     withType<BootJar> { enabled = false }
 }
+
+// 루트 프로젝트 JaCoCo 통합 리포트 설정
+tasks.register<JacocoReport>("jacocoRootReport") {
+    description = "Generates an aggregate report from all subprojects"
+    group = "reporting"
+
+    dependsOn(subprojects.map { it.tasks.named("test") })
+
+    sourceDirectories.setFrom(subprojects.map { it.the<SourceSetContainer>()["main"].allSource.srcDirs })
+    classDirectories.setFrom(subprojects.map { subproject ->
+        subproject.fileTree(subproject.layout.buildDirectory.get().asFile.resolve("classes/kotlin/main")) {
+            exclude(testExclusionPatterns)
+        }
+    })
+    executionData.from(subprojects.map { subproject ->
+        subproject.fileTree(subproject.layout.buildDirectory.dir("jacoco")) {
+            include("**/*.exec")
+        }
+    })
+
+    reports {
+        xml.required.set(true)
+        csv.required.set(false)
+        html.required.set(true)
+    }
+}
+
+// SonarQube 설정을 루트에서 모든 서브모듈에 대해 설정
+sonar {
+    properties {
+        property("sonar.projectKey", "YAPP-Github_26th-App-Team-1-BE")
+        property("sonar.organization", "yapp-github")
+        property("sonar.host.url", "https://sonarcloud.io")
+        property(
+            "sonar.coverage.jacoco.xmlReportPaths",
+            "${layout.buildDirectory.get()}/reports/jacoco/jacocoRootReport/jacocoRootReport.xml"
+        )
+        property("sonar.kotlin.coveragePlugin", Plugins.JACOCO)
+        property("sonar.kotlin.version", Versions.KOTLIN)
+        property("sonar.exclusions", sonarGlobalExclusions.joinToString(","))
+        property("sonar.cpd.exclusions", testExclusionPatterns.joinToString(","))
+        property("sonar.coverage.exclusions", testExclusionPatterns.joinToString(","))
+    }
+}
+
+// SonarQube 태스크가 통합 JaCoCo 리포트에 의존하도록 설정
+tasks.named("sonar") {
+    dependsOn("jacocoRootReport")
+}
+
+/**
+ * CI용 - 전체 품질 검증 파이프라인을 실행합니다. (테스트, 커버리지, SonarQube 분석)
+ * GitHub Actions에서 이 태스크 하나만 호출합니다.
+ * 사용 예: ./gradlew fullCheck
+ */
+tasks.register("fullCheck") {
+    description = "Runs all tests, generates reports, and performs SonarQube analysis"
+    group = "Verification"
+    dependsOn("testAll", "jacocoTestReportAll")
+    finalizedBy("sonar")
+}
+
+/**
+ * 로컬용 - SonarQube 분석 없이 빠르게 테스트 커버리지만 확인합니다.
+ * 사용 예: ./gradlew checkCoverage
+ */
+tasks.register("checkCoverage") {
+    description = "Runs tests and generates coverage reports without SonarQube analysis"
+    group = "Verification"
+    dependsOn("testAll", "jacocoTestReportAll")
+}
+
+/**
+ * 로컬용 - 빌드 과정에서 생성된 모든 리포트를 삭제합니다.
+ * 사용 예: ./gradlew cleanReports
+ */
+tasks.register("cleanReports") {
+    description = "Cleans all generated reports"
+    group = "Cleanup"
+    doLast {
+        subprojects.forEach { subproject ->
+            delete(subproject.layout.buildDirectory.dir("reports"))
+        }
+        delete(layout.buildDirectory.dir("reports"))
+    }
+}
+
+tasks.register("testAll") {
+    description = "Runs tests in all subprojects"
+    group = "Verification"
+    dependsOn(subprojects.map { it.tasks.named("test") })
+}
+
+tasks.register("jacocoTestReportAll") {
+    description = "Generates JaCoCo test reports for all subprojects and creates aggregate report"
+    group = "Verification"
+    dependsOn(subprojects.map { it.tasks.named("jacocoTestReport") })
+    finalizedBy("jacocoRootReport")
+}

buildSrc/src/main/kotlin/Plugins.kt

@@ -3,6 +3,8 @@ object Plugins {
     const val SPRING_DEPENDENCY_MANAGEMENT = "io.spring.dependency-management"
     const val DETEKT = "io.gitlab.arturbosch.detekt"
     const val KOVER = "org.jetbrains.kotlinx.kover"
+    const val JACOCO = "jacoco"
+    const val SONAR_QUBE = "org.sonarqube"
 
     object Kotlin {
         const val ALLOPEN = "org.jetbrains.kotlin.plugin.allopen"

buildSrc/src/main/kotlin/Versions.kt

@@ -3,6 +3,7 @@ object Versions {
     const val SPRING_DEPENDENCY_MANAGEMENT = "1.1.7"
     const val KOTLIN = "1.9.25"
     const val DETEKT = "1.23.1"
-    const val KOVER = "0.9.1"
+    const val SONAR_QUBE = "6.2.0.5505"
+    const val JACOCO = "0.8.13"
     const val JAVA_VERSION = "21"
 }

settings.gradle.kts

@@ -1,4 +1,4 @@
-rootProject.name = "multi-module-test"
+rootProject.name = "reed"
 
 include(
     "admin",