사용자 도구

사이트 도구


java:sonarqube

SonarQube

SonarQube Scanner for Jenkins

  • Jenkins 사용시 Jenkins용 SonarQube Scanner를 사용하면 멀티 모듈 프로젝트를 하나로 묶는것이 더 좋고, 자동으로 sonarqube 에 대한 링크까지 생성된다.
  • Maven이나 Gradle Plugin이 아닌 Jenkins 혹은 명령행 Scanner 사용시 Java Plugin and Bytecode에 있는 sonar.java.binaries, sonar.java.libraries이 올바로 설정이 안되어 Lombok 등에 대한 false alarm이 빌생하게 된다.
  • 따라서 위 프라퍼티들을 올바로 설정할 자신이 없으면 그냥 Gradle SonarQube 사용 권장

False Positive

  • 해당 규칙이 false positive 인 경우 NOSONAR 보다는 Rule 자체를 변경하는 것이 좋겠다.
  • //NOSONAR시에 항상 왜 그럴 수 밖에 없었는지 이유를 작성하자.

@SuppressWarnings("all")

  • @SuppressWarnings(“all”)를 클래스에 붙이면 해당 클래스의 모든 규칙 위반을 무시한다.

NOSONAR

  • 규칙 위반을 고치는게 불가능할 경우 해당 위반의 줄 맨 끝에 //NOSONAR를 붙인다.

@SuppressWarnings("squid:룰번호")

  • @SuppressWarnings({“squid:S2078”, “squid:S2076”}) 처럼 @SuppressWarningssquid:S룰번호 를 사용한다.

참고 자료

Web API

  • 분석 및 분석 결과등을 API로 제공
  • 자신의sonarqube.주소/web_api를 통해 현재 시스템이 제공하는 API 목록 및 문서 확인 가능.
# 현재 이슈 목록
curl http://sonarqube.example.com/api/issues/search?componentKeys=project:module

# 현재 프로젝트의 메트릭(위반 갯수 등)
 curl 'http://sonarqube.example.com?componentKeys=project:module&severities=BLOCKER,MAJOR,CRITICAL'

Quality Gates

  • 분석 결과 품질이 저하되거나 하면 알림을 줄 수 있다.
  • 알림은 자기 계정의 My Account → Notifications에서 프로젝트 단위, 혹은 전체 프로젝트를 지정할 수 있다.

Jenkins Pipeline에서 Quality Gate 응답 대기

  • Quality Gate 응답을 기다리고 실패이면 UNSTABLE로 변경
    timeout(time: 10, unit: 'MINUTES') {
        def qg = waitForQualityGate()
        if (qg.status != 'OK') {
            println "Pipeline unstable due to SoanrQube quality gate failure: ${qg.status}"
            currentBuild.result = 'UNSTABLE'
        }
    }
  • Declarative Pipeline 에서 아래 사용시 무조건 FAILURE로 바꿔버림
     waitForQualityGate abortPipeline: true

Installing Sonar

  • Sonar 웹서버를 다운로드하여 압축을 풀면 설치가 끝난다.

설정

  • conf/sonar.properties 파일에서 데이터베이스를 지정해준다. 설정 파일에서 주석만 제거하면 될 정도로 예제가 다 나와있다.
    sonar.jdbc.url: the URL of the database
    sonar.jdbc.driver: the class of the driver
    sonar.jdbc.user: the username
    sonar.jdbc.password: the password
  • bin/아키텍처/실행파일를 실행한다.
  • DB 생성과 권한 설정만 해 두면 나머지는 테이블 생성은 알아서 진행된다.
  • 실행시 디버그 정보를 보려면 -Dsonar.verbose=true 시스템 프라퍼티를 지정한다.

Annotation Magic number

  • MagicNumber 항목을 찾아서 ignoreAnnotation, ignoreHashCode 등을 true로 변경한다.

Plugin

exclude

  • General Settings → Exclusions → Global Source File Exclusions에서 file:**/generated/**를 통해 generated 이하 파일들 모두 제외

Powermock

  • Powermock + jacoco 사용시에는 코드 커버리지가 작동하지 않는다.
  • Cobertura를 사용하면 작동한다.

Findbug timeout

  • sonarqube - Jenkins findbug threshold issue
     Can not execute SonarQube analysis: Can not execute Findbugs with a timeout threshold value of 600000 milliseconds
  • 위와 같은 오류 발생시에는 SonarQube Settings → General Settings → Java → FindBugs에 들어가 FindBug에서 timeout을 늘려줘야한다.

참조

java/sonarqube.txt · 마지막으로 수정됨: 2018/10/11 16:06 저자 kwon37xi