Skip to content

Commit

Permalink
envtest: improve process cleanup
Browse files Browse the repository at this point in the history
When envtest creates new processes, it wasn't setting the process group
to the parent, when the main process is killed or it panics, all the
other processes are orphaned, and need to be killed separately.

In addition, if for some reason we can't shutdown a process cleanly, we
should try to SIGKILL before returning from Stop.

Signed-off-by: Vince Prignano <vincepri@redhat.com>
  • Loading branch information
vincepri committed Oct 23, 2023
1 parent 15d7928 commit e03cc2a
Show file tree
Hide file tree
Showing 3 changed files with 66 additions and 0 deletions.
28 changes: 28 additions & 0 deletions pkg/internal/testing/process/procattr_other.go
@@ -0,0 +1,28 @@
//go:build (!aix && !darwin && !dragonfly && !freebsd && !linux && !netbsd && !openbsd && !solaris && !zos) || !go1.9
// +build !aix,!darwin,!dragonfly,!freebsd,!linux,!netbsd,!openbsd,!solaris,!zos !go1.9

/*
Copyright 2016 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package process

import "syscall"

// getSysProcAttr returns the SysProcAttr to use for the process,
// for non-unix systems this returns nil.
func getSysProcAttr() *syscall.SysProcAttr {
return nil
}
34 changes: 34 additions & 0 deletions pkg/internal/testing/process/procattr_unix.go
@@ -0,0 +1,34 @@
//go:build (aix || darwin || dragonfly || freebsd || linux || netbsd || openbsd || solaris || zos) && go1.9
// +build aix darwin dragonfly freebsd linux netbsd openbsd solaris zos
// +build go1.9

/*
Copyright 2023 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package process

import (
"golang.org/x/sys/unix"
)

// getSysProcAttr returns the SysProcAttr to use for the process,
// for unix systems this returns a SysProcAttr with Setpgid set to true,
// which inherits the parent's process group id.
func getSysProcAttr() *unix.SysProcAttr {
return &unix.SysProcAttr{
Setpgid: true,
}
}
4 changes: 4 additions & 0 deletions pkg/internal/testing/process/process.go
Expand Up @@ -155,6 +155,7 @@ func (ps *State) Start(stdout, stderr io.Writer) (err error) {
ps.Cmd = exec.Command(ps.Path, ps.Args...)
ps.Cmd.Stdout = stdout
ps.Cmd.Stderr = stderr
ps.Cmd.SysProcAttr = getSysProcAttr()

ready := make(chan bool)
timedOut := time.After(ps.StartTimeout)
Expand Down Expand Up @@ -265,6 +266,9 @@ func (ps *State) Stop() error {
case <-ps.waitDone:
break
case <-timedOut:
if err := ps.Cmd.Process.Signal(syscall.SIGKILL); err != nil {
return fmt.Errorf("unable to kill process %s: %w", ps.Path, err)
}
return fmt.Errorf("timeout waiting for process %s to stop", path.Base(ps.Path))
}
ps.ready = false
Expand Down

0 comments on commit e03cc2a

Please sign in to comment.