第13章 Express测试与调试

测试和调试是软件开发过程中不可或缺的环节。通过测试，可以确保代码按预期工作；通过调试，可以快速定位和解决问题。本章节将介绍如何在 Express 应用中进行单元测试和集成测试，并使用常用工具进行调试。

单元测试

单元测试是指对应用中最小的功能单元进行测试，通常是函数或方法。以下是如何在 Express 应用中编写和运行单元测试的详细指南。

安装 Mocha 和 Chai

Mocha 是一个功能强大的测试框架，而 Chai 是一个断言库，两者结合可以方便地进行单元测试。

npm install mocha chai --save-dev

编写单元测试

假设我们有一个简单的 Express 路由处理器函数，需要对其进行测试：

// routes.js
function getUser(req, res) {
    const userId = req.params.id;
    if (!userId) {
        return res.status(400).send('User ID is required');
    }
    res.status(200).json({ id: userId, name: 'John Doe' });
}

module.exports = { getUser };

我们可以为这个函数编写一个单元测试：

// test/routes.test.js
const { expect } = require('chai');
const { getUser } = require('../routes');
const httpMocks = require('node-mocks-http');

describe('GET /user/:id', () => {
    it('should return user details for valid ID', () => {
        const req = httpMocks.createRequest({
            method: 'GET',
            url: '/user/123',
            params: {
                id: '123'
            }
        });
        const res = httpMocks.createResponse();

        getUser(req, res);

        expect(res.statusCode).to.equal(200);
        const data = JSON.parse(res._getData());
        expect(data).to.deep.equal({ id: '123', name: 'John Doe' });
    });

    it('should return 400 if no ID is provided', () => {
        const req = httpMocks.createRequest({
            method: 'GET',
            url: '/user'
        });
        const res = httpMocks.createResponse();

        getUser(req, res);

        expect(res.statusCode).to.equal(400);
        expect(res._getData()).to.equal('User ID is required');
    });
});

运行单元测试

在 package.json 文件中添加一个测试脚本：

"scripts": {
    "test": "mocha"
}

然后在命令行中运行测试：

npm test

集成测试

集成测试是指对应用的各个部分进行集成后的测试，通常涉及数据库、网络请求等。以下是如何在 Express 应用中编写和运行集成测试的详细指南。

安装 Supertest

Supertest 是一个用于测试 HTTP 服务器的库，结合 Mocha 和 Chai，可以方便地进行集成测试。

npm install supertest --save-dev

编写集成测试

假设我们有一个简单的 Express 应用，需要对其进行集成测试：

// app.js
const express = require('express');
const { getUser } = require('./routes');

const app = express();
app.get('/user/:id', getUser);

module.exports = app;

我们可以为这个应用编写一个集成测试：

// test/app.test.js
const request = require('supertest');
const { expect } = require('chai');
const app = require('../app');

describe('GET /user/:id', () => {
    it('should return user details for valid ID', (done) => {
        request(app)
            .get('/user/123')
            .expect(200)
            .end((err, res) => {
                if (err) return done(err);
                expect(res.body).to.deep.equal({ id: '123', name: 'John Doe' });
                done();
            });
    });

    it('should return 400 if no ID is provided', (done) => {
        request(app)
            .get('/user')
            .expect(400)
            .end((err, res) => {
                if (err) return done(err);
                expect(res.text).to.equal('User ID is required');
                done();
            });
    });
});

运行集成测试

集成测试可以通过和单元测试相同的命令运行：

npm test

使用 Mocha 和 Chai

Mocha 提供了一个灵活且强大的测试框架，而 Chai 提供了多种风格的断言（例如 BDD 和 TDD），两者结合可以方便地进行各种测试。

const { expect } = require('chai');

describe('Array', () => {
    it('should start empty', () => {
        const arr = [];
        expect(arr).to.be.an('array').that.is.empty;
    });
});

调试技巧与工具

在开发过程中，调试代码是不可避免的。以下是一些常用的调试技巧和工具。

使用 console.log

console.log 是最简单的调试方法，通过在代码中插入 console.log 语句，可以输出变量值或运行状态。

function add(a, b) {
    console.log(`Adding ${a} and ${b}`);
    return a + b;
}

使用 Node.js 内置调试器

Node.js 提供了一个内置的调试器，可以通过 --inspect 标志启用。

node --inspect app.js

然后，可以在浏览器中打开 chrome://inspect 进行调试。

使用 VSCode 调试

Visual Studio Code 是一个流行的代码编辑器，提供了强大的调试功能。可以通过以下步骤在 VSCode 中调试 Node.js 应用：

1. 打开 VSCode，按 F5 进入调试视图。

2. 点击齿轮图标，选择 Node.js 创建 launch.json 文件。

3. 配置 launch.json 文件，例如：

   {
       "version": "0.2.0",
       "configurations": [
           {
               "type": "node",
               "request": "launch",
               "name": "Launch Program",
               "program": "${workspaceFolder}/app.js"
           }
       ]
   }
   

4. 设置断点，按 F5 开始调试。

本章详细介绍了如何在 Express 应用中进行单元测试和集成测试，并使用 Mocha、Chai、Supertest 等工具进行测试。同时，还介绍了使用各种调试工具和技巧，帮助开发者在开发过程中快速定位和解决问题。通过掌握这些技术，可以大大提高代码质量和开发效率。