Приказ статуса контроле квалитета изворног кода у СонарКубе програмерима

СонарКубе је платформа за осигурање квалитета отвореног кода која подржава широк спектар програмских језика и пружа извештаје о метрикама као што су дуплицирање кода, усклађеност са стандардима кодирања, покривеност тестом, сложеност кода, потенцијалне грешке и још много тога. СонарКубе практично визуализује резултате анализе и омогућава вам да пратите динамику развоја пројекта током времена.

Циљ: Покажите програмерима статус контроле квалитета изворног кода у СонарКубе-у.

Постоје два решења:

• Покрените скрипту да бисте проверили статус контроле квалитета изворног кода у СонарКубе-у. Ако контрола квалитета изворног кода у СонарКубе-у не прође, онда монтажа не успе.
• Прикажи статус контроле квалитета изворног кода на главној страници пројекта.

Инсталирање СонарКубе-а

Да бисмо инсталирали сонаркубе из рпм пакета, користићемо спремиште https://harbottle.gitlab.io/harbottle-main.

Хајде да инсталирамо пакет са спремиштем за ЦентОС 7.

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

Инсталирамо сам сонаркубе.

yum install -y sonarqube

Током инсталације, већина додатака ће бити инсталирана, али морате да инсталирате финдбугове и пмд

yum install -y sonarqube-findbugs sonarqube-pmd

Покрените услугу и додајте је у покретање

systemctl start sonarqube
systemctl enable sonarqube

Ако је потребно много времена за учитавање, додајте генератор случајних бројева /дев/./урандом на крај опција сонар.веб.јаваОптс

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

Покретање скрипте за проверу статуса контроле квалитета изворног кода у СонарКубе-у.

Нажалост, додатак сонар-бреак-мавен-плугин није ажуриран дуго времена. Па хајде да напишемо сопствени сценарио.

За тестирање ћемо користити спремиште https://github.com/uweplonus/spotbugs-examples.

Увоз у Гитлаб. Додајте датотеку .гитлаб-ци.имл:

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

Датотека .гитлаб-ци.имл није савршена. Тестирано да ли се задаци скенирања у сонаркубе-у завршавају статусом: „УСПЕХ“. До сада није било других статуса. Чим буду други статуси, исправићу .гитлаб-ци.имл у овом посту.

Приказ статуса контроле квалитета изворног кода на главној страници пројекта

Инсталирање додатка за СонарКубе

yum install -y sonarqube-qualinsight-badges

Идемо у СонарКубе у http://172.26.9.115:9000/
Креирајте редовног корисника, на пример "значке".
Пријавите се на СонарКубе под овим корисником.

Идите на „Мој налог“, креирајте нови токен, на пример са именом „реад_алл_репоситори“ и кликните на „Генериши“.

Видимо да се појавио токен. Он ће се појавити само 1 пут.

Пријавите се као администратор.

Идите на Конфигурација -> СВГ значке

Копирајте овај токен у поље „Токен значке активности“ и кликните на дугме сачувај.

Идите на Администрација -> Безбедност -> Шаблони дозвола -> Подразумевани шаблон (и друге шаблоне које ћете имати).

Корисник значке мора имати потврђен избор у пољу за потврду „Прегледај“.

Тестирање

На пример, узмимо пројекат https://github.com/jitpack/maven-simple.

Хајде да увеземо овај пројекат.

Додајте датотеку .гитлаб-ци.имл у корен пројекта са следећим садржајем.

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

У СонарКубе-у пројекат ће изгледати овако:

Додајте торбе у РЕАДМЕ.мд и оне ће изгледати овако:

Код за приказ значки изгледа овако:

Рашчлањивање низа приказа значки:

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

Где да добијете/проверите кључ пројекта и ИД пројекта.

Кључ пројекта је у доњем десном углу. УРЛ садржи ИД пројекта.

Опције за добијање метрике могу бити погледај овде.

Сви захтеви за повлачењем за побољшања, исправке грешака доставити у ово спремиште.

Телеграм ћаскање о СонарКубе-у https://t.me/sonarqube_ru
Телеграм ћаскање о ДевСецОпс-у - безбедном ДевОпс-у https://t.me/sec_devops

Извор: ввв.хабр.цом