ConvertTo-STJson.Tests.ps1

#requires -version 2
<#
Pester 4.x tests for Svendsen Tech's ConvertTo-STJson. Joakim Borger Svendsen.
Initially created on 2017-10-21.
#>

# Standardize the decimal separator to a period (not making it dynamic for now).
$Host.CurrentCulture.NumberFormat.NumberDecimalSeparator = "."

$MyScriptRoot = Split-Path -Path $MyInvocation.MyCommand.Path -Parent
. "$MyScriptRoot\ConvertTo-STJson.ps1"

Describe ConvertTo-STJson {
    
    It "Test that null, true and false as value types are accounted for when passed in alone" {
        ConvertTo-STJson -InputObject $Null | Should -Be ""
        ConvertTo-STJson -InputObject $False | Should -Be "false"
        ConvertTo-STJson -InputObject $True | Should -Be "true"
    }
    
    It "Given a number as a value, it should not be quoted" {
        ConvertTo-STJson -InputObject 1 -Compress | Should -Be "1"
        ConvertTo-STJson -InputObject 1.1 -Compress | Should -Be "1.1"
        ConvertTo-STJson -InputObject 1.12e-2 -Compress | Should -Be "0.0112"
    }
    
    It "Given a number as a string, it should be quoted." {
        ConvertTo-STJson -InputObject "1" -Compress | Should -Be '"1"'
        ConvertTo-STJson -InputObject "1.1" -Compress | Should -Be """1.1"""
        ConvertTo-STJson -InputObject "1.12e-2" -Compress | Should -Be """1.12e-2"""
    }
    
    It "Given a number as a string, it should not be quoted if -CoerceNumberStrings is passed" {
        ConvertTo-STJson -InputObject "1" -Compress -CoerceNumberStrings | Should -Be "1"
        ConvertTo-STJson -InputObject "1.1" -Compress -CoerceNumberStrings | Should -Be "1.1"
        ConvertTo-STJson -InputObject "1.12e-2" -Compress -CoerceNumberStrings | Should -Be "1.12e-2"

    }
    
    It "Test hashtable structure with number, string, null, true and false as values" {
        ConvertTo-STJson -InputObject @{ Key = 1.23 } -Compress | Should -Be "{`"Key`":1.23}"
        ConvertTo-STJson -InputObject @{ Key = 'null' } -Compress | Should -Be "{`"Key`":`"null`"}"
        ConvertTo-STJson -InputObject @{ Key = $Null } -Compress | Should -Be "{`"Key`":null}"
        ConvertTo-STJson -InputObject @{ Key = $True } -Compress | Should -Be "{`"Key`":true}"
        ConvertTo-STJson -InputObject @{ Key = $False } -Compress | Should -Be "{`"Key`":false}"
    }
    
    It "Test custom PowerShell object with number, string, null, true and false as values" {
        ConvertTo-STJson -InputObject (New-Object -TypeName PSObject -Property @{ Key = 1.23 }) -Compress | 
            Should -Be "{`"Key`":1.23}"
        ConvertTo-STJson -InputObject (New-Object -TypeName PSObject -Property @{ Key = 'null' }) -Compress | 
            Should -Be "{`"Key`":`"null`"}"
        ConvertTo-STJson -InputObject (New-Object -TypeName PSObject -Property @{ Key = $Null }) -Compress |
            Should -Be "{`"Key`":null}"
        ConvertTo-STJson -InputObject (New-Object -TypeName PSObject -Property @{ Key = $True }) -Compress |
            Should -Be "{`"Key`":true}"
        ConvertTo-STJson -InputObject (New-Object -TypeName PSObject -Property @{ Key = $False }) -Compress |
            Should -Be "{`"Key`":false}"
    }
    
    It "Test single array with numbers, strings, null, true and false as values" {
        ConvertTo-STJson -InputObject @(1, 2, 3, "test", $Null, $True, $False, 'bar') -Compress |
            Should -Be '[1,2,3,"test",null,true,false,"bar"]'
    }
    
    It "Test array as hashtable value, with numbers and strings" {
        # Test a PSCustomObject at the same time. PSv2-compatible syntax/creation (not ordered).
        $Number = New-Object -TypeName PSObject -Property @{
            Key = @(1.12e-2, 2, "3", 'foo')
        }
        ConvertTo-STJson -InputObject $Number -Compress | Should -Be "{`"Key`":[0.0112,2,`"3`",`"foo`"]}"
    }
    
    It "Test complex/mixed data structure" {
        ConvertTo-STJson -InputObject @(
            @(1..3), 'a', 'b',
            @{
                NestedMore = @(1, @{
                    foo = @{ key = 'bar' }
                })
            }
        ) -Compress |
            Should -Be '[[1,2,3],"a","b",{"NestedMore":[1,{"foo":{"key":"bar"}}]}]'
    }
    
    It "Test that compressed output from the built in ConvertTo-Json is identical if on PSv3+" {
        if ($PSVersionTable.PSVersion.Major -lt 3) {
            1 | Should -Be 1 # Can't test this on PSv2 or 1.
            break
        }
        $Object = @{
            a = @(@(1..3), 'a', 'b', @{ key = @(1, @(5,6,7), 'x') })
            b = @{ a = @('y', 'z', @(1, @('innerinner', @('innerinnerinner', "innerinnerinner2", @{
            innerkey = 'g' }, @{ inkey = 'f'} ), @(3,4) ) ) )} }
        (ConvertTo-Json -InputObject $Object -Compress -Depth 99) -eq (ConvertTo-STJson -InputObject $Object -Compress) |
            Should -Be $True
        
    }
    
    It "Test that double quotes, newlines and carriage returns are escaped within a string" {
        ConvertTo-STJson -InputObject "string with a`n newline a `r carriage return and a `"quoted`" word" -Compress |
            Should -Be '"string with a\n newline a \r carriage return and a \"quoted\" word"'
    }
    
    It "Test that double quotes, newlines and carriage returns are escaped within a string in a hashtable value" {
        ConvertTo-STJson -InputObject @{ Key = "string with a`n newline a `r carriage return and a `"quoted`" word" } -Compress |
            Should -Be '{"Key":"string with a\n newline a \r carriage return and a \"quoted\" word"}'
    }
    
    It "Test for PSScriptAnalyzer errors" {
        if (Get-Command -Name "Invoke-ScriptAnalyzer" -ErrorAction SilentlyContinue) {
            try {
                @(Invoke-ScriptAnalyzer -Path "$MyScriptRoot\ConvertTo-STJson.ps1" -ErrorAction Stop |
                    Where-Object {
                        $_.Severity -notmatch 'Information|Warning'
                }).Count | Should -Be 0
            }
            catch {
                throw "Invoke-ScriptAnalyzer gave a critical error: $_"
            }
        }
        else {
            1 | Should -Be 1 # can't test without PSScriptAnalyzer
           break
        }
    }

    It "Formats datetime objects as ISO 8601 when you specify the switch parameter" {
        ConvertTo-STJson -InputObject @{ nest = 
            @{ datetime = Get-Date -Year 2018 -Month 06 -Day 25 -Hour 00 -Minute 00 -Second 00 } } `
            -Compress -DateTimeAsISO8601 |
            Should -Be '{"nest":{"datetime":"2018-06-25T00:00:00"}}'
    }

    It "Test indentation/formatting of a complex data structure" {
        ConvertTo-STJson -InputObject @(
            @(@(1..3), 'a', 'b', @{ key = @(1, @(5,6,7), 'x') }),
            @{ a = @('y', 'z', @(1, @('innerinner', @('innerinnerinner',
                $Null, "foo", @{
                innerkey = 'g' }, @{ inkey = @{ x = 'f' } } ),
                @(3,4) ) ) ) } ) |
            Should -Be (
@"
[
    [
        [
            1,
            2,
            3
        ],
        "a",
        "b",
        {
            "key":
            [
                1,
                [
                    5,
                    6,
                    7
                ],
                "x"
            ]
        }
    ],
    {
        "a":
        [
            "y",
            "z",
            [
                1,
                [
                    "innerinner",
                    [
                        "innerinnerinner",
                        null,
                        "foo",
                        {
                            "innerkey": "g"
                        },
                        {
                            "inkey":
                            {
                                "x": "f"
                            }
                        }
                    ],
                    [
                        3,
                        4
                    ]
                ]
            ]
        ]
    }
]
"@ -replace '\r') # \n becomes \r\n in this string, but is only \n in the JSON, 
                  # so it breaks the comparison. Workaround. Can't have \r in the test data.
    }

}