Jenkins持续集成实战
作者:运维人在路上
个人博客:https://www.cnblogs.com/hujinzhong
微信公众号:运维人在路上
Bilibili账号:https://space.bilibili.com/409609392
个人简介:本人是一枚大型电商平台的运维工程师,对开发及运维有一定了解,现分享技术干货,欢迎大家交流!
一、持续集成介绍
1.1、软件开发周期
软件开发生命周期又叫做SDLC(Software Development Life Cycle
),它是集合了计划、开发、测试和部署过程的一整套流程
1.1.1、需求分析
这是生命周期的第一阶段,根据项目需求,团队执行一个可行性计划的分析。项目需求可能是公司内部或者客户提出的。这阶段主要是对信息的收集,也有可能是对现有项目的改善和重新做一个新的项目。还要分析项目的预算多长,可以从哪方面受益及布局,这也是项目创建的目标
1.1.2、设计
第二阶段就是设计阶段,系统架构和满意状态(就是要做成什么样子,有什么功能),和创建一个项目计划。计划可以使用图表,布局设计或者文者的方式呈现
1.1.3、实现
第三阶段就是实现阶段,项目经理创建和分配工作给开者,开发者根据任务和在设计阶段定义的目标进行开发代码。依据项目的大小和复杂程度,可以需要数月或更长时间才能完成。
1.1.4、测试
测试人员进行代码测试 ,包括功能测试、代码测试、压力测试等
1.1.5、进化
最后进阶段就是对产品不断的进化改进和维护阶段,根据用户的使用情况,可能需要对某功能进行修改,bug修复,功能增加等
1.2、软件开发瀑布模型
瀑布模型是最著名和最常使用的软件开发模型。瀑布模型就是一系列的软件开发过程。它是由制造业繁衍出来的。一个高度化的结构流程在一个方向上流动,有点像生产线一样。在瀑布模型创建之初,没有其它开发的模型,有很多东西全靠开发人员去猜测,去开发。这样的模型仅适用于那些简单的软件开发, 但是已经不适合现在的开发了。
优势 | 劣势 |
---|---|
简单易用和理解 | 各个阶段的划分完全固定,阶段之间产生大量的文档,极大的增加了工作量 |
当前一阶段完成后,您只需要去关注后续阶段 | 由于开发模型是线性的,用户只有等到整个过程的末期才能见到开发成果,从而增加了开发风险 |
为项目提供了按阶段划分的检查节点 | 瀑布模型的突出缺点是不适应用户需求的变化。 |
1.3、软件敏捷开发
1.3.1、什么是敏捷开发
敏捷开发(Agile Development) 的核心是迭代开发(Iterative Development)与 增量开发(Incremental Development)
1)迭代开发
对于大型软件项目,传统的开发方式是采用一个大周期(比如一年)进行开发,整个过程就是一次"大开发";迭代开发的方式则不一样,它将开发过程拆分成多个小周期,即一次"大开发"变成多次"小开发",每次小开发都是同样的流程,所以看上去就好像重复在做同样的步骤
举例来说,SpaceX 公司想造一个大推力火箭,将人类送到火星。但是,它不是一开始就造大火箭,而是先造一个最简陋的小火箭 Falcon 1。结果,第一次发射就爆炸了,直到第四次发射,才成功进入轨道。然后,开发了中型火箭 Falcon 9,九年中发射了70次。最后,才开发 Falcon 重型火箭。如果SpaceX 不采用迭代开发,它可能直到现在还无法上天
2)增量开发
软件的每个版本,都会新增一个用户可以感知的完整功能。也就是说,按照新增功能来划分迭代
举例来说,房产公司开发一个10栋楼的小区。如果采用增量开发的模式,该公司第一个迭代就是交付一号楼,第二个迭代交付二号楼......每个迭代都是完成一栋完整的楼。而不是第一个迭代挖好10栋楼的地基,第二个迭代建好每栋楼的骨架,第三个迭代架设屋顶......
3)敏捷开发如何迭代
虽然敏捷开发将软件开发分成多个迭代,但是也要求,每次迭代都是一个完整的软件开发周期,必须按照软件工程的方法论,进行正规的流程管理
1.3.2、敏捷开发好处
1)早期交付
敏捷开发的第一个好处,就是早期交付,从而大大降低成本。 还是以上一节的房产公司为例,如果按照传统的"瀑布开发模式",先挖10栋楼的地基、再盖骨架、然后架设屋顶,每个阶段都等到前一个阶段完成后开始,可能需要两年才能一次性交付10栋楼。也就是说,如果不考虑预售,该项目必须等到两年后才能回款。 敏捷开发是六个月后交付一号楼,后面每两个月交付一栋楼。因此,半年就能回款10%,后面每个月都会有现金流,资金压力就大大减轻了
2)降低风险
敏捷开发的第二个好处是,及时了解市场需求,降低产品不适用的风险。 请想一想,哪一种情况损失比较小:10栋楼都造好以后,才发现卖不出去,还是造好第一栋楼,就发现卖不出去,从而改进或停建后面9栋楼?
1.4、持续集成
1.4.1、什么是持续集成
持续集成( Continuous integration
, 简称 CI
)指的是,频繁地(一天多次)将代码集成到主干。持续集成的目的,就是让产品可以快速迭代,同时还能保持高质量。它的核心措施是,代码集成到主干之前,必须通过自动化测试。只要有一个测试用例失败,就不能集成。通过持续集成, 团队可以快速的从一个功能到另一个功能,简而言之,敏捷软件开发很大一部分都要归功于持续集成
1.4.2、持续集成流程
根据持续集成的设计,代码从提交到生产,整个过程有以下几步:
1)提交:开发者向代码仓库提交代码,所有后面的步骤都始于本地代码的一次提交
2)测试(第一轮):代码仓库对commit
操作配置了钩子(hook
),只要提交代码或者合并进主干,就会跑自动化测试
3)构建:指的是将源码转换为可以运行的实际代码,比如安装依赖,配置各种资源(样式表、JS脚本、图片)等等。通过第一轮测试,代码就可以合并进主干,就算可以交付了。交付后,就先进行构建(build),再进入第二轮测试
4)测试(第二轮):构建完成,就要进行第二轮测试。如果第一轮已经涵盖了所有测试内容,第二轮可以省略,这时构建步骤也要移到第一轮测试前面
5)部署:过了第二轮测试,当前代码就是一个可以直接部署的版本(artifact
)。将这个版本的所有文件打包存档,发到生产服务器。
6)回滚:一旦当前版本发生问题,就要回滚到上一个版本的构建结果。最简单的做法就是修改一下符号链接,指向上一个版本的目录
1.4.3、持续集成组成要素
1)一个自动构建过程, 从检出代码、 编译构建、 运行测试、 结果记录、 测试统计等都是自动完成的, 无需人工干预。
2)一个代码存储库,即需要版本控制软件来保障代码的可维护性,同时作为构建过程的素材库,一般使用SVN
或Git
。
3)一个持续集成服务器, Jenkins
就是一个配置简单和使用方便的持续集成服务器。
1.4.4、持续集成好处
1)降低风险,由于持续集成不断去构建,编译和测试,可以很早期发现问题,所以修复的代价就少;
2)对系统健康持续检查,减少发布风险带来的问题;
3)减少重复性工作;
4)持续部署,提供可部署单元包;
5)持续交付可供使用的版本;
6)增强团队信心;
二、持续集成环境安装配置
2.1、持续集成环境说明
1)首先,开发人员每天进行代码提交,提交到Git仓库
2)然后,Jenkins作为持续集成工具,使用Git工具到Git仓库拉取代码到集成服务器,再配合JDK,Maven等软件完成代码编译,代码测试与审查,测试,打包等工作,在这个过程中每一步出错,都重新再执行一次整个流程。
3)最后,Jenkins把生成的jar或war包分发到测试服务器或者生产服务器,测试人员或用户就可以访问应用。
2.2、服务器规划
本实验均采用CentOS7
作为服务器
名称 | 配置 | ip地址 | 安装的服务 |
---|---|---|---|
代码托管服务器 | 2C4G | 10.0.0.101 | Gitlab-12.4.2 |
持续集成服务器 | 2C4G | 10.0.0.102 | Jenkins-2.284,JDK1.8,Maven3.6.2,Git,SonarQube |
应用测试服务器 | 1C1G | 10.0.0.103 | JDK1.8,Tomcat8.5 |
2.3、Gitlab代码托管服务器安装
2.3.1、Gitlab介绍
GitLab 是一个用于仓库管理系统的开源项目,使用Git作为代码管理工具,并在此基础上搭建起来的web服务。
GitLab和GitHub一样属于第三方基于Git开发的作品,免费且开源(基于MIT协议),与Github类似,可以注册用户,任意提交你的代码,添加SSHKey等等。不同的是,GitLab是可以部署到自己的服务器上,数据库等一切信息都掌握在自己手上,适合团队内部协作开发,你总不可能把团队内部的智慧总放在别人的服务器上吧?简单来说可把GitLab看作个人版的GitHub。
2.3.2、Gitlab安装
# 1、安装相关依赖
[root@gitlab ~]# yum -y install policycoreutils policycoreutils-python openssh-server openssh-clients postfix
# 2、设置postfix开机自启,并启动,postfix支持gitlab发短信功能
[root@gitlab ~]# systemctl enable postfix && systemctl start postfix
# 3、开放ssh以及http服务,然后重新加载防火墙列表(如果关闭防火墙就不需要做以下配置),如果是云服务器,需要在安全组中开放端口
[root@gitlab ~]# firewall-cmd --add-service=ssh --permanent
[root@gitlab ~]# firewall-cmd --add-service=http --permanent
[root@gitlab ~]# firewall-cmd --reload
# 4、下载gitlab包,并且安装
[root@gitlab ~]# wget https://mirrors.tuna.tsinghua.edu.cn/gitlab-ce/yum/el6/gitlab-ce-12.4.2-ce.0.el6.x86_64.rpm
[root@gitlab ~]# rpm -ivh gitlab-ce-12.4.2-ce.0.el6.x86_64.rpm
此时会出现如下界面:
# 6、修改gitlab配置(访问地址及端口)
[root@gitlab ~]# vim /etc/gitlab/gitlab.rb
external_url 'http://10.0.0.101:82'
nginx['listen_port'] = 82
# 7、重载配置及启动gitlab
[root@gitlab ~]# gitlab-ctl reconfigure
[root@gitlab ~]# gitlab-ctl restart
ok: run: alertmanager: (pid 4198) 0s
ok: run: gitaly: (pid 4209) 1s
ok: run: gitlab-exporter: (pid 4228) 0s
ok: run: gitlab-workhorse: (pid 4236) 0s
ok: run: grafana: (pid 4249) 0s
ok: run: logrotate: (pid 4298) 0s
ok: run: nginx: (pid 4343) 1s
ok: run: node-exporter: (pid 4350) 0s
ok: run: postgres-exporter: (pid 4356) 1s
ok: run: postgresql: (pid 4365) 0s
ok: run: prometheus: (pid 4374) 0s
ok: run: redis: (pid 4385) 1s
ok: run: redis-exporter: (pid 4419) 0s
ok: run: sidekiq: (pid 4428) 0s
ok: run: unicorn: (pid 4439) 1s
# 8、把端口添加到防火墙(关闭防火墙无需添加,云服务器需要放行安全组)
[root@gitlab ~]# firewall-cmd --zone=public --add-port=82/tcp --permanent
[root@gitlab ~]# firewall-cmd --reload
# 9、浏览器输入http://10.0.0.101:82访问,修改root密码后登陆
修改完密码后即可登陆:
2.3.3、Gitlab邮箱设置
# 添加如下配置
[root@gitlab ~]# vim /etc/gitlab/gitlab.rb
gitlab_rails['smtp_enable'] = true
gitlab_rails['smtp_address'] = "smtp.163.com"
gitlab_rails['smtp_port'] = 25
gitlab_rails['smtp_user_name'] = "18665870472@163.com"
gitlab_rails['smtp_password'] = "GGCTEDQDVLKPCIID" # 163邮箱授权码
gitlab_rails['smtp_domain'] = "163.com"
gitlab_rails['smtp_authentication'] = :login
gitlab_rails['smtp_enable_starttls_auto'] = true
#gitlab_rails['smtp_tls'] = false
gitlab_rails['gitlab_email_from'] = "18665870472@163.com"
user["git_user_email"] = "18665870472@163.com"
# 重新加载配置
[root@gitlab ~]# gitlab-ctl reconfigure
[root@gitlab ~]# gitlab-ctl start
测试:使用管理员账号创建用户,测试邮件发送
2.3.4、Gitlab添加组、创建用户、创建项目
1)创建组
使用管理员 root 创建组,一个组里面可以有多个项目,可以将开发添加到组里面进行设置权限,不同的组就是公司不同的开发项目或者服务模块,不同的组添加不同的开发即可实现对开发设置权限的管理
2)创建用户
创建用户的时候,可以选择Regular
或Admin
类型。
regular
:普通用户,只能访问他的项目与组
admin
:管理员,可以访问所有的项目与组
创建完用户后,立即修改密码:
3)用户添加进组
选择某个用户组,进行Members管理组的成员
角色说明:
Guest:可以创建issue、发表评论,不能读写版本库
Reporter:可以克隆代码,不能提交,QA、PM可以赋予这个权限
Developer:可以克隆代码、开发、提交、push,普通开发可以赋予这个权限
Maintainer:可以创建项目、添加tag、保护分支、添加项目成员、编辑项目,核心开发可以赋予这个权限
Owner:可以设置项目访问权限 - Visibility Level、删除项目、迁移项目、管理组成员,开发组组长可以赋予这个权限
4)在用户组中创建项目
以刚才创建的新用户身份登录到Gitlab,然后在用户组中创建新的项目
2.3.5、源码推送至Gitlab仓库
来到IDEA开发工具,准备好一个简单的Web应用准备到集成部署。要把源码上传到Gitlab的项目仓库中
如何创建javaweb
项目:https://blog.csdn.net/qq_43594119/article/details/106199248
1)项目结构说明
2)开启版本控制
3)提交代码到远程仓库
先add
代码到缓存区
再Commit
到本地仓库:
推送到Gitlab项目仓库中:
指定远程仓库:
输入gitlab的用户名和密码,然后就可以把代码推送到远程仓库啦
刷新Gitlab:
也可以使用git命令直接推送:
git init
git add *
git commit -m "项目初始化"
git remote add origin git@10.0.0.101:dianchou_group/tensquare_back.git
git push -u origin master
2.3.6、Gitlab备份与恢复
1)Gitlab备份
# 使用以下命令会在/var/opt/gitlab/backups目录下创建一个名称类似为xxx_gitlab_backup.tar的压缩包
[root@gitlab ~]# gitlab-rake gitlab:backup:create
[root@gitlab backups]# pwd
/var/opt/gitlab/backups
[root@gitlab backups]# ll
total 39272
-rw------- 1 git git 40212480 Mar 27 17:35 1616837730_2021_03_27_12.4.2_gitlab_backup.tar
注意:gitlab.rb
和gitlab-secrets.json
包含敏感信息,不会自动备份,需要手动备份
# 修改默认存放备份站点目录,然后进行重新加载配置文件
[root@gitlab ~]# vim /etc/gitlab/gitlab.rb
gitlab_rails['backup_path'] = "/data/gitlab/backups"
[root@gitlab ~]# gitlab-ctl reconfigure
# 手动备份
[root@gitlab ~]# gitlab-rake gitlab:backup:create
# 自动备份
# 实现每天凌晨2点进行一次自动备份:通过crontab使用备份命令实现
00 02 * * * /usr/bin/gitlab-rake gitlab:backup:create
2)Gitlab恢复
# 停止相关数据连接服务
[root@gitlab ~]# gitlab-ctl stop unicorn
[root@gitlab ~]# gitlab-ctl stop sidekiq
# 从1616837730_2021_03_27_12.4.2编号备份中恢复
[root@gitlab ~]# gitlab-rake gitlab:backup:restore BACKUP=1616837730_2021_03_27_12.4.2
# 启动Gitlab
[root@gitlab ~]# gitlab-ctl start
2.3.7、Gitlab迁移及升级
参考文档:https://www.xuliangwei.com/oldxu/803.html
2.4、Jenkins持续集成服务器安装
2.4.1、什么是Jenkins
Jenkins 是一款流行的开源持续集成(Continuous Integration
)工具,广泛用于项目开发,具有自动化构建、测试和部署等功能
官网: https://www.jenkins.io/zh/
2.4.2、Jenkins特征
1)开源的Java语言开发持续集成工具,支持持续集成,持续部署
2)易于安装部署配置:可通过yum
安装,或下载war
包以及通过docker
容器等快速实现安装部署,可方便web界面配置管理
3)消息通知及测试报告:集成RSS/E-mail
通过RSS
发布构建结果或当构建完成时通过e-mail
通知,生成JUnit/TestNG
测试报告
4)分布式构建:支持Jenkins能够让多台计算机一起构建/测试
5)文件识别:Jenkins能够跟踪哪次构建生成哪些jar,哪次构建使用哪个版本的jar等
6)丰富的插件支持:支持扩展插件,你可以开发适合自己团队使用的工具,如git,svn,maven,docker等
2.4.3、Jenkins安装
1)安装jdk8
[root@jenkins ~]# rpm -ivh jdk-8u162-linux-x64.rpm
[root@jenkins ~]# java -version
java version "1.8.0_162"
Java(TM) SE Runtime Environment (build 1.8.0_162-b12)
Java HotSpot(TM) 64-Bit Server VM (build 25.162-b12, mixed mode)
2)安装jenkins的rpm包
[root@jenkins ~]# wget https://mirror.tuna.tsinghua.edu.cn/jenkins/redhat/jenkins-2.284-1.1.noarch.rpm
[root@jenkins ~]# rpm -ivh jenkins-2.284-1.1.noarch.rpm
3)修改jenkins配置
[root@jenkins ~]# vim /etc/sysconfig/jenkins
JENKINS_USER="root"
JENKINS_PORT="8888"
4)启动jenkins
[root@jenkins ~]# systemctl enable jenkins && systemctl start jenkins
5)浏览器访问http://10.0.0.102:8888/
6)获取并输入admin账户密码
[root@jenkins ~]# cat /var/lib/jenkins/secrets/initialAdminPassword
01d8e29a17c6442a8a8c5121fa28c79f
7)跳过插件安装
因为Jenkins插件需要连接默认官网下载,速度非常慢,而且经过会失败,所以我们暂时先跳过插件安装
8)创建一个管理员账户并进入后台
2.4.4、Jenkins插件管理
Jenkins本身不提供很多功能,我们可以通过使用插件来满足我们的使用。例如从Gitlab拉取代码,使用Maven构建项目等功能需要依靠插件完成
1)修改Jenkins插件下载地址
Jenkins国外官方插件地址下载速度非常慢,所以可以修改为国内插件地址
Jenkins->Manage Jenkins->Manage Plugins,点击Available
接着修改地址文件,替换为国内插件地址:
[root@jenkins updates]# pwd
/var/lib/jenkins/updates
[root@jenkins updates]#sed -i 's/https://updates.jenkins.io/download/https://mirrors.tuna.tsinghua.edu.cn/jenkins/g' default.json
[root@jenkins updates]#sed -i 's/http://www.google.com/https://www.baidu.com/g' default.json
最后,Manage Plugins点击Advanced,把Update Site
改为国内插件下载地址:
https://mirrors.tuna.tsinghua.edu.cn/jenkins/updates/update-center.json
Sumbit后,在浏览器输入: http://10.0.0.102:8888/restart ,重启Jenkins
2)安装中文汉化插件
Jenkins->Manage Jenkins->Manage Plugins,点击Available,搜索"Chinese"
重启Jenkins后,就看到Jenkins汉化了!(PS:但可能部分菜单汉化会失败)
2.4.5、Jenkins用户权限管理
我们可以利用Role-based Authorization Strategy
插件来管理Jenkins用户权限
1)安装Role-based Authorization Strategy
插件
2)配置全局安全配置,切换策略切换为"Role-Based Strategy
",保存
3)创建角色
在系统管理页面进入 Manage and Assign Roles
,点击"Manage Roles
"
Global roles(全局角色):管理员等高级用户可以创建基于全局的角色
Item roles(项目角色):针对某个或者某些项目的角色
Node roles(节点角色):节点相关的权限
我们添加以下三个角色:
- baseRole:该角色为全局角色。这个角色需要绑定Overall下面的Read权限,是为了给所有用户绑定最基本的Jenkins访问权限。注意:如果不给后续用户绑定这个角色,会报错误:用户名
is missing the Overall/Read permission
- role1:该角色为项目角色。使用正则表达式绑定"
dianchou.*
",意思是只能操作dianchou开头的项目。 - role2:该角色也为项目角色。绑定"
itdianchou.*
",意思是只能操作itdianchou开头的项目。
4)创建用户
在系统管理页面进入 Manage Users ==>新建用户
分别创建两个用户:jack
和eric
5)给用户分配角色
系统管理页面进入Manage and Assign Roles,点击Assign Roles,绑定规则如下:
- eric用户分别绑定baseRole和role1角色
- jack用户分别绑定baseRole和role2角色
6)创建项目测试权限
以admin管理员账户创建两个项目,分别为dianchou01
和itdianchou01
结果为:
- eric用户登录,只能看到dianchou01项目
- jack用户登录,只能看到itdianchou01项目
2.4.6、Jenkins凭证管理
凭据可以用来存储需要密文保护的数据库密码、Gitlab密码信息、Docker私有仓库密码
等,以便Jenkins可以和这些第三方的应用进行交互
1)安装Credentials Binding插件
安装插件后,系统管理里面会出现manage Credentials
,在这里管理所有凭证
可以添加的凭证有5种:
Username with password
:用户名和密码
SSH Username with private key
: 使用SSH用户和密钥
Secret file
:需要保密的文本文件,使用时Jenkins会将文件复制到一个临时目录中,再将文件路径设置到一个变量中,等构建结束后,所复制的Secret file就会被删除。
Secret text
:需要保存的一个加密的文本串,如钉钉机器人或Github的api token
Certificate
:通过上传证书文件的方式常用的凭证类型有:Username with password(用户密码)和SSH Username with private key(SSH密钥)
2.4.7、演示:Jenkins管理Gitlab凭证
1)安装Git插件和Git工具
为了让Jenkins支持从Gitlab拉取源码,需要安装Git插件以及在CentOS7上安装Git工具
CentOS7上安装Git工具:
[root@jenkins ~]# yum install git -y
[root@jenkins ~]# git version
git version 1.8.3.1
2)用户密码类型凭证
系统管理>manage Credentials>全局==>添加凭据
选择"Username with password
",输入Gitlab的用户名和密码,点击"确定"。
测试凭证是否可用,创建一个FreeStyle项目:新建Item->FreeStyle Project->确定
找到"源码管理"->"Git",在Repository URL复制Gitlab中的项目URL
保存配置后,点击立即构建
开始构建项目
查看/var/lib/jenkins/workspace/
目录,发现已经从Gitlab成功拉取了代码到Jenkins中
3)SSH秘钥类型
SSH免密登录示意图
jenkin服务器上使用root用户生成公钥和私钥
[root@jenkins ~]# ssh-keygen -t rsa
Generating public/private rsa key pair.
Enter file in which to save the key (/root/.ssh/id_rsa):
Created directory '/root/.ssh'.
Enter passphrase (empty for no passphrase):
Enter same passphrase again:
Your identification has been saved in /root/.ssh/id_rsa.
Your public key has been saved in /root/.ssh/id_rsa.pub.
The key fingerprint is:
SHA256:XdzgJf9VrhU1uZr/Ohu0R6faTYMWBI4tr3OscUkRP08 root@jenkins
The key's randomart image is:
+---[RSA 2048]----+
| oo .o=|
| +o+* o+|
| o +++oE=|
| .o.o +=.|
| S .o .=.+|
| + .+o+.|
| + = o=.o|
| * .o.*.|
| . . +++|
+----[SHA256]-----+
[root@jenkins ~]# ll .ssh/
total 8
-rw------- 1 root root 1679 Mar 20 09:53 id_rsa
-rw-r--r-- 1 root root 394 Mar 20 09:53 id_rsa.pub
[root@jenkins ~]# cat .ssh/id_rsa.pub
ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDH2d5pWkaO7IyHse1G6lqowDlb01YBydCBfxlk/TAOQocFgHk+y+fdZDUcnwericBOyLacinNurpL2LlkZm3L6PZW9B1OKgpMVGXs2s2WFFPHngh+faO3ruh0C2ySxhxrX2acMjlIeqzKPEk83JUc5XbtsbuTOKrOZs7fweXr5V8hBaCUfU0XSas+aZ4tns+IWlS5oUk70diZwxMCAcvpzZOiwyFHB0TDjBnAtw2bF3EExyHzsBROoTSlijxb+HJzX09ZDv8DHv+Ouh3GEMitY0RxBSI03rx3MsiwT0dBrQiuGjzSPvqbsJ46+lenbdnAq+/bbI7gj7c6+IEKlbgJn root@jenkins
[root@jenkins ~]# cat .ssh/id_rsa
-----BEGIN RSA PRIVATE KEY-----
MIIEpAIBAAKCAQEAx9neaVpGjuyMh7HtRupaqMA5W9NWAcnQgX8ZZP0wDkKHBYB5
Psvn3WQ1HJ8Hq4nATsi2nIpzbq6S9i5ZGZty+j2VvQdTioKTFRl7NrNlhRTx54If
n2jt67odAtsksYca19mnDI5SHqsyjxJPNyVHOV27bG7kziqzmbO38Hl6+VfIQWgl
H1NF0mrPmmeLZ7PiFpUuaFJO9HYmcMTAgHL6c2TosMhRwdEw4wZwLcNmxdxBMch8
7AUTqE0pYo8W/hyc19PWQ7/Ax7/jrodxhDIrWNEcQUiNN68dzLIsE9HQa0Irho80
j76m7CeOvpXp23ZwKvv22yO4I+3OviBCpW4CZwIDAQABAoIBAQCRNtnJK3OBfphO
MRb8JGVjoOkMs+8WtZHvxm6pVt+IPQbnFIcE/hyoXZvKBDQKjLlThbxK2r8teWQH
xX2wgad19THMfHpTdrVw62cARDJMFQAA/CgGKLRYSI+z95Ad/tGebeRX10IMTtEZ
7G/q3gd2w4jgLWPL+nMuB8xry5lzevCsTcQ9J6dKqNuVjvL4IPxqHeprC7F2IxEb
jxvFnzX/Y5YEB2ctn9RYKqKpRHiIeeLpbexNhZJdBcgf14Yo8wRE5mY4nFoxitTq
zNDvJPNbXLzxog4JBbnpCjO8RaOsPztT2p6gD/Y7eplQ/S+ttBjktWmC/oZRftAU
YrvfYYHhAoGBAOOhmZeUpWCoUdLcsSpPbj1adsBx/k0lCGAzzE30vP23c64xMEtb
RXVogvvGfOZqODcmh0gW1pi6t0P06VDVS3YYB2EmUtjGAByDRUIFumbKrggJou9c
gHnThqqsEtMKEnR6bAINev35Rv9IXWaV91NayG0ofcrfu3q80vdrN05dAoGBAODB
9oDsx3XkfWAYmCn28RaqYyxviE0QG9QNBDEmQzQHALQaaXPZJMi/DQTzcLmH51PD
Co52bT/uCUy5BPspx0DP3nXv+XtGTAhWaCmJqTvre8eQ3uHl//DE6mj2wke1E+RG
Ost+CSLrhLxijZPKzGHmYW+iIhpWd/K/re30fd+TAoGBAJKOkgghIVUZKg1cIAkA
uRZxbzG6cyOSK1FdKDYs0517BtTpQJHUAuVz05ltEy96xhTkDoeghKwy0xnCzpFH
st0m3WF0PjTpTlsNPYMjkv7pkaEFK013PhSx1ut9/GS6AGXUCEROD5kDbO2h1tjc
xy94rMBzKIJ9CAUfG6lG84XVAoGAOpbVZ25R4I2bkT1YDThuSHZKO/8nDM+yMWjj
Oty6kAlzSX/JFYX5bMtA3ZWIQRUIXHFvgwukFxI6ImHoxoBxjJejaiMQae49S78a
kBluoEwWjENblo+aVG1AnfQVWRP/B3a3ROyp/QxgIaufNHOdK7geljcxpKP9yK3m
7Sza0zkCgYAQalU9m4ykHBRdhNtp/YjrFZzB8UJVcrrUahmbZTHEUW5W4JOyiPXj
9fPDpnK2RiPfpdNeUz9WOFxOaqDaDmNVweII8J+9gn11ga49tJbPactf7JjC1OwS
B0v84ceazEOINRxgJpIf+IsFnupKZNmcq0iLo993ro+xkAo0HgAqDQ==
-----END RSA PRIVATE KEY-----
把生成的公钥放在Gitlab中:
以root账户登录->点击头像->Settings->SSH Keys,复制刚才id_rsa.pub
文件的内容到这里,点击"Add Key"
在Jenkins中添加凭证,配置私钥,在Jenkins添加一个新的凭证,类型为"SSH Username with private key
",把刚才生成私有文件内容复制过来
测试凭证是否可用,新建"test02"项目->源码管理->Git,这次要使用Gitlab的SSH连接,并且选择SSH凭证
同样尝试构建项目,如果代码可以正常拉取,代表凭证配置成功
2.4.8、maven安装配置
在Jenkins集成服务器上,我们需要安装Maven来编译和打包项目
1)安装maven并配置环境变量
[root@jenkins ~]# tar xf apache-maven-3.6.2-bin.tar.gz -C /opt/
[root@jenkins ~]# mv /opt/apache-maven-3.6.2/ /opt/maven
[root@jenkins ~]# vim /etc/profile
# java配置
export JAVA_HOME=/usr/java/jdk1.8.0_162
export PATH=$PATH:$JAVA_HOME/bin
# maven配置
export MAVEN_HOME=/opt/maven
export PATH=$PATH:$MAVEN_HOME/bin
[root@jenkins ~]# source /etc/profile
[root@jenkins ~]# mvn -v
Apache Maven 3.6.2 (40f52333136460af0dc0d7232c0dc0bcf0d9e117; 2019-08-27T23:06:16+08:00)
Maven home: /opt/maven
Java version: 1.8.0_162, vendor: Oracle Corporation, runtime: /usr/java/jdk1.8.0_162/jre
Default locale: en_US, platform encoding: UTF-8
OS name: "linux", version: "3.10.0-693.el7.x86_64", arch: "amd64", family: "unix"
2)全局工具配置关联JDK和Maven
Jenkins->Global Tool Confifiguration->JDK->新增JDK,配置如下:
Jenkins->Global Tool Confifiguration->Maven->新增Maven,配置如下:
3)添加Jenkins全局变量
Manage Jenkins->Confifigure System->Global Properties ,添加三个全局变量JAVA_HOME
、M2_HOME
、PATH+EXTRA
4)修改Maven的settings.xml,修改本地仓库地址,设置阿里云私服地址
[root@jenkins ~]# mkdir -p /root/repo
[root@jenkins ~]# vim /opt/maven/conf/settings.xml
<!--修改本地仓库地址-->
<localRepository>/root/repo</localRepository>
<!--设置阿里云私服地址,在mirrors节点下添加-->
<mirrors>
<mirror>
<id>nexus-aliyun</id>
<mirrorOf>central</mirrorOf>
<name>Nexus aliyun</name>
<url>http://maven.aliyun.com/nexus/content/groups/public</url>
</mirror>
</mirrors>
5)测试Maven是否配置成功
使用之前的gitlab密码测试项目,修改配置:构建->增加构建步骤->Execute Shell
再次构建,如果可以把项目打成war包,代表maven环境配置成功啦!
2.4.9、Tomcat安装
1)Tomcat安装
[root@tomcat ~]# rpm -ivh jdk-8u162-linux-x64.rpm
[root@tomcat ~]# java -version
java version "1.8.0_162"
Java(TM) SE Runtime Environment (build 1.8.0_162-b12)
Java HotSpot(TM) 64-Bit Server VM (build 25.162-b12, mixed mode)
[root@tomcat ~]# ls
anaconda-ks.cfg apache-tomcat-8.5.47.tar.gz
[root@tomcat ~]# tar xf apache-tomcat-8.5.47.tar.gz -C /opt/
[root@tomcat ~]# mv /opt/apache-tomcat-8.5.47/ /opt/tomcat
# 启动tomcat
[root@tomcat ~]# /opt/tomcat/bin/startup.sh
Using CATALINA_BASE: /opt/tomcat
Using CATALINA_HOME: /opt/tomcat
Using CATALINA_TMPDIR: /opt/tomcat/temp
Using JRE_HOME: /opt/module/jdk1.8.0_144
Using CLASSPATH: /opt/tomcat/bin/bootstrap.jar:/opt/tomcat/bin/tomcat-juli.jar
Tomcat started.
2)配置tomcat用户角色权限
默认情况下Tomcat是没有配置用户角色权限的
但是,后续Jenkins部署项目到Tomcat服务器,需要用到Tomcat的用户,所以修改tomcat以下配置,添加用户及权限
# 用户和密码都是:tomcat
[root@tomcat ~]# vim /opt/tomcat/conf/tomcat-users.xml
<tomcat-users>
<role rolename="tomcat"/>
<role rolename="role1"/>
<role rolename="manager-script"/>
<role rolename="manager-gui"/>
<role rolename="manager-status"/>
<role rolename="admin-gui"/>
<role rolename="admin-script"/>
<user username="tomcat" password="tomcat" roles="manager-gui,manager-script,tomcat,admin-gui,admin-script"/>
</tomcat-users>
注意:上面配置如果有问题,可能会报错
Caused by: org.codehaus.cargo.container.tomcat.internal.TomcatManagerException: The username you provided is not allowed to use the text-based Tomcat Manager (error 403)
解决方法:
注意:为了能够使刚才配置的用户登录到Tomcat,还需要修改以下配置
# 注释该行
[root@tomcat ~]# vim /opt/tomcat/webapps/manager/META-INF/context.xml
<!--
<Valve className="org.apache.catalina.valves.RemoteAddrValve"
allow="127.d+.d+.d+|::1|0:0:0:0:0:0:0:1" />
-->
# 重启tomcat
[root@tomcat ~]# /opt/tomcat/bin/shutdown.sh
[root@tomcat ~]# /opt/tomcat/bin/startup.sh
访问:http://10.0.0.103:8080/manager/html ,输入tomcat和tomcat,看到以下页面代表成功
三、Jenkins项目构建类型
Jenkins中自动构建项目的类型有很多,常用的有以下三种:
- 自由风格软件项目(
FreeStyle Project
) - Maven项目(
Maven Project
) - 流水线项目(
Pipeline Project
)
每种类型的构建其实都可以完成一样的构建过程与结果,只是在操作方式、灵活度等方面有所区别,在实际开发中可以根据自己的需求和习惯来选择。(PS:个人推荐使用流水线类型,因为灵活度非常高)
3.1、自由风格项目构建
3.1.1、拉取代码
1)创建项目
2)配置源码管理,从gitlab拉取代码
3.1.2、编译打包
构建->添加构建步骤->Executor Shell
3.1.3、远程部署
把项目部署到远程的Tomcat里面
1)安装 Deploy to container插件
2)添加Tomcat用户凭证
3)添加构建后操作
4)点击"Build Now",开始构建过程
5)部署成功后,访问项目http://10.0.0.103:8080/web_demo/
6)演示代码改动后的持续集成
IDEA中源码修改并提交到gitlab
在Jenkins中项目重新构建,访问tomcat
3.2、Maven项目构建
1)安装Maven Integration
插件
2)创建maven项目
3)配置项目
拉取代码和远程部署的过程和自由风格项目一样,只是"构建"部分不同
3.3、Pipeline项目构建
3.3.1、Pipeline简介
1)概念
Pipeline,简单来说,就是一套运行在 Jenkins 上的工作流框架,将原来独立运行于单个或者多个节点的任务连接起来,实现单个任务难以完成的复杂流程编排和可视化的工作。
2)使用Pipeline有以下好处(来自翻译自官方文档):
代码
:Pipeline以代码的形式实现,通常被检入源代码控制,使团队能够编辑,审查和迭代其传送流程。
持久
:无论是计划内的还是计划外的服务器重启,Pipeline都是可恢复的。
可停止
:Pipeline可接收交互式输入,以确定是否继续执行Pipeline。
多功能
:Pipeline支持现实世界中复杂的持续交付要求。它支持fork/join、循环执行,并行执行任务的功能。
可扩展
:Pipeline插件支持其DSL的自定义扩展 ,以及与其他插件集成的多个选项。3)如何创建 Jenkins Pipeline呢?
Pipeline 脚本是由
Groovy
语言实现的,但是我们没必要单独去学习 Groovy,Pipeline 支持两种语法:Declarative(声明式)和 Scripted Pipeline(脚本式)语法,Pipeline 也有两种创建方法:可以直接在 Jenkins 的 Web UI 界面中输入脚本;也可以通过创建一个Jenkinsfile
脚本文件放入项目源码库中(一般我们都推荐在 Jenkins 中直接从源代码控制(SCM)中直接载入 Jenkinsfile这种方法)。
3.3.2、安装Pipeline插件
3.3.3、Pipeline语法
官方文档:https://www.jenkins.io/zh/doc/book/pipeline/
1)Declarative声明式-Pipeline
创建项目
说明:
stages
:代表整个流水线的所有执行阶段。通常stages只有1个,里面包含多个stage
stage
:代表流水线中的某个阶段,可能出现n个。一般分为拉取代码,编译构建,部署等阶段。
steps
:代表一个阶段内需要执行的逻辑。steps里面是shell脚本,git拉取代码,ssh远程发布等任意内容。
编写一个简单声明式Pipeline:
pipeline {
agent any
stages {
stage('拉取代码') {
steps {
echo '拉取代码'
}
}
stage('编译构建') {
steps {
echo '编译构建'
}
}
stage('项目部署') {
steps {
echo '项目部署建'
}
}
}
}
点击构建,可以看到整个构建过程
2)Scripted Pipeline脚本式-Pipeline
创建项目
这次选择"Scripted Pipeline"
说明:
Node
:节点,一个 Node 就是一个 Jenkins 节点,Master 或者 Agent,是执行 Step 的具体运行环境,后续讲到Jenkins的Master-Slave架构的时候用到。
Stage
:阶段,一个 Pipeline 可以划分为若干个 Stage,每个 Stage 代表一组操作,比如:Build、Test、Deploy,Stage 是一个逻辑分组的概念。
Step
:步骤,Step 是最基本的操作单元,可以是打印一句话,也可以是构建一个 Docker 镜像,由各类 Jenkins 插件提供,比如命令:sh ‘make’,就相当于我们平时 shell 终端中执行 make 命令一样。
3.3.4、实例:使用pipeline构建项目
1)拉取代码
使用片段生成器
生成pipeline代码:
2)编译构建
3)项目部署
4)完整的pipeline脚本
pipeline {
agent any
stages {
stage('拉取代码') {
steps {
checkout([$class: 'GitSCM', branches: [[name: '*/master']], extensions: [], userRemoteConfigs: [[credentialsId: 'cf17ff40-5824-4b2d-bdd5-784560255001', url: 'git@10.0.0.101:dianchou_group/web_demo.git']]])
}
}
stage('编译构建') {
steps {
sh 'mvn clean package'
}
}
stage('项目部署') {
steps {
deploy adapters: [tomcat8(credentialsId: '58abc576-5cc5-4fa6-b4ab-13e64b2be856', path: '', url: 'http://10.0.0.103:8080/')], contextPath: null, war: 'target/*.war'
}
}
}
}
3.3.5、Pipeline Script from SCM
我们都是直接在Jenkins的UI界面编写Pipeline代码,这样不方便脚本维护,建议把Pipeline脚本放在项目中(一起进行版本控制)
1)在项目根目录建立Jenkinsfile文件,把内容复制到该文件中并推送至gitlab
2)在项目中引用该文件
3.3.6、Blue Ocean
1)安装插件
2)流水线项目构建并查看
四、Jenkins构建触发器
Jenkins内置4种构建触发器:
- 触发远程构建
- 其他工程构建后触发(
Build after other projects are build
) - 定时构建(
Build periodically
) - 轮询SCM(
Poll SCM
)
4.1、触发远程构建
测试:直接在浏览器上输入JENKINS_URL/job/test01_pipeline_declarative/build?token=TOKEN_NAME
,看是否触发构建
4.2、其他工程构建后触发
1)创建pre_job流水线工程
2)配置需要触发的工程
4.3、定时构建
说明:
定时字符串从左往右分别为: 分 时 日 月 周
一些定时表达式的例子:
每30分钟构建一次:H代表形参 H/30 * * * *
每2个小时构建一次: H H/2 * * *
每天的8点,12点,22点,一天构建3次 (多个时间点中间用逗号隔开) :0 8,12,22 * * *
每天中午12点定时构建一次 :H 12 * * *
每天下午18点定时构建一次 :H 18 * * *
在每个小时的前半个小时内的每10分钟: H(0-29)/10 * * * *
每两小时一次,每个工作日上午9点到下午5点(也许是上午10:38,下午12:38,下午2:38,下午4:38): H H(9-16)/2 * * 1-5
4.4、轮询SCM
轮询SCM:是指定时扫描本地代码仓库的代码是否有变更,如果代码有变更就触发项目构建
注意:这种构建触发器,Jenkins会定时扫描整个项目的代码,增大系统的开销,不建议使用。
4.5、Git hook自动触发构建
原理:利用Gitlab的webhook
实现代码push到仓库,立即触发项目自动构建
4.5.1、安装相关插件
需要安装两个插件:Gitlab Hook
和GitLab
4.5.2、Jenkins设置自动构建
4.5.3、Gitlab配置webhook
1)开启webhook功能
使用root账户登录到后台,点击Admin Area -> Settings -> Network->Outbound requests勾选"Allow requests to the local network from web hooks and services
"
2)在项目添加webhook
点击项目->Settings->Integrations
点击add webhook
并测试push events
:
此时会报错:
需要在jenkins中配置:Manage Jenkins->Confifigure System:
在gitlab中再次测试:
4.5.4、更新代码测试自动构建
五、Jenkins参数化构建
有时在项目构建的过程中,我们需要根据用户的输入动态传入一些参数,从而影响整个构建结果,这时我们可以使用参数化构建
Jenkins支持非常丰富的参数类型:
5.1、不同分支参数构建
1)创建分支并推送至gitlab
新建分支:v1,代码稍微改动下,然后提交到gitlab上
2)在Jenkins添加添加字符串类型参数
3)修改jenkinsfile(master和v1分支都需要修改)
4)构建测试
5.2、根据tag参数构建及回滚
1)安装Git Parameter
插件
2)创建自由风格项目并配置
3)创建tag并推送gitlab
# git命令
git tag # 查看当前tag
git tag -a v1.1 -m "version1.1" # 创建tag
git push origin v1.1 # 推送tag到master分支
git tag -d v1.1 v1.2 v1.3 # 删除tag
# idea中操作
在gitlab中查看:
4)根据tag构建或者回滚代码
六、Jenkins配置邮件服务
6.1、安装Email Extension Template
插件
6.2、邮箱开通SMTP服务
6.3、Jenkins设置邮箱相关参数
Manage Jenkins->Confifigure System
1)设置系统发件人邮箱
2)设置邮件参数
邮件通知设置:
3)准备邮件模板
在项目根目录编写email.html,并把文件推送到Gitlab,内容如下
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>${ENV, var="JOB_NAME"}-第${BUILD_NUMBER}次构建日志</title>
</head>
<body leftmargin="8" marginwidth="0" topmargin="8" marginheight="4"
offset="0">
<table width="95%" cellpadding="0" cellspacing="0"
style="font-size: 11pt; font-family: Tahoma, Arial, Helvetica, sans-serif">
<tr>
<td>(本邮件是程序自动下发的,请勿回复!)</td>
</tr>
<tr>
<td><h2>
<font color="#0000FF">构建结果 - ${BUILD_STATUS}</font>
</h2></td>
</tr>
<tr>
<td><br />
<b><font color="#0B610B">构建信息</font></b>
<hr size="2" width="100%" align="center" /></td>
</tr>
<tr>
<td>
<ul>
<li>项目名称 : ${PROJECT_NAME}</li>
<li>构建编号 : 第${BUILD_NUMBER}次构建</li>
<li>触发原因: ${CAUSE}</li>
<li>构建日志: <a href="${BUILD_URL}console">${BUILD_URL}console</a></li>
<li>构建 Url : <a href="${BUILD_URL}">${BUILD_URL}</a></li>
<li>工作目录 : <a href="${PROJECT_URL}ws">${PROJECT_URL}ws</a></li>
<li>项目 Url : <a href="${PROJECT_URL}">${PROJECT_URL}</a></li>
</ul>
</td>
</tr>
<tr>
<td><b><font color="#0B610B">Changes Since Last
Successful Build:</font></b>
<hr size="2" width="100%" align="center" /></td>
</tr>
<tr>
<td>
<ul>
<li>历史变更记录 : <a href="${PROJECT_URL}changes">${PROJECT_URL}changes</a></li>
</ul> ${CHANGES_SINCE_LAST_SUCCESS,reverse=true, format="Changes for Build #%n:<br />%c<br />",showPaths=true,changesFormat="<pre>[%a]<br />%m</pre>",pathFormat=" %p"}
</td>
</tr>
<tr>
<td><b>Failed Test Results</b>
<hr size="2" width="100%" align="center" /></td>
</tr>
<tr>
<td><pre
style="font-size: 11pt; font-family: Tahoma, Arial, Helvetica, sans-serif">$FAILED_TESTS</pre>
<br /></td>
</tr>
<tr>
<td><b><font color="#0B610B">构建日志 (最后 100行):</font></b>
<hr size="2" width="100%" align="center" /></td>
</tr>
<tr>
<td><textarea cols="80" rows="30" readonly="readonly"
style="font-family: Courier New">${BUILD_LOG, maxLines=100}</textarea>
</td>
</tr>
</table>
</body>
</html>
4)编写Jenkinsfile添加构建后发送邮件
pipeline {
agent any
stages {
stage('拉取代码') {
steps {
checkout([$class: 'GitSCM', branches: [[name: '*/${branch}']], extensions: [], userRemoteConfigs: [[credentialsId: 'cf17ff40-5824-4b2d-bdd5-784560255001', url: 'git@10.0.0.101:dianchou_group/web_demo.git']]])
}
}
stage('编译构建') {
steps {
sh 'mvn clean package'
}
}
stage('项目部署') {
steps {
deploy adapters: [tomcat8(credentialsId: '58abc576-5cc5-4fa6-b4ab-13e64b2be856', path: '', url: 'http://10.0.0.103:8080/')], contextPath: null, war: 'target/*.war'
}
}
}
post {
always {
emailext(
subject: '构建通知:${PROJECT_NAME} - Build # ${BUILD_NUMBER} - ${BUILD_STATUS}!',
body: '${FILE,path="email.html"}',
to: '2143342085@qq.com'
)
}
}
}
PS:邮件相关全局参数参考列表:
系统设置->Extended E-mail Notifification->Content Token Reference,点击旁边的
?
号
5)构建测试
七、Jenkins配置钉钉报警
7.1、添加钉钉机器人
注意:关键字需要在pipeline中的Text中带上
# token信息
https://oapi.dingtalk.com/robot/send?access_token=xxx
7.2、Jenkins安装插件
参考文档:
https://blog.csdn.net/ljj123_/article/details/105173171
https://www.zyxiao.com/p/46030
https://pgzxc.com/posts/4e0acf4c.html
钉钉插件下载地址:http://updates.jenkins-ci.org/download/plugins/dingding-notifications/
7.3、配置钉钉
7.4、自由风格构建
7.5、流线线风格项目构建
参考文档:https://jenkinsci.github.io/dingtalk-plugin/guide/pipeline.html
pipeline {
agent any
stages {
stage('拉取代码') {
steps {
checkout([$class: 'GitSCM', branches: [[name: '*/${branch}']], extensions: [], userRemoteConfigs: [[credentialsId: 'cf17ff40-5824-4b2d-bdd5-784560255001', url: 'git@10.0.0.101:dianchou_group/web_demo.git']]])
}
}
stage('code checking') {
steps {
script {
//引入SonarQubeScanner工具
scannerHome = tool 'sonarqube-scanner'
}
//引入SonarQube的服务器环境
withSonarQubeEnv('sonarqube') {
sh "${scannerHome}/bin/sonar-scanner"
}
}
}
stage('编译构建') {
steps {
sh 'mvn clean package'
}
}
stage('项目部署') {
steps {
deploy adapters: [tomcat8(credentialsId: '58abc576-5cc5-4fa6-b4ab-13e64b2be856', path: '', url: 'http://10.0.0.103:8080/')], contextPath: null, war: 'target/*.war'
}
}
}
post {
success {
dingTalk (
robot: '06ce7f2e-987c-4fee-a45a-c364427c9add',
type: 'TEXT',
//需要带上关键字Jenkins
text: [
'Jenkins',
'${BUILD_URL}',
'构建成功'
]
)
}
failure {
dingTalk (
robot: '06ce7f2e-987c-4fee-a45a-c364427c9add',
type: 'TEXT',
text: [
'Jenkins',
'${BUILD_URL}',
'构建失败'
]
)
}
}
}
效果显示:
八、Jenkins配置代码审查SonarQube
8.1、SonarQube介绍
SonarQube是一个用于管理代码质量的开放平台,可以快速的定位代码中潜在的或者明显的错误。目前支持java,C#,C/C++,Python,PL/SQL,Cobol,JavaScrip,Groovy等二十几种编程语言的代码质量管理与检测
流程图:
8.2、安装环境要求
软件 | 服务器 | 版本 |
---|---|---|
JDK | 10.0.0.102 | 1.8 |
MySQL | 10.0.0.102 | 5.7 |
SonarQube | 10.0.0.102 | 6.7.4 |
8.3、SonarQube安装
8.3.1、安装MySQL
yum安装方式:https://blog.csdn.net/qq_36582604/article/details/80526287
[root@jenkins ~]# wget -i -c http://dev.mysql.com/get/mysql57-community-release-el7-10.noarch.rpm
[root@jenkins ~]# yum -y install mysql57-community-release-el7-10.noarch.rpm
[root@jenkins ~]# yum -y install mysql-community-server
[root@jenkins ~]# systemctl start mysqld.service
[root@jenkins ~]# systemctl status mysqld.service
[root@jenkins ~]# grep "password" /var/log/mysqld.log
2021-03-21T09:42:38.861162Z 1 [Note] A temporary password is generated for root@localhost: !zwJuxcyD3dR
# 登录mysql修改密码
[root@jenkins ~]# mysql -uroot -p'!zwJuxcyD3dR'
mysql> ALTER USER 'root'@'localhost' IDENTIFIED BY 'Root@123';
mysql> grant all privileges on *.* to 'root'@'%' identified by 'Root@123' with grant option;
mysql> flush privileges;
mysql> exit
# 配置mysql
[root@jenkins ~]# vim /etc/my.cnf
[root@jenkins ~]# systemctl restart mysqld.service
在MySQL创建sonar数据库:
mysql> create database sonar;
Query OK, 1 row affected (0.00 sec)
mysql> show databases;
+--------------------+
| Database |
+--------------------+
| information_schema |
| mysql |
| performance_schema |
| sonar |
| sys |
+--------------------+
5 rows in set (0.00 sec)
8.3.2、安装SonarQube
软件下载地址:https://www.sonarqube.org/downloads/
# 1、解压sonar,并设置权限
[root@jenkins ~]# unzip sonarqube-6.7.4.zip -d /opt/
[root@jenkins ~]# mv /opt/sonarqube-6.7.4/ /opt/sonar
[root@jenkins ~]# useradd sonar
[root@jenkins ~]# chown -R sonar:sonar /opt/sonar
# 2、修改sonar配置
[root@jenkins ~]# vim /opt/sonar/conf/sonar.properties
sonar.jdbc.username=root
sonar.jdbc.password=Root@123
sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false
#sonar.web.port=9000 # 注意:sonar默认监听9000端口,如果9000端口被占用,需要更改。
# 3、启动sonar
[root@jenkins ~]# cd /opt/sonar/
[root@jenkins sonar]# su sonar ./bin/linux-x86-64/sonar.sh start # 启动
[root@jenkins sonar]# su sonar ./bin/linux-x86-64/sonar.sh status #查看状态
[root@jenkins sonar]# su sonar ./bin/linux-x86-64/sonar.sh stop # 停止
[root@jenkins sonar]# tail -f logs/sonar.logs # 查看日志
# 4、访问sonar:http://10.0.0.102:9000/
8.3.3、创建token
登录sonar并创建token:默认账户(admin/admin)
# token要记下来后面要使用
admin: c9bb023589b7894c70708eeae10c64faa0c29d4a
8.3.4、Jenkins安装插件
安装SonarQube Scanner
插件
8.3.5、Jenkins添加SonarQube凭证
SonaQube关闭审查结果上传到SCM功能:
8.3.6、Jenkins配置SonarQube
Manage Jenkins->Configure System->SonarQube servers
Manage Jenkins->Global Tool Confifiguration
8.3.7、项目添加SonarQube代码审查
# must be unique in a given SonarQube instance
sonar.projectKey=web_demo
# this is the name and version displayed in the SonarQube UI. Was mandatory prior to SonarQube 6.1.
sonar.projectName=web_demo
sonar.projectVersion=1.0
# Path is relative to the sonar-project.properties file. Replace "" by "/" on Windows.
# This property is optional if sonar.modules is set.
sonar.sources=.
sonar.exclusions=**/test/**,**/target/**
sonar.java.source=1.8
sonar.java.target=1.8
# Encoding of the source code. Default is default system encoding
sonar.sourceEncoding=UTF-8
8.3.8、修改jenkinsfile,添加代码审查阶段
pipeline {
agent any
stages {
stage('拉取代码') {
steps {
checkout([$class: 'GitSCM', branches: [[name: '*/${branch}']], extensions: [], userRemoteConfigs: [[credentialsId: 'cf17ff40-5824-4b2d-bdd5-784560255001', url: 'git@10.0.0.101:dianchou_group/web_demo.git']]])
}
}
stage('code checking') {
steps {
script {
//引入SonarQubeScanner工具
scannerHome = tool 'sonarqube-scanner'
}
//引入SonarQube的服务器环境
withSonarQubeEnv('sonarqube') {
sh "${scannerHome}/bin/sonar-scanner"
}
}
}
stage('编译构建') {
steps {
sh 'mvn clean package'
}
}
stage('项目部署') {
steps {
deploy adapters: [tomcat8(credentialsId: '58abc576-5cc5-4fa6-b4ab-13e64b2be856', path: '', url: 'http://10.0.0.103:8080/')], contextPath: null, war: 'target/*.war'
}
}
}
post {
always {
emailext(
subject: '构建通知:${PROJECT_NAME} - Build # ${BUILD_NUMBER} - ${BUILD_STATUS}!',
body: '${FILE,path="email.html"}',
to: '2143342085@qq.com'
)
}
}
}
重新构建并到SonarQube的UI界面查看审查结果: