nosinovacao/dotnet-sonar

dotnet-sonar

镜像概述和主要用途

dotnet-sonar是一个集成开发环境容器，主要用于构建dotnet项目并通过SonarQube MSBuild Scanner进行代码质量分析。该镜像还支持通过挂载docker.sock实现Docker-in-Docker（DinD）功能，适用于需要在容器内运行Docker命令的场景。

核心功能和特性

最新镜像包含以下核心组件：

• dotnetcore-sdk 6.0.100（项目构建工具）
• dotnetcore-runtime 6.0.0（Sonar-Scanner运行依赖）
• SonarQube MSBuild Scanner 5.3.2.38712（代码质量分析工具）
• Docker binaries 20.10.x（支持Docker-in-Docker）
• OpenJDK Java Runtime 11（Sonar-Scanner及插件运行依赖）
• NodeJS 16（Sonar-Scanner Web分析插件依赖）

支持的标签和对应Dockerfile链接

标签遵循格式：dotnet-sonar:<year>.<month>.<revision>

• 21.11.3, latest https://github.com/nosinovacao/dotnet-sonar/blob/21.11.3/Dockerfile
  • DotNet 6.0.100
  • SonarScanner 5.3.2.38712
• 21.11.1 https://github.com/nosinovacao/dotnet-sonar/blob/21.11.1/Dockerfile
  • DotNet 5.0.302
  • SonarScanner 5.3.2.38712
• 21.11.0 https://github.com/nosinovacao/dotnet-sonar/blob/21.11.0/Dockerfile
  • DotNetCore 3.1.415
  • SonarScanner 5.3.2.38712
• 更多历史版本标签及Dockerfile请参见https://hub.docker.com/r/nosinovacao/dotnet-sonar/

使用场景和适用范围

• dotnet项目的构建与编译
• SonarQube代码质量分析与报告生成
• CI/CD流程集成（如Jenkins、GitLab CI等）
• 需要在容器环境中运行Docker命令的开发/测试场景
• 包含代码覆盖率分析的自动化测试流程

使用方法和配置说明

容器内直接使用

基础SonarQube分析流程

bash
# 开始SonarQube分析
dotnet /sonar-scanner/SonarScanner.MSBuild.dll begin /k:sonarProjectKey
# 构建项目
dotnet build
# 结束SonarQube分析并提交结果
dotnet /sonar-scanner/SonarScanner.MSBuild.dll end

配置外部SonarQube服务器

bash
# 开始分析，指定SonarQube服务器地址和令牌
dotnet /sonar-scanner/SonarScanner.MSBuild.dll begin /k:sonarProjectKey /d:sonar.host.url="<SonarQubeServerUrl:Port>" /d:sonar.login="<SonarQubeServerToken>"
# 构建项目
dotnet build
# 结束分析，提交结果
dotnet /sonar-scanner/SonarScanner.MSBuild.dll end /d:sonar.login="<SonarQubeServerToken>"

使用Docker命令行运行

简单使用示例

bash
docker run -it --rm -v <本地项目路径>:/source nosinovacao/dotnet-sonar:latest bash -c "cd source \
    && dotnet /sonar-scanner/SonarScanner.MSBuild.dll begin /k:sonarProjectKey /name:sonarProjectName /version:buildVersion \
    && dotnet restore \
    && dotnet build -c Release \
    && dotnet /sonar-scanner/SonarScanner.MSBuild.dll end"

高级使用示例（含测试和覆盖率分析）

bash
docker run -it --rm \
    -v <本地项目路径>:/source \
    -v <本地NuGet配置路径>:/nuget \
    nosinovacao/dotnet-sonar:latest \
    bash -c \
        "cd source \
        && dotnet /sonar-scanner/SonarScanner.MSBuild.dll begin \
        /k:<项目标识> /name:<项目名称> /version:<项目版本> \
        /d:sonar.host.url=\"<SonarQube服务器地址>\" \
        /d:sonar.login=\"<SonarQube用户名>\" \
        /d:sonar.password=\"<SonarQube密码>\" \
        /d:sonar.cs.opencover.reportsPaths='tests/**/coverage.opencover.xml' \
        && dotnet restore --configfile /nuget/NuGet.Config \
        && dotnet build -c Release \
        && dotnet publish -c Release -r linux-x64 -o deployment \
        && dotnet test --no-build -c Release --filter \"Category=Unit\" --logger trx --results-directory testResults /p:CollectCoverage=true /p:CoverletOutputFormat=\"opencover\" \
        && dotnet /sonar-scanner/SonarScanner.MSBuild.dll end \
        /d:sonar.login=\"<SonarQube用户名>\" \
        /d:sonar.password=\"<SonarQube密码>\""

上述脚本功能说明：

• 将本地项目目录挂载到容器的/source目录
• （可选）挂载本地NuGet配置到/nuget目录（用于私有NuGet源）
• 启动SonarQube扫描会话，配置项目信息和SonarQube服务器参数
• 执行项目还原、构建、发布
• 运行单元测试并收集覆盖率报告（opencover格式）
• 结束SonarQube扫描并提交分析结果

Jenkins Pipeline集成

以下Pipeline配置实现：SonarQube扫描、项目构建、测试覆盖率分析、质量门禁检查

groovy
def envVariables = [
    'HOME=/tmp/home',
    'DOTNET_CLI_TELEMETRY_OPTOUT=1'
]

node('somenode-with-docker') {
    withSonarQubeEnv('my-jenkins-configured-sonar-environment') {
        docker.image('nosinovacao/dotnet-sonar:latest').inside() {
            withEnv(envVariables) {
                stage('build') {
                    checkout scm
                    sh "dotnet /sonar-scanner/SonarScanner.MSBuild.dll begin /k:someKey /name:someName /version:someVersion /d:sonar.cs.opencover.reportsPaths='tests/**/coverage.opencover.xml'"
                    sh "dotnet build -c Release /property:Version=someVersion"
                    sh "rm -drf ${env.WORKSPACE}/testResults"
                    sh (returnStatus: true, script: "find tests/**/* -name '*.csproj' -print0 | xargs -L1 -0 -P 8 dotnet test --no-build -c Release --logger trx --results-directory ${env.WORKSPACE}/testResults /p:CollectCoverage=true /p:CoverletOutputFormat=opencover")
                    step([$class: 'XUnitPublisher', testTimeMargin: '3000', thresholdMode: 1, thresholds: [[$class: 'FailedThreshold', unstableThreshold: '0'], [$class: 'SkippedThreshold']], tools: [[$class: 'MSTestJunitHudsonTestType', deleteOutputFiles: true, failIfNotNew: false, pattern: 'testResults/**/*.trx', skipNoTestFiles: true, stopProcessingIfError: true]]])
                    sh "dotnet /sonar-scanner/SonarScanner.MSBuild.dll end"
                }
            }
        }
    }
}

timeout(time: 1, unit: 'HOURS') {
    def qualityGate = waitForQualityGate()
    if (qualityGate.status == 'ERROR') {
        currentBuild.result = 'UNSTABLE'
    }
}

Docker-in-Docker使用（注意安全风险）

如需在容器内运行Docker命令，需挂载主机的docker.sock并添加Docker用户组（存在安全风险，谨慎使用）：

groovy
docker.image('nosinovacao/dotnet-sonar:latest').inside("--group-add docker -v /var/run/docker.sock:/var/run/docker.sock") {
    // 在容器内使用Docker命令
    docker.image('hello-world:latest').inside() {
        sh "echo '在Docker-in-Docker环境中执行命令'"
    }
}

代码覆盖率分析

上述示例已集成代码覆盖率分析，需在单元测试项目中添加coverlet NuGet包：

bash
dotnet add package coverlet.collector

更多信息：

• .NET Core单元测试与代码覆盖率
• https://github.com/tonerdo/coverlet/