TUnit项目中字典等价性断言的问题分析与修复

引言

在单元测试中，断言两个字典是否等价是一个常见需求。TUnit测试框架提供了IsEquivalentTo方法来验证两个字典是否包含相同的键值对。然而，在处理不同类型的字典时，特别是ImmutableDictionary与普通Dictionary时，断言行为存在不一致性，这可能导致开发者困惑。

问题现象

当使用ImmutableDictionary进行等价性断言时，如果字典键不匹配，会抛出KeyNotFoundException异常：

await Assert.That(ImmutableDictionary<string, int>.Empty.Add("Hello", 1))
  .IsEquivalentTo(ImmutableDictionary<string, int>.Empty.Add("Hello2", 1));

而同样的测试用例使用普通Dictionary时，则会正确生成一个AssertionException，明确指出哪些键不匹配：

await Assert.That(new Dictionary<string, int> {{"Hello", 1}})
  .IsEquivalentTo(new Dictionary<string, int> { { "Hello2", 1 } });

问题根源分析

这种不一致行为源于.NET中不同字典类型对IDictionary接口的实现差异：

1. 普通Dictionary：当通过非泛型IDictionary接口访问不存在的键时，会返回null值
2. ImmutableDictionary：无论通过哪种接口访问，都会抛出KeyNotFoundException

TUnit框架内部实现是通过收集两个字典的所有键，然后逐一比较每个键对应的值。当遇到不存在的键时，不同字典类型的行为差异导致了上述不一致现象。

潜在问题

这种实现方式还存在一个更隐蔽的问题：当字典中包含null值时，可能导致误判。例如：

await Assert.That(new Dictionary<string, string?> {{"Hello", "a"}, {"Hello2", null}})
  .IsEquivalentTo(new Dictionary<string, string?> { { "Hello", "a" } });

这个断言会错误地通过，因为在比较"Hello2"键时，预期字典中不存在该键会返回null，与实际的null值匹配。

解决方案

更健壮的字典等价性比较算法应该：

1. 首先比较两个字典的键集合是否相同
2. 然后仅对共有的键进行值比较
3. 明确报告缺失或多余的键

伪代码实现如下：

var actualKeys = new HashSet<object>(actualDictionary.Keys);

foreach (var expectedKV in expectedDictionary) {
    if (actualKeys.Contains(expectedKV.Key)) {
        // 比较值
        actualKeys.Remove(expectedKV.Key);
    } else {
        // 报告缺失的键
    }
}

if (actualKeys.Count > 0) {
    // 报告多余的键
}

修复结果

TUnit框架在版本0.19.136中修复了这个问题，现在无论使用Dictionary还是ImmutableDictionary，都能提供一致的断言行为和清晰的错误信息。

最佳实践建议

1. 在编写字典等价性断言时，明确考虑null值的语义
2. 对于不可变字典，注意其严格的行为特性
3. 更新到最新版本的TUnit框架以获得一致的断言体验
4. 在复杂场景下，考虑编写自定义的比较逻辑

通过这次问题修复，TUnit框架在字典比较方面的行为更加一致和可靠，为开发者提供了更好的测试体验。