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);
});