Skip to content

Fix flaky Debug-Runspace attach event test #27885

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

Open
Travis Plunk (TravisEz13) wants to merge 3 commits into
base: master
Choose a base branch
from
+67 −25
Open

Fix flaky Debug-Runspace attach event test #27885

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a99bab0
Fix flaky Debug-Runspace attach event test
TravisEz13 Aug 25, 2026
8879d91
Tighten Debug-Runspace test cleanup
TravisEz13 Aug 25, 2026
fa30138
Warn when Debug-Runspace cleanup fails
TravisEz13 Aug 25, 2026
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
92 changes: 67 additions & 25 deletions test/powershell/Modules/Microsoft.PowerShell.Utility/Debug-Runspace.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,30 +34,72 @@ Describe "Debug-Runspace" -Tag "CI" {

It "Should write attach event and mark runspace as having a remote debugger attached" {
$onAttachName = [System.Management.Automation.PSEngineEvent]::OnDebugAttach

$debugTarget = [PowerShell]::Create()
$null = $debugTarget.AddCommand('Wait-Event').AddParameter('SourceIdentifier', $onAttachName)
$waitTask = $debugTarget.BeginInvoke()

$debugTarget.Runspace.IsRemoteDebuggerAttached | Should -BeFalse

$debugger = [PowerShell]::Create()
$null = $debugger.AddCommand('Debug-Runspace').AddParameter('Id', $debugTarget.Runspace.Id)
$debugTask = $debugger.BeginInvoke()

$waitTask.AsyncWaitHandle.WaitOne(5000) | Should -BeTrue
$waitInfo = $debugTarget.EndInvoke($waitTask)
$waitInfo.SourceIdentifier | Should -Be $onAttachName

$debugTarget.Runspace.IsRemoteDebuggerAttached | Should -BeTrue

$debugger.Stop()
$exp = {
$debugger.EndInvoke($debugTask)
} | Should -Throw -PassThru
$exp.FullyQualifiedErrorId | Should -Be "PipelineStoppedException"

$debugTarget.Runspace.IsRemoteDebuggerAttached | Should -BeFalse

$targetRunspace = $null
$debugTarget = $null
$debugger = $null
$debugTask = $null

try {
# Open the target runspace up front so that 'Debug-Runspace' can never observe it in a
# non-Opened state, and so that its event manager is guaranteed to exist when the
# OnDebugAttach event is generated.
$targetRunspace = [runspacefactory]::CreateRunspace()
$targetRunspace.Open()

$debugTarget = [PowerShell]::Create()
$debugTarget.Runspace = $targetRunspace
$null = $debugTarget.AddCommand('Wait-Event').AddParameter('SourceIdentifier', $onAttachName)
$waitTask = $debugTarget.BeginInvoke()

# 'BeginInvoke' only queues the work. Wait until the 'Wait-Event' pipeline is actually
# running in the target runspace before attaching the debugger, so the attach event is
# never generated against a runspace that has not started executing the waiter.
$ready = Wait-UntilTrue -IntervalInMilliseconds 20 -TimeoutInMilliseconds 5000 -sb {
$debugTarget.InvocationStateInfo.State -eq [System.Management.Automation.PSInvocationState]::Running -and
$targetRunspace.RunspaceAvailability -eq [System.Management.Automation.Runspaces.RunspaceAvailability]::Busy
}
$ready | Should -BeTrue -Because "the 'Wait-Event' pipeline should be running in the target runspace"

$targetRunspace.IsRemoteDebuggerAttached | Should -BeFalse

$debugger = [PowerShell]::Create()
$null = $debugger.AddCommand('Debug-Runspace').AddParameter('Id', $targetRunspace.Id)
$debugTask = $debugger.BeginInvoke()

$waitTask.AsyncWaitHandle.WaitOne(5000) | Should -BeTrue
$waitInfo = $debugTarget.EndInvoke($waitTask)
$waitInfo.SourceIdentifier | Should -Be $onAttachName

$targetRunspace.IsRemoteDebuggerAttached | Should -BeTrue

$debugger.Stop()
$exp = {
$debugger.EndInvoke($debugTask)
} | Should -Throw -PassThru
$exp.FullyQualifiedErrorId | Should -Be "PipelineStoppedException"

# 'IsRemoteDebuggerAttached' is reset by the cmdlet as it unwinds, which happens
# asynchronously with respect to 'Stop' completing.
$detached = Wait-UntilTrue -IntervalInMilliseconds 20 -TimeoutInMilliseconds 5000 -sb {
-not $targetRunspace.IsRemoteDebuggerAttached
}
$detached | Should -BeTrue

$targetRunspace.IsRemoteDebuggerAttached | Should -BeFalse
}
finally {
if ($debugger) {
try { $debugger.Stop() } catch { Write-Warning "Failed to stop the debugger during cleanup: $_" }
$debugger.Dispose()
}

if ($debugTarget) {
try { $debugTarget.Stop() } catch { Write-Warning "Failed to stop the debug target during cleanup: $_" }
$debugTarget.Dispose()
}

if ($targetRunspace) { $targetRunspace.Dispose() }
}
}
}

Loading