🥇SonarQube |-ko garatzaileei iturburu kodearen kalitate-kontrolaren egoera bistaratzea ProHoster

SonarQube kode irekiko kalitatea bermatzeko plataforma bat da, programazio-lengoaia ugari onartzen dituena eta kodeen bikoizketa, kodeketa estandarrak betetzea, proben estaldura, kodearen konplexutasuna, akats potentzialak eta abar bezalako neurrien berri ematen duena. SonarQube-k analisiaren emaitzak eroso ikusten ditu eta denboran zehar proiektuaren garapenaren dinamika jarraitzeko aukera ematen du.

Helburua: Erakutsi garatzaileei SonarQube-n iturburu-kodearen kalitate-kontrolaren egoera.

Bi irtenbide daude:

Exekutatu script bat SonarQube-n iturburu kodearen kalitate-kontrolaren egoera egiaztatzeko. SonarQube-n iturburu-kodearen kalitate-kontrola pasatzen ez bada, huts egin du muntaia.
Erakutsi iturburu-kodearen kalitate-kontrolaren egoera proiektuaren orrialde nagusian.

SonarQube instalatzen

rpm paketeetatik sonarqube instalatzeko, biltegia erabiliko dugu https://harbottle.gitlab.io/harbottle-main.

Instala dezagun paketea CentOS 7rako biltegiarekin.

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

Sonarqube bera instalatzen dugu.

yum install -y sonarqube

Instalazioan, plugin gehienak instalatuko dira, baina findbugs eta pmd instalatu behar dituzu

yum install -y sonarqube-findbugs sonarqube-pmd

Abiarazi zerbitzua eta gehitu abiarazteko

systemctl start sonarqube
systemctl enable sonarqube

Kargatzeko denbora luzea behar bada, gehitu ausazko zenbaki-sorgailu bat /dev/./urandom aukeren amaieran sonar.web.javaOpts

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

SonarQube-n iturburu-kodearen kalitate-kontrolaren egoera egiaztatzeko script bat exekutatzen.

Zoritxarrez, sonar-break-maven-plugin plugina ez da denbora luzez eguneratu. Beraz, idatzi dezagun gure gidoia.

Probak egiteko biltegia erabiliko dugu https://github.com/uweplonus/spotbugs-examples.

Gitlab-era inportatzen. Gehitu .gitlab-ci.yml fitxategia:

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 fitxategia ez da perfektua. Sonarqube-n eskaneatze-zereginak egoerarekin amaitzen diren ala ez probatu da: "ARRAKATA". Orain arte ez da beste estatusik egon. Beste egoera batzuk egon bezain laster, .gitlab-ci.yml zuzenduko dut mezu honetan.

Iturburu-kodearen kalitate-kontrolaren egoera proiektuaren orrialde nagusian bistaratzea

SonarQuberako plugina instalatzen

yum install -y sonarqube-qualinsight-badges

SonarQube-ra goaz http://172.26.9.115:9000/
Sortu ohiko erabiltzaile bat, adibidez, "txapak".
Hasi saioa SonarQube-n erabiltzaile honen azpian.

Joan “Nire kontua”, sortu token berri bat, adibidez “read_all_repository” izenarekin eta egin klik “Generate”.

Token bat agertu dela ikusten dugu. Behin bakarrik agertuko da.

Hasi saioa administratzaile gisa.

Joan Konfigurazioa -> SVG txapak

Kopiatu token hau "Jardueraren bereizgarriaren tokena" eremuan eta egin klik gorde botoian.

Joan Administrazioa -> Segurtasuna -> Baimen txantiloiak -> Txantiloi lehenetsia (eta izango dituzun beste txantiloi batzuk).

Txapa erabiltzaileak "Arakatu" kontrol-laukia markatuta izan behar du.

Entseguak.

Adibidez, har dezagun proiektua https://github.com/jitpack/maven-simple.

Inporta dezagun proiektu hau.

Gehitu .gitlab-ci.yml fitxategia proiektuaren errora hurrengo edukiarekin.

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-n proiektua honela izango da:

Gehitu maletak README.md-era eta itxura hau izango dute:

Txapak bistaratzeko kodea honelakoa da:

Txapak bistaratzeko katea analizatzen:

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

Non eskuratu / egiaztatu Proiektuaren gakoa eta proiektuaren IDa.

Proiektuaren gakoa beheko eskuinaldean dago. URLak proiektuaren IDa dauka.