🥇Wyświetlanie statusu kontroli jakości kodu źródłowego w SonarQube dla programistów

SonarQube to platforma zapewniania jakości kodu open source, która obsługuje szeroką gamę języków programowania i zapewnia raportowanie wskaźników, takich jak duplikacja kodu, zgodność ze standardami kodowania, pokrycie testów, złożoność kodu, potencjalne błędy i inne. SonarQube w wygodny sposób wizualizuje wyniki analiz i pozwala śledzić dynamikę rozwoju projektu w czasie.

Cel: Pokazanie programistom stanu kontroli jakości kodu źródłowego w SonarQube.

Istnieją dwa rozwiązania:

Uruchom skrypt, aby sprawdzić stan kontroli jakości kodu źródłowego w SonarQube. Jeśli kontrola jakości kodu źródłowego w SonarQube nie przejdzie pomyślnie, montaż nie powiedzie się.
Pokaż status kontroli jakości kodu źródłowego na stronie głównej projektu.

Instalowanie SonarQube

Do instalacji sonarqube z pakietów RPM skorzystamy z repozytorium https://harbottle.gitlab.io/harbottle-main.

Zainstalujmy paczkę z repozytorium dla CentOS 7.

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

Instalujemy sam sonarqube.

yum install -y sonarqube

Podczas instalacji większość wtyczek zostanie zainstalowana, ale musisz zainstalować findbugs i pmd

yum install -y sonarqube-findbugs sonarqube-pmd

Uruchom usługę i dodaj ją do uruchamiania

systemctl start sonarqube
systemctl enable sonarqube

Jeśli ładowanie zajmuje dużo czasu, dodaj generator liczb losowych /dev/./urandom na końcu opcji sonar.web.javaOpts

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

Uruchomienie skryptu sprawdzającego stan kontroli jakości kodu źródłowego w SonarQube.

Niestety wtyczka sonar-break-maven-plugin nie była aktualizowana od dłuższego czasu. Napiszmy więc własny scenariusz.

Do testów będziemy używać repozytorium https://github.com/uweplonus/spotbugs-examples.

Importowanie do Gitlaba. Dodaj plik .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

Plik .gitlab-ci.yml nie jest doskonały. Testowane, czy zadania skanowania w sonarqube zakończyły się statusem: „SUCCESS”. Jak dotąd nie było innych statusów. Gdy tylko pojawią się inne statusy, poprawię .gitlab-ci.yml w tym poście.

Wyświetlanie stanu kontroli jakości kodu źródłowego na stronie głównej projektu

Instalowanie wtyczki do SonarQube

yum install -y sonarqube-qualinsight-badges

Do SonarQube jedziemy o godz http://172.26.9.115:9000/
Utwórz zwykłego użytkownika, na przykład „odznaki”.
Zaloguj się do SonarQube pod tym użytkownikiem.

Przejdź do „Moje konto”, utwórz nowy token, np. o nazwie „read_all_repository” i kliknij „Generuj”.

Widzimy, że pojawił się token. Pojawi się tylko 1 raz.

Zaloguj się jako administrator.

Przejdź do Konfiguracja -> Odznaki SVG

Skopiuj ten token do pola „Token odznaki aktywności” i kliknij przycisk Zapisz.

Przejdź do Administracja -> Bezpieczeństwo -> Szablony uprawnień -> Szablon domyślny (i inne szablony, które będziesz mieć).

Użytkownik identyfikatorów musi mieć zaznaczone pole wyboru „Przeglądaj”.

Testowanie

Weźmy na przykład projekt https://github.com/jitpack/maven-simple.

Zaimportujmy ten projekt.

Dodaj plik .gitlab-ci.yml do katalogu głównego projektu z następującą zawartością.

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

W SonarQube projekt będzie wyglądał następująco:

Dodaj torby do README.md i będą wyglądać tak:

Kod wyświetlania plakietek wygląda następująco:

Analizowanie ciągu wyświetlania identyfikatorów:

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

Gdzie zdobyć/sprawdzić klucz projektu i identyfikator projektu.

Klucz projektu znajduje się w prawym dolnym rogu. Adres URL zawiera identyfikator projektu.

Opcje uzyskiwania metryk mogą być spójrz tutaj.

Wszystkie żądania ściągnięcia dotyczące ulepszeń, poprawek błędów przesłać do tego repozytorium.

Czat telegramowy na temat SonarQube https://t.me/sonarqube_ru
Czat telegramowy na temat DevSecOps - bezpieczny DevOps https://t.me/sec_devops

Źródło: www.habr.com

Wyświetlanie programistom stanu kontroli jakości kodu źródłowego w SonarQube

Instalowanie SonarQube

Uruchomienie skryptu sprawdzającego stan kontroli jakości kodu źródłowego w SonarQube.

Wyświetlanie stanu kontroli jakości kodu źródłowego na stronie głównej projektu

Dodaj komentarz Anuluj odpowiedź