先安装sonarQube、sonarScanner和jenkins,然后把Jenkins集成sonarQube进行项目管理。
博客链接:
文章目录
- 一、软件和环境的准备
- 二、安装配置sonarQube
- 三、安装配置sonarScanner
- 四、安装配置jenkins
- 五、Jenkins整合SonarQube
- 六、通过jenkins启动项目分析
一、软件和环境的准备
1、软件版本
sonarqube-7.6
sonar-scanner-3.3.0
mysql-8.0.16(windows)
mysql-5.7.29(linux)
jenkins-2.204.5
windows10 64位系统
2、软件下载
1)、sonarqube下载:https://www.sonarqube.org/downloads/ 2)、sonar-scanner下载:https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner 3)、jenkins下载:https://jenkins.io/download/
二、安装配置sonarQube
1、分别下载sonarqube和sonar-scanner安装包到本地之后进行解压
2、启动MySQL数据库,创建sonar数据库即可
3、进入sonarqube解压缩之后的文件目录中,进入conf文件下,找到sonar.properties文件,并向其中添加MySQL数据库的连接配置信息如下:
(注意:sonarQube7.6对数据库版本的要求:MySQL >=5.6 && <8.0;Oracle 11g/12c)
sonar.jdbc.url=jdbc:mysql://192.168.9.18:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false
sonar.jdbc.username=root
sonar.jdbc.password=libin1234
sonar.sorceEncoding=UTF-8
sonar.login=admin
sonar.password=admin
4、至此,Sonar的基本配置就已经完成了,启动它
进入sonarqube解压之后的文件目录中,进入bin目录下,找到相对应操作系统的启动环境(StartSonar.bat)进行启动服务。
5、进入数据库中,你会看到生成了大量的数据表,如下:
6、在浏览器上访问:http://localhost:9000,出现如下页面信息,表示sonar安装成功
7、点击登录进行登录,账户:admin,密码:admin,即可进入
8、安装中文语言包,搜索chinese Pack,进行安装即可
9、如果安装中文语言包chinese Pack不成功,点击下载汉化插件的相应版本,然后放在插件目录即可。
10、安装成功,需要重启StartSonar.bat服务,即可看到如下效果。
三、安装配置sonarScanner
1、解压sonar-scanner,配置环境变量
A:新建环境变量:SONAR_SCANNER_HOME、值:D:\software\sonar-scanner-3.3.0
B:打开path,添加%SONAR_SCANNER_HOME%\bin;
C:cmd进入,输入sonar-scanner -v 出现如下为设置成功
2、进入sonar-scanner解压缩之后的文件目录中,进入conf文件下,找到sonar-scanner.properties文件,并向其中添加MySQL数据库的连接配置信息如下:
sonar.jdbc.url=jdbc:mysql://192.168.9.18:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false
sonar.jdbc.username=root
sonar.jdbc.password=libin1234
sonar.sorceEncoding=UTF-8
sonar.login=admin
sonar.password=admin
3、修改settings.xml文件,D:\software\apache-maven-3.6.0\conf\settings.xml
<pluginGroups>
<pluginGroup>org.sonarsource.scanner.maven</pluginGroup>
</pluginGroups>
<profiles>
<profile>
<id>sonar</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<sonar.jdbc.url>jdbc:mysql://192.168.9.18:3306/sonar</sonar.jdbc.url>
<sonar.jdbc.driver>com.mysql.jdbc.Driver</sonar.jdbc.driver>
<sonar.jdbc.username>root</sonar.jdbc.username>
<sonar.jdbc.password>libin1234</sonar.jdbc.password>
<sonar.host.url>http://localhost:9000/</sonar.host.url>
</properties>
</profile>
</profiles>
4、分析项目
1)、通过Maven命令分析项目,在项目Run as --> Maven build…中执行命令:clean install sonar:sonar
2)、通过sonar-scanner分析项目,需要到项目的根目录,然后shift+右键选择【在此处打开Powershell窗口(S)】,输入命令:sonar-scanner 等待完成即可(或者通过cmd访问到项目根目录在执行命令)
3)、分析成功后的界面
四、安装配置jenkins
1、下载jenkins
2、解锁jenkins
安装完成之后,点击finish按钮。自动弹出浏览器,并显示以下页面
按照提示,在指定目录E:\Applications\Jenkins\secrets\下找到initialAdminPassword文件,复制初始密码,并粘贴到输入框中,点击continue按钮
3、等待插件完成后(插件安装失败可以跳过后续再安装)创建账号信息
- 创建第一个管理用户,填写账号密码等信息之后,点击save and finish按钮
- 或者点击continue as admin按钮,继续使用初始的账号密码,推荐创建新的账号
5、开始使用jenkins工具
6、启动、关闭或者重启是通过【services.msc】找到服务Jenkins做相应的操作(后续知道更好的办法再补充)
五、Jenkins整合SonarQube
1、SonarQube Scanner插件在【ManageJenkins】–>【Plugin Manager】–>【可选插件】中搜索【SonarQube Scanner】
2、如果第一步下载失败,方法一:【ManageJenkins】–>【Plugin Manager】–>【高级】
把:http://updates.jenkins-ci.org/update-center.json
换成:http://mirror.esuni.jp/jenkins/updates/update-center.json
方法二:到https://wiki.jenkins-ci.org/display/JENKINS/Plugins下载插件再上传
3、【ManageJenkins】–>【Global Tool Configuration】–>, 配置JDK
4、在【ManageJenkins】–>【Confingre System】配置 SonarQube Server 信息(之前我是在【Global Tool Configuration】找,找到地老天荒都没有找到,一度怀疑我装的软件有问题)5、Jenkins->新建,新建一个项目
在增加构建步骤中选择Execute SonarQube Scanner
Task to run 输入框中输入 scan,即分析代码;
Path to project properties:可选择的输入框,可以指定一个 sonar-project.properties 文件,如果不指定则使用项目默认的 properties 文件;
Analysis properties:输入一些配置参数传递给 SonarQube,这里的参数优先级高于 sonar-project.properties 文件里面的参数,所以可以在这里来配置所有的参数以替代 sonar-project.properties 文件
注:SonarQube Scanner配置可以直接在项目根目录中创建一个文件sonar-project.properties,然后使用Path to project properties中指定属性文件,或者直接在Analysis Properties中配置
Additional arguments:可以输入一些附加的参数,示例中的-X指进入 SonarQube Scanner 的 Debug 模式,输出更多的日志信息
Jenkins立即构建
6、如果想分析现有的项目,需要把项目复制到【jenkins-2.204.5】的安装目录下,构建会不一样(后续再补充更加智能化的操作)
六、通过jenkins启动项目分析
1、项目创建完毕,进行项目分析
构建项目分析
通过sonarqube查看分析的结果
查看构建时的日志