🥇SonarQube のソースコードの品質管理ステータスを開発者に表示

SonarQube は、幅広いプログラミング言語をサポートし、コードの重複、コーディング標準への準拠、テストカバレッジ、コードの複雑さ、潜在的なバグなどの指標に関するレポートを提供するオープンソースコード品質保証プラットフォームです。 SonarQube は分析結果を簡単に視覚化し、プロジェクト開発のダイナミクスを長期にわたって追跡できるようにします。

目的: SonarQube のソースコード品質管理のステータスを開発者に示します。

解決策は XNUMX つあります。

スクリプトを実行して、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/
「バッジ」などの通常のユーザーを作成します。
このユーザーで 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 に関する電報チャット https://t.me/sonarqube_ru
DevSecOps についての Telegram チャット - 安全な DevOps https://t.me/sec_devops

出所： habr.com

SonarQube のソースコードの品質管理ステータスを開発者に表示する

SonarQube のインストール

SonarQube でのソースコードの品質管理のステータスをチェックするスクリプトを実行します。

メインプロジェクトページにソースコードの品質管理ステータスを表示する

コメントを追加します返信をキャンセル

SonarQube のソース コードの品質管理ステータスを開発者に表示する

SonarQube のインストール

SonarQube でのソース コードの品質管理のステータスをチェックするスクリプトを実行します。

メインプロジェクトページにソースコードの品質管理ステータスを表示する

コメントを追加します 返信をキャンセル

SonarQube のソースコードの品質管理ステータスを開発者に表示する

SonarQube でのソースコードの品質管理のステータスをチェックするスクリプトを実行します。

コメントを追加します返信をキャンセル