仓库设置

添加choerodon chart仓库并同步

helm repo add c7n https://openchart.choerodon.com.cn/choerodon/c7n/
helm repo update

部署SonarQube

 注意：本事例中 PostgreSql 数据库搭建仅为快速体验 SonarQube 而编写，由于使用了NFS存储故并不能保证其稳定运行或数据不丢失，您可以参照 PostgreSql 官网进行搭建。

helm upgrade --install sonarqube c7n/sonarqube \
    --set persistence.enabled=true \
    --set persistence.storageClass=nfs-provisioner \
    --set postgresql.persistence.storageClass=nfs-provisioner \
    --set ingress.enabled=true \
    --set ingress.'hosts[0]'=sonarqube.example.choerodon.io \
    --set plugins.'install[0]'=https://file.choerodon.com.cn/choerodon-install/sonarqube/sonar-auth-choerodonoauth-plugin-1.5.3.RELEASE.jar \
    --create-namespace \
    --version 0.15.0-3 \
    --namespace c7n-system

• 更多参数及含义请参考SonarQube Chart

安装SoanrQube插件

• 此步骤用于之前已经安装过SonarQube，只需安装插件的情况（如已经执行过上一步可跳过此步骤）
• 进入SonarQube安装目录，下载https://file.choerodon.com.cn/choerodon-install/sonarqube/sonar-auth-choerodonoauth-plugin-1.5.3.RELEASE.jar 插件到\data\sonarqube\extensions\plugins目录
• 重启SoanrQube服务

验证部署

• 访问设置的SonarQube域名出现以下界面即部署成功

  

配置 Choerodon 认证

• 以下操作须将Choerodon搭建完成后再继续进行，若未搭建，请跳过。

添加Choerodon Client

• 编写参数配置文件 sonarqube-client.yaml

  env:
    MYSQL_HOST: c7n-mysql.c7n-system.svc
    MYSQL_PASS: password
    MYSQL_PORT: 3306
    MYSQL_USER: root
    SQL_SCRIPT: |
      INSERT INTO hzero_platform.oauth_client (name,organization_id,resource_ids,secret,scope,authorized_grant_types,web_server_redirect_uri,access_token_validity,refresh_token_validity,additional_information,auto_approve,object_version_number,created_by,creation_date,last_updated_by,last_update_date,enabled_flag,time_zone)VALUES('sonar',1,'default','sonarsonar','default','password,implicit,client_credentials,authorization_code,refresh_token','http://sonarqube.example.choerodon.io/oauth2/callback/choerodon',3600,3600,'{}','default',1,0,NOW(),0,NOW(),1,'GMT+8');
  

• 部署服务

  helm upgrade --install sonarqube-client c7n/mysql-client \
      -f sonarqube-client.yaml \
      --version 0.1.0 \
      --create-namespace \
      --namespace c7n-system
  

配置用户权限

 默认管理员用户名：admin，密码：admin

• 使用管理员用户登录 SoanrQube

• 配置默认新建项目为Private, 进入 Administration -> Projects -> Management 

• 更改默认权限模板, 进入 Administration -> Security -> Permission Templates ,去掉 sonar-users 用户组所有权限  

配置认证插件

• 使用管理员用户登录 SoanrQube
• 进入 Administration -> Configuration ->choerodon
• 更改 Enabled 为启用

• 更改 Choerodon url 为当前使用的 choerodon api getaway 地址；默认地址为：http://api.example.choerodon.io 

• 更改 sonar url 为当前使用的SonarQube实际地址

• 退出登录，测试使用choerodon登录,出现如下界面 

• Choerodon权限与SonarQube权限为lazy分配，对于用户登录后在SonarQube没有权限的应用服务，从Choerodon代码质量详情界面，跳转登录到SonarQube即可。

Choerodon应用关联SonarQube项目

• 部署devops-service时添加SonarQube环境变量

  SERVICES_SONARQUBE_URL: http://sonarqube.example.choerodon.io
  SERVICES_SONARQUBE_USERNAME: admin
  SERVICES_SONARQUBE_PASSWORD: admin
  

• Choerodon 应用关联 SonarQube 针对 maven 和非 maven 项目有不同的配置。

  • 如果是 maven 项目可以在 .gitlab-ci.yml 文件 build 阶段添加

  - >-
      mvn --batch-mode  verify sonar:sonar
      -Dsonar.host.url=$SONAR_URL -Dsonar.login=$SONAR_LOGIN
      -Dsonar.gitlab.project_id=$CI_PROJECT_PATH
      -Dsonar.gitlab.commit_sha=$CI_COMMIT_SHA
      -Dsonar.gitlab.ref_name=$CI_COMMIT_REF_NAME
      -Dsonar.analysis.serviceGroup=$GROUP_NAME
      -Dsonar.analysis.commitId=$CI_COMMIT_SHA
      -Dsonar.projectKey=${GROUP_NAME}:${PROJECT_NAME}
  

  • 其他项目可以使用 sonar-scanner，在 .gitlab-ci.yml 文件 build 阶段添加

     请确保 cibase 的镜像版本大于等于 0.10.0

  - >-
      sonar-scanner -Dsonar.host.url=$SONAR_URL -Dsonar.login=$SONAR_LOGIN
      -Dsonar.gitlab.project_id=$CI_PROJECT_PATH
      -Dsonar.gitlab.commit_sha=$CI_COMMIT_SHA
      -Dsonar.gitlab.ref_name=$CI_COMMIT_REF_NAME
      -Dsonar.analysis.serviceGroup=$GROUP_NAME
      -Dsonar.analysis.commitId=$CI_COMMIT_SHA
      -Dsonar.projectKey=${GROUP_NAME}:${PROJECT_NAME}
      -Dsonar.sources=.
  

• sonar.projectKey=${GROUP_NAME}:${PROJECT_NAME}不可更改；否则，在查看代码质量时将获取不到对应数据

• sonar.sources 指定扫描代码的路径

• GROUP_NAME和PROJECT_NAME是devops-service内置的环境变量， GROUP_NAME=当前项目所在组织编码-当前项目编码，PROJECT_NAME=当前应用编码

• 如果手动创建SonarQube项目(不通过.gitlab-ci.yml创建)，项目命名规则为：当前项目所在组织编码-当前项目编码:当前应用编码

SonarQube 涵盖27种编程语言，同时与您现有的软件管道配对，可为开发人员提供清晰的补救指南，以帮助他们理解和解决问题，并为整个团队提供更好，更安全的软件。SonarQube拥有170,000多个部署，可帮助小型开发团队和全球组织，为全球所有团队和公司提供并拥有并影响其代码质量和安全性的手段。

主要重点是制造具有影响力并受到用户喜爱的优质产品。

早在2007年，当第一行代码创建时，SonarQube（最初称为Sonar）的创始人就梦想着有一天能够为每个开发人员提供衡量其项目代码质量的能力。他们的座右铭是：“持续检查必须成为持续集成的主流”。

连续检查

SonarQube支持连续检查实践。

在构建SonarQube平台时，我们从一开始就考虑了持续检查。因此，它附带了支持该实践所需的一切，质量门，泄漏管理，分支分析，并行报告处理，治理功能，高可用性，较短的反馈循环等。

质量门

SonarQube提供了GO / NO-GO门以促进应用程序推广。

质量门是SonarQube的一个重要的开箱即用功能。它提供了在每次分析时知道应用程序是否通过或未通过发布标准的能力。换句话说，它在每次分析时都告诉您应用程序是否“按质量”准备好进行生产。

多语言

我们的解决方案涵盖27种以上的编程语言。

通过提供对多种语言的支持，包括Java，C＃，C / C ++，T-SQL，TypeScript，JavaScript和COBOL，SonarQube提供了一个涵盖大量应用程序的独特解决方案。

插件库

SonarQube体验可以通过插件来增强。

SonarQube提供了60多个社区和商业插件，可轻松使用其他语言，指标和页面来增强您的体验。还可以开发插件来满足组织内的特定需求。

优点

我们为整个开发组织增值。

无论您在开发组织中的角色如何，SonarSource解决方案都可以增加价值，因为我们拥有您需要的最先进功能，以最大限度地提高质量并管理软件产品组合中的风险。

对于开发人员

软件开发人员最终对代码质量负责。

代码质量是所谓的非功能性需求的一部分，因此是开发人员的直接责任。因为代码质量不应该推迟到以后，所以我们的解决方案在开发过程的每个步骤（从IDE到发行版）（包括任何中间促销活动）中都提供反馈。

这使开发人员可以就代码质量做出早期且受过良好教育的决策，使他们能够做得更好，并交付更好的软件。

用于DevOps

DevOps团队需要确保正确构建软件。

DevOps团队负有许多责任。其中包括支持开发过程，自动化测试，确保质量，提高生产率……并最终实现持续部署。良好的代码质量是实现所有这些目标的必要条件，尽管还不够。我们的解决方案提供了可在任何构建/测试/部署步骤中添加的代码质量收费门。

这使devOps团队可以自动执行一组质量标准，从而确保组织交付更好的软件。

对于高管

SonarSource解决方案可降低风险并提高团队生产力。

管理人员需要能够安全地操作软件，并且其成本能够证明投资回报是合理的。我们的解决方案使高管一目了然，他们面临的运营风险以及缓解风险的成本。它也具有开箱即用的功能，可以系统地提高可维护性，从而提高开发团队的长期生产力。

这使高管可以使用风险控制方法以最佳成本确保其组织交付更好的软件。