# Copyright (c) Microsoft Corporation. # Licensed under the MIT License. function New-NestedJson { Param( [ValidateRange(1, 2048)] [int] $Depth ) $nestedJson = "true" $Depth..1 | ForEach-Object { $nestedJson = '{"' + $_ + '":' + $nestedJson + '}' } return $nestedJson } function Count-ObjectDepth { Param([PSCustomObject] $InputObject) for ($i=1; $i -le 2048; $i++) { $InputObject = Select-Object -InputObject $InputObject -ExpandProperty $i if ($InputObject -eq $true) { return $i } } } Describe 'ConvertFrom-Json Unit Tests' -tags "CI" { BeforeAll { $testCasesWithAndWithoutAsHashtableSwitch = @( @{ AsHashtable = $true } @{ AsHashtable = $false } ) $testCasesWithAndWithoutNoEnumerateSwitch = @( @{ NoEnumerate = $true } @{ NoEnumerate = $false } ) } It 'Can convert a single-line object with AsHashtable switch set to ' -TestCases $testCasesWithAndWithoutAsHashtableSwitch { Param($AsHashtable) ('{"a" : "1"}' | ConvertFrom-Json -AsHashtable:$AsHashtable).a | Should -Be 1 } It 'Can convert one string-per-object with AsHashtable switch set to ' -TestCases $testCasesWithAndWithoutAsHashtableSwitch { Param($AsHashtable) $json = @('{"a" : "1"}', '{"a" : "x"}') | ConvertFrom-Json -AsHashtable:$AsHashtable $json.Count | Should -Be 2 $json[1].a | Should -Be 'x' if ($AsHashtable) { $json | Should -BeOfType Hashtable } } It 'Throws an ArgumentException with an incomplete array with AsHashtable switch set to ' -TestCase $testCasesWithAndWithoutAsHashtableSwitch { Param($AsHashtable) { ConvertFrom-Json '["1",' -AsHashtable:$AsHashtable } | Should -Throw -ErrorId "System.ArgumentException,Microsoft.PowerShell.Commands.ConvertFromJsonCommand" { ConvertFrom-Json '[' -AsHashtable:$AsHashtable } | Should -Throw -ErrorId "System.ArgumentException,Microsoft.PowerShell.Commands.ConvertFromJsonCommand" } It 'Can convert multi-line object with AsHashtable switch set to ' -TestCases $testCasesWithAndWithoutAsHashtableSwitch { Param($AsHashtable) $json = @('{"a" :', '"x"}') | ConvertFrom-Json -AsHashtable:$AsHashtable $json.a | Should -Be 'x' if ($AsHashtable) { $json | Should -BeOfType Hashtable } } It 'Can convert an object with Newtonsoft.Json metadata properties with AsHashtable switch set to ' -TestCases $testCasesWithAndWithoutAsHashtableSwitch { Param($AsHashtable) $id = 13 $type = 'Calendar.Months.December' $ref = 1989 $json = '{"$id":' + $id + ', "$type":"' + $type + '", "$ref":' + $ref + '}' | ConvertFrom-Json -AsHashtable:$AsHashtable $json.'$id' | Should -Be $id $json.'$type' | Should -Be $type $json.'$ref' | Should -Be $ref if ($AsHashtable) { $json | Should -BeOfType Hashtable } } It 'Can convert an object of depth 1024 by default with AsHashtable switch set to ' -TestCases $testCasesWithAndWithoutAsHashtableSwitch { Param($AsHashtable) $nestedJson = New-NestedJson -Depth 1024 $json = $nestedJson | ConvertFrom-Json -AsHashtable:$AsHashtable if ($AsHashtable) { $json | Should -BeOfType Hashtable } else { $json | Should -BeOfType PSCustomObject } } It 'Fails to convert an object of depth higher than 1024 by default with AsHashtable switch set to ' -TestCases $testCasesWithAndWithoutAsHashtableSwitch { Param($AsHashtable) $nestedJson = New-NestedJson -Depth 1025 { $nestedJson | ConvertFrom-Json -AsHashtable:$AsHashtable } | Should -Throw -ErrorId "System.ArgumentException,Microsoft.PowerShell.Commands.ConvertFromJsonCommand" } It 'Can correctly round trip arrays with NoEnumerate switch set to ' -TestCases $testCasesWithAndWithoutNoEnumerateSwitch { Param($NoEnumerate) '[ 1, 2 ]' | ConvertFrom-Json -NoEnumerate:$NoEnumerate | ConvertTo-Json -Compress | Should -Be '[1,2]' } It 'Unravels array elements when NoEnumerate switch is not set' { ('[ 1, 2 ]' | ConvertFrom-Json | Measure-Object).Count | Should -Be 2 } It 'Sends a Json array as a single element when NoEnumerate switch is set' { ('[ 1, 2 ]' | ConvertFrom-Json -NoEnumerate | Measure-Object).Count | Should -Be 1 } It 'Cannot round trip single element arrays without NoEnumerate switch' { '[ 1 ]' | ConvertFrom-Json | ConvertTo-Json | Should -Be 1 } It 'Can round trip single element arrays with NoEnumerate switch' { '[ 1 ]' | ConvertFrom-Json -NoEnumerate | ConvertTo-Json -Compress | Should -Be '[1]' } It 'Can convert null' { 'null' | ConvertFrom-Json | Should -Be $null $out = '[1, null, 2]' | ConvertFrom-Json $out.Length | Should -Be 3 # can't compare directly to array as Pester doesn't handle the $null $out[0] | Should -Be 1 $out[1] | Should -Be $null $out[2] | Should -Be 2 } It 'Order is preserved for a hashtable' { $json = '{"a":1,"b":2,"c":3}' | ConvertFrom-Json -AsHashtable ($json | Out-String).Trim() | Should -BeExactly @" Name Value ---- ----- a 1 b 2 c 3 "@ } It 'Parses DateKind Default strings for ' -TestCases @( @{ Value = '"2022-11-02T12:01:44.5801388+04:00"' Expected = ([DateTimeOffset]::new(2022, 11, 2, 12, 1, 44, 580, 138, (New-TimeSpan -Hours 4)).AddTicks(8).LocalDateTime) } @{ Value = '"2022-11-02T12:01:44.5801388-04:00"' Expected = ([DateTimeOffset]::new(2022, 11, 2, 12, 1, 44, 580, 138, (New-TimeSpan -Hours -4)).AddTicks(8).LocalDateTime) } @{ Value = '"1970-01-01T00:00:00"' Expected = ([DateTime]::new(1970, 1, 1, 0, 0, 0, 0, 0, 'Unspecified')) } @{ Value = '"1970-01-01T00:00:00.0000000Z"' Expected = ([DateTimeOffset]::new(1970, 1, 1, 0, 0, 0, 0, 0, (New-TimeSpan -Hours 0)).UtcDateTime) } @{ Value = '"1970-01-01T00:00:00.0000000+00:00"' Expected = ([DateTimeOffset]::new(1970, 1, 1, 0, 0, 0, 0, 0, (New-TimeSpan -Hours 0)).LocalDateTime) } @{ Value = '"1970-01-01T00:00:00.0000000-00:00"' Expected = ([DateTimeOffset]::new(1970, 1, 1, 0, 0, 0, 0, 0, (New-TimeSpan -Hours 0)).LocalDateTime) } @{ Value = '"1970-01-01T00:00:00.0000000+10:00"' Expected = ([DateTimeOffset]::new(1970, 1, 1, 0, 0, 0, 0, 0, (New-TimeSpan -Hours 10)).LocalDateTime) } @{ Value = '"1970-01-01T00:00:00.0000000-10:00"' Expected = ([DateTimeOffset]::new(1970, 1, 1, 0, 0, 0, 0, 0, (New-TimeSpan -Hours -10)).LocalDateTime) } ) { param ($Value, $Expected) $json = $Value | ConvertFrom-Json $json | Should -BeOfType ([DateTime]) $json.Kind | Should -Be $Expected.Kind $json | Should -Be $Expected $json = $Value | ConvertFrom-Json -DateKind Default $json | Should -BeOfType ([DateTime]) $json.Kind | Should -Be $Expected.Kind $json | Should -Be $Expected } It 'Parses DateKind Local strings for ' -TestCases @( @{ Value = '"2022-11-02T12:01:44.5801388+04:00"' Expected = ([DateTimeOffset]::new(2022, 11, 2, 12, 1, 44, 580, 138, (New-TimeSpan -Hours 4)).AddTicks(8).LocalDateTime) } @{ Value = '"2022-11-02T12:01:44.5801388-04:00"' Expected = ([DateTimeOffset]::new(2022, 11, 2, 12, 1, 44, 580, 138, (New-TimeSpan -Hours -4)).AddTicks(8).LocalDateTime) } @{ Value = '"1970-01-01T00:00:00"' Expected = ([DateTime]::new(1970, 1, 1, 0, 0, 0, 0, 0, 'Local')) } @{ Value = '"1970-01-01T00:00:00.0000000Z"' Expected = ([DateTimeOffset]::new(1970, 1, 1, 0, 0, 0, 0, 0, (New-TimeSpan -Hours 0)).LocalDateTime) } @{ Value = '"1970-01-01T00:00:00.0000000+00:00"' Expected = ([DateTimeOffset]::new(1970, 1, 1, 0, 0, 0, 0, 0, (New-TimeSpan -Hours 0)).LocalDateTime) } @{ Value = '"1970-01-01T00:00:00.0000000-00:00"' Expected = ([DateTimeOffset]::new(1970, 1, 1, 0, 0, 0, 0, 0, (New-TimeSpan -Hours 0)).LocalDateTime) } @{ Value = '"1970-01-01T00:00:00.0000000+10:00"' Expected = ([DateTimeOffset]::new(1970, 1, 1, 0, 0, 0, 0, 0, (New-TimeSpan -Hours 10)).LocalDateTime) } @{ Value = '"1970-01-01T00:00:00.0000000-10:00"' Expected = ([DateTimeOffset]::new(1970, 1, 1, 0, 0, 0, 0, 0, (New-TimeSpan -Hours -10)).LocalDateTime) } ) { param ($Value, $Expected) $json = $Value | ConvertFrom-Json -DateKind Local $json | Should -BeOfType ([DateTime]) $json.Kind | Should -Be Local $json | Should -Be $Expected } It 'Parses DateKind Utc strings for ' -TestCases @( @{ Value = '"2022-11-02T12:01:44.5801388+04:00"' Expected = ([DateTimeOffset]::new(2022, 11, 2, 12, 1, 44, 580, 138, (New-TimeSpan -Hours 4)).AddTicks(8).UtcDateTime) } @{ Value = '"2022-11-02T12:01:44.5801388-04:00"' Expected = ([DateTimeOffset]::new(2022, 11, 2, 12, 1, 44, 580, 138, (New-TimeSpan -Hours -4)).AddTicks(8).UtcDateTime) } @{ Value = '"1970-01-01T00:00:00"' Expected = ([DateTime]::new(1970, 1, 1, 0, 0, 0, 0, 0, 'Utc')) } @{ Value = '"1970-01-01T00:00:00.0000000Z"' Expected = ([DateTimeOffset]::new(1970, 1, 1, 0, 0, 0, 0, 0, (New-TimeSpan -Hours 0)).UtcDateTime) } @{ Value = '"1970-01-01T00:00:00.0000000+00:00"' Expected = ([DateTimeOffset]::new(1970, 1, 1, 0, 0, 0, 0, 0, (New-TimeSpan -Hours 0)).UtcDateTime) } @{ Value = '"1970-01-01T00:00:00.0000000-00:00"' Expected = ([DateTimeOffset]::new(1970, 1, 1, 0, 0, 0, 0, 0, (New-TimeSpan -Hours 0)).UtcDateTime) } @{ Value = '"1970-01-01T00:00:00.0000000+10:00"' Expected = ([DateTimeOffset]::new(1970, 1, 1, 0, 0, 0, 0, 0, (New-TimeSpan -Hours 10)).UtcDateTime) } @{ Value = '"1970-01-01T00:00:00.0000000-10:00"' Expected = ([DateTimeOffset]::new(1970, 1, 1, 0, 0, 0, 0, 0, (New-TimeSpan -Hours -10)).UtcDateTime) } ) { param ($Value, $Expected) $json = $Value | ConvertFrom-Json -DateKind Utc $json | Should -BeOfType ([DateTime]) $json.Kind | Should -Be Utc $json | Should -Be $Expected } It 'Parses DateKind Offset strings for ' -TestCases @( @{ Value = '"2022-11-02T12:01:44.5801388+04:00"' Expected = ([DateTimeOffset]::new(2022, 11, 2, 12, 1, 44, 580, 138, (New-TimeSpan -Hours 4)).AddTicks(8)) } @{ Value = '"2022-11-02T12:01:44.5801388-04:00"' Expected = ([DateTimeOffset]::new(2022, 11, 2, 12, 1, 44, 580, 138, (New-TimeSpan -Hours -4)).AddTicks(8)) } @{ Value = '"1970-01-01T00:00:00"' Expected = ([DateTimeOffset]::new([DateTime]::new(1970, 1, 1, 0, 0, 0, 0, 0, 'Local'))) } @{ Value = '"1970-01-01T00:00:00.0000000Z"' Expected = ([DateTimeOffset]::new(1970, 1, 1, 0, 0, 0, 0, 0, (New-TimeSpan -Hours 0))) } @{ Value = '"1970-01-01T00:00:00.0000000+00:00"' Expected = ([DateTimeOffset]::new(1970, 1, 1, 0, 0, 0, 0, 0, (New-TimeSpan -Hours 0))) } @{ Value = '"1970-01-01T00:00:00.0000000-00:00"' Expected = ([DateTimeOffset]::new(1970, 1, 1, 0, 0, 0, 0, 0, (New-TimeSpan -Hours 0))) } @{ Value = '"1970-01-01T00:00:00.0000000+10:00"' Expected = ([DateTimeOffset]::new(1970, 1, 1, 0, 0, 0, 0, 0, (New-TimeSpan -Hours 10))) } @{ Value = '"1970-01-01T00:00:00.0000000-10:00"' Expected = ([DateTimeOffset]::new(1970, 1, 1, 0, 0, 0, 0, 0, (New-TimeSpan -Hours -10))) } ) { param ($Value, $Expected) $json = $Value | ConvertFrom-Json -DateKind Offset $json | Should -BeOfType ([DateTimeOffset]) $json.EqualsExact($Expected) | Should -BeTrue } It 'Parses DateKind String strings for ' -TestCases @( @{ Value = '"2022-11-02T12:01:44.5801388+04:00"' } @{ Value = '"2022-11-02T12:01:44.5801388-04:00"' } @{ Value = '"1970-01-01T00:00:00"' } @{ Value = '"1970-01-01T00:00:00.0000000Z"' } @{ Value = '"1970-01-01T00:00:00.0000000+00:00"' } @{ Value = '"1970-01-01T00:00:00.0000000-00:00"' } @{ Value = '"1970-01-01T00:00:00.0000000+10:00"' } @{ Value = '"1970-01-01T00:00:00.0000000-10:00"' } ) { param ($Value) $json = $Value | ConvertFrom-Json -DateKind String $json | Should -BeOfType ([string]) $json | Should -Be $Value.Substring(1, $Value.Length - 2) } It 'Ignores comments in arrays' -TestCase $testCasesWithAndWithoutAsHashtableSwitch { param($AsHashtable) # https://github.com/powerShell/powerShell/issues/14553 '[ // comment 100, /* comment */ 200 ]' | ConvertFrom-Json -AsHashtable:$AsHashtable | Should -Be @(100, 200) } It 'Ignores comments in dictionaries' -TestCase $testCasesWithAndWithoutAsHashtableSwitch { param($AsHashtable) $json = '{ // comment "a": 100, /* comment */ "b": 200 }' | ConvertFrom-Json -AsHashtable:$AsHashtable if ($AsHashtable) { $json.Keys | Should -Be @("a", "b") } else { $json.psobject.Properties | Should -HaveCount 2 } $json.a | Should -Be 100 $json.b | Should -Be 200 } } Describe 'ConvertFrom-Json -Depth Tests' -tags "Feature" { BeforeAll { $testCasesJsonDepthWithAndWithoutAsHashtableSwitch = @( @{ Depth = 2; AsHashtable = $true } @{ Depth = 2; AsHashtable = $false } @{ Depth = 200; AsHashtable = $true } @{ Depth = 200; AsHashtable = $false } @{ Depth = 2000; AsHashtable = $true } @{ Depth = 2000; AsHashtable = $false } ) } It 'Can convert an object with depth less than Depth param set to and AsHashtable switch set to ' -TestCases $testCasesJsonDepthWithAndWithoutAsHashtableSwitch { Param($AsHashtable, $Depth) $nestedJson = New-NestedJson -Depth ($Depth - 1) $json = $nestedJson | ConvertFrom-Json -AsHashtable:$AsHashtable -Depth $Depth if ($AsHashtable) { $json | Should -BeOfType Hashtable } else { $json | Should -BeOfType PSCustomObject } (Count-ObjectDepth -InputObject $json) | Should -Be ($Depth - 1) } It 'Can convert an object with depth equal to Depth param set to and AsHashtable switch set to ' -TestCases $testCasesJsonDepthWithAndWithoutAsHashtableSwitch { Param($AsHashtable, $Depth) $nestedJson = New-NestedJson -Depth:$Depth $json = $nestedJson | ConvertFrom-Json -AsHashtable:$AsHashtable -Depth $Depth if ($AsHashtable) { $json | Should -BeOfType Hashtable } else { $json | Should -BeOfType PSCustomObject } (Count-ObjectDepth -InputObject $json) | Should -Be $Depth } It 'Fails to convert an object with greater depth than Depth param set to and AsHashtable switch set to ' -TestCases $testCasesJsonDepthWithAndWithoutAsHashtableSwitch { Param($AsHashtable, $Depth) $nestedJson = New-NestedJson -Depth ($Depth + 1) { $nestedJson | ConvertFrom-Json -AsHashtable:$AsHashtable -Depth $Depth } | Should -Throw -ErrorId "System.ArgumentException,Microsoft.PowerShell.Commands.ConvertFromJsonCommand" } }