이 문서는 SonarQube Plugin 설치가이드를 공유하기 위해 작성되었다.
| 도구명 | SonarQube CE |
|---|---|
| 버전 | 9.4 |
SonarQube Marketplace 이용
SonarQube Marketplace를 통해서 설치하는 방법과, 서버에 직접 설치하는 방법을 가이드한다.
SonarQube Marketplace Plugin 설치
- 마켓플레이스 접속이 가능해야하므로 외부 인터넷이 가능한 환경만 가능
1. 관리자 계정으로 로그인 후 상단 Administration → Marketplace 메뉴에 진입한다.
2. 하단 Marketplace에 등록된 Plugin 목록에서 설치할 Plugin 우측 Install 버튼을 클릭한다.
검색 필드를 통해 원하는 플러그인 검색 가능
3. Install 버튼 클릭시 설치중 아이콘이 표시되고, 완료시 다음과 같이 Install Pending으로 표시된다.
상단에는 안내 메시지가 표시되며, 설치한 Plugin을 적용하기 위한 재시작(Restart Server) 버튼과 취소를 위한 원복(Revert) 버튼을 제공한다.
4. 재시작(Restart Server) 버튼을 클릭하면 다음과 같이 한번더 물어보고, Restart 버튼을 클릭하여 서버를 재시작한다.
5. 재시작 완료 후 다시 Marketplace 메뉴에 진입하여 Plugin 목록의 Installed(설치됨) 탭 클릭 시 위에서 설치한 Plugin 을 확인할 수 있다.
6. SonarQube Plugin은 종류에 따라서 구동방식이 다를 수 있다.
- Korean Pack Plugin : 한국어팩 Plugin으로 설치시 바로 적용되어 메뉴 등이 한글로 번역되어 표시된다.
(별도 Plugin을 위한 메뉴 제공되지 않아 삭제 외엔 비활성화 불가능) Azure Active Directory (AAD) Authentication Plugin : Azure AD를 Integration 하기 위한 Plugin으로 설정 메뉴를 제공한다.
SonarQube Marketplace Plugin 제거
위 설치방법과 동일한 순서로 Marketplace Plugin 목록에서 설치한 Plugin의 제거(Uninstall) 버튼 클릭 후 재시작(Restart Server) 버튼으로 서버 재시작시, 제거된다.
한국어팩 Plugin 제거 후 서버 재시작 시 한국어 번역 효과 제거되고, 설치된 Plugin 목록에서도 사라짐
SonarQube Plugin 수동 설치
- 외부 인터넷이 안되는 환경에서 Plugin 다운로드 및 서버에 업로드하여 설치
1. 설치할 SonarQube Plugin을 다운로드 한다.
- 퍼블릭 Plugin은 Github /
SonarQube Plugins Index사이트 등에서 검색하여 다운로드 가능 - 이 가이드에서는 Findbugs Plugin을 다운로드하여 수동 설치 방법 가이드
- Findbugs Plugin : Java 관련 Rule Sets(=Quality Profiles) 제공
1-1. SonarQube Plugins Index 사이트 통하여 다운로드
- 최신버전 업로드가 되지 않고 있어, SonarQube Plugins Index 사이트 사용 비권장
- 구글링을 통해 설치한 Plugin 공식 홈페이지에서 다운로드(ex Findbugs Plugin의 경우 GitHub)
1-1-1. SonarQube Plugins Index(SonarQube™ Plugins Index) 사이트 접속하여 설치한 Plugin 검색
1-1-2. 검색 결과 Plugin 선택
1-1-3. 다운로드(version x.xx.x) 버튼 클릭하여 plugin jar 파일 다운로드
1-2. Plugin 공식 홈페이지(ex. Github)에서 다운로드
1-2-1. Findbugs(=Spotbugs) Plugin 공식 홈페이지(Github GitHub - spotbugs/sonar-findbugs: SpotBugs plugin for SonarQube)진입하여 우측 최신 Release 버전 클릭
1-2-2. 하단 Assets 항목에서 jar파일 선택하여 Plugin 다운로드
2. 다운로드한 Plugin jar 파일을 SonarQube 서버에 업로드하고, SonarQube의 다음 경로에 위치한다.
$SONARQUBE_HOME/extensions/plugins
- $SONARQUBE_HOME/extensions/plugins 위치에 jar파일 복사
- jar파일 소유자 권한 SonarQube 실행 계정과 동일하게 변경
- 신규 설치가 아닌 업데이트일 경우 기존 설치된 jar 파일 삭제
3. 서버 수동으로 재시작
- SonarQube Administration(관리자 메뉴) -> System 메뉴에서 Restart Server 버튼으로 재시작 할 수 있다.
4. 재시작 완료 후 관리자 메뉴(Administration) → Marketplace 메뉴에 진입하여 Plugin 목록의 Installed(설치됨) 탭 클릭 시 위에서 설치한 Plugin 을 확인할 수 있다.
5. Quality Profiles 메뉴 → Java 부분 확인 시 FindBugs Profile이 생성된것을 확인할 수 있다.
SonarQube Plugin 수동 제거
SonarQube Plugin이 설치된 다음 경로에서 제거할 Plugin jar파일을 삭제하고 SonarQube 서버를 재시작한다.
$SONARQUBE_HOME/extensions/plugins
참조 링크
- Install a Plugin | SonarQube Docs
- Marketplace | SonarQube Docs
- SonarQube™ Plugins Index (sonarplugins.com)
- GitHub - spotbugs/sonar-findbugs: SpotBugs plugin for SonarQube