Assert.AreEqual 如何确定两个泛型 IEnumerable 之间的相等性？

Question

我有一个单元测试来检查方法是否返回正确的 IEnumerable。 该方法使用 yield return 构建可枚举值。 它是可枚举的类如下：

enum TokenType
{
    NUMBER,
    COMMAND,
    ARITHMETIC,
}

internal class Token
{
    public TokenType type { get; set; }
    public string text { get; set; }
    public static bool operator == (Token lh, Token rh) { return (lh.type == rh.type) && (lh.text == rh.text); }
    public static bool operator != (Token lh, Token rh) { return !(lh == rh); }
    public override int GetHashCode()
    {
        return text.GetHashCode() % type.GetHashCode();
    }
    public override bool Equals(object obj)
    {
        return this == (Token)obj;
    }
}

这是该方法的相关部分：

 foreach (var lookup in REGEX_MAPPING)
 {
     if (lookup.re.IsMatch(s))
     {
         yield return new Token { type = lookup.type, text = s };
         break;
     }
 }

如果我将此方法的结果存储在 actual 中，则创建另一个可枚举 expected，并像这样比较它们……

  Assert.AreEqual(expected, actual);

，断言失败。

我为 IEnumerable 编写了一个扩展方法，类似于 Python 的 zip 函数（它将两个 IEnumerables 组合成一组对）并尝试了这个：

foreach(Token[] t in expected.zip(actual))
{
    Assert.AreEqual(t[0], t[1]);
}

它有效！ 那么这两个Assert.AreEqual有什么区别呢？

Answer 1

找到了：

Assert.IsTrue(expected.SequenceEqual(actual));

Answer 2

您是否考虑过使用CollectionAssert类来代替......考虑到它的目的是对集合执行相等检查？

附录：
如果要比较的“集合”是枚举，那么简单地用“new List(enumeration)”包装它们是执行比较的最简单方法。 构建新列表当然会产生一些开销，但在单元测试的上下文中，我希望这应该不会太重要？

Answer 3

Assert.AreEqual 将比较手头的两个对象。 IEnumerable 本身就是类型，并提供了一种迭代某些集合的机制……但它们实际上并不是那个集合。 您最初的比较比较了两个 IEnumerable，这是一个有效的比较......但不是您所需要的。 您需要比较两个 IEnumerable 想要枚举的内容。

以下是我比较两个枚举的方法：

Assert.AreEqual(t1.Count(), t2.Count());

IEnumerator<Token> e1 = t1.GetEnumerator();
IEnumerator<Token> e2 = t2.GetEnumerator();

while (e1.MoveNext() && e2.MoveNext())
{
    Assert.AreEqual(e1.Current, e2.Current);
}

我不确定上面的代码是否比您的 .Zip 方法少，但它非常简单。

Answer 4

我认为断言你想要的平等的最简单和最清晰的方法是结合 jerryjvl 的答案和 MEMark 对他的帖子的评论 - 将 CollectionAssert.AreEqual 与扩展方法结合起来：

CollectionAssert.AreEqual(expected.ToArray(), actual.ToArray());

这提供了比OP 建议的 SequenceEqual 答案（它会告诉您发现了哪个元素是意外的）。 例如：

IEnumerable<string> expected = new List<string> { "a", "b" };
IEnumerable<string> actual   = new List<string> { "a", "c" }; // mismatching second element

CollectionAssert.AreEqual(expected.ToArray(), actual.ToArray());
// Helpful failure message!
//  CollectionAssert.AreEqual failed. (Element at index 1 do not match.)    

Assert.IsTrue(expected.SequenceEqual(actual));
// Mediocre failure message:
//  Assert.IsTrue failed.   

如果/当你的测试失败时，你会真的很高兴你这样做了 - 有时你甚至可以知道出了什么问题，而无需打破调试器 - 嘿，你正在做 TDD对吧，所以你先写一个失败的测试，对吗？ ;-)

如果您使用 AreEquivalent 来测试等效性（顺序无关紧要），错误消息会变得更加有用：

CollectionAssert.AreEquivalent(expected.ToList(), actual.ToList());
// really helpful error message!
//  CollectionAssert.AreEquivalent failed. The expected collection contains 1
//  occurrence(s) of <b>. The actual collection contains 0 occurrence(s).