Yn dangos statws rheoli ansawdd cod ffynhonnell yn SonarQube i ddatblygwyr

Mae SonarQube yn blatfform sicrhau ansawdd cod ffynhonnell agored sy'n cefnogi ystod eang o ieithoedd rhaglennu ac yn adrodd ar fetrigau megis dyblygu cod, cydymffurfio â safonau codio, cwmpas prawf, cymhlethdod cod, chwilod posibl, a mwy. Mae SonarQube yn delweddu canlyniadau dadansoddi yn gyfleus ac yn caniatáu ichi olrhain deinameg datblygiad prosiect dros amser.

Amcan: Dangoswch i ddatblygwyr statws rheoli ansawdd cod ffynhonnell yn SonarQube.

Mae dau ateb:

• Rhedeg sgript i wirio statws rheoli ansawdd y cod ffynhonnell yn SonarQube. Os nad yw rheolaeth ansawdd y cod ffynhonnell yn SonarQube yn pasio, yna methu'r cynulliad.
• Dangos statws rheoli ansawdd cod ffynhonnell ar brif dudalen y prosiect.

Gosod SonarQube

I osod sonarqube o becynnau rpm, byddwn yn defnyddio'r ystorfa https://harbottle.gitlab.io/harbottle-main.

Gadewch i ni osod y pecyn ystorfa ar gyfer CentOS 7.

yum install -y https://harbottle.gitlab.io/harbottle-main/7/x86_64/harbottle-main-release.rpm

Rydym yn gosod sonarqube ei hun.

yum install -y sonarqube

Yn ystod y gosodiad, bydd y rhan fwyaf o ategion yn cael eu gosod, ond mae angen i chi osod findbugs a pmd

yum install -y sonarqube-findbugs sonarqube-pmd

Lansiwch y gwasanaeth a'i ychwanegu at gychwyn

systemctl start sonarqube
systemctl enable sonarqube

Os yw'n cymryd amser hir i'w lwytho, yna ychwanegwch gynhyrchydd rhif ar hap /dev/./urandom i ddiwedd yr opsiynau sonar.web.javaOpts

sonar.web.javaOpts=другие параметры -Djava.security.egd=file:/dev/urandom

Rhedeg sgript i wirio statws rheoli ansawdd cod ffynhonnell yn SonarQube.

Yn anffodus, nid yw'r ategyn sonar-break-maven-plugin wedi'i ddiweddaru ers amser maith. Felly gadewch i ni ysgrifennu ein sgript ein hunain.

Ar gyfer profi byddwn yn defnyddio'r ystorfa https://github.com/uweplonus/spotbugs-examples.

Mewnforio i Gitlab. Ychwanegu'r ffeil .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

Nid yw'r ffeil .gitlab-ci.yml yn berffaith. Wedi'i brofi a oedd tasgau sganio yn sonarqube yn dod i ben gyda'r statws: "LLWYDDIANT". Hyd yn hyn ni fu unrhyw statws arall. Cyn gynted ag y bydd statws arall, byddaf yn cywiro .gitlab-ci.yml yn y post hwn.

Yn dangos statws rheoli ansawdd y cod ffynhonnell ar brif dudalen y prosiect

Gosod yr ategyn ar gyfer SonarQube

yum install -y sonarqube-qualinsight-badges

Rydym yn mynd i SonarQube yn http://172.26.9.115:9000/
Creu defnyddiwr rheolaidd, er enghraifft "bathodynnau".
Mewngofnodwch i SonarQube o dan y defnyddiwr hwn.

Ewch i “Fy nghyfrif”, crëwch docyn newydd, er enghraifft gyda'r enw “read_all_repository” a chliciwch ar “Cynhyrchu”.

Gwelwn fod tocyn wedi ymddangos. Dim ond 1 tro y bydd yn ymddangos.

Mewngofnodi fel gweinyddwr.

Ewch i Ffurfweddu -> Bathodynnau SVG

Copïwch y tocyn hwn i'r maes "Tocyn bathodyn gweithgaredd" a chliciwch ar y botwm arbed.

Ewch i Weinyddiaeth -> Diogelwch -> Templedi Caniatâd -> Templed diofyn (a thempledi eraill a fydd gennych).

Rhaid i'r blwch ticio "Pori" wirio'r defnyddiwr bathodynnau.

Profi.

Er enghraifft, gadewch i ni gymryd y prosiect https://github.com/jitpack/maven-simple.

Gadewch i ni fewnforio'r prosiect hwn.

Ychwanegwch y ffeil .gitlab-ci.yml at wraidd y prosiect gyda'r cynnwys canlynol.

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

Yn SonarQube bydd y prosiect yn edrych fel hyn:

Ychwanegwch fagiau i README.md a byddant yn edrych fel hyn:

Mae'r cod arddangos bathodynnau yn edrych fel hyn:

Wrth dosrannu'r llinyn arddangos bathodynnau:

[![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-проекта)

Ble i gael/gwirio Allwedd y Prosiect ac ID y Prosiect.

Mae Allwedd y Prosiect ar y gwaelod ar y dde. Mae'r URL yn cynnwys id y prosiect.

Gall opsiynau ar gyfer cael metrigau fod edrychwch yma.

Pob cais tynnu am welliannau, trwsio bygiau ymostwng i'r gadwrfa hon.

Sgwrs Telegram am SonarQube https://t.me/sonarqube_ru
Sgwrs Telegram am DevSecOps - DevOps diogel https://t.me/sec_devops

Ffynhonnell: hab.com