Chai 中 expect 的使用教程-JavaScript中文网-JavaScript教程资源分享门户

前言

在前端开发中，写测试用例是非常重要的。通过测试用例，我们可以验证代码的正确性、稳定性和可用性，从而提升代码质量和开发效率。

在测试用例中，断言（Assertion）是核心。断言是指对代码行为的一种预期。如果预期成立，那么测试就通过了；反之，则测试失败。因此，断言的正确性和准确性非常重要。在 JavaScript 中，有很多优秀的断言库，比如 Mocha、Jasmine、Chai 等。其中，Chai 是最受欢迎和强大的断言库之一。

Chai 支持多种断言风格，其中最常用的是 expect 风格。本文将介绍 Chai 中 expect 风格的使用方法，帮助读者熟练掌握这一强大的工具，提升前端开发的质量和效率。

Chai 的安装和引入

Chai 是一个 NPM 包，可以通过 npm 指令进行安装。在安装 Chai 之前需要确认 Node.js 已经被正确地安装。

npm install chai

在使用 Chai 时，需要在测试文件中引入 Chai：

const { expect } = require('chai')

在引入 expect 后，我们可以使用其提供的各种方法和属性，进行测试用例的编写。下面，我们将会介绍 expect 的各种方法和用法。

expect 的基本使用

在 expect 风格中，我们首先需要使用 expect 函数，来构造一个断言语句：

expect(value).to.be.a(type)

其中，value 表示待验证的值，type 表示值的类型。例如，我们希望验证一个字符串是否为数组，可以这样写：

expect('hello').to.be.a('array')

当 value 不为数组时，断言会失败，测试用例会报错。反之，则测试通过。

除了 .to.be.a 方法，还有很多类似的方法，比如 .to.be.an、.to.be.ok、.to.exist 等。这些方法用于对 value 进行各种不同的判断。下面，我们将介绍这些方法的使用方法和参数。

expect 的详细用法

判断类型

在 JavaScript 中，有很多基本数据类型和复合数据类型，包括 String、Number、Boolean、Object、Array、Function 等。expect 提供了丰富的 is 或者 type 开头的语法来检查值的类型。

.to.be.a(type) 或者 .to.be.an(type)：检查值的类型是否为 type。
.to.be.a('string') 或者 .to.be.an('object') 等。
.to.be.a('function'). 和 .to.be.an('array') 等。

例如：

expect('hello').to.be.a('string')
expect(42).to.be.a('number')
expect({}).to.be.an('object')

判断相等

在测试中，我们常常需要对两个值进行比较，例如比较两个字符串是否相同。expect 提供了几个方法来实现这个目的。

.to.equal(value)：检查值是否等于 value。
.to.equal(42) 或者 .to.equal('hello') 等。
.to.eql(value)：检查值是否深度等于 value。
.to.eql({foo: 'bar'}) 等同于 {foo: 'bar'}
.to.deep.equal(value)：也可以检查值是否深度等于 value。
.to.deep.equal({foo: 'bar'}) 等同于 {foo: 'bar'}

注意，to.equal() 和 to.eql() 的区别在于：

to.equal() 比较两个值是否严格相等，即采用 === 比较。
to.eql() 则比 to.equal() 更加宽松，并允许值的深度比较。例如，当比较两个数组时，to.equal() 会判断两个数组是否严格相等，而 to.eql() 则检查两个数组的每一个元素是否相等，包括元素的类型和嵌套结构等。

判断大小

在测试中，我们有时需要比较数字的大小。expect 提供了几个方法来实现这个目的。

.to.be.above(value)：检查值是否大于 value。
.to.be.above(10) 等同于 > 10
.to.be.at.least(value)：检查值是否大于或等于 value。
.to.be.at.least(10) 等同于 >= 10
.to.be.below(value)：检查值是否小于 value。
.to.be.below(10) 等同于 < 10
.to.be.at.most(value)：检查值是否小于或等于 value。
.to.be.at.most(10) 等同于 <= 10

例如：

expect(1).to.be.above(0)
expect(10).to.be.at.least(10)
expect(9).to.be.below(10)
expect(10).to.be.at.most(10)

判断包含关系

在测试中，我们有时需要检查一个数组、字符串或对象是否包含某一个值。expect 提供了几个方法来实现这个目的。

.to.be.oneOf(list)：检查值是否等于 list 中的某一个值。
.to.be.oneOf([1, 2, 3]) 等同于 == 1 || == 2 || == 3
.to.include(value)：检查值是否包含 value，可以用于数组、字符串和对象。
.to.include('hello') 等同于 'hello'.indexOf(value) !== -1
.to.have.property(key, [value])：检查对象是否具有 key 属性，如果提供了 value，则检查属性的值是否等于 value。
.to.have.property('foo') 等同于 o.foo !== undefined
.to.have.property('foo', 'bar') 等同于 o.foo === 'bar'
.to.have.keys(list)：检查对象是否具有 list 中的所有属性。
.to.have.keys('foo', 'bar') 表示对象必须具有 foo 和 bar 两个属性。

例如：

expect(3).to.be.oneOf([1, 2, 3])
expect([1, 2, 3]).to.include(3)
expect({foo: 'bar'}).to.have.property('foo')
expect({foo: 'bar'}).to.have.property('foo', 'bar')
expect({foo: 'bar', baz: 'qux'}).to.have.keys('foo', 'baz')

判断真值和假值

在测试中，有时需要检查一个值是否为真（True）或假（False）。expect 提供了以下几种方法来实现这个目的。

.to.be.true：检查值是否为 true。
.to.be.false：检查值是否为 false。
.to.be.ok：检查值是否为真值（Truthy），即不是 undefined、null、NaN、0 或者空字符串。
.to.not.be.ok：检查值是否为假值（Falsy），即 undefined、null、NaN、0 或者空字符串。

例如：

expect(true).to.be.true
expect(false).to.be.false
expect(1).to.be.ok
expect('').to.not.be.ok

expect 的进阶用法

除了基本使用之外，expect 还支持很多进阶用法，比如断言的消息、异常处理、异步测试等。本节将会介绍一些常用的进阶用法。

断言的消息

在测试中，断言失败时需要给出错误提示信息。expect 允许我们在断言语句后面加上描述信息，用于更准确地定位错误。

例如：

expect('hello').to.be.a('array', '字符串应该是一个数组')

当字符串不是数组时，测试框架会输出一条错误信息，提示“字符串应该是一个数组”。

异常处理

在测试中，有时我们需要抛出异常，比如用于模拟复杂场景、验证错误处理等。expect 允许我们使用 to.throw() 方法来验证一个函数是否抛出了指定的异常。

例如：

expect(() => {
  throw new Error('oops')
}).to.throw('oops')

上面代码中，我们在一个箭头函数中使用 throw 语句抛出了一个错误。然后使用 to.throw() 方法验证代码是否正常抛出了这个错误。如果代码没有抛出异常，测试会失败。

异步测试

在前端开发中，异步操作非常常见，比如异步请求、异步渲染等。如何对异步操作进行测试呢？expect 允许我们使用 done() 函数来处理异步操作。

例如：

it('测试异步操作', function(done) {
  setTimeout(() => {
    expect('hello').to.equal('world')
    done()
  }, 1000)
})

上面代码中，我们使用 it 函数声明一个测试用例，然后在函数中使用 setTimeout 函数模拟一个异步操作。在异步操作的回调函数中，我们再次使用 expect 函数来断言值是否相同。将 done() 函数作为回调函数的参数，用于标记异步操作已经完成。

如果在 1 秒内未执行 done() 函数，测试框架会认为测试用例失败。

总结

Chai 提供了丰富的断言机制，帮助我们对代码行为进行精准的预测和验证。掌握 expect 风格的断言语法和使用方法，将有助于我们编写高质量的测试用例，提升代码的可靠性和稳定性。

来源：JavaScript中文网，转载请注明来源本文地址：https://www.javascriptcn.com/post/653aa2587d4982a6eb4c5565