环境搭建检测语言的运行环境
- 使用sonar-scanner检测的机器需要有所检测语言的运行环境,所以需要在设备上安装相应的运行环境
- 本文只记录sonar-scanner完成基础检测,想要完整/丰富的检测结果,参考后面的sonar集成检测工具
sonar创建相应的项目
- 点击项目、或者顶部+号,点击创建新项目
- 写入新项目的名称并创建
- 创建令牌并记录
设置配置文件
设置配置文件的方式有两种(使用jenkins集成推荐使用方法一,使用sonar-scanner的话推荐使用方法二)
其一:
- 跟项目有关的配置直接在运行sonar-scanner命令时带入
- 跟语言、插件等其他有关的配置直接写在sonar-scanner的/opt/sonar/sonar-scanner-3.3.0.1492-linux/conf/sonar-scanner.properties配置文件中
- 例:在根目录下执行如下命令:
sonar-scanner \
-Dsonar.projectKey=test-tool \
-Dsonar.sources=. \
-Dsonar.host.url=http://localhost:9000 \
-Dsonar.login=xxxxxxxxxxxxxxxxxxxxx(上面创建项目时创建的令牌)
其二:
- 在项目的根目录下面创建一个“sonar-project.properties”的配置文件
- 将所有有关项目、语言、插件的配置均写在该文件中
- 例:在sonar-project.properties文件配置内容如下
sonar.projectKey=test-tool #sonar中对应项目的Key(创建项目时的标识)
sonar.projectName=test-tool #sonar中对应项目的名字(创建项目时的显示名)
sonar.projectVersion=1.0 #sonar中对应项目的版本
sonar.sourceEncoding=UTF-8 #所检测项目的字符编码
sonar.sources=. \ #特别注意,其是用于指定源码的文件夹,相对于该配置文件的目录(相对路径)
sonar.language=py #所检测项目的语言,该参数在sonar7.7被移除,如果使用的是7.7之前的版本就需要带这个参数
开始检测
根据上面2种配置方式,检测的命令不同
其一:
- 如上,打开终端,进入到项目根目录下,将上述命令直接执行即可,sonar的web界面会展示扫描结果(如果出错会有相应的错误信息提示)
其二:
- 写好配置文件后,在项目根目录下执行“sonar-scanner”即可,sonar的web界面会展示扫描结果(如果出错会有相应的错误信息提示)