roiback/gitlab-ci-sonarqube

gitlab-ci-sonarqube

概述

gitlab-ci-sonarqube是一个集成了https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner%E3%80%81https://github.com/gabrie-allaigre/sonar-gitlab-plugin%E5%92%8Chttps://github.com/gabrie-allaigre/sonar-gate-breaker%E7%9A%84Docker%E9%95%9C%E5%83%8F%E3%80%82%E5%85%B6%E4%B8%BB%E8%A6%81%E7%94%A8%E9%80%94%E6%98%AF%E5%B0%86SonarQube%E8%B4%A8%E9%87%8F%E9%97%A8%E4%B8%8EGitlab CI流程集成，实现当代码未通过SonarQube质量门时自动中断Gitlab CI流水线。该镜像已在Sonarqube 7.3和Gitlab 11.3.5环境中测试通过。

核心功能和特性

• 多工具集成：整合sonnar-scanner进行代码质量分析、sonar-gitlab-plugin实现GitLab内联注释、sonar-gate-breaker检查质量门状态
• 质量门控制：当代码未通过SonarQube质量门时，自动以非零状态退出，中断Gitlab CI流水线
• 双模式扫描：支持预览模式（sonar-scanner-preview）和正式模式（sonar-scanner）
  • 预览模式：仅生成分析结果并在GitLab提交中添加内联注释，不向SonarQube服务器发布结果
  • 正式模式：向SonarQube服务器发布分析结果，并检查质量门状态
• GitLab CI适配：可直接集成到GitLab CI流程中，通过环境变量配置关键参数

使用场景和适用范围

适用于需要在GitLab CI/CD流程中集成SonarQube代码质量检查的项目，特别适合以下场景：

• 希望在代码合并前强制通过SonarQube质量门的开发团队
• 需要在GitLab界面直接查看代码质量问题内联注释的项目
• 希望自动化控制代码质量标准，避免低质量代码进入主分支的场景

使用方法和配置说明

1. SonarQube服务器配置

首先需在SonarQube服务器中安装并配置sonar-gitlab-plugin：

1. 参考https://github.com/gabrie-allaigre/sonar-gitlab-plugin%E4%B8%8B%E8%BD%BD%E6%8F%92%E4%BB%B6
2. 将插件安装到SonarQube服务器的extensions/plugins目录
3. 重启SonarQube服务器
4. 按照插件文档完成必要的配置（如GitLab访问令牌等）

2. 项目配置

2.1 项目根目录添加配置文件

与标准sonnar-scanner使用方式相同，需在项目根目录创建sonar.properties文件，配置项目基本信息（如项目密钥、源代码目录等）。示例配置：

properties
sonar.projectKey=my-project-key
sonar.projectName=My Project
sonar.projectVersion=1.0
sonar.sources=src/
sonar.java.binaries=target/classes

2.2 GitLab CI配置

在项目的.gitlab-ci.yml文件中添加质量检查作业，示例如下：

yaml
quality:
  image: roiback/gitlab-ci-sonarqube
  stage: test
  variables:
    SONAR_URL: "https://your-sonarqube-server-url"  # SonarQube服务器URL
    SONAR_LOGIN: "your-sonarqube-login-token"       # SonarQube登录令牌（在SonarQube中生成）
  script:
    # 预览模式：生成内联注释，不发布结果到SonarQube
    - sonar-scanner-preview -Dsonar.projectVersion=${CI_COMMIT_SHA}  # 可添加其他sonar参数
    # 正式模式：发布结果到SonarQube并检查质量门，失败时中断流水线
    - sonar-scanner -Dsonar.projectVersion=${CI_COMMIT_SHA}  # 可添加其他sonar参数

3. 关键参数说明

• 环境变量：

  • SONAR_URL：SonarQube服务器的URL地址（必填）
  • SONAR_LOGIN：SonarQube的登录令牌（在SonarQube个人账号设置中生成，必填）

• 扫描命令：

  • sonar-scanner-preview：预览模式，仅在GitLab当前提交中生成代码质量问题的内联注释，不向SonarQube服务器发布分析结果
  • sonar-scanner：正式模式，向SonarQube服务器发布分析结果，并检查质量门状态。若质量门未通过，该命令将以非零状态退出，导致GitLab CI流水线中断

4. 命令扩展参数

可在扫描命令后添加SonarQube支持的参数，例如：

• -Dsonar.projectVersion=${CI_COMMIT_SHA}：使用Git提交SHA作为项目版本
• -Dsonar.branch.name=${CI_COMMIT_BRANCH}：指定分析的分支名称
• -Dsonar.exclusions=**/test/**：排除测试目录