🥇在SonarQube中向開發者展示原始碼品質控制狀態 |專業主機

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

我們安裝 sonarqube 本身。

yum install -y sonarqube

安裝過程中，大部分插件都會安裝，但需要安裝findbugs和pmd

yum install -y sonarqube-findbugs sonarqube-pmd

啟動服務並將其新增至啟動項

systemctl start sonarqube
systemctl enable sonarqube

如果載入時間較長，則在選項 sonar.web.javaOpts 的末端新增隨機數產生器 /dev/./urandom

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 檔案並不完美。測試 sonarqube 中的掃描任務是否以狀態「SUCCESS」結束。到目前為止，還沒有其他狀態。一旦有其他狀態，我將在這篇文章中更正 .gitlab-ci.yml 。

在專案主頁面顯示原始程式碼品質控制狀態

安裝 SonarQube 插件

yum install -y sonarqube-qualinsight-badges

我們去 SonarQube http://172.26.9.115:9000/
建立一個普通用戶，例如“badges”。
使用該用戶登入 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-проекта)

在哪裡取得/檢查項目金鑰和項目 ID。

項目密鑰位於右下角。 URL 包含項目 ID。

取得指標的選項可以是看這裡.

所有改進、錯誤修復的拉取請求提交到此存儲庫.

關於 SonarQube 的 Telegram 聊天 https://t.me/sonarqube_ru
關於 DevSecOps 的 Telegram 聊天 - 安全 DevOps https://t.me/sec_devops

來源： www.habr.com

在 SonarQube 中向開發人員顯示原始程式碼品質控制狀態

安裝 SonarQube

執行腳本來檢查 SonarQube 中原始程式碼品質控制的狀態。

在專案主頁面顯示原始程式碼品質控制狀態

添加評論取消回复

在 SonarQube 中向開發人員顯示原始程式碼品質控制狀態

安裝 SonarQube

執行腳本來檢查 SonarQube 中原始程式碼品質控制的狀態。

在專案主頁面顯示原始程式碼品質控制狀態

添加評論 取消回复

添加評論取消回复