如何使用 Jest 测试 Express.js 应用-JavaScript中文网-JavaScript教程资源分享门户

在前端开发中，测试是保证代码质量和可靠性的重要手段。而 Jest 是一个流行的 JavaScript 测试框架，它提供了丰富的 API 和插件，可以方便地对前端应用进行单元测试和集成测试。

本文将介绍如何使用 Jest 测试 Express.js 应用。我们将从安装 Jest 开始，逐步深入，介绍如何编写测试用例、模拟请求、测试控制器和中间件等内容。

安装 Jest

首先，我们需要在项目中安装 Jest。可以使用 npm 或 yarn 安装：

npm install --save-dev jest
# 或
yarn add --dev jest

安装完成后，在项目根目录下创建一个 __tests__ 目录，用于存放测试文件。

编写测试用例

首先，我们需要编写测试用例。测试用例是一个函数，它包含一个或多个测试语句，用于验证被测试代码的正确性。

例如，我们要测试一个简单的 Express.js 应用，它的路由定义如下：

// javascriptcn.com 代码示例
const express = require('express');
const app = express();

app.get('/', (req, res) => {
  res.send('Hello, world!');
});

app.listen(3000, () => {
  console.log('Server started on port 3000');
});

我们可以编写一个测试用例，测试根路由是否正常工作：

// javascriptcn.com 代码示例
const request = require('supertest');
const app = require('../app');

describe('Test the root path', () => {
  test('It should response the GET method', async () => {
    const response = await request(app).get('/');
    expect(response.statusCode).toBe(200);
    expect(response.text).toBe('Hello, world!');
  });
});

这里使用了 supertest 库来模拟请求。describe 函数用于描述测试用例，test 函数用于编写测试语句。在测试语句中，我们使用了 expect 函数来断言测试结果是否符合预期。

模拟请求

在测试 Express.js 应用时，我们需要模拟请求，以便测试控制器和中间件的正确性。supertest 库提供了方便的 API 来模拟请求。

例如，我们要测试一个需要身份验证的路由，它的控制器定义如下：

// javascriptcn.com 代码示例
function authenticate(req, res, next) {
  if (!req.headers.authorization) {
    res.status(401).send('Unauthorized');
  } else {
    const token = req.headers.authorization.split(' ')[1];
    if (token === 'secret') {
      next();
    } else {
      res.status(401).send('Unauthorized');
    }
  }
}

function secured(req, res) {
  res.send('Welcome to the secured area');
}

module.exports = { authenticate, secured };

我们可以编写一个测试用例，测试身份验证是否正常工作：

// javascriptcn.com 代码示例
const request = require('supertest');
const app = require('../app');
const { authenticate, secured } = require('../controllers/auth');

describe('Test the authentication middleware', () => {
  test('It should return 401 for unauthorized requests', async () => {
    const response = await request(app).get('/secured');
    expect(response.statusCode).toBe(401);
  });

  test('It should pass authorized requests', async () => {
    const response = await request(app)
      .get('/secured')
      .set('Authorization', 'Bearer secret');
    expect(response.statusCode).toBe(200);
    expect(response.text).toBe('Welcome to the secured area');
  });
});

这里我们编写了两个测试语句，分别测试未授权请求和授权请求的结果是否符合预期。在授权请求中，我们使用了 set 函数来设置请求头中的授权信息。

测试控制器

在测试控制器时，我们需要模拟请求并验证控制器的返回结果是否符合预期。

例如，我们要测试一个控制器，它从数据库中获取用户信息并返回：

// javascriptcn.com 代码示例
const User = require('../models/user');

async function getUser(req, res) {
  const user = await User.findById(req.params.id);
  if (!user) {
    res.status(404).send('User not found');
  } else {
    res.send(user);
  }
}

module.exports = { getUser };

我们可以编写一个测试用例，测试控制器是否正常工作：

// javascriptcn.com 代码示例
const request = require('supertest');
const app = require('../app');
const User = require('../models/user');
const { getUser } = require('../controllers/user');

describe('Test the user controller', () => {
  test('It should return 404 for non-existing users', async () => {
    User.findById.mockReturnValue(null);
    const response = await request(app).get('/users/1');
    expect(response.statusCode).toBe(404);
  });

  test('It should return user information for existing users', async () => {
    User.findById.mockReturnValue({ id: 1, name: 'Alice' });
    const response = await request(app).get('/users/1');
    expect(response.statusCode).toBe(200);
    expect(response.body).toEqual({ id: 1, name: 'Alice' });
  });
});

这里我们使用了 Jest 提供的 mock 函数来模拟数据库操作。在测试语句中，我们分别测试了控制器返回 404 和用户信息的情况。

测试中间件

在测试中间件时，我们需要模拟请求并验证中间件的行为是否符合预期。

例如，我们要测试一个中间件，它记录请求和响应的时间：

// javascriptcn.com 代码示例
function logger(req, res, next) {
  const start = Date.now();
  res.on('finish', () => {
    const duration = Date.now() - start;
    console.log(`${req.method} ${req.path} ${res.statusCode} ${duration}ms`);
  });
  next();
}

module.exports = logger;

我们可以编写一个测试用例，测试中间件是否正常工作：

// javascriptcn.com 代码示例
const request = require('supertest');
const app = require('../app');
const logger = require('../middlewares/logger');

describe('Test the logger middleware', () => {
  test('It should log request and response time', async () => {
    console.log = jest.fn();
    const response = await request(app)
      .get('/')
      .set('Accept', 'application/json');
    expect(response.statusCode).toBe(200);
    expect(console.log).toHaveBeenCalledTimes(1);
    expect(console.log).toHaveBeenCalledWith(
      'GET / 200 1ms'
    );
  });
});

这里我们使用了 Jest 提供的 fn 函数来模拟 console.log 方法。在测试语句中，我们模拟了一个请求，并验证了日志输出是否符合预期。

总结

本文介绍了如何使用 Jest 测试 Express.js 应用。我们从安装 Jest 开始，逐步深入，介绍了如何编写测试用例、模拟请求、测试控制器和中间件等内容。希望本文能对读者了解 Jest 测试框架和测试 Express.js 应用有所帮助。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/6509867b95b1f8cacd43b3a7