pjthomso/concourse-sonarqube-resource

Concourse CI的SonarQube资源

该资源用于在Concourse CI中执行SonarQube代码质量分析，并跟踪SonarQube质量门状态。支持SonarCloud和自托管的SonarQube实例，若需实现严格质量控制，可结合concourse-sonarqube-qualitygate-task使用，当质量目标未达成时中断构建。

安装

在Concourse CI pipeline中添加资源类型：

yaml
resource_types:
- name: sonar-runner
  type: docker-image
  source:
    repository: pjthomso/concourse-sonarqube-resource
    tag: latest # 建议使用特定版本标签以确保构建可重现

源配置

• host_url: 必选。SonarQube实例地址（如SonarCloud为"[***]"），需以斜杠结尾。
• organization: SonarCloud专用，必选，指定分析所属组织。
• login: SonarQube用户的登录名或认证令牌，需具备执行分析权限（无需认证时留空）。
• password: 与login对应的密码（使用令牌时留空）。
• maven_settings: Maven配置，仅在扫描类型为Maven时生效。
• __debug: 调试开关，开启后输出详细日志（生产环境不建议启用，避免泄露敏感信息）。

核心功能

1. 多场景支持: 兼容SonarCloud和自托管SonarQube实例。
2. 灵活扫描: 支持自动检测（Maven/CLI）、CLI和Maven三种扫描类型。
3. 分支管理: 自动检测Git分支或手动指定分支名称、目标分支。
4. 结果输出: 生成质量门状态和计算引擎任务信息的JSON文件，便于后续质量检查。

使用场景

• 集成到CI/CD流程中，对代码进行静态质量分析。
• 通过质量门控制构建流程，确保代码符合预设质量标准。
• 跟踪不同分支的代码质量变化，助力持续改进。

行为说明

out动作：触发分析

参数包括project_path（必选，待分析路径）、scanner_type（扫描类型）、project_key（项目键）等，支持传递额外属性（如覆盖率报告路径）。

in动作：获取结果

生成两个JSON文件：

• qualitygate_project_status.json: 质量门状态（格式参考SonarQube API）。
• ce_task_info.json: 分析任务详情（格式参考SonarQube API）。

完整Pipeline示例

yaml
resource_types:
- name: sonar-runner
  type: docker-image
  source:
    repository: pjthomso/concourse-sonarqube-resource
    tag: latest

resources:
- name: sources
  type: git
  source:
    uri: https://github.com/example/example.git
- name: artifact
  type: s3
  # 省略S3配置
- name: code-analysis
  type: sonar-runner
  source:
    host_url: [***]
    login: ((sonarqube-auth-token))
    project_key: com.example.my_project

jobs:
- name: build-and-analyze
  plan:
  - get: sources
    trigger: true
  - task: build
    config:
      platform: linux
      image_resource:
        type: docker-image
        source: {repository: debian, tag: 'jessie'}
      inputs: [name: sources]
      outputs: [name: sonarqube-analysis-input]
      run: {path: build.sh, dir: sources}
  - aggregate:
    - put: code-analysis
      params:
        project_path: sonarqube-analysis-input
        additional_properties: {sonar.javascript.lcov.reportPaths: coverage/lcov.info}
    - put: artifact

- name: qualitygate
  plan:
  - aggregate:
    - get: artifact
      passed: [build-and-analyze]
    - get: code-analysis
      passed: [build-and-analyze]
      trigger: true
  - task: check-quality-gate
    config:
      platform: linux
      image_resource:
        type: docker-image
        source: {repository: cathive/concourse-sonarqube-qualitygate-task, tag: latest}
      inputs: [name: code-analysis]
      run: {path: /sonarqube-qualitygate-check, dir: code-analysis}

- name: deploy
  plan:
  - get: artifact
    passed: [qualitygate]