mirror of
https://github.com/helmfile/helmfile.git
synced 2026-09-30 23:08:48 +02:00
KUOKA Yusuke
4f83e69bf6
* Various U/X improvements for `helmfile apply` This improves the U/X of `helmfile apply`, by allowing you to selectively apply sub-helmfiles. When you have two or more sub-helmfiles processed, typing `n` to cancel the first doesn't automatically stop the whole helmfile execution. Instead, it proceeds by diffing the next sub-helmfile, and asks you to apply it, which should be what the user would expect. To support this workflow, I have suppressed useless exec logs, correct exit status when diff exists in sub-helmfiles but not in the parent helmfile, and made the final error message emitted by helmfile better. More concretely, this moves more output from `helm` to STDERR and the `debug` log-level. The overall output from `helmfile` should be a bit more cleaner especially for `apply`, `sync`, `diff` and perhaps other `helmfile` sub-commands, too. For example, when one of release failed, `helmfile`'s final error message now includes the error message from the failed `helm` execution, like seen in the last line: ``` List of updated releases : RELEASE CHART VERSION envoy stable/envoy 1.5.0 List of releases in error : RELEASE envoy2 in ./helmfile.yaml: in .helmfiles[0]: in /Users/c-ykuoka/helmfile/helmfile.1.yaml: failed processing release envoy2: helm exited with status 1: Error: UPGRADE FAILED: "envoy2" has no deployed releases ``` This way you can better understand what caused helmfile to finally fail. `helmfile` has been streaminig a lot of stdout and stderr contents from the `helm` commands regardless of the helmfile's log-level. It has been suppressed by default and moved to the `debug` log-level. You will see that it helps you focus on what was the cause of a failure. While working on the above, I found an another bug that made `--detailed-exitcode` useless in some case. That is, `helmfile diff --detailed-exitcode`, when any diff existed only in sub-helmfiles, has been returning an exit code of `1`. It should return `2` when any release had diff and no release had an error, regardless of the target is a sub-helmfile or a parent helmfile. Why? Because that's what `--detailed-exitcode` meant for! After this PR gets merged, `helmfile diff --detailed-exitcode` propery return exit code `2` in such cases. Fixes #543 Resolves #540
100 lines
2.4 KiB
Go
100 lines
2.4 KiB
Go
package helmexec
|
|
|
|
import (
|
|
"bytes"
|
|
"errors"
|
|
"fmt"
|
|
"go.uber.org/zap"
|
|
"os"
|
|
"os/exec"
|
|
"strings"
|
|
"syscall"
|
|
)
|
|
|
|
const (
|
|
tmpPrefix = "helmfile-"
|
|
tmpSuffix = "-exec"
|
|
)
|
|
|
|
// Runner interface for shell commands
|
|
type Runner interface {
|
|
Execute(cmd string, args []string, env map[string]string) ([]byte, error)
|
|
}
|
|
|
|
// ShellRunner implemention for shell commands
|
|
type ShellRunner struct {
|
|
Dir string
|
|
|
|
logger *zap.SugaredLogger
|
|
}
|
|
|
|
// Execute a shell command
|
|
func (shell ShellRunner) Execute(cmd string, args []string, env map[string]string) ([]byte, error) {
|
|
preparedCmd := exec.Command(cmd, args...)
|
|
preparedCmd.Dir = shell.Dir
|
|
preparedCmd.Env = mergeEnv(os.Environ(), env)
|
|
return combinedOutput(preparedCmd, shell.logger)
|
|
}
|
|
|
|
func combinedOutput(c *exec.Cmd, logger *zap.SugaredLogger) ([]byte, error) {
|
|
if c.Stdout != nil {
|
|
return nil, errors.New("exec: Stdout already set")
|
|
}
|
|
if c.Stderr != nil {
|
|
return nil, errors.New("exec: Stderr already set")
|
|
}
|
|
var stdout bytes.Buffer
|
|
var stderr bytes.Buffer
|
|
c.Stdout = &stdout
|
|
c.Stderr = &stderr
|
|
err := c.Run()
|
|
|
|
o := stdout.Bytes()
|
|
e := stderr.Bytes()
|
|
|
|
if err != nil {
|
|
// TrimSpace is necessary, because otherwise helmfile prints the redundant new-lines after each error like:
|
|
//
|
|
// err: release "envoy2" in "helmfile.yaml" failed: exit status 1: Error: could not find a ready tiller pod
|
|
// <redundant new line!>
|
|
// err: release "envoy" in "helmfile.yaml" failed: exit status 1: Error: could not find a ready tiller pod
|
|
switch ee := err.(type) {
|
|
case *exec.ExitError:
|
|
// Propagate any non-zero exit status from the external command, rather than throwing it away,
|
|
// so that helmfile could return its own exit code accordingly
|
|
waitStatus := ee.Sys().(syscall.WaitStatus)
|
|
exitStatus := waitStatus.ExitStatus()
|
|
err = newExitError(c.Path, exitStatus, string(e))
|
|
default:
|
|
panic(fmt.Sprintf("unexpected error: %v", err))
|
|
}
|
|
}
|
|
|
|
return o, err
|
|
}
|
|
|
|
func mergeEnv(orig []string, new map[string]string) []string {
|
|
wanted := env2map(orig)
|
|
for k, v := range new {
|
|
wanted[k] = v
|
|
}
|
|
return map2env(wanted)
|
|
}
|
|
|
|
func map2env(wanted map[string]string) []string {
|
|
result := []string{}
|
|
for k, v := range wanted {
|
|
result = append(result, k+"="+v)
|
|
}
|
|
return result
|
|
}
|
|
|
|
func env2map(env []string) map[string]string {
|
|
wanted := map[string]string{}
|
|
for _, cur := range env {
|
|
pair := strings.SplitN(cur, "=", 2)
|
|
wanted[pair[0]] = pair[1]
|
|
}
|
|
return wanted
|
|
}
|