javascript - 如何让 mocha 在断言错误时在 diff 中显示整个对象？

Question

我有一个使用 mocha 和 chai's expect 创建的单元测试测试用例，我在其中深入比较值对象数组与 JSON 文件的解析内容。

我的记录对象大概有20个属性，目前只有价格会导致不匹配。在 diff 上，我只看到其中的五个。

 expect(records).to.deep.equal(expected);

       "data": {
  -      "price": 3578
  +      "price": 3438
         "not_important": "foo"
         "also_not_important": "bar"
       }
       "data": {
  -      "price": 1828
  +      "price": 1698
         "not_important": "foo"
         "also_not_important": "bar"
       }

这在大多数情况下是有用的默认值，但在这种情况下，它混​​淆了哪个特定数据对象正在破坏断言，因为我在这里只看到冗余数据。

假设数据对象中有一个 important 属性，它可以很清楚地表明是什么期望破坏了测试。因此，我希望能够配置显示的属性或在 diff 中显示整个对象。

如何配置 mocha 的差异显示？

---

这是一个展示问题的人为设计的元句法示例:

import {expect} from "chai";

describe(("diff problem"), () => {
    it("should show case that the diff is not shown properly", () => {
        const actual = {
            a: 1,
            troiz: 0,
            bar: 0,
            baz: 2,
            poit: 3,
            narf: 4,
            fizzbuzz: 117,
            fizz: 5,
            buzz: 4,
            waldo: 115,
            mos: 85465,
            important: "THIS IS IMPORTANT",
        };

        const expected = {
            ...actual,
            a: 0,
        };

        return expect(actual).to.deep.equal(expected);
    });
});

该测试用例的输出将是:

2) SourceParser 差异问题应该在一个属性的错误上显示整个差异:

  AssertionError: expected { Object (a, troiz, ...) } to deeply equal { Object (a, troiz, ...) }
  + expected - actual

   {
  -  "a": 1
  +  "a": 0
     "bar": 0
     "baz": 2
     "buzz": 4
     "fizz": 5

然而，如果看到:important: "THIS IS IMPORTANT" 也会很有帮助。

---

这里是数组情况的修改示例:

describe(("diff problem with an array"), () => {
    it("should show case that the diff is not shown properly for deep equal of arrays", () => {
        const anEntity = {
            a: 1,
            troiz: 0,
            bar: 0,
            baz: 2,
            poit: 3,
            narf: 4,
            fizzbuzz: 117,
            fizz: 5,
            buzz: 4,
            waldo: 115,
            mos: 85465,
            important: "IMPORTANT", // assume that each item has a unique important property, which is why it's helpful for it to be shown
        };

        const offendingItem = {
            ...anEntity,
            a: 0,
        };

        const actual = [
            anEntity,
            offendingItem,
            anEntity,
        ];

        const expected = [
            anEntity,
            anEntity,
            anEntity,
        ];

        return expect(actual).to.deep.equal(expected);
    });

输出将是:

  AssertionError: expected [ Array(3) ] to deeply equal [ Array(3) ]
  + expected - actual

       "troiz": 0
       "waldo": 115
     }
     {
  -    "a": 0
  +    "a": 1
       "bar": 0
       "baz": 2
       "buzz": 4
       "fizz": 5

而且 Louis 的答案修改 chai 也不会变得更好，因为它只会先转储整个实际数组，然后显示无用的差异:

AssertionError: expected [ { a: 1,
    troiz: 0,
    bar: 0,
    baz: 2,
    poit: 3,
    narf: 4,
    fizzbuzz: 117,
    fizz: 5,
    buzz: 4,
    waldo: 115,
    mos: 85465,
    important: 'IMPORTANT' },
  { a: 0,
    troiz: 0,
    bar: 0,
    baz: 2,
    poit: 3,
    narf: 4,
    fizzbuzz: 117,
    fizz: 5,
    buzz: 4,
    waldo: 115,
    mos: 85465,
    important: 'IMPORTANT' },
  { a: 1,
    troiz: 0,
    bar: 0,
    baz: 2,
    poit: 3,
    narf: 4,
    fizzbuzz: 117,
    fizz: 5,
    buzz: 4,
    waldo: 115,
    mos: 85465,
    important: 'IMPORTANT' } ] to deeply equal [ { a: 1,
    troiz: 0,
    bar: 0,
    baz: 2,
    poit: 3,
    narf: 4,
    fizzbuzz: 117,
    fizz: 5,
    buzz: 4,
    waldo: 115,
    mos: 85465,
    important: 'IMPORTANT' },
  { a: 1,
    troiz: 0,
    bar: 0,
    baz: 2,
    poit: 3,
    narf: 4,
    fizzbuzz: 117,
    fizz: 5,
    buzz: 4,
    waldo: 115,
    mos: 85465,
    important: 'IMPORTANT' },
  { a: 1,
    troiz: 0,
    bar: 0,
    baz: 2,
    poit: 3,
    narf: 4,
    fizzbuzz: 117,
    fizz: 5,
    buzz: 4,
    waldo: 115,
    mos: 85465,
    important: 'IMPORTANT' } ]
      + expected - actual

           "troiz": 0
           "waldo": 115
         }
         {
      -    "a": 0
      +    "a": 1
           "bar": 0
           "baz": 2
           "buzz": 4
           "fizz": 5

Answer 1

据我所知，没有任何内置方法可以让 Chai 或 Mocha 生成差异，这些差异会添加到差异提供的上下文中，一些不负责测试失败的字段.而且我不知道有任何扩展可以满足您的需求。所以我只知道解决方法。

---

如果您将 truncateThreshold 配置设置设置为更大的值，或者如果您不希望任何 chop ，则设置为 0，将显示 diff 之前出现的失败消息整个对象。因此，如果我将此添加到您的代码中:

chai.config.truncateThreshold = 0; // 0 means "don't truncate, ever".

(配置选项包含在此 documentation page 中。)

然后我得到的错误是:

      AssertionError: expected { a: 1,
  troiz: 0,
  bar: 0,
  baz: 2,
  poit: 3,
  narf: 4,
  fizzbuzz: 117,
  fizz: 5,
  buzz: 4,
  waldo: 115,
  mos: 85465,
  important: 'THIS IS IMPORTANT' } to deeply equal { a: 0,
  troiz: 0,
  bar: 0,
  baz: 2,
  poit: 3,
  narf: 4,
  fizzbuzz: 117,
  fizz: 5,
  buzz: 4,
  waldo: 115,
  mos: 85465,
  important: 'THIS IS IMPORTANT' }
      + expected - actual

       {
      -  "a": 1
      +  "a": 0
         "bar": 0
         "baz": 2
         "buzz": 4
         "fizz": 5

此外，在错误消息中获取自定义信息的一种方法是使用断言设置自定义消息，例如:

expect(actual).to.deep.equal(
            expected,
            `failed equality test on object with important field set to: ${actual.important}`)

自定义消息可以像您需要的那样冗长或简洁。

如果只有一个字段对您区分对象很重要，则自定义消息可能足以获取跟踪问题所需的信息。

---

对于对象数组，您可以通过遍历 actual 和 expected 数组并比较每个成员来执行比较。然后它基本上会像上面描述的那样工作。当然，这有缺点:例如，如果第 1 项和第 10 项不同，您将只得到第 1 项的报告，因为测试将以比较失败而结束。当您解决此问题并再次运行测试时，您将获得第 10 项的报告。这在实践中是否是一个主要问题取决于您正在测试的数据类型。

---

在默认差异算法未执行我想要的操作的情况下，我做过的一件事是导入一个我根据自己的喜好配置的差异库，然后使用该库在我关心的对象和我关心的对象之间执行差异将结果组合成最终报告，然后用断言进行检查。

同样，我不知道有哪个图书馆可以专门您正在寻找的东西。但是，我可以想象遍历 actual 和 expected 数组来为每对生成一个差异报告，然后将它们组合成一个更大的包含识别信息的报告。