🥇Ծրագրային կոդի որակի վերահսկման կարգավիճակի ցուցադրում 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 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-ում սկանավորման առաջադրանքները ավարտվել են «ՀԱՋՈՂՈՒԹՅՈՒՆ» կարգավիճակով: Մինչ այժմ այլ կարգավիճակներ չեն եղել։ Հենց այլ ստատուսներ լինեն, այս գրառման մեջ կուղղեմ .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-ն:

Չափանիշներ ստանալու տարբերակները կարող են լինել նայիր այստեղ.

Բարելավումների, վրիպակների շտկման բոլոր պահանջները ներկայացնել այս շտեմարան.

Telegram զրույց SonarQube-ի մասին https://t.me/sonarqube_ru
Telegram զրույց DevSecOps-ի մասին՝ անվտանգ DevOps https://t.me/sec_devops

Source: www.habr.com

Ծրագիր կոդի որակի վերահսկման կարգավիճակի ցուցադրում SonarQube-ում մշակողների համար

SonarQube-ի տեղադրում

Աշխատում է սկրիպտ՝ SonarQube-ում սկզբնական կոդի որակի վերահսկման կարգավիճակը ստուգելու համար:

Ծրագրի հիմնական էջում ելակետային կոդի որակի վերահսկման կարգավիճակի ցուցադրում

Добавить комментарий Չեղարկել պատասխանել