使用 Jest 和 Supertest 进行接口端点测试实例详解


Posted in Javascript onApril 25, 2020

本文实例讲述了使用 Jest 和 Supertest 进行接口端点测试。分享给大家供大家参考,具体如下:

如何创建测试是一件困难的事。网络上有许多关于测试的文章,却从来不告诉你他们是如何开始创建测试的。

所以,今天我将分享我在实际工作中是如何从头开始创建测试的。希望能够对你提供一些灵感。

目录:

  • 使用 Express 创建一个应用
  • 使用 Mongoose 链接 MongoDB
  • 使用 Jest 作为测试框架

为什么使用 Jest

  • 易于使用
  • wath-mode 非常棒

开始使用 Jest
首先,你需要安装它:

npm install jest --save-dev

接着,将测试启动脚本添加到package.json中:

"scripts": {
 "test": "jest",
 "test:watch": "jest --watch"
},

添加testtest:watch是非常有用的,前者是一次性测试,而后者开始了 watch 模式。

使用以下任意方法,Jest 就能识别哪些是测试文件:

    1. 位于 tests 文件夹下的所有 js 文件
    1. 文件名以 test.js 结尾的文件,譬如 user.test.js
    1. 文件名以 spec.js 结尾的文件,譬如 user.spec.js

你可以把它们放在任何位置。但我总是把测试文件和接口放在一起,这有利于维护管理。

- routes
 |- users/
  |- index.js
  |- users.test.js

编写你的第一个测试
Jest 包含了descibe,it,expect,你不必在每个测试文件内 require 它们。

  • describe 用来组织文件中的测试项
  • it 用来运行测试用例
  • expect 用于执行断言,当所有断言通过时,该测试才会通过

举一个测试失败的栗子。在该例中我 expect 1 应该严格等于 2。但由于 1 !== 2,所以测试失败。

it('Testing to see if Jest works', () => {
 expect(1).toBe(2)
})

如果运行测试,你会看到错误信息。

npm run test:watch

使用 Jest 和 Supertest 进行接口端点测试实例详解

更改测试用例使得测试通过:

it('Testing to see if Jest works', () => {
 expect(1).toBe(1)
})

使用 Jest 和 Supertest 进行接口端点测试实例详解

虽然已经包含了使用 Jest 进行测试的大部分内容,但却没啥卵用,因为实际工作中的测试比这复杂多了。

异步测试
你需要发送请求来测试接口。请求是异步的,这意味着你必须能够编写异步测试用例。

使用 Jest 编写异步测试非常容易,仅仅需要两步:

    1. 添加 async 关键字
    1. 在测试的最后一步,调用 done

就像这样:

it('Async test', async done => {
 // 其他逻辑
 
 done()
})

测试接口
可以选择 Supertest 来测试接口。我们先安装 Supertest。

npm install supertest --save-dev

在测试接口之前,需要设置下 server,以便 Supertest 在测试中使用它。

大多数教程都告诉你,在 server 文件中监听 Express 应用端口,像这样:

const express = require('express')
const app = express()

// Middlewares...
// Routes...

app.listen(3000)

这有个潜在问题,当你编写了多个测试文件,运行测试时,会产生"port in use"的错误。

如果想要在每个测试文件都启动一个新的服务,你需要导出一个没有监听端口的 app。

const express = require('express')
const app = express()

// Middlewares...
// Routes...

module.exports = app

为了使应用正常工作,需要在另一个文件(比如 start.js)内监听 app.

// start.js
const app = require('./server.js)
app.listen(3000)

使用 Supertest
在测试文件内导入 app 和 supertest 来测试接口。

const app = require('./server') // Link to your server file
const supertest = require('supertest')
const request = supertest(app)

现在,你可以在测试文件中发送 GET,POST,PUT,PATCH 和 DELETE 请求了。在发送请求之前我们需要一个接口(端点)。譬如我们的应用有一个 /test 接口,它返回一个 JSON。

app.get('/test', async (req, res) => {
 res.json({message: 'pass!'})
})

使用 Supertest 的 .get 方法,向 /test 发送一个 GET 请求:

it('Gets the test endpoint', async done => {
 // 发送 GET 请求到应用的 /test 接口
 const res = request.get('/test')

 // ...
 done()
})

Supertest 从接口处获取响应结果。你可以测试 HTTP 状态码和响应体:

it('gets the test endpoint', async done => {
 const response = await request.get('/test')

 expect(response.status).toBe(200)
 expect(response.body.message).toBe('pass!')
 done()
})

使用 Jest 和 Supertest 进行接口端点测试实例详解

接下来,我会向你展示如何发送 POST 请求,怎样在测试文件内连接 Mongoose。

译自:https://zellwk.com/blog/endpoint-testing/?ck_subscriber_id=313113699

感兴趣的朋友可以使用在线HTML/CSS/JavaScript代码运行工具:http://tools.3water.com/code/HtmlJsRun测试上述代码运行效果。

更多关于JavaScript相关内容可查看本站专题:《JavaScript常用函数技巧汇总》、《javascript面向对象入门教程》、《JavaScript错误与调试技巧总结》、《JavaScript数据结构与算法技巧总结》及《JavaScript数学运算用法总结》

希望本文所述对大家JavaScript程序设计有所帮助。

Javascript 相关文章推荐
Linux下使用jq友好的打印JSON技巧分享
Nov 18 Javascript
javascript原型链继承用法实例分析
Jan 28 Javascript
AngularJS基础 ng-keydown 指令简单示例
Aug 02 Javascript
js生成随机数方法和实例
Jan 17 Javascript
Angular中使用$watch监听object属性值的变化(详解)
Apr 24 Javascript
在vue中使用jointjs的方法
Mar 24 Javascript
js捆绑TypeScript声明文件的方法教程
Apr 13 Javascript
JavaScript 中的 this 工作原理
Jun 20 Javascript
jQuery使用each遍历循环的方法
Sep 19 jQuery
JQuery搜索框自动补全(模糊匹配)功能实现示例
Jan 08 jQuery
解决node.js含有%百分号时发送get请求时浏览器地址自动编码的问题
Nov 20 Javascript
Javascript节流函数throttle和防抖函数debounce
Dec 03 Javascript
javascript 函数的暂停和恢复实例详解
Apr 25 #Javascript
详解ES6 CLASS在微信小程序中的应用实例
Apr 24 #Javascript
Vue中函数防抖节流的理解及应用实现
Apr 24 #Javascript
vue 路由懒加载中给 Webpack Chunks 命名的方法
Apr 24 #Javascript
vue中使用带隐藏文本信息的图片、图片水印的方法
Apr 24 #Javascript
基于Vue实现微前端的示例代码
Apr 24 #Javascript
Vue通过getAction的finally来最大程度避免影响主数据呈现问题
Apr 24 #Javascript
You might like
基于数据库的在线人数,日访问量等统计
2006/10/09 PHP
PHP投票系统防刷票判断流程分析
2012/02/04 PHP
php自定义函数转换html标签示例
2016/09/29 PHP
使用laravel指定日志文件记录任意日志
2019/10/17 PHP
JavaScript实现添加及删除事件的方法小结
2015/08/04 Javascript
jQuery进行组件开发完整实例
2015/12/15 Javascript
JS+Canvas 实现下雨下雪效果
2016/05/18 Javascript
AngularJS 中的Promise --- $q服务详解
2016/09/14 Javascript
jQuery源码分析之sizzle选择器详解
2017/02/13 Javascript
详解Vue.js项目API、Router配置拆分实践
2018/03/16 Javascript
vue异步加载高德地图的实现
2018/06/19 Javascript
vue2.0 如何在hash模式下实现微信分享
2019/01/22 Javascript
详解用JS添加和删除class类名
2019/03/25 Javascript
基于mpvue小程序使用echarts画折线图的方法示例
2019/04/24 Javascript
vue-router源码之history类的浅析
2019/05/21 Javascript
如何在Python中编写并发程序
2016/02/27 Python
Python实现购物车功能的方法分析
2017/11/10 Python
Python基于Flask框架配置依赖包信息的项目迁移部署
2018/03/02 Python
ubuntu系统下使用pm2设置nodejs开机自启动的方法
2018/05/12 NodeJs
python 读取目录下csv文件并绘制曲线v111的方法
2018/07/06 Python
Windows下安装Scrapy
2018/10/17 Python
pycharm在调试python时执行其他语句的方法
2018/11/29 Python
Flask模板引擎之Jinja2语法介绍
2019/06/26 Python
opencv resize图片为正方形尺寸的实现方法
2019/12/26 Python
详解Python实现进度条的4种方式
2020/01/15 Python
Python 安装 virturalenv 虚拟环境的教程详解
2020/02/21 Python
Python xlwt模块使用代码实例
2020/06/10 Python
颁奖晚会主持词
2014/03/25 职场文书
个人承诺书
2014/03/26 职场文书
保护动物的标语
2014/06/11 职场文书
活动费用申请报告
2015/05/15 职场文书
人与自然观后感
2015/06/16 职场文书
环保建议书范文
2015/09/14 职场文书
解决Swagger2返回map复杂结构不能解析的问题
2021/07/02 Java/Android
SQL Server数据库查询出现阻塞之性能调优
2022/04/10 SQL Server
速龙x4-860k处理器相当于i几
2022/04/20 数码科技