在NodeJS中测试对象相等性

时间:2012-09-27 21:02:34

标签: javascript node.js testing

我们正在为一个程序编写测试。我们想编写一个函数测试来验证程序的输出是否符合某些期望。 返回的对象是一个复杂的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].

[在这个例子中,我简化了对象的复杂性......]

我应该坚持这样一个事实,即我们需要一段足够聪明的代码来告诉我们什么是不同的,而不是仅仅告诉我们这2个对象是不同的。我们现在谈到了深刻的平等,但我们还没有找到任何实际告诉我们差异的东西。

6 个答案:

答案 0 :(得分:21)

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

答案 1 :(得分:15)

JavaScript不支持开箱即用的对象深度相等,我也不知道NodeJS API内置任何内容。

我的赌注可能是UnderscoreisEqual功能。

  

npm install underscore

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测试框架也应该包含一个对象深度相等的断言,但你没有提到你正在使用哪一个。

答案 2 :(得分:6)

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

这是一个古老的问题,所以这个图书馆可能在提出问题时并不存在。

答案 3 :(得分:1)

虽然我认为已经涵盖了对象比较的基础知识(参见here和其他),如果你正在寻找一种快速而肮脏的方式来执行这些测试并看到两者之间的差异不相等对象,您可以使用Webstorm IDE(here

中的nodeunit运行测试

Webstorm与nodeunit集成得特别好,对于任何test.equals()或test.deepEquals()断言,它都提供了一个可查看的差异,突出显示你的不足。我强烈推荐IDE,它将测试集成到我的js开发周期中。

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

祝你好运,

布赖恩

答案 4 :(得分:1)

请注意,自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中使用自定义消息,则会得到两个对象之间差异的漂亮彩色输出:

enter image description here

答案 5 :(得分:0)

这是我使用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()语句。我只是将差异打印到控制台。