Supertest 是一个用于 HTTP 请求集成测试的库。它提供了一种简洁的方式来测试你的 Express 应用程序。本章将详细介绍如何使用 Supertest 来测试 Node.js 应用程序。
安装 Supertest
首先，你需要安装 Supertest。你可以通过 npm 来安装它：
npm install supertest --save-dev
同时，为了测试 Express 应用程序，你还需要安装 supertest-koa-agent，这是一个增强版的 Supertest，适用于 Koa 应用程序：
npm install supertest-koa-agent --save-dev
创建一个简单的 Express 应用
为了演示如何使用 Supertest，我们先创建一个简单的 Express 应用程序。假设你已经有一个基本的 Express 应用程序结构：
// www.javascriptcn.com code example
// app.js
const express = require('express');
const app = express();
app.get('/', (req, res) => {
res.send('Hello World!');
});
app.listen(3000, () => {
console.log('App is listening on port 3000');
});编写测试用例
接下来，我们将编写一些测试用例来验证我们的 Express 应用程序的行为。
测试 GET 请求
首先，我们需要安装 mocha 作为测试框架，并且安装 chai 来帮助我们断言结果：
npm install mocha chai --save-dev
然后，在项目根目录下创建一个名为 test 的文件夹，并在其中创建一个名为 app.test.js 的文件。在这个文件中，我们将编写测试用例：
// www.javascriptcn.com code example
// test/app.test.js
const request = require('supertest');
const app = require('../app');
describe('GET /', () => {
it('should respond with "Hello World!"', (done) => {
request(app)
.get('/')
.expect('Hello World!', done);
});
});运行测试
你可以通过 Mocha 来运行测试用例。在 package.json 文件中添加一个脚本来运行测试：
{
"scripts": {
"test": "mocha"
}
}然后运行以下命令来执行测试：
npm test
如果一切正常，你应该会看到测试通过的信息。
测试 POST 请求
除了 GET 请求，你还可以测试 POST 请求。下面是一个示例，展示如何测试一个 POST 请求：
// www.javascriptcn.com code example
// test/app.test.js
const request = require('supertest');
const app = require('../app');
describe('POST /submit', () => {
it('should accept a JSON body and return the same body', (done) => {
const data = { name: 'John Doe' };
request(app)
.post('/submit')
.send(data)
.set('Accept', 'application/json')
.expect('Content-Type', /json/)
.expect(200)
.expect(data, done);
});
});你需要确保你的 Express 应用程序能够处理 POST 请求。例如，你可以添加如下代码到 app.js：
app.post('/submit', (req, res) => {
res.json(req.body);
});测试错误处理
Supertest 也支持测试错误处理。你可以模拟错误情况并检查应用程序是否正确地返回了错误信息。例如：
// www.javascriptcn.com code example
// test/app.test.js
const request = require('supertest');
const app = require('../app');
describe('Error handling', () => {
it('should handle 404 errors', (done) => {
request(app)
.get('/not-found')
.expect(404, done);
});
it('should handle server errors', (done) => {
request(app)
.get('/server-error')
.expect(500, done);
});
});你需要确保你的 Express 应用程序能够处理这些错误。例如，你可以添加如下代码到 app.js：
app.use((req, res) => {
res.status(404).send('Not Found');
});
app.use((err, req, res, next) => {
console.error(err.stack);
res.status(500).send('Something broke!');
});总结
通过本章的学习，你应该掌握了如何使用 Supertest 来测试你的 Node.js 应用程序。Supertest 提供了简单而强大的 API 来测试 HTTP 请求，使得测试变得非常方便。你可以利用这些技术来提高你的应用质量和稳定性。
希望这些示例和解释对你有所帮助！如果你有任何问题或需要进一步的帮助，请随时提问。