Functions/It.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 |
function It { <# .SYNOPSIS Validates the results of a test inside of a Describe block. .DESCRIPTION The It command is intended to be used inside of a Describe or Context Block. If you are familiar with the AAA pattern (Arrange-Act-Assert), the body of the It block is the appropriate location for an assert. The convention is to assert a single expectation for each It block. The code inside of the It block should throw a terminating error if the expectation of the test is not met and thus cause the test to fail. The name of the It block should expressively state the expectation of the test. In addition to using your own logic to test expectations and throw exceptions, you may also use Pester's Should command to perform assertions in plain language. .PARAMETER Name An expressive phsae describing the expected test outcome. .PARAMETER Test The script block that should throw an exception if the expectation of the test is not met.If you are following the AAA pattern (Arrange-Act-Assert), this typically holds the Assert. .PARAMETER Pending Marks the test as pending, that is inconclusive/not implemented. The test will not run and will .PARAMETER TestCases Optional array of hashtable (or any IDictionary) objects. If this parameter is used, Pester will call the test script block once for each table in the TestCases array, splatting the dictionary to the test script block as input. If you want the name of the test to appear differently for each test case, you can embed tokens into the Name parameter with the syntax 'Adds numbers <A> and <B>' (assuming you have keys named A and B in your TestCases hashtables.) .EXAMPLE function Add-Numbers($a, $b) { return $a + $b } Describe "Add-Numbers" { It "adds positive numbers" { $sum = Add-Numbers 2 3 $sum | Should Be 5 } It "adds negative numbers" { $sum = Add-Numbers (-2) (-2) $sum | Should Be (-4) } It "adds one negative number to positive number" { $sum = Add-Numbers (-2) 2 $sum | Should Be 0 } It "concatenates strings if given strings" { $sum = Add-Numbers two three $sum | Should Be "twothree" } } .EXAMPLE function Add-Numbers($a, $b) { return $a + $b } Describe "Add-Numbers" { $testCases = @( @{ a = 2; b = 3; expectedResult = 5 } @{ a = -2; b = -2; expectedResult = -4 } @{ a = -2; b = 2; expectedResult = 0 } @{ a = 'two'; b = 'three'; expectedResult = 'twothree' } ) It 'Correctly adds <a> and <b> to get <expectedResult>' -TestCases $testCases { param ($a, $b, $expectedResult) $sum = Add-Numbers $a $b $sum | Should Be $expectedResult } } .LINK Describe Context about_should #> [CmdletBinding(DefaultParameterSetName = 'Normal')] param( [Parameter(Mandatory = $true, Position = 0)] [string]$name, [Parameter(Position = 1)] [ScriptBlock] $test = {}, [System.Collections.IDictionary[]] $TestCases, [Parameter(ParameterSetName = 'Pending')] [Switch] $Pending, [Parameter(ParameterSetName = 'Skip')] [Switch] $Skip ) ItImpl -Pester $pester -OutputScriptBlock ${function:Write-PesterResult} @PSBoundParameters } function ItImpl { [CmdletBinding(DefaultParameterSetName = 'Normal')] param( [Parameter(Mandatory = $true, Position=0)] [string]$name, [Parameter(Position = 1)] [ScriptBlock] $test, [System.Collections.IDictionary[]] $TestCases, [Parameter(ParameterSetName = 'Pending')] [Switch] $Pending, [Parameter(ParameterSetName = 'Skip')] [Switch] $Skip, $Pester, [scriptblock] $OutputScriptBlock ) Assert-DescribeInProgress -CommandName It # Jumping through hoops to make strict mode happy. if ($PSCmdlet.ParameterSetName -ne 'Skip') { $Skip = $false } if ($PSCmdlet.ParameterSetName -ne 'Pending') { $Pending = $false } #unless Skip or Pending is specified you must specify a ScriptBlock to the Test parameter if (-not ($PSBoundParameters.ContainsKey('test') -or $Skip -or $Pending)) { throw 'No test script block is provided. (Have you put the open curly brace on the next line?)' } #the function is called with Pending or Skipped set the script block if needed if ($null -eq $test) { $test = {} } #mark empty Its as Pending #[String]::IsNullOrWhitespace is not available in .NET version used with PowerShell 2 if ($PSCmdlet.ParameterSetName -eq 'Normal' -and [String]::IsNullOrEmpty((Remove-Comments $test.ToString()) -replace "\s")) { $Pending = $true } $pendingSkip = @{} if ($PSCmdlet.ParameterSetName -eq 'Skip') { $pendingSkip['Skip'] = $Skip } else { $pendingSkip['Pending'] = $Pending } if ($null -ne $TestCases -and $TestCases.Count -gt 0) { foreach ($testCase in $TestCases) { $expandedName = [regex]::Replace($name, '<([^>]+)>', { $capture = $args[0].Groups[1].Value if ($testCase.Contains($capture)) { $testCase[$capture] } else { "<$capture>" } }) $splat = @{ Name = $expandedName Scriptblock = $test Parameters = $testCase ParameterizedSuiteName = $name OutputScriptBlock = $OutputScriptBlock } Invoke-Test @splat @pendingSkip } } else { Invoke-Test -Name $name -ScriptBlock $test @pendingSkip -OutputScriptBlock $OutputScriptBlock } } function Invoke-Test { [CmdletBinding(DefaultParameterSetName = 'Normal')] param ( [Parameter(Mandatory = $true)] [string] $Name, [Parameter(Mandatory = $true)] [ScriptBlock] $ScriptBlock, [scriptblock] $OutputScriptBlock, [System.Collections.IDictionary] $Parameters, [string] $ParameterizedSuiteName, [Parameter(ParameterSetName = 'Pending')] [Switch] $Pending, [Parameter(ParameterSetName = 'Skip')] [Switch] $Skip ) if ($null -eq $Parameters) { $Parameters = @{} } $Pester.EnterTest($Name) if ($Skip) { $Pester.AddTestResult($Name, "Skipped", $null) } elseif ($Pending) { $Pester.AddTestResult($Name, "Pending", $null) } else { Invoke-TestCaseSetupBlocks $errorRecord = $null try{ do { $null = & $ScriptBlock @Parameters } until ($true) } catch { $errorRecord = $_ } $result = Get-PesterResult -Test $ScriptBlock -ErrorRecord $errorRecord $orderedParameters = Get-OrderedParameterDictionary -ScriptBlock $ScriptBlock -Dictionary $Parameters $Pester.AddTestResult( $result.name, $result.Result, $null, $result.FailureMessage, $result.StackTrace, $ParameterizedSuiteName, $orderedParameters ) } if ($null -ne $OutputScriptBlock) { $Pester.testresult[-1] | & $OutputScriptBlock } if (-not ($Skip -or $Pending)) { Invoke-TestCaseTeardownBlocks } Exit-MockScope $Pester.LeaveTest() } function Get-PesterResult { param( [ScriptBlock] $Test, [Nullable[TimeSpan]] $Time, [System.Management.Automation.ErrorRecord] $ErrorRecord ) $testResult = @{ name = $name time = $time failureMessage = "" stackTrace = "" success = $false result = "Failed" }; if(-not $ErrorRecord) { $testResult.Result = "Passed" $testResult.success = $true return $testResult } if ($ErrorRecord.FullyQualifiedErrorID -eq 'PesterAssertionFailed') { # we use TargetObject to pass structured information about the error. $details = $ErrorRecord.TargetObject $failureMessage = $details.message $file = $test.File $line = $details.line $lineText = "`n$line`: $($details.linetext)" } else { $failureMessage = $ErrorRecord.ToString() $file = $ErrorRecord.InvocationInfo.ScriptName $line = $ErrorRecord.InvocationInfo.ScriptLineNumber $lineText = '' } $testResult.failureMessage = $failureMessage $testResult.stackTrace = "at line: $line in ${file}${lineText}" return $testResult } function Remove-Comments ($Text) { $text -replace "(?s)(<#.*#>)" -replace "\#.*" } function Get-OrderedParameterDictionary { [OutputType([System.Collections.IDictionary])] param ( [scriptblock] $ScriptBlock, [System.Collections.IDictionary] $Dictionary ) $parameters = Get-ParameterDictionary -ScriptBlock $ScriptBlock $orderedDictionary = New-Object System.Collections.Specialized.OrderedDictionary foreach ($parameterName in $parameters.Keys) { $value = $null if ($Dictionary.ContainsKey($parameterName)) { $value = $Dictionary[$parameterName] } $orderedDictionary[$parameterName] = $value } return $orderedDictionary } function Get-ParameterDictionary { param ( [scriptblock] $ScriptBlock ) $guid = [guid]::NewGuid().Guid try { Set-Content function:\$guid $ScriptBlock $metadata = [System.Management.Automation.CommandMetadata](Get-Command -Name $guid -CommandType Function) return $metadata.Parameters } finally { if (Test-Path function:\$guid) { Remove-Item function:\$guid } } } |