Chai 在 Node.js 环境中的使用技巧-JavaScript中文网-JavaScript教程资源分享门户

前言

在 Node.js 环境中，开发者经常需要编写测试用例来保证代码正确行为并减少 bug 影响范围。但是，测试用例的编写却不是那么容易的事情，特别是对于前端开发者来说。这个时候，Chai 就可以派上用场了。Chai 是一个适用于 Node.js 环境的断言库，它提供了丰富的断言方法帮助开发者方便地对代码行为进行测试。在本文中，我们将会详细介绍 Chai 在 Node.js 环境中的使用技巧。

安装

在 Node.js 环境中使用 Chai，我们需要先安装 Chai。安装命令如下：

npm install chai --save-dev

安装完成后，在测试代码中引入 Chai：

const chai = require('chai');

断言语法

Chai 提供了多种形式的断言语法，这里我们将介绍其中的两种：BDD 和 TDD 风格。

BDD 风格：

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);
    });
  });
});

TDD 风格：

suite('Array', function() {
  suite('#indexOf()', function() {
    test('should return -1 when not present', function() {
      assert.equal([1,2,3].indexOf(4), -1);
    });
  });
});

BDD 风格的测试用例看起来更像是一系列的自然语言描述，而 TDD 风格的测试用例则更加注重方法调用的精确性。

常用的 Assertion

Chai 提供了很多的 Assertion API，这里我们就介绍几个常见的：

equal

equal 断言用来比较实际值和期望值是否一致。它使用相等运算符进行比较。

assert.equal(2 + 2, 4);

deep equal

deep equal 断言用来深度比较实际值和期望值是否一致。它使用深度比较算法进行比较。

assert.deepEqual({ foo: 'bar' }, { foo: 'bar' });

throws

throws 断言用来检查函数是否抛出错误。如果抛出了错误，则断言通过。

assert.throw(() => {
  throw new Error('Fail')
});

notEqual

notEqual 断言用来比较实际值和期望值是否不一致。它使用不等运算符进行比较。

assert.notEqual(2 + 2, 5);

Chai 的链式断言

Chai 还提供了链式断言，可以让我们在一个语句中使用多个断言。这些断言将在上一个断言的基础上进行验证。

expect(foo).to.be.a('string').and.have.lengthOf(3);

Chai 的插件

为了扩展 Chai 的功能，我们可以使用 Chai 的插件。下面是几个常用的插件：

chai-as-promised

chai-as-promised 插件可以让我们更方便地测试 Promise。

它添加了以下方法：

eventually：用于测试 Promise 返回值。
notify：用于在支持 Progress 工具的 Promise 库中测试 Progress 通知。
rejectedWith：用于测试 Promise 是否被拒绝。

const chai = require('chai');
const chaiAsPromised = require('chai-as-promised');

chai.use(chaiAsPromised);

const promise = Promise.reject();
expect(promise).to.eventually.be.rejected;

chai-http

chai-http 插件可以让我们更方便地测试 HTTP APIs。

chai.request('http://localhost:8080')
  .get('/api/something')
  .set('X-API-Key', 'foobar')
  .then((res) => {
    expect(res).to.have.status(200);
  });

结论

Chai 是一个非常强大的 Node.js 测试断言库，它提供了丰富的断言方法，可以让我们写出更高质量的测试用例。在 Node.js 开发中经常用到，希望本文可以给大家提供一些帮助。

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