[Jenkins] 간략히보는 SonarQube와 Jenkins 연동하기

간략히보는 SonarQube와 Jenkins 연동하기

1. EC2를 하나 파서 도커를 설치한다.

2. sudo apt-get update && \ sudo apt-get install -y apt-transport-https ca-certificates curl software-properties-common && \ curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - && \ sudo apt-key fingerprint 0EBFCD88 && \ sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" && \ sudo apt-get update && \ sudo apt-get install -y docker-ce && \ sudo usermod -aG docker ubuntu && \ sudo curl -L "https://github.com/docker/compose/releases/download/1.23.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose && \ sudo chmod +x /usr/local/bin/docker-compose && \ sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose

3. sonarqube를 도커위에 올린다.

4. docker run -d --name sonarqube -p 8000:9000 sonarqube //밑의 스샷은 9000:9000 인데 실제로는 8000:9000 으로 실행했음

5. http://{sonarqube_ip}:8000/sonar 에 접속한다. 초기 id/pw는 admin/admin 이다.

6. 토큰을 생성하고, 프로젝트를 만든다.

   

7. 

8. 

9. 젠킨스에서 SonarQube 플러그인을 설치한다.

6. 젠킨스 메인화면 > Jenkins 관리 > Global Tool Configuration에서 SonarQube Scanner 를 설정해준다.

7. 

8. 젠킨스 메인화면 > Jenkins 관리 > 시스템 설정에서 SonarQube servers 에 소나큐브 url을 등록해준다.

9. 

10. 자바 프로젝트에 Jacoco 설정을 해준다.

    jacocoTestReport {
       dependsOn bootJar
    
       reports {
           html.enabled true
           xml.enabled true
           csv.enabled false
    
           html.destination file("src/jacoco/jacoco.html")
           xml.destination file("src/jacoco/jacoco.xml")
       }
    
       afterEvaluate {
           classDirectories.setFrom(files(classDirectories.files.collect {
               fileTree(dir: it,
                       exclude: [
                               '**/TyfServerApplication*'
                       ])
           }))
       }
    
       finalizedBy 'jacocoTestCoverageVerification'
    }
    
    jacocoTestCoverageVerification {
       violationRules {
           rule {
               enabled = true
               element = 'CLASS'
    
               limit {
                   counter = 'METHOD'
                   value = 'COVEREDRATIO'
                   minimum = 0.6
               }
    
               excludes = [
                       '**.*TyfServerApplication*'
               ]
           }
       }

    jacocoTestReport 에서 excludes 는 분석대상에서 제외하는 것,
    jacocoTestCoverageVerification 에서 excludes 는 테스트 대상에서 제외

11. 

12. 젠킨스 item 구성의 Build 탭에서 Execute SonarQube Scanner 를 등록해준다.

    

    sonar.login = {소나큐브에서 발급한 token}
    sonar.projectKey = {소나큐브에서 설정한 key 이름}
    sonar.projectName= {소나큐브에서 설정한 project 이름}
    sonar.host.url = {소나큐브 url}
    sonar.report.export.path = sonar-report.json
    sonar.sources=server/src/main/java, server/src/main/resources
    sonar.java.coveragePlugin = jacoco
    sonar.coverage.jacoco.xmlReportPaths= server/src/jacoco/jacoco.xml (자코코 xml 생성 위치)
    sonar.test.inclusions=**/*Test.java (include 할 클래스들)
    sonar.exclusions=**/*TyfServerApplication.java, */Q*.java (exclude 할 클래스들)
    sonar.projectVersion=1.0
    sonar.sourceEncoding=UTF-8
    sonar.java.binaries=server/build/classes

    각 속성 값들에 대한 정보는 https://sonarqubekr.atlassian.net/wiki/spaces/SON/pages/388027 이곳에서 확인가능

13. Analysis properties 에는 다음과 같이 작성

14. 

---