Skip to content
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.

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

Fix podman version check #7010

Merged
Changes from all commits
Commits
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
96 changes: 31 additions & 65 deletions pkg/podman/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,8 @@ import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"os/exec"
"sync"
"time"

"k8s.io/klog"
Expand All @@ -34,85 +32,53 @@ func (o *PodmanCli) Version(ctx context.Context) (SystemVersionReport, error) {
// it is expected to return in a timely manner (hence this configurable timeout).
// This is to avoid situations like the one described in https://github.com/redhat-developer/odo/issues/6575
// (where a podman CLI that takes too long to respond affects the "odo dev" command, even if the user did not intend to use the Podman platform).
ctxWithTimeout, cancel := context.WithTimeout(ctx, o.podmanCmdInitTimeout)
defer cancel()

cmd := exec.CommandContext(ctxWithTimeout, o.podmanCmd, "version", "--format", "json")
cmd := exec.CommandContext(ctx, o.podmanCmd, "version", "--format", "json")
klog.V(3).Infof("executing %v", cmd.Args)

// Because cmd.Output() does not respect the context timeout (see https://github.com/golang/go/issues/57129),
// we are reading from the connected pipes instead.
stdoutPipe, err := cmd.StdoutPipe()
if err != nil {
return SystemVersionReport{}, err
}
stderrPipe, err := cmd.StderrPipe()
if err != nil {
return SystemVersionReport{}, err
}
outbuf, errbuf := new(bytes.Buffer), new(bytes.Buffer)
cmd.Stdout, cmd.Stderr = outbuf, errbuf

err = cmd.Start()
err := cmd.Start()
if err != nil {
return SystemVersionReport{}, err
}

var wg sync.WaitGroup
wg.Add(3)
// Use a channel to signal completion so we can use a select statement
done := make(chan error)
go func() { done <- cmd.Wait() }()

var result SystemVersionReport
go func() {
defer wg.Done()
// Reading from the pipe is a blocking call, hence this goroutine.
// The goroutine will exit after the pipe is closed or the command exits;
// these will be triggered by cmd.Wait() either after the timeout expires or the command finished.
err = json.NewDecoder(stdoutPipe).Decode(&result)
var timeoutErr error
select {
case <-time.After(o.podmanCmdInitTimeout):
err = cmd.Process.Kill()
if err != nil {
klog.V(3).Infof("unable to decode output: %v", err)
klog.V(3).Infof("unable to kill podman version process: %s", err)
}
}()

var stderr string
go func() {
defer wg.Done()
var buf bytes.Buffer
_, rErr := buf.ReadFrom(stderrPipe)
if rErr != nil {
klog.V(7).Infof("unable to read from stderr pipe: %v", rErr)
}
stderr = buf.String()
}()

var wErr error
go func() {
defer wg.Done()
// cmd.Wait() will block until the timeout expires or the program started by cmd exits.
// It will then close all resources associated with cmd,
// including the stdout and stderr pipes above, which will in turn terminate the goroutines spawned above.
wErr = cmd.Wait()
}()
timeoutErr = fmt.Errorf("timeout (%s) while waiting for Podman version", o.podmanCmdInitTimeout.Round(time.Second).String())
klog.V(3).Infof(timeoutErr.Error())

// Wait until all we are sure all previous goroutines are done
wg.Wait()
case err = <-done:
if err != nil {
klog.V(3).Infof("Non-zero exit code for podman version: %v", err)

if wErr != nil {
ctxErr := ctxWithTimeout.Err()
if ctxErr != nil {
msg := "error"
if errors.Is(ctxErr, context.DeadlineExceeded) {
msg = fmt.Sprintf("timeout (%s)", o.podmanCmdInitTimeout.Round(time.Second).String())
stderr := errbuf.String()
if len(stderr) > 0 {
klog.V(3).Infof("podman version stderr: %v", stderr)
}
wErr = fmt.Errorf("%s while waiting for Podman version: %s: %w", msg, ctxErr, wErr)
}
if exitErr, ok := wErr.(*exec.ExitError); ok {
wErr = fmt.Errorf("%s: %s", wErr, string(exitErr.Stderr))
}
if err != nil {
wErr = fmt.Errorf("%s: (%w)", wErr, err)

return SystemVersionReport{}, err
}
if stderr != "" {
wErr = fmt.Errorf("%w: %s", wErr, stderr)
}

var result SystemVersionReport
err = json.NewDecoder(outbuf).Decode(&result)
if err != nil {
klog.V(3).Infof("unable to decode output: %v", err)
if timeoutErr != nil {
return SystemVersionReport{}, timeoutErr
}
return SystemVersionReport{}, fmt.Errorf("%v. Please check the output of the following command: %v", wErr, cmd.Args)
return SystemVersionReport{}, err
rm3l marked this conversation as resolved.
Show resolved Hide resolved
}

return result, nil
Expand Down