SonarQube의 소스 코드 품질 관리 상태를 개발자에게 표시

SonarQube는 광범위한 프로그래밍 언어를 지원하고 코드 중복, 코딩 표준 준수, 테스트 범위, 코드 복잡성, 잠재적 버그 등과 같은 지표에 대한 보고를 제공하는 오픈 소스 코드 품질 보증 플랫폼입니다. SonarQube를 사용하면 분석 결과를 편리하게 시각화하고 시간 경과에 따른 프로젝트 개발 역학을 추적할 수 있습니다.

목표: 개발자에게 SonarQube의 소스 코드 품질 관리 상태를 보여줍니다.

두 가지 솔루션이 있습니다.

• SonarQube에서 소스코드 품질관리 상태를 확인하는 스크립트를 실행해 보세요. SonarQube의 소스 코드 품질 관리가 통과하지 못하면 어셈블리가 실패하게 됩니다.
• 메인 프로젝트 페이지에 소스코드 품질관리 상태를 표시합니다.

SonarQube 설치

rpm 패키지에서 sonarqube를 설치하려면 저장소를 사용합니다. https://harbottle.gitlab.io/harbottle-main.

CentOS 7용 저장소가 포함된 패키지를 설치해 보겠습니다.

yum install -y https://harbottle.gitlab.io/harbottle-main/7/x86_64/harbottle-main-release.rpm

Sonarqube 자체를 설치합니다.

yum install -y sonarqube

설치하는 동안 대부분의 플러그인이 설치되지만 findbugs 및 pmd를 설치해야 합니다.

yum install -y sonarqube-findbugs sonarqube-pmd

서비스를 시작하고 시작에 추가하세요.

systemctl start sonarqube
systemctl enable sonarqube

로드하는 데 시간이 오래 걸리면 sonar.web.javaOpts 옵션 끝에 난수 생성기 /dev/./urandom을 추가하세요.

sonar.web.javaOpts=другие параметры -Djava.security.egd=file:/dev/urandom

SonarQube에서 소스 코드 품질 관리 상태를 확인하기 위한 스크립트를 실행합니다.

불행하게도 sonar-break-maven-plugin 플러그인은 오랫동안 업데이트되지 않았습니다. 그럼 우리만의 스크립트를 작성해 봅시다.

테스트를 위해 저장소를 사용합니다. https://github.com/uweplonus/spotbugs-examples.

Gitlab으로 가져오는 중입니다. .gitlab-ci.yml 파일을 추가합니다.

variables:
  MAVEN_OPTS: "-Dhttps.protocols=TLSv1.2 -Dmaven.repo.local=~/.m2/repository -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=WARN -Dorg.slf4j.simpleLogger.showDateTime=true -Djava.awt.headless=true"
  MAVEN_CLI_OPTS: "--batch-mode --errors --fail-at-end --show-version -DinstallAtEnd=true -DdeployAtEnd=true"
  SONAR_HOST_URL: "http://172.26.9.226:9000"
  LOGIN: "admin" # логин sonarqube
  PASSWORD: "admin" # пароль sonarqube

cache:
  paths:
    - .m2/repository

build:
  image: maven:3.3.9-jdk-8
  stage: build
  script:
    - apt install -y jq || true
    - mvn $MAVEN_CLI_OPTS -Dmaven.test.failure.ignore=true org.jacoco:jacoco-maven-plugin:0.8.5:prepare-agent clean verify org.jacoco:jacoco-maven-plugin:0.8.5:report
    - mvn $MAVEN_CLI_OPTS -Dmaven.test.skip=true verify sonar:sonar -Dsonar.host.url=$SONAR_HOST_URL -Dsonar.login=$LOGIN -Dsonar.password=$PASSWORD -Dsonar.gitlab.project_id=$CI_PROJECT_PATH -Dsonar.gitlab.commit_sha=$CI_COMMIT_SHA -Dsonar.gitlab.ref_name=$CI_COMMIT_REF_NAME
    - export URL=$(cat target/sonar/report-task.txt | grep ceTaskUrl | cut -c11- ) #URL where report gets stored
    - echo $URL
    - |
      while : ;do
          curl -k -u "$LOGIN":"$PASSWORD" "$URL" -o analysis.txt
          export status=$(cat analysis.txt | jq -r '.task.status') #Status as SUCCESS, CANCELED, IN_PROGRESS or FAILED
          echo $status
          if [ ${status} == "SUCCESS" ];then
            echo "SONAR ANALYSIS SUCCESS";
            break
          fi
          sleep 5
      done
    - curl -k -u "$LOGIN":"$PASSWORD" "$URL" -o analysis.txt
    - export status=$(cat analysis.txt | jq -r '.task.status') #Status as SUCCESS, CANCELED or FAILED
    - export analysisId=$(cat analysis.txt | jq -r '.task.analysisId') #Get the analysis Id
    - |
      if [ "$status" == "SUCCESS" ]; then
        echo -e "SONAR ANALYSIS SUCCESSFUL...ANALYSING RESULTS";
        curl -k -u "$LOGIN":"$PASSWORD" "$SONAR_HOST_URL/api/qualitygates/project_status?analysisId=$analysisId" -o result.txt; #Analysis result like critical, major and minor issues
        export result=$(cat result.txt | jq -r '.projectStatus.status');

        if [ "$result" == "ERROR" ];then
          echo -e "91mSONAR RESULTS FAILED";
          echo "$(cat result.txt | jq -r '.projectStatus.conditions')"; #prints the critical, major and minor violations
          exit 1 #breaks the build for violations
        else
          echo -e "SONAR RESULTS SUCCESSFUL";
          echo "$(cat result.txt | jq -r '.projectStatus.conditions')";
          exit 0
        fi
      else
          echo -e "e[91mSONAR ANALYSIS FAILEDe[0m";
          exit 1 #breaks the build for failure in Step2
      fi
  tags:
    - docker

.gitlab-ci.yml 파일은 완벽하지 않습니다. Sonarqube의 스캔 작업이 "SUCCESS" 상태로 종료되었는지 테스트했습니다. 지금까지 다른 상태는 없었습니다. 다른 상태가 발생하는 대로 이 게시물에서 .gitlab-ci.yml을 수정하겠습니다.

메인 프로젝트 페이지에 소스코드 품질관리 현황 표시

SonarQube용 플러그인 설치

yum install -y sonarqube-qualinsight-badges

우리는 SonarQube로 이동합니다. http://172.26.9.115:9000/
예를 들어 "배지"와 같은 일반 사용자를 만듭니다.
이 사용자로 SonarQube에 로그인하세요.

"내 계정"으로 이동하여 예를 들어 "read_all_repository"라는 이름으로 새 토큰을 생성하고 "생성"을 클릭합니다.

토큰이 나타난 것을 볼 수 있습니다. 그는 딱 1번만 등장합니다.

관리자로 로그인하세요.

구성 -> SVG 배지로 이동합니다.

이 토큰을 "활동 배지 토큰" 필드에 복사하고 저장 버튼을 클릭하세요.

관리 -> 보안 -> 권한 템플릿 -> 기본 템플릿(및 기타 템플릿)으로 이동합니다.

배지 사용자는 "찾아보기" 확인란을 선택해야 합니다.

테스트.

예를 들어 프로젝트를 살펴 보겠습니다. https://github.com/jitpack/maven-simple.

이 프로젝트를 가져오겠습니다.

다음 내용으로 .gitlab-ci.yml 파일을 프로젝트 루트에 추가합니다.

variables:
  MAVEN_OPTS: "-Dhttps.protocols=TLSv1.2 -Dmaven.repo.local=~/.m2/repository -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=WARN -Dorg.slf4j.simpleLogger.showDateTime=true -Djava.awt.headless=true"
  MAVEN_CLI_OPTS: "--batch-mode --errors --fail-at-end --show-version -DinstallAtEnd=true -DdeployAtEnd=true"
  SONAR_HOST_URL: "http://172.26.9.115:9000"
  LOGIN: "admin" # логин sonarqube
  PASSWORD: "admin" # пароль sonarqube

cache:
  paths:
    - .m2/repository

build:
  image: maven:3.3.9-jdk-8
  stage: build
  script:
    - mvn $MAVEN_CLI_OPTS -Dmaven.test.failure.ignore=true org.jacoco:jacoco-maven-plugin:0.8.5:prepare-agent clean verify org.jacoco:jacoco-maven-plugin:0.8.5:report
    - mvn $MAVEN_CLI_OPTS -Dmaven.test.skip=true verify sonar:sonar -Dsonar.host.url=$SONAR_HOST_URL -Dsonar.login=$LOGIN -Dsonar.password=$PASSWORD -Dsonar.gitlab.project_id=$CI_PROJECT_PATH -Dsonar.gitlab.commit_sha=$CI_COMMIT_SHA -Dsonar.gitlab.ref_name=$CI_COMMIT_REF_NAME
  tags:
    - docker

SonarQube에서 프로젝트는 다음과 같습니다:

README.md에 가방을 추가하면 다음과 같이 보일 것입니다:

배지 표시 코드는 다음과 같습니다.

배지 표시 문자열 구문 분석:

[![Quality Gate](http://172.26.9.115:9000/api/badges/gate?key=com.github.jitpack:maven-simple)](http://172.26.9.115:9000/dashboard?id=com.github.jitpack%3Amaven-simple)
[![Название](http://172.26.9.115:9000/api/badges/gate?key=Project Key)](http://172.26.9.115:9000/dashboard?id=id-проекта)
[![Coverage](http://172.26.9.115:9000/api/badges/measure?key=com.github.jitpack:maven-simple&metric=coverage)](http://172.26.9.115:9000/dashboard?id=com.github.jitpack%3Amaven-simple)
[![Название Метрики](http://172.26.9.115:9000/api/badges/measure?key=Project Key&metric=МЕТРИКА)](http://172.26.9.115:9000/dashboard?id=id-проекта)

프로젝트 키와 프로젝트 ID를 가져오거나 확인할 수 있는 위치입니다.

프로젝트 키는 오른쪽 하단에 있습니다. URL에는 프로젝트 ID가 포함되어 있습니다.

측정항목을 얻기 위한 옵션은 다음과 같습니다. 여기를 봐.

개선, 버그 수정을 위한 모든 풀 요청 이 저장소에 제출.

SonarQube에 대한 텔레그램 채팅 https://t.me/sonarqube_ru
DevSecOps에 대한 전보 채팅 - 보안 DevOps https://t.me/sec_devops

출처 : habr.com