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

 

 

 

 

 

🚀 SonarQube 설치

    🔽 개요

        📦 소개

이번에는 Docker를 이용하여 SonarQube라는 것을 설치해 보려고 해요.

먼저 SonarQube란 무엇일까요?

소나소스가 개발한 소나큐브는 코드 베이스의 코드 품질 및 보안을 지속해서 검사하고, 코드 검토 중에 개발팀을 좋은 코드로 인도하는 안내자 역할을 하는 도구에요.

현재 27개의 Programming Language를 지원하고, 기존 Software Pipeline과 연결되는 동안 소나큐브는 개발자가 문제를 이해하고, 수정하고, 팀 전체가 더 우수하고, 안전한 개발을 할 수 있도록 명확한 수정 방법에 대한 가이드라인을 제공해 주는 친절한 개발 동반자에요.

170,000개 이상의 배포를 통해 소규모 개발팀과 글로벌 조직을 지원하는 소나큐브는 전 세계의 모든 팀과 회사가 코드 품질 및 보안을 소유하고 영향을 미칠 수 있는 수단을 제공하고 있어요.

소나큐브는 20개 이상의 Programming Language에서 Bug, Code smell, 보안 취약점을 발견할 목적으로 정적 코드 분석을 통해 자동 리뷰를 수행하기 위한 지속적인 코드 품질 검사용 오픈 소스 플랫폼이에요.

소나큐브는 중복 코드, 코딩 표준, 유닛 테스트, 코드 커버리지, 코드 복잡도, 주석, 버그 및 보안 취약점 관련 보고서 또한 제공해 주는 친구에요. 또한, 각종 Plugin을 제공하여 보다 많은 기능을 사용할 수 있게 도와주며, IDE 확장 Plugin으로 소나린트를 통해 다양한 코드 품질 문제를 감지하고, 수정할 수 있도록 도와주고 있어요.

소나큐브는 커뮤니티 부터 데이터 센터까지 다양한 Edtion으로 구성되어 있고, 그 중 주니쓰가 구축할 Communication Edition은 무료 버전이에요.

참고로 그 외 Edition은 인스턴스 당 코드 라인 수로 가격이 책정되고, 다양한 기능들을 더 이용할 수 있답니다.

 

 

 

소나큐브의 분석 기준은 아래와 같아요.

분석 기준 종류	상세 내용
코드 악취(Maintainability)	변경 가능성, 모듈성, 이해 가능성, 테스트 용의성, 재 사용성 등 심각한 문제는 아니나, 사소한 문제들
Bug	잠재적 버그 혹은 Runtime 당시 예상되는 동작하지 않는 Code
취약점	Cracker에게 잠재적 약점이 될 수 있는 보안상 문제. SQL Injection, Cross Site Script 공격과 같은 보안 취약성을 찾는다.
중복	코드 품질 저해 시키는 가장 큰 요인 중 하나
단위 테스트	단위 테스트 커버리지 기능을 통해 테스트의 성공 / 실패 정보 제공
복잡도	순환 복잡도 측정, 코드 논리적 흐름 상 존재하는 인지 복잡도 측정
사이즈	코드 라인 전체 라인 수 구문, 함수 / 클래스, Directory, 주석 수, 코멘트 비율 등 코드 크기와 관련된 다양한 지표 제공

728x90

 

 

 

    🔽 구성

        📦 설치

주니가 설치 및 구축하려는 소나큐브에 대해 어느정도 알았으니 본격적으로 설치 진행해 볼게요.
Docker 안에 소나큐브 관련한 Image는 굉장히 다양하게 존재해요.

하지만, 주니는 PR Decoration을 보다 편리하게 이용할 수 있는 mc1arke/sonarqube-with-community-branch-plugin Image를 통해 설치를 진행해 보려고 해요.

최초 아래와 같이 max virtual memory areas 설정의 vm.max_map_count 값을 도커 호스트 서버에서 올려주어야 해요.

# max virtual memory areas의 vm.max_map_count 값 확인 명령어
sysctl vm.max_map_count

 

vim /etc/sysctl.conf

맨 아랫줄에 위와 같이 추가해 주었어요.

그런 뒤 저장하고 나옵니다.

sysctl -p

위 명령어를 입력하여 변경 사항을 입력시켜 주었어요.

 

 

docker pull mc1arke/sonarqube-with-community-branch-plugin

 

 

최초 위와 같이 Image를 내려 받아 주었어요.

 

 

vim {Shell Script file Name}.sh

반응형

그런 뒤 위와 같이 Container 구동용 Shell Script를 만들어 주었어요. 

 

 

chmod -R 775 {Shell Script Name}.sh

 

그런 뒤 만들어준 Shell Script의 권한을 변경해 주었어요.

 

 

./{Shell Script Name}.sh

 

해당 Shell Script를 작동 시켜 Container를 구동 시켜 주었어요.

 

 

 

초기 계정: admin // admin

 

브라우저를 통해 해당 Docker Container Host OS IP주소와 Container에 설정한 Port 번호를 통해 접속할 수 있어요.

 

 

 

최초 접속을 시도하면 위와 같이 비밀번호를 바꾸라고 할 거에요.
비밀번호를 변경해 줄게요.

Plugin이 발견 되었다는 경고에요.

이는 공식적으로 소나큐브가 제공하지 않는 Plugin인 sonarqube-with-community-branch-plugin이 설치된 소나큐브를 설치했기 때문에 나오는 것이에요.

I understand the risk를 누르고 넘어 갑니다.

정상적으로 설치가 완료 되었어요.

 

 

 

        📦 부가 설정

이번에는 보다 편리한 사용을 위해 한글팩을 설치해 보도록 할게요.

 

 

Administration -> Marketplace -> 검색창: korean -> Install

 

 

위와 같이 설치를 진행해 줍니다.

설치가 완료되면 Restart Server를 눌러 해당 Container를 재부팅 해 줍니다.
이 때, Container가 재 부팅되는 것이지 Host 장비가 재부팅 되는 것은 아니에요.

재부팅이 되고 나면 이렇게 Login창이 다시 보일텐데, 벌써 한글이 보이는 거 보이시나요?

이렇게 한글팩까지 초기 설정을 모두 마무리 하였어요.

🧐 참고 자료

https://junyharang.tistory.com/368