테스트 코드 커버리지 분석 도구 Jacoco를 적용해보자!

Jacoco 란?

Java Code Coverage 의 줄임말로, 코드 커버리지 분석을 위한 라이브러리이다.

 

❓ 코드 커버리지란?

소프트웨어의 테스트 케이스가 얼마나 충족되었는지를 나타내는 지표 중 하나이다.

1. 라인 커버리지 : 코드 한 줄이 한 번 이상 실행된다면 충족된다.

2. 결정 커버리지 : 브랜치 커버리지라고도 불린다. 모든 조건식의 내부 조건이 true/ false 를 가지게 되면 충족한다.

3. 조건 커버리지 : if 조건문 안의 개별 조건식이 false 인경우와 true인 경우 모두 실행되었을 때 충족한다. 결정 커버리지보다 더 detail한 커버리지이다.

 

---

적용해보자

 

적용 전 build.gradle

plugins {
    id 'java'
    id 'org.springframework.boot' version '3.1.2'
    id 'io.spring.dependency-management' version '1.1.2'
}

group = 'com'
version = '0.0.1-SNAPSHOT'

java {
    sourceCompatibility = '17'
}

configurations {
    compileOnly {
        extendsFrom annotationProcessor
    }
}

repositories {
    mavenCentral()
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    compileOnly 'org.projectlombok:lombok'
    runtimeOnly 'com.mysql:mysql-connector-j'
    annotationProcessor 'org.springframework.boot:spring-boot-configuration-processor'
    annotationProcessor 'org.projectlombok:lombok'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

tasks.named('test') {
    useJUnitPlatform()
}

 

 

plugin 추가

plugins {
    id 'java'
    id 'org.springframework.boot' version '3.1.2'
    id 'io.spring.dependency-management' version '1.1.2'
	
    // 추가 된 부분
    id 'jacoco'
}

 

jacoco 플러그인을 추가한다.

 

 

jacoco 버전과 분석 리포트 경로 설정

jacoco {
    toolVersion = "0.8.10"
    reportsDirectory = layout.buildDirectory.dir('jacocoReport')
}

 

위와 같이 분석 리포트가 생성되는 경로를 지정하면, build > jacocoReport 라는 디렉토리가 생성되고

 

해당 디렉토리 안에 리포트가 생성된다.

 

 

test task 실행 후 jacocoTestReport 실행 되게끔 설정

// 기존에 있던 아래 코드 제거
//
// tasks.named('test') {
//     useJUnitPlatform()
// }

test {
    finalizedBy jacocoTestReport
    useJUnitPlatform()
}

 

위와 같이 수정한다.

 

finalizedBy jacocoTestReport는 test task 실행 후, jacocoTestReport task 를 실행하게끔 하는 구문이다.

 

테스트를 실행할때마다 jacoco 리포트가 생성될 것이다. (제외하고 싶은 사람은 제외해도 된다. 대신 분석 리포트를 생성하려면 따로 실행해야한다.)

 

 

jacocoTestReport task 설정

jacocoTestReport {

    dependsOn test

    reports {
        xml.required = false
        csv.required = false
        html.required = true
    }

    afterEvaluate {
        classDirectories.setFrom(
                files(classDirectories.files.collect {
                    fileTree(dir: it, excludes: [
                            '**/domain/**',
                            '**/global/**',
                            '**/*Application*'
                    ])
                })
        )
    }
    finalizedBy 'jacocoTestCoverageVerification'
}

 

dependsOn test 로 test task 실행 뒤 실행되도록 명시한다.

 

reports 는 html 파일로만 확인할 것이므로 html.required 만 true로 한다.

 

그리고 afterEvaluate{ ... } 구문의 excludes : [ ... ] 안에 분석 리포트에서 제외할 클래스를 선택한다.

 

나는 service 코드와 controller 클래스만 커버리지를 점검하기 위해, 프로젝트 내의 domain · global 디렉토리 그리고 Application 클래스 파일을 제외했다.

 

그리고  finalizedBy 'jacocoTestCoverageVerification' 를 통해 다음 진행할 task를 설정한다.

 

 

jacocoTestCoverageVerification task 설정

jacocoTestCoverageVerification {
    violationRules {
        rule {
            enabled = true;
            element = 'CLASS'

            // 라인 커버리지 제한을 90%로 설정
            limit {
                counter = 'LINE'
                value = 'COVEREDRATIO'
                minimum = 0.90
            }

            excludes = [
                    '**.*Application',
                    '**.domain.**',
                    '**.global.**'

            ]
        }

    }
}

 

위 부분은, 커버리지 기준을 설정할 수 있다.

 

클래스 단위로 라인 커버리지를 최소 90% 만족시켜야 하는 옵션을 설정했다.

 

또한, 커버리지 검증에서 제외할 경로도 추가했다. 

 

jacocoTestReport 에서 사용했던 표현식과는 약간 차이가 있으니 주의해야한다.

 

위에서 설정한 커버리지를 만족하지 목하면 빌드 과정에서 에러가 발생하도록 되어 있어 테스트 코드를 짜게금 강조할 수 있고 안전한 코드를 지향할 수 있게 된다.

 

 

적용 후 build.gradle

plugins {
    id 'java'
    id 'org.springframework.boot' version '3.1.2'
    id 'io.spring.dependency-management' version '1.1.2'

    id 'jacoco'
}

group = 'com'
version = '0.0.1-SNAPSHOT'

java {
    sourceCompatibility = '17'
}

configurations {
    compileOnly {
        extendsFrom annotationProcessor
    }
}

repositories {
    mavenCentral()
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    compileOnly 'org.projectlombok:lombok'
    runtimeOnly 'com.mysql:mysql-connector-j'
    annotationProcessor 'org.springframework.boot:spring-boot-configuration-processor'
    annotationProcessor 'org.projectlombok:lombok'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

test {
    finalizedBy jacocoTestReport
    useJUnitPlatform()
}


jacoco {
    toolVersion = "0.8.10"
    reportsDirectory = layout.buildDirectory.dir('jacocoReport')
}


jacocoTestReport {

    dependsOn test

    reports {
        xml.required = false
        csv.required = false
        html.required = true
    }

    afterEvaluate {
        classDirectories.setFrom(
                files(classDirectories.files.collect {
                    fileTree(dir: it, excludes: [
                            '**/domain/**',
                            '**/global/**',
                            '**/*Application*'
                    ])
                })
        )
    }
    finalizedBy 'jacocoTestCoverageVerification'
}

jacocoTestCoverageVerification {
    violationRules {
        rule {
            enabled = true;
            element = 'CLASS'

            // 라인 커버리지 제한을 90%로 설정
            limit {
                counter = 'LINE'
                value = 'COVEREDRATIO'
                minimum = 0.90
            }

            excludes = [
                    '**.*Application',
                    '**.domain.**',
                    '**.global.**'

            ]
        }

    }
}

 

---

Jacoco Report 확인

 

이제 다시 빌드를 하고, 터미널에 

./gradlew clean test

 

위 명령어를 입력하거나

 

 

intellij 에서 test task를 클릭하면 분석 리포트가 생성된다.

 

 

 

설정했던 경로에 index.html 이라는 리포트가 생성되었고 열어보면

 

라인 커버리지와 브랜치 커버리지를 눈으로 확인할 수 있다.

 

 

클릭해서 상세 화면을 들어가면, 위와 같이 라인 커버리지를 확인할 수 있다.

 

---

트러블 슈팅

 

만약, test 리포트가 생성이 잘 안되거나 리포트 내의 한글이 깨지거나 하는 경우는

 

실제 프로젝트가 존재하는 경로에 한글로 된 디렉토리가 포함되어있는지 확인해보는 것이 좋다.

 

나도 분석 결과 리포트에 주석으로 써놓은 한글이 계속 깨져서 한참을 해결해보려다가

 

실제 컴퓨터에 저장되어 있는 프로젝트의 경로가 한글로 된 디렉토리 내에 있었고,

 

이를 해결하니 한글이 잘 나오게 되었다.