PowerShell PSCustomObjectの差分確認

Question

前提・実現したいこと

PowerShellのPSCustomObject同士で、差分確認を行いたいです。

該当のソースコード

gc Config_File.json
[{"hoge":"foo"}]

gc Task_Json.json
[{"hoge":"foo"}]

$PSCsustomObject1 = (gc Config_File.json | ConvertFrom-Json)
$PSCsustomObject2 = (gc Task_Json.json | ConvertFrom-Json)

if($PSCsustomObject1[0] -eq $PSCsustomObject2[0]){
        $NOT_Processing_Flag = 1
                                                 }

if($NOT_Processing_Flag -ne 1){
        Main_Process
                              }

試したこと

上記のソースコードを実行すると、if文の結果が、「False」になりますが、
比較演算子を「match」に変えると、結果が「True」になります。
「eq」と「match」の差は正規表現が使えるか否かの差だと、
認識しているので、今回の場合であれば、結果が同じになると想定しているのですが、
なぜ、結果が異なるのでしょうか。
また、PSCustomObjectで差分を確認する際の演算子は、どちらが正しいのでしょうか。

補足情報（FW/ツールのバージョンなど）

・PSVersion 5.1

Answer 1

また、PSCustomObjectで差分を確認する際の演算子は、どちらが正しいのでしょうか。

構造的に同じかどうかを比較したい場合はどちらも不適切です。

試したこと の動作のイメージ

まず、-eq演算子のときですが、PSCustomObjectの場合は左辺と右辺が同じ参照かどうかを比較します。

具体的には以下のような場合にTrueになります。

$PSCsustomObject1[0] -eq $PSCsustomObject1[0]
$PSCsustomObject2[0] -eq $PSCsustomObject2[0]

それ以外の場合はFalseになります。

-match演算子のときは、-match演算子は文字列を対象とした演算子のため、
左辺と右辺の両方が文字列に変換され、その上で文字列として比較が行われます。

今回の場合は、文字列化したときの結果がたまたま一致し、正規表現のメタ文字も含まれなかったため、結果がTrueとなりました。

仮に、プロパティが複数あり、文字列化したときのプロパティの表示の順番が異なっていれば、-match演算子でもFalseになります。

具体的には以下のような場合はFalseになります。

$pso1, $pso2 = @(@'
[
    {
        "hoge":"foo",
        "fuga":"bar"
    },
    {
        "fuga":"bar",
        "hoge":"foo"
    }
]
'@ | ConvertFrom-Json).ForEach({$_})

$pso1 -match $pso2

対策案

CSV化して比較

単純な値のみが含まれる場合は、ConvertTo-Csvで文字列化して比較するのが簡単だと思われます。

ConvertTo-Csvに複数のオブジェクトをパイプライン入力した場合、先頭のオブジェクトに合わせてプロパティの整列が行われるためです。

$pso1, $pso2 = @(@'
[
    {
        "hoge":"foo",
        "fuga":"bar"
    },
    {
        "fuga":"bar",
        "hoge":"foo"
    }
]
'@ | ConvertFrom-Json).ForEach({$_})

# 1行目はヘッダーなので捨てる
$null, [string]$pso1AsCsv, [string]$pso2AsCsv =
    @($pso1, $pso2) | 
        ConvertTo-Csv -NoTypeInformation

$pso1AsCsv -eq $pso2AsCsv

各プロパティについて詳細な比較

単純に文字列化できない要素を含んでいる場合は、各プロパティを列挙して比較することになるでしょう。

いろいろ考慮不足な簡易的な実装ですが、以下のコードのようなイメージです。

using namespace System.Management.Automation

function Test-PSCustomObject {
<#
.SYNOPSIS
二つのオブジェクトが構造的に等しいかどうかを判定します。
簡易的な実装です。
https://teratail.com/questions/227831
#>
    Param(
        [Parameter(Mandatory = $true)]
        [PSCustomObject]$Base
        ,
        [Parameter(Mandatory = $true)]
        [PSCustomObject]$Target
    )
    [PSMemberInfoCollection[PSPropertyInfo]]$targeteProps =
        $Target.psobject.Properties
    # 各プロパティについて名前を一致するプロパティを探し、値が一致するかどうか確認する
    [PSPropertyInfo]$baseProp = $null
    foreach ($baseProp in $Base.psobject.Properties) {
        [ReadOnlyPSMemberInfoCollection[PSPropertyInfo]]$matchProps =
            $targeteProps.Match($baseProp.Name)
        if ($matchProps.Count -eq 0) {
            Write-Verbose -Message ('$Targetに"{0}"という名前のプロパティがありません。' -f $baseProp.Name)
            return $false
        }

        if ($matchProps[0].Value -ne $baseProp.Value) {
            Write-Verbose -Message ('$Targetの"{0}"という名前のプロパティの値が$Baseと異なります(Base = {1}, Target = {2})。' -f $baseProp.Name, $baseProp.Value, $matchProps[0].Value)
            return $false
        }
    }
    return $true
}