.requirements/powershell-yaml/0.3.4/Tests/powershell-yaml.Tests.ps1
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 |
# Copyright 2016 Cloudbase Solutions Srl # # Licensed under the Apache License, Version 2.0 (the "License"); you may # not use this file except in compliance with the License. You may obtain # a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # License for the specific language governing permissions and limitations # under the License. # $here = Split-Path -Parent $MyInvocation.MyCommand.Path $moduleHome = Split-Path -Parent $here $moduleName = "powershell-yaml" $modulePath = Join-Path $moduleHome "powershell-yaml.psd1" Import-Module $modulePath InModuleScope $moduleName { # Confirm-Equality is a helper function which acts like a DeepEquals # with special attention payed to the specific types the yaml decoder # can handle. function Confirm-Equality { Param( [Parameter(Mandatory=$true)]$expected, [Parameter(Mandatory=$true)]$got ) # check for easy way out; this should work for all simple value types: if ($expected -eq $got) { return $true } # else; handle hashes and arrays specially: if ($expected -is [System.Array]) { if ( -not (,$got | Get-Member -Name 'Count') -or ($expected.Count -ne $got.Count)) { return $false } # just iterate through the elements of the array comparing each one: for ($i = 0; $i -lt $expected.Count; $i = $i + 1) { if ( !(Confirm-Equality $expected[$i] $got[$i]) ) { return $false } } return $true } if ($expected -is [Hashtable]) { if ($got -isnot [Hashtable] -or ($expected.Count -ne $got.Count)) { return $false } # iterate through all the keys: $eq = $true $expected.Keys | % { if ( !$got.ContainsKey($_) ) { $eq = $false return } if ( !(Confirm-Equality $expected.Item($_) $got.Item($_)) ) { return $false } } | out-null return $eq } return $false } Describe "Test encode-decode symmetry." { Context "Simple-Items" { $items = 1, "yes", 56, $null foreach ($item in $items) { It "Should represent identity to encode and decode." { $yaml = ConvertTo-Yaml $item $i = ConvertFrom-Yaml $yaml $item -eq $i | Should Be $true } } } Context "Test array handling under various circumstances." { $arr = 1, 2, "yes", @{ key = "value" }, 5, (1, "no", 3) It "Should represent identity to encode/decode arrays as arguments." { $yaml = ConvertTo-Yaml $arr $a = ConvertFrom-Yaml $yaml Confirm-Equality $arr $a | Should Be $true } It "Should represent identity to encode/decode arrays by piping them in." { $yaml = $arr | ConvertTo-Yaml $a = ConvertFrom-Yaml $yaml Confirm-Equality $arr $a | Should Be $true } It "Should be irrelevant whether we convert an array by piping it, or referencing them as an argument." { $arged = ConvertTo-Yaml $arr $piped = $arr | ConvertTo-Yaml Confirm-Equality $arged $piped | Should Be $true } } Context "Test hash handling under various circumstances." { $hash = @{ # NOTE: intentionally not considered as YAML requires dict keys # be strings. As such; decoding the encoding of this would result # in a hash with the string key of "1", as below: # 1 = 42; "1" = 42; today = @{ month = "January"; year = "2016"; timestamp = Get-Date }; arr = 1, 2, 3, "yes", @{ yes = "yes" }; yes = "no" } It "Should be symmetrical to encode and then decode the hash as an argument." { $yaml = ConvertTo-Yaml $hash $h = ConvertFrom-Yaml $yaml Confirm-Equality $hash $h | Should Be $true } It "Should be symmetrical to endocode and then decode a hash by piping it." { $yaml = $hash | ConvertTo-Yaml $h = ConvertFrom-Yaml $yaml Confirm-Equality $hash $h | Should Be $true } It "Shouldn't matter whether we reference or pipe our hashes in to the YAML functions." { $arged = ConvertTo-Yaml $hash $piped = $hash | ConvertTo-Yaml Confirm-Equality $arged $piped | Should Be $true } } } Describe "Being able to decode an externally provided string." { Context "Decoding an arbitrary YAML string correctly." { # testYaml is just a string containing some yaml to be tested below: $testYaml = @" wishlist: - [coats, hats, and, scarves] - product : A Cool Book. quantity : 1 description : I love that Cool Book. price : 55.34 total: 4443.52 int64: $([int64]::MaxValue) note: > I can't wait. To get that Cool Book. dates: - 2001-12-15T02:59:43.1Z - 2001-12-14t21:59:43.10-05:00 - 2001-12-14 21:59:43.10 -5 - 2001-12-15 2:59:43.10 - 2002-12-14 version: - 1.2.3 noniso8601dates: - 5/4/2017 - 1.2.3 bools: - yes - no - true - false - on - off "@ $expected = @{ wishlist = @( @("coats", "hats", "and", "scarves"), @{ product = "A Cool Book."; quantity = 1; description = "I love that Cool Book."; price = 55.34 } ); total = 4443.52; int64 = ([int64]::MaxValue); note = ("I can't wait. To get that Cool Book.`n"); dates = @( [DateTime]::Parse('2001-12-15T02:59:43.1Z'), [DateTime]::Parse('2001-12-14t21:59:43.10-05:00'), [DateTime]::Parse('2001-12-14 21:59:43.10 -5'), [DateTime]::Parse('2001-12-15 2:59:43.10'), [DateTime]::Parse('2002-12-14') ); version = "1.2.3"; noniso8601dates = @( '5/4/2017', '1.2.3' ); bools = @( $true, $false, $true, $false, $true, $false ); } $res = ConvertFrom-Yaml $testYaml It "Should decode the YAML string as expected." { $wishlist = $res['wishlist'] $wishlist | Should Not BeNullOrEmpty $wishlist.Count | Should Be 2 $wishlist[0] | Should Not BeNullOrEmpty $wishlist[0].Count | Should Be 4 $wishlist[0][0] | Should Be $expected['wishlist'][0][0] $wishlist[0][1] | Should Be $expected['wishlist'][0][1] $wishlist[0][2] | Should Be $expected['wishlist'][0][2] $wishlist[0][3] | Should Be $expected['wishlist'][0][3] $product = $res['wishlist'][1] $product | Should Not BeNullOrEmpty $expectedProduct = $expected['wishlist'][1] $product['product'] | Should Be $expectedProduct['product'] $product['quantity'] | Should Be $expectedProduct['quantity'] $product['description'] | Should Be $expectedProduct['description'] $product['price'] | Should Be $expectedProduct['price'] $res['total'] | Should Be $expected['total'] $res['note'] | Should Be $expected['note'] $res['dates'] | Should Not BeNullOrEmpty $res['dates'].Count | Should Be $expected['dates'].Count for( $idx = 0; $idx -lt $expected['dates'].Count; ++$idx ) { $res['dates'][$idx] | Should BeOfType ([datetime]) $res['dates'][$idx] | Should Be $expected['dates'][$idx] } $res['version'] | Should BeOfType ([string]) $res['version'] | Should Be $expected['version'] $res['noniso8601dates'] | Should Not BeNullOrEmpty $res['noniso8601dates'].Count | Should Be $expected['noniso8601dates'].Count for( $idx = 0; $idx -lt $expected['noniso8601dates'].Count; ++$idx ) { $res['noniso8601dates'][$idx] | Should BeOfType ([string]) $res['noniso8601dates'][$idx] | Should Be $expected['noniso8601dates'][$idx] } Confirm-Equality $expected $res | Should Be $true } } } Describe "Test ConvertTo-Yaml -OutFile parameter behavior" { Context "Providing -OutFile with invalid prefix." { $testPath = "/some/bogus/path" $testObject = 42 # mock Test-Path to fail so the test for the directory of the -OutFile fails: Mock Test-Path { return $false } -Verifiable -ParameterFilter { $OutFile -eq $testPath } It "Should refuse to work with an -OutFile with an invalid prefix." { { ConvertTo-Yaml $testObject -OutFile $testPath } | Should Throw "Parent folder for specified path does not exist" } It "Should verify that all the required mocks were called." { Assert-VerifiableMock } } Context "Providing existing -OutFile without -Force." { $testPath = "/some/bogus/path" $testObject = "A random string this time." # mock Test-Path to succeed so the -OutFile seems to exist: Mock Test-Path { return $true } -Verifiable -ParameterFilter { $OutFile -eq $testPath } It "Should refuse to work for an existing -OutFile but no -Force flag." { { ConvertTo-Yaml $testObject -OutFile $testPath } | Should Throw "Target file already exists. Use -Force to overwrite." } It "Should verify that all the required mocks were called." { Assert-VerifiableMock } } Context "Providing a valid -OutFile." { $testObject = @{ yes = "No"; "arr" = @(1, 2, 3) } $testPath = [System.IO.Path]::GetTempFileName() Remove-Item -Force $testPath # must be deleted for the test It "Should succesfully write the expected content to the specified -OutFile." { $yaml = ConvertTo-Yaml $testObject ConvertTo-Yaml $testObject -OutFile $testPath Compare-Object $yaml (Get-Content -Raw $testPath) | Should Be $null } # NOTE: the below assertion relies on the above writing its file. It "Should succesfully write the expected content to the specified -OutFile with -Force even if it exists." { $newTestObject = @(1, "two", @("arr", "ay"), @{ yes = "no"; answer = 42 }) $yaml = ConvertTo-Yaml $newTestObject ConvertTo-Yaml $newTestObject -OutFile $testPath -Force Compare-Object $yaml (Get-Content -Raw $testPath) | Should Be $null } } } Describe "Generic Casting Behaviour" { Context "Node Style is 'Plain'" { $value = @' T1: 001 '@ It 'Should be an int' { $result = ConvertFrom-Yaml -Yaml $value $result.T1 | Should BeOfType System.Int32 } It 'Should be value of 1' { $result = ConvertFrom-Yaml -Yaml $value $result.T1 | Should Be 1 } It 'Should not be value of 001' { $result = ConvertFrom-Yaml -Yaml $value $result.T1 | Should Not Be '001' } } Context "Node Style is 'SingleQuoted'" { $value = @' T1: '001' '@ It 'Should be a string' { $result = ConvertFrom-Yaml -Yaml $value $result.T1 | Should BeOfType System.String } It 'Should be value of 001' { $result = ConvertFrom-Yaml -Yaml $value $result.T1 | Should Be '001' } It 'Should not be value of 1' { $result = ConvertFrom-Yaml -Yaml $value $result.T1 | Should Not Be '1' } } Context "Node Style is 'DoubleQuoted'" { $value = @' T1: "001" '@ It 'Should be a string' { $result = ConvertFrom-Yaml -Yaml $value $result.T1 | Should BeOfType System.String } It 'Should be value of 001' { $result = ConvertFrom-Yaml -Yaml $value $result.T1 | Should Be '001' } It 'Should not be value of 1' { $result = ConvertFrom-Yaml -Yaml $value $result.T1 | Should Not Be '1' } } } } |