快捷導(dǎo)航

使用 Jest 和 Supertest 進(jìn)行接口端點(diǎn)測試實(shí)例詳解

更新時間：2020年04月25日 10:11:36 作者：廖飛銀

這篇文章主要介紹了使用 Jest 和 Supertest 進(jìn)行接口端點(diǎn)測試,結(jié)合實(shí)例形式詳細(xì)分析了使用 Jest 和 Supertest 進(jìn)行接口端點(diǎn)測試具體原理、操作技巧與相關(guān)注意事項(xiàng),需要的朋友可以參考下

本文實(shí)例講述了使用 Jest 和 Supertest 進(jìn)行接口端點(diǎn)測試。分享給大家供大家參考，具體如下：

如何創(chuàng)建測試是一件困難的事。網(wǎng)絡(luò)上有許多關(guān)于測試的文章，卻從來不告訴你他們是如何開始創(chuàng)建測試的。

所以，今天我將分享我在實(shí)際工作中是如何從頭開始創(chuàng)建測試的。希望能夠?qū)δ闾峁┮恍╈`感。

目錄：

使用 Express 創(chuàng)建一個應(yīng)用
使用 Mongoose 鏈接 MongoDB
使用 Jest 作為測試框架

為什么使用 Jest

易于使用
wath-mode 非常棒

開始使用 Jest
首先，你需要安裝它：

npm install jest --save-dev

接著，將測試啟動腳本添加到package.json中：

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

添加test和test:watch是非常有用的，前者是一次性測試，而后者開始了 watch 模式。

使用以下任意方法，Jest 就能識別哪些是測試文件：

1. 位于 tests 文件夾下的所有 js 文件
1. 文件名以 test.js 結(jié)尾的文件，譬如 user.test.js
1. 文件名以 spec.js 結(jié)尾的文件，譬如 user.spec.js

你可以把它們放在任何位置。但我總是把測試文件和接口放在一起，這有利于維護(hù)管理。

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

編寫你的第一個測試
Jest 包含了descibe,it,expect，你不必在每個測試文件內(nèi) require 它們。

describe 用來組織文件中的測試項(xiàng)
it 用來運(yùn)行測試用例
expect 用于執(zhí)行斷言，當(dāng)所有斷言通過時，該測試才會通過

舉一個測試失敗的栗子。在該例中我 expect 1 應(yīng)該嚴(yán)格等于 2。但由于 1 !== 2，所以測試失敗。

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

如果運(yùn)行測試，你會看到錯誤信息。

npm run test:watch

更改測試用例使得測試通過：

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

雖然已經(jīng)包含了使用 Jest 進(jìn)行測試的大部分內(nèi)容，但卻沒啥卵用，因?yàn)閷?shí)際工作中的測試比這復(fù)雜多了。

異步測試
你需要發(fā)送請求來測試接口。請求是異步的，這意味著你必須能夠編寫異步測試用例。

使用 Jest 編寫異步測試非常容易，僅僅需要兩步：

1. 添加 async 關(guān)鍵字
1. 在測試的最后一步，調(diào)用 done

就像這樣：

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

測試接口
可以選擇 Supertest 來測試接口。我們先安裝 Supertest。

npm install supertest --save-dev

在測試接口之前，需要設(shè)置下 server，以便 Supertest 在測試中使用它。

大多數(shù)教程都告訴你，在 server 文件中監(jiān)聽 Express 應(yīng)用端口，像這樣：

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

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

app.listen(3000)

這有個潛在問題，當(dāng)你編寫了多個測試文件，運(yùn)行測試時，會產(chǎn)生"port in use"的錯誤。

如果想要在每個測試文件都啟動一個新的服務(wù)，你需要導(dǎo)出一個沒有監(jiān)聽端口的 app。

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

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

module.exports = app

為了使應(yīng)用正常工作，需要在另一個文件(比如 start.js)內(nèi)監(jiān)聽 app.

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

使用 Supertest
在測試文件內(nèi)導(dǎo)入 app 和 supertest 來測試接口。

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

現(xiàn)在，你可以在測試文件中發(fā)送 GET,POST,PUT,PATCH 和 DELETE 請求了。在發(fā)送請求之前我們需要一個接口（端點(diǎn)）。譬如我們的應(yīng)用有一個 /test 接口，它返回一個 JSON。

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

使用 Supertest 的 .get 方法，向 /test 發(fā)送一個 GET 請求：

it('Gets the test endpoint', async done => {
 // 發(fā)送 GET 請求到應(yīng)用的 /test 接口
 const res = request.get('/test')

 // ...
 done()
})

Supertest 從接口處獲取響應(yīng)結(jié)果。你可以測試 HTTP 狀態(tài)碼和響應(yīng)體：

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()
})