項(xiàng)目地址：https://github.com/wangduandu...

功能強(qiáng)大的REST接口測(cè)試工具, Power By Jest, axios, superstruct, mustache, lodash

非常簡(jiǎn)單: 大部分工作量在于寫(xiě)配置文件

請(qǐng)求模板: 可以在配置文件中加入運(yùn)行時(shí)變量，如/users/{{id}}

響應(yīng)體結(jié)構(gòu)驗(yàn)證: 支持對(duì)響應(yīng)體的字段類(lèi)型進(jìn)行嚴(yán)格校驗(yàn)，多字段、少字段、字段類(lèi)型不符合預(yù)期都會(huì)報(bào)錯(cuò)

非常詳細(xì)的報(bào)錯(cuò)提示: 參見(jiàn)截圖

yarn add aester
npm i aester -S

// filename 必須以 test.js結(jié)尾

const Ae = require("aester")
var testData = require("./test-data.js")

// 初始化配置文件
testData = Ae.init(testData)

describe("4XX 5XX error response test", () => {
  test("Get User Info without sessionId", async () => {
    await expect(Ae.send(testData.getOneUser, {id: "1"})).rejects.toHaveProperty("status", 403)
  })

  test("loginByEmail Fail Test", async () => {
    await expect(Ae.send(testData.loginByEmail, {password: "111"})).rejects.toHaveProperty("status", 401)
  })
})

describe("2XX success response test", () => {
  test("loginByEmail Success Test", async () => {
    // 對(duì)于符合預(yù)期的正向測(cè)試，不需要使用expect, 如果響應(yīng)狀態(tài)碼是400以上，或者響應(yīng)體結(jié)構(gòu)不符合預(yù)期，
    // 該測(cè)試用例會(huì)自動(dòng)失敗
    const data = await Ae.send(testData.loginByEmail, {password: "000"})
    Ae.share("sessionId", data.sessionId)
  })

  test("Get User Info", async () => {
    await Ae.send(testData.getOneUser, {id: "1"})
  })
})

describe("2XX success response with error body struct", () => {
  test("StructError test", async () => {
    var data = _.cloneDeep(testData.getOneUser)
    data.resBodyStruct.test = "number" // set a error struct

    await expect(Ae.send(data, {id: "1"})).rejects.toHaveProperty("type", "StructError")
  })
})

// test-data.js
module.exports = {
  $baseUrl: "http://localhost:3000",
  loginByEmail: {
    desc: "login",
    req: {
      method: "post",
      path: "/login",
      headers: { "content-type": "application/x-www-form-urlencoded" },
      data: "[email protected]&password={{password}}",
      params: {
        _test: 1
      }
    },
    resBodyStruct: {
      sessionId: "string"
    }
  },
  getOneUser: {
    desc: "get user info",
    req: {
      path: "/users/{{id}}",
      headers: {
        "sessionId": "{{sessionId}}" // 如果share中有sessionId, 在請(qǐng)求發(fā)送時(shí)，會(huì)自動(dòng)將{{sessionId}}替換成真正的值，否則會(huì)被替換成空字符串
      }
    },
    resBodyStruct: {
      id: "string",
      email: "string",
      password: "string",
      userName: "string",
      likes: "array",
      isAdmin: "boolean"
    }
  },
  createOneUser: {
    desc: "create user",
    req: {
      method: "post",
      path: "/users",
      headers: {
        "sessionId": "{{sessionId}}"
      }
    }
  },
  updateOneUser: {
    desc: "update user",
    req: {
      method: "put",
      path: "/users/{{id}}",
      headers: {
        "sessionId": "{{sessionId}}"
      }
    }
  },
  deleteOneUser: {
    desc: "獲取用戶(hù)信息接口",
    req: {
      method: "delete",
      path: "/users/{{id}}",
      headers: {
        "sessionId": "{{sessionId}}"
      }
    }
  }
}

在package.json加入

  "scripts": {
    "test": "jest"
  }

然后運(yùn)行npm test

yarn add jest-html-reporter -D

然后在package.json中加入如下字段

"test:report": "jest --reporters="jest-html-reporter""

然后運(yùn)行

npm run test:report

創(chuàng)建jest.config.js在項(xiàng)目根目錄

module.exports = {
  verbose: true,
  testEnvironment: "node",
  reporters: [
    "default",
    ["./node_modules/jest-html-reporter", {
      pageTitle: `operation api test ${process.env.testConfigEnv}`,
      includeFailureMsg: true // 詳細(xì)錯(cuò)誤提示
    }]
  ]
}

然后運(yùn)行

npm test

 PASS  test/unit.test.js
 PASS  test/index.test.js

Test Suites: 2 passed, 2 total
Tests:       8 passed, 8 total
Snapshots:   0 total
Time:        1.864s

          "origin": "null",
          "readyState": 4,
          "requestBuffer": null,
          "requestCache": null,
          "responseBuffer": [Buffer],
          "responseCache": null,
          "responseHeaders": [Object],
          "responseTextCache": "Forbidden",
          "responseURL": "http://localhost:3000/users/1",
          "responseXMLCache": null,
          "send": true,
          "status": 403,
          "statusText": "Forbidden",
          "timeoutFn": null,
          "timeoutId": 0,
          "timeoutStart": 0,
          "totalReceivedChunkSize": 9,
          "uploadComplete": true,
          "uploadListener": false,
        },
      },
      "status": 403,
      "statusText": "Forbidden",
    }

      18 | })
      19 |
    > 20 | test("Get User Info", async () => {
         | ^
      21 |   await Ae.send(testData.getOneUser, {id: "1"})
      22 | })
      23 |

      at Env.it (node_modules/jest-jasmine2/build/jasmine_async.js:102:24)
      at Object. (test/index.test.js:20:1)

例如，resBodyStruct配置sessionId為number格式，但是返回的格式是字符串，將會(huì)如下格式的報(bào)錯(cuò)

    TypeError: Expected a value of type `number` for `sessionId` but received `"123456"`.

      60 |       if (conf.resBodyStruct) {
      61 |         let Scheme = struct(conf.resBodyStruct)
    > 62 |         let result = Scheme.validate(res.data)
         |                             ^
      63 |         if (result.length === 1) {
      64 |           reject(result[0])
      65 |         }

      at Function.Struct.validate.value [as validate] (node_modules/superstruct/src/superstruct.js:78:17)
      at src/index.js:62:29

初始化配置文件

const Ae = require("aester")

...
var conf = Ae.init(apiConfs)

發(fā)送請(qǐng)求。

options會(huì)與share合并，然后將對(duì)應(yīng)變量渲染到請(qǐng)求模板中。

const Ae = require("aester")

...
Ae.send(testData.getOneUser, {id: "1"}

設(shè)置共享變量

const Ae = require("aester")

...
var conf = Ae.share("token", "123123")

獲取所有共享變量

const Ae = require("aester")

...
var conf = Ae.getShare() // {token: "123123"}

desc | 否 | 接口說(shuō)明
req | 是 | 請(qǐng)求對(duì)象
req.method | 否 | 請(qǐng)求方法，默認(rèn)get
req.path | 是 | 請(qǐng)求路徑
req.headers | 是 | 默認(rèn)為空對(duì)象，默認(rèn)設(shè)置"content-type": "application/json; charset=UTF-8"
resBodyStruct | 否 | 響應(yīng)體格式校驗(yàn)對(duì)象

resBodyStruct字段說(shuō)明

{
  key: keyType
}

字段類(lèi)型支持如下

any: 任意

number: 數(shù)字

array: 數(shù)組

string: 字符串

boolean： 布爾值

null: null

undefined: undefined

object: 對(duì)象類(lèi)型

在字段類(lèi)型后加上?表示字段是否可選

如：

{
  sessionId: "string?" //sessionId是字符串，但是可以沒(méi)有這個(gè)字段
}

更多字段類(lèi)型驗(yàn)證參考：https://github.com/ianstormta...

npm test