멀티모듈 JaCoCo 집계된 커버리지 보고서를 기준으로 빌드 검증

🌱 문제 상황

2024.07.24 - [Back-end] - [Spring Boot] 멀티모듈에 JaCoCo + JaCoCo Report Aggregation 적용하기

[Spring Boot] 멀티모듈에 JaCoCo + JaCoCo Report Aggregation 적용하기

이전에 멀티모듈 + JaCoCo Report Aggregation을 사용하여 테스트 커버리지를 확인하고 검증하는 기능을 적용해 보았다.

 

각 모듈에서의 결과 보고서를 집계한 종합 보고서를 완성하는 데는 성공했지만 직면하게 된 또 다른 문제점이 있었다.

간단하게 설명하자면 내 프로젝트에는 app, admin, domain 모듈이 있는데 도메인 모듈의 메서드 테스트가 다른 모듈(app 또는 admin 모듈)에서 실행되어 도메인 모듈 자체의 커버리지가 낮게 나오는 문제가 발생했다.

 

JaCoCo는 각 모듈별로 테스트 커버리지를 계산하는데, 도메인 모듈의 코드가 다른 모듈의 테스트에서만 실행되어 JacocoTestCoverageVerification 단계에서 도메인 모듈의 커버리지 기준을 충족하지 못해 빌드가 실패하게 되었다.

Rule violated for class Bid: lines covered ratio is 0.13, but expected minimum is 0.80
Rule violated for class User: lines covered ratio is 0.36, but expected minimum is 0.80
...

왼쪽은 도메인 모듈의 보고서, 오른쪽은 전체 모듈 종합 보고서이다. 이처럼 같은 코드를 테스트했음에도 불구하고, 도메인 모듈의 커버리지가 낮게 나오는 것을 확인할 수 있다.

 

🌱 해결 방안

내가 생각해 낸 방법은 두 가지가 있었다. 첫 번째 방법은 어쩔 수 없이 도메인 모듈 자체에서 메서드들을 직접 테스트하는 단위 테스트를 추가하는 것.. 두 번째 방법은 JaCoCo의 설정을 조정해 다른 모듈의 테스트 실행 결과도 도메인 모듈의 커버리지에 포함되도록 하는 것이었다.

 

이미 다른 모듈에서 테스트된 코드에 대해 중복 테스트를 작성하는 것은 비효율적이라 생각했고, 오히려 다른 모듈의 테스트 실행 결과를 커버리지에 함께 반영하는 것이 실제 사용하는 시나리오에 더 정확한 결과를 얻을 수 있을 것이라 생각하여 JaCoCo의 설정을 조정하는 방식으로 해결해 보기로 했다.

 

subprojects {
    apply plugin: 'java'
    apply plugin: 'jacoco'

    jacoco {
        toolVersion = '0.8.12'
    }

    test {
        finalizedBy 'jacocoTestReport'
    }

    jacocoTestReport {
        ...
    }

    jacocoTestCoverageVerification {
        enabled = false	// JaCoCo 검증 비활성화
    }
}

우선 각 모듈에서 jacocoTestCoverageVerification 태스크를 비활성화한다.

 

project(':support:jacoco') {
    apply plugin: 'jacoco-report-aggregation'
    
    testCodeCoverageReport {
        ...
    }
    
    ...
    
    task jacocoRootCoverageVerification(type: JacocoCoverageVerification) {
        dependsOn testCodeCoverageReport

        // 커버리지 측정할 소스 디렉토리 지정
        // 모든 서브 프로젝트의 소스 디렉토리 포함
        sourceDirectories.setFrom(files(allProjects
                .collect { it.sourceSets.main.allSource.srcDirs }))
        
        // 소스 디렉토리 내 클래스를 컴파일 한 결과인 *.class 파일이 있는 디렉토리를 지정
        // 각 서브 프로젝트의 빌드 디렉토리 내의 클래스 파일
        classDirectories.setFrom(files(allProjects
                .collect { it.fileTree(dir: "${it.buildDir}/classes/java/main", exclude:
                        Qdomains + excludeFromCoverage.stream()
                                .map(s -> s + ".class")
                                .collect(Collectors.toList())) }))
                                
        // 모든 서브 프로젝트에서 생성된 JaCoCo 실행 데이터 포함
        executionData.setFrom(files(allProjects.collect { it.jacocoTestReport.executionData }))

        violationRules {
            rule {
                enabled = true
                element = "CLASS"
                limit {
                    counter = "LINE"
                    value = "COVEREDRATIO"
                    minimum = 0.80
                }
                excludes += Qdomains.stream()
                        .map(s -> s.replace("/", "."))
                        .collect(Collectors.toList()) +
                        excludeFromCoverage.stream()
                        .map(s -> s.replace("/", "."))
                        .collect(Collectors.toList())
            }
        }
    }

    check.dependsOn jacocoRootCoverageVerification
}

 

jacocoRootCoverageVerification 태스크는 모든 서브 프로젝트의 소스 디렉토리, 클래스 파일, JaCoCo 실행 데이터를 포함하여 커버리지를 측정해 각 모듈의 테스트 결과를 종합한 전체 커버리지 보고서를 생성한다. 그 후 rule을 지정해 커버리지 기준을 만족했는지 확인한다. 이렇게 수정할 경우 다른 모듈에서 수행된 테스트 결과도 도메인 모듈의 커버리지에 반영되기 때문에 중복 테스트를 작성할 필요 없이 전체적인 코드 커버리지를 기준으로 검증할 수 있게 된다.