이 문서는 SonarQube Scanner를 활용하여 코드 분석을 위한 가이드를 제공한다.
SonarQube
사전 준비사항
- SonarQube Server
- JDK 11 version
- SonarQube Scanners
- JDK 11 version, JDK 8 version
SonarQube 다운로드
아래 링크를 통해 SonarQube 적절한 에디션을 다운로드 받는다.
다운로드 받은 파일을 적절한 위치에 압축을 해제한다.
- ex) D:\apps\Sonarsource\sonarqube-8.5.1.38104
SonarQube 서버 실행
실습을 위해 아래 경로의 배치 파일을 실행한다.
- D:\apps\Sonarsource\sonarqube-8.5.1.38104\bin\windows-x86-64\StartSonar.bat
다음과 같이 서버가 실행된다.
SonarQube 서버 접속 확인
다음 주소로 접속하여 아래 화면과 같이 SonarQube 서버에 접속되는지 확인한다.
상단 로그인 버튼을 클릭하여 기본 암호로 로그인이 되는지 확인한다.
- admin / admin
SonarScanner Basic
SonarQube SonarScanner 다운로드
아래 링크를 통해 SonarQube SonarScanner를 다운로드 받는다.
- Windows : https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-4.5.0.2216-windows.zip
- Linux : https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-4.5.0.2216-linux.zip
- Mac : https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-4.5.0.2216-macosx.zip
- 기타 (다음 링크 참조)
다운로드 받은 SonarQube SonarScanner 파일을 적절한 위치에 압축을 해제한다.
- ex) D:\apps\Sonarsource\sonar-scanner-4.5.0.2216-windows
SonarQube 분석 샘플 파일 다운로드
이를 위해 다음 샘플을 다운로드를 받는다.
다음과 같이 적절한 위치에 압축을 해제한다.
- ex) D:\apps\Sonarsource\Samplecode\sonar-scanning-examples-master
SonarQube SonarScanner 실행
샘플 파일이 압축 해제되면 아래와 같이 sonar-scanner 폴더로 이동한다.
- ex) D:\apps\Sonarsource\Samplecode\sonar-scanning-examples-master\sonarqube-scanner
다음과 같이 SonarQube Sonarscanner를 실행한다.
sonar-scanner.bat -Dsonar.host.url=http://localhost:9000 -Dsonar.projectKey=sample-sonar-scanner -Dsonar.projectName="Sample Sonar Scanner"
실제 수행 예시는 다음과 같다.
D:\apps\Sonarsource\sonar-scanner-4.5.0.2216-windows\bin\sonar-scanner.bat -Dsonar.host.url=http://localhost:9000 -Dsonar.projectKey=sample-sonar-scanner -Dsonar.projectName="Sample Sonar Scanner"
아래와 같이 수행 결과를 확인할 수 있다.
웹페이지로 접속하면 다음 결과를 확인할 수 있다.
