SonarQube (4.3.2)

SonarQube (version : 4.3.2)

SonarQube는 코드품질을 체크해주는 프로그램이다. 분기문을 체크하는 브랜치 커버리지 및 버그나 취약점을 체크하는 이슈, 기술 부채, 프로젝트 복잡도 등등 의 정보를 확인할 수 있다. 이밖에도 다양한 라이브러리를 적용하여 품질을 검증할 수 있다.

1. SonarQube 다운로드 및 특정 디렉토리에 압축 해체

2. SonarQube  실행

- SonarQube를 실행한다.

- console창에서 (SonarQub 압축해제 디렉토리/bin/{{os별 디렉토리}}/sonar.sh start)

- 브라우저에서 "http://localhost:9000" 접속 한다.

- Main 화면에서 로그인 한다. (계정 : admin / admin)

3. SonarQube 설정

- 1. SonarQube 플러그인 설치

- Setting -> Update Center -> Available Plugins 으로 이동 

(5.6버전에서는 Administration -> System -> updateCenter)

- Checkstyle 설치

- PMD 설치

- Findbugs 설치

- SonarQube 재시작 

- (SonarQub 압축해제 디렉토리/bin/{{os별 디렉토리}}/sonar.sh restart)

- 만약 재시작이 안된다면 "jacoco", "squid", "surefire" 플러그인을 제거한다.

- 2. Check Rule 등록

- Main 화면에서 Quality profiles 로 이동한다.

- 이름을 지정하고 첨부한 파일을 추가하여 Java Profile을 생성한다.

- 생성한 Java Profile을 Default로 지정한다. (Set as Default 클릭)

- 3. GeneratedFile Exclude (JPA등 자동으로 생성되는 파일은 제외한다.)

- setting -> General Settings -> Exclusions -> Files -> Global Source File Exclusions -> **/generated/** 추가

PMD

미사용 변수, 비어있는 코드 블락, 불필요한 오브젝트 생성과 같은 Defect을 유발할 수 있는 코드를 검사한다.

https://pmd.github.io/pmd-6.13.0/pmd_rules_java.html

 

Find Bugs

Java 프로그램에서 100여 개의 잠재적인 에러 타입을 찾아주며, 이 잠재적인 에러는 scariest, scary, troubling, concern으로 구분하여 점수(rank)가 주어진다. 

http://findbugs.sourceforge.net/manual/index.html

http://findbugs.sourceforge.net/manual/gui.html#d0e1162

 

Check Style

개발된 코드가 얼마나 코딩 룰을 잘 따르고 있는지 분석해주는 정적 분석 도구이다. 기본적으로 내장된 코딩 룰은 Google's Style과 Unix Style이다. 또한 조직만의 코딩 룰을 정의하고 작성된 코드들이 이를 잘 따르고 있는지 점검할 수 있다.

http://checkstyle.sourceforge.net/checks.html