Jacoco

Jacoco란?

왜 사용하게 되었나?

Jacoco 적용

플러그인 추가

plugins {
	id 'org.springframework.boot' version '2.6.8'
	id 'io.spring.dependency-management' version '1.0.11.RELEASE'
	id "com.ewerk.gradle.plugins.querydsl" version "1.0.10"
	id 'java'
	id 'jacoco'
}
...

jacoco {
	toolVersion = '0.8.7'
}

테스트 후 jacocoTestReport 수행

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

jacocoTestReport

jacocoTestReport {
	reports {
		html.destination file("${buildDir}/jacocoHtml")
		xml.enabled false
		csv.enabled false
	}

	def Qdomains = []

	for (qPattern in '**/QA'..'**/QZ') {
		Qdomains.add(qPattern + '*')
	}

	afterEvaluate {
		classDirectories.setFrom(
				files(classDirectories.files.collect {
					fileTree(dir: it, excludes: [
							"com/prgrms/coretime/common/*",
							"**/dto/*",
							"**/domain/*",
							"**/controller/*",
							"**/util/*",
							"**/*Validator",
							"com/prgrms/coretime/CoretimeApplication.class"
					] + Qdomains)
				})
		)
	}

	finalizedBy 'jacocoTestCoverageVerification'
}

• reports
• 원하는 종류의 보고서(html, xml, csv)를 키고 끌 수 있다.
• 제공된 보고서가 어디에 저장될지 경로를 설정할 수 있다.
(html.destination file("${buildDir}/jacocoHtml"))

• 보고서에 포함되지 않을 클래스

	def Qdomains = []

	for (qPattern in '**/QA'..'**/QZ') {
		Qdomains.add(qPattern + '*')
	}

	afterEvaluate {
		classDirectories.setFrom(
				files(classDirectories.files.collect {
					fileTree(dir: it, excludes: [
							"com/prgrms/coretime/common/*",
							"**/dto/*",
							"**/domain/*",
							"**/controller/*",
							"**/util/*",
							"com/prgrms/coretime/CoretimeApplication.class"
					] + Qdomains)
				})
		)
	}

Jacoco 보고서에 포함되지 않을 클래스들을 위와 같이 설정할 수 있다. 현재는 Service 디렉토리에 포함된 클래스에 대해서만 보고서에서 확인할 수 있도록 설정하였다.
• Q도메인 제외

def Qdomains = []

for (qPattern in '**/QA'..'**/QZ') {
	Qdomains.add(qPattern + '*')
}

위 코드는 보고서에서 제외될 Q 도메인(QueryDsl을 사용함으로서 생성)의 패턴을 Qdomains 라는 배열에 추가하는 코드이다. 이 방법을 사용함으로서 Q 도메인만 제외할 수 있다고 한다.

• finalizedBy 'jacocoTestCoverageVerification'
jacocoTestReport 라는 태스크가 종료된 이후 jacocoTestCoverageVerification 라는 태스크를 진행하도록 한다.

jacocoTestCoverageVerification

jacocoTestCoverageVerification {
	def Qdomains = []

	for (qPattern in '*.QA'..'*.QZ') {
		Qdomains.add(qPattern + '*')
	}

	violationRules {
		rule {
			element = 'CLASS'

			limit {
				counter = 'LINE'
				value = 'COVEREDRATIO'
				minimum = 0.70
			}

			limit {
				counter = 'BRANCH'
				value = 'COVEREDRATIO'
				minimum = 0.70
			}

			excludes = [
			    "com.prgrms.coretime.common.*",
					"*.dto.*",
					"*.controller.*",
					"*.domain.*",
					"*.util.*",
					"*.*Validator",
					"com.prgrms.coretime.CoretimeApplication"
			] + Qdomains
		}
	}
}

• violationrules
violationRules로 커버리지 기준들을 설정할 수 있다.
• rule
커버리지 기준을 설정할 수 있다.
• element
커버리지 체크 기준을 설정할 수 있다. 현재는 클래스 단위로 커버리지를 확인할 수 있도록 설정하였다.
• limit
커버러지의 종류와 비율을 설정할 수 있다. 현재는 LINE, BRANCH 커버리지를 모두 70%로 설정한 상태이다. LINE 커버리지는 테스트 코드를 통해 실행된 실제 코드의 라인 수를 측정하는 방식이고 BRANCH 커버리지는 테스트 코드를 통해 실행된 분기문을 측정하는 방식이다.
• 커버리지를 적용하지 않을 클래스
Jacoco 보고서 설정과 거의 동일한 방식으로 클래스들을 제외할 수 있다. excludes에 커버리지에 포함되지 않을 클래스 명을 지정하여 제외하면 된다. 현재는 Service 디렉토리에 포함된 클래스에 대해서만 커버리지를 확인할 수 있도록 설정하였다.
• Q 도메인 제외

def Qdomains = []

for (qPattern in '*.QA'..'*.QZ') {
	Qdomains.add(qPattern + '*')
}

커버리지 확인에서도 Q도메인은 제외 시켜줘야한다.

마무리

참고 문서

Gradle 프로젝트에 JaCoCo 설정하기 | 우아한형제들 기술블로그

안녕하세요. 상품시스템팀에서 서버 개발(..새발)을 하고 있는 연철입니다. 프로젝트 세팅 중에 찾아보고 삽질했던 내용들이 도움이 될까 하여 남깁니다. JaCoCo 는 Java 코드의 커버리지를 체크하는 라이브러리입니다. 테스트코드를 돌리고 그 커버리지 결과를 눈으로 보기 좋도록 html이나 xml, csv 같은 리포트로 생성합니다. 그리고 테스트 결과가 내가 설정한 커버리지 기준을 만족하는지 확인하는 기능도 있습니다.

https://techblog.woowahan.com/2661/

코드 분석 도구 적용기 - 2편, JaCoCo 적용하기

이 글은 우아한테크코스에서 진행한 프로젝트인 직고래의 기술 블로그 에 함께 게시된 글입니다. 안녕하세요. 우아한테크코스 2기, 셀러리 컴퍼니에서 직고래 를 개발하고 있는 스티치(이준영)입니다. 코드 분석 도구 적용기 - 1편, 코드 커버리지(Code Coverage)가 뭔가요?에 이어서, 이번에는 프로젝트에 코드 커버리지 분석 도구인 JaCoCo를 어떻게 적용했는지 에 대해 소개해드리도록 하겠습니다.

https://velog.io/@lxxjn0/%EC%BD%94%EB%93%9C-%EB%B6%84%EC%84%9D-%EB%8F%84%EA%B5%AC-%EC%A0%81%EC%9A%A9%EA%B8%B0-2%ED%8E%B8-JaCoCo-%EC%A0%81%EC%9A%A9%ED%95%98%EA%B8%B0