🥇 سونار ڪيوب ۾ ڊولپرز کي سورس ڪوڊ ڪوالٽي ڪنٽرول اسٽيٽس ڏيکارڻ

SonarQube هڪ اوپن سورس ڪوڊ معيار جي يقين ڏياريندڙ پليٽ فارم آهي جيڪو پروگرامنگ ٻولين جي وسيع رينج کي سپورٽ ڪري ٿو ۽ ميٽرڪ تي رپورٽنگ مهيا ڪري ٿو جهڙوڪ ڪوڊ نقل، ڪوڊنگ معيار جي تعميل، ٽيسٽ ڪوريج، ڪوڊ پيچيدگي، امڪاني بگ، ۽ وڌيڪ. SonarQube آسانيءَ سان تجزيو جا نتيجا ڏسي ٿو ۽ توھان کي اجازت ڏئي ٿو ته توھان کي وقت سان گڏ پروجيڪٽ جي ترقيءَ جي حرڪيات کي ٽريڪ ڪرڻ جي.

مقصد: ڊولپرز کي ڏيکاريو سورس ڪوڊ ڪيفيت ڪنٽرول جي حالت سونار ڪوب ۾.

اتي ٻه حل آهن:

SonarQube ۾ سورس ڪوڊ جي ڪيفيت ڪنٽرول اسٽيٽس چيڪ ڪرڻ لاءِ اسڪرپٽ هلايو. جيڪڏهن SonarQube ۾ سورس ڪوڊ جو معيار ڪنٽرول پاس نه ٿيو، پوء اسيمبلي کي ناڪام ڪريو.
ڏيکاريو ماخذ ڪوڊ معيار ڪنٽرول اسٽيٽس مين پروجيڪٽ صفحي تي.

SonarQube انسٽال ڪرڻ

rpm پيڪيجز مان سونارڪوب کي انسٽال ڪرڻ لاءِ، اسان استعمال ڪنداسين مخزن 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

انسٽاليشن دوران، گھڻا پلگ ان انسٽال ڪيا ويندا، پر توھان کي انسٽال ڪرڻو پوندو 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 ۾ سورس ڪوڊ جي ڪيفيت ڪنٽرول جي صورتحال کي جانچڻ لاءِ اسڪرپٽ هلائڻ.

بدقسمتي سان، سونار-برڪ-ماوين-پلگ ان پلگ ان کي گهڻي وقت تائين اپڊيٽ نه ڪيو ويو آهي. سو اچو ته پنهنجو اسڪرپٽ لکون.

جاچ لاءِ اسان استعمال ڪنداسين مخزن 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 فائل مڪمل نه آهي. ٽيسٽ ڪيو ويو ته سونارڪوب ۾ اسڪيننگ جا ڪم اسٽيٽس سان ختم ٿي ويا: ”ڪاميابي“. هينئر تائين ڪا به ٻي حيثيت نه آهي. جيترو جلد ٻيون حالتون آهن، آئون هن پوسٽ ۾ .gitlab-ci.yml کي درست ڪندس.

مکيه پروجيڪٽ جي صفحي تي ماخذ ڪوڊ جي معيار جي ڪنٽرول جي حالت ڏيکاريندي

SonarQube لاءِ پلگ ان انسٽال ڪرڻ

yum install -y sonarqube-qualinsight-badges

اسان سونار ڪوب تي وڃون ٿا 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-проекта)

پروجيڪٽ ڪي ۽ پروجيڪٽ آئي ڊي ڪٿي حاصل ڪرڻ/پڙهڻ لاءِ.

پروجيڪٽ جي ڪني هيٺان ساڄي پاسي آهي. URL ۾ پروجيڪٽ جي سڃاڻپ شامل آهي.