Skip to content

Fix #2571: Expand data-driven block name before BeforeAll execution #2711

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
nohwnd wants to merge 1 commit into from
Closed

Fix #2571: Expand data-driven block name before BeforeAll execution #2711

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 26 additions & 21 deletions src/Pester.Runtime.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,32 +377,37 @@ function Invoke-Block ($previousBlock) {
$sessionStateInternal = $script:ScriptBlockSessionStateInternalProperty.GetValue($block.ScriptBlock, $null)
$script:ScriptBlockSessionStateInternalProperty.SetValue($sb, $SessionStateInternal)

$expandCurrentBlockName = if (-not $Block.IsRoot) {
# expand block name by evaluating the <> templates, only match templates that have at least 1 character and are not escaped by `<abc`>
# avoid using variables so we don't run into conflicts
$sb = {

$____Pester.CurrentBlock.ExpandedName = if ($____Pester.CurrentBlock.Name -like "*<*") { & ([ScriptBlock]::Create(('"' + ($____Pester.CurrentBlock.Name -replace '\$', '`$' -replace '"', '`"' -replace '(?<!`)<([^>^`]+)>', '$$($$$1)') + '"'))) } else { $____Pester.CurrentBlock.Name }

$____Pester.CurrentBlock.ExpandedPath = if ($____Pester.CurrentBlock.Parent.IsRoot) {
# to avoid including Root name in the path
$____Pester.CurrentBlock.ExpandedName
}
else {
"$($____Pester.CurrentBlock.Parent.ExpandedPath).$($____Pester.CurrentBlock.ExpandedName)"
}
}

$SessionStateInternal = $script:ScriptBlockSessionStateInternalProperty.GetValue($State.CurrentBlock.ScriptBlock, $null)
$script:ScriptBlockSessionStateInternalProperty.SetValue($sb, $SessionStateInternal)

$sb
}

$result = Invoke-ScriptBlock `
-ScriptBlock $sb `
-OuterSetup @(
$(if (-not (Is-Discovery) -and (-not $Block.Skip)) {
@($previousBlock.EachBlockSetup) + @($block.OneTimeTestSetup)
@($previousBlock.EachBlockSetup)
})
$(if (-not $Block.IsRoot) {
# expand block name by evaluating the <> templates, only match templates that have at least 1 character and are not escaped by `<abc`>
# avoid using variables so we don't run into conflicts
$sb = {

$____Pester.CurrentBlock.ExpandedName = if ($____Pester.CurrentBlock.Name -like "*<*") { & ([ScriptBlock]::Create(('"' + ($____Pester.CurrentBlock.Name -replace '\$', '`$' -replace '"', '`"' -replace '(?<!`)<([^>^`]+)>', '$$($$$1)') + '"'))) } else { $____Pester.CurrentBlock.Name }

$____Pester.CurrentBlock.ExpandedPath = if ($____Pester.CurrentBlock.Parent.IsRoot) {
# to avoid including Root name in the path
$____Pester.CurrentBlock.ExpandedName
}
else {
"$($____Pester.CurrentBlock.Parent.ExpandedPath).$($____Pester.CurrentBlock.ExpandedName)"
}
}

$SessionStateInternal = $script:ScriptBlockSessionStateInternalProperty.GetValue($State.CurrentBlock.ScriptBlock, $null)
$script:ScriptBlockSessionStateInternalProperty.SetValue($sb, $SessionStateInternal)

$sb
$expandCurrentBlockName
$(if (-not (Is-Discovery) -and (-not $Block.Skip)) {
@($block.OneTimeTestSetup)
})
) `
-OuterTeardown $( if (-not (Is-Discovery) -and (-not $Block.Skip)) {
Expand Down
5 changes: 3 additions & 2 deletions src/functions/Output.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ function Write-PesterReport {

if (0 -lt $RunResult.FailedBlocksCount) {
Write-PesterHostMessage ('BeforeAll \ AfterAll failed: {0}' -f $RunResult.FailedBlocksCount) -Foreground $ReportTheme.Fail
Write-PesterHostMessage ($(foreach ($b in $RunResult.FailedBlocks) { " - $($b.Path -join '.')" }) -join [Environment]::NewLine) -Foreground $ReportTheme.Fail
Write-PesterHostMessage ($(foreach ($b in $RunResult.FailedBlocks) { " - $(if (-not [string]::IsNullOrWhiteSpace($b.ExpandedPath)) { $b.ExpandedPath } else { $b.Path -join '.' })" }) -join [Environment]::NewLine) -Foreground $ReportTheme.Fail
}

if (0 -lt $RunResult.FailedContainersCount) {
Expand Down Expand Up @@ -773,7 +773,8 @@ function Get-WriteScreenPlugin ($Verbosity) {

foreach ($e in $Context.Block.ErrorRecord) { ConvertTo-FailureLines $e }

$errorHeader = "[-] $($Context.Block.FrameworkData.CommandUsed) $($Context.Block.Path -join ".") failed"
$blockPath = if (-not [string]::IsNullOrWhiteSpace($Context.Block.ExpandedPath)) { $Context.Block.ExpandedPath } else { $Context.Block.Path -join "." }
$errorHeader = "[-] $($Context.Block.FrameworkData.CommandUsed) $blockPath failed"

$formatErrorParams = @{
Err = $Context.Block.ErrorRecord
Expand Down
27 changes: 27 additions & 0 deletions tst/Pester.RSpec.Output.ts.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,33 @@ i -PassThru:$PassThru {
@($describe1).Count | Verify-Equal 1
@($describe2).Count | Verify-Equal 1
}

t 'BeforeAll failures use expanded names for each data item' {
$sb = {
$PesterPreference = [PesterConfiguration]::Default
$PesterPreference.Output.Verbosity = 'Detailed'
$PesterPreference.Output.RenderMode = 'ConsoleColor'

$container = New-PesterContainer -ScriptBlock {
Describe 'Test <_>' -ForEach @('a', 'b') {
BeforeAll { throw 'something' }
It 'is a or b' {
$_ | Should -Match '[ab]'
}
}
}
Invoke-Pester -Container $container
}

$output = Invoke-InNewProcess $sb
$null, $run = $output -join "`n" -split 'Running tests.'
$run | Write-Host

@($output | Select-String -Pattern '\[-\] Describe Test a failed\s*$').Count | Verify-Equal 1
@($output | Select-String -Pattern '\[-\] Describe Test b failed\s*$').Count | Verify-Equal 1
@($output | Select-String -Pattern ' - Test a\s*$').Count | Verify-Equal 1
@($output | Select-String -Pattern ' - Test b\s*$').Count | Verify-Equal 1
}
}

b 'Output for container names' {
Expand Down
26 changes: 23 additions & 3 deletions tst/Pester.RSpec.ts.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2076,9 +2076,29 @@ i -PassThru:$PassThru {
$container = New-PesterContainer -ScriptBlock $sb
$r = Invoke-Pester -Container $container -PassThru
$r.Containers[0].Blocks[0].Blocks[0].Result | Verify-Equal 'Failed'
$r.Containers[0].Blocks[0].Blocks[0].ExpandedName | Verify-Equal 'd2 <_>'
# ExpandedPath is updated as far as possible (parent block) before failure in block
$r.Containers[0].Blocks[0].Blocks[0].ExpandedPath | Verify-Equal 'd 1.d2 <_>'
$r.Containers[0].Blocks[0].Blocks[0].ExpandedName | Verify-Equal 'd2 1'
$r.Containers[0].Blocks[0].Blocks[0].ExpandedPath | Verify-Equal 'd 1.d2 1'
}

t "Data-driven Describe names are expanded before BeforeAll throws" {
$sb = {
Describe 'Test <_>' -ForEach @('a', 'b') {
BeforeAll { throw 'something' }
It 'is a or b' {
$_ | Should -Match '[ab]'
}
}
}

$r = Invoke-Pester -Configuration ([PesterConfiguration]@{
Run = @{ ScriptBlock = $sb; PassThru = $true }
Output = @{ Verbosity = 'Detailed' }
})

$r.Containers[0].Blocks[0].ExpandedName | Verify-Equal 'Test a'
$r.Containers[0].Blocks[0].ExpandedPath | Verify-Equal 'Test a'
$r.Containers[0].Blocks[1].ExpandedName | Verify-Equal 'Test b'
$r.Containers[0].Blocks[1].ExpandedPath | Verify-Equal 'Test b'
}

t "ExpandedPath is expanded for parent blocks when test is skipped or fails in BeforeEach" {
Expand Down
Loading