Functions/Gherkin.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 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 |
if (($PSVersionTable.ContainsKey('PSEdition')) -and ($PSVersionTable.PSEdition -eq 'Core')) { & $SafeCommands["Add-Type"] -Path "${Script:PesterRoot}/lib/core/Gherkin.dll" } else { & $SafeCommands["Import-Module"] -Name "${Script:PesterRoot}/lib/legacy/Gherkin.dll" } $GherkinSteps = @{} $GherkinHooks = @{ BeforeEachFeature = @() BeforeEachScenario = @() AfterEachFeature = @() AfterEachScenario = @() } function Invoke-GherkinHook { <# .SYNOPSIS Internal function to run the various gherkin hooks .PARAMETER Hook The name of the hook to run .PARAMETER Name The name of the feature or scenario the hook is being invoked for .PARAMETER Tags Tags for filtering hooks #> [CmdletBinding()] param([string]$Hook, [string]$Name, [string[]]$Tags) if ($GherkinHooks.${Hook}) { foreach ($GherkinHook in $GherkinHooks.${Hook}) { if ($GherkinHook.Tags -and $Tags) { :tags foreach ($hookTag in $GherkinHook.Tags) { foreach ($testTag in $Tags) { if ($testTag -match "^($hookTag)$") { & $hook.Script $Name break :tags } } } } elseif ($GherkinHook.Tags) { # If the hook has tags, it can't run if the step doesn't } else { & $GherkinHook.Script $Name } } # @{ Tags = $Tags; Script = $Test } } } function Invoke-Gherkin { <# .SYNOPSIS Invokes Pester to run all tests defined in .feature files .DESCRIPTION Upon calling Invoke-Gherkin, all files that have a name matching *.feature in the current folder (and child folders recursively), will be parsed and executed. If ScenarioName is specified, only scenarios which match the provided name(s) will be run. If FailedLast is specified, only scenarios which failed the previous run will be re-executed. Optionally, Pester can generate a report of how much code is covered by the tests, and information about any commands which were not executed. .PARAMETER FailedLast Rerun only the scenarios which failed last time .PARAMETER Path This parameter indicates which feature files should be tested. Aliased to 'Script' for compatibility with Pester, but does not support hashtables, since feature files don't take parameters. .PARAMETER ScenarioName When set, invokes testing of scenarios which match this name. Aliased to 'Name' and 'TestName' for compatibility with Pester. .PARAMETER EnableExit Will cause Invoke-Gherkin to exit with a exit code equal to the number of failed tests once all tests have been run. Use this to "fail" a build when any tests fail. .PARAMETER Tag Filters Scenarios and Features and runs only the ones tagged with the specified tags. .PARAMETER ExcludeTag Informs Invoke-Gherkin to not run blocks tagged with the tags specified. .PARAMETER CodeCoverage Instructs Pester to generate a code coverage report in addition to running tests. You may pass either hashtables or strings to this parameter. If strings are used, they must be paths (wildcards allowed) to source files, and all commands in the files are analyzed for code coverage. By passing hashtables instead, you can limit the analysis to specific lines or functions within a file. Hashtables must contain a Path key (which can be abbreviated to just "P"), and may contain Function (or "F"), StartLine (or "S"), and EndLine ("E") keys to narrow down the commands to be analyzed. If Function is specified, StartLine and EndLine are ignored. If only StartLine is defined, the entire script file starting with StartLine is analyzed. If only EndLine is present, all lines in the script file up to and including EndLine are analyzed. Both Function and Path (as well as simple strings passed instead of hashtables) may contain wildcards. .PARAMETER Strict Makes Pending and Skipped tests to Failed tests. Useful for continuous integration where you need to make sure all tests passed. .PARAMETER OutputFile The path to write a report file to. If this path is not provided, no log will be generated. .PARAMETER OutputFormat The format for output (LegacyNUnitXml or NUnitXml), defaults to NUnitXml .PARAMETER Quiet Disables the output Pester writes to screen. No other output is generated unless you specify PassThru, or one of the Output parameters. .PARAMETER PesterOption Sets advanced options for the test execution. Enter a PesterOption object, such as one that you create by using the New-PesterOption cmdlet, or a hash table in which the keys are option names and the values are option values. For more information on the options available, see the help for New-PesterOption. .PARAMETER Show Customizes the output Pester writes to the screen. Available options are None, Default, Passed, Failed, Pending, Skipped, Inconclusive, Describe, Context, Summary, Header, All, Fails. The options can be combined to define presets. Common use cases are: None - to write no output to the screen. All - to write all available information (this is default option). Fails - to write everything except Passed (but including Describes etc.). A common setting is also Failed, Summary, to write only failed tests and test summary. This parameter does not affect the PassThru custom object or the XML output that is written when you use the Output parameters. .PARAMETER PassThru Returns a custom object (PSCustomObject) that contains the test results. By default, Invoke-Gherkin writes to the host program, not to the output stream (stdout). If you try to save the result in a variable, the variable is empty unless you use the PassThru parameter. To suppress the host output, use the Quiet parameter. .EXAMPLE Invoke-Gherkin This will find all *.feature specifications and execute their tests. No exit code will be returned and no log file will be saved. .EXAMPLE Invoke-Gherkin -Path ./tests/Utils* This will run all *.feature specifications under ./Tests that begin with Utils. .EXAMPLE Invoke-Gherkin -ScenarioName "Add Numbers" This will only run the Scenario named "Add Numbers" .EXAMPLE Invoke-Gherkin -EnableExit -OutputXml "./artifacts/TestResults.xml" This runs all tests from the current directory downwards and writes the results according to the NUnit schema to artifacts/TestResults.xml just below the current directory. The test run will return an exit code equal to the number of test failures. .EXAMPLE Invoke-Gherkin -CodeCoverage 'ScriptUnderTest.ps1' Runs all *.feature specifications in the current directory, and generates a coverage report for all commands in the "ScriptUnderTest.ps1" file. .EXAMPLE Invoke-Gherkin -CodeCoverage @{ Path = 'ScriptUnderTest.ps1'; Function = 'FunctionUnderTest' } Runs all *.feature specifications in the current directory, and generates a coverage report for all commands in the "FunctionUnderTest" function in the "ScriptUnderTest.ps1" file. .EXAMPLE Invoke-Gherkin -CodeCoverage @{ Path = 'ScriptUnderTest.ps1'; StartLine = 10; EndLine = 20 } Runs all *.feature specifications in the current directory, and generates a coverage report for all commands on lines 10 through 20 in the "ScriptUnderTest.ps1" file. .LINK Invoke-Pester https://kevinmarquette.github.io/2017-03-17-Powershell-Gherkin-specification-validation/ https://kevinmarquette.github.io/2017-04-30-Powershell-Gherkin-advanced-features/ #> [CmdletBinding(DefaultParameterSetName = 'Default')] param( [Parameter(Mandatory = $True, ParameterSetName = "RetestFailed")] [switch]$FailedLast, [Parameter(Position = 0, Mandatory = $False)] [Alias('Script', 'relative_path')] [string]$Path = $Pwd, [Parameter(Position = 1, Mandatory = $False)] [Alias("Name", "TestName")] [string[]]$ScenarioName, [Parameter(Position = 2, Mandatory = $False)] [switch]$EnableExit, [Parameter(Position = 4, Mandatory = $False)] [Alias('Tags')] [string[]]$Tag, [string[]]$ExcludeTag, [object[]] $CodeCoverage = @(), [Switch]$Strict, [string] $OutputFile, [ValidateSet('NUnitXml')] [string] $OutputFormat = 'NUnitXml', [Switch]$Quiet, [object]$PesterOption, [Pester.OutputTypes]$Show = 'All', [switch]$PassThru ) begin { & $SafeCommands["Import-LocalizedData"] -BindingVariable Script:ReportStrings -BaseDirectory $PesterRoot -FileName Gherkin.psd1 -ErrorAction SilentlyContinue #Fallback to en-US culture strings If ([String]::IsNullOrEmpty($ReportStrings)) { & $SafeCommands["Import-LocalizedData"] -BaseDirectory $PesterRoot -BindingVariable Script:ReportStrings -UICulture 'en-US' -FileName Gherkin.psd1 -ErrorAction Stop } # Make sure broken tests don't leave you in space: $CWD = [Environment]::CurrentDirectory $Location = & $SafeCommands["Get-Location"] [Environment]::CurrentDirectory = & $SafeCommands["Get-Location"] -PSProvider FileSystem $script:GherkinSteps = @{} $script:GherkinHooks = @{ BeforeEachFeature = @() BeforeEachScenario = @() AfterEachFeature = @() AfterEachScenario = @() } } end { if ($PSBoundParameters.ContainsKey('Quiet')) { & $SafeCommands["Write-Warning"] 'The -Quiet parameter has been deprecated; please use the new -Show parameter instead. To get no output use -Show None.' & $SafeCommands["Start-Sleep"] -Seconds 2 if (!$PSBoundParameters.ContainsKey('Show')) { $Show = [Pester.OutputTypes]::None } } if ($PSCmdlet.ParameterSetName -eq "RetestFailed" -and $FailedLast) { $ScenarioName = $script:GherkinFailedLast if (!$ScenarioName) { throw "There are no existing failed tests to re-run." } } $pester = New-PesterState -TagFilter @($Tag -split "\s+") -ExcludeTagFilter ($ExcludeTag -split "\s") -TestNameFilter $ScenarioName -SessionState $PSCmdlet.SessionState -Strict $Strict -Show $Show -PesterOption $PesterOption | & $SafeCommands["Add-Member"] -MemberType NoteProperty -Name Features -Value (& $SafeCommands["New-Object"] System.Collections.Generic.List[PSObject] ) -PassThru | & $SafeCommands["Add-Member"] -MemberType ScriptProperty -Name FailedScenarios -PassThru -Value { $Names = $this.TestResult | & $SafeCommands["Group-Object"] Describe | & $SafeCommands["Where-Object"] { $_.Group | & $SafeCommands["Where-Object"] { -not $_.Passed } } | & $SafeCommands["Select-Object"] -ExpandProperty Name $this.Features | Select-Object -ExpandProperty Scenarios | & $SafeCommands["Where-Object"] { $Names -contains $_.Name } } | & $SafeCommands["Add-Member"] -MemberType ScriptProperty -Name PassedScenarios -PassThru -Value { $Names = $this.TestResult | & $SafeCommands["Group-Object"] Describe | & $SafeCommands["Where-Object"] { -not ($_.Group | & $SafeCommands["Where-Object"] { -not $_.Passed }) } | & $SafeCommands["Select-Object"] -ExpandProperty Name $this.Features | Select-Object -ExpandProperty Scenarios | & $SafeCommands["Where-Object"] { $Names -contains $_.Name } } Write-PesterStart $pester $Path Enter-CoverageAnalysis -CodeCoverage $CodeCoverage -PesterState $pester foreach ($FeatureFile in & $SafeCommands["Get-ChildItem"] $Path -Filter "*.feature" -Recurse ) { Invoke-GherkinFeature $FeatureFile -Pester $pester } # Remove all the steps $Script:GherkinSteps.Clear() $Location | & $SafeCommands["Set-Location"] [Environment]::CurrentDirectory = $CWD $pester | Write-PesterReport $coverageReport = Get-CoverageReport -PesterState $pester Write-CoverageReport -CoverageReport $coverageReport Exit-CoverageAnalysis -PesterState $pester if (& $SafeCommands["Get-Variable"]-Name OutputFile -ValueOnly -ErrorAction $script:IgnoreErrorPreference) { Export-PesterResults -PesterState $pester -Path $OutputFile -Format $OutputFormat } if ($PassThru) { # Remove all runtime properties like current* and Scope $properties = @( "Path", "Features", "TagFilter", "TestNameFilter", "TotalCount", "PassedCount", "FailedCount", "Time", "TestResult", "PassedScenarios", "FailedScenarios" if ($CodeCoverage) { @{ Name = 'CodeCoverage'; Expression = { $coverageReport } } } ) $result = $pester | & $SafeCommands["Select-Object"] -Property $properties $result.PSTypeNames.Insert(0, "Pester.Gherkin.Results") $result } $script:GherkinFailedLast = @($pester.FailedScenarios.Name) if ($EnableExit) { Exit-WithCode -FailedCount $pester.FailedCount } } } function Import-GherkinSteps { <# .SYNOPSIS Internal function for importing the script steps from a directory tree .PARAMETER StepPath The folder which contains step files .PARAMETER Pester Pester #> [CmdletBinding()] param( [Alias("PSPath")] [Parameter(Mandatory = $True, Position = 0, ValueFromPipelineByPropertyName = $True)] $StepPath, [PSObject]$Pester ) begin { # Remove all existing steps $Script:GherkinSteps.Clear() # Remove all existing hooks $Script:GherkinHooks.Clear() } process { foreach ($StepFile in & $SafeCommands["Get-ChildItem"] $StepPath -Filter "*.?teps.ps1" -Include "*.[sS]teps.ps1" -Recurse) { $invokeTestScript = { [CmdletBinding()] param ( [Parameter(Position = 0)] [string] $Path ) & $Path } Set-ScriptBlockScope -ScriptBlock $invokeTestScript -SessionState $Pester.SessionState & $invokeTestScript $StepFile.FullName } & $SafeCommands["Write-Verbose"] "Loaded $($Script:GherkinSteps.Count) step definitions from $(@($StepFiles).Count) steps file(s)" } } function Import-GherkinFeature { <# .SYNOPSIS Internal function to import a Gherkin feature file. Wraps Gherkin.Parse .PARAMETER Path The path to the feature file to import .PARAMETER Pester Internal Pester object. For internal use only #> [CmdletBinding()] param($Path, [PSObject]$Pester) $Background = $null $parser = & $SafeCommands["New-Object"] Gherkin.Parser $Feature = $parser.Parse($Path).Feature | Convert-Tags $Scenarios = $( :scenarios foreach ($Child in $Feature.Children) { $null = & $SafeCommands["Add-Member"] -MemberType "NoteProperty" -InputObject $Child.Location -Name "Path" -Value $Path foreach ($Step in $Child.Steps) { $null = & $SafeCommands["Add-Member"] -MemberType "NoteProperty" -InputObject $Step.Location -Name "Path" -Value $Path } switch ($Child.Keyword.Trim()) { "Scenario" { $Scenario = Convert-Tags -InputObject $Child -BaseTags $Feature.Tags } "Scenario Outline" { $Scenario = Convert-Tags -InputObject $Child -BaseTags $Feature.Tags } "Background" { $Background = Convert-Tags -InputObject $Child -BaseTags $Feature.Tags continue scenarios } default { & $SafeCommands["Write-Warning"] "Unexpected Feature Child: $_" } } if ($Scenario.Examples) { foreach ($ExampleSet in $Scenario.Examples) { ${Column Names} = @($ExampleSet.TableHeader.Cells | & $SafeCommands["Select-Object"] -ExpandProperty Value) $NamesPattern = "<(?:" + (${Column Names} -join "|") + ")>" $Steps = foreach ($Example in $ExampleSet.TableBody) { foreach ($Step in $Scenario.Steps) { [string]$StepText = $Step.Text if ($StepText -match $NamesPattern) { for ($n = 0; $n -lt ${Column Names}.Length; $n++) { $Name = ${Column Names}[$n] if ($Example.Cells[$n].Value -and $StepText -match "<${Name}>") { $StepText = $StepText -replace "<${Name}>", $Example.Cells[$n].Value } } } if ($StepText -ne $Step.Text) { & $SafeCommands["New-Object"] Gherkin.Ast.Step $Step.Location, $Step.Keyword.Trim(), $StepText, $Step.Argument } else { $Step } } } $ScenarioName = $Scenario.Name if ($ExampleSet.Name) { $ScenarioName = $ScenarioName + "`n Examples:" + $ExampleSet.Name.Trim() } & $SafeCommands["New-Object"] Gherkin.Ast.Scenario $ExampleSet.Tags, $Scenario.Location, $Scenario.Keyword.Trim(), $ScenarioName, $Scenario.Description, $Steps | Convert-Tags $Scenario.Tags } } else { $Scenario } } ) & $SafeCommands["Add-Member"] -MemberType NoteProperty -InputObject $Feature -Name Scenarios -Value $Scenarios -Force return $Feature, $Background, $Scenarios } function Invoke-GherkinFeature { <# .SYNOPSIS Internal function to (parse and) run a whole feature file #> [CmdletBinding()] param( [Alias("PSPath")] [Parameter(Mandatory = $True, Position = 0, ValueFromPipelineByPropertyName = $True)] [IO.FileInfo]$FeatureFile, [PSObject]$Pester ) $Pester.EnterTestGroup($FeatureFile.FullName, 'Script') # Make sure broken tests don't leave you in space: $CWD = [Environment]::CurrentDirectory $Location = & $SafeCommands["Get-Location"] [Environment]::CurrentDirectory = & $SafeCommands["Get-Location"] -PSProvider FileSystem try { $Parent = & $SafeCommands["Split-Path"] $FeatureFile.FullName Import-GherkinSteps -StepPath $Parent -Pester $pester $Feature, $Background, $Scenarios = Import-GherkinFeature -Path $FeatureFile.FullName -Pester $Pester } catch [Gherkin.ParserException] { & $SafeCommands["Write-Error"] -Exception $_.Exception -Message "Skipped '$($FeatureFile.FullName)' because of parser error.`n$(($_.Exception.Errors | & $SafeCommands["Select-Object"] -Expand Message) -join "`n`n")" continue } $null = $Pester.Features.Add($Feature) Invoke-GherkinHook BeforeEachFeature $Feature.Name $Feature.Tags # Test the name filter first, since it will probably return one single item if ($Pester.TestNameFilter) { $Scenarios = foreach ($nameFilter in $Pester.TestNameFilter) { $Scenarios | & $SafeCommands["Where-Object"] { $_.Name -like $NameFilter } } $Scenarios = $Scenarios | & $SafeCommands["Get-Unique"] } # if($Pester.TagFilter -and @(Compare-Object $Tags $Pester.TagFilter -IncludeEqual -ExcludeDifferent).count -eq 0) {return} if ($Pester.TagFilter) { $Scenarios = $Scenarios | & $SafeCommands["Where-Object"] { & $SafeCommands["Compare-Object"] $_.Tags $Pester.TagFilter -IncludeEqual -ExcludeDifferent } } # if($Pester.ExcludeTagFilter -and @(Compare-Object $Tags $Pester.ExcludeTagFilter -IncludeEqual -ExcludeDifferent).count -gt 0) {return} if ($Pester.ExcludeTagFilter) { $Scenarios = $Scenarios | & $SafeCommands["Where-Object"] { !(& $SafeCommands["Compare-Object"] $_.Tags $Pester.ExcludeTagFilter -IncludeEqual -ExcludeDifferent) } } if ($Scenarios) { Write-Describe $Feature } try { foreach ($Scenario in $Scenarios) { Invoke-GherkinScenario $Pester $Scenario $Background } } catch { $firstStackTraceLine = $_.ScriptStackTrace -split '\r?\n' | & $SafeCommands["Select-Object"] -First 1 $Pester.AddTestResult("Error occurred in test script '$($Feature.Path)'", "Failed", $null, $_.Exception.Message, $firstStackTraceLine, $null, $null, $_) # This is a hack to ensure that XML output is valid for now. The test-suite names come from the Describe attribute of the TestResult # objects, and a blank name is invalid NUnit XML. This will go away when we promote test scripts to have their own test-suite nodes, # planned for v4.0 $Pester.TestResult[-1].Describe = "Error in $($Feature.Path)" $Pester.TestResult[-1] | Write-PesterResult } finally { $Location | & $SafeCommands["Set-Location"] [Environment]::CurrentDirectory = $CWD } Invoke-GherkinHook AfterEachFeature $Feature.Name $Feature.Tags $Pester.LeaveTestGroup($FeatureFile.FullName, 'Script') } function Invoke-GherkinScenario { <# .SYNOPSIS Internal function to (parse and) run a single scenario #> [CmdletBinding()] param( $Pester, $Scenario, $Background ) $Pester.EnterTestGroup($Scenario.Name, 'Scenario') try { Write-Context $Scenario $script:mockTable = @{} # Create a clean variable scope in each scenario $script:GherkinScenarioScope = New-Module NestedGherkin { } $script:GherkinSessionState = $Script:GherkinScenarioScope.SessionState #Wait-Debugger New-TestDrive Invoke-GherkinHook BeforeEachScenario $Scenario.Name $Scenario.Tags # If there's a background, run that before the test, but after hooks if ($Background) { foreach ($Step in $Background.Steps) { # Run Background steps -Background so they don't output in each scenario Invoke-GherkinStep -Step $Step -Pester $Pester -Scenario $GherkinSessionState -Visible } } foreach ($Step in $Scenario.Steps) { Invoke-GherkinStep -Step $Step -Pester $Pester -Scenario $GherkinSessionState -Visible } Invoke-GherkinHook AfterEachScenario $Scenario.Name $Scenario.Tags } catch { $firstStackTraceLine = $_.ScriptStackTrace -split '\r?\n' | & $SafeCommands["Select-Object"] -First 1 $Pester.AddTestResult("Error occurred in scenario '$($Scenario.Name)'", "Failed", $null, $_.Exception.Message, $firstStackTraceLine, $null, $null, $_) # This is a hack to ensure that XML output is valid for now. The test-suite names come from the Describe attribute of the TestResult # objects, and a blank name is invalid NUnit XML. This will go away when we promote test scripts to have their own test-suite nodes, # planned for v4.0 $Pester.TestResult[-1].Describe = "Error in $($Scenario.Name)" $Pester.TestResult[-1] | Write-PesterResult } Remove-TestDrive $Pester.LeaveTestGroup($Scenario.Name, 'Scenario') Exit-MockScope } function Find-GherkinStep { <# .SYNOPSIS Find a step implmentation that matches a given step .DESCRIPTION Searches the *.Steps.ps1 files in the BasePath (current working directory, by default) Returns the step(s) that match .PARAMETER Step The text from feature file .PARAMETER BasePath The path to search for step implementations. .EXAMPLE Find-GherkinStep -Step 'And the module is imported' Step Source Implementation ---- ------ -------------- And the module is imported .\module.Steps.ps1: line 39 ... #> [CmdletBinding()] param( [string]$Step, [string]$BasePath = $Pwd ) $OriginalGherkinSteps = $Script:GherkinSteps try { Import-GherkinSteps $BasePath -Pester $PSCmdlet $KeyWord, $StepText = $Step -split "(?<=^(?:Given|When|Then|And|But))\s+" if (!$StepText) { $StepText = $KeyWord } & $SafeCommands["Write-Verbose"] "Searching for '$StepText' in $($Script:GherkinSteps.Count) steps" $( foreach ($StepCommand in $Script:GherkinSteps.Keys) { & $SafeCommands["Write-Verbose"] "... $StepCommand" if ($StepText -match "^${StepCommand}$") { & $SafeCommands["Write-Verbose"] "Found match: $StepCommand" $StepCommand | & $SafeCommands["Add-Member"] -MemberType NoteProperty -Name MatchCount -Value $Matches.Count -PassThru } } ) | & $SafeCommands["Sort-Object"] MatchCount | & $SafeCommands["Select-Object"] @{ Name = 'Step' Expression = { $Step } }, @{ Name = 'Source' Expression = { $Script:GherkinSteps["$_"].Source } }, @{ Name = 'Implementation' Expression = { $Script:GherkinSteps["$_"] } } -First 1 # $StepText = "{0} {1} {2}" -f $Step.Keyword.Trim(), $Step.Text, $Script:GherkinSteps[$StepCommand].Source } finally { $Script:GherkinSteps = $OriginalGherkinSteps } } function Invoke-GherkinStep { <# .SYNOPSIS Run a single gherkin step, given the text from the feature file .PARAMETER Step The text of the step for matching against regex patterns in step implementations .PARAMETER Visible If Visible is true, the results of this step will be shown in the test report .PARAMETER Pester Pester state object. For internal use only .PARAMETER ScenarioState Gherkin state object. For internal use only #> [CmdletBinding()] param ( $Step, [Switch]$Visible, $Pester, $ScenarioState ) if ($Step -is [string]) { $KeyWord, $StepText = $Step -split "(?<=^(?:Given|When|Then|And|But))\s+" if (!$StepText) { $StepText = $KeyWord $Keyword = "Step" } $Step = @{ Text = $StepText; Keyword = $Keyword } } $DisplayText = "{0} {1}" -f $Step.Keyword.Trim(), $Step.Text $PesterErrorRecord = $null $Source = $null $Elapsed = $null $NamedArguments = @{} try { # Pick the match with the least grouping wildcards in it... $StepCommand = $( foreach ($StepCommand in $Script:GherkinSteps.Keys) { if ($Step.Text -match "^${StepCommand}$") { $StepCommand | & $SafeCommands["Add-Member"] -MemberType NoteProperty -Name MatchCount -Value $Matches.Count -PassThru } } ) | & $SafeCommands["Sort-Object"] MatchCount | & $SafeCommands["Select-Object"] -First 1 if (!$StepCommand) { $PesterErrorRecord = New-InconclusiveErrorRecord -Message "Could not find implementation for step!" -File $Step.Location.Path -Line $Step.Location.Line -LineText $DisplayText } else { $NamedArguments, $Parameters = Get-StepParameters $Step $StepCommand $watch = & $SafeCommands["New-Object"] System.Diagnostics.Stopwatch $watch.Start() try { # Invoke-GherkinHook BeforeStep $Step.Text $Step.Tags if ($NamedArguments.Count) { if ($NamedArguments.ContainsKey("Table")) { $DisplayText += "..." } $ScriptBlock = { . $Script:GherkinSteps.$StepCommand @NamedArguments @Parameters } } else { $ScriptBlock = { . $Script:GherkinSteps.$StepCommand @Parameters } } Set-ScriptBlockScope -ScriptBlock $Script:GherkinSteps.$StepCommand -SessionState $ScenarioState $null = & $ScriptBlock } catch { $PesterErrorRecord = $_ } $watch.Stop() $Elapsed = $watch.Elapsed $Source = $Script:GherkinSteps[$StepCommand].Source } } catch { $PesterErrorRecord = $_ } if ($Pester -and $Visible) { for ($p = 0; $p -lt $Parameters.Count; $p++) { $NamedArguments."Unnamed-$p" = $Parameters[$p] } # Normally, PesterErrorRecord is an ErrorRecord. Sometimes, it's an exception which HAS A ErrorRecord if ($PesterErrorRecord.ErrorRecord) { $PesterErrorRecord = $PesterErrorRecord.ErrorRecord } ${Pester Result} = ConvertTo-PesterResult -ErrorRecord $PesterErrorRecord # For Gherkin, we want to show the step, but not pretend to be a StackTrace if (${Pester Result}.Result -eq 'Inconclusive') { ${Pester Result}.StackTrace = "At " + $Step.Keyword.Trim() + ', ' + $Step.Location.Path + ': line ' + $Step.Location.Line } else { # Unless we really are a StackTrace... ${Pester Result}.StackTrace += "`nFrom " + $Step.Location.Path + ': line ' + $Step.Location.Line } $Pester.AddTestResult($DisplayText, ${Pester Result}.Result, $Elapsed, $PesterErrorRecord.Exception.Message, ${Pester Result}.StackTrace, $Source, $NamedArguments, $PesterErrorRecord ) $Pester.TestResult[-1] | Write-PesterResult } } function Get-StepParameters { <# .SYNOPSIS Internal function for determining parameters for a step implementation .PARAMETER Step The parsed step from the feature file .PARAMETER CommandName The text of the best matching step #> param($Step, $CommandName) $Null = $Step.Text -match $CommandName $NamedArguments = @{} $Parameters = @{} foreach ($kv in $Matches.GetEnumerator()) { switch ($kv.Name -as [int]) { 0 { } # toss zero (where it matches the whole string) $null { $NamedArguments.($kv.Name) = $ExecutionContext.InvokeCommand.ExpandString($kv.Value) } default { $Parameters.([int]$kv.Name) = $ExecutionContext.InvokeCommand.ExpandString($kv.Value) } } } $Parameters = @($Parameters.GetEnumerator() | & $SafeCommands["Sort-Object"] Name | & $SafeCommands["Select-Object"] -ExpandProperty Value) # TODO: Convert parsed tables to tables.... if ($Step.Argument -is [Gherkin.Ast.DataTable]) { $NamedArguments.Table = $Step.Argument.Rows | ConvertTo-HashTableArray } if ($Step.Argument -is [Gherkin.Ast.DocString]) { # trim empty matches if we're attaching DocStringArgument $Parameters = @( $Parameters | & $SafeCommands["Where-Object"] { $_.Length } ) + $Step.Argument.Content } return @($NamedArguments, $Parameters) } function Convert-Tags { <# .SYNOPSIS Internal function for tagging Gherkin feature files (including inheritance from the feature) #> [CmdletBinding()] param( [Parameter(ValueFromPipeline = $true)] $InputObject, [Parameter(Position = 0)] [string[]]$BaseTags = @() ) process { # Adapt the Gherkin .Tags property to the way we prefer it... [string[]]$Tags = foreach ($tag in $InputObject.Tags | Where-Object { $_ }) { $tag.Name.TrimStart("@") } & $SafeCommands["Add-Member"] -MemberType NoteProperty -InputObject $InputObject -Name Tags -Value ([string[]]($Tags + $BaseTags)) -Force $InputObject } } function ConvertTo-HashTableArray { <# .SYNOPSIS Internal function for converting Gherkin AST tables to arrays of hashtables for splatting #> [CmdletBinding()] param( [Parameter(ValueFromPipeline = $true)] [Gherkin.Ast.TableRow[]]$InputObject ) begin { ${Column Names} = @() ${Result Table} = @() } process { # Convert the first table row into headers: ${InputObject Rows} = @($InputObject) if (!${Column Names}) { & $SafeCommands["Write-Verbose"] "Reading Names from Header" ${InputObject Header}, ${InputObject Rows} = ${InputObject Rows} ${Column Names} = ${InputObject Header}.Cells | & $SafeCommands["Select-Object"] -ExpandProperty Value } & $SafeCommands["Write-Verbose"] "Processing $(${InputObject Rows}.Length) Rows" foreach (${InputObject row} in ${InputObject Rows}) { ${Pester Result} = @{} for ($n = 0; $n -lt ${Column Names}.Length; $n++) { ${Pester Result}.Add(${Column Names}[$n], ${InputObject row}.Cells[$n].Value) } ${Result Table} += @(${Pester Result}) } } end { ${Result Table} } } |