Specs/Configuration.Steps.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 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 |
$PSModuleAutoLoadingPreference = "None" Remove-Module Configuration -EA 0 Import-Module .\Configuration.psd1 Given 'the configuration module is imported with testing paths:' { param($Table) Remove-Module Configuration -EA 0 Import-Module .\Configuration.psd1 -Args @($null, $Table.Enterprise, $Table.User, $Table.Machine) -Scope Global } Given 'the configuration module is imported with a URL converter' { param($Table) Remove-Module Configuration -EA 0 Import-Module .\Configuration.psd1 -Args @{ [Uri] = { "Uri '$_' " } "Uri" = { param([string]$Value) [Uri]$Value } } -Scope Global } Given 'the manifest module is imported' { param($Table) Remove-Module Configuration, Manifest Import-Module .\Manifest.psm1 -Scope Global } Given "a module with(?:\s+\w+ name '(?<name>.+?)'|\s+\w+ the company '(?<company>.+?)'|\s+\w+ the author '(?<author>.+?)')+" { param($name, $Company = "", $Author = "") $Script:ModulePath = "TestDrive:\Modules\$name" Remove-Module $name -ErrorAction SilentlyContinue Remove-Item $ModulePath -Recurse -ErrorAction SilentlyContinue $null = mkdir $ModulePath -Force $Env:PSModulePath = $Env:PSModulePath + ";TestDrive:\Modules" -replace "(;TestDrive:\\Modules)+?$", ";TestDrive:\Modules" Set-Content $ModulePath\${Name}.psm1 " function GetStoragePath { Get-StoragePath @Args } function ImportConfiguration { Import-Configuration } function ImportConfigVersion { Import-Configuration -Version 2.0 } filter ExportConfiguration { `$_ | Export-Configuration } filter ExportConfigVersion { `$_ | Export-Configuration -Version 2.0 } " New-ModuleManifest $ModulePath\${Name}.psd1 -RootModule .\${Name}.psm1 -Description "A Super Test Module" -Company $Company -Author $Author # New-ModuleManifest sets things even when we don't want it to: if(!$Author) { Set-Content $ModulePath\${Name}.psd1 ((Get-Content $ModulePath\${Name}.psd1) -Replace "^(Author.*)$", '#$1') } if(!$Company) { Set-Content $ModulePath\${Name}.psd1 ((Get-Content $ModulePath\${Name}.psd1) -Replace "^(Company.*)$", '#$1') } Import-Module $ModulePath\${Name}.psd1 } When "the module's (\w+) path should (\w+) (.+)$" { param($Scope, $Comparator, $Path) [string[]]$Path = $Path -split "\s*and\s*" | %{ $_.Trim("['`"]") } $script:LocalStoragePath = GetStoragePath -Scope $Scope foreach($PathAssertion in $Path) { $script:LocalStoragePath | Should $Comparator $PathAssertion } } Given "a script with the name '(.+)' that calls Get-StoragePath with no parameters" { param($name) Set-Content "TestDrive:\${name}.ps1" "Get-StoragePath" $Script:ScriptName = $Name } Given "a script with the name '(?<File>.+)' that calls Get-StoragePath (?:-Name (?<Name>\w*) ?|-Author (?<Author>\w*) ?){2}" { param($File, $Name, $Author) Set-Content "TestDrive:\${File}.ps1" "Get-StoragePath -Name $Name -Author $Author" $Script:ScriptName = $File } Then "the script should throw an exception$" { { $script:LocalStoragePath = iex "TestDrive:\${ScriptName}.ps1" } | Should throw } Then "the script's (\w+) path should (\w+) (.+)$" { param($Scope, $Comparator, $Path) [string[]]$Path = $Path -split "\s*and\s*" | %{ $_.Trim("['`"]") } $script:LocalStoragePath = iex "TestDrive:\${Script:ScriptName}.ps1" foreach($PathAssertion in $Path) { $script:LocalStoragePath | Should $Comparator $PathAssertion } } When "the module's storage path should end with a version number if one is passed in" { GetStoragePath -Version "2.0" | Should Match "\\2.0$" GetStoragePath -Version "4.0" | Should Match "\\4.0$" } When "a settings hashtable" { param($hashtable) $script:Settings = iex "[ordered]$hashtable" } When "we update the settings with" { param($hashtable) $Update = if($hashtable) { iex $hashtable } else { $null } $script:Settings = $script:Settings | Update-Object $Update } When "a (?:settings file|module manifest) named (\S+)(?:(?: in the (?<Scope>\S+) folder)|(?: for version (?<Version>[0-9.]+)))*" { param($fileName, $hashtable, $Scope = $null, $Version = $null) if($Scope -and $Version) { $folder = GetStoragePath -Scope $Scope -Version $Version } elseif($Scope) { $folder = GetStoragePath -Scope $Scope } elseif($Version) { $folder = GetStoragePath -Version $Version } elseif(Test-Path "${Script:ModulePath}") { $folder = $Script:ModulePath } else { $folder = "TestDrive:\" } $Script:SettingsFile = Join-Path $folder $fileName $Parent = Split-Path $Script:SettingsFile if(!(Test-Path $Parent)) { $null = mkdir $Parent -Force -EA 0 } Set-Content $Script:SettingsFile -Value $hashtable } Then "the settings object MyPath should match the file's path" { $script:Settings.MyPath | Should Be ${Script:SettingsFile} } When "a settings hashtable with an? (.+) in it" { param($type) $script:Settings = @{ UserName = $Env:UserName } switch($type) { "NULL" { $Settings.TestCase = $Null } "Enum" { $Settings.TestCase = [Security.PolicyLevelType]::Enterprise } "String" { $Settings.TestCase = "Test" } "Number" { $Settings.OneTestCase = 42 $Settings.TwoTestCase = 42.9 } "Array" { $Settings.TestCase = "One", "Two", "Three" } "Boolean" { $Settings.OneTestCase = $True $Settings.TwoTestCase = $False } "DateTime" { $Settings.TestCase = Get-Date } "DateTimeOffset" { $Settings.TestCase = [DateTimeOffset](Get-Date) } "GUID" { $Settings.TestCase = [GUID]::NewGuid() } "PSObject" { $Settings.TestCase = New-Object PSObject -Property @{ Name = $Env:UserName } } "PSCredential" { $Settings.TestCase = New-Object PSCredential @("UserName", (ConvertTo-SecureString -AsPlainText -Force -String "Password")) } "SecureString" { $Settings.TestCase = ConvertTo-SecureString -AsPlainText -Force -String "Password" } "Uri" { $Settings.TestCase = [Uri]"http://HuddledMasses.org" } "Hashtable" { $Settings.TestCase = @{ Key = "Value"; ANother = "Value" } } "ConsoleColor" { $Settings.TestCase = [ConsoleColor]::Red } default { throw "missing test type" } } } When "we add a converter for (.*) types" { param($Type) switch ($Type) { "Uri" { Add-MetadataConverter @{ [Uri] = { "Uri '$_' " } "Uri" = { param([string]$Value) [Uri]$Value } } } default { throw "missing converter type" } } } When "we convert the settings to metadata" { $script:SettingsMetadata = ConvertTo-Metadata $script:Settings # Write-Debug $script:SettingsMetadata $Wide = $Host.UI.RawUI.WindowSize.Width Write-Verbose $script:SettingsMetadata } When "we export to a settings file named (.*)" { param($fileName) if(!$Script:ModulePath -or !(Test-Path $Script:ModulePath)) { $Script:ModulePath = "TestDrive:\" } $Script:SettingsFile = Join-Path $Script:ModulePath $fileName $File = $script:Settings | Export-Metadata ${Script:SettingsFile} -Passthru $File.FullName | Should Be (Convert-Path $SettingsFile) } When "we convert the metadata to an object" { $script:Settings = ConvertFrom-Metadata $script:SettingsMetadata Write-Verbose (($script:Settings | Out-String -Stream | % TrimEnd) -join "`n") } When "we import the file to an object" { $script:Settings = Import-Metadata ${Script:SettingsFile} Write-Verbose (($script:Settings | Out-String -Stream | % TrimEnd) -join "`n") } When "we import the file with ordered" { $script:Settings = Import-Metadata ${Script:SettingsFile} -Ordered Write-Verbose (($script:Settings | Out-String -Stream | % TrimEnd) -join "`n") } When "we import the folder path" { $script:Settings = Import-Metadata (Split-Path ${Script:SettingsFile}) Write-Verbose (($script:Settings | Out-String -Stream | % TrimEnd) -join "`n") } When "trying to import the file to an object should throw(.*)" { param([string]$Message) { $script:Settings = Import-Metadata ${Script:SettingsFile} } | Should Throw $Message.trim() } When "the string version should (\w+)\s*(.*)?" { param($operator, $data) # I have to normalize line endings: $meta = ($script:SettingsMetadata -replace "\r?\n","`n") $data = $data.trim('"''') -replace "\r?\n","`n" # And then actually test it $meta | Should $operator $data } When "the settings file should (\w+)\s*(.*)?" { param($operator, $data) # I have to normalize line endings: $data = [regex]::escape(($data -replace "\r?\n","`n")) if($operator -eq "Contain"){ $operator = "ContainMultiline"} Get-Item ${Script:SettingsFile} | Should $operator $data } # This step will create verifiable/counting loggable mocks for Write-Warning, Write-Error, Write-Verbose When "we expect an? (?<type>warning|error|verbose) in (?<module>.*)" { param($type, $module) $Script:ErrorModule = $module Mock -Module $Script:ErrorModule Write-$type { $true } -Verifiable if($Type -eq "Error" -and ($Script:ErrorModule -eq "Metadata")) { Mock -Module $Script:ErrorModule WriteError { Write-Error "Error" -TargetObject $Args } -Verifiable } # if($Type -eq "Warning") { # Mock -Module Manifest WriteWarning { Write-Warning "Warning" -TargetObject $Args } -Verifiable # } } # this step lets us verify the number of calls to those three mocks When "the (?<type>warning|error|verbose) is logged(?: (?<exactly>exactly) (\d+) times?)?" { param($count, $exactly, $type) $param = @{} if($count) { $param.Exactly = $Exactly -eq "Exactly" $param.Times = $count } Assert-MockCalled -Module $Script:ErrorModule -Command Write-$type @param } When "we add a converter that's not a scriptblock" { Add-MetadataConverter @{ "Uri" = " param([string]$Value) [Uri]$Value " } } When "we add a converter with a number as a key" { Add-MetadataConverter @{ 42 = { param([string]$Value) $Value } } } # Then the error is logged exactly 2 times Then "the settings object should be of type (.*)" { param([Type]$Type) $script:Settings | Should BeOfType $Type } Then "the settings object should have an? (.*) of type (.*)" { param([String]$Parameter, [Type]$Type) $script:Settings.$Parameter | Should BeOfType $Type } Then "the settings object's (.*) should (be of type|be) (.*)" { param([String]$Parameter, [String]$operator, $Expected) $Value = $script:Settings # Write-Debug ($Settings | Out-String) foreach($property in $Parameter.Split(".")) { $value = $value.$property } $operator = $operator -replace " " if($Operator -eq "be" -and $Expected -eq "null") { $value | Should BeNullOrEmpty } else { $value | Should $operator $Expected } } Then "Key (\d+) is (\w+)" { param([int]$index, [string]$name) $script:Settings.Keys | Select -Index $index | Should Be $Name } Given "a mock PowerShell version (.*)" { param($version) $script:PSVersion = [Version]$version $script:PSDefaultParameterValues."Test-PSVersion:Version" = $script:PSVersion } When "we fake version 2.0 in the Metadata module" { &(Get-Module Configuration) { &(Get-Module Metadata) { $script:PSDefaultParameterValues."Test-PSVersion:Version" = [Version]"2.0" } } } When "we're using PowerShell 4 or higher in the Metadata module" { &(Get-Module Configuration) { &(Get-Module Metadata) { $null = $script:PSDefaultParameterValues.Remove("Test-PSVersion:Version") $PSVersionTable.PSVersion -ge ([Version]"4.0") | Should Be $True } } } Given "the actual PowerShell version" { $script:PSVersion = $PSVersionTable.PSVersion $null = $script:PSDefaultParameterValues.Remove("Test-PSVersion:Version") } Then "the Version -(..) (.*)" { param($comparator, $version) if($version -eq "the version") { [Version]$version = $script:PSVersion } else { [Version]$version = $version } $test = @{ $comparator = $version } Test-PSVersion @test | Should Be $True } When "I call Import-Configuration" { $script:Settings = ImportConfiguration Write-Verbose (($script:Settings | Out-String -Stream | % TrimEnd) -join "`n") } When "I call Import-Configuration with a Version" { $script:Settings = ImportConfigVersion Write-Verbose (($script:Settings | Out-String -Stream | % TrimEnd) -join "`n") } When "I call Export-Configuration with" { param($configuration) iex "$configuration" | ExportConfiguration } When "I call Export-Configuration with a Version" { param($configuration) iex "$configuration" | ExportConfigVersion } When "I call Get-Metadata (\S+)(?: (\S+))?" { param($path, $name) Push-Location $script:ModulePath try { if($name) { $script:Result = Get-Metadata $path $name } else { $script:Result = Get-Metadata $path } } finally { Pop-Location } } When "I call Update-Metadata (\S+)(?: (\S+))?" { param($path, $name) Push-Location $script:ModulePath try { if($name) { $script:Result = Update-Metadata $path $name } else { $script:Result = Update-Metadata $path } } finally { Pop-Location } } When "I call Update-Metadata (\S+) -Increment (\S+)" { param($path, $name) Push-Location $script:ModulePath try { $script:Result = Update-Metadata $path -Increment $name } finally { Pop-Location } } Then "the result should be (.*)" { param($value) $script:Result | Should Be $value } Then "a settings file named (\S+) should exist(?:(?: in the (?<Scope>\S+) folder)|(?: for version (?<Version>[0-9.]+)))*" { param($fileName, $hashtable, $Scope = $null, $Version = $null) if($Scope -and $Version) { $folder = GetStoragePath -Scope $Scope -Version $Version } elseif($Scope) { $folder = GetStoragePath -Scope $Scope } elseif($Version) { $folder = GetStoragePath -Version $Version } elseif(Test-Path "${Script:ModulePath}") { $folder = $Script:ModulePath } else { $folder = "TestDrive:\" } $Script:SettingsFile = Join-Path $folder $fileName $Script:SettingsFile | Should Exist } |