使用Tap编写Fastify测试用例的优化疑问及示例请求

1. 每个测试文件重复创建服务器与数据库连接是否合理？ #

从测试独立性角度来说，这种方式是合理的——每个测试用例拥有独立的服务器实例和数据库连接，能彻底避免测试间的状态污染（比如某个测试修改了数据库数据，不会影响其他测试结果）。

但缺点也很明显：频繁创建、销毁连接会增加测试的性能开销，拖慢整体测试速度。如果是小型项目，完全可以接受这种方式；如果是大型项目，你可以考虑复用全局的数据库连接，但必须在每个测试前后清空数据库数据（或者用事务回滚），保证测试之间的独立性不受影响。

2. 如何避免测试文件间的重复导入与代码冗余？ #

可以创建一个测试工具模块（比如test/utils.js），把重复的逻辑（服务器初始化、资源销毁、依赖导入）封装进去，每个测试文件直接导入工具函数即可，不用重复写相同的代码：

// test/utils.js
const buildServer = require('../server')
const mongoose = require('mongoose')
const { redisClient } = require('../plugins/redis')

// 封装服务器初始化逻辑，确保完成插件加载与数据库连接
async function setupTestServer() {
  const fastify = buildServer()
  await fastify.ready()
  return fastify
}

// 封装资源销毁逻辑，统一处理服务器、Redis、MongoDB的关闭
async function teardownResources(fastify) {
  await fastify.close()
  await redisClient.quit()
  await mongoose.connection.close()
}

module.exports = { setupTestServer, teardownResources }

3. 手动关闭数据库连接的实现是否正确？ #

当前实现有问题：t.teardown里的fastify.close()、redisClient.quit()都是异步操作，但你用了同步写法，Tap不会等待这些操作完成就结束测试，容易导致连接泄漏、后续测试出错。必须使用异步的teardown函数，确保资源完全销毁。

优化后的测试示例 #

健康检查测试（server.test.js）

const tap = require('tap')
const { setupTestServer, teardownResources } = require('./utils')

tap.test('requests the `/health-check` route', async function (t) {
  const fastify = await setupTestServer()

  // 异步销毁资源，确保测试结束前完成所有清理
  t.teardown(async () => {
    await teardownResources(fastify)
  })

  const response = await fastify.inject({
    method: 'GET',
    url: '/health-check'
  })
  t.equal(response.statusCode, 200, 'health-check returns 200 status')
})

Artist模块测试（artist.test.js）

const { test } = require('tap')
const { faker } = require('@faker-js/faker')
const { setupTestServer, teardownResources } = require('../../utils')

test('Artist module tests', async (t) => {
  const fastify = await setupTestServer()

  t.teardown(async () => {
    await teardownResources(fastify)
  })

  t.test('should return data by Id', async (t) => {
    // 可选：提前插入测试数据（用faker生成模拟数据）
    // const testArtist = await Artist.create({
    //   name: faker.person.fullName(),
    //   // 其他字段...
    // })

    const response = await fastify.inject({
      method: 'GET',
      url: '/api/v1/artist/',
      query: {
        id: "1" // 或者用上面生成的testArtist._id
      }
    })
    
    const payload = response.json()
    t.equal(response.statusCode, 200, 'returns 200 status code')
    t.ok(payload.data, 'response contains valid artist data')
  })
})

额外优化建议 #

• 使用测试专用数据库：在测试环境配置独立的MongoDB数据库，避免污染生产/开发环境的数据。
• 测试数据前置清理：在setupTestServer里添加数据清理逻辑（比如清空MongoDB集合、Redis缓存），确保每个测试都在干净的环境中执行。
• Mock外部依赖：如果接口依赖第三方服务，用Sinon等工具Mock相关操作，减少测试对外部服务的依赖，提升测试速度。

内容的提问来源于stack exchange，提问作者Vasu Rangpariya