이 문서는 SonarQube Scanner를 활용하여 코드 분석을 위한 가이드를 제공한다.
SonarQube
사전 준비사항
- SonarQube Server (가이드 참조)
- Global Analysis Token
- 발급 방법: SonarQube 서버 Web UI - 우상단 Account - My Account - Security - Generate Tokens
Token 이름 입력 + Global Analysis Token 선택 - Generate
- 발급 방법: SonarQube 서버 Web UI - 우상단 Account - My Account - Security - Generate Tokens
SonarScanner CLI
SonarQube SonarScanner 다운로드
아래 링크를 통해 SonarQube SonarScanner를 다운로드 받는다.
- Windows : https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-8.0.1.6346-windows-x64.zip
- Linux : https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-8.0.1.6346-linux-x64.zip
- Mac : https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-8.0.1.6346-macosx-aarch64.zip
- 기타 (다음 링크 참조)
다운로드 받은 SonarQube SonarScanner 파일을 적절한 위치에 압축을 해제한다.
- ex) D:\apps\Sonar\sonar-scanner-8.0.1.6346-windows--x64
SonarQube SonarScanner 실행
SonarScanner 실행을 위해 분석 타겟 프로젝트의 루트 디렉토리로 이동한다.
- ex) C:\Users\curvc\source\repos\ConsoleApplication1
다음과 같이 SonarQube Sonarscanner를 실행한다.
sonar-scanner.bat -Dsonar.host.url=https://<sonarqube-server> -Dsonar.projectKey=sample-sonar-scanner -Dsonar.token=<global-analysis-token>
실제 수행 예시는 다음과 같다.
D:\apps\Sonarsource\sonar-scanner-8.0.1.6346-windows--x64\bin\sonar-scanner.bat -D"sonar.host.url=http://localhost:9000" -D"sonar.projectKey=sample-sonar-scanner" -D"sonar.token=<global-analysis-token>"