Fastify

测试

测试是开发应用最重要的一部分。Fastify 处理测试非常灵活并且它兼容绝大多数框架 (例如 Tap。下面的例子都会用这个演示)。

让我们 cd 进入一个全新的 ‘testing-example’ 文件夹，并在终端里输入 npm init -y。

执行 npm install fastify && npm install tap pino-pretty --save-dev。

关注点分离让测试变得轻松

首先，我们将应用代码与服务器代码分离：

app.js:

  1. 'use strict'
  3. const fastify = require('fastify')
  5. function build(opts={}) {
  6.   const app = fastify(opts)
  7.   app.get('/', async function (request, reply) {
  8.     return { hello: 'world' }
  9.   })
  11.   return app
  12. }
  14. module.exports = build

server.js:

  1. 'use strict'
  3. const server = require('./app')({
  4.   logger: {
  5.     level: 'info',
  6.     prettyPrint: true
  7.   }
  8. })
  10. server.listen(3000, (err, address) => {
  11.   if (err) {
  12.     console.log(err)
  13.     process.exit(1)
  14.   }
  15. })

使用 fastify.inject() 的好处

感谢有 light-my-request，Fastify 自带了伪造的 HTTP 注入。

在进行任何测试之前，我们通过 .inject 方法向路由发送假的请求：

app.test.js:

  1. 'use strict'
  3. const build = require('./app')
  5. const test = async () => {
  6.   const app = build()
  8.   const response = await app.inject({
  9.     method: 'GET',
  10.     url: '/'
  11.   })
  13.   console.log('status code: ', response.statusCode)
  14.   console.log('body: ', response.body)
  15. }
  16. test()

我们的代码运行在异步函数里，因此可以使用 async/await。

.inject 确保了所有注册的插件都已引导完毕，可以开始测试应用了。之后请求方法将被传递到路由函数中去。使用 await 可以存储响应，且避免了回调函数。

在终端执行 node app.test.js 来开始测试。

  1. status code:  200
  2. body:  {"hello":"world"}

HTTP 注入测试

现在我们能用真实的测试语句代替 console.log 了！

在 package.json 里修改 “test” script 如下：

"test": "tap --reporter=list --watch"

app.test.js:

  1. 'use strict'
  3. const { test } = require('tap')
  4. const build = require('./app')
  6. test('requests the "/" route', async t => {
  7.   const app = build()
  9.   const response = await app.inject({
  10.     method: 'GET',
  11.     url: '/'
  12.   })
  13.   t.equal(response.statusCode, 200, 'returns a status code of 200')
  14. })

执行 npm test，查看结果！

inject 方法能完成的不只有简单的 GET 请求：

  1. fastify.inject({
  2.   method: String,
  3.   url: String,
  4.   query: Object,
  5.   payload: Object,
  6.   headers: Object,
  7.   cookies: Object
  8. }, (error, response) => {
  9.   // 你的测试
  10. })

忽略回调函数，可以链式调用 .inject 提供的方法：

  1. fastify
  2.   .inject()
  3.   .get('/')
  4.   .headers({ foo: 'bar' })
  5.   .query({ foo: 'bar' })
  6.   .end((err, res) => { //  调用 .end 触发请求
  7.     console.log(res.payload)
  8.   })

或是用 promise 的版本

  1. fastify
  2.   .inject({
  3.     method: String,
  4.     url: String,
  5.     query: Object,
  6.     payload: Object,
  7.     headers: Object,
  8.     cookies: Object
  9.   })
  10.   .then(response => {
  11.     // 你的测试
  12.   })
  13.   .catch(err => {
  14.     // 处理错误
  15.   })

Async await 也是支持的！

  1. try {
  2.   const res = await fastify.inject({ method: String, url: String, payload: Object, headers: Object })
  3.   // 你的测试
  4. } catch (err) {
  5.   // 处理错误
  6. }

另一个例子：

app.js

  1. const Fastify = require('fastify')
  3. function buildFastify () {
  4.   const fastify = Fastify()
  6.   fastify.get('/', function (request, reply) {
  7.     reply.send({ hello: 'world' })
  8.   })
  10.   return fastify
  11. }
  13. module.exports = buildFastify

test.js

  1. const tap = require('tap')
  2. const buildFastify = require('./app')
  4. tap.test('GET `/` route', t => {
  5.   t.plan(4)
  7.   const fastify = buildFastify()
  9.   // 在测试的最后，我们强烈建议你调用 `.close()`
  10.   // 方法来确保所有与外部服务的连接被关闭。
  11.   t.teardown(() => fastify.close())
  13.   fastify.inject({
  14.     method: 'GET',
  15.     url: '/'
  16.   }, (err, response) => {
  17.     t.error(err)
  18.     t.equal(response.statusCode, 200)
  19.     t.equal(response.headers['content-type'], 'application/json; charset=utf-8')
  20.     t.same(response.json(), { hello: 'world' })
  21.   })
  22. })

测试正在运行的服务器

你还可以在 fastify.listen() 启动服务器之后，或是 fastify.ready() 初始化路由与插件之后，进行 Fastify 的测试。

举例:

使用之前例子的 app.js。

test-listen.js (用 Request 测试)

  1. const tap = require('tap')
  2. const request = require('request')
  3. const buildFastify = require('./app')
  5. tap.test('GET `/` route', t => {
  6.   t.plan(5)
  8.   const fastify = buildFastify()
  10.   t.teardown(() => fastify.close())
  12.   fastify.listen(0, (err) => {
  13.     t.error(err)
  15.     request({
  16.       method: 'GET',
  17.       url: 'http://localhost:' + fastify.server.address().port
  18.     }, (err, response, body) => {
  19.       t.error(err)
  20.       t.equal(response.statusCode, 200)
  21.       t.equal(response.headers['content-type'], 'application/json; charset=utf-8')
  22.       t.same(JSON.parse(body), { hello: 'world' })
  23.     })
  24.   })
  25. })

test-ready.js (用 SuperTest 测试)

  1. const tap = require('tap')
  2. const supertest = require('supertest')
  3. const buildFastify = require('./app')
  5. tap.test('GET `/` route', async (t) => {
  6.   const fastify = buildFastify()
  8.   t.teardown(() => fastify.close())
  10.   await fastify.ready()
  12.   const response = await supertest(fastify.server)
  13.     .get('/')
  14.     .expect(200)
  15.     .expect('Content-Type', 'application/json; charset=utf-8')
  16.   t.same(response.body, { hello: 'world' })
  17. })

如何检测 tap 的测试

  1. 设置 {only: true} 选项，将需要检测的测试与其他测试分离
  1. test('should ...', {only: true}, t => ...)
  1. 通过 npx 运行 tap
  1. > npx tap -O -T --node-arg=--inspect-brk test/<test-file.test.js>
  • -O 表示开启 only 选项，只运行设置了 {only: true} 的测试
  • -T 表示不设置超时
  • --node-arg=--inspect-brk 会启动 node 调试工具
  1. 在 VS Code 中创建并运行一个 Node.js: Attach 调试配置，不需要额外修改。

现在你便可以在编辑器中检测你的测试文件 (以及 Fastify 的其他部分) 了。