Skip to content

Commit b3ee4da

Browse files
bolensbolens
committed
fix(ci): pin Pester 5.x and harden flaky assertions
Pester 6 breaks coverage tracer teardown with SmartPrompt and stricter mocks. Pin CI/runner to 5.x and align tests with current module behavior.
1 parent 03ffdec commit b3ee4da

23 files changed

Lines changed: 251 additions & 167 deletions

‎.github/workflows/test-pester.yml‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,15 @@ jobs:
8888
Register-PSRepository -Default
8989
}
9090
Set-PSRepository -Name PSGallery -InstallationPolicy Trusted
91-
Install-Module -Name Pester -MinimumVersion 5.0.0 -Force -Scope CurrentUser
91+
Install-Module -Name Pester -MinimumVersion 5.0.0 -MaximumVersion 5.99.99 -Force -Scope CurrentUser -AllowClobber
92+
# Prefer 5.7.x when multiple 5.x builds are present; reject Pester 6+ (breaks coverage tracer teardown / mocks).
93+
$pester5 = Get-Module -ListAvailable Pester |
94+
Where-Object { $_.Version -ge [version]'5.0.0' -and $_.Version -lt [version]'6.0.0' } |
95+
Sort-Object Version -Descending |
96+
Select-Object -First 1
97+
if (-not $pester5) { throw 'Pester 5.x is required but was not installed' }
98+
Import-Module Pester -RequiredVersion $pester5.Version -Force
99+
Write-Host "Installed Pester $($pester5.Version)"
92100
- name: Run Pester shard
93101
shell: pwsh
94102
run: |

‎scripts/lib/ModuleImport.psm1‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,36 @@ function Get-LibPath {
123123

124124
# Resolve repository root first, then construct scripts/lib path
125125
if (-not (Get-Command Get-RepoRoot -ErrorAction SilentlyContinue)) {
126+
# Bootstrap PathResolution when callers import ModuleImport alone (common in scripts).
127+
$moduleImportDir = $PSScriptRoot
128+
if (-not $moduleImportDir -and $PSCommandPath) {
129+
$moduleImportDir = Split-Path -Parent $PSCommandPath
130+
}
131+
$pathResolutionCandidate = Join-Path $moduleImportDir 'path' 'PathResolution.psm1'
132+
if (Test-Path -LiteralPath $pathResolutionCandidate) {
133+
Import-Module $pathResolutionCandidate -DisableNameChecking -ErrorAction SilentlyContinue
134+
}
135+
}
136+
137+
if (-not (Get-Command Get-RepoRoot -ErrorAction SilentlyContinue)) {
138+
# Last-resort walk from ScriptPath so ExitCodes/Logging can load before PathResolution.
139+
$probe = $ScriptPath
140+
if (Test-Path -LiteralPath $probe -PathType Leaf) {
141+
$probe = Split-Path -Parent $probe
142+
}
143+
while ($probe) {
144+
$candidateLib = Join-Path $probe 'scripts' 'lib'
145+
if (Test-Path -LiteralPath $candidateLib -PathType Container) {
146+
$resolvedLibPath = (Resolve-Path -LiteralPath $candidateLib).Path
147+
if (Get-Command Set-CachedValue -ErrorAction SilentlyContinue) {
148+
Set-CachedValue -Key $cacheKey -Value $resolvedLibPath -ExpirationSeconds 3600
149+
}
150+
return $resolvedLibPath
151+
}
152+
$parent = Split-Path -Parent $probe
153+
if (-not $parent -or $parent -eq $probe) { break }
154+
$probe = $parent
155+
}
126156
throw "Get-RepoRoot function not available. PathResolution module may not be loaded."
127157
}
128158

‎scripts/lib/metrics/CodeMetrics.psm1‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -424,11 +424,12 @@ function Get-CodeMetrics {
424424
$fileMetricsArray = ConvertTo-FileMetricsArray -InputList $fileMetrics
425425

426426
# Ensure fileMetricsArray is always an array, never null (defensive checks)
427+
# Prefer [object[]]::new(0) over @() — empty @() can unwrap to $null when assigned as a NoteProperty.
427428
if ($null -eq $fileMetricsArray) {
428-
$fileMetricsArray = @()
429+
$fileMetricsArray = [object[]]::new(0)
429430
}
430431
if (-not ($fileMetricsArray -is [System.Array])) {
431-
$fileMetricsArray = @()
432+
$fileMetricsArray = [object[]]::new(0)
432433
}
433434

434435
# Create result object (without FileMetrics first)
@@ -451,8 +452,8 @@ function Get-CodeMetrics {
451452
# Final verification: ensure FileMetrics is never null (defensive check)
452453
# Double-check that the property was set correctly
453454
if ($null -eq $result.FileMetrics) {
454-
# Last resort: remove and re-add the property
455-
$emptyArray = @()
455+
# Last resort: remove and re-add the property with a true empty array
456+
$emptyArray = [object[]]::new(0)
456457
if ($result.PSObject.Properties['FileMetrics']) {
457458
$result.PSObject.Properties.Remove('FileMetrics')
458459
}
@@ -461,7 +462,7 @@ function Get-CodeMetrics {
461462

462463
# One more safety check - verify the property exists and is not null
463464
if (-not $result.PSObject.Properties['FileMetrics'] -or $null -eq $result.PSObject.Properties['FileMetrics'].Value) {
464-
$emptyArray = @()
465+
$emptyArray = [object[]]::new(0)
465466
$result | Add-Member -MemberType NoteProperty -Name 'FileMetrics' -Value $emptyArray -Force
466467
}
467468

‎scripts/lib/runtime/NodeJs.psm1‎

Lines changed: 39 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,37 @@ scripts/lib/NodeJs.psm1
2626
The path to pnpm's global node_modules directory, or $null if not found.
2727
#>
2828
function Get-PnpmGlobalPath {
29-
# Use Validation module if available
30-
$useValidation = Get-Command Test-ValidPath -ErrorAction SilentlyContinue
29+
# Prefer core Get-Command so Pester mocks of Get-Command cannot break the Validation probe.
30+
$useValidation = $false
31+
try {
32+
$useValidation = $null -ne (Microsoft.PowerShell.Core\Get-Command -Name 'Test-ValidPath' -ErrorAction SilentlyContinue)
33+
}
34+
catch {
35+
$useValidation = $false
36+
}
37+
38+
# Local helper: Test-ValidPath when available, else Test-Path (never throw on missing helper).
39+
$testPathExists = {
40+
param([string]$Path, [string]$PathType = 'Any')
41+
if (-not $Path -or [string]::IsNullOrWhiteSpace($Path)) {
42+
return $false
43+
}
44+
if ($useValidation) {
45+
try {
46+
return [bool](Test-ValidPath -Path $Path -PathType $PathType)
47+
}
48+
catch {
49+
# Fall through to Test-Path
50+
}
51+
}
52+
if ($PathType -eq 'Directory') {
53+
return (Test-Path -LiteralPath $Path -PathType Container)
54+
}
55+
if ($PathType -eq 'File') {
56+
return (Test-Path -LiteralPath $Path -PathType Leaf)
57+
}
58+
return (Test-Path -LiteralPath $Path)
59+
}
3160

3261
# First, check common pnpm/Node.js-related environment variables (highest priority)
3362
$pnpmEnvVars = @('PNPM_HOME', 'PNPM_ROOT', 'NPM_CONFIG_PREFIX', 'NODE_PATH', 'NVM_DIR')
@@ -45,36 +74,18 @@ function Get-PnpmGlobalPath {
4574
# PNPM_HOME typically points to the pnpm installation directory
4675
# Check for global node_modules
4776
$testPath = Join-Path $envValue 'node_modules'
48-
$pathExists = if ($useValidation) {
49-
Test-ValidPath -Path $testPath -PathType Directory
50-
}
51-
else {
52-
$testPath -and -not [string]::IsNullOrWhiteSpace($testPath) -and (Test-Path -LiteralPath $testPath)
53-
}
54-
if ($pathExists) {
77+
if (& $testPathExists -Path $testPath -PathType Directory) {
5578
return $testPath
5679
}
5780
# Also check if the value itself is a node_modules path
58-
$pathExists = if ($useValidation) {
59-
Test-ValidPath -Path $envValue -PathType Directory
60-
}
61-
else {
62-
$envValue -and -not [string]::IsNullOrWhiteSpace($envValue) -and (Test-Path -LiteralPath $envValue)
63-
}
64-
if ($pathExists -and $envValue -like '*node_modules*') {
81+
if ((& $testPathExists -Path $envValue -PathType Directory) -and ($envValue -like '*node_modules*')) {
6582
return $envValue
6683
}
6784
}
6885
# For NPM_CONFIG_PREFIX - this points to npm global installation
6986
elseif ($envVar -eq 'NPM_CONFIG_PREFIX') {
7087
$testPath = Join-Path $envValue 'node_modules'
71-
$pathExists = if ($useValidation) {
72-
Test-ValidPath -Path $testPath -PathType Directory
73-
}
74-
else {
75-
$testPath -and -not [string]::IsNullOrWhiteSpace($testPath) -and (Test-Path -LiteralPath $testPath)
76-
}
77-
if ($pathExists) {
88+
if (& $testPathExists -Path $testPath -PathType Directory) {
7889
return $testPath
7990
}
8091
}
@@ -83,13 +94,7 @@ function Get-PnpmGlobalPath {
8394
$paths = $envValue -split ([System.IO.Path]::PathSeparator)
8495
foreach ($path in $paths) {
8596
if ($path -and -not [string]::IsNullOrWhiteSpace($path)) {
86-
$pathExists = if ($useValidation) {
87-
Test-ValidPath -Path $path -PathType Directory
88-
}
89-
else {
90-
$path -and -not [string]::IsNullOrWhiteSpace($path) -and (Test-Path -LiteralPath $path)
91-
}
92-
if ($pathExists) {
97+
if (& $testPathExists -Path $path -PathType Directory) {
9398
return $path
9499
}
95100
}
@@ -99,24 +104,12 @@ function Get-PnpmGlobalPath {
99104
elseif ($envVar -eq 'NVM_DIR') {
100105
# nvm typically has versions in versions/node directory
101106
$testPath = Join-Path $envValue 'versions' 'node'
102-
$pathExists = if ($useValidation) {
103-
Test-ValidPath -Path $testPath -PathType Directory
104-
}
105-
else {
106-
$testPath -and -not [string]::IsNullOrWhiteSpace($testPath) -and (Test-Path -LiteralPath $testPath)
107-
}
108-
if ($pathExists) {
107+
if (& $testPathExists -Path $testPath -PathType Directory) {
109108
# Return the first version's node_modules if available
110109
$versions = Get-ChildItem -Path $testPath -Directory -ErrorAction SilentlyContinue | Sort-Object Name -Descending
111110
if ($versions) {
112111
$latestVersionPath = Join-Path $versions[0].FullName 'lib' 'node_modules'
113-
$latestExists = if ($useValidation) {
114-
Test-ValidPath -Path $latestVersionPath -PathType Directory
115-
}
116-
else {
117-
$latestVersionPath -and -not [string]::IsNullOrWhiteSpace($latestVersionPath) -and (Test-Path -LiteralPath $latestVersionPath)
118-
}
119-
if ($latestExists) {
112+
if (& $testPathExists -Path $latestVersionPath -PathType Directory) {
120113
return $latestVersionPath
121114
}
122115
}
@@ -143,16 +136,8 @@ function Get-PnpmGlobalPath {
143136
if ($pnpmRoot) {
144137
$pnpmGlobalPath = $pnpmRoot.ToString().Trim()
145138
# Validate that the path exists
146-
if ($useValidation) {
147-
if (Test-ValidPath -Path $pnpmGlobalPath -PathType Directory) {
148-
return $pnpmGlobalPath
149-
}
150-
}
151-
else {
152-
# Fallback to manual validation
153-
if ($pnpmGlobalPath -and -not [string]::IsNullOrWhiteSpace($pnpmGlobalPath) -and (Test-Path -LiteralPath $pnpmGlobalPath)) {
154-
return $pnpmGlobalPath
155-
}
139+
if (& $testPathExists -Path $pnpmGlobalPath -PathType Directory) {
140+
return $pnpmGlobalPath
156141
}
157142
}
158143
}

‎scripts/utils/code-quality/run-pester.ps1‎

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -886,37 +886,39 @@ $global:ConfirmPreference = 'None'
886886
# Initialize output utilities
887887
Initialize-OutputUtils -RepoRoot $repoRoot
888888

889-
# Ensure Pester 5+ is available and imported
889+
# Ensure Pester 5.x is available and imported (Pester 6+ breaks CodeCoverage tracer teardown
890+
# when profile fragments install PostCommandLookupAction, and changes Mock ParameterFilter semantics).
891+
# Do NOT call Ensure-ModuleAvailable for Pester — Install-RequiredModule has no MaximumVersion and
892+
# may install Pester 6+. Install/import only the 5.x range explicitly.
890893
Write-Host "Checking Pester availability..." -ForegroundColor Yellow
891894
$requiredPesterVersion = [version]'5.0.0'
895+
$maxPesterVersion = [version]'5.99.99'
892896

893-
try {
894-
Ensure-ModuleAvailable -ModuleName 'Pester'
895-
}
896-
catch {
897-
Write-Host "Failed to ensure Pester is available: $_" -ForegroundColor Red
898-
Exit-WithCode -ExitCode $EXIT_SETUP_ERROR -ErrorRecord $_
899-
}
900-
901-
$installedPester = Get-Module -ListAvailable -Name 'Pester' | Sort-Object Version -Descending | Select-Object -First 1
902-
if (-not $installedPester -or $installedPester.Version -lt $requiredPesterVersion) {
897+
$installedPester = Get-Module -ListAvailable -Name 'Pester' |
898+
Where-Object { $_.Version -ge $requiredPesterVersion -and $_.Version -le $maxPesterVersion } |
899+
Sort-Object Version -Descending |
900+
Select-Object -First 1
901+
if (-not $installedPester) {
903902
try {
904-
Write-ScriptMessage -Message "Installing Pester $requiredPesterVersion or newer"
905-
Install-RequiredModule -ModuleName 'Pester' -Scope 'CurrentUser' -Force
906-
$installedPester = Get-Module -ListAvailable -Name 'Pester' | Sort-Object Version -Descending | Select-Object -First 1
903+
Write-ScriptMessage -Message "Installing Pester $requiredPesterVersion (maximum $maxPesterVersion)"
904+
Install-Module -Name 'Pester' -MinimumVersion $requiredPesterVersion -MaximumVersion $maxPesterVersion -Scope 'CurrentUser' -Force -AllowClobber -ErrorAction Stop
905+
$installedPester = Get-Module -ListAvailable -Name 'Pester' |
906+
Where-Object { $_.Version -ge $requiredPesterVersion -and $_.Version -le $maxPesterVersion } |
907+
Sort-Object Version -Descending |
908+
Select-Object -First 1
907909
}
908910
catch {
909911
Exit-WithCleanup -ExitCode $EXIT_SETUP_ERROR -ErrorRecord $_
910912
}
911913
}
912914

913-
if (-not $installedPester -or $installedPester.Version -lt $requiredPesterVersion) {
914-
$message = "Pester $requiredPesterVersion or newer is required but could not be installed."
915+
if (-not $installedPester) {
916+
$message = "Pester $requiredPesterVersion–$maxPesterVersion is required but could not be installed."
915917
Exit-WithCleanup -ExitCode $EXIT_SETUP_ERROR -Message $message
916918
}
917919

918920
try {
919-
Import-Module -Name 'Pester' -MinimumVersion $requiredPesterVersion -Force -ErrorAction Stop
921+
Import-Module -Name 'Pester' -RequiredVersion $installedPester.Version -Force -ErrorAction Stop
920922
}
921923
catch {
922924
Exit-WithCode -ExitCode $EXIT_SETUP_ERROR -ErrorRecord $_

‎tests/TestSupport/TestSupportCoreFunctions.ps1‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,6 @@ function Clear-CommandTestStubs {
327327
'Get-NodePackageInstallRecommendation'
328328
'Get-Platform'
329329
'Import-Requirements'
330-
'Get-RepoRoot'
331330
'CommandFailureProbe'
332331
'Import-ModuleSafely'
333332
'Test-FailingCommand'

‎tests/integration/profile/quality.tests.ps1‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -9,29 +9,20 @@ tests/integration/profile/quality.tests.ps1
99
Describe 'Profile Quality Integration Tests' {
1010
BeforeAll {
1111
try {
12-
$script:ProfilePath = Get-TestPath -RelativePath 'Microsoft.PowerShell_profile.ps1' -StartPath $PSScriptRoot -EnsureExists
13-
$script:ProfileDir = Get-TestPath -RelativePath 'profile.d' -StartPath $PSScriptRoot -EnsureExists
14-
if ($null -eq $script:ProfilePath -or [string]::IsNullOrWhiteSpace($script:ProfilePath)) {
15-
throw "Get-TestPath returned null or empty value for ProfilePath"
16-
}
17-
if ($null -eq $script:ProfileDir -or [string]::IsNullOrWhiteSpace($script:ProfileDir)) {
18-
throw "Get-TestPath returned null or empty value for ProfileDir"
19-
}
20-
if (-not (Test-Path -LiteralPath $script:ProfilePath)) {
21-
throw "Profile file not found at: $script:ProfilePath"
22-
}
23-
if (-not (Test-Path -LiteralPath $script:ProfileDir)) {
24-
throw "Profile directory not found at: $script:ProfileDir"
25-
}
26-
}
27-
catch {
28-
$errorDetails = @{
29-
Message = $_.Exception.Message
30-
Type = $_.Exception.GetType().FullName
31-
Location = $_.InvocationInfo.ScriptLineNumber
12+
$script:ProfilePath = Get-TestPath -RelativePath 'Microsoft.PowerShell_profile.ps1' -StartPath $PSScriptRoot -EnsureExists
13+
$script:ProfileDir = Get-TestPath -RelativePath 'profile.d' -StartPath $PSScriptRoot -EnsureExists
14+
if ($null -eq $script:ProfilePath -or [string]::IsNullOrWhiteSpace($script:ProfilePath)) {
15+
throw "Get-TestPath returned null or empty value for ProfilePath"
16+
}
17+
if ($null -eq $script:ProfileDir -or [string]::IsNullOrWhiteSpace($script:ProfileDir)) {
18+
throw "Get-TestPath returned null or empty value for ProfileDir"
19+
}
20+
if (-not (Test-Path -LiteralPath $script:ProfilePath)) {
21+
throw "Profile file not found at: $script:ProfilePath"
22+
}
23+
if (-not (Test-Path -LiteralPath $script:ProfileDir)) {
24+
throw "Profile directory not found at: $script:ProfileDir"
3225
}
33-
Write-Error "Failed to initialize profile quality tests in BeforeAll: $($errorDetails | ConvertTo-Json -Compress)" -ErrorAction Stop
34-
throw
3526

3627
$bootstrapPath = Join-Path $script:ProfileDir 'bootstrap.ps1'
3728
if (-not (Test-Path -LiteralPath $bootstrapPath)) {
@@ -45,6 +36,15 @@ Describe 'Profile Quality Integration Tests' {
4536
}
4637
$null = . $script:UtilitiesEnvPath
4738
}
39+
catch {
40+
$errorDetails = @{
41+
Message = $_.Exception.Message
42+
Type = $_.Exception.GetType().FullName
43+
Location = $_.InvocationInfo.ScriptLineNumber
44+
}
45+
Write-Error "Failed to initialize profile quality tests in BeforeAll: $($errorDetails | ConvertTo-Json -Compress)" -ErrorAction Stop
46+
throw
47+
}
4848
}
4949

5050
Context 'Cross-platform compatibility' {

‎tests/integration/terminal/starship.tests.ps1‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,12 @@ Describe "Starship Module Tests" {
8181
}
8282

8383
It "Returns true when prompt function contains starship" {
84-
function prompt { & starship prompt }
84+
Set-Item -Path Function:\global:prompt -Value { & starship prompt } -Force
85+
$promptCmd = Get-Command prompt -CommandType Function -ErrorAction SilentlyContinue
86+
if (-not $promptCmd -or ($promptCmd.ScriptBlock.ToString() -notmatch 'starship')) {
87+
Set-ItResult -Skipped -Because 'Could not install a starship-containing prompt function in this session'
88+
return
89+
}
8590
Test-StarshipInitialized | Should -Be $true
8691
}
8792
}

0 commit comments

Comments
 (0)