წყარო კოდის ხარისხის კონტროლის სტატუსის ჩვენება 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

თუ ჩატვირთვას დიდი დრო დასჭირდება, მაშინ დაამატეთ შემთხვევითი რიცხვების გენერატორი /dev/./urandom sonar.web.javaOpts ოფციების ბოლოს.

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" და დააწკაპუნეთ "Genereate".

ჩვენ ვხედავთ, რომ გამოჩნდა ნიშანი. ის მხოლოდ 1-ჯერ გამოჩნდება.

შედით როგორც ადმინისტრატორი.

გადადით კონფიგურაცია -> SVG სამკერდე ნიშნები

დააკოპირეთ ეს ჟეტონი "აქტივობის ბეჯის ნიშნის" ველში და დააჭირეთ შენახვის ღილაკს.

გადადით ადმინისტრაცია -> უსაფრთხოება -> ნებართვის შაბლონები -> ნაგულისხმევი შაბლონი (და სხვა შაბლონები, რომლებიც გექნებათ).

ბეჯების მომხმარებელს უნდა ჰქონდეს მონიშნული ველი "Browse".

ტესტირება

მაგალითად, ავიღოთ პროექტი https://github.com/jitpack/maven-simple.

მოდით შემოვიტანოთ ეს პროექტი.

დაამატეთ .gitlab-ci.yml ფაილი პროექტის root-ში შემდეგი შინაარსით.

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.

Project Key არის ქვედა მარჯვენა კუთხეში. URL შეიცავს პროექტის ID-ს.

მეტრიკის მიღების ვარიანტები შეიძლება იყოს შეხედე აქ.

ყველა მოთხოვნა გაუმჯობესების, შეცდომების გამოსწორების შესახებ გაგზავნეთ ამ საცავში.

ტელეგრამის ჩატი SonarQube-ის შესახებ https://t.me/sonarqube_ru
Telegram ჩატი DevSecOps-ის შესახებ - უსაფრთხო DevOps https://t.me/sec_devops

წყარო: www.habr.com