[CI/CD] SonarQube를 통해 Code Convention 적용

 

 

 

 

 

🗂 목차

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

✅ [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 Code Convention

    🔽 개요

        📦 구성도

CI/CD 무중단 배포 구성도

 

 

 

 

 

 

 

deploy Directory Path

 

        📦 소개

이번 시간에는 SonarQube를 통해 한 Project에서 많은 개발자들에게 공통의 개발 방식을 정할 수 있는 Code Convention을 적용해 보도록 할거에요.

Code Convention을 적용하는 이유는 모든 개발자들이 다른 개발자가 한 Code 작업물을 보더라도 읽고, 이해하기 쉽고, 구조적으로 파악하기 쉽도록 하기 위한 Coding Style 규칙이에요.

이렇게 하면 다른 개발자의 코드를 빨리 이해해서 개발 시간과 유지 보수 시간등을 단축 시킬 수 있기 때문이에요.

주니는 현재 하고 있는 프로젝트에서 Naver Coding Convention을 이용하기로 하였어요.

캠퍼스 핵데이 Java 코딩 컨벤션

위에 Site에 열거 되어 있는 내용들을 봐가면서 코딩한다면 정말 어려운 일이 될 거에요.

그래서 주니는 SonarQube에 Coding Convention을 적용 시키고, InteliJ의 PlugIn 중 SonarLint와 함께 사용하여 개발 당시와 배포가 이뤄지는 시점에 Convention Rule을 검증 받을 수 있도록 준비하려고 해요.

 

 

 

    🔽 Source Code

        📦 PlugIn 추가

최초 Gradle에 PlugIn을 설정해 주어야 해요.

build.gradle

주니는 위와 같이 6 ~ 8번째 줄에 PlugIn에 대한 정보를 넣어 주었어요.

//Check Style (Code Convention) Plugins
id 'checkstyle'
id 'org.ec4j.editorconfig' version '0.0.3'
// Gradle 6.0 이상에서 Lombok 사이 호환성 문제로 Build 때, QueryDsl Error 발생을 막기 위한 설정
// franzbecker는 Lombok Annotation Process를 단순화 하는 Plugin
id "io.franzbecker.gradle-lombok" version "3.0.0"

xml.report를 생성하기 위해 위와 같이 checkstyle PlugIn을 추가해 주었어요.

build.gradle

그런 뒤 위와 같이 Checkstyle 설정을 추가해 주었어요.

해당 설정에 상세 내용은 아래 Site를 참고해 주세요.

Checkstyle - Gradle DSL Version 2.1

 

 

Apache Maven Checkstyle Plugin – checkstyle:checkstyle

 

GitHub - checkstyle/checkstyle: Checkstyle is a development tool to help programmers write Java code that adheres to a coding st

 

위에서 설정한 config File 경로와 Config Properties의 경로는 Naver Code Convention File을 내려 받고,
Project에 지정한 경로를 설정해 준거에요.

Project Root Directory/config

주니는 이렇게 추가해 주었어요.


이 전 글에서 소나큐브 연동 시 162개의 코드 악취가 발생한 걸 확인했었어요.

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

 

 

그럼 위 설정을 통해 코드 악취를 없애는 방법에 대해 알아볼게요.

 

 

    🔽 IntelliJ

        📦 PlugIn - CheckStyle-IDEA

먼저 인텔리제이에서 플러그인을 받아 보려고 해요.

CheckStyle-IDEA PlugIn

위 플러그인을 받도록 할게요.

설치가 완료되면 IDE를 재시작 해 줍니다.

도구 -> Checkstyle

재 시작 완료 뒤 위의 설정 창에서 설정을 해줘야 해요.

먼저 Scan Scope에 All sources(including tests)를 선택해 줄게요.

그런 뒤 Configuration File을  추가해 볼게요.

최초 이름을 설정해 주고, 해당 File 즉, xml File을 찾아 볼거에요.

BROWSE 버튼을 눌러줄게요.

naver-checkstyle-rules.xml

위 File을 찾아 Import 해 줍니다.

 

그런 뒤 NEXT를 눌러줄게요.

이 곳에서 /config/checkstyle에 넣어두었던 naver-checkstyle-suppressions.xml 이름을 명시해 주었어요.

그런 뒤 NEXT를 눌러줍니다.

규칙 파일의 유효성이 검사되었으며 추가할 준비가 되었습니다.

이제 FINISH를 눌러줄게요.

설정한 내용이 보이면 활성화 하고, 적용을 누른 뒤 확인을 눌러 빠져 나갑니다.

인텔리제이 왼쪽에 ... 모양을 보면 위와 같이 CheckStyle이 생긴걸 확인할 수 있어요.

CheckStyle을 선택하면 밑에 화면이 위와 같이 바뀔건데, Rules 부분에 우리가 추가한 설정 이름을 선택해 줍니다.

왼쪽에 보면 폴더 모양 (Check Project)가 있는데, 이걸 클릭하면 위와 같이 검사가 진행되고,
어떤 부분이 문제가 있는지 알 수 있어요.


이번에는 어떤 부분이 문제가 있는지 확인했으니 문제를 해결하는 방법에 대해 설정해 볼게요.

        📦 IntelliJ-Formatter

이번에는 인텔리제이의 Formatter를 통해 naver-intellij-formmater.xml을 이용하여 설정하는 방법을 해 볼게요.

인텔리제이 설정(Intellj Configure) -> 에디터(Editor) -> 코드 스타일(Code Style) -> Java

위와 같이 설정 창에 가면 구성표 옆에 ...이 세로로 있는 것이 보이는데,
여기서 구성표 가져오기 -> IntelliJ IDEA 코드 스타일 XML 을 선택해 줄게요.

그리고, 위와 같이 naver-intellij-formatter.xml을 찾아 Import 해 줍니다.

이 화면이 나오면 확인을 눌러주면 된답니다.

위와 같이 구성표 이름이 바뀐걸 확인할 수 있어요.

적용을 누르고, 확인을 눌러 해당 창을 빠져 나와 줄게요.

naver-checkstyle-suppressions.yml

참고로 위 내용은 Test Method 이름이 한글인 것을 문제로 삼지 않게 하기 위해 추가해준 내용이에요.


이번에는 Code Convention을 잡아주는 유용한 플러그인을 설치하고, 설정해 볼게요.

 

 

 

        📦 PlugIn - Save Actions

위 플러그인을 받아 주도록 할게요.

설치가 완료되면 위와 같이 인텔리제이 설정에 기타 설정에 보면 Save Actions가 보이는데,
위와 같이 세 개의 체크 박스를 활성화 해 줄게요.

그런 뒤 적용을 누르고, 확인을 나와 빠져 나오면 import 최적화와 함께
Fommater Rule에 따라 Code가 재 정렬 될 거에요.

Project Root Directory 우클릭 -> 코드 서식 다시 지정

그리고 위와 같이 코드 서식 다시 지정을 선택해 줄게요.

위와 같은 창이 나오면 import 문 최적화만 활성화 한 뒤 실행을 눌러줍니다.

그럼 이렇게 열심히 인텔리제이가 작업하는 걸 확인할 수 있어요.


참고로 네이버 코드 컨벤션의 경우 문자열의 개행은 LF로 끝나야 해요.

이 부분을 맞춰볼게요.

인텔리제이 설정 -> 에디터(Editor) -> 코드 스타일(Code Style)

위 설정창에서 위와 같이 줄 구분 기호를 Unix 및 MacOS(\n)로 선택해 줄게요.

인텔리제이 밑에 오른쪽을 보면 위와 같이 LF로 설정된걸 확인할 수 있어요.

설정 전

 

설정 뒤

설정 전에는 위와 같이 문제가 7,814개나 있었는데, 이제 472개로 불어든 것을 확인할 수 있어요.

Source Code push를 통해 CI/CD를 걸고, 소나큐브에 검증을 받아 보니 위와 같이 깔끔해 진걸 확인할 수 있어요.

 

 

        📦 PlugIn - SonarLint

SonarLint는 Code 작성 시 버그, 취약점, 코드 악취를 찾아 문제를 알려주는 무료 IDE 플러그인이에요.

맞춤법 검사기와 마찬가지로 문제가 발생하면 즉시 강조 표시를 하고, 형상 관리로 Push 등을 하기 전에 코드를 정리할 수 있도록 도와주는 플러그인이에요.

SonarLint는 IntelliJ IDEA, CLion, WebStorm, PHPStorm, PyCharm, Rider, Android Studio 및 RubyMine을 포함한 대부분의 JetBrains IDE와 통합됩니다. 또한 Visual Studio Code에서도 지원이 되고 있어요. 
지원되는 언어에는 C, C++, Java, JavaScript, TypeScript, Python, C#, Kotlin, Ruby, HTML 및 PHP가 있답니다.

이 플러그인을 통해 소나큐브와 연동하여 Code Convention 등을 보다 확실하고, 견고하게 지킬 수 있도록 해 줄 수 있어요.

참고로 SonarLint를 사용하려면 IDE를 JVM 11+ 이상에서 실행해야 해요. (최근 모든 JetBrains IDE의 경우) 
JavaScript 및 TypeScript를 분석하려면 컴퓨터에 Node.js 12.22 이상 설치되어 있어야 해요.

 

 

이번에는 Sonar Lint 플러그인을 받아서 설정해 볼게요.

 

 

반응형

소나큐브와 연동을 위해 위와 같이 중간 부분에 구름 모양을 눌러줄게요.

 

 

이 곳에서 Bind project to SonarQube / SonarCloud 활성화 한 뒤
CONFIGURE THE CONNECTION...을 눌러 줍니다.

 

이 곳에서 + 버튼을 눌러 우리가 구성한 소나큐브와 연동을 해 줄거에요.

http://{소나큐브 IP}:{Port Numbe}/

먼저 이름을 적어주고, 우리는 Cloud가 아니기 때문에 sonarQube를 선택한 뒤 해당
소나큐브의 IP 주소와 포트 번호를 작성해 줍니다.

위와 같이 창이 나오면 Token 방식을 선택하던지 주니처럼 ID / Password 방식으로 연동을 해주어야 해요.


주니는 여러 개발자와 함께 사용할 수 있는 공용 계정을 만들어서 연동해 주었어요.

다음을 눌러줄게요.
  

위와 같은 창이 나오면 알림을 받기 위해 활성화를 해 주어야 해요.

활성화를 해 주면 다음 알림을 소나큐브로 부터 받을 수 있어요.

1. 바인딩된 프로젝트의 품질 게이트 상태 변경

2. 소나큐브에서 바인딩된 프로젝트에 대한 최신 분석 결과를 통한 문제 알림

 

 

 

다음을 누르면 위 창이 나올텐데, 생성을 눌러줄게요.

이 곳에서 확인을 눌러 해당 창을 나가줄게요.

이 곳에서 방금 만든 연동 정보를 선택해 주고, 확인을 눌러줍니다.

그리고 Project key 부분에 SEARCH IN LIST...를 눌러줍니다.

그럼 밑에 소나큐브 연동 Project Key가 있을텐데, 이걸 선택하고, 확인을 눌러줍니다.

그리고 이 곳에서도 확인을 눌러 주면 된답니다.

Report에 보면 왼쪽에 폴더 모양(Analyze All Project Files)가 있는데,
이걸 눌러 소나큐브에게 검증을 요청할 수 있어요.

그럼 위와 같이 내용이 나오는 걸 확인할 수 있어요.

Log를 통해서도 정상적으로 연동된걸 확인할 수 있답니다.

 

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

다음 글: [DevOps] JAVA Gradle JaCoCo (Code coverage) 설정하기