SonarQube-[配置Scanner|使用Scanner|java,web前端,go代码扫描]

scanner的类型有很多， 可以通过官网：https://docs.sonarqube.org/8.9/analysis/overview/ 获取支持的列表。

• 变更项目代码： 可以使用构建工具进行扫描。例如maven、ant、gradle可以在配置文件中引入对应的配置。
• 不变更项目代码配置： 可以使用Jenkins或其他平台的扩展插件， 以及使用命令行进行扫描。

● Gradle - SonarScanner for Gradle
● .NET - SonarScanner for .NET
● Maven - use the SonarScanner for Maven
● Jenkins - SonarScanner for Jenkins  （Jenkins 集成插件）
● Azure DevOps - SonarQube Extension for Azure DevOps   （devops平台扩展插件）
● Ant - SonarScanner for Ant
● anything else (CLI) - SonarScanner（更加通用的扫描命令行）

/data/sonar-scanner-4.6.2.2472-linux/conf是scanner的配置文件，用于连接服务器端

root@jeekins sonar-scanner-4.6.2.2472-linux]# cat conf/sonar-scanner.properties 
#Configure here general information about the environment, such as SonarQube server connection details for example
#No information about specific project should appear here

#----- Default SonarQube server
#sonar.host.url=http://localhost:9000

#----- Default source code encoding
#sonar.sourceEncoding=UTF-8

使用更加灵活的命令行工具进行扫描， 可以在不更改项目配置的前提下进行代码扫描：

## 进入实验目录 
cd /data/

## 下载包
wget https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-4.6.2.2472-linux.zip

## 解压(JDK)
tar zxf sonar-scanner-xxxx.tar.gz 
unzip sonar-scanner-cli-4.6.2.2472-linux.zip

## 设置环境变量
vim /etc/profile
export SONAR_SCANNER_HOME=/data/sonar-scanner-4.6.2.2472-linux
export PATH=$SONAR_SCANNER_HOME/bin:$PATH
source /etc/profile 


## 测试生效
[root@zeyang-nuc-service sonar-scanner-4.6.2.2472-linux]# sonar-scanner -v
INFO: Scanner configuration file: /data/cicd2/buildtools/sonar-scanner-4.6.2.2472-linux/conf/sonar-scanner.properties
INFO: Project root configuration file: NONE
INFO: SonarScanner 4.6.2.2472
INFO: Java 11.0.11 AdoptOpenJDK (64-bit)
INFO: Linux 4.18.0-80.el8.x86_64 amd64

这里请注意JDK版本的问题， 默认安装的sonarscanner是使用自带的jdk。通过上面的显示可以发现是jdk1.11版本， 如果想使用系统默认的jdk版本，可以修改scanner可执行程序的配置。如下所示：

代码扫描过程： 本地（构建节点）安装配置SonarScanner环境，然后通过设置sonar的一系列参数进行扫描分析。

• 配置文件方式读取扫描参数
• 命令行方式读取扫描参数

一个基本的sonar-project.properties配置文件的参数：

# 定义唯一的关键字
sonar.projectKey=devops-hello-service

# 定义项目名称
sonar.projectName=devops-hello-service

# 定义项目的版本信息
sonar.projectVersion=1.0
 
# 指定扫描代码的目录位置（多个逗号分隔）
sonar.sources=.
 
# 执行项目编码
sonar.sourceEncoding=UTF-8

# 指定sonar Server
sonar.host.url=

# 认证信息
sonar.login
sonar.password

这些配置项都是统一的，目前sonar支持将扫描参数以文件的方式存放或者以命令行传参的方式读取。 文件方式：可以将扫描参数放到项目的根目录或者sonar-scanner的配置文件目录等自定义的目录中， 命令行传参则可以直接将变量传递给sonarsacnner cli -Dsonar.projectKey=xxx 

# 指定配置文件
sonar-scanner -Dproject.settings=myproject.properties

# 命令行传参
sonar-scanner -Dsonar.projectKey=myproject -Dsonar.sources=src1

扩展-Docker运行sonarscanner

docker run \
    --rm \
    -e SONAR_HOST_URL="http://${SONARQUBE_URL}" \
    -e SONAR_LOGIN="myAuthenticationToken" \
    -v "${YOUR_REPO}:/usr/src" \
    sonarsource/sonar-scanner-cli

关于项目参数可以参考：https://docs.sonarqube.org/latest/analysis/analysis-parameters/

各种语言的扫描示例：https://docs.sonarqube.org/latest/analysis/languages/

SonarQube中各种语言的扫描规则都是以jar包的方式。在SonarQube8.9.0之前版本，默认没有安装语言规则插件， 需要手动安装。 服务端安装Java Code Quality and SecuritySonarJS SonarGO 插件，并重启服务器。（如果这里由于网速原因下载不了插件，可以使用课程提供的压缩包，解压到downloads目录下然后重启sonarqube）

如果低于该版本，可以参考如下操作。（可选，跳过）

[root@zeyang-nuc-service ~]# cd /data/cicd/plugin-sonar/

[root@zeyang-nuc-service plugin-sonar]# ls
sonar-go-plugin-1.6.0.719.jar            sonar-l10n-zh-plugin-1.29.jar
sonar-java-plugin-6.3.2.22818.jar        sonar-typescript-plugin-2.1.0.4359.jar
sonar-javascript-plugin-6.2.2.13315.jar

[root@zeyang-nuc-service plugin-sonar]# cp sonar-go-plugin-1.6.0.719.jar  sonar-java-plugin-6.3.2.22818.jar  sonar-javascript-plugin-6.2.2.13315.jar  sonar-typescript-plugin-2.1.0.4359.jar  /data/cicd/sonarqube/sonarqube_extensions/downloads/

[root@zeyang-nuc-service plugin-sonar]# ls /data/cicd/sonarqube/sonarqube_extensions/downloads/
sonar-go-plugin-1.6.0.719.jar      sonar-javascript-plugin-6.2.2.13315.jar
sonar-java-plugin-6.3.2.22818.jar  sonar-typescript-plugin-2.1.0.4359.jar

[root@zeyang-nuc-service plugin-sonar]# chmod +x /data/cicd/sonarqube/sonarqube_extensions/downloads/*

[root@zeyang-nuc-service plugin-sonar]# ls /data/cicd/sonarqube/sonarqube_extensions/downloads/
sonar-go-plugin-1.6.0.719.jar      sonar-javascript-plugin-6.2.2.13315.jar
sonar-java-plugin-6.3.2.22818.jar  sonar-typescript-plugin-2.1.0.4359.jar

[root@zeyang-nuc-service plugin-sonar]# docker restart sonarqube
sonarqube