在 NodeJS 中测试对象相等性

Question

我们正在为一个程序编写测试。我们想编写一个功能测试来验证程序的输出是否符合某些期望。 返回的对象是一个复杂的 JS 对象（具有嵌套对象、许多属性...等）。

我们想测试这显然符合我们的需要。 到目前为止，我们一直在“浏览”对象和预期结果，检查每个属性和每个嵌套对象。这非常麻烦，我们想知道是否有任何库可以仅基于对象“构建”所有测试。比如这样的事情。

var res = {
  a: {
    alpha: [1,2,3],
    beta: "Hello",
    gamma: "World"
    },
    },
    b: 123,
    c: "It depends"
  }
};
var expectation = {
  a: {
    alpha: [1,2,4],
    beta: "Hello",
    gamma: "World"
    },
    },
    b: 123,
    c: "It depends"
  }
};

assert(res, expectation) // -> Raises an error because res[a][b][2] is different from expectation[a][b][2].

[在示例中，我简化了对象的复杂性...]

我应该坚持这样一个事实，即我们需要一段足够聪明的代码来告诉我们有什么不同，而不是仅仅告诉我们两个对象不同。我们现在讨论的是深度平等，但我们还没有发现任何能真正告诉我们差异的东西。

Answer 1

Node 具有用于测试的内置 assert 模块。这有一个名为 deepEqual 的方法，用于深度相等检查。

函数签名是：

assert.deepEqual(actual, expected, [message])

用于测试 deepEquality 并返回 diff 的快速编写函数：

// Will test own properties only
function deepEqualWithDiff(a, e, names){
  var dif = {};
  var aKeys = Object.keys(a);
  var eKeys = Object.keys(e);

  var cKeys = aKeys;
  var dKeys = eKeys;
  var c = a;
  var d = e;
  var names = {
    c: names ? names['a'] : 'Actual',
    d: names ? names['e'] : 'Expected'
  }

  if(eKeys.length > aKeys.length){
    cKeys = eKeys;
    dKeys = aKeys;
    c = e;
    d = a;
    names = {
      d: names ? names['a'] : 'Actual',
      c: names ? names['e'] : 'Expected'
    }
  }


  for(var i = 0, co = cKeys.length; i < co; i++){
    var key = cKeys[i];
    if(typeof c[key] !== typeof d[key]){
      dif[key] = 'Type mismatch ' + names['c'] + ':' + typeof c[key] + '!==' + names['d'] + typeof d[key];
      continue;
    }
    if(typeof c[key] === 'function'){
      if(c[key].toString() !== d[key].toString()){
        dif[key] = 'Differing functions';
      }
      continue;
    }
    if(typeof c[key] === 'object'){
      if(c[key].length !== undefined){ // array
        var temp = c[key].slice(0);
        temp = temp.filter(function(el){
          return (d[key].indexOf(el) === -1);
        });
        var message = '';
        if(temp.length > 0){
          message += names['c'] + ' excess ' + JSON.stringify(temp);
        }

        temp = d[key].slice(0);
        temp = temp.filter(function(el){
          return (c[key].indexOf(el) === -1);
        });
        if(temp.length > 0){
          message += ' and ' + names['d'] + ' excess ' + JSON.stringify(temp);
        }
        if(message !== ''){
          dif[key] = message;
        }
        continue;
      }
      var diff = deepEqualWithDiff(c[key], d[key], {a:names['c'],e:names['d']});
      if(diff !== true && Object.keys(diff).length > 0){
        dif[key] = diff;
      }
      continue;
    }
    // Simple types left so
    if(c[key] !== d[key]){
      dif[key] = names['c'] + ':' + c[key] + ' !== ' + names['d'] + ':' + d[key]; 
    }
  }
  return Object.keys(dif).length > 0 ? dif : true;
}

Answer 2

JavaScript 不支持开箱即用的对象深度相等，我也不知道 NodeJS API 中内置了什么。

我的赌注可能是Underscore 和isEqual 函数。

npm 安装下划线

var _ = require('underscore');
var moe   = {name : 'moe', luckyNumbers : [13, 27, 34]};
var clone = {name : 'moe', luckyNumbers : [13, 27, 34]};
moe == clone;
=> false
_.isEqual(moe, clone);
=> true

虽然大多数 Node 测试框架也应该包含一个对象深度相等断言，但您没有提及您使用的是哪一个。

Answer 3

deep-diff 满足 OP 的要求。它可以比较两个 javascript 对象/JSON 对象，并以您的代码可以访问的方式列出差异。

这是一个老问题，所以这个库可能在提出问题时不存在。

Answer 4

请注意，自 Node.js v9.9.0 起，Node 的 deepEqual() 已被弃用，请改用 deepStrictEqual()：

const assert = require('assert');

const actual = {
  a: {
    name: 'some',
    b: {
      name: 'thing',
    },
  },
};

const expected = {
  a: {
    name: 'thing',
    b: {
      name: 'some',
    },
  },
};

assert.deepStrictEqual(actual, expected, 'Expect names to be equal.');

专业提示：如果您不在deepStrictEqual 中使用自定义消息，您将获得两个对象之间差异的漂亮彩色输出：

Answer 5

虽然我认为已经涵盖了对象比较的基础知识（请参阅 here 和其他人），但如果您正在寻找一种快速而肮脏的方式来执行这些测试并查看两个不相等对象之间的差异，您可以在 Webstorm IDE (here) 中使用 nodeunit 运行测试

Webstorm 与 nodeunit 集成得特别好，并且对于任何 test.equals() 或 test.deepEquals() 断言，它提供了一个可见的差异并突出显示您的差异。我强烈推荐 IDE，因为它将测试集成到我的 js 开发周期中。

现在，如果您需要在代码中访问该测试/差异的结果，这显然对您来说还不够，我建议您从我列出的第一个链接中复制几个 deepEquals 比较器。

祝你好运，

布赖恩

Answer 6

这是我使用 Lodash 编写的一个简单/灵活的深度差异函数：

_.merge(obj1, obj2, function (objectValue, sourceValue, key, object, source) {
    if ( !(_.isEqual(objectValue, sourceValue)) && (Object(objectValue) !== objectValue)) {
        console.log(key + "\n    Expected: " + sourceValue + "\n    Actual: " + objectValue);
    }
});

您可以将console.log() 语句替换为您需要的任何比较逻辑。我的只是将差异打印到控制台。