起因

最近在看nodebestpractice，秉持着凡事都要试试的原则，简单练了练手，本文完整代码参见链接node-practice。

关于自动化测试，原文是这么描述的。

这里超快的流行的测试包是指Supertest这个包，专门用于对HTTP服务进行集成测试的。

安装

我用的是Typescript，所以开发依赖当中有很多类型申明的包。

json 复制代码

"devDependencies": {
  "@types/body-parser": "^1.19.4",
  "@types/express": "^4.17.20",
  "@types/node": "^20.8.8",
  "@types/supertest": "^2.0.15",
  "mocha": "^10.2.0",
  "supertest": "^6.3.3",
  "ts-node": "^10.9.1"
},
"dependencies": {
  "express": "^4.18.2"
}

指令

测试相关的命令有一些Typescript相关的配置。

json 复制代码

"scripts": {
  "tsc": "tsc",
  "start": "node build/app.js",
  "dev": "nodemon src/app.ts",
  "build": "tsc -p .",
  "test": "mocha -r ts-node/register src/**/test.ts"
},

实现一个简单的GET接口

ts 复制代码

// src/components/blog/controller.ts
import { Router } from 'express';

const router = Router();

router.get('/', (res, req, next) => {
  req.status(200).send('Hello world!');
});

export default router;

// src/app.ts
import express from 'express'
import blogRouter from './components/blog/controller'

const app = express();

app.use(
  blogRouter,
);

const server = app.listen(8088, function () {
  console.log('node-practice app listening on port http://localhost:8088');
});

export default server;

使用Supertest测试

踩坑

手动启动的服务Supertest无法在测试完成后将其关闭

官方提供的方法是直接将app这个express实例传入到request函数当中去，request会帮助我们创建一个HttpServer，并且会在调用end方法时在内部调用HttpServer的close方法。

js 复制代码

// 官方推荐使用方法
const request = require('supertest');
const assert = require('assert');
const express = require('express');

const app = express();

app.get('/user', function(req, res) {
  res.status(200).json({ name: 'john' });
});

request(app)
  .get('/user')
  .expect('Content-Type', /json/)
  .expect('Content-Length', '15')
  .expect(200)
  .end(function(err, res) {
    if (err) throw err;
  });

// 服务创建源码
serverAddress(app, path) {
  const addr = app.address();

  if (!addr) this._server = app.listen(0);
  const port = app.address().port;
  const protocol = app instanceof Server ? 'https' : 'http';
  return protocol + '://127.0.0.1:' + port + path;
}

// 服务销毁源码
end(fn) {
  const server = this._server;

  super.end((err, res) => {
    const localAssert = () => {
      this.assert(err, res, fn);
    };

    if (server && server._handle) return server.close(localAssert);

    localAssert();
  });

  return this;
}

可以看到在销毁的时候会先判断server是否存在以及_handle属性是否被定义，如果没有做应用和服务的分离，也就是手动启动服务，将会导致_handle为null，服务将不会被关闭，测试的进程也不会自动结束。

手动创建的server输出

所以在app.ts文件中需要导出的是服务，而不是express实例，并且在test文件中手动关闭当前服务。

当然，也可以通过应用和服务的分离避免这样的问题。

node版本导致的node:test当中it函数入参TestFn的入参变化

Supertest官方的代码示例当中it函数第二个入参，也就是测试函数的入参和node18对应的测试函数的入参有所区别。