持续集成(CI)
在日常开发过程中,代码常常会根据业务变更、功能异常等情况发生变化;那么当代码完成后,必不可少的步骤需要将代码部署到服务器端;频繁、重复的部署操作,一方面任何人也不想耗费时间在机械的工作上,另一方面,需要让开发人员更关注业务代码;这样一来,代码部署自动化的需求越来越大,简而言之呢,之前如果修改了一个系统Bug,除了要对业务代码进行修改推送到CVS,还需要部署到服务器上;现在呢,只需要关心您的代码,部署的事情交给另外一台机器帮您完成。回归到Salesforce系统中,目标部署服务器就是具体的Organization,那代码修改完需要自动部署目标Organization中。下面我们来看一下,自动部署是怎样实现与Salesforce建立连接。
JWT配置
持续集成环境是自动化的,不支持Web-Based Flow,不熟悉该流程的同学,参考一下这篇文章Using SalesforceDX(SFDX) without Scratch Org;在这里,需要用到JWT-Based Flow(JSON web tokens),这个流程需要将数字证书上传到自定义的应用中,然后再通过脚本进行服务端认证,简单来说可以分为以下两个阶段:
- 本地创建自签证书、Salesforce端新建Connect app.
- 脚本运行在CI环境中
验证前提
请在开始以下步骤之前安装OpenSSL(Open Secure Sockets Layer),使用以下命令检查环境:
which openSSl
环境没有准备好的话,如果是Mac系统,使用Homebrew进行安装
brew install openssl
Windows请下载安装包。
验证过程
生成server.crt文件
- 新建任意文件夹存储生成的文件,比如我在桌面上创建了testJWT文件夹。
- 生成private key,存储在server.key文件
openssl genrsa -des3 -passout pass:SomePassword -out server.pass.key 2048
openssl rsa -passin pass:SomePassword -in server.pass.key -out server.key
生成server.key
现在testJWT文件夹下有两个文件server.key、server.pass.key,server.pass.key文件不会再用到,可以将其删除。
-3. 生成证书签名,存储在server.csr文件中
openssl req -new -key server.key -out server.csr
生成server.csr
- 根据server.key和 server.csr文件,生成自签名证书。
openssl x509 -req -sha256 -days 365 -in server.csr -signkey server.key -out server.crt
生成server.crt
目前为止,已经生成了JWT所需的证书,下一步新建Connect App的时候会用到。
创建Connect App
在Salesforce中新建Connect App应该是比较熟悉的了,不清楚的话,可以参考一下使用Postman对Salesforce进行接口测试,需要说明一下两点:
- 针对JWT认证方式,需要在新建App过程中,上传server.crt自签名证书。
上传证书
- 针对JWT认证方式,需要在新建App过程中,上传server.crt自签名证书。
- 编辑App的OAuth Policies,修改为Admin approved users are pre-authorized方式
修改认证属性
- 编辑App的OAuth Policies,修改为Admin approved users are pre-authorized方式
随后你可以通过Permission set管理给App分配CI用户,方便起见,这里分配给简档System Administrator的用户。保存App后,需要保存一下Consumer Key,接下来的测试我们需要用到Consumer Key。
连接测试
现在App已经准备好,证书也上传到App,那我们是否能成功的连接到Salesforce呢?
新建的Connect App
通过以下命令测试,尝试建立连接:
export CONSUMER_KEY=3MVG9pe2TCoA1Pf4Sl71bGc3xBuVp.h8zly2rk_4gCeP0whCxrONIcvjPTkmTw3_.H3LNAA_QVIYuONIoXU4o //Connect App Consumer Key value
export JWT_KEY_FILE=/Users/bubba/Desktop/testJWT/server.key
export HUB_USERNAME=lj1377736@brave-bear-p3qvk9.com
sfdx force:auth:jwt:grant --clientid ${CONSUMER_KEY} --username ${HUB_USERNAME} --jwtkeyfile ${JWT_KEY_FILE} --instanceurl https://brave-bear-p3qvk9-dev-ed.my.salesforce.com -a testJWT
如果能看到以下截图内容,说明已经成功连接到了Salesforce,也可以通过sfdx force:org:list命令来查看已认证的Organization.
下一步
相信您已利用JWT成功的建立了与Salesforce的连接,接下来还需要结合自动化部署工具(Travis、Jenkins)运行到项目中,提供两个资源模板供大家参考:
通过简单的配置脚本,让项目做到自动化部署,就可以节省开发人员时间,避免繁琐的操作。
网友评论