前言
第一次接触持续集成,是以前在银行做项目的时候,当时APP团队人员较多,测试阶段频繁的打包测试,手动打包效率很低,团队大佬搭建了Jenkins持续集成,当时觉得这玩意儿真好使,提交完代码,轻轻点一下构建,几分钟以后,新包就打好了,对于当初只做上层应用开发的我,感觉好高大上。
五月底换了新公司,进了新的项目组,团队负责两个系统APP的开发、运维,6个人研发团队,规模不大不小。开发阶段打包频率不高,一旦到了交付测试阶段,每天打包的频率很高。每个迭代周期测试时间5~7天,从手动打包的方式来看,两个APP、两个平台(iOS、Android),单个APP打包发布时间8min左右, 如果按平均每天各自打包5次来算(5次算是保守的),每天打包消耗的时间2h40min, 整个测试阶段打包最少也要消耗13h20min。可以看出消耗时间是也不少,如果这些时间可以省下来,小伙伴们完全可以做些其他有意义的事情。
我所在的中心,后台部署是在Jenkins上进行的,然而APP持续集成是真空的。鉴于自己是从事iOS开发的,就先从iOS持续集成开始吧,安卓稍后再弄。以下是持续集成的一些经历~
中心已经有了一台Jenkins服务器,就没必要再新搭一台了,但是iOS打包要基于Mac、Xcode,当然AppCode也可以,因平时用的少,此处不做介绍。Jenkins的服务器是Linux系统,Jenkins可以配置Slave(奴隶)服务器,实现分布式部署。于是决定在Jenkins的主节点下建一个从节点,用一台Mac来做Slave(奴隶)服务器,其实我更喜欢把这台Mac叫做节点机。
1、准备工作
1、配置MacOS slave,具体步骤如下:
1.1 、在偏好设置 ->共享 中开启 远程登录,参照下图:
1.2、创建节点
Jenkins -> 系统管理 -> 节点管理 -> 新建节点,输入节点名称,并勾选 固定节点,点击OK。
1.3、配置节点
需要注意的是,这里的远程工作目录,权限为ssh链接的用户可读写。
1.4、添加Credentials
这里我选择是的SSH Username with private key。
1.5、配置节点属性
此处需要注意的是:PATH环境变量,需要在Mac 终端输入echo $PATH,然后将值copy过去
Keychains and Provisioning Profiles路径要填写正确。没有这个选项的安装Keychains and Provisioning Profiles Management插件。
1.6、保存
以上即添加Mac Slave成功,且Mac Slave在线。若连不上,请反复确认远程工作目录的权限、以及网络。
节点启动失败后,确认权限、网络都正常,可以尝试重启节点代理。
2、Jenkins系统配置
2.1、配置证书、描述文件
在 Jenkins > 系统管理 > Keychains and Provisioning Profiles Management,配置证书、描述文件。如下:
注意:login.keychain 在目录/Users/xxx/Library/Keychains/login.keychain下,Password是自己Mac的登录密码
2.2、Jenkins > 系统管理 > 系统设置 中设置 Xcode和keychain
注意:Keychain的路径:/Users/xxx/Library/Keychains/login.keychain,也可以这么写${HOME}/Library/Keychains/login.keychain,密码为Mac登录密码。
3、配置iOS项目
3.1、新建任务
3.2、General
注意:指定Mac Slave服务器来作为构建Xcode工程的Slave服务器,Xcode打包构建将在该节点上进行。
3.3、配置源码
此处配置代码从git上拉取
注意:Credentials为git用户名、密码,点击添加,去新建一个。
3.4、构建环境
3.5、构建
打包并发布到蒲公英
这里用到了fastlane来打包,fastlane是一套自动化打包的工具集,用 Ruby 写的,用于 iOS 和 Android 的自动化打包和发布等工作。gym是其中的打包命令。
fastlane 的官网看这里, fastlane 的 github 看这里
安装fastlane
使用Homebrew安装:
$ brew cask install fastlane
或者Rubygems安装:
$ sudo gem install fastlane -NV
或者
$ sudo gem install fastlane --verbose
具体构建脚本如下
# 构建
#!/bin/bash -l
export LANG="en_US.UTF-8"
export LANGUAGE="en_US.UTF-8"
export LC_ALL="en_US.UTF-8"
pod install --verbose --no-repo-update
# 打包环境 (核心)
#config="Release"
config="Debug"
# 导出安装包方式
#export_method="app-store"
#export_method="ad-hoc"
export_method="development"
#export_method="enterprise"
# ipa 包名
ipa_name="xxx"
#指定ipa输出地址
ipa_path="${WORKSPACE}/build/products"
fastlane gym --workspace Project.xcworkspace --scheme Project --clean --configuration ${config} --export_method ${export_method} --output_name ${ipa_name} --output_directory ${ipa_path}
echo "===上传至蒲公英平台==="
# 蒲公英userkey
pgyerUserKey="xxx"
# 蒲公英apiKey
pgyerApiKey="xxx"
# 更新版本
buildUpdateDescription="测试环境"
# 安装类型 2:密码安装,3:邀请安装
buildInstallType="2"
# 安装密码
buildPassword="xxx"
#open ${ipa_path}
packageTime="打包时间:【`date \"+%Y-%m-%d %H:%M:%S\"`】---"
echo $packageTime
echo "===开始上传蒲公英平台==="
if [ -e ${ipa_path}/${ipa_name}.ipa ]; then
RESULT=$(curl -F "_api_key=${pgyerApiKey}" \
-F "buildInstallType=${buildInstallType}" \
-F "buildPassword=${buildPassword}" \
-F "buildUpdateDescription=${buildUpdateDescription}" \
-F "file=@${ipa_path}/${ipa_name}.ipa" \
https://www.pgyer.com/apiv2/app/upload)
echo ${RESULT}
if [ "${RESULT}" ]; then
echo "===上传蒲公英平台成功==="
# 打包结果同步到钉钉群
curl 'https://oapi.dingtalk.com/robot/send?access_token=xxx' \
-H 'Content-Type: application/json' \
-d '{"msgtype": "text",
"text": {
"content": "xxx iOS App更新(测试环境) \n\n下载地址:https://www.pgyer.com/xxx \n安装密码:xxx"
}
}'
else
echo "===上传蒲公英平台失败==="
# 打包结果同步到钉钉群,失败自动@相关负责人
curl 'https://oapi.dingtalk.com/robot/send?access_token=xxx' \
-H 'Content-Type: application/json' \
-d '{"msgtype": "text",
"text": {
"content": "xxx iOS App(测试环境),打包失败 \n上传蒲公英平台失败"
},
"at": {
"atMobiles": [
"18000000000"
],
"isAtAll": false
}
}'
fi
else
echo "===上传蒲公英平台失败==="
# 打包结果同步到钉钉群,失败自动@相关负责人
curl 'https://oapi.dingtalk.com/robot/send?access_token=xxx' \
-H 'Content-Type: application/json' \
-d '{"msgtype": "text",
"text": {
"content": " xxx iOS App(测试环境),打包失败 \n上传蒲公英平台失败"
},
"at": {
"atMobiles": [
"18000000000"
],
"isAtAll": false
}
}'
fi
# xcode中archive路径
#archive_path="/Users/wpapp/Library/Developer/Xcode/Archives"
#echo "===移除Xcode中Archives记录==="
# 删除Archives文件夹
#rm -r $archive_path
# 清空Archives文件夹中的文件,保留Archives文件夹
#rm -rf $archive_path/*
# 判断Archives文件夹是否为空
#if [ "`ls -A ${archive_path}`" = "" ];
#then
# echo "Archive记录清除成功"
#else
# echo "Archive记录清除失败"
#fi
注意:上传蒲公英的API有两个,分别是API 1.0、API 2.0。API 1.0蒲公英已不再维护,此处选择用API 2.0上传。必填参数一定要填,前段时间蒲公英出现系统技术失误后,安装密码有选填变成了必填。
两种API的具体参数,请参考 API 1.0、 API 2.0
IPA包上传蒲公英,此处采用的是脚本,也可以用Jenkins集成的蒲公英上传插件
蒲公英上传的API,上面有描述,这里不再赘述。
配置钉钉群通知
使用 Webhook 地址,向钉钉群推送消息。
操作步骤:钉钉群设置-智能群助手-添加机器人,选择自定义机器人,如图:
配置机器人:
安全设置目前有3种方式:
(1)方式一,自定义关键词
最多可以设置10个关键词,消息中至少包含其中1个关键词才可以发送成功。
例如:添加了一个自定义关键词:监控报警
则这个机器人所发送的消息,必须包含 监控报警 这个词,才能发送成功。
(2)方式二,加签
第一步,把timestamp+"\n"+密钥当做签名字符串,使用HmacSHA256算法计算签名,然后进行Base64 encode,最后再把签名参数再进行urlEncode,得到最终的签名(需要使用UTF-8字符集)。
第二步,把 timestamp和第一步得到的签名值拼接到URL中。
(3)方式三,IP地址(段)
设定后,只有来自IP地址范围内的请求才会被正常处理。支持两种设置方式:IP、IP段,暂不支持IPv6地址白名单,格式如下:
注意:安全设置的上述三种方式,需要至少设置其中一种,以进行安全保护。校验不通过的消息将会发送失败,错误如下:
// 消息内容中不包含任何关键词
{
"errcode":310000,
"errmsg":"keywords not in content"
}
// timestamp 无效
{
"errcode":310000,
"errmsg":"invalid timestamp"
}
// 签名不匹配
{
"errcode":310000,
"errmsg":"sign not match"
}
// IP地址不在白名单
{
"errcode":310000,
"errmsg":"ip X.X.X.X not in whitelist"
}
此处选用方式一,自定义关键词来进行配置
钉钉群通知,详细配置请查看文档
构建成功效果图
状态集:
控制台输出:
钉钉群通知
问题记录
问题1:
Unable to locate Xcode. Please make sure to have Xcode installed on your machine
解决方法:
在Xcode中没有设置“Command Line Tools”:打开Xcode偏好设置,选择"Location"选项卡,选择相应的“Command Line Tools”即可
问题2:
Alternatively you can provide the provisioning profile mapping manually
解决方法:
先在xcode上archive一次包,把证书更新下来,就OK了。原因:通过xcode管理证书,并未把所有证书同步到本地,archive导出IPA的时候,会同步打包所需的证书到本地。
问题三:
构建成功,钉钉却收不到通知
解决方法:
钉钉机器人安全配置,选用自定义关键词,钉钉通知脚本中,通知内容未包含关键词,导致构建成功,钉钉群却收不到通知。
至此,iOS持续集成结束。
总结
iOS持续集成,更多在于对Slave(奴隶)服务器/从节点的理解,在从节点上建一个Jenkins工作目录,这个目录Jenkins必须要有读写的权限,之前在这里吃了亏,配了Linux服务器(主节点)Jenkins的工作目录,导致代码没拉到Mac上,没法构建。构建的时候一定要先解锁keychain,再构建。
下一篇:Android 持续集成(Jenkins+Gradle+360加固+蒲公英+钉钉群通知)