Skip to content

Add -WhatIf switch to Start-Process cmdlet #4735

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 7 commits into from
Sep 8, 2017
Merged

Add -WhatIf switch to Start-Process cmdlet #4735

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3fa6423
Add -WhatIf switch to Start-Process cmdlet
Sep 1, 2017
326a924
Added a test to ensure that using a whatif switch prevents the action…
Sep 1, 2017
b2333fb
Incorporated code review comments
Sep 5, 2017
f73b26b
merged two tests into one as suggested
Sep 5, 2017
97d10e2
Included the error action at the end of the cmdlet
Sep 5, 2017
85a31ab
Remove extra space before `StringUtil` and new line
daxian-dbw Sep 6, 2017
ff9556c
Renamed the resource string id ProcessStartInfo to StartProcessTarget
Sep 7, 2017
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
5 changes: 4 additions & 1 deletion src/Microsoft.PowerShell.Commands.Management/commands/management/Process.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1658,7 +1658,7 @@ private string MapReturnCodeToErrorMessage(int returnCode)
/// <summary>
/// This class implements the Start-process command
/// </summary>
[Cmdlet(VerbsLifecycle.Start, "Process", DefaultParameterSetName = "Default", HelpUri = "https://go.microsoft.com/fwlink/?LinkID=135261")]
[Cmdlet(VerbsLifecycle.Start, "Process", DefaultParameterSetName = "Default", SupportsShouldProcess = true, HelpUri = "https://go.microsoft.com/fwlink/?LinkID=135261")]
[OutputType(typeof(Process))]
public sealed class StartProcessCommand : PSCmdlet, IDisposable
{
Expand Down Expand Up @@ -2051,6 +2051,9 @@ protected override void BeginProcessing()
startInfo.WindowStyle = _windowstyle;
}

string targetMessage = StringUtil.Format(ProcessResources.StartProcessTarget, startInfo.FileName, startInfo.Arguments.Trim());
if (!ShouldProcess(targetMessage)) { return; }

//Starts the Process
Process process = Start(startInfo);

Expand Down
3 changes: 3 additions & 0 deletions src/Microsoft.PowerShell.Commands.Management/resources/ProcessResources.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,9 @@
<data name="ProcessNameForConfirmation" xml:space="preserve">
<value>{0} ({1})</value>
</data>
<data name="StartProcessTarget" xml:space="preserve">
<value>{0} {1}</value>
</data>
<data name="CouldNotEnumerateModules" xml:space="preserve">
<value>Cannot enumerate the modules of the "{0}" process.</value>
</data>
Expand Down
10 changes: 10 additions & 0 deletions test/powershell/Modules/Microsoft.PowerShell.Management/Start-Process.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,16 @@ Describe "Start-Process" -Tags @("Feature") {
$process.Name | Should Be "notepad"
$process | Stop-Process
}

It "Should be able to use the -WhatIf switch without performing the actual action" {
$pingOutput = Join-Path $TestDrive "pingOutput.txt"
{ Start-Process -Wait $pingCommand -ArgumentList $pingParam -RedirectStandardOutput $pingOutput -WhatIf -ErrorAction Stop } | Should Not Throw
$pingOutput | Should Not Exist
}

It "Should return null when using -WhatIf switch with -PassThru" {
Start-Process $pingCommand -ArgumentList $pingParam -PassThru -WhatIf | Should Be $null
}
}

Describe "Start-Process tests requiring admin" -Tags "Feature","RequireAdminOnWindows" {
Expand Down