<div id="readability-page-1" class="page"><div><h2 id="jacoco">Jacoco</h2>
<p>자바 코드커버리지를 측정할 때 사용하는 오픈소스 라이브러리</p>
<ul>
<li>라인 커버리지 제공</li>
<li>브랜치 커버리지(조건분기문의 Boolean expression이 참/거짓으로 모두 실행 되었는지) 제공</li>
<li>커버리지 결과를 xml, html, csv 등의 파일로 저장가능</li>
<li>기준을 설정해줘서 특정 커버리지 기준을 만족하는지 확인 가능</li>
</ul>
<h3 id="설정-방법">설정 방법</h3>
<ol>
<li>플러그인 추가</li>
</ol>
<pre><code>plugins {
    id 'jacoco'
}</code></pre>
<p><img src="https://user-images.githubusercontent.com/45876793/128545845-7ea3468a-14cd-4281-bbe4-b0d5c51884a5.png"></p><p>jacocoTestCoverageVerification: 원하는 커버리지 기준을 만족하는지 확인해 주는 Task</p>
<p>jacocoTestReport: 커버리지 결과를 xml, html, csv 등의 파일로 저장</p>
<ol start="2">
<li>Jacoco 플러그인 설정</li>
</ol>
<pre><code>jacoco {
    toolVersion = '0.8.5' 
    // reportsDir = ${project.reporting.baseDir}/jacoco - 따로 설정해 주지 않을 경우 기본 경로
}</code></pre>
<p>0.8.0 버전부터 lombok 사용으로 생기는 @Getter, @Builder등을 테스트 커버리지에서 제외시키기 위한 설정을 적용할 수 있음.</p>
<ol start="3">
<li>jacocoTestReport 설정</li>
</ol>
<p>*소나큐브와 연동하기 위해서 xml로 파일로 만들어주기</p>
<pre><code>jacocoTestReport {
    reports {
        html.enabled true // html 만들어 - 로컬에서 쉽게 보기 위함
        xml.enabled true // xml 만들어 - 소나큐브 연동 위함
        csv.enabled false // csv 안 만들어 

        // xml.destination file("${buildDir}/jacoco/result.xml") // 여기 저장할 것이라는 뜻.
    }
}</code></pre>
<p>destination 설정을 하지 않으면, html은 <code>build/reports/jacoco/test/html/index.html</code>에 생기고, xml은 <code>build/reports/jacoco/test/jacocoTestReport.xml</code>에 생성된다.</p>
<ol start="4">
<li>jacocoTestCoverageVerification 설정</li>
</ol>
<p><a href="https://www.eclemma.org/jacoco/trunk/doc/api/org/jacoco/core/analysis/ICoverageNode.ElementType.html">rule.element</a>: <code>BUNDLE</code>(default), <code>CLASS</code>, <code>GROUP</code>, <code>METHOD</code>, <code>PACKAGE</code>, <code>SOURCEFILE</code></p>
<p><a href="https://www.eclemma.org/jacoco/trunk/doc/api/org/jacoco/core/analysis/ICoverageNode.CounterEntity.html">rule.limit.counter</a>: <code>INSTRUCTION</code>(default),<code>BRANCH</code>, <code>CLASS</code>, <code>COMPLEXITY</code>, <code>METHOD</code>, <code>LINE</code></p>
<p><a href="https://www.eclemma.org/jacoco/trunk/doc/api/org/jacoco/core/analysis/ICounter.CounterValue.html">rule.limit.value</a>: <code>COVEREDRATIO</code>(default), <code>COVEREDCOUNT</code>,  <code>MISSEDCOUNT</code>, <code>MISSEDRATIO</code>, <code>TOTALCOUNT</code></p>
<pre><code>jacocoTestCoverageVerification {
    violationRules {
        rule {
            enabled = true // 이 rule을 적용할 것이다.
            element = 'CLASS' // class 단위로

            // 브랜치 커버리지 최소 50%
            limit {
                counter = 'BRANCH'
                value = 'COVEREDRATIO'
                minimum = 0.50
            }

            // 라인 커버리지 최소한 80%
            limit {
                counter = 'LINE'
                value = 'COVEREDRATIO'
                minimum = 0.80
            }

            // 빈 줄을 제외한 코드의 라인수 최대 300라인
            limit {
                counter = 'LINE'
                value = 'TOTALCOUNT'
                maximum = 300
            }

            // 커버리지 체크를 제외할 클래스들
            excludes = []
        }
    }
}</code></pre>
<ol start="5">
<li>test task 설정</li>
</ol>
<pre><code>test {
    jacoco {
	// 아래 설정들은 모두 기본 값. 따라서 변경할 것이 없다면 적어주지 않아도 됨
        enabled = true
        destinationFile = file("$buildDir/jacoco/${name}.exec")
        includes = []
        excludes = []
        excludeClassLoaders = []
        includeNoLocationClasses = false
        sessionId = "<span><span><span>&lt;</span>auto-generated</span> <span>value</span><span>&gt;</span></span>"
        dumpOnExit = true
        classDumpDir = null
        output = JacocoTaskExtension.Output.FILE
        address = "localhost"
        port = 6300
        jmx = false
    }
}</code></pre>
<ol start="6">
<li>최종<br>
test -&gt; jacocoTestReport -&gt; jacocoTestCoverageVerification 순으로 실행되어야한다.<br>
finalizedBy로 순서 지정</li>
</ol>
<pre><code>plugins {
    // ...
    id 'jacoco'
}

//...

test {
    // ...
    finalizedBy 'jacocoTestReport'
}

jacoco {
    toolVersion = '0.8.5'
}

jacocoTestReport {
    reports {
        html.enabled true
        xml.enabled true
        csv.enabled false

        xml.destination file("$buildDir/jacoco/jacoco.xml")
    }

    // 코드 커버리지 기준을 만족해야지 build 성공
    finalizedBy 'jacocoTestCoverageVerification'
}

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

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

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

            limit {
                counter = 'LINE'
                value = 'TOTALCOUNT'
                maximum = 300
            }

            excludes = []
        }
    }
}</code></pre>
<h2 id="sonarqube">SonarQube</h2>
<p>버그, 코드 스멜, 보안 취약점을 발견할 목적으로 정적 코드 분석으로 자동 리뷰를 수행하기 위한 지속적인 코드 품질 검사용 오픈 소스 플랫폼</p>
<h3 id="ubuntu에-설치">ubuntu에 설치</h3>
<pre><code>docker pull sonarqube</code></pre>
<pre><code>docker run -d --name sonarqube -p 9000:9000 sonarqube</code></pre>
<h3 id="설정">설정</h3>
<p>접속<br>
http://[EC2 인스턴스 public ip]:9000</p>
<p>기본 계정<br>
id: admin<br>
password: admin</p>
<p>프로젝트 생성<br>
<img src="https://user-images.githubusercontent.com/45876793/128550180-70c8d41b-ba31-4d6a-bb50-0a197104f43e.png"></p>
<p><img src="https://user-images.githubusercontent.com/45876793/128550246-99b107a5-b0c2-4ed8-8763-85ab83bef63f.png"></p><p>토큰 발급<br>
<img src="https://user-images.githubusercontent.com/45876793/128550280-024e5fc9-1784-4db2-9b14-44f2875a89b7.png"></p>
<h3 id="프로젝트에서-설정">프로젝트에서 설정</h3>
<ol>
<li>플러그인 추가</li>
</ol>
<pre><code>plugins {
    id "org.sonarqube" version "3.3"
}</code></pre>
<ol start="2">
<li>프로퍼티 설정</li>
</ol>
<pre><code>sonarqube {
    properties {
        property "sonar.projectKey", "dropthecode"
        property "sonar.host.url", "${sonarQube 인스턴스 ip:9000}"
        property "sonar.language", "java"
        property "sonar.sourceEncoding", "UTF-8"
        property "sonar.sources", "src/main/java"
        property "sonar.tests", "src/test/java"
        property "sonar.coverage.jacoco.xmlReportPaths", "${buildDir}/reports/jacoco/test/jacocoTestReport.xml" // jacoco xml 파일 위치
        property "sonar.java.binaries", "${buildDir}/classes"
        property "sonar.test.inclusions", "**/*Test.java"
        property "sonar.exclusions", "**/util/**, **/support/**, **/dto/**" // 제외할 클래스들 
    }
}</code></pre>
<ul>
<li>jacoco에서 exclude에 코드 커버리지 검사를 하지 않을 클래스를 설정해줘도, sonarQube에는 적용되지 않는다. 따라서 sonarQube에서도 해당 클래스를 제외하고 싶다면 <code>sonar.exclusions</code> 설정을 해줘야한다.</li>
</ul>
<h3 id="실행">실행</h3>
<p>test 실행 후 `./gradlew sonarqube -Dsonar.login=${위에서 발급 받은 토큰}</p>
<h3 id="reference">reference</h3>
<ul>
<li>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#jacoco-%ED%94%8C%EB%9F%AC%EA%B7%B8%EC%9D%B8-%EC%B6%94%EA%B0%80</li>
<li>https://stackoverflow.com/questions/41724423/how-can-i-exclude-files-of-the-code-coverage-of-sonarqube-using-jacoco-maven-plu</li>
</ul></div></div>

air.log

Jacoco
자바 코드커버리지를 측정할 때 사용하는 오픈소스 라이브러리
라인 커버리지 제공
브랜치 커버리지(조건분기문의 Boolean expression이 참/거짓으로 모두 실행 되었는지) 제공
커버리지 결과를 xml, html, csv 등의 파일로 저장가능
기준을 설정해줘서 특정 커버리지 기준을 만족하는지 확인 가능
설정 방법
플러그인 추가
plugins {
 id 'jacoco'
}
jacocoTestCoverageVerification: 원하는 커버리지 기준을 만족하는지 확인해 주는 Task
jacocoTestReport: 커버리지 결과를 xml, html, csv 등의 파일로 저장
Jacoco 플러그인 설정
jacoco {
 toolVersion = '0.8.5' 
 // reportsDir = ${project.reporting.baseDir}/jacoco - 따로 설정해 주지 않을 경우 기본 경로
}
8.0 버전부터 lombok 사용으로 생기는 @Getter, @Builder등을 테스트 커버리지에서 제외시키기 위한 설정을 적용할 수 있음.
jacocoTestReport 설정
*소나큐브와 연동하기 위해서 xml로 파일로 만들어주기
jacocoTestReport {
    reports {
        html.enabled true // html 만들어 - 로컬에서 쉽게 보기 위함
        xml.enabled true // xml 만들어 - 소나큐브 연동 위함
        csv.enabled false // csv 안 만들어 
        // xml.destination file("${buildDir}/jacoco/result.xml") // 여기 저장할 것이라는 뜻.
    }
}
destination 설정을 하지 않으면, html은 build/reports/jacoco/test/html/index.html에 생기고, xml은 build/reports/jacoco/test/jacocoTestReport.xml에 생성된다.
jacocoTestCoverageVerification 설정
rule.element: BUNDLE(default), CLASS, GROUP, METHOD, PACKAGE, SOURCEFILE
rule.limit.counter: INSTRUCTION(default),BRANCH, CLASS, COMPLEXITY, METHOD, LINE
rule.limit.value: COVEREDRATIO(default), COVEREDCOUNT,  MISSEDCOUNT, MISSEDRATIO, TOTALCOUNT
jacocoTestCoverageVerification {
    violationRules {
        rule {
            enabled = true // 이 rule을 적용할 것이다.
            element = 'CLASS' // class 단위로
            // 브랜치 커버리지 최소 50%
            limit {
                counter = 'BRANCH'
                value = 'COVEREDRATIO'
                minimum = 0.50
            }
            // 라인 커버리지 최소한 80%
            limit {
                counter = 'LINE'
                value = 'COVEREDRATIO'
                minimum = 0.80
            }
            // 빈 줄을 제외한 코드의 라인수 최대 300라인
            limit {
                counter = 'LINE'
                value = 'TOTALCOUNT'
                maximum = 300
            }
            // 커버리지 체크를 제외할 클래스들
            excludes = []
        }
    }
}
test task 설정
test {
 jacoco {
 // 아래 설정들은 모두 기본 값. 따라서 변경할 것이 없다면 적어주지 않아도 됨
     enabled = true
     destinationFile = file("$buildDir/jacoco/${name}.exec")
     includes = []
     excludes = []
     excludeClassLoaders = []
     includeNoLocationClasses = false
     sessionId = "<auto-generated value>"
     dumpOnExit = true
     classDumpDir = null
     output = JacocoTaskExtension.Output.FILE
     address = "localhost"
     port = 6300
     jmx = false
 }
}
최종
test -> jacocoTestReport -> jacocoTestCoverageVerification 순으로 실행되어야한다. 
finalizedBy로 순서 지정
plugins {
    // ...
    id 'jacoco'
}
//...
test {
    // ...
    finalizedBy 'jacocoTestReport'
}
jacoco {
    toolVersion = '0.8.5'
}
jacocoTestReport {
    reports {
        html.enabled true
        xml.enabled true
        csv.enabled false
        xml.destination file("$buildDir/jacoco/jacoco.xml")
    }
    // 코드 커버리지 기준을 만족해야지 build 성공
    finalizedBy 'jacocoTestCoverageVerification'
}
jacocoTestCoverageVerification {
    violationRules {
        rule {
            enabled = true
            element = 'CLASS'
            limit {
                counter = 'BRANCH'
                value = 'COVEREDRATIO'
                minimum = 0.50
            }
            limit {
                counter = 'LINE'
                value = 'COVEREDRATIO'
                minimum = 0.80
            }
            limit {
                counter = 'LINE'
                value = 'TOTALCOUNT'
                maximum = 300
            }
            excludes = []
        }
    }
}
SonarQube
버그, 코드 스멜, 보안 취약점을 발견할 목적으로 정적 코드 분석으로 자동 리뷰를 수행하기 위한 지속적인 코드 품질 검사용 오픈 소스 플랫폼
ubuntu에 설치
docker pull sonarqube
docker run -d --name sonarqube -p 9000:9000 sonarqube
설정
접속
http://[EC2 인스턴스 public ip]:9000
기본 계정
id: admin
password: admin
프로젝트 생성
토큰 발급
프로젝트에서 설정
플러그인 추가
plugins {
 id "org.sonarqube" version "3.3"
}
프로퍼티 설정
sonarqube {
 properties {
     property "sonar.projectKey", "dropthecode"
     property "sonar.host.url", "${sonarQube 인스턴스 ip:9000}"
     property "sonar.language", "java"
     property "sonar.sourceEncoding", "UTF-8"
     property "sonar.sources", "src/main/java"
     property "sonar.tests", "src/test/java"
     property "sonar.coverage.jacoco.xmlReportPaths", "${buildDir}/reports/jacoco/test/jacocoTestReport.xml" // jacoco xml 파일 위치
     property "sonar.java.binaries", "${buildDir}/classes"
     property "sonar.test.inclusions", "**/*Test.java"
     property "sonar.exclusions", "**/util/**, **/support/**, **/dto/**" // 제외할 클래스들 
 }
}
jacoco에서 exclude에 코드 커버리지 검사를 하지 않을 클래스를 설정해줘도, sonarQube에는 적용되지 않는다. 따라서 sonarQube에서도 해당 클래스를 제외하고 싶다면 sonar.exclusions 설정을 해줘야한다.
실행
test 실행 후 `./gradlew sonarqube -Dsonar.login=${위에서 발급 받은 토큰}
reference
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#jacoco-%ED%94%8C%EB%9F%AC%EA%B7%B8%EC%9D%B8-%EC%B6%94%EA%B0%80
https://stackoverflow.com/questions/41724423/how-can-i-exclude-files-of-the-code-coverage-of-sonarqube-using-jacoco-maven-plu

정적 분석 with Jacoco & SonarQube

댓글