Postman 实用接口测试系列 3 - 写测试

前面两个章节 [Postman 实用接口测试系列 1 - 基础] 和 [Postman 实用接口测试系列 2 - 接口依赖] 我们介绍了postman的具体使用和如何处理接口依赖。今天要介绍的是如果写测试用例。 这一部分就和我们测试童鞋更息息相关了。

大纲：

* 测试用例编写的3A原则
* 脚本类型
* 如何编写脚本

1 测试用例编写的3A原则

接口测试简单的说就是创建一个请求，发送请求，然后判断请求的结果是否是期望的。

对于测试用例的编写可以参考3A原则：

• Arrange：准备先决条件和输入，比如查询的接口，之前需要准备一些数据用于查询。
• Act：调用接口，发送请求
• Assert：验证结果

对应的postman的模块如下图：

我们接下来的就会分别讲解这个几个模块的内容。

2 脚本类型

pre-request和test脚本有三种类型：

• collection 级别的脚本
• folder 级别的脚本
• request 级别的脚本

对于pre-request和test脚本执行顺序都是： collection > folder > request， 如下图

当然如果你只有一个请求，pre-request 和 test脚本都在这个请求上，那它的顺序就简单多了。

不同层级的脚本，可以实现脚本的复用，比如同一个collection下的脚本，我们都有一个共同的test是判断返回结果是200，那这个test就可以写在collection的脚本里。然后request只需要写自己特殊的test。

3 如何编写脚本

首先使用的语言是Javascript，我们在脚本中可以使用的几个主要模块有。

• pm.response ： 可以获得返回的结果
• pm.test 定义测试用例，用例名字，方法，方法返回一个 true/false 的布尔值，来判断用例pass还是fail。
• pm.expect 来做断言

3.1 常用的可以作为断言的方法：

• 包含

//数组
pm.expect([1, 2, 3]).to.include(2);
//json
pm.expect({a: 1, b: 2, c: 3}).to.include({a: 1, b: 2});
//先判断类型更好
pm.expect([1, 2, 3]).to.be.an('array').that.includes(2);
//判断返回的response body 是否含有某个字符串
pm.expect(pm.response.text()).to.include("string_you_want_to_search");
//判断是否含有子串
pm.expect('foobar').to.have.string('bar');
//判断是否包含某个jsonBody
pm.response.to.have.jsonBody("");
//判断是否不包含某个jsonBody
pm.response.to.not.have.jsonBody("error");

• 相等

//判断环境
pm.expect(pm.environment.get("env")).to.equal("production");
//判断返回的response body 是否等于某个字符串
pm.response.to.have.body("response_body_string");
//判断返回的json内容
var jsonData = pm.response.json();
pm.expect(jsonData.value).to.eql(100);
//判断两个数组里元素是否相同
pm.expect([1, 2, 3]).to.have.members([2, 1, 3]);
//判断返回状态码是否是201，202中一个
pm.expect(pm.response.code).to.be.oneOf([201,202]);

• 判断是否为空

expect([]).to.be.empty
pm.expect('').to.be.empty;
//先判断类型，然后判断是否为空
pm.expect([]).to.be.an('array').that.is.empty;

• 判断类型

//判断类型是否是string，object或者undefined
pm.expect('Postman').to.be.a('string');
pm.expect({a: 1}).to.be.an('object');
pm.expect(undefined).to.be.an('undefined');

• 其他

//判断响应时长是否低于200ms
pm.expect(pm.response.responseTime).to.be.below(200);
//判断长度
pm.expect('foo').to.have.lengthOf(3);
//判断个数
pm.expect([1, 2, 3]).to.have.lengthOf(2);
//判断response
pm.response.to.not.be.error;
pm.response.to.be.ok;
pm.response.to.be.withBody;
pm.response.to.be.json;

//判断Content-Type是否出现
pm.response.to.have.header("Content-Type");
//判断返回状态码是否是200
pm.response.to.have.status(200);
//返回状态码是否含有某个字符串
pm.response.to.have.status("Created")

//把xml body转成JSON
var jsonObject = xml2Json(responseBody);

//发送异步请求
pm.sendRequest("https://postman-echo.com/get", function (err, response) {
    console.log(response.json());
});

• keys的判断

//是否含有集合里的所有的key
pm.expect({a: 1, b: 2}).to.have.all.keys('a', 'b');
//是否含有一个集合中的某个key
pm.expect({a: 1, b: 2}).to.have.any.keys('a', 'b');
//是否不含集合中的任何key
pm.expect({a: 1, b: 2}).to.not.have.any.keys('c', 'd');
//先判断类型，再判断keys
pm.expect({a: 1, b: 2}).to.be.an('object').that.has.all.keys('a', 'b');

小技巧，一般在做断言之前先使用.a先来判断类型效果更好

特殊情况：

1.判断整个返回的json数据是对的，可以使用JSON.stringify把json变成string，然后对比，如下代码

var expected_json = JSON.stringify({"id":1480,"cId":"cxy","pcc":null})

pm.test("check whole json data", function() {
    pm.expect(pm.response.text()).to.include(expected_json);
})

2.判断返回的json数据是根据response动态变化的 ， 比如下面的代码，把id从response提取出来，然后在JSON.stringify中的json中，直接使用。

var data = pm.response.json();
var id = data.id

var expected_json = JSON.stringify({"id":id,"cId":"cxy","pcc":null})

pm.test("check whole json data", function() {
    pm.expect(pm.response.text()).to.include(expected_json);
})

3.设置结果为失败

pm.expect.fail();

3.2 编写脚本示例

我们这里写一个简单的单个请求的Test。判断返回状态码是否是200，某个参数的值是否是对的

• 在请求下面的tests里加入脚本
  
• 点击send，在跑完request请求后，就会开始跑tests里脚本
• 在test results 里能看到跑的结果
  
• 如果需要看更详细的信息debug的话，可以通过点击view->show postman console
  

参考：https://learning.postman.com/...