Skip to content
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

Skip blocks without runnable tests #2447

Merged
merged 6 commits into from
May 17, 2024
+126 −46
Merged

Skip blocks without runnable tests #2447

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ae07d00
Use new certificate thumbprint
nohwnd Apr 25, 2024
7a5148e
Skip blocks when no tests should execute
fflaten May 8, 2024
93e3076
Don't modify blocks that are excluded
fflaten May 8, 2024
1711adf
Add test for onetime setup/teardown on skipped blocks
fflaten May 13, 2024
433db55
Update test
fflaten May 13, 2024
5fc7b82
Cleanup
fflaten May 13, 2024
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
2 changes: 1 addition & 1 deletion publish/release.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ param (
[String] $PsGalleryApiKey,
[String] $NugetApiKey,
[String] $ChocolateyApiKey,
[String] $CertificateThumbprint = 'c7b0582906e5205b8399d92991694a614d0c0b22',
[String] $CertificateThumbprint = '2FCC9148EC2C9AB951C6F9654C0D2ED16AF27738',
[Switch] $Force
)

Expand Down
35 changes: 35 additions & 0 deletions src/Pester.Runtime.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2061,6 +2061,7 @@ function PostProcess-DiscoveredBlock {
}

$blockShouldRun = $false
$allTestsSkipped = $true
if ($tests.Count -gt 0) {
foreach ($t in $tests) {
$t.Block = $b
Expand Down Expand Up @@ -2140,11 +2141,19 @@ function PostProcess-DiscoveredBlock {
$testsToRun[-1].Last = $true
$blockShouldRun = $true
}

foreach ($t in $testsToRun) {
if (-not $t.Skip) {
$allTestsSkipped = $false
break
}
}
}
}

$childBlocks = $b.Blocks
$anyChildBlockShouldRun = $false
$allChildBlockSkipped = $true
if ($childBlocks.Count -gt 0) {
foreach ($cb in $childBlocks) {
$cb.Parent = $b
Expand All @@ -2159,9 +2168,17 @@ function PostProcess-DiscoveredBlock {
$childBlocksToRun[0].First = $true
$childBlocksToRun[-1].Last = $true
}

foreach ($cb in $childBlocksToRun) {
if (-not $cb.Skip) {
$allChildBlockSkipped = $false
break
}
}
}

$shouldRunBasedOnChildren = $blockShouldRun -or $anyChildBlockShouldRun
$shouldSkipBasedOnChildren = $allTestsSkipped -and $allChildBlockSkipped

if ($b.ShouldRun -and -not $shouldRunBasedOnChildren) {
if ($PesterPreference.Debug.WriteDebugMessages.Value) {
Expand All @@ -2170,6 +2187,24 @@ function PostProcess-DiscoveredBlock {
}

$b.ShouldRun = $shouldRunBasedOnChildren

if ($b.ShouldRun) {
if (-not $b.Skip -and $shouldSkipBasedOnChildren) {
if ($PesterPreference.Debug.WriteDebugMessages.Value) {
if ($b.IsRoot) {
Write-PesterDebugMessage -Scope Skip "($($b.BlockContainer)) Container will be skipped because all children are excluded or skipped."
} else {
Write-PesterDebugMessage -Scope Skip "($($b.Path -join '.')) Block will be skipped because all children are excluded or skipped."
}
}
$b.Skip = $true
} elseif ($b.Skip -and -not $shouldSkipBasedOnChildren) {
if ($PesterPreference.Debug.WriteDebugMessages.Value) {
Write-PesterDebugMessage -Scope Skip "($($b.Path -join '.')) Block was marked as Skip, but one or more children should run and is not skipped, so the block will not be skipped."
}
$b.Skip = $false
}
fflaten marked this conversation as resolved.
Show resolved Hide resolved
}
}
}

Expand Down
86 changes: 41 additions & 45 deletions tst/Pester.Runtime.ts.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1229,52 +1229,48 @@ i -PassThru:$PassThru {
$container.EachTestTeardown | Verify-Equal 0
}

t "skipping all items in a block will skip the parent block" {
# this is not implemented, but is a possible feature
# which could be implemented together with "if any test is explicitly unskipped in child
# then the block should run, this will be needed for running tests explicitly by path I think
# it also should be taken into consideration whether or not adding a lazySkip is a good idea and how it would
# affect implementation of this. Right now skipping the block goes from parent down, and skipping all items in a block
# will not prevent the parent block setups from running

# $container = @{
# OneTimeTestSetup = 0
# OneTimeTestTeardown = 0
# EachTestSetup = 0
# EachTestTeardown = 0
# TestRun = 0
# }
t 'skipping all items in a block will skip the parent block' {
$container = @{
OneTimeTestSetup = 0
OneTimeTestTeardown = 0
EachTestSetup = 0
EachTestTeardown = 0
TestRun = 0
}

$actual = Invoke-Test -SessionState $ExecutionContext.SessionState -BlockContainer (New-BlockContainerObject -ScriptBlock {
New-OneTimeTestSetup -ScriptBlock { $container.OneTimeTestSetup++ }
New-OneTimeTestTeardown -ScriptBlock { $container.OneTimeTestTeardown++ }

New-Block 'parent block' {
# putting this in child block because each test setup is not supported in root block
New-OneTimeTestSetup -ScriptBlock { $container.OneTimeTestSetup++ }
New-OneTimeTestTeardown -ScriptBlock { $container.OneTimeTestTeardown++ }

New-EachTestSetup -ScriptBlock { $container.EachTestSetup++ }
New-EachTestTeardown -ScriptBlock { $container.EachTestTeardown++ }

New-Test 'test1' -Skip {
$container.TestRun++
'a'
}

# $actual = Invoke-Test -SessionState $ExecutionContext.SessionState -BlockContainer (New-BlockContainerObject -ScriptBlock {
# New-Block "parent block" {
# New-Block "parent block" {
# # putting this in child block because each test setup is not supported in root block
# New-OneTimeTestSetup -ScriptBlock { $container.OneTimeTestSetup++ }
# New-OneTimeTestTeardown -ScriptBlock { $container.OneTimeTestTeardown++ }

# New-EachTestSetup -ScriptBlock { $container.EachTestSetup++ }
# New-EachTestTeardown -ScriptBlock { $container.EachTestTeardown++ }

# New-Test "test1" -Skip {
# $container.TestRun++
# "a"
# }

# New-Test "test2" -Skip {
# $container.TestRun++
# "a"
# }
# }
# }
# })

# # $actual.Blocks[0].Skip | Verify-True
# $actual.Blocks[0].ErrorRecord.Count | Verify-Equal 0
# $container.TestRun | Verify-Equal 0
# $container.OneTimeTestSetup | Verify-Equal 0
# $container.OneTimeTestTeardown | Verify-Equal 0
# $container.EachTestSetup | Verify-Equal 0
# $container.EachTestTeardown | Verify-Equal 0
New-Test 'test2' -Skip {
$container.TestRun++
'a'
}
}
})

# Should be marked as Skip by runtime
$actual.Blocks[0].Skip | Verify-True
$actual.Blocks[0].ErrorRecord.Count | Verify-Equal 0

$container.TestRun | Verify-Equal 0
$container.OneTimeTestSetup | Verify-Equal 0
$container.OneTimeTestTeardown | Verify-Equal 0
$container.EachTestSetup | Verify-Equal 0
$container.EachTestTeardown | Verify-Equal 0
}
}

Expand Down