Skip to content

Updated background invocation & operator to use -WorkingDirectory when starting a new job #16180

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
daxian-dbw merged 7 commits into from
Feb 21, 2022
Merged

Updated background invocation & operator to use -WorkingDirectory when starting a new job #16180

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
412fffa
made background invocation operator use -WorkingDirectory to set work…
ayousuf23 Oct 14, 2021
7112fa1
added a test to make sure changing working directory also changes a b…
ayousuf23 Oct 23, 2021
8b1522a
Merge remote-tracking branch 'origin' into issue-10515
ayousuf23 Oct 25, 2021
9d4949d
fixed error when running background jobs
ayousuf23 Oct 28, 2021
e4ad408
updated variable names for background job tests
ayousuf23 Oct 29, 2021
84d5dad
added parameter names for arguments used for creating a new job
ayousuf23 Jan 10, 2022
5dc5651
Add a few new lines to break up the code
daxian-dbw Feb 2, 2022
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
31 changes: 19 additions & 12 deletions src/System.Management.Automation/engine/runtime/Operations/MiscOps.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -531,12 +531,8 @@ internal static void InvokePipelineInBackground(
var pipelineOffset = pipelineAst.Extent.StartOffset;
var variables = pipelineAst.FindAll(static x => x is VariableExpressionAst, true);

// Used to make sure that the job runs in the current directory
const string cmdPrefix = @"Microsoft.PowerShell.Management\Set-Location -LiteralPath $using:pwd ; ";

// Minimize allocations by initializing the stringbuilder to the size of the source string + prefix + space for ${using:} * 2
System.Text.StringBuilder updatedScriptblock = new System.Text.StringBuilder(cmdPrefix.Length + scriptblockBodyString.Length + 18);
updatedScriptblock.Append(cmdPrefix);
// Minimize allocations by initializing the stringbuilder to the size of the source string + space for ${using:} * 2
System.Text.StringBuilder updatedScriptblock = new System.Text.StringBuilder(scriptblockBodyString.Length + 18);
int position = 0;

// Prefix variables in the scriptblock with $using:
Expand Down Expand Up @@ -568,14 +564,25 @@ internal static void InvokePipelineInBackground(
var sb = ScriptBlock.Create(updatedScriptblock.ToString());
var commandInfo = new CmdletInfo("Start-Job", typeof(StartJobCommand));
commandProcessor = context.CommandDiscovery.LookupCommandProcessor(commandInfo, CommandOrigin.Internal, false, context.EngineSessionState);
var parameter = CommandParameterInternal.CreateParameterWithArgument(

var workingDirectoryParameter = CommandParameterInternal.CreateParameterWithArgument(
parameterAst: pipelineAst,
Copy link
Member

@anamnavi anamnavi Dec 10, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perhaps make all the arguments passed in named parameters then (i.e argumentName: argumentValue)

"ScriptBlock",
null,
parameterName: "WorkingDirectory",
parameterText: null,
argumentAst: pipelineAst,
sb,
false);
commandProcessor.AddParameter(parameter);
value: context.SessionState.Path.CurrentLocation.Path,
spaceAfterParameter: false);

var scriptBlockParameter = CommandParameterInternal.CreateParameterWithArgument(
parameterAst: pipelineAst,
parameterName: "ScriptBlock",
parameterText: null,
argumentAst: pipelineAst,
value: sb,
spaceAfterParameter: false);

commandProcessor.AddParameter(workingDirectoryParameter);
commandProcessor.AddParameter(scriptBlockParameter);
pipelineProcessor.Add(commandProcessor);
pipelineProcessor.LinkPipelineSuccessOutput(outputPipe ?? new Pipe(new List<object>()));

Expand Down
12 changes: 11 additions & 1 deletion test/powershell/Modules/Microsoft.PowerShell.Core/Job.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ Describe "Debug-job test" -Tag "Feature" {
}
}

Describe "Ampersand background test" -Tag "CI","Slow" {
Describe "Ampersand background test" -Tag "CI", "Slow" {
Context "Simple background job" {
AfterEach {
Get-Job | Remove-Job -Force
Expand Down Expand Up @@ -218,6 +218,16 @@ Describe "Ampersand background test" -Tag "CI","Slow" {
$j = Get-Location | ForEach-Object -MemberName Path &
Receive-Job -Wait $j | Should -Be ($PWD.Path)
}
It "Make sure Set-Location is not used in the job's script block to set the working directory" {
$j = (Get-Variable -Value ExecutionContext).SessionState.PSVariable.Get("MyInvocation").Value.MyCommand.ScriptBlock &
(Receive-Job -Wait $j).ToString() | Should -BeExactly "(Get-Variable -Value ExecutionContext).SessionState.PSVariable.Get(`"MyInvocation`").Value.MyCommand.ScriptBlock"
}
It "Test that changing working directory also changes background job's working directory" {
Set-Location ..
$WorkingDirectory = (Get-Location).ToString()
$BackgroundJob = (Get-Location &)
(Receive-Job -Wait $BackgroundJob).ToString() | Should -BeExactly $WorkingDirectory
}
It "Test that output redirection is done in the background job" {
$j = Write-Output hello > $TESTDRIVE/hello.txt &
Receive-Job -Wait $j | Should -BeNullOrEmpty
Expand Down