HOWTO: 使用CukeTest进行API自动化测试

进行API自动化测试场景，可供选择的组件有很多，但是CukeTest工具提供了API测试的工具，作为一款基于BDD理念的测试开发工具，CukeTest内置了got库和API测试的工具，这里介绍如何使用内置的API自动化库实现API自动化测试场景。

有关内置API自动化库的说明，可以参考API自动化库-got

API工具的使用

新建项目时选择API Service模版，可以看到简单的API测试DEMO，如下：

新建项目-API模版

该项目使用json-server库基于data.json文件搭建了简单的本地服务，能够使用API进行交互，更多相关的信息可以查看json-server - npm。

模版中各种HTTP请求方法的用法都类似，需要注意的有以下几点：

  1. 请求体body使用的是步骤中格式化出来的数据，这样就可以通过将数据传入到步骤描述中来灵活的控制传入API的数据。

    1.  Given("发送Post请求 {string} 请求数据为 {string} 服务器应该返回结果 {string}", 
    2.  async function (url, data, expectval) {
    3.  let option = {
    4.      "headers": {
    5.          "content-type": "application/json"
    6.      },
    7.      "json": true,
    8.      "body": JSON.parse(data)
    9.  };
    10.  let res = await got.post(url, option);
    11.  });

    右键剧本示例表选择表格文件可以从CSV文件中快速导入数据。

    HOWTO: 使用CukeTest进行API自动化测试 - 图2

  2. 使用Node.js自带的assert库进行API结果校验，将预期结果和实际返回结果进行比较验证，这里选择的是使用JSON.parse()方法将预期结果解析为JSON数据，接着进行比较；

    1.  let res = await got.get(url, option);
    2.  let actual = res.body;
    3.  let expected = JSON.parse(expectval);
    4.  assert.deepEqual(actual, expected);

  3. 使用this.attach()方法将期望的信息显示在运行报告中，这里插入的是字符串，还可以插入图片。

    1. ......
    2. assert.deepEqual(actual, expected);
    3. this.attach(res.body); // 插入这一行

    执行后的报表中显示了attach的结果：

    HOWTO: 使用CukeTest进行API自动化测试 - 图3

有关如何通过attach方法添加数据到报表可以参考附件