Postman pm 对象 - 测试相关功能

pm 对象还提供了测试相关功能:

  • pm.test 函数用来生成一个测试,可以输入测试标题,并加入各种断言。断言全部成功则测试成功,某一个断言失败则测试失败;一个请求可以添加多个测试函数。
  • pm.expect 函数,用来生成各种断言;
  • pm.response 对象中也提供了很多内置的断言语句。

pm.test

pm.test(testName:String, specFunction:Function):Function

这个函数已经在我们之前的文章中出现过很多次了,只是那时候不需要大家深入了解,使用预设的语句就可以了。

与 tests 对象不同,使用 pm.test() 函数编写测试可以准确地命名测试。

即使该函数内部存在错误,该函数也可以确保脚本的其余部分不会被阻塞。

pm.test(testName:String, specFunction:Function) 接收两个参数: testName 用字符串输入一个测试名称,会显示在最终报告上;specFunction 接收一个回调函数,在该回调函数内部运行断言语句。

  pm.test("response should be okay to process", function () {
      pm.response.to.not.be.error;
      pm.response.to.have.jsonBody('');
      pm.response.to.not.have.jsonBody('error');
  });

pm.expect

pm.expect(assertion:*):Function → Assertion

pm.expect 是一个通用的断言函数。这是一个基于 JavaScript BDD 库 ChaiJS 开发的功能。使用 ChaiJS 库,可以很容易地编写语法易读的测试。(BDD 嘛,行为驱动开发,用自然语言的形式描述测试过程,当然易读)所以语法与 ChaiJS 一致。

该函数对于处理来自响应 response 或变量 variables 的数据断言很有用。pm.expect 主要与 pm.test 联用。

expect 是期望的意思,也就是传递给 expect 函数的值是否符合预期。通过一系列的调用链来实现。

常见的用法如:

pm.test("判断包含关系", function(){
    pm.expect('abc').to.include('ab'); // => 断言
});
  • pm.expect()接收一个断言内容(相当于实际结果),可以是任意数据类型;
  • .to 是连接符,用于连接断言与判断;
  • .include() 用于指定断言方式和预期结果。

连接符

.to 一样,expect 还提供了很多连接符,这些连接符并不会对结果造成任何影响,主要目的是让断言语句更符合英文文法。也就是说你随便写都可以。

除了 .to 以外还有如下连接符:

to,be,been,is,that,which,and,has,have,with,at,of,same

断言方式

相等:.equal(value)

  • value:Mixed

断言目标严格等于(===)value。

pm.test("相等", function(){
    pm.expect('100').to.be.equal(100); // => 失败,类型不符
    pm.expect(5.5).to.be.equal(5.5);
});

取非:.not

对之后的断言无条件取反

pm.test("取反", function(){
    pm.expect('nemo').to.not.equal('name');  // => not对后面的断言取反
});

expect(foo).to.not.equal('bar')
expect(goodFn).to.not.throw(Error)
expect({ foo: 'baz'}).to.have.property('foo')
.and.not.equal('bar')

包含:.include(value) / .contains(value)

  • value:Object | String | Number

表示实际结果是否包含预期结果,两个函数用法一致。

pm.test("判断包含关系", function(){
    pm.expect('abc').to.include('ab');
    pm.expect('abc').to.contains('ab');
    pm.expect({name:"Nemo"}).to.contains.keys('name');
});

判断结果是否为真:.ok/.true

断言目标为真值。.true 与 .ok 的区别是不进行类型转换,只能为布尔值 true 才能通过断言。

pm.test("判断结果是否为真", function(){
    pm.expect('nemo').to.be.ok;  // => 字符串有值
    pm.expect(1).to.be.true;  // => 断言失败,1不是布尔值true
    pm.expect(1).to.be.ok;   // 有值为1,断言成功
    pm.expect(false).to.not.be.ok;
    pm.expect(null).to.not.be.true;
});

以上列出了最常用的一些断言方式,如果有兴趣的同学可以查看这位博主的翻译内容《ChaiJS 断言库 API 中文文档》

Response 断言 API

以下是 pm.response 对象内置的断言语句,可以在不使用 expect 函数的情况下直接使用:

  • pm.response.to.have.status(code:Number):判断响应结果是否包含指定的状态码;
  • pm.response.to.have.status(reason:String):判断响应结果是否包含指定的状态描述;
  • pm.response.to.have.header(key:String):判断响应结果是否包含指定的头部字段;
  • pm.response.to.have.header(key:String, optionalValue:String):判断响应结果是否包含指定的头部字段和值;
  • pm.response.to.have.body():判断响应结果是否包含消息体;
  • pm.response.to.have.body(optionalValue:String):判断响应结果是否包含指定的字符串;
  • pm.response.to.have.body(optionalValue:RegExp):判断响应结果是否包含指定的符合正则表达式规则的字符串;
  • pm.response.to.have.jsonBody():判断响应结果是否包含 json 格式的消息体;
  • pm.response.to.have.jsonBody(optionalExpectEqual:Object):判断响应结果是否包含指定对象的 json 格式消息体;
  • pm.response.to.have.jsonBody(optionalExpectPath:String):判断响应结果是否包含指定层级的 json 格式消息体;
  • pm.response.to.have.jsonBody(optionalExpectPath:String, optionalValue:*):判断响应结果是否包含指定路径并且值也匹配的 json 格式消息体;
  • pm.response.to.have.jsonSchema(schema:Object):判断响应结果是否符合指定的 json 结构;schema 参数是以对象形式描述的 json 结构;
  • pm.response.to.have.jsonSchema(schema:Object, ajvOptions:Object):判断响应结果是否符合指定的 json 结构;schema 参数是以对象形式描述的 json 结构并且附加 ajv 库的操作 ;

判断 json 结果示例:

var shema = {
    type: "object", // 类型为对象类型
    properties:{
        "error_code": {type: "number"},  // 包含error_code,类型为number
        "data": {type: "array"} 
    },
    require: ["error_code", "data"] // 结构中必须包含error_code和data
}

pm.test("判断响应体结构是否符合", function(){
    pm.response.to.have.jsonSchema(schema);
});

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

推荐阅读更多精彩内容