如何在Pester测试中正确比较Hashtable？

问题背景 #

在Pester测试中直接使用Should -Be对比哈希表时，即便两个哈希表内容完全一致也会报错——这是因为Should -Be判断的是引用相等而非值相等。尝试转成PSCustomObject、仅比较键集合等方式，也会出现类似的匹配问题。

试过的几种方案都存在不足：

• 自定义Test-HashTablesAreEqual方法：无法输出Pester标准的友好错误提示
• 拆分键与值分别比较：操作繁琐，错误信息不够直观
• 转为JSON比较：存在键排序不确定的潜在问题，且无法精准定位差异点

官方推荐的正确方式 #

在Pester 5及以上版本中，直接使用Should -DeepEqual命令即可解决问题。它会递归比较哈希表的所有键和对应值，不匹配时能清晰指出差异的具体位置。

示例代码 #

# 定义预期和实际的哈希表
$expectedHash = @{ 
    Name = "Alice"
    Age  = 30
    Tags = @("Admin", "User")
}
$actualHash = @{ 
    Age  = 30
    Name = "Alice"
    Tags = @("Admin", "User")
}

# 执行深度相等断言
$actualHash | Should -DeepEqual $expectedHash

错误提示示例 #

如果实际哈希表的值不匹配（比如$actualHash.Tags = @("Guest")），Pester会输出清晰的差异提示：

Expected @{ Age = 30; Name = "Alice"; Tags = @("Admin", "User") }, but got @{ Age = 30; Name = "Alice"; Tags = @("Guest") }. Difference at path 'Tags' is @("Guest") instead of @("Admin", "User").

自定义临时解决方案 #

如果使用的是旧版Pester（不支持-DeepEqual），可以使用自定义的Compare-HashtablesInPester函数，它会调用Pester的标准断言逻辑，输出规范的错误信息：

function Compare-HashtablesInPester {
    param(
        [Parameter(Mandatory)]
        [hashtable]$Expected,
        [Parameter(Mandatory)]
        [hashtable]$Actual
    )

    # 先验证键集合完全一致
    $Expected.Keys | Should -Be $Actual.Keys -Because "哈希表的键必须完全匹配"

    # 逐个键对应的值进行比较
    foreach ($key in $Expected.Keys) {
        $Actual[$key] | Should -Be $Expected[$key] -Because "键 '$key' 的值必须匹配预期"
    }
}

# 使用示例
Compare-HashtablesInPester -Expected @{a=1; b=2} -Actual @{a=1; b=3}

当键不匹配时，会提示键集合的差异；当值不匹配时，会明确指出是哪个键对应的值出了问题。

内容的提问来源于stack exchange，提问作者JohnLBevan