静态代码分析工具及框架

Jenkins Pipline&&maven项目

2018-04-20  本文已影响47人  何妨吟啸且徐行1
前提:sonarqube服务已经搭建完成→[搭建参考 ](https://www.sonarqube.org)

一、前期准备工作:

1.下载安装Jenkins的SonarQube插件——SonarScanner:

[未安装用户,下载安装]
  Jenkins->系统管理->插件管理->可选插件Tab->找到SonarScanner并下载:

可选插件tab

  Jenkins ->系统管理-> 管理插件 -> 高级 -> 上传插件,点击选择文件上传即可:
(ps:可能因为版本不同,安装插件失败,需要升级Jenkins或者降低SonarScanner插件版本,但是要注意,如果你的Jenkins使用的是Pipline模式,需要SonarScanner的版本>=2.8

上传插件

  配置成功以后,可以在Jenkins-> 系统管理 -> 管理插件下看到你安装的SonarScanner插件:

成功安装插件

[已安装用户,需要升级]
  Jenkins->系统管理->插件管理->可更新->找到SonarScanner并更新即可:

更新插件
2.配置全局环境和工具:

  Jenkins -> 系统管理 -> 系统设置 -> SonarQube servers->添加,根据实际情况配置即可:
※这里SonarScanner我选择的版本>=5.3,所以用的是token登录,因为5.3及以上版本已经废弃账户和密码登录的方式;
※如果你配置的是5.2及以下版本,这里要使用账户密码的登录方式;

全局环境配置

  Jenkins->系统管理->全局工具配置->SonarQube Scanner->添加:
(ps:可以直接选择自动安装,也可以自己下载之后再配置,这里选的是自动安装)

配置全局工具 安装插件

  这个时候,Jenkins就已经成功接入sonar了,在工程中直接配置使用就可以了。

二、在Jenkins项目中使用Sonar:

下面的内容建立在已建立可用Jenkins项目:

1、maven模式:

a. 直接在项目构建这一步,选择增加构建步骤:

选择增加构建步骤

b. 在可以选择的步骤里面,选择执行Sonar Scanner:

执行Sonars Sanner

c. 选择JDK和SonarQube Scanner插件,并且配置项目Properties:
(这个地方只要你在工具配置里面配置过的Scanner插件都能看到,可以选择~)

配置sonar属性

配置这里的Analysis properties:

# sonar.profile=Objective-C
sonar.projectKey=yourprojectkey
sonar.language=objc
# # 这里我启用了scm,有些版本的SonarQube不开启scm会报错
sonar.scm.enable=true

# Project description
sonar.projectDescription=iOS description
sonar.objectivec.appScheme=Enterprise

# Path to source directories
# 这里是你要检查的代码路径
sonar.sources=/Users/yourpath/workspace/iOS_CI_StaticAnalyzer_sonarTest
#sonar.swift.swiftlint.report=sonar-reports/lizard-report.xml
# 你的项目下的xcodeproj的名称和应用的scheme信息
sonar.objectivec.projec=yourapp.xcodeproj
sonar.objectivec.appScheme=yourapp,yourappExtension
sonar.objectivec.oclint.report=/Users/yourpath/workspace/iOS_CI_StaticAnalyzer_sonarTest/sonar-reports/lizard-report.xml

d. 构建job:

构建带有sonar标记

  这个时候去SonarQube平台会发现,已经有检查结果上传了。
  第一次扫描完成后,发现扫描结果的漏洞居然是0,后来了解到,SonarQube上即使安装了OCLint的插件,也需要自己添加规则进行扫描……所以最开始扫描完了并没有发现什么问题(毕竟代码曾经用OCLint扫描并且修改过)……

2.Pipline模式:

  Pipeline代码:
a.选择Jenkins自动安装Sonar插件的代码示例:

stage('SonarQubeanalysis') {
            steps{
                script {
                    scannerHome = tool 'SonarQubeScanner2.8'
                    //这里这个tool是直接根据名称,获取自动安装的插件的路径
                }
            withSonarQubeEnv('SonarQube') {
                sh "${scannerHome}/bin/sonar-scanner sonar.projectKey=YourProjectKey sonar.sources=."
            }
     }
}

b.自己下载安装配置插件的代码示例:

stage('SonarQubeanalysis') {
            steps{
                # 直接进入到安装目录下运行命令就ok了
                sh ('/Users/yourpath/sonar-scanner-3.0.3.778-macosx/bin/sonar-scanner -Dsonar.projectKey=YourProjectKey -Dsonar.sources=.')
            }
}

c.构建Job,查看SonarQube平台,数据成功上传。

到sonar平台查看错误

  到这里,Jenkins引入SOnarQube插件的操作就完成啦!

上一篇下一篇

猜你喜欢

热点阅读