# Node 应用中的单元测试

> 新增或迭代功能时，用 BDD/TDD 思路配合 assert/chai、mocha 或 jest 组织用例，并用 nyc、codecov 查看覆盖率与 API 测试。

- 发布于: 2020-04-04
- 更新于: 2026-09-30
- 原文: https://shanyue.tech/posts/node/test/
- 标签: node
- 专栏: Node 牛刀小试

---

> 当新增一个新功能或迭代已有功能时，如何保证不会影响到旧功能的正常运作？

单元测试是提高代码质量的一个必要手段，也能够最大限度地减少对旧有功能的最大破坏。对于一些公共库，如 `lodash`，`koa` 及 `react` 而言，它们对健壮性，代码质量有着更高的要求，单元测试则是必备条件了。

除了提高代码质量，单元测试还可以充当 **文档** 或者 **示例** 的功能，特别是对那些文档不齐及不见文档特性而言。

## BDD 与 TDD

测试分为两大流派，分别为

1. BDD: Behavior Driven Development，行为驱动开发，先作实现，然后对实现做尽量完整的测试
1. TDD: Test Driven Development，测试驱动开发，先写测试用例，根据测试用例驱动开发，对于开发细节有很好的把控

## 断言 | chai

```js
function sum(a, b) {
  return a + b;
}
```

假设项目中有一个函数 `sum`，我们要对它进行测试:

```js
sum(1, 1) === 2;
```

当然这种写法过于简单，当有更多个测试用例时也无法更直观地查看详情，于是有很多优秀的断言库支持：

1. [assert](https://nodejs.org/docs/latest-v12.x/api/assert.html): Node 原生支持的断言模块
1. [chai](https://github.com/chaijs/chai) (6.7k star): 可支持浏览器及 Node 的断言库，支持 TDD 与 BDD
1. [should](https://github.com/tj/should.js) (2.8k star): 支持 BDD
1. [expect](https://github.com/Automattic/expect.js) (2.1k star)

## 框架 | mocha

一个测试用例可以包含一个断言或多个断言，那如何组织多个测试用例呢？

通过框架，它可以对测试用例进行分组测试，并形成测试报告。常见的几种测试框架如下

1. [ava](https://github.com/avajs/ava) (17.7k)
1. [mocha](https://github.com/mochajs/mocha) (19.1k)，著名框架 express 通过它来写测试
1. [jest](https://github.com/facebook/jest) (30.2k)，多在浏览器环境中使用，如 `react`
1. [karma](https://github.com/karma-runner/karma) (11k)，多在浏览器环境中使用，如 `vue`

这是一个使用 `mocha` 和 `assert` 测试 `Array.prototype.indexOf` 的示例

```js
const assert = require("assert");
describe("Array", function () {
  describe("#indexOf()", function () {
    it("should return -1 when the value is not present", function () {
      assert.equal([1, 2, 3].indexOf(4), -1);
    });
  });
});
```

这是通过 `mocha` 测试框架所形成的测试报告

```js
$ ./node_modules/mocha/bin/mocha

  Array
    #indexOf()
      ✓ should return -1 when the value is not present


  1 passing (9ms)
```

## 仅仅测试某一个 TestSuite

为了更有针对性的调试，仅需对某一个文件进行测试

## 测试覆盖率

1. [nyc](https://github.com/istanbuljs/nyc) (4.1k star)
1. [codecov](https://github.com/codecov/codecov-node)

```bash
  CLS Session
    ✓ expect work
    ✓ expect scope return value
    ✓ expect work at async resource
    ✓ expect work at koa middleware


  4 passing (39ms)


=============================== Coverage summary ===============================
Statements   : 97.06% ( 33/34 )
Branches     : 62.5% ( 5/8 )
Functions    : 92.31% ( 12/13 )
Lines        : 97.06% ( 33/34 )
================================================================================
```

```bash
$ jest --coverage
```

## API 测试