curlybracket/sonar-scanner

Sonarqube Scanner CLI 容器

镜像概述和主要用途

Sonarqube Scanner CLI容器是一个Docker镜像，专为在Jenkins等构建服务器中使用而设计，用于通过Sonarqube扫描器执行代码质量扫描。该镜像封装了Sonarqube扫描工具，可无缝集成到CI/CD流水线中，实现自动化代码质量检测。

核心功能和特性

• 提供标准命令：sonar-scanner 和 sonar-scanner-debug
• 支持Pull Request分析，可配置分支比较（需Sonarqube Developer Edition及以上版本）
• 兼容主流CI/CD工具（如Jenkins），支持通过配置文件或命令行参数进行扫描配置

使用场景和适用范围

• CI/CD流水线中的代码质量检查环节
• Pull Request验证流程，确保代码变更符合质量标准
• 自动化构建过程中的静态代码分析
• 需要在隔离环境中执行Sonarqube扫描的场景

使用方法和配置说明

PR分析使用

在CI流水线中配置以下命令，在容器内执行代码质量扫描：

bash
sonar-scanner -D sonar.host.url=<URL> \ 
              -D sonar.projectKey=<SONAR_PROJECT_KEY> \
              -D sonar.pullrequest.branch=<BRANCH_NAME> \
              -D sonar.pullrequest.key=<PR_ID> \
              -D sonar.pullrequest.base=<PR目标分支> \
              -D sonar.projectVersion=<SCM哈希/ID>

或者，使用存储在Git中的sonar-project.properties文件，通过替换令牌步骤更新URL、分支和PR详情。

注意：根据Sonarqube版本，还可配置扫描器进行分支比较，这至少需要Developer Edition。

Jenkinsfile示例

以下是可用于Jenkins流水线脚本的示例配置，使用此Docker CI镜像实现自动化测试和部署：

groovy
pipeline {
    agent { 
        docker { 
            image 'curlybracket/sonar-scanner:latest'
        }
    }
    stages {
        stage('代码质量检查') {
	
            // 使用Jenkins的配置文件提供器存储sonar详细信息（如服务器URL和项目Key）
            // 详见sonar文档
            configFileProvider([configFile(fileId: 'sonar-properties', targetLocation: 'sonar-project.properties')]) {                
                script {
                    // 配合bitbucket/stash插件使用的设置 -- 假设使用Sonar社区版（无分支支持）
                    def sonarProps = readProperties file:'sonar-project.properties'
                    sh "sonar-scanner -D sonar.projectKey=${sonarProps['sonar.projectKey']}:${BRANCH_NAME}"
                }		
            }	
            
        }
    }
}