پراختیا کونکو ته په سونار کیوب کې د سرچینې کوډ کیفیت کنټرول حالت ښودل

سونار کیوب د خلاصې سرچینې کوډ کیفیت تضمین پلیټ فارم دی چې د پراخه برنامې ژبې ملاتړ کوي او د میټریکونو راپور ورکول چمتو کوي لکه د کوډ نقل کول ، د کوډ کولو معیارونو اطاعت ، د ازموینې پوښښ ، د کوډ پیچلتیا ، احتمالي بګونه او نور ډیر څه. سونار کیوب په اسانۍ سره د تحلیل پایلې لیدوي او تاسو ته اجازه درکوي د وخت په تیریدو سره د پروژې پراختیا متحرکات تعقیب کړئ.

هدف: پراختیا کونکو ته په سونار کیوب کې د سرچینې کوډ کیفیت کنټرول حالت وښایاست.

دوه حلونه شتون لري:

• په سونار کیوب کې د سرچینې کوډ کیفیت کنټرول حالت چیک کولو لپاره سکریپټ چل کړئ. که په سونار کیوب کې د سرچینې کوډ کیفیت کنټرول نه تیریږي ، نو مجلس ناکام کړئ.
• د اصلي پروژې په پاڼه کې د سرچینې کوډ کیفیت کنټرول حالت وښایاست.

د سونار کیوب نصب کول

د 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

موږ پخپله سونارکوب نصب کوو.

yum install -y sonarqube

د نصبولو په جریان کې، ډیری پلگ ان به نصب شي، مګر تاسو اړتیا لرئ چې د موندلو بګ او 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

په سونار کیوب کې د سرچینې کوډ کیفیت کنټرول حالت چیک کولو لپاره سکریپټ چلول.

له بده مرغه، د سونار-بریک-ماین-پلگ ان پلگ ان د اوږدې مودې لپاره تازه شوی نه دی. نو راځئ چې خپل سکریپټ ولیکو.

د ازموینې لپاره موږ به ذخیره وکاروو https://github.com/uweplonus/spotbugs-examples.

ګیټلاب ته واردول. د 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 فایل کامل ندی. ازموینه شوې که چیرې په سونارکوب کې د سکین کولو دندې د دې حالت سره پای ته ورسیږي: "بریالیتوب". تر دې دمه کوم بل دریځ نه دی څرګند شوی. هرڅومره ژر چې نور حالتونه شتون ولري ، زه به پدې پوسټ کې gitlab-ci.yml سم کړم.

د اصلي پروژې په پاڼه کې د سرچینې کوډ کیفیت کنټرول حالت ښودل

د سونار کیوب لپاره د پلگ ان نصب کول

yum install -y sonarqube-qualinsight-badges

موږ سونار کیوب ته ځو http://172.26.9.115:9000/
یو منظم کارن جوړ کړئ، د بیلګې په توګه "بیجز".
د دې کارونکي لاندې سونار کیوب ته ننوتل.

"زما حساب" ته لاړ شئ، یو نوی نښه جوړه کړئ، د بیلګې په توګه د "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

په سونار کیوب کې پروژه به داسې ښکاري:

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 لري.

د میټریکونو ترلاسه کولو اختیارونه کیدی شي دلته وګوره.

د پرمختګ لپاره ټولې پلې غوښتنې ، بګ اصلاحات دې ذخیره ته وسپاري.

د سونار کیوب په اړه د ټیلیګرام چیٹ https://t.me/sonarqube_ru
د DevSecOps په اړه د ټیلیګرام چیٹ - خوندي DevOps https://t.me/sec_devops

سرچینه: www.habr.com