使用 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 相关文章推荐
图解JavaScript中的this关键字
May 28 Javascript
jQuery中ajax的load()与post()方法实例详解
Jan 05 Javascript
jQuery Select下拉框操作小结(推荐)
Jul 22 Javascript
基于Vue.js实现数字拼图游戏
Aug 02 Javascript
学习掌握JavaScript中this的使用技巧
Aug 29 Javascript
详解tween.js的使用教程
Sep 14 Javascript
移动web开发之touch事件实例详解
Jan 17 Javascript
图片文字识别(OCR)插件Ocrad.js教程
Nov 26 Javascript
Javascript的this详解
Mar 23 Javascript
p5.js实现简单货车运动动画
Oct 23 Javascript
基于vue.js仿淘宝收货地址并设置默认地址的案例分析
Aug 20 Javascript
Vue Object.defineProperty及ProxyVue实现双向数据绑定
Sep 02 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
深入了解php4(2)--重访过去
2006/10/09 PHP
探讨php中header的用法详解
2013/06/07 PHP
php 批量生成html,txt文件的实现代码
2013/06/26 PHP
神盾加密解密教程(二)PHP 神盾解密
2014/06/08 PHP
pjblog中的UBBCode.js
2007/04/25 Javascript
发布BlueShow v1.0 图片浏览器(类似lightbox)blueshow.js 打包下载
2007/07/21 Javascript
基于jquery实现的鼠标拖拽元素复制并写入效果
2011/08/23 Javascript
jQuery+jRange实现滑动选取数值范围特效
2015/03/14 Javascript
jquery中$each()方法的使用指南
2015/04/30 Javascript
Angular1.x复杂指令实例详解
2017/03/01 Javascript
jQuery之动画ajax事件(实例讲解)
2017/07/18 jQuery
import与export在node.js中的使用详解
2017/09/28 Javascript
Bootstrap popover 实现鼠标移入移除显示隐藏功能方法
2018/01/24 Javascript
微信小程序页面生命周期详解
2018/01/31 Javascript
详解ajax的data参数错误导致页面崩溃
2018/04/30 Javascript
vue + webpack如何绕过QQ音乐接口对host的验证详解
2018/07/01 Javascript
基于vue中keep-alive缓存问题的解决方法
2018/09/21 Javascript
在React项目中使用Eslint代码检查工具及常见问题
2018/10/10 Javascript
JavaScript惰性求值的一种实现方法示例
2019/01/11 Javascript
如何在vue里面优雅的解决跨域(路由冲突问题)
2019/01/20 Javascript
elementUI select组件使用及注意事项详解
2019/05/29 Javascript
[51:26]DOTA2上海特级锦标赛主赛事日 - 2 胜者组第一轮#3Secret VS OG第二局
2016/03/03 DOTA
[01:36]极致酷炫!TI9典藏宝瓶+撼地者至宝展示
2019/06/11 DOTA
详解Python中内置的NotImplemented类型的用法
2015/03/31 Python
kafka-python 获取topic lag值方式
2019/12/23 Python
Django model.py表单设置默认值允许为空的操作
2020/05/19 Python
PyCharm2019 安装和配置教程详解附激活码
2020/07/31 Python
《乡愁》教学反思
2014/02/18 职场文书
GMP办公室主任岗位职责
2014/03/14 职场文书
2014年国庆节活动总结
2014/08/26 职场文书
刑事撤诉申请书
2015/05/18 职场文书
未婚证明格式
2015/06/15 职场文书
小学数学教学随笔
2015/08/14 职场文书
Redis6.0搭建集群Redis-cluster的方法
2021/05/08 Redis
新手入门Jvm-- JVM对象创建与内存分配机制
2021/06/18 Java/Android
nginx请求限制配置方法
2021/07/09 Servers