Chai 中的 expect.to.have.members 方法详解及使用实例-JavaScript中文网-JavaScript教程资源分享门户

简介

在前端自动化测试中，Chai 是一个非常流行的断言库。它提供了一系列易于使用的断言方法，可以方便地验证代码的正确性和性能。

其中，expect.to.have.members 方法被广泛用于验证数组和集合类型的数据。本文将详细介绍这个方法的使用方法及实例应用，并为读者指导如何在实际项目中应用。

基本用法

expect.to.have.members() 方法用于验证一个集合类型的数据是否包含指定的成员。如果验证成功，方法会返回 true；否则会抛出 AssertionError 错误。

具体语法如下：

expect([1, 2, 3]).to.have.members([2, 1, 3]);

上述语句表示，验证 [1, 2, 3] 这个数组是否包含成员 [2, 1, 3]。由于两个数组中的成员都是相同的，所以该方法会返回 true。

在验证过程中，成员的顺序并不会影响验证结果。例如：

expect([1, 2, 3]).to.have.members([2, 3, 1]);

上述语句也会返回 true，因为它们包含的成员是相同的，只是顺序不同。

若验证失败，错误提示就会显示具体的差异之处，如：

expect([1, 2, 3]).to.have.members([2, 3, 4]);
// AssertionError: expected [1,2,3] to have members [2,3,4]
// missing: 4, expected to include: 1

上述错误提示显示出了 [1, 2, 3] 数组缺失成员 4，并且期望包含成员 1，但实际中并没有找到。

可选参数

除了必须传入的集合数据之外，expect.to.have.members() 方法还支持两个可选参数：ignoreOrder 和 strict。

ignoreOrder

如果启用 ignoreOrder 参数，expect.to.have.members() 方法会忽略验证数据中成员的顺序。例如：

expect([1, 2, 3]).to.have.members([2, 3, 1], true);

上述语句中，ignoreOrder 参数传入了 true，那么即使示例中两个数组的成员顺序不同，该方法也会返回 true，因为它们只要包含相同的成员就会被认为是相等的。

strict

如果启用 strict 参数，expect.to.have.members() 方法会完全验证两个集合中的成员是否相同，包括它们的长度。例如：

expect([1, 2, 3]).to.have.members([2, 3, 4], false, true);

上述语句中，strict 参数传入了 true，那么即使示例中两个数组的成员相同，但它们的长度不同，该方法也会抛出 AssertionError 错误。

实例分析

为了更好地说明 expect.to.have.members() 方法的使用，下面我们结合一个实际的案例进行分析。

例如，现在我们假设有一个数据模型，模型包含两个对象：

// javascriptcn.com 代码示例
const userModel = {
  username: 'john',
  password: '12345',
};

const articleModel = {
  title: 'example article',
  content: 'lorem ipsum dolor sit amet',
};

我们现在要使用 Chai 对这两个对象进行验证，需要保证它们的成员都正确。具体的测试代码如下：

it('should have members', () => {
  expect(userModel).to.have.members(['john', '12345']);
  expect(articleModel).to.have.members(['example article', 'lorem ipsum dolor sit amet']);
});

然而，上述测试代码中没有通过，失败了。我们来看看具体的原因。

通过分析代码，我们不难发现，userModel 和 articleModel 是两个对象，而非数组。因此，它们并不适合使用 expect.to.have.members() 方法进行数组的比较验证。

正确的测试代码如下：

it('should have properties', () => {
  expect(userModel).to.have.property('username', 'john');
  expect(userModel).to.have.property('password', '12345');

  expect(articleModel).to.have.property('title', 'example article');
  expect(articleModel).to.have.property('content', 'lorem ipsum dolor sit amet');
});

通过使用 .to.have.property() 方法，可以直接比较对象的成员，从而更好地验证代码的正确性。

总结

expect.to.have.members() 方法是一个非常实用的方法，用于验证数组和集合类型的成员是否正确，并且支持多种选项参数以满足不同的验证需求。

虽然该方法的使用看起来非常简单，但是需要注意数组和对象的区别，以及避免传入错误的参数。只有深入理解该方法的原理和使用方法，才能真正发掘其无限的价值。

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