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

ਅਸੀਂ ਖੁਦ ਸੋਨਾਰਕਿਊਬ ਨੂੰ ਸਥਾਪਿਤ ਕਰਦੇ ਹਾਂ।

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

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 ਫਾਈਲ ਸੰਪੂਰਨ ਨਹੀਂ ਹੈ। ਜਾਂਚ ਕੀਤੀ ਗਈ ਕਿ ਕੀ ਸੋਨਾਰਕਯੂਬ ਵਿੱਚ ਸਕੈਨਿੰਗ ਕਾਰਜ ਸਥਿਤੀ ਦੇ ਨਾਲ ਖਤਮ ਹੋਏ: "ਸਫਲਤਾ"। ਹੁਣ ਤੱਕ ਕੋਈ ਹੋਰ ਸਟੇਟਸ ਨਹੀਂ ਆਇਆ ਹੈ। ਜਿਵੇਂ ਹੀ ਹੋਰ ਸਟੇਟਸ ਹਨ, ਮੈਂ ਇਸ ਪੋਸਟ ਵਿੱਚ .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-проекта)

ਪ੍ਰੋਜੈਕਟ ਕੁੰਜੀ ਅਤੇ ਪ੍ਰੋਜੈਕਟ ਆਈਡੀ ਕਿੱਥੋਂ ਪ੍ਰਾਪਤ/ਜਾਂਚ ਕਰਨੀ ਹੈ।

ਪ੍ਰੋਜੈਕਟ ਕੁੰਜੀ ਹੇਠਾਂ ਸੱਜੇ ਪਾਸੇ ਹੈ। URL ਵਿੱਚ ਪ੍ਰੋਜੈਕਟ ਆਈ.ਡੀ. ਸ਼ਾਮਲ ਹੈ।

ਮੈਟ੍ਰਿਕਸ ਪ੍ਰਾਪਤ ਕਰਨ ਲਈ ਵਿਕਲਪ ਹੋ ਸਕਦੇ ਹਨ ਇੱਥੇ ਦੇਖੋ.

ਸੁਧਾਰਾਂ ਲਈ ਸਾਰੀਆਂ ਪੁੱਲ ਬੇਨਤੀਆਂ, ਬੱਗ ਫਿਕਸ ਇਸ ਰਿਪੋਜ਼ਟਰੀ ਨੂੰ ਜਮ੍ਹਾ ਕਰੋ.

SonarQube ਬਾਰੇ ਟੈਲੀਗ੍ਰਾਮ ਚੈਟ https://t.me/sonarqube_ru
DevSecOps ਬਾਰੇ ਟੈਲੀਗ੍ਰਾਮ ਚੈਟ - ਸੁਰੱਖਿਅਤ DevOps https://t.me/sec_devops

ਸਰੋਤ: www.habr.com