[인프라] Jacoco(자코코) ↔ SonarQube(소나큐브) ↔ Jenkins(젠킨스) 연동하여 코드 정적 분석 하기(1)

SonarQube란?

소나큐브는 현재 기준 27개의 프로그래밍 언어에서 버그, 코드스멜, 보안 취약점 등을 리뷰하는 정적 코드 분석 도구이다.

지속적으로 코드 품질을 높이고, 유지보수를 할 때 도움을 주는 애플리케이션이다. 코드 컨벤션부터 잠재적인 위험 사항까지 체크해주기 때문에 코딩 습관과 품질 향상에 많은 도움을 준다.

 

• 다양한 언에 대한 코드 분석을 지원
• Admin으로 로그인하여 분석 된 것을 한 눈에 확인할 수 있고, 지속적인 관리 가능
• Jenkins 같은 CI 엔진과 통합하여 분석도 가능

소나큐브 개요

소나큐브는 위의 그림과 같이 3부분으로 나눠져 있다.

 

1. Scanner(스캐너)는 정적 분석할 코드를 소나큐브 서버로 전달해주는 역할을 한다.

 Gradle, Maven, Jenkins, .net, ant, Azure Devops에 대해서는 구현되어있는 Plugin(플러그인)을 제공하고, 직접 스캐너를 커스텀할 수 있다.

 

2. Sonarqube Server(소나큐브 서버)에서는 정적 분석을 할 프로그램이 돌아가고 있는 서버다.

 스캐너로 부터 API 요청을 받으면, 해당 코드에 대한 정적 분석을 시행하고 리포트를 생성한다.

 

3. Database Server(데이터베이스 서버)에서는 분석결과를 영속화한다. Postgresql, oracle, MS SQL을 지원한다.

(만약, 데이터베이스 서버를 연결하지 않는다면, 소나큐브 프로그램 내부 H2 DB를 사용한다.)

 

---

프로젝트 환경

- Sonarqube 9.9

- Jacoco

- EC2 : Ubuntu Server 22.04 LTS ( t3-medium )

- Database : Postgresql 15.2

- Java : jdk 17

- CI tool : Jenkins

- 저장소 : GitLab

 

📣 SonarQube는 기본적으로 java, database가 설치되어 있어야 한다.

📣 자주 사용하는 mySQL를 데이터베이스로 사용하려고 했으나 sonarqube 7.2 까지 지원으로 postgresql로 사용

 

1. Ubuntu Server jdk 17 설치 및 설정( EC2 생성은 생략 )

# apt 업데이트
sudo apt update

# apt 업그레이드
sudo apt upgrade

리눅스 apt 명령어 업데이트 후 jdk 17 버전으로 설치

# java 17 설치
sudo apt install openjdk 17-jdk

설치한 java 의 버전과 경로를 확인하여 환경변수 설정

# java 버전 확인
java -version

# java 경로 확인
which java

sudo vi /etc/environment

# 환경변수 적용 확인
source /etc/environment

echo $JAVA_HOME

2. Database - Postgresql 설치 및 설정

Postgresql 은 기본적으로 5432 포트에 열리기 때문에 EC2 포트를 미리 열어줘야함

# postgresql 설치
sudo apt-get install postgresql

# postgres 계정으로 접속
sudo -i -u postgres

# postgresql 쉘 커맨드 실행
psql

postgres=# 으로 바뀜

이제 postgres 계정 말고도 sonarqube와 연동하여 사용할 계정을 만들어줌

# 계정 추가
create user [사용할 계정] with password '[사용할 암호]';

# 데이터베이스 생성
create database [사용할 데이터베이스명] owner [권한을 가지는 계정];

# 추가한 계정에 db 생성권한 부여
ALTER ROLE [계정명] WITH createdb;

완료 되면 위와 같이 뜸

3. SonarQube 설치 및 설정

소나큐브다운로드

Download | SonarQube

소나큐브 다운로드 페이지에서 버전과 서버환경에 맞춘 소나큐브.zip 파일 다운

링크 주소를 복사하여 ubuntu 환경에서 설치

# 소나큐브 다운로드
wget https://binaries.sonarsource.com/Distribution/sonarqube/sonarqube-9.9.0.65466.zip

# zip 파일 압축 해제를 위한 'unzip' 설치
sudo apt install unzip

# zip 파일 압축 해제
unzip sonarqube-9.9.0.65466.zip

sonarqube와 postgresql 연동을 위한 sonar.properties 파일 수정

vim [zip 파일 설치경로]/sonarqube-9.9.0.65466/conf/sonar.properties

sonar.jdbc.username=[postgresql에서 설정한 계정이름]

sonar.jdbc.username=[postgresql에서 설정한 암호]

sonar.jdbc.url=jdbc:postgresql://[postgresql 주소]

입력하고 :wq! 저장 후종료

cd [zip 설치된 경로]/bin/linux-x86-64

위의 경로 (설치된 서버에 해당하는 운영체제 폴더로 들어감)

sonarqube 실행 파일 존재

이 경로에서 실행함

# 기본적인 sonarqube 실행
./sonar.sh start

# sonarqube 실행과 콘솔 출력
./sonar.sh console start

💢 문제발생

콘솔 출력과 함께 sonarqube 실행을 했는데 아래와 같은 에러가 뜸

2023.02.14 00:36:42 INFO  es[][o.e.b.BootstrapChecks] explicitly enforcing bootstrap checks

ERROR: [1] bootstrap checks failed. You must address the points described in the following [1] lines before starting Elasticsearch.
bootstrap check failure [1] of [1]: max virtual memory areas vm.max_map_count [65530] is too low, increase to at least [262144]
ERROR: Elasticsearch did not exit normally - check the logs at /home/ubuntu/sonarqube-9.9.0.65466/logs/sonarqube.log

📌 참고 블로그

http://www.blognawa.com/i/28361/7345018/https://happylie.tistory.com/112

온실 속 선인장 - [SonarQube] 소나큐브 구동 시 vm.max_map_count Error 해결하기 | 블로그나와

검색 해보니 위의 에러는 vm.max_map_count의 설정값이 애플리케이션에서 필요로하는 수보다 작기 때문에 발생함

해당 에러는 Elasticsearch 구동 시에도 많이 발생하는 에러이고, 소나큐브도 마찬가지로 Elasticsearch 를 사용하고 있음

💡 해결

# vm.max_map_count 의 설정값 확인
sysctl -a | grep vm.max_map_count

# vm.max_map_count 설정값 변경
sysctl -w vm.max_map_count=262144

처음에 설정값을 확인해보면 vm.max_map_count = 65530 이다.

해당 값을 vm.max_map_count = 262144 로 변경해준다.

 

다시 start 해보니 정상 구동! 

console로 start하면 터미널이 꺼졌을 때 같이 종료되기 때문에 start로 바로 접속하기

 

 

 

✅ Jenkins , Jacoco 연동은 다음 포스팅에서...

 

 

 

 

📌 참고 블로그

https://kys9261.github.io/2019/05/02/programming/devops/how-to-install-sonarqube-on-ubuntu/

ubuntu에 SonarQube 설치하기