[CI/CD] 정적 코드 분석 툴 SonarQube와 Jenkins 연동

 

 

 

 

 

 

 

🗂 목차

⚠️ 아래 목차 중 몇몇개의 링크가 걸리지 않는 문제로 글 맨 하단에 다음 글로 이동할 수 있게 해 두었습니다.

✅ [CI/CD] Jenkins와 Gitea 연동
✅ [CI/CD] Jenkins Trigger 정보 Discord로 보내기
✅ [CI/CD] 정적 코드 분석 툴 SonarQube와 Jenkins 연동
✅ [CI/CD] SonarQube를 통해 Code Convention 적용
✅ [DevOps] JAVA Gradle JaCoCo (Code coverage) 설정하기 
✅ [DevOps] JAVA Gradle JaCoCo (Code coverage) 설정하기 (추가)(https://junyharang.tistory.com/392)
✅ [CI/CD] Jenkins + Docker를 이용한 무중단 배포 - ① Application Linuxt(Ubuntu)에 SSH를 이용한 파일 전송
✅ [CI/CD] Jenkins + Docker를 이용한 무중단 배포 - ② Create Docker Image And BackUp
✅ [CI/CD] Jenkins + Docker를 이용한 무중단 배포 - ③ Application Server Docker Job (① Application 도커 존재 여부 확인)
✅ [CI/CD] Jenkins + Docker를 이용한 무중단 배포 - ③ Application Server Docker Job (② Application Docker Run)(https://junyharang.tistory.com/406)
✅ [CI/CD] Jenkins + Docker를 이용한 무중단 배포 - ③ Application Server Docker Job (③ Application Docker Health Check)
✅ [CI/CD] Jenkins + Docker를 이용한 무중단 배포 - ④ NGINX Server Docker Job (① NGINX 각 종 설정) 
✅ [CI/CD] Jenkins + Docker를 이용한 무중단 배포 - ④ NGINX Server Docker Job (② NGINX Docker 존재 여부 확인) 
✅ [CI/CD] Jenkins + Docker를 이용한 무중단 배포 - ④ NGINX Server Docker Job (③ NGINX Docker Run & Health Check)
✅ [CI/CD] Jenkins + Docker를 이용한 무중단 배포 - ④ NGINX Server Docker Job (③ NGINX 재 설정)

🤔 내가 만난 문제

⛔️ [Jenkins] java.lang.OutOfMemoryError: Java heap space

 

 

 

 

 

배포 자동화와 지속적 인도:도커와 젠킨스 쿠버네티스로 만드는

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."

 

 

🚀 SonarQube와 Jenkins 연동

    🔽 개요

        📦 구성도

CI/CD 무중단 배포 구성도

 

 

 

 

 

 

deploy Directory Path

        📦 소개

이번에는 정적 코드 분석 툴 소나큐브와 젠킨스를 연동하는 방법에 대해 정리해 보도록 하려고 해요.

소나큐브에 대한 소개와 주니가 설치한 방법에 대해서는 이 곳에 정성스럽게 준비해 두었어요.

[DevOps] Docker를 이용한 SonarQube 설치하기

 

 

    🔽 구성

        📦 SonarQube

소나큐브를 설치하였으니 이제 젠킨스와 연결을 위해 소나큐브에서 작업을 해 주도록 할게요.

Main -> Create Project -> Manually

최초 메인 화면에서 위와 같이 선택을 해 줄게요.

Project display name에는 원하는 이름을 넣어주면 되고,
이름을 넣어주면 key 부분이 알아서 입력되는 걸 확인할 수 있어요.

주의할 점은 젠킨스와 연동할 때,
소나큐브 properties 설정에서 해당 key 값과 이름을 입력해 줘야하기 때문에 잘 정리해 두는 것이 좋겠어요.

Main branch name에는 형상 관리 프로그램에서 Repository의 Main Branch 이름을 적어주면 된답니다.

이제 Set Up 버튼을 눌러줄게요.

이 창이 나오면 Locally를 선택해 주도록 할게요.

Token을 만들어 주는 부분이에요.

위와 같이 기억하기 쉬운 토큰 이름을 지정하고, 해당 토큰이 만료되는 시점을 정해줄 수 있어요.

주니는 만료되지 않도록 해 줄거에요.

이제 생성하기를 눌러줄게요.

그럼 위와 같이 토큰이 발급된 걸 확인할 수 있어요.

이 토큰을 젠킨스에 credentials에 등록해 주어야 해요.

Continue를 눌러준 뒤 다른 작업을 하지 않고, 일단 Main Page로 돌아와 줍니다.

그럼 이렇게 방금 만든 프로젝트가 만들어진걸 확인할 수 있어요.

 

환경설정 -> Webhooks

이번엔 Webhook 설정을 해주도록 해볼게요.

이 곳에서 생성 버튼을 눌러 줍니다.

이 곳에서 연동할 젠킨스 이름을 지정하고, 해당 젠킨스와 연결할 수 있는 URL 정보를 입력해 주면 되요.

URN은 위와 같이 /sonarqube-webhook/을 꼭 넣어주어야 해요.

이렇게 하고, 생성 버튼을 누르게 되면 Global 설정으로 소나큐브 모든 프로젝트에 해당 webhook이 적용되어 질 거에요.

주니가 사용하는 젠킨스는 하나이기 때문에 이렇게 클로벌 설정을 해 주었어요.

만약 프로젝트 당 개별로 Webhook 설정을 원하는 경우 해당 프로젝트 안에서 Project Setting - Webhook 설정에서 프로젝트 별로 webhook을 다르게 설정해 줄 수도 있어요.

 

 

 

 

 

 

 

        📦 Jenkins

이번에는 젠킨스에서 설정을 해 보도록 할게요.

Jenkins 관리 -> PlugIn Manager

최초 PlugIn Manager에서 위의 두 PlugIn을 설치해 주도록 해야 해요.

Jenkins 관리 -> Credentials

 

이제 소나큐브 연동을 위해 Credentials를 등록해 줄건데, 위와 같이 Global 설정을 해 주려고 해요.

이 곳에서 최초 kind는 Secret text로 해 줄게요.

Secret에는 소나큐브에서 발급 받은 토큰 값을 입력해 주었어요.

ID는 젠킨스 파이프라인에서 사용할 ID로 이 값을 통해 Jenkins File에서 소나큐브 토큰 값을 전달 받게 되요.

Description은 해당 Credentials에 설명을 적어주면 된답니다.

Create를 눌러줄게요.

Jenkins 관리 -> Configure System

이제 젠킨스 시스템 설정에서 위와 같이 소나큐브 정보를 입력해 주면 되요.

그런 뒤 고급 버튼을 눌러 줍니다.

반응형

그럼 위 설정 부분이 나올텐데, 이 부분은 소나큐브 properties 설정을 하는 부분이에요.
주니는 이 곳에 project Key와 project Name을 설정해 줄 수 있어요.

이렇게 소나큐브에 등록을 해 줘도 되고,
소스 코드 Project Root Directory에 sonar.properties를 만들어 관리할 수도 있어요.

주니는 이 설정을 jenkins File에 해 줄거에요.

해당 내용은 밑에서 확인할 수 있어요.

여기까지 되었다면 밑에 Apply를 누른 뒤 Save를 눌러 저장해 줍니다.

 

 

 

 

   🔽 설정

        📦 Sonar Scanner

이번에는 Sonar Scanner 설정을 해보려고 해요.

젠킨스에서 젠킨스 관리의 Global Tool Configuration에서 진행 합니다.

Jenkins 관리 -> Global Tool Configuration

Sonar-Scanner PlugIn이 잘 설치 되었다면 위에 항목이 보여야 해요.

Add SonarScanner for MSBuild 버튼을 눌러 위와 같이 설정해 주었어요.

여기서 이름은 임의의 값을 지정해 주면 된답니다.

그런 뒤 Add SonarQube Scanner를 눌러 위와 같이 설정해 주었어요.

이 곳에 사용된 이름 값을 추후 Jenkins File에 Sonnar-analysis Stage 부분에서
Sonnar-Scanner tool 부분에 명시해 줘야 하는 이름이에요.

밑 부분에 Apply를 누르고, Save를 눌러 빠져 나와 줄게요.


이제 Jenkins File을 수정해 보도록 할거에요.

def SET_VARIABLE = "Jenkins File 변수 설정"
def SONARQUBE_ANALYSIS = "소나큐브 Analysis"

pipeline {
    agent any
    environment {
        WEBHOOK_URL = credentials("Total-Back-Office-BE-Discord-Webhook")
    }

    stages {
        stage(SET_VARIABLE) {
            steps {
                script {
                    // 구동 환경 설정 (삼항 연산자로 브런치 이름이 master라면 prod 환경이고, 아니면 dev 환경
                    DRIVE_ENV = env.BRANCH_NAME.equals("master") ? "prod" : "dev"

                    // 소나큐브 설정
                    SONARQUBE_SERVER_NAME = 'Jenkins SonarQube Server 설정의 Name'
                    SONARQUBE_CREDENTIAL_ID = "Jenkins에서 등록한 SonarQube Crendential ID"
                }
            }
        }
    }

    stage(SONARQUBE_ANALYSIS) {
        when {
            branch pattern: "(develop|master)", comparator: "REGEXP"
        }

        steps {
            script {
                def scannerHome = tool 'SonarQube-Scanner';
                withSonarQubeEnv(credentialsId: SONARQUBE_CREDENTIAL_ID, installationName: SONARQUBE_SERVER_NAME) {
                sh "${scannerHome}/bin/sonar-scanner \
                    -Dsonar.projectKey=BE-total-back-office \
                    -Dsonar.projectName=BE-total-back-office \
                    -Dsonar.branch.name=master \
                    -Dsonar.language=java \
                    -Dsonar.java.source=1.8 \
                    -Dsonar.sources=src/main/java \
                    -Dsonar.test=src/test/java \
                    -Dsonar.test.inclusion=**/*Test.java \
                    -Dsonar.issuesReport.console.enable=true \
                    -Dsonar.junit.reportPaths=build/test-results/test \
                    -Dsonar.java.binaries=build/classes \
                    -Dsonar.java.libraries.empty=true \
                    -Dsonar.sourceEncoding=UTF-8 \
                    -Dsonar.exclusions=**/dto/**,**/exception/**,**/constant/**,**/SpringInitProjectApplication.java,**/WebRestController.java,**/FileUploadYaml.java \
                    -Dsonar.java.checkstyle.reportPaths=build/reports/checkstyle-output/checkstyle-report.xml \
                    "
                }
            }
        }

        post {
            success {
                discordSend description: "소나큐브 Scan 작업 성공 하였어요. 😀",
                    footer: "Jenkins CI/CD Trigger Alarm",
                    link: env.BUILD_URL, result: currentBuild.currentResult,
                    title: "Jenkins CI/CD Trigger Discord를 통해 받기 시험 중 입니다.",
                    webhookURL: env.WEBHOOK_URL
            }

            failure {
                discordSend description: "소나큐브 Scan 작업 실패 하였어요. 😢",
                    footer: "Jenkins CI/CD Trigger Alarm",
                    link: env.BUILD_URL, result: currentBuild.currentResult,
                    title: "Jenkins CI/CD Trigger Discord를 통해 받기 시험 중 입니다.",
                    webhookURL: env.WEBHOOK_URL
            }
        } // Discord Send Post 끝
    } // stage(SONARQUBE_ANALYSIS) 끝
}

Jenkins File을 위와 같이 수정해 주었어요.

최초 when 절 밑에 branch 부분은 Jenkins Build가 Develop Branch로 Merge 또는 Push가 일어날 때만, 해당 Stage가 작동하도록 해주려고 작성한 부분이에요.

운영 환경(prod) 때 배포 시에는 이미 개발 환경에서 모든 분석과 수정, 테스트가 끝나고 배포가 되기 때문에 이 부분을 또
거칠 필요가 없어요.

또 다른 stage sh 부분은 Shell Script를 작성하겠다는 의미인데,
-Dsonar. 으로 시작하는 설정들을 통해 소나큐브 분석시 사용될 설정들을 설정하겠다고 알려준 거에요.

위에서 소나큐브 Project name과 Project Key를 Jenkins File에 두겠다고 하였는데, 그 부분이 바로

jenkinsfile 61 ~ 64전째 줄

63 ~ 64번째 줄에 명시해 준 부분이에요.

분석할 Package 위치도 명시 해주고, inclusion과 exclusion 설정을 통해
SonarQube를 통한 분석 시 포함할 항목과 배제할 항목도 지정해 줄 수 있어요.

-Dsnoar.branch.name=master 부분은 SonarQube에서 생성된
Project 분석 결과를 등록할 Branch Name을 명시하는 곳인데,

소나큐브 설정을 통해 Default Branch Name을 변경하지 않는 한 main으로 잡혀 있을 거에요.
주니는 master로 변경했답니다. 이 설정을 sonar-bot의 PR Comment를 사용하지 않는다면 필요 없어요.

CheckStyle 부분에서 Code Convention 분석 결과를 소나큐브로 보내기 위해 생성된 xml File 위치를 명시해 주었어요.

-Dsonar.java.checkstyle.reportPaths=build/reports/checkstyle-output/checkstyle-report.xml \

.Dsonar. 으로 시작하는 설정들은 주니가 젠킨스에서 소나큐브 설정시 이야기한 Project Root Directory에 sonar.properties를 따로 만들어 관리할 수도 있어요.

이번에는 소나큐브의 Quality Gate 기능을 이용하는 방법에 대해 정리해 볼게요.

jenkinsfile 73 ~ 97번째 줄

jenkinsfile 99 ~ 116번째 줄

 

        stage(SONARQUBE_QUALITY_GATE) {
            when {
                branch pattern: "(develop|master)", comparator: "REGEXP"
            }

            steps {
                timeout(time: 5, unit: 'MINUTES') {
                    script {
                        echo "소나큐브 Quality Gate 검사가 시작 되었어요!"
                        def sonarQubeQualityGate = waitForQualityGate()
                        def qualityGateStatus = sonarQubeQualityGate.status
                        echo "Quality Gate 상태: ${qualityGateStatus}"

                        if (qualityGateStatus != 'OK') {
                            echo "Quality Gate 검증 상태: ${qualityGateStatus}"
                            error "Quality Gate 검증에 실패 하였어요 😭: ${qualityGateStatus}"

                        } else {
                         echo "Quality Gate 검증에 성공 하였어요 😀: ${qualityGateStatus}"
                        }

                        echo "Quality Gate 검증을 모두 완료 하였어요 😎"
                    }
                }
            }

            post {
                success {
                    discordSend description: "소나큐브 Quality Gate 작업 성공 하였어요. 😀",
                        footer: "Jenkins CI/CD Trigger Alarm",
                        link: env.BUILD_URL, result: currentBuild.currentResult,
                        title: "Jenkins CI/CD Trigger Discord를 통해 받기 시험 중 입니다.",
                        webhookURL: env.WEBHOOK_URL
                }

                failure {
                    discordSend description: "소나큐브 Quality Gate 작업 실패 하였어요. 😢",
                        footer: "Jenkins CI/CD Trigger Alarm",
                        link: env.BUILD_URL, result: currentBuild.currentResult,
                        title: "Jenkins CI/CD Trigger Discord를 통해 받기 시험 중 입니다.",
                        webhookURL: env.WEBHOOK_URL
                }
            } // Discord Send Post 끝
        } // stage(SONARQUBE_QUALITY_GATE) 끝

Jenkins File에 위 내용을 추가해 주었어요.

sonarQubeQualityGate 라는 변수에 waitForQualityGate()를 호출한 결과값을 받도록 해 주었는데,
이 부분은 소나큐브 Analysis가 끝날 때까지 기다린 다음 결과 값을 반환하도록 해 주기 위한 부분이에요.

여기까지 작업하고, Gitea에 Push를 해 주었어요.

젠킨스에서 확인해보니 정상적으로 작업이 완료가 되었어요.

디스코드에도 성공한 내역을 확인할 수 있어요.

소나큐브에서 보면 위와 같이 검사가 완료되고, 해당 내용을 확인할 수 있어요.

이렇게 버그(Bug), 취약점, 코드 악취 (Code Smell) 등을 검증 받아서 보다 좋은 코드를 만들 수 있게 도와주는게
바로 소나큐브에요.


위에서 설정했던 Qulity Gate를 통과하게 되면 정상적으로 CI/CD가 진행되는 걸 확인할 수 있어요.

소나큐브 -> Quality Gate(품질 게이트)

소나큐브의 Quality Gate는 위와 같이 기본값으로 잡혀 있는 상태에요.

만약 이 부분을 우리 환경에 맞게 좀 더 높은 기준치를 두거나, 혹은 낮춰서 설정해 줄 수도 있어요.

이번에는 Quality Gate를 한번 만들어 볼게요.

 
위 화면에서 생성을 눌러 줄게요.

그리고 위와 같이 이름을 정해 주고, 저장을 눌러 줍니다.

위 화면에서 조건 추가 (Add Condition)을 눌러줄게요.

그럼 이 곳에서 우리 환경에 맞는 Quality Gate를 만들 수 있는 여러가지 항목이 있는걸 확인할 수 있어요.

이렇게 만든 Quality Gate를 통해 우리의 Project Setting에서 만들었던 Quality Gate를 지정해 주면 이 설정을 내용을
토대로 분석을 하게 된답니다.

 

 

이전 글: [CI/CD] Jenkins Trigger 정보 Discord로 보내기

다음 글: [CI/CD] SonarQube를 통해 Code Convention 적용