SpringBoot3 SonarQube 적용 (w. Jenkins)

최준호·2023년 6월 3일

sonarqube springboot3

Appling

목록 보기

3/12

참고
우리 팀의 코드 품질은? 정적코드 분석도구, 소나큐브 적용기
코드 분석 도구 적용기 - 3편, SonarQube 적용하기

🔴 SonarQube란

정적 코드분석기로 코드를 분석하여 코드 품질 관리와 향상에 도움이 되는 도구이다. 이전에도 많이 들었지만 귀찮다는 이유로 프로젝트에 잘 적용하지 않고 있었는데.

이번 회사에서 구글 강사분을 초빙하여 강의를 진행하였었는데. 해당 강사분이 자신의 코드가 교과서 같다는 말을 많이 들으신다고 하셨다. 
그런데 이러한 특징에는 코드 정적 분석기가 많은 도움을 줬다는 말을 듣고 바로 적용해보기로 마음을 먹었다.

그리고 팀내에서도 소나큐브를 적용중이기도 하다. 내가 볼수 있는건 없지만... 그래도 알고 있으면 도움이 될거니까!

🔵 SonarQube 서버 만들기

소나 큐브는 젠킨스와 비슷하게 하나의 웹서버를 만들어서 세팅해주는 방식이다. 그렇기 때문에 하나의 서버가 필요하다. 나는 개인 Raspberry pi4를 가지고 있어서 해당 서버에 설치를 진행했다.

개인 PC에 설치해서 코드를 분석할때만 실행시켜서 사용해도 괜찮을거 같다!

🟢 Docker 작성

version: "3"
services:
  sonarqube:
    image: sonarqube:community
    hostname: sonarqube
    container_name: sonarqube
    depends_on:
      - qube-db
    environment:
      SONAR_JDBC_URL: jdbc:postgresql://qube-db:5432/sonar
      SONAR_JDBC_USERNAME: sonar
      SONAR_JDBC_PASSWORD: sonar
    volumes:
      - sonarqube_data:/opt/sonarqube/data
      - sonarqube_extensions:/opt/sonarqube/extensions
      - sonarqube_logs:/opt/sonarqube/logs
    ports:
      - "9000:9000"
  qube-db:
    image: postgres:13
    hostname: postgresql
    container_name: postgresql
    environment:
      POSTGRES_USER: sonar
      POSTGRES_PASSWORD: sonar
      POSTGRES_DB: sonar
    volumes:
      - postgresql:/var/lib/postgresql
      - postgresql_data:/var/lib/postgresql/data

volumes:
  sonarqube_data:
  sonarqube_extensions:
  sonarqube_logs:
  postgresql:
  postgresql_data:

다음과 같이 작성후에 docker compose 실행 명령어를 통해 실행만 하면 바로 서버가 실행된다.

하지만 개인서버의 경우 최소 사양을 맞추지 못해 실행이 안되는 경우도 존재하는데 그럴땐 서버의 세팅을 확인 후 변경하거나 최소 사양에 맞는 서버로 교체해야한다 ㅜㅜ

🟢 사양 체크

최소 사양

리눅스 - vm.max_map_count 524288
리눅스 - fs.file-max 131072
파일 디스크립터 개수 - 131072
스레드 개수 - 8192

sysctl vm.max_map_count
sysctl fs.file-max
ulimit -n
ulimit -u

확인 후 사양에 미달한다면 아래 명령어를 통해 사양을 수정해주자.

sysctl -w vm.max_map_count=524288
sysctl -w fs.file-max=131072
ulimit -n 131072
ulimit -u 8192

🟢 서버 실행

docker compose up -d --build

명령어를 입력하면 다음과 같이 화면이 실행된다.

🔵 프로젝트 세팅

🟢 gradle 세팅

plugins {
    ...
    id 'jacoco'
    id 'org.sonarqube' version '3.3'
}


dependencies {
    ...
    implementation 'org.sonarsource.scanner.gradle:sonarqube-gradle-plugin:3.3'
}

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

tasks.named('asciidoctor') {
    inputs.dir snippetsDir
    dependsOn test
}

// jacoco
jacoco {
    toolVersion = '0.8.8'
}

jacocoTestReport {
    reports {
        xml.enabled true    // sonarqube 분석 파일
        csv.enabled false
        html.enabled false

        xml.destination file("${buildDir}/jacoco/index.xml")	// 파일 경로 변경
        csv.destination file("${buildDir}/jacoco/index.csv")
        html.destination file("${buildDir}/jacoco/index.html")
    }

    afterEvaluate {
        classDirectories.setFrom(
                files(classDirectories.files.collect {
                    fileTree(dir: it, excludes: [
                            '**/*Application*',
                            '**/*Exception*',
                            '**/*Advice*',
                            '**/dto/**',
                            '**/vo/**',
                            '**/enums/**',
                            '**/api/**',
                            '**/config/**',
                            // ...
                    ])
                })
        )
    }

    finalizedBy 'jacocoTestCoverageVerification'
}

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

            excludes = [
                    '*.*Application',
                    '*.*Exception',
                    '*.*Advice',
                    '*.dto.*',
                    '*.vo.*',
                    '*.enums.*',
                    '*.api.*',
                    '*.common.*',
                    '*.security.*',
                    '*.entity.*',
                    '*.entity.*.Q*',
            ]

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

        rule {
            enabled = true
            element = 'CLASS'

            excludes = [
                    '*.*Application',
                    '*.*Exception',
                    '*.*Advice',
                    '*.dto.*',
                    '*.vo.*',
                    '*.enums.*',
                    '*.api.*',
                    '*.common.*',
                    '*.security.*',
                    '*.entity.*',
                    '*.entity.*.Q*',
            ]

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

sonarqube {
    properties {
        property "sonar.host.url", "{sonarqube server url}"
        property "sonar.sources", "src"
        property "sonar.language", "java"
        property "sonar.projectKey", "appling-api"
        property "sonar.projectName", "appling-api-prod"
        property "sonar.sourceEncoding", "UTF-8"
        property "sonar.java.binaries", "${buildDir}/classes"
        property "sonar.test.inclusions", "**/*Test.java, **/*Docs.java"
        property "sonar.exclusions", "**/resources/static/**, **/Q*.class, **/test/**"
        property "sonar.coverage.jacoco.xmlReportPaths", "${buildDir}/jacoco/index.xml"
    }
}

정적분석은 SonarQube를 사용하고 동적분석은 jacoco를 사용하였다. 해당 설정으로 소스의 테스트 커버리지도 확인할 수 있다.

🔵 Jenkins 설정

다른 젠킨스의 자동 설정이나 깃헙 액션을 통한 자동설정도 많은데 나는 그냥 명령어로 간단하게 실행하고자 한다. 아직 프로젝트가 엄청 복잡한 것도 아니기 때문에!

🟢 파이프라인 작성

pipeline {
    agent any

    stages {
        stage('pull') {
            steps {
                git branch: 'main', credentialsId: 'git', url: 'https://github.com/appling-c/appling-api.git'
            }
        }
        stage('build') {
            steps {
                sh './gradlew clean build'
            }
        }
        
        stage('sonar') {
            steps {
                sh './gradlew sonarqube -Dsonar.login={sonarqube loing user token}'
            }
        }
        
        
        stage('clean') {
            steps {
                sshPublisher(
                    publishers: [
                        sshPublisherDesc(
                            configName: 'normal', 
                            transfers: [
                                sshTransfer(
                                    cleanRemote: false, 
                                    excludes: '', 
                                    execCommand: 'sudo rm -r /home/ubuntu/appling/api/build', 
                                    execTimeout: 120000, 
                                    flatten: false, 
                                    makeEmptyDirs: false, 
                                    noDefaultExcludes: false, 
                                    patternSeparator: '[, ]+', 
                                    remoteDirectory: '', 
                                    remoteDirectorySDF: false, 
                                    removePrefix: '', 
                                    sourceFiles: ''
                                    )
                                ], 
                                usePromotionTimestamp: false, useWorkspaceInPromotion: false, verbose: false)])
            }
        }
        
        stage('transfer') {
            steps {
                sshPublisher(
                    publishers: [
                        sshPublisherDesc(
                            configName: 'normal', 
                            transfers: [
                                sshTransfer(
                                    cleanRemote: false, 
                                    excludes: '', 
                                    execCommand: '', 
                                    execTimeout: 120000, 
                                    flatten: false, 
                                    makeEmptyDirs: false, 
                                    noDefaultExcludes: false, 
                                    patternSeparator: '[, ]+', 
                                    remoteDirectory: '/home/ubuntu/appling/api', 
                                    remoteDirectorySDF: false, 
                                    removePrefix: '', 
                                    sourceFiles: 'build/libs/appling-1.0.jar'
                                    )
                                ], 
                                usePromotionTimestamp: false, useWorkspaceInPromotion: false, verbose: false)])
            }
        }
        
        stage('up') {
            steps {
                sshPublisher(
                    publishers: [
                        sshPublisherDesc(
                            configName: 'normal', 
                            transfers: [
                                sshTransfer(
                                    cleanRemote: false, 
                                    excludes: '', 
                                    execCommand: 'cd /home/ubuntu/appling/api && sudo docker compose down ; sudo docker compose up -d --build', 
                                    execTimeout: 120000, 
                                    flatten: false, 
                                    makeEmptyDirs: false, 
                                    noDefaultExcludes: false, 
                                    patternSeparator: '[, ]+', 
                                    remoteDirectory: '', 
                                    remoteDirectorySDF: false, 
                                    removePrefix: '', 
                                    sourceFiles: ''
                                    )
                                ], 
                                usePromotionTimestamp: false, useWorkspaceInPromotion: false, verbose: false)])
            }
        }
    }
}

clean 부터는 개인 설정이기 때문에 보지 않아도 되고 sonar까지 참고해서 작성하면 좋을거 같다.
따로 큰 설정없이 gradle 설정을 통해서 소나큐브에 바로 적용이 가능하기 때문에 엄청 간단하다.

그리고 sonarqube.loing= 들어가는 토큰값은 소나큐브에 로그인 후 user token을 발급 받아서 사용하면 된다.