이 문서는 SonarQube 설치 후 기본적인 설정을 하기 위한 가이드를 공유하기 위해 작성되었다.
| 도구명 | SonarQube CE |
|---|---|
| 버전 | 9.4 |
이 문서에서는 관리자 메뉴에 대한 모든 것이 아닌 주요 설정만 소개한다.
General Settings
상단 Administration → Configuration → General Settings 메뉴에 진입한다.
General
- General - Server base URL : SonarQube URL 설정.
→ 접속할때 사용하는 URL(http(s):// 포함)을 입력한다.
- Look & Feel - Enable support of gravatars : 프로필에 외부 아바타(Gravatar) 사용 여부 설정.
→ 외부 인터넷이 안되는 환경일 경우 비활성화 한다.
- Quality Gate - Ignore duplication and coverage on small changes : Quality Gate 조건에서 작은 변경(20줄 미만)에 대한 중복 코드 및 커버리지 무시 여부 설정.
→ 작은 단위도 체크하고 싶을 경우 비활성화 한다.
- Email - SMTP ~ : 메일 알림을 위한 SMTP 설정.
- SMTP host : SMTP 서버 URL 입력
- SMTP port : SMTP 서버 포트 입력
- Secure connection : SMTP 서버 보안 접속 여부 설정 (No value / ssl / starttls
- SMTP username : SMTP 서버 인증을 위한 계정 입력 (인증 필요 없이 SMTP 서버 사용 가능할 경우 입력 불필요)
- SMTP password : SMTP username에 대한 인증 패스워드 입력 (인증 필요 없이 SMTP 서버 사용 가능할 경우 입력 불필요)
- From address : 발신자로 표시되는 메일주소 입력
- From name : 발신자로 표시되는 이름 입력
- Email prefix : 메일 제목 앞에 붙는 텍스트 입력
- Test Configuration : 위 설정 항목으로 SMTP 메일 발신이 정상적으로 동작하는지 테스트 기능 제공
Security
- Security - Force user authentication : 익명사용자(anonymous users) 방지 설정.
→ SonarQube는 기본적으로 익명사용자도 프로젝트를 볼 수 있다. 익명 사용자를 방지하고 로그인한 사용자만 볼수 있게하려면 해당 기능 활성화 한다.
DevOps Platform Integrations
- DevOps Platform Integrations : 형상관리 시스템과 연동 설정. GitHub / Bitbucket / Azure DevOps / GitLab을 지원하고 여기서는 Bitbucket Server 연동 설정을 소개한다.
- Bitbucket → Create configuration 버튼 클릭
Bitbucket Server 선택 후 다음과 같이 설정 후 Save configuration 버튼 클릭
- Configuration name : 설정명 입력
- Bitbucket Server URL : Bitbucket 서버 URL 입력
- Personal Access Token : Bitbucket에서 생성한 토큰 입력
> Bitbucket Personal Access Token은 SonarQube에서 Bitbucket Pull Request의 Quality Gate 상태를 보고하기 위해 필요한 것으로, 관리자 권한을 가진 계정의 토큰과 최소 Read 권한이 필요함
> Quality Gate 상태 보고는 브랜치별 분석기능을 지원하는 SonarQube Developer 버전 이상에서 지원
- 설정 결과 및 연동 상태 확인
- Check configuration 버튼 클릭하여 연동 정상일 경우 초록색으로 Configuration valid 표시됨
- Bitbucket → Create configuration 버튼 클릭