使用 Jest 和 Supertest 进行接口端点测试实例详解

使用 Jest 和 Supertest 进行接口端点测试是一种常见的自动化测试方式，有助于提高开发和测试效率，以下是具体的实例攻略。

准备工作

在开始测试之前，我们需要先安装相关的环境和库，具体包括:

1. 安装 Node.js

在 Node.js 官网 https://nodejs.org/en/ 上下载对应的版本并安装。

1. 创建项目

在命令行中通过 npm 命令创建一个空的项目。

npm init -y

1. 安装依赖库

Jest 和 Supertest 是我们用来测试的库，需要使用 npm 安装到项目中去。

npm install jest supertest --save-dev

1. 创建测试文件

在项目中创建一个名为 tests 的目录，用于存放测试文件。例如我们在 tests 下创建一个 app.test.js 文件。

编写测试用例

Jest 支持编写同步和异步的测试用例，本例中我们通过 Supertest 进行 HTTP 请求测试。

首先导入我们要测试的 app 模块和 supertest 库。

const app = require('../app');
const request = require('supertest');

接着编写具体的测试用例，例如我们要测试 HTTP GET 请求：

describe('测试 GET /users', () => {
  it('请求应该返回用户列表', done => {
    request(app)
      .get('/users')
      .expect(200)
      .end((err, res) => {
        if (err) return done(err);
        expect(res.body).toBeInstanceOf(Array);
        done();
      });
  });
});

这里使用 Jest 的 describe、it 和 expect 函数编写测试用例，其中：

• describe 函数用来给测试用例命名，它可以嵌套使用。
• it 函数是真正的用例编写函数，本例中我们测试 GET /users 接口的返回结果，使用 Supertest 发起请求，并判断返回的数据类型是否是数组。
• expect 函数是 Jest 内置的断言函数，可以判断两个值是否相等。

接下来我们通过另一个示例来说明如何测试 POST 请求：

describe('测试 POST /users', () => {
  it('请求应该添加一个新用户', done => {
    request(app)
      .post('/users')
      .send({
        name: '测试用户'
      })
      .expect(201)
      .end((err, res) => {
        if (err) return done(err);
        expect(res.body).toHaveProperty('id');
        expect(res.body.name).toBe('测试用户');
        done();
      });
  });
});

本例中我们测试 POST /users 添加一个新用户的结果，并判断返回的数据中是否包含 id 属性和 name 字段是否为 '测试用户'。

运行测试

编写完测试用例之后，我们可以在命令行中执行以下命令运行测试：

npm test

Jest 会自动查找项目中所有的测试文件，并执行其中的测试用例，结果会输出到控制台上，方便我们查看和修复测试用例。

示例说明

以上示例只是简单的介绍，实际测试用例中还可以包含更多的测试场景和细节判断，例如：

1. 测试超时处理：当接口响应时间过长或出现错误时，需要设置超时测试场景，避免测试长时间阻塞。
2. 测试异常处理：当接口返回错误结果时，需要设置测试异常处理场景，判断错误信息和返回值是否符合预期。
3. 测试覆盖率：维护测试用例，同时能够监控测试代码的覆盖率和测试通过率，以保证整个项目的稳定性和可靠性。

总之，使用 Jest 和 Supertest 进行接口端点测试是非常方便和高效的，可以提高项目的测试覆盖率和代码质量，值得开发人员们使用。