使用 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 相关文章推荐
9个JavaScript评级/投票插件
Jan 18 Javascript
JavaScript中setAttribute用法介绍
Jul 20 Javascript
JQuery实现DIV其他动画效果的简单实例
Sep 18 Javascript
js仿京东轮播效果 选项卡套选项卡使用
Jan 12 Javascript
jQuery插件ImgAreaSelect实现头像上传预览和裁剪功能实例讲解一
May 26 jQuery
详解Vue微信公众号开发踩坑全记录
Aug 21 Javascript
对于input 框限定输入值为浮点型的js代码
Sep 25 Javascript
微信小程序支付之c#后台实现方法
Oct 19 Javascript
express框架下使用session的方法
Jul 31 Javascript
Vue发布订阅模式实现过程图解
Apr 30 Javascript
多个Vue项目部署到服务器的步骤记录
Oct 22 Javascript
详细聊聊浏览器是如何看闭包的
Nov 11 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
PHP curl模拟浏览器采集阿里巴巴的实现代码
2011/04/20 PHP
php递归创建目录的方法
2015/02/02 PHP
PHP开发中AJAX技术的简单应用
2015/12/11 PHP
让Laravel API永远返回JSON格式响应的方法示例
2018/09/05 PHP
用jQuery简化JavaScript开发分析
2009/02/19 Javascript
JS下高效拼装字符串的几种方法比较与测试代码
2010/04/15 Javascript
关于hashchangebroker和statehashable的补充文档
2011/08/08 Javascript
JavaScript判断DOM何时加载完毕的技巧
2012/11/11 Javascript
浅谈js中的闭包
2015/03/16 Javascript
jQuery实现首页顶部可伸缩广告特效代码
2015/04/15 Javascript
jquery京东商城双11焦点图多图广告特效代码分享
2015/09/06 Javascript
jQuery实现鼠标滑过链接控制图片的滑动展开与隐藏效果
2015/10/28 Javascript
利用纯Vue.js构建Bootstrap组件
2016/11/03 Javascript
jQuery中的deferred使用方法
2017/03/27 jQuery
vue mint-ui 实现省市区街道4级联动示例(仿淘宝京东收货地址4级联动)
2017/10/16 Javascript
jQuery中图片展示插件highslide.js的简单dom
2018/04/22 jQuery
详谈Object.defineProperty 及实现数据双向绑定
2020/07/18 Javascript
9种python web 程序的部署方式小结
2014/06/30 Python
python端口扫描系统实现方法
2014/11/19 Python
Pyhton中单行和多行注释的使用方法及规范
2016/10/11 Python
python基于ID3思想的决策树
2018/01/03 Python
Python基本数据结构之字典类型dict用法分析
2019/06/08 Python
flask 使用 flask_apscheduler 做定时循环任务的实现
2019/12/10 Python
pytorch下大型数据集(大型图片)的导入方式
2020/01/08 Python
django中url映射规则和服务端响应顺序的实现
2020/04/02 Python
python判断变量是否为列表的方法
2020/09/17 Python
秋季开学典礼主持词
2014/03/19 职场文书
毕业班联欢会主持词
2014/03/27 职场文书
保险公司开门红口号
2014/06/21 职场文书
党的群众路线教育实践活动总结报告
2014/07/03 职场文书
夫妻分居协议书范本(有子女版)
2014/11/01 职场文书
幼师个人总结范文
2015/02/28 职场文书
主题班会开场白
2015/06/01 职场文书
党员发展大会主持词
2015/07/03 职场文书
七一表彰大会简报
2015/07/20 职场文书
Oracle使用别名的好处
2022/04/19 Oracle