Skip to content

Fix -Debug to not trigger the ShouldProcess prompt #26081

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

Merged
iSazonov merged 2 commits into from
Sep 23, 2025
Merged

Fix -Debug to not trigger the ShouldProcess prompt #26081

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0c10a48
Fix `-Debug` to not trigger `ShouldProcess`
daxian-dbw Sep 22, 2025
eb934df
Add test
daxian-dbw Sep 22, 2025
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
12 changes: 5 additions & 7 deletions src/System.Management.Automation/engine/MshCommandRuntime.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2992,21 +2992,19 @@ internal ConfirmImpact ConfirmPreference
{
// WhatIf not relevant, it never gets this far in that case
if (Confirm)
return ConfirmImpact.Low;
if (Debug)
{
if (IsConfirmFlagSet) // -Debug -Confirm:$false
return ConfirmImpact.None;
return ConfirmImpact.Low;
}

if (IsConfirmFlagSet) // -Confirm:$false
if (IsConfirmFlagSet)
{
// -Confirm:$false
return ConfirmImpact.None;
}

if (!_isConfirmPreferenceCached)
{
bool defaultUsed = false;
_confirmPreference = Context.GetEnumPreference(SpecialVariables.ConfirmPreferenceVarPath, _confirmPreference, out defaultUsed);
_confirmPreference = Context.GetEnumPreference(SpecialVariables.ConfirmPreferenceVarPath, _confirmPreference, out _);
_isConfirmPreferenceCached = true;
}

Expand Down
40 changes: 40 additions & 0 deletions test/powershell/Modules/Microsoft.PowerShell.Utility/Write-Debug.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,44 @@ Describe "Write-Debug tests" -Tags "CI" {
$out = $p.StandardError.ReadToEnd()
$out | Should -BeNullOrEmpty
}

It "'-Debug' should not trigger 'ShouldProcess'" {
$pwsh = [PowerShell]::Create()
$pwsh.AddScript(@'
function Test-DebugWithConfirm
{
[CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = 'Low')]
Param ()

PROCESS
{
Write-Debug -Message "Debug_Message1"
If ($PSCmdlet.ShouldProcess('Doing the thing.','Proceed?','Ready to do the thing.'))
{
Write-Output 'success'
}
Write-Debug -Message "Debug_Message2"
}

END {}
}
'@)
$pwsh.Invoke()
$pwsh.Commands.Clear()
$pwsh.Streams.ClearStreams()

try {
$result = $pwsh.AddScript("Test-DebugWithConfirm -Debug").Invoke()
$result.Count | Should -BeExactly 1
$result[0] | Should -BeExactly 'success'

$pwsh.Streams.Error.Count | Should -BeExactly 0
$pwsh.Streams.Debug.Count | Should -BeExactly 2
$pwsh.Streams.Debug[0] | Should -BeExactly 'Debug_Message1'
$pwsh.Streams.Debug[1] | Should -BeExactly 'Debug_Message2'
}
finally {
$pwsh.Dispose()
}
}
}
Loading