Jacoco 도입 (#244)

* chore: jacoco 설정

* chore: CI workflow에 jacoco report 업로드 작업 추가

* chore: jacoco report 생성 경로를 기본값으로 변경

* chore: jacoco report 업로드 확인을 위해 임시로 커버리지 기준을 60으로 설정

* chore: jacoco 커버리지 기준 70으로 설정 및 update-comment 활성화

* chore: 이전 step들의 실패 여부와 상관없이 무조건 jacoco report 실행

* chore: jacoco에서 Q클래스 제외

* test: SuccessResponseCustomizer customize 단위 테스트

* chore: 변경된 파일에 대한 커버리지 누락 확인을 위해 'update-comment:true' 임시 주석 처리

* chore: 'update-comment:true' 주석 해제 및 Q클래스 제외 규칙 변경

* chore: CI 워크플로우에 Get the Coverage info 추가

* test: jacoco 변경 파일에 대한 커버리지 체크 여부 확인을 위한 테스트 임시 주석

* test: jacoco-report v1.6.1로 다운그레이드

* test: jacoco-report v1.7.2로 업그레이드

* test: jacoco report 확인을 위한 임의 클래스 및 테스트 코드 작성

* Revert "test: jacoco report 확인을 위한 임의 클래스 및 테스트 코드 작성"

This reverts commit a1f7a59.

Author: Hanjaemo

.github/workflows/continuous-intergration.yml

@@ -48,8 +48,18 @@ jobs:
           files: build/test-results/**/*.xml
 
       - name: Upload Jacoco Report
-        if: ${{ failure() }}
-        uses: actions/upload-artifact@v4.6.0
+        id: jacoco
+        uses: madrapps/jacoco-report@v1.7.2
+        if: always()
         with:
-          name: jacoco-report
-          path: build/reports/jacoco/test/html
+          title: 📊테스트 커버리지
+          paths: ${{ github.workspace }}/build/reports/jacoco/test/jacocoTestReport.xml
+          token: ${{ secrets.GITHUB_TOKEN }}
+          min-coverage-overall: 70
+          min-coverage-changed-files: 70
+          update-comment: true
+
+      - name: Get the Coverage info
+        run: |
+          echo "Total coverage ${{ steps.jacoco.outputs.coverage-overall }}"
+          echo "Changed Files coverage ${{ steps.jacoco.outputs.coverage-changed-files }}"

build.gradle

@@ -2,6 +2,7 @@ plugins {
     id 'java'
     id 'org.springframework.boot' version '3.4.1'
     id 'io.spring.dependency-management' version '1.1.7'
+    id 'jacoco'
 }
 
 group = 'org.ject'
@@ -24,6 +25,10 @@ repositories {
     maven { url 'https://s3-us-west-2.amazonaws.com/dynamodb-local/release' }
 }
 
+jacoco {
+    toolVersion = "0.8.12"
+}
+
 dependencies {
     // Boot
     implementation 'org.springframework.boot:spring-boot-starter-web'
@@ -131,13 +136,55 @@ configurations {
     querydsl.extendsFrom compileClasspath
 }
 
+def jacocoExcludes = [
+        '**/Q*',      // QueryDSL Q*
+        '**/exception/**',
+        '**/dto/**'
+]
+
 test {
     useJUnitPlatform(){
         // throughput test 제외
         excludeTags 'throughput'
     }
     // test profile로 테스트
     systemProperty 'spring.profiles.active', 'test'
+
+    // 테스트 종료 후 jacoco 실행
+    finalizedBy(jacocoTestReport)
+}
+
+jacocoTestReport {
+    reports {
+        html.required.set(true)
+        xml.required.set(true)
+    }
+
+    afterEvaluate {
+        classDirectories.setFrom(
+                files(classDirectories.files.collect {
+                    fileTree(dir: it, excludes: jacocoExcludes)
+                })
+        )
+    }
+
+    finalizedBy(jacocoTestCoverageVerification)
+}
+
+jacocoTestCoverageVerification {
+    violationRules {
+        rule {
+            enabled = true // 규칙 활성화
+
+            limit {
+                counter = "LINE" // 라인 커버리지
+                value = "COVEREDRATIO"
+                minimum = 0.70  // 최소 70% 이상 만족
+            }
+
+            excludes = jacocoExcludes
+        }
+    }
 }
 
 def generated = 'src/main/generated'

src/test/java/org/ject/support/common/springdoc/SuccessResponseCustomizerTest.java

@@ -0,0 +1,74 @@
+package org.ject.support.common.springdoc;
+
+import io.swagger.v3.oas.models.Operation;
+import io.swagger.v3.oas.models.media.Content;
+import io.swagger.v3.oas.models.media.MediaType;
+import io.swagger.v3.oas.models.media.ObjectSchema;
+import io.swagger.v3.oas.models.media.Schema;
+import io.swagger.v3.oas.models.media.StringSchema;
+import io.swagger.v3.oas.models.responses.ApiResponse;
+import io.swagger.v3.oas.models.responses.ApiResponses;
+import org.junit.jupiter.api.Test;
+
+import java.util.Map;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.ject.support.common.response.ApiResponseConstant.SUCCESS_STATUS_MESSAGE;
+
+class SuccessResponseCustomizerTest {
+
+    SuccessResponseCustomizer customizer = new SuccessResponseCustomizer();
+
+    @Test
+    void 응답이_2xx이면_공통스키마로_래핑한다() {
+        Operation op = new Operation();
+        ApiResponses responses = new ApiResponses();
+        op.setResponses(responses);
+
+        ApiResponse ok = new ApiResponse();
+        Content okContent = new Content();
+        MediaType okJson = new MediaType();
+        Schema<?> original200 = new StringSchema();
+        okJson.setSchema(original200);
+        okContent.addMediaType("application/json", okJson);
+        ok.setContent(okContent);
+        responses.addApiResponse("200", ok);
+
+        // when
+        customizer.customize(op, null);
+
+        // then
+        Schema<?> wrapped200 = op.getResponses()
+                .get("200").getContent().get("application/json").getSchema();
+        Map<String, Schema> properties = wrapped200.getProperties();
+        assertThat(properties).isNotNull();
+        assertThat(original200).isEqualTo(properties.get("data"));
+        assertThat(SUCCESS_STATUS_MESSAGE).isEqualTo(properties.get("status").getExample());
+        assertThat("2025-08-08T14:10:32.123").isEqualTo(properties.get("timestamp").getExample());
+    }
+
+    @Test
+    void 응답이_2xx가_아니면_래핑하지_않는다() {
+        // given
+        Operation op = new Operation();
+        ApiResponses responses = new ApiResponses();
+        op.setResponses(responses);
+
+        ApiResponse bad = new ApiResponse();
+        Content badContent = new Content();
+        MediaType badJson = new MediaType();
+        Schema<?> original400 = new ObjectSchema();
+        badJson.setSchema(original400);
+        badContent.addMediaType("application/json", badJson);
+        bad.setContent(badContent);
+        responses.addApiResponse("400", bad);
+
+        // when
+        customizer.customize(op, null);
+
+        // then
+        Schema<?> after = op.getResponses().get("400")
+                .getContent().get("application/json").getSchema();
+        assertThat(original400).isEqualTo(after);
+    }
+}