🥇Адлюстраванне распрацоўнікам статусу кантролю якасці зыходнага кода ў SonarQube

SonarQube – гэта адкрытая платформа для забеспячэння бесперапыннага кантролю якасці зыходнага кода, якая падтрымлівае вялікую колькасць моў праграмавання і дазваляе атрымліваць справаздачы па такіх метрыках, як дубліраванне кода, адпаведнасць стандартам кадавання, пакрыццё тэстамі, складанасць кода, патэнцыйныя памылкі і г.д. SonarQube зручна візуалізуе вынікі аналізу і дазваляе адсочваць дынаміку развіцця праекта ў часе.

Задача: Паказваць распрацоўшчыкам статус кантролю якасці зыходнага кода ў SonarQube.

Ёсць два спосабы рашэння:

Запускаць скрыпт праверкі статуту кантролю якасці зыходнага кода ў SonarQube. Калі кантроль якасці зыходнага кода ў SonarQube не праходзіць, тое фейліць зборку.
Паказваць на галоўнай старонцы праекта статус кантролю якасці зыходнага кода.

Устаноўка SonarQube

Для ўсталёўкі sonarqube з rpm пакетаў скарыстаемся рэпазітаром. 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/
Ствараем звычайнага карыстальніка, напрыклад "badges".
Заходзім пад гэтым карыстальнікам у SonarQube.

Заходзім у "My account", ствараем новы токер, напрыклад з назовам "read_all_repository" і націскаем "Genereate".

Бачым, што з'явіўся токен. Ён з'явіцца толькі 1 раз.

Заходзім пад адміністратарам.

Ідзем у Configuration -> SVG Badges

Капіяваны гэты токен у поле "Activity badge token" і націскаем кнопку save.

Заходзім у Administration -> Security -> Permission Templates -> Default template (і іншыя шаблоны, якія ў вас будуць).

У карыстальніка badges неабходна ўсталяваць галку "Browse".

Тэставанне.

Для прыкладу возьмем праект 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 праект будзе выглядаць так:

Дадаем bages у README.md і яны будуць выглядаць так:

Код адлюстравання badges выглядае так:

Разбор радка адлюстравання badges:

[![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-проекта)

Дзе ўзяць/праверыць Project Key і id-праекта.

Project Key знаходзіцца справа ўнізе. У URL знаходзіцца id-праекта.

Опцыі для атрыманне метрык можна паглядзець тут.

Усе pull request на паляпшэнне, выпраўленні памылак дасылайце ў гэты рэпазітар.

Тэлеграм чат пра SonarQube https://t.me/sonarqube_ru
Тэлеграм чат пра DevSecOps - бяспечны DevOps https://t.me/sec_devops

Крыніца: habr.com

Адлюстраванне распрацоўнікам статусу кантролю якасці зыходнага кода ў SonarQube

Устаноўка SonarQube

Запуск скрыпту праверкі статуту кантролю якасці зыходнага кода ў SonarQube.

Адлюстраванне на галоўнай старонцы праекта статус кантролю якасці зыходнага кода

Дадаць каментар Адмяніць адказ