Skip to content

Fix: Orphaned process and goroutine leak in ScriptRun/CustomSync leading to split-brain deployments #6735

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
pulkitvats2007-crypto wants to merge 1 commit into
base: master
Choose a base branch
from
+93 −10
Open

Fix: Orphaned process and goroutine leak in ScriptRun/CustomSync leading to split-brain deployments #6735

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
10 changes: 7 additions & 3 deletions pkg/app/piped/executor/customsync/customsync.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
package customsync

import (
"context"
"os"
"os/exec"
"strings"
Expand Down Expand Up @@ -64,10 +65,12 @@ func (e *deployExecutor) Execute(sig executor.StopSignal) model.StageStatus {
e.appDir = ds.AppDir

timeout := e.StageConfig.CustomSyncOptions.Timeout.Duration()
ctx, cancel := context.WithCancel(sig.Context())
defer cancel()

c := make(chan model.StageStatus, 1)
go func() {
c <- e.executeCommand()
c <- e.executeCommand(ctx)
}()

timer := time.NewTimer(timeout)
Expand All @@ -94,7 +97,7 @@ func (e *deployExecutor) Execute(sig executor.StopSignal) model.StageStatus {
}
}

func (e *deployExecutor) executeCommand() model.StageStatus {
func (e *deployExecutor) executeCommand(ctx context.Context) model.StageStatus {
opts := e.StageConfig.CustomSyncOptions

e.LogPersister.Infof("Runnnig commands...")
Expand All @@ -109,7 +112,8 @@ func (e *deployExecutor) executeCommand() model.StageStatus {
envs = append(envs, key+"="+value)
}

cmd := exec.Command("/bin/sh", "-l", "-c", opts.Run)
cmd := exec.CommandContext(ctx, "/bin/sh", "-l", "-c", opts.Run)
cmd.WaitDelay = time.Second
cmd.Dir = e.appDir
cmd.Env = append(os.Environ(), envs...)
cmd.Stdout = e.LogPersister
Expand Down
7 changes: 4 additions & 3 deletions pkg/app/piped/executor/customsync/rollback.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,10 @@ func (e *rollbackExecutor) ensureRollback(ctx context.Context) model.StageStatus
}
e.LogPersister.Infof("Start rollback for custom sync")

return e.executeCommand(runningDS.GenericApplicationConfig.Pipeline.Stages[0])
return e.executeCommand(ctx, runningDS.GenericApplicationConfig.Pipeline.Stages[0])
}

func (e *rollbackExecutor) executeCommand(config config.PipelineStage) model.StageStatus {
func (e *rollbackExecutor) executeCommand(ctx context.Context, config config.PipelineStage) model.StageStatus {
opts := config.CustomSyncOptions

e.LogPersister.Infof("Runnnig commands...")
Expand All @@ -93,7 +93,8 @@ func (e *rollbackExecutor) executeCommand(config config.PipelineStage) model.Sta
envs = append(envs, key+"="+value)
}

cmd := exec.Command("/bin/sh", "-l", "-c", opts.Run)
cmd := exec.CommandContext(ctx, "/bin/sh", "-l", "-c", opts.Run)
cmd.WaitDelay = time.Second
cmd.Dir = e.appDir
cmd.Env = append(os.Environ(), envs...)
cmd.Stdout = e.LogPersister
Expand Down
3 changes: 2 additions & 1 deletion pkg/app/piped/executor/kubernetes/rollback.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,8 @@ func (e *rollbackExecutor) ensureScriptRunRollback(ctx context.Context) model.St
envs = append(envs, key+"="+value)
}

cmd := exec.Command("/bin/sh", "-l", "-c", onRollback)
cmd := exec.CommandContext(ctx, "/bin/sh", "-l", "-c", onRollback)
cmd.WaitDelay = time.Second
cmd.Dir = e.appDir
cmd.Env = append(os.Environ(), envs...)
cmd.Stdout = e.LogPersister
Expand Down
73 changes: 73 additions & 0 deletions pkg/app/piped/executor/scriptrun/execute_command_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
package scriptrun

import (
"context"
"fmt"
"os"
"testing"
"time"

"github.com/stretchr/testify/assert"

"github.com/pipe-cd/pipecd/pkg/app/piped/executor"
"github.com/pipe-cd/pipecd/pkg/config"
"github.com/pipe-cd/pipecd/pkg/model"
)

type fakeLogPersister struct{}

func (l *fakeLogPersister) Write(b []byte) (int, error) { fmt.Println(string(b)); return len(b), nil }
func (l *fakeLogPersister) Info(s string) { fmt.Println("INFO:", s) }
func (l *fakeLogPersister) Infof(s string, args ...interface{}) { fmt.Printf("INFO: "+s+"\n", args...) }
func (l *fakeLogPersister) Success(s string) { fmt.Println("SUCCESS:", s) }
func (l *fakeLogPersister) Successf(s string, args ...interface{}) { fmt.Printf("SUCCESS: "+s+"\n", args...) }
func (l *fakeLogPersister) Error(s string) { fmt.Println("ERROR:", s) }
func (l *fakeLogPersister) Errorf(s string, args ...interface{}) { fmt.Printf("ERROR: "+s+"\n", args...) }

func TestExecuteCommandCancellation(t *testing.T) {
// Ensure that executeCommand correctly stops when its context is canceled.
e := &Executor{
Input: executor.Input{
Deployment: &model.Deployment{
Id: "deploy-1",
Trigger: &model.DeploymentTrigger{
Commit: &model.Commit{
Hash: "hash-1",
},
},
GitPath: &model.ApplicationGitPath{
Repo: &model.ApplicationGitRepository{
Id: "repo-1",
Remote: "repo-url",
},
},
},
LogPersister: &fakeLogPersister{},
StageConfig: config.PipelineStage{
ScriptRunStageOptions: &config.ScriptRunStageOptions{
Run: "exec sleep 10",
},
},
},
appDir: os.TempDir(),
}

ctx, cancel := context.WithCancel(context.Background())

// Run command in a goroutine
done := make(chan model.StageStatus)
go func() {
done <- e.executeCommand(ctx)
}()

// Cancel almost immediately
time.Sleep(100 * time.Millisecond)
cancel()

select {
case status := <-done:
assert.Equal(t, model.StageStatus_STAGE_FAILURE, status, "Expected command to fail on cancellation")
case <-time.After(2 * time.Second):
t.Fatal("executeCommand did not return after context cancellation")
}
}
10 changes: 7 additions & 3 deletions pkg/app/piped/executor/scriptrun/scriptrun.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
package scriptrun

import (
"context"
"encoding/json"
"os"
"os/exec"
Expand Down Expand Up @@ -59,10 +60,12 @@ func (e *Executor) Execute(sig executor.StopSignal) model.StageStatus {
e.appDir = ds.AppDir

timeout := e.StageConfig.ScriptRunStageOptions.Timeout.Duration()
ctx, cancel := context.WithCancel(sig.Context())
defer cancel()

c := make(chan model.StageStatus, 1)
go func() {
c <- e.executeCommand()
c <- e.executeCommand(ctx)
}()

timer := time.NewTimer(timeout)
Expand Down Expand Up @@ -92,7 +95,7 @@ func (e *Executor) Execute(sig executor.StopSignal) model.StageStatus {
}
}

func (e *Executor) executeCommand() model.StageStatus {
func (e *Executor) executeCommand(ctx context.Context) model.StageStatus {
opts := e.StageConfig.ScriptRunStageOptions

e.LogPersister.Infof("Runnnig commands...")
Expand All @@ -118,7 +121,8 @@ func (e *Executor) executeCommand() model.StageStatus {
envs = append(envs, key+"="+value)
}

cmd := exec.Command("/bin/sh", "-l", "-c", opts.Run)
cmd := exec.CommandContext(ctx, "/bin/sh", "-l", "-c", opts.Run)
cmd.WaitDelay = time.Second
cmd.Dir = e.appDir
cmd.Env = append(os.Environ(), envs...)
cmd.Stdout = e.LogPersister
Expand Down
Loading