Skip to content

Avoid race-conditions while executing sub-commands #1201

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
andrewnester merged 1 commit into from
Feb 12, 2024
Merged

Avoid race-conditions while executing sub-commands #1201

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 16 additions & 14 deletions libs/exec/exec.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,18 +90,25 @@ func NewCommandExecutorWithExecutable(dir string, execType ExecutableType) (*Exe
}, nil
}

func (e *Executor) StartCommand(ctx context.Context, command string) (Command, error) {
func (e *Executor) prepareCommand(ctx context.Context, command string) (*osexec.Cmd, *execContext, error) {
ec, err := e.shell.prepare(command)
if err != nil {
return nil, err
return nil, nil, err
}
return e.start(ctx, ec)
}

func (e *Executor) start(ctx context.Context, ec *execContext) (Command, error) {
cmd := osexec.CommandContext(ctx, ec.executable, ec.args...)
cmd.Dir = e.dir
return cmd, ec, nil
}

func (e *Executor) StartCommand(ctx context.Context, command string) (Command, error) {
cmd, ec, err := e.prepareCommand(ctx, command)
if err != nil {
return nil, err
}
return e.start(ctx, cmd, ec)
}

func (e *Executor) start(ctx context.Context, cmd *osexec.Cmd, ec *execContext) (Command, error) {
stdout, err := cmd.StdoutPipe()
if err != nil {
return nil, err
Expand All @@ -116,17 +123,12 @@ func (e *Executor) start(ctx context.Context, ec *execContext) (Command, error)
}

func (e *Executor) Exec(ctx context.Context, command string) ([]byte, error) {
cmd, err := e.StartCommand(ctx, command)
if err != nil {
return nil, err
}

res, err := io.ReadAll(io.MultiReader(cmd.Stdout(), cmd.Stderr()))
cmd, ec, err := e.prepareCommand(ctx, command)
if err != nil {
return nil, err
}

return res, cmd.Wait()
defer os.Remove(ec.scriptFile)
return cmd.CombinedOutput()
}

func (e *Executor) ShellType() ExecutableType {
Expand Down
15 changes: 12 additions & 3 deletions libs/exec/exec_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,15 @@ func TestExecutorWithComplexInput(t *testing.T) {
assert.Equal(t, "Hello\nWorld\n", string(out))
}

func TestExecutorWithStderr(t *testing.T) {
executor, err := NewCommandExecutor(".")
assert.NoError(t, err)
out, err := executor.Exec(context.Background(), "echo 'Hello' && >&2 echo 'Error'")
assert.NoError(t, err)
assert.NotNil(t, out)
assert.Equal(t, "Hello\nError\n", string(out))
}

func TestExecutorWithInvalidCommand(t *testing.T) {
executor, err := NewCommandExecutor(".")
assert.NoError(t, err)
Expand Down Expand Up @@ -108,16 +117,16 @@ func TestExecutorCleanupsTempFiles(t *testing.T) {
executor, err := NewCommandExecutor(".")
assert.NoError(t, err)

ec, err := executor.shell.prepare("echo 'Hello'")
cmd, ec, err := executor.prepareCommand(context.Background(), "echo 'Hello'")
assert.NoError(t, err)

cmd, err := executor.start(context.Background(), ec)
command, err := executor.start(context.Background(), cmd, ec)
assert.NoError(t, err)

fileName := ec.args[1]
assert.FileExists(t, fileName)

err = cmd.Wait()
err = command.Wait()
assert.NoError(t, err)
assert.NoFileExists(t, fileName)
}
Expand Down