[DevOps] Jenkins를 이용한 CI/CD Pipeline 구축 - Advenced Jenkins 사용 ② - SonarQube

 

 

이 내용은 인프런 - Jenkins를 이용한 CI/CD Pipeline 구축 강의를 보고 정리한 내용 입니다.


해당 내용의 Code 내용은 이 곳에서 확인하실 수 있습니다.

 

 

초보를 위한 젠킨스 2 활용 가이드 2/e / 에이콘출판사

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

 

🗂 목차

● [DevOps] Jenkins를 이용한 CI/CD Pipeline 구축 - 자동화 도구의 사용
● [DevOps] Jenkins를 이용한 CI/CD Pipeline 구축 - Jenkins + Infrastructure as Code 와의 연동
● [DevOps] Jenkins를 이용한 CI/CD Pipeline 구축 - Jenkins + Ansible + Kubernetes 와의 연동
● [DevOps] Jenkins를 이용한 CI/CD Pipeline 구축 - Advenced Jenkins 사용 ① - Pipeline
● [DevOps] Jenkins를 이용한 CI/CD Pipeline 구축 - Advenced Jenkins 사용 ② - SonarQube
● [DevOps] Jenkins를 이용한 CI/CD Pipeline 구축 - Advenced Jenkins 사용 ③ - Multi Nodes
● [DevOps] Jenkins를 이용한 CI/CD Pipeline 구축 - 상용 클라우드 환경에 배포하기
● [DevOps] Jenkins를 이용한 CI/CD Pipeline 구축 - 부록

 

🚀 SonarQube

    🔽 SonarQube

        📦 개요

 

1. Continuous Integration + Analysis (지속적인 통합과 분석 Tool)
   ∙ Code Quality Assurance tool : Issue + Defect + Code Complexity
   ∙ Detect Bugs & Vulnerabilities
   ∙ Track Code Smells
   ∙ Code Quality Metrics & History

2. 17개 Programming Language 지원
   ∙ JAVA, C#, JavaScript, TypeScript, CloudFormation, Terraform, Kotlin, Ruby, Go, Scala, Flex, Python,
        PHP, HTML, CSS, XML, VB.NET 등

3. CI / CD Integration

4. Extensible, with 50 + community plugins

 

 

📦 설치하기

주니하랑은 Synology NAS의 Docker를 이용하여 SonarQube를 Container화 하여 사용해 볼게요.

 

sudo docker pull sonarqube

Intel Chip을 이용하는 PC 혹은 Server에서는 위와 같이 Image를 받을 수 있어요.

만약 Applie M1 Chip을 이용하시는 분들은 아래 명령어를 이용해 주세요.

sudo docker pull edowon0623/sonarqube:arm

 

sudo docker images

위와 같이 sonarqube Image를 확인할 수 있어야 해요.

sudo docker run --rm -p 9000:9000 --name {Container 이름 지정} {Image 이름}

728x90

기존에 만들어져 있을지 모를 Container를 지우기 위해 --rm Option과 함께
Container 기동 명령어를 입력해 주었어요.

웹 브라우저에서 위와 같이 정상적으로 붙은 것을 확인할 수 있어요.

참고로 기동되는데 꽤 오래 걸렸어요.

admin // admin

위와 같이 Login창이 나오면 초기 계정 정보를 입력해 주세요.

이번에는 SonarQube Token을 이용해서 Git hub과 연결을 해 줄게요.

먼저 우측 상단에 A라고 표시된 초록색 네모 Icon을 클릭해 주세요.

그리고, My Account를 눌러줍니다.

Security Tab을 눌러 접속합니다.

이름은 자유롭게 지어주고, Type은 User Token을 선택한 뒤 Expires in (만료일)을 희망하시는대로 정해주세요.

주니하랑은 30일로 하려고 해요.

그런 뒤 Generate Button을 눌러줍니다.

Token Value :squ_31daff1a938ccf0b80cf08720fc8a87882353b57

그럼 위와 같이 Token이 생성된 걸 확인할 수 있어요.

 

 

    🔽 SonarQube와 Maven

        📦 Maven Project를 이용하여 가지고 놀기

pom.xml

최초 Maven Project Pom.xml에 위와 같이 plugin을 추가해 주었어요.

해당 내용은 아래 URL에 들어가시게 되면 존재합니다.

https://docs.sonarqube.org/latest/analysis/scan/sonarscanner-for-maven

https://docs.sonarqube.org/latest/analysis/scan/sonarscanner-for-maven

반응형

위 Site에서 표시된 곳만 긁어서 주니하랑처럼 의존성을 추가해 주시면 되요.


최신 버전을 추가 하고 싶다면 아래 URL에 접속하시면 받을 수 있어요.

https://mvnrepository.com/artifact/org.sonarsource.scanner.maven/sonar-maven-plugin

 

mvn sonar:sonar -Dsonar:host.utl=http://192.168.0.2:9000 -Dsonar.login={Sonar Token Value}

Maven Project Directory에서 위의 명령어를 입력해 줄게요.

mvn sonar:sonar -Dsonar.host.utl=http://192.168.0.2:9000 -Dsonar.login={Sonar Token Value}

Sonarqube Site에 돌아와서 상단 좌측에 Projects를 눌러주면 위와 같은 화면을 만날 수 있어요.

 

 

 

    🔽 SonarQube 가지고 놀기

        📦 Bad Code 조사

최초 기존에 있었던 Code에서 logger 부분을 주석처리하고, Println을 통해 임의의 문자를 출력되게 만들었어요.
Web 개발을 할 때, Println은 성능 Issue를 불러 일으키기 때문에 사용하지 않습니다.

이렇게 개발을 하게 되면 Sonarqube는 뭐라고 할까요?

mvn clean compile package -DskipTests=ture

최초 위와 같이 Maven Build을 진행할게요.

-DskipTests=true Option은 Unit Test를 진행하지 않겠다는 의미에요.

mvn sonar:sonar -Dsonar.host.utl=http://192.168.0.2:9000 -Dsonar.login={Sonar Token Value}

위와 같이 Maven을 이용하여 Sonar Build를 진행해 주었어요.

Issue Tab에 보면 꽤 많은 경고가 나오는 것을 확인할 수 있어요.

주니하랑은 그 중에 Remove this unused "logger"private field에 주목했어요.

내용을 보니 "logger라는 Member 변수 선언해놓고, 왜 안 써요? 그럴거면 지우세요!" 라고 하고 있고,

주석 처리한 부분에는 "이거 주석 처리 할거면 지우세요!" 라고 하고 있고,

Println이라는 부분에는 "System.out 대신에 logger를 사용하세요!" 라고 알려주고 있어요.

Code를 위와 같이 수정해 주었어요.

다시 Build 초기화를 한 뒤 Build를 해주었어요.

위와 같이 경고문이 수정된 것을 확인할 수 있어요.

    🔽 Jenkins와 SonarQube 이야기

        📦 연동

최초 Jenkins에서 SonarQube Plugin을 설치해주어야 해요.

Jenkins 관리 -> Plugin Manager -> 설치가능

위와 같이 SonaQube Scanner Plugin을 설치하도록 할게요.

 

이번에는 Jenkins 관리에서 Manage Credentials를 들어가 설정을 해줄거에요.

위와 같이 이미 등록되어 있는 여러가지 정보들이 있는데, Domains에 (golobal) 아무거나 눌러줍니다.

그런 뒤 Add Credentials를 눌러주세요.

 

 

Kind에 Secret text를 선택해 주세요.

Secret 부분에 SonarQube에서 발급한 Token 값을 입력해 주면 되요.

그리고, ID는 원하시는 값을 넣어주면 됩니다.

그리고, Create Button을 눌러주세요.

이번엔 Jenkins 관리에서 시스템 설정으로 들어가 줄게요.

SonarQube server라는 항목에서 설정을 이어가볼게요.

Environment variables를 활성화해주고, Add SonarQube를 눌러주세요.

위와 같이 SonarQube Server 정보를 입력해 주시면 되요.

Name은 자유롭게 적으면 되고, Server URL은 SonarQube를 브라우저를 통해
접속할 때 사용하는 URL을 적어주면 되요.

Server authentication token에는 위에서 만들었던 Credential ID를 찾아 선택해 주면 되요.

저장을 누르고 해당 창을 빠져나와 줄게요.

        📦 Pipeline 사용하기

주니하랑은 이 전에 만들었던 Pipeline Project에 추가 작업을 해 보려고 해요.

해당 Project가 궁금하시다면 이 곳에 정성스럽게 준비해 두었으니 많이 사랑해 주세요.

 

pipeline {
    agent any
    tools {
        maven 'Maven3.8.5'
    }
    
    stages {
        stage('Git Clone') {
            steps {
                git 'https://github.com/junyharang-coding-study/JunyHarang-Maven-Test-Project'
            }
        }
        
        stage('Maven Build') {
            steps {
                sh '''
                    echo build start
                    mvn clean compile package -Dskiptests=true
                '''
            }
        }
        
        stage('SonarQube analysis') {
            steps {
                withSonarQubeEnv('SonarQube-Test') {
                    sh 'mvn sonar:sonar'
                }
            }
        }
        
        stage('deploy') {
            steps {
                deploy adapters: [tomcat9(credentialsId: 'deployer_user', path: '', url: 'http://172.17.0.6:8088')], contextPath: null, war: '**/*.war'
            }
        }
        
        stage('ssh publisher') {
            steps {
                sshPublisher(publishers: [sshPublisherDesc(configName: 'docker-container', transfers: [sshTransfer(cleanRemote: false, excludes: '', execCommand: 'docker build --tag junyharang/devops_study1 -f Dockerfile .', execTimeout: 120000, flatten: false, makeEmptyDirs: false, noDefaultExcludes: false, patternSeparator: '[, ]+', remoteDirectory: '.', remoteDirectorySDF: false, removePrefix: 'target', sourceFiles: 'target/*.war')], usePromotionTimestamp: false, useWorkspaceInPromotion: false, verbose: false)])
            }
        }
    }
}

해당 Project 구성에서 Pipeline에 위와 같이 Script 문을 추가해 주었어요.

withSOnarQUbeEnv에는 이 전에 SonarQube를 Jenkins 시스템 구성에서 등록할 때,
Name 부분에 등록했던 이름을 적어주면 되요.

그런 뒤 Maven 명령어를 통해 Sonar Build를 했듯이 명령어를 입력해 주면 되는데,
접속 정보나 Token 값은 Jenkins에 등록을 해 주었고,
그 값을  withSOnarQUbeEnv에서 등록한 이름을 찾아 해당 내용을 가지고 오기 때문에 따로 적어줄 필요는 없어요.

저장하고, 해당 창을 나온 뒤 Build를 해 볼게요.

Build 작업이 정상적으로 끝났어요!

SonarQube Project Tab에서 Last analysis가 2분 전인걸 확인할 수 있어요.

 

 

 

 

 

초보를 위한 젠킨스 2 활용 가이드 2/e / 에이콘출판사

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