基于sonar 的C#静态代码扫描使用总结

最新推荐文章于 2024-04-20 00:01:15 发布

一个双鱼座的测开

最新推荐文章于 2024-04-20 00:01:15 发布

阅读量1.6k

点赞数 1

文章标签： c# 开发语言

伟仔

本文链接：https://blog.csdn.net/weixin_42439274/article/details/132662315

版权

1.原理简介

C#语言接入Sonar代码静态扫描相较于Java、Python来说，相对麻烦一些。Sonar检测C#代码时需要预先编译，而且C#代码必须用MSbuid进行编译，如果需要使用SonarQube对C#进行代码质量分析，则需要Sonar-Scanner-MSBuild和MSBuild，其中要求MSBuild在V14.0以上。

1.1 java8需要的安装包

链接：https://pan.baidu.com/s/1lp85mfmX_0W7t6MyWgn0JQ?pwd=abcd
提取码：abcd

Sonarqube-7.8是sonar的部署包；
sonar-scanner-msbuild是代码扫描的包；
还需要msbuild，这个是需要安装Microsoft Visual Studio 会自动安装没有需要自行安装；
sonar-|10n-zh-plugin-1.28.jar为汉化包。

2.sonar安装

2.1基于windows安装sonarqube

环境参数
software
version
JDK
1.8
SonarQube
SonarQube-7.8
sonar-runner
sonar-runner-dist-2.4
汉化插件
sonar-|10n-zh-plugin-1.28.jar
mysql
mysql-5.7 有版本限制 5.7 最新8.0以上版本不支持

一、数据库配置

root登录数据库，执行以下命令：

创建sonar数据库
创建sonar 用户
给sonar 赋予权限
密码是sonar
刷新权限

CREATE DATABASE sonar CHARACTER SET utf8 COLLATE utf8_general_ci;
CREATE USER 'sonar' IDENTIFIED BY 'sonar';
GRANT ALL ON sonar.* TO 'sonar'@'%' IDENTIFIED BY 'sonar';
GRANT ALL ON sonar.* TO 'sonar'@'localhost' IDENTIFIED BY 'sonar';
FLUSH PRIVILEGES;

打开sonar/conf目录下的sonar.properties,加入以下配置项:

#数据库连接url
sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false
#数据库用户
sonar.jdbc.username=sonar
#数据库密码
sonar.jdbc.password=sonar
sonar.sorceEncoding=UTF-8
sonar.login=admin
sonar.password=admin

url是数据库连接地址，username是数据库用户名，jdbc.password是数据库密码，login是sonarqube的登录名，sonar.password是sonarqube的密码
sonar默认的登陆名和密码都是admin，默认端口是http://localhost:9000/

二、启动sonarqube

直接打开bin\windows-x86-64\StartSonar.bat 即可运行；如需汉化提前将汉化包放入到
\sonarqube-7.8\sonarqube-7.8\extensions\plugins 下

注：汉化包下载地址：https://github.com/xuhuisheng/sonar-l10n-zh/releases/tag/sonar-l10n-zh-plugin-1.28

在这里插入图片描述表示执行安装成功。本地连接访问地址：http://localhost:9000/未修改文件情况下初始账户密码为 admin admin

3.windows本地C#代码扫描插件环境安装

3.1安装 sonar-scanner-msbuild

下载对应版本的sonar scanner插件并解压
在这里插入图片描述

将解压后路径配置到环境变量 path中 D:\soft\sonar-scanner-msbuild-4.3.1.1372-net46
在这里插入图片描述

3.2 msbuild C#编译环境配置

msbuild在安装vs后会自动安装，路径为
C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\MSBuild\15.0\Bin
将此路径配置到环境变量。
在这里插入图片描述

4.本地执行扫描操作

msbuild常用编译命令：

MSBuild MyApp.sln /t:Rebuild /p:Configuration=Release
MSBuild MyApp.csproj /t:Clean /p:Configuration=Debug;/p:Platform=x86;TargetFrameworkVersion=v3.5

编译为 Release 代码 -p:configuration=“release”
清理项目 -t:clean
重新编译 -t:rebuild
编译项目 -t:build 默认可以忽略这个参数
发布 -t:Publish
注意：这里的 -t 和 /t 作用是相同的。

4.1 配置sonar项目，创建token （注意token只展示一次，记着赋值备份）

在这里插入图片描述

以上步骤完成生成三个对应阶段命令，直接赋值依次执行即为 4.2 、4.3、 4.4的步骤。

4.2 开启scanner-for-msbuild begin

注意执行scanner-for-msbuild begin 命令前先将路径切换到C#路径

在这里插入图片描述

4.3 开始编译C#代码

执行 MsBuild.exe /t:Rebuild 命令编译代码
在这里插入图片描述

4.4 扫描结束上传报告

执行

SonarScanner.MSBuild.exe end /d:sonar.login="xxxxxxxxxxxx"

上传报告
上传中。。
在这里插入图片描述

上传成功图

在这里插入图片描述

4.5 报告分析

以上步骤执行成功后，报告上传到本地sonar成功，查看项目展示缩略信息
在这里插入图片描述

进入项目展示详细信息
在这里插入图片描述

5.如何导出报告

下载sonar-pdf-plugin插件
下载地址：https://gitee.com/zzulj/sonar-pdf-plugin/releases
暂时无法在飞书文档外展示此内容

把下载好的插件放到Sonarqube安装目录的extensions/plugins目录下，重启Sonarqube服务即可。
pdf生成配置：

在这里插入图片描述

重新执行代码扫描后会生成pdf文件，下载pdf文件位置

6.VS ide 使用SonarLint

待完善。

7.通过jenkins集成 sonar 做静态代码扫描注意事项及方式

一、插件方式

1.Jenkins安装插件及插件配置

下载插件sonarqube scanner，用来集成sonarqube，在配置任务的时候才有sonarscanner的选项。
在这里插入图片描述

全局工具配置windows本地的msbuild和sonarscanner for msbuild
在这里插入图片描述

2.系统配置sonar server

在这里插入图片描述

3任务配置

限制运行节点为windows的几点，关于windows机器怎么设置为代理节点在8.2章节介绍
在这里插入图片描述

在这里插入图片描述

二、pipline脚本方式

pipeline {

    agent {
        label 'windowssonar'
    }
    parameters {
        string(name: 'BRANCHNAME', defaultValue: 'develop', description: '代码分支名称')
    }

    environment {
        JENKINS_NODE_COOKIE = 'dontKillMe'

    }
    stages {
        stage("任务参数检测") {
            steps {
                println "JobName: " + env.JOB_NAME
                println "BuildNumber: " + env.BUILD_NUMBER
                println "BranchName: " + "${BRANCHNAME}"
                

                script {
                    echo "任务参数检测"
                }
            }
        }

        stage("清理测试环境") {
            steps {
                script {

                    echo "删除之前代码库代码"
                }
            }
        }


        stage("下载平台代码") {
            steps {
                script {
                    echo "开始克隆代码"
                }
            }
        }


                
                stage("开启扫描") {
            steps {
                script {
                    dir('D:\\cproject\\miautomationv1.0\\code\\LineControlSln'){
                                            echo "begin"
                                            cmd_begin='SonarScanner.MSBuild.exe begin /k:"miautomationv1.0-01" /d:sonar.host.url="http://10.221.129.75:9000" /d:sonar.login="768ea2749c6151843e6dc113cf86ae2c2ba48fca"'
                                            echo cmd_begin
                                            
                                            bat "cd D:\\cproject\\miautomationv1.0\\code\\LineControlSln"
                                            
                                            bat "cd"
                                            bat "${cmd_begin}"
    
                                            
                                            echo "编译"
                                            bat "MsBuild.exe /t:Rebuild"
                                            
                                            echo "end"
                                            bat 'SonarScanner.MSBuild.exe end /d:sonar.login="768ea2749c6151843e6dc113cf86ae2c2ba48fca"'
                    }                    
                                        
                }
            }
        }
   

    }
}