Postman +Newman+Jenkins+钉钉 实现持续集成的接口自动化

本文已被51测试网收录:https://mp.weixin.qq.com/s/j1OZOiqmYQ5Yc2hFZrTP8g

目录

一、<a href="#1">postman 基础知识 </a>
二、<a href="#2">postman 变量与集合</a>
三、<a href="#3">postman 脚本应用(sandbox)</a>
四、<a href="#4">postman 接口自动化实现</a>
五、<a href="#5">postman 与第三方框架结合</a>
六、<a href="#6">实战演练(合同系统)</a>

<a name ="1" id="1">

一、postman 基础知识

文档:官方文档
工具:下载页面

1. postman 版本选择

postman分为chrome插件版和native版本,插件版的有很多功能都受限制:
比如native必须要安装扩展才可以操作cookie,headers设置受限制,
没有native版本的Postman console,非常不方便调试

2.为什么选择postman作为自动化框架

优点: 门槛低,上手快,界面操作简洁方便
优点: 使用js语言编写脚本,语法简单
优点: 自带各种代码模块,按需使用即可
优点: 自动化框架有命令行版本:newman,方便放在服务器上运行,做持续集成
优点: 支持抓包,保存历史记录,多终端,多用户同步测试用例
优点: 支持读取数据文件,json,csv
优点: 如果项目有Swagger生成API文档,JSON文件可以直接导入Postman来生成用例

不支持:通过url搜索用例,通过命令行传参修改环境变量,不能指定执行失败的测试用例
不理想:不能操作文件相关的操作,不能读写数据库,不能使用非HTTP协议
不理想:不方便调试自动化代码。

3. 账号和数据同步

用户免费注册账号后可以获得以下权限:
①同步和备份历史、集合、环境、与指头
②轻松处理来自不同机器的postman实例


image.png

4. 发送请求

强调点:需要发送上传文件的请求,在body中选择选择form-data ,选择File选项后即可选择文件


image.png

强调点:设置请求头和管理请求头


image.png

5. 代理抓包

由于postman不是类似fiddle这种专门用于抓包的软件,所以需要手动打开代理设置
①点击右上角的拦截图标,打开【Capture requests】,设置Port和Target

image.png

②打开浏览器的代理设置,设置相同端口


image.png

手机端设置方法:https://learning.getpostman.com/docs/postman/sending_api_requests/capturing_http_requests

6. postman 控制台

打开左下角打开【postman console】控制台,方便查看接口调试的打印信息


image.png

<a name ="2" id="2">

二、postman 变量与集合

1. 变量

为什么要使用变量,如果某个参数值只需要在某个独立接口的使用一次,那么我们可以不使用变量,但是如果变量需要在多个位置重复使用,或者发生接口传递(即前一个接口的返回值用于下一个接口的请求参数),那么借助变量,postman就可以实现业务逻辑与测试数据分离,帮助我们建立健壮的测试用例。

2. 变量作用域:

全局变量(Global):主要用于需要在多个位置重复使用的几乎不改变的数据
环境变量(environment):主要用于接口传递的参数
局部变量(local):集合/文件/接口中 某个js脚本中的变量
数据变量(data):主要用于并发测试(json/csv文件)

同变量名的情况下,优先级范围:局部变量> 环境变量> 全局变量

3 . 设置变量:

① 在postman的ui上进行定义


image.png
image.png

② 使用脚本定义 pm.environment.set("new_name", "zhougang");

image.png

4. 使用变量:

① Builder中的使用:{{varname}}

image.png

② js 脚本中的使用:pm.environment.get("variable_key");

5. 集合

为什么要使用集合?
①组织业务逻辑:分类和存储接口
②方便一键运行:在runner中选择要运行的collection或者里面的文件夹进行运行
③方便导入导出:导出和导入json文件,如使用newman在命令行执行(集合和变量的导出是分开的)
③方便分享:分享至自己团队的共享目录下

image.png
image.png

<a name ="3" id="3">

三、postman 脚本应用(sandbox)

postman支持js语言,它允许用户向请求和集合添加动态行为。通过使用js脚本,可以构建包含动态参数的请求,在请求之间传递数据。用户可以在下面两个事件流中添加js代码。
①在请求发送前,在“pre-request script”选项卡下输入脚本,主要用于设置测试需要的测试参数
②在请求发送后,在“test”选项卡下输入脚本,主要用于做断言


image.png
image.png

③右边会有自带各种代码模块,按需使用即可,常用示例如下:

/** test示例 */
var jsonData = pm.response.json();
pm.test("操作是否成功", function () {
    pm.expect(jsonData.code).to.eql(1);
});
pm.test("接口返回时间是否超过2s", function () {
    pm.expect(pm.response.responseTime).to.be.below(2000);
});

tests["名称是否正确"] = jsonData.data.name === pm.environment.get("customer_contract_name");
tests["管理人是否正确"] = jsonData.data.manage_user  === pm.environment.get("admin_user_name");
tests["组织是否正确"] = jsonData.data.manage_org_name  === pm.environment.get("org_name");

pm.environment.set("variable_key", "variable_value");
//使用变量{{variable_key}}

如果这里没有你需要的,可以查看帮助文档
https://learning.getpostman.com/docs/postman/scripts/postman_sandbox_api_reference/

image.png

image.png

用户可以将与请求和测试脚本添加到一个集合,一个文件,一个请求中
优先级:请求>文件>集合

<a name ="4" id="4">

四、postman 接口自动化实现

1. 使用postman自带的 runner工具

①在runner中选择要运行的collection或者里面的文件夹进行运行
②enviroment:选择用例跑的环境变量集合
③iterations:接口迭代次数(接口自动化 默认使用1就行,1以上一般拿来做并发测试)
④delay:每个接口发起请求的的间隔时间(建议200ms)
⑤data:数据文件,可以是json格式的,也可以是csv格式的(一般用于并发测试)
⑤keep variable values: 重点!!!必须要勾上,环境变量将会更新
⑥start run:运行结果集,并查看结果页,可导出

image.png

执行顺序设定(此代码只在runner和Newman中生效):

 postman.setNextRequest('接口名称');// 设定下一请求执行路径

运行结果页:


image.png

2. 使用postman插件:Newman

官方说明文档:https://www.npmjs.com/package/newman(https://www.npmjs.com/package/newman

①首先需要安装node.js环境(同时安装了npm)
下载地址:http://nodejs.cn/download/

image.png

②使用命令行安装 Newman
npm install -g newman
安装导出html报告的包: npm install -g newman-reporter-html

③Newman运行命令脚本,一般只需要指定运行集合、运行环境、间隔时间,数据文件,指定输出报告的模板和位置

原始脚本: newman run xxx.json

添加下述定制化参数:
指定运行环境变量集合: --environment xxx.environment.json
指定输出环境变量集合: --export-environment xxx.environment.json
指定输出报告形式:-r cli,html
指定输出报告文件: --reporter-html-export xxx.htm
指定接口间隔时间: --delay-request 100

进入脚本所在文件目录,运行脚本(保存成脚本文件,直接运行即可)
newman run cms_init.postman_collection.json --environment cms-test.environment.json --export-environment cms-test.environment.json -r cli,html --reporter-html-export ./reports/cms_init_html_output.htm --delay-request 120

运行结果(命令行):


image.png

运行结果(html格式):


image.png

<a name ="5" id="5">

六、postman 与第三方框架结合(维护)

1. 与Git结合 (版本控制)

①将集合的脚本文件导出到目录下
②然后使用相关git命令推送到远程仓库即可

备注:多人协作可同时使用postman的分支管理,更好的维护接口代码


image.png

2. 与jenkins结合 (持续集成)

当我们将代码推送到git上后,可以使用jenkins直接构建任务即可,省去了脚本打包放到对应服务器再启用对应环境脚本的麻烦。
参考链接:https://www.jianshu.com/p/18863c609019
参考链接:https://blog.csdn.net/qq_16510189/article/details/79074809

①下载jenkins的war包,使用java -jar jenkins.war --httpPort=8080启动, 按照配置jenkins完成
②在Jenkins中安装对应的插件,Git、NodeJS 插件
③新建job,配置相关内容
git配置

image.png

定时器配置

image.png

构建环境配置

image.png

构建脚本

image.png

③选择构建,查看控制台


image.png

3. 与钉钉机器人结合

image.png
image.png
image.png
image.png
image.png

<a name ="6" id="6">

六、实战演练

以合同管理系统为例(演示)

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
禁止转载,如需转载请通过简信或评论联系作者。
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,711评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,932评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,770评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,799评论 1 271
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,697评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,069评论 1 276
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,535评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,200评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,353评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,290评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,331评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,020评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,610评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,694评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,927评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,330评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,904评论 2 341

推荐阅读更多精彩内容