🥇在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

来源： habr.com

在 SonarQube 中向开发人员显示源代码质量控制状态

安装 SonarQube

运行脚本来检查 SonarQube 中源代码质量控制的状态。

在项目主页面显示源代码质量控制状态

添加评论取消回复

在 SonarQube 中向开发人员显示源代码质量控制状态

安装 SonarQube

运行脚本来检查 SonarQube 中源代码质量控制的状态。

在项目主页面显示源代码质量控制状态

添加评论 取消回复

添加评论取消回复