Skip to content

Add tests for ConvertFrom-Json #15706

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
daxian-dbw merged 9 commits into from
Jul 16, 2021
Merged

Add tests for ConvertFrom-Json #15706

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
15f15a8
Add datetime tests to the convertfrom-json tests
strawgate Jul 1, 2021
f2a66fc
Add parsing for a large complex json object
strawgate Jul 1, 2021
f31bdd8
add explicit tests for number handling
strawgate Jul 1, 2021
69104c4
add additional number tests to account for precision and biginteger v…
strawgate Jul 1, 2021
4280ac7
Fixes from PR Comments
strawgate Jul 1, 2021
ec4aec4
Additional cleanup from PR comments
strawgate Jul 1, 2021
592a440
Coerce to UTC before running tests
strawgate Jul 1, 2021
f995686
Switch to beexactly
strawgate Jul 9, 2021
e9eb1b9
Formatting fixes
strawgate Jul 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
252 changes: 252 additions & 0 deletions test/powershell/Modules/Microsoft.PowerShell.Utility/Json.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -345,6 +345,258 @@ Describe "Json Tests" -Tags "Feature" {
ValidateSampleObject -result $result -hasEmbeddedSampleObject
}

It "ConvertFrom-Json correctly processes datetimes vs strings using newtonsoft conventions" {
# Create all the various "standard" date formats from a source date 2008-09-22T14:01:54.9571247Z
# Then we deserialize them and verify which ones newtonsoft decides to make into datetimes and which ones newtonsoft keeps as strings
# For the ones that are datetimes, make sure they retain all of the various formats correctly
# for the ones that are strings just verify that they are actually strings.

$json = @"
{
"date-s-should-parse-as-datetime": "2008-09-22T14:01:54",
"date-upperO-should-parse-as-datetime": "2008-09-22T14:01:54.9571247Z",

"date-o-should-parse-as-string": "2019-12-17T06:14:06 +06:00",
"date-upperD-should-parse-as-string": "Monday, September 22, 2008",
"date-f-should-parse-as-string": "Monday, September 22, 2008 2:01 PM",
"date-upperF-should-parse-as-string": "Monday, September 22, 2008 2:01:54 PM",
"date-g-should-parse-as-string": "9/22/2008 2:01 PM",
"date-upperG-should-parse-as-string": "9/22/2008 2:01:54 PM",
"date-m-should-parse-as-string": "September 22",
"date-upperM-should-parse-as-string": "September 22",
"date-upperR-should-parse-as-string": "Mon, 22 Sep 2008 14:01:54 GMT",
"date-t-should-parse-as-string": "2:01 PM",
"date-upperT-should-parse-as-string": "2:01:54 PM",
"date-u-should-parse-as-string": "2008-09-22 14:01:54Z",
"date-upperU-should-parse-as-string": "Monday, September 22, 2008 2:01:54 PM",
"date-upperY-should-parse-as-string": "September 2008",
"date-y-should-parse-as-string": "September 2008"
}
"@
foreach ($asHashtableOption in @($True, $False)) {
$result = ConvertFrom-Json $json -AsHashtable:$asHashtableOption

# If the timezone is not specified in the input string newtonsoft assumes the system timezone.
# this means that some tests will fail locally but work on the build farm and vice-versa.
# this is used to force the datetime into UTC without changing the value so 4PM Central becomes 4PM UTC instead of becoming 10PM UTC
$result."date-s-should-parse-as-datetime" = [datetime]::SpecifyKind($result."date-s-should-parse-as-datetime", [System.DateTimeKind]::Utc)
$result."date-s-should-parse-as-datetime".ToString("d") | Should -Be "9/22/2008"
$result."date-s-should-parse-as-datetime".ToString("D") | Should -Be "Monday, September 22, 2008"
$result."date-s-should-parse-as-datetime".ToString("f") | Should -Be "Monday, September 22, 2008 2:01 PM"
$result."date-s-should-parse-as-datetime".ToString("F") | Should -Be "Monday, September 22, 2008 2:01:54 PM"
$result."date-s-should-parse-as-datetime".ToString("g") | Should -Be "9/22/2008 2:01 PM"
$result."date-s-should-parse-as-datetime".ToString("G") | Should -Be "9/22/2008 2:01:54 PM"
$result."date-s-should-parse-as-datetime".ToString("m") | Should -Be "September 22"
$result."date-s-should-parse-as-datetime".ToString("M") | Should -Be "September 22"
$result."date-s-should-parse-as-datetime".ToString("o") | Should -Be "2008-09-22T14:01:54.0000000Z"
$result."date-s-should-parse-as-datetime".ToString("O") | Should -Be "2008-09-22T14:01:54.0000000Z"
$result."date-s-should-parse-as-datetime".ToString("R") | Should -Be "Mon, 22 Sep 2008 14:01:54 GMT"
$result."date-s-should-parse-as-datetime".ToString("s") | Should -Be "2008-09-22T14:01:54"
$result."date-s-should-parse-as-datetime".ToString("t") | Should -Be "2:01 PM"
$result."date-s-should-parse-as-datetime".ToString("T") | Should -Be "2:01:54 PM"
$result."date-s-should-parse-as-datetime".ToString("u") | Should -Be "2008-09-22 14:01:54Z"
$result."date-s-should-parse-as-datetime".ToString("U") | Should -Be "Monday, September 22, 2008 2:01:54 PM"
$result."date-s-should-parse-as-datetime".ToString("Y") | Should -Be "September 2008"
$result."date-s-should-parse-as-datetime".ToString("y") | Should -Be "September 2008"
$result."date-s-should-parse-as-datetime" | Should -BeOfType [DateTime]

$result."date-upperO-should-parse-as-datetime" = [datetime]::SpecifyKind($result."date-upperO-should-parse-as-datetime", [System.DateTimeKind]::Utc)
$result."date-upperO-should-parse-as-datetime".ToString("d") | Should -Be "9/22/2008"
$result."date-upperO-should-parse-as-datetime".ToString("D") | Should -Be "Monday, September 22, 2008"
$result."date-upperO-should-parse-as-datetime".ToString("f") | Should -Be "Monday, September 22, 2008 2:01 PM"
$result."date-upperO-should-parse-as-datetime".ToString("F") | Should -Be "Monday, September 22, 2008 2:01:54 PM"
$result."date-upperO-should-parse-as-datetime".ToString("g") | Should -Be "9/22/2008 2:01 PM"
$result."date-upperO-should-parse-as-datetime".ToString("G") | Should -Be "9/22/2008 2:01:54 PM"
$result."date-upperO-should-parse-as-datetime".ToString("m") | Should -Be "September 22"
$result."date-upperO-should-parse-as-datetime".ToString("M") | Should -Be "September 22"
$result."date-upperO-should-parse-as-datetime".ToString("o") | Should -Be "2008-09-22T14:01:54.9571247Z"
$result."date-upperO-should-parse-as-datetime".ToString("O") | Should -Be "2008-09-22T14:01:54.9571247Z"
$result."date-upperO-should-parse-as-datetime".ToString("R") | Should -Be "Mon, 22 Sep 2008 14:01:54 GMT"
$result."date-upperO-should-parse-as-datetime".ToString("s") | Should -Be "2008-09-22T14:01:54"
$result."date-upperO-should-parse-as-datetime".ToString("t") | Should -Be "2:01 PM"
$result."date-upperO-should-parse-as-datetime".ToString("T") | Should -Be "2:01:54 PM"
$result."date-upperO-should-parse-as-datetime".ToString("u") | Should -Be "2008-09-22 14:01:54Z"
$result."date-upperO-should-parse-as-datetime".ToString("U") | Should -Be "Monday, September 22, 2008 2:01:54 PM"
$result."date-upperO-should-parse-as-datetime".ToString("Y") | Should -Be "September 2008"
$result."date-upperO-should-parse-as-datetime".ToString("y") | Should -Be "September 2008"
$result."date-upperO-should-parse-as-datetime" | Should -BeOfType [DateTime]

$result."date-o-should-parse-as-string" | Should -Be "2019-12-17T06:14:06 +06:00"
$result."date-o-should-parse-as-string" | Should -BeOfType [String]
$result."date-f-should-parse-as-string" | Should -Be "Monday, September 22, 2008 2:01 PM"
$result."date-f-should-parse-as-string" | Should -BeOfType [String]
$result."date-g-should-parse-as-string" | Should -Be "9/22/2008 2:01 PM"
$result."date-g-should-parse-as-string" | Should -BeOfType [String]
$result."date-m-should-parse-as-string" | Should -Be "September 22"
$result."date-m-should-parse-as-string" | Should -BeOfType [String]
$result."date-upperM-should-parse-as-string" | Should -Be "September 22"
$result."date-upperM-should-parse-as-string" | Should -BeOfType [String]
$result."date-t-should-parse-as-string" | Should -Be "2:01 PM"
$result."date-t-should-parse-as-string" | Should -BeOfType [String]
$result."date-u-should-parse-as-string" | Should -Be "2008-09-22 14:01:54Z"
$result."date-u-should-parse-as-string" | Should -BeOfType [String]
$result."date-upperD-should-parse-as-string" | Should -Be "Monday, September 22, 2008"
$result."date-upperD-should-parse-as-string" | Should -BeOfType [String]
$result."date-upperF-should-parse-as-string" | Should -Be "Monday, September 22, 2008 2:01:54 PM"
$result."date-upperF-should-parse-as-string" | Should -BeOfType [String]
$result."date-upperG-should-parse-as-string" | Should -Be "9/22/2008 2:01:54 PM"
$result."date-upperG-should-parse-as-string" | Should -BeOfType [String]
$result."date-upperR-should-parse-as-string" | Should -Be "Mon, 22 Sep 2008 14:01:54 GMT"
$result."date-upperR-should-parse-as-string" | Should -BeOfType [String]
$result."date-upperT-should-parse-as-string" | Should -Be "2:01:54 PM"
$result."date-upperT-should-parse-as-string" | Should -BeOfType [String]
$result."date-upperU-should-parse-as-string" | Should -Be "Monday, September 22, 2008 2:01:54 PM"
$result."date-upperU-should-parse-as-string" | Should -BeOfType [String]
$result."date-upperY-should-parse-as-string" | Should -Be "September 2008"
$result."date-upperY-should-parse-as-string" | Should -BeOfType [String]
$result."date-y-should-parse-as-string" | Should -Be "September 2008"
$result."date-y-should-parse-as-string" | Should -BeOfType [String]
}
}

It "ConvertFrom-Json properly parses complex objects" {
$json = @"
{
"_id": "60dd3ea9253016932039a0a2",
"index": 0,
"guid": "429b96a7-24e3-47de-a93b-f44a346c5ac9",
"isActive": false,
"balance": "$2,039.72",
"picture": "http://placehold.it/32x32",
"age": 35,
"eyeColor": "green",
"name": "Rhodes Roberson",
"gender": "male",
"company": "INSECTUS",
"email": "rhodesroberson@insectus.com",
"phone": "+1 (883) 561-3999",
"address": "931 Kings Place, Hartsville/Hartley, Federated States Of Micronesia, 9344",
"about": "Ipsum pariatur nisi eiusmod aliquip in cupidatat. Deserunt non sit anim consectetur consectetur incididunt elit qui id proident nostrud. Consectetur pariatur et adipisicing aliquip fugiat fugiat Lorem reprehenderit laboris magna. Duis veniam irure amet ex minim eiusmod et laborum non elit. Dolor enim Lorem occaecat nisi consectetur mollit laborum anim velit et. Irure aliquip eiusmod anim proident ex ea duis deserunt aute amet adipisicing nisi nostrud. Minim ipsum fugiat consequat mollit fugiat tempor fugiat.",
"registered": "2019-12-17T06:14:06 +06:00",
"latitude": 51.890798,
"longitude": -47.522764,
"tags": [
"laboris",
"voluptate",
"amet",
"ad",
"velit",
"ipsum",
"do"
],
"friends": [
{
"id": 0,
"name": "Renee Holden"
},
{
"id": 1,
"name": "Bennett Dixon"
},
{
"id": 2,
"name": "Emilia Holder"
}
],
"greeting": "Hello, Rhodes Roberson! You have 9 unread messages.",
"favoriteFruit": "banana"
}
"@
$result = ConvertFrom-Json $Json
$result."about"| Should -BeExactly "Ipsum pariatur nisi eiusmod aliquip in cupidatat. Deserunt non sit anim consectetur consectetur incididunt elit qui id proident nostrud. Consectetur pariatur et adipisicing aliquip fugiat fugiat Lorem reprehenderit laboris magna. Duis veniam irure amet ex minim eiusmod et laborum non elit. Dolor enim Lorem occaecat nisi consectetur mollit laborum anim velit et. Irure aliquip eiusmod anim proident ex ea duis deserunt aute amet adipisicing nisi nostrud. Minim ipsum fugiat consequat mollit fugiat tempor fugiat."
$result."about" | Should -BeOfType [String]
$result."address"| Should -BeExactly "931 Kings Place, Hartsville/Hartley, Federated States Of Micronesia, 9344"
$result."address" | Should -BeOfType [String]
$result."age" | Should -BeOfType [Int64]
$result."balance"| Should -BeExactly ",039.72"
$result."balance" | Should -BeOfType [String]
$result."company"| Should -BeExactly "INSECTUS"
$result."company" | Should -BeOfType [String]
$result."email"| Should -BeExactly "rhodesroberson@insectus.com"
$result."email" | Should -BeOfType [String]
$result."eyeColor"| Should -BeExactly "green"
$result."eyeColor" | Should -BeOfType [String]
$result."favoriteFruit"| Should -BeExactly "banana"
$result."favoriteFruit" | Should -BeOfType [String]
$result."gender"| Should -BeExactly "male"
$result."gender" | Should -BeOfType [String]
$result."greeting"| Should -BeExactly "Hello, Rhodes Roberson! You have 9 unread messages."
$result."greeting" | Should -BeOfType [String]
$result."guid"| Should -BeExactly "429b96a7-24e3-47de-a93b-f44a346c5ac9"
$result."guid" | Should -BeOfType [String]
$result."index" | Should -BeOfType [Int64]
$result."isActive"| Should -Be False
$result."isActive" | Should -BeOfType [Boolean]
$result."latitude"| Should -Be 51.890798
$result."latitude" | Should -BeOfType [Double]
$result."longitude"| Should -Be -47.522764
$result."longitude" | Should -BeOfType [Double]
$result."name"| Should -BeExactly "Rhodes Roberson"
$result."name" | Should -BeOfType [String]
$result."phone"| Should -BeExactly "+1 (883) 561-3999"
$result."phone" | Should -BeOfType [String]
$result."picture"| Should -BeExactly "http://placehold.it/32x32"
$result."picture" | Should -BeOfType [String]
$result."registered"| Should -BeExactly "2019-12-17T06:14:06 +06:00"
$result."registered" | Should -BeOfType [String]
$result."_id"| Should -BeExactly "60dd3ea9253016932039a0a2"
$result."_id" | Should -BeOfType [String]

$result.Tags | Should -BeOfType [string]

$result.Tags.count | Should -Be 7
$result.Tags[0] | Should -BeExactly "laboris"
$result.Tags | Should -Be @("laboris", "voluptate", "amet", "ad", "velit", "ipsum", "do")

$result.Friends | Should -BeOfType [pscustomobject]
$result.Friends[0].id | Should -Be 0
$result.Friends[0].name | Should -BeExactly "Renee Holden"
$result.Friends[1].id | Should -Be 1
$result.Friends[1].name | Should -BeExactly "Bennett Dixon"
$result.Friends[2].id | Should -Be 2
$result.Friends[2].name | Should -BeExactly "Emilia Holder"
}

It "ConvertFrom-Json chooses the appropriate number type" {
ConvertFrom-Json -InputObject "5" | should -Be 5
ConvertFrom-Json -InputObject 5 | should -Be 5
ConvertFrom-Json -InputObject "5" | should -BeOfType [int64]
ConvertFrom-Json -InputObject 5 | should -BeOfType [int64]
ConvertFrom-Json -InputObject 5000000000000 | should -Be 5000000000000
ConvertFrom-Json -InputObject "5000000000000" | should -Be "5000000000000"
ConvertFrom-Json -InputObject "5000000000000" | should -BeOfType [int64]
ConvertFrom-Json -InputObject 5000000000000 | should -BeOfType [int64]
ConvertFrom-Json -InputObject "5.0" | should -Be 5.0
ConvertFrom-Json -InputObject 5.0 | should -Be 5.0
ConvertFrom-Json -InputObject "5.0" | should -BeOfType [double]
ConvertFrom-Json -InputObject 5.0 | should -BeOfType [double]

# The decimal is lost but only when this is quoted
ConvertFrom-Json -InputObject "500000000000.0000000000000001" | should -Be "500000000000"

# Counter intuitively all four of these tests pass because precision is lost on both sides of the test, likely due to powershell number handling
ConvertFrom-Json -InputObject 500000000000.0000000000000001 | should -Be 500000000000
ConvertFrom-Json -InputObject 500000000000.0000000000000001 | should -Be 500000000000.0000000000000001
ConvertFrom-Json -InputObject 500000000000 | should -Be 500000000000.0000000000000001
ConvertFrom-Json -InputObject 500000000000 | should -Be 500000000000

ConvertFrom-Json -InputObject "500000000000.0000000000000001" | should -BeOfType [double]
ConvertFrom-Json -InputObject 500000000000.0000000000000001 | should -BeOfType [double]

# these tests also pass because precision is lost during conversion/powershell handling
ConvertFrom-Json -InputObject "50000000000000000000000000000000000.0000000000000001" | should -Be "5E+34"
ConvertFrom-Json -InputObject 50000000000000000000000000000000000.0000000000000001 | should -Be "5E+34"

ConvertFrom-Json -InputObject "50000000000000000000000000000000000.0000000000000001" | should -BeOfType [double]
ConvertFrom-Json -InputObject 50000000000000000000000000000000000.0000000000000001 | should -BeOfType [double]


ConvertFrom-Json -InputObject "50000000000000000000000000000000000" | should -Be 50000000000000000000000000000000000
ConvertFrom-Json -InputObject 50000000000000000000000000000000000 | should -Be 50000000000000000000000000000000000
ConvertFrom-Json -InputObject "50000000000000000000000000000000000" | should -BeOfType [BigInt]
ConvertFrom-Json -InputObject 50000000000000000000000000000000000 | should -BeOfType [BigInt]
}

It "ConvertFrom-Json with special characters" {

$json = '{"SampleValue":"\"\\\b\f\n\r\t\u4321\uD7FF"}'
Expand Down