PSCustomObject.Tests.ps1

#Requires -Modules @{ ModuleName = 'Pester'; ModuleVersion = '6.0.0'; MaximumVersion = '6.*' }

[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
    'PSUseDeclaredVarsMoreThanAssignments', '',
    Justification = 'Pester grouping syntax: known issue.'
)]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
    'PSAvoidUsingConvertToSecureStringWithPlainText', '',
    Justification = 'Used to create a secure string for testing.'
)]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
    'PSAvoidUsingWriteHost', '',
    Justification = 'Log outputs to GitHub Actions logs.'
)]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
    'PSAvoidLongLines', '',
    Justification = 'Long test descriptions and skip switches'
)]
[CmdletBinding()]
param()

Describe 'PSCustomObject' {
    It 'Function: Compare-PSCustomObject' {
        $Left = [PSCustomObject]@{
            Name  = 'Test'
            Value = 1
        }

        $Right = [PSCustomObject]@{
            Name  = 'Test'
            Value = 2
        }

        LogGroup 'Diff' {
            $diff = $Left | Compare-PSCustomObject $Right
            Write-Host "$($diff | Format-Table | Out-String)"
        }

        $diff | Should -HaveCount 2
        $diff.Property | Should -BeIn @('Name', 'Value')
        $diff.Left | Should -BeIn @('Test', 1)
        $diff.Right | Should -BeIn @('Test', 2)
        $diff.Changed | Should -Contain $true
    }

    It 'Function: Compare-PSCustomObject -OnlyChanged' {
        $Left = [PSCustomObject]@{
            Name  = 'Test'
            Value = 1
        }

        $Right = [PSCustomObject]@{
            Name  = 'Test'
            Value = 2
        }

        LogGroup 'Diff' {
            $diff = $Left | Compare-PSCustomObject $Right -OnlyChanged
            Write-Host "$($diff | Format-Table | Out-String)"
        }

        $diff | Should -HaveCount 1
        $diff.Property | Should -Be 'Value'
        $diff.Left | Should -Be 1
        $diff.Right | Should -Be 2
        $diff.Changed | Should -Be $true
    }
}