package helmexec import ( "bytes" "fmt" "io" "io/ioutil" "os" "path/filepath" "strconv" "strings" "sync" "github.com/Masterminds/semver/v3" "go.uber.org/zap" "go.uber.org/zap/zapcore" ) type decryptedSecret struct { mutex sync.RWMutex bytes []byte err error } type execer struct { helmBinary string version semver.Version runner Runner logger *zap.SugaredLogger kubeContext string extra []string decryptedSecretMutex sync.Mutex decryptedSecrets map[string]*decryptedSecret writeTempFile func([]byte) (string, error) } func NewLogger(writer io.Writer, logLevel string) *zap.SugaredLogger { var cfg zapcore.EncoderConfig cfg.MessageKey = "message" out := zapcore.AddSync(writer) var level zapcore.Level err := level.Set(logLevel) if err != nil { panic(err) } core := zapcore.NewCore( zapcore.NewConsoleEncoder(cfg), out, level, ) return zap.New(core).Sugar() } func parseHelmVersion(versionStr string) (semver.Version, error) { if len(versionStr) == 0 { return semver.Version{}, nil } versionStr = strings.TrimLeft(versionStr, "Client: ") versionStr = strings.TrimRight(versionStr, "\n") ver, err := semver.NewVersion(versionStr) if err != nil { return semver.Version{}, fmt.Errorf("error parsing helm version '%s'", versionStr) } // Support explicit helm3 opt-in via environment variable if os.Getenv("HELMFILE_HELM3") != "" && ver.Major() < 3 { return *semver.MustParse("v3.0.0"), nil } return *ver, nil } func getHelmVersion(helmBinary string, runner Runner) (semver.Version, error) { // Autodetect from `helm version` outBytes, err := runner.Execute(helmBinary, []string{"version", "--client", "--short"}, nil) if err != nil { return semver.Version{}, fmt.Errorf("error determining helm version: %w", err) } return parseHelmVersion(string(outBytes)) } // New for running helm commands func New(helmBinary string, logger *zap.SugaredLogger, kubeContext string, runner Runner) *execer { // TODO: proper error handling version, err := getHelmVersion(helmBinary, runner) if err != nil { panic(err) } return &execer{ helmBinary: helmBinary, version: version, logger: logger, kubeContext: kubeContext, runner: runner, decryptedSecrets: make(map[string]*decryptedSecret), } } func (helm *execer) SetExtraArgs(args ...string) { helm.extra = args } func (helm *execer) SetHelmBinary(bin string) { helm.helmBinary = bin } func (helm *execer) AddRepo(name, repository, cafile, certfile, keyfile, username, password string, managed string) error { var args []string var out []byte var err error if name == "" && repository != "" { helm.logger.Infof("empty field name\n") return fmt.Errorf("empty field name") } switch managed { case "acr": helm.logger.Infof("Adding repo %v (acr)", name) out, err = helm.azcli(name) case "": args = append(args, "repo", "add", name, repository) // See https://github.com/helm/helm/pull/8777 if cons, err := semver.NewConstraint(">= 3.3.2"); err == nil { if cons.Check(&helm.version) { args = append(args, "--force-update") } } else { panic(err) } if certfile != "" && keyfile != "" { args = append(args, "--cert-file", certfile, "--key-file", keyfile) } if cafile != "" { args = append(args, "--ca-file", cafile) } if username != "" && password != "" { args = append(args, "--username", username, "--password", password) } helm.logger.Infof("Adding repo %v %v", name, repository) out, err = helm.exec(args, map[string]string{}) default: helm.logger.Errorf("ERROR: unknown type '%v' for repository %v", managed, name) out = nil err = nil } helm.info(out) return err } func (helm *execer) UpdateRepo() error { helm.logger.Info("Updating repo") out, err := helm.exec([]string{"repo", "update"}, map[string]string{}) helm.info(out) return err } func (helm *execer) RegistryLogin(repository string, username string, password string) error { helm.logger.Info("Logging in to registry") args := []string{ "registry", "login", repository, "--username", username, "--password-stdin", } buffer := bytes.Buffer{} buffer.Write([]byte(fmt.Sprintf("%s\n", password))) out, err := helm.execStdIn(args, map[string]string{"HELM_EXPERIMENTAL_OCI": "1"}, &buffer) helm.info(out) return err } func (helm *execer) BuildDeps(name, chart string) error { helm.logger.Infof("Building dependency release=%v, chart=%v", name, chart) out, err := helm.exec([]string{"dependency", "build", chart}, map[string]string{}) helm.info(out) return err } func (helm *execer) UpdateDeps(chart string) error { helm.logger.Infof("Updating dependency %v", chart) out, err := helm.exec([]string{"dependency", "update", chart}, map[string]string{}) helm.info(out) return err } func (helm *execer) SyncRelease(context HelmContext, name, chart string, flags ...string) error { helm.logger.Infof("Upgrading release=%v, chart=%v", name, chart) preArgs := context.GetTillerlessArgs(helm) env := context.getTillerlessEnv() if helm.IsHelm3() { flags = append(flags, "--history-max", strconv.Itoa(context.HistoryMax)) } else { env["HELM_TILLER_HISTORY_MAX"] = strconv.Itoa(context.HistoryMax) } out, err := helm.exec(append(append(preArgs, "upgrade", "--install", "--reset-values", name, chart), flags...), env) helm.write(nil, out) return err } func (helm *execer) ReleaseStatus(context HelmContext, name string, flags ...string) error { helm.logger.Infof("Getting status %v", name) preArgs := context.GetTillerlessArgs(helm) env := context.getTillerlessEnv() out, err := helm.exec(append(append(preArgs, "status", name), flags...), env) helm.write(nil, out) return err } func (helm *execer) List(context HelmContext, filter string, flags ...string) (string, error) { helm.logger.Infof("Listing releases matching %v", filter) preArgs := context.GetTillerlessArgs(helm) env := context.getTillerlessEnv() var args []string if helm.IsHelm3() { args = []string{"list", "--filter", filter} } else { args = []string{"list", filter} } out, err := helm.exec(append(append(preArgs, args...), flags...), env) // In v2 we have been expecting `helm list FILTER` prints nothing. // In v3 helm still prints the header like `NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION`, // which confuses helmfile's existing logic that treats any non-empty output from `helm list` is considered as the indication // of the release to exist. // // This fixes it by removing the header from the v3 output, so that the output is formatted the same as that of v2. if helm.IsHelm3() { lines := strings.Split(string(out), "\n") lines = lines[1:] out = []byte(strings.Join(lines, "\n")) } helm.write(nil, out) return string(out), err } func (helm *execer) DecryptSecret(context HelmContext, name string, flags ...string) (string, error) { absPath, err := filepath.Abs(name) if err != nil { return "", err } helm.logger.Debugf("Preparing to decrypt secret %v", absPath) helm.decryptedSecretMutex.Lock() secret, ok := helm.decryptedSecrets[absPath] // Cache miss if !ok { secret = &decryptedSecret{} helm.decryptedSecrets[absPath] = secret secret.mutex.Lock() defer secret.mutex.Unlock() helm.decryptedSecretMutex.Unlock() helm.logger.Infof("Decrypting secret %v", absPath) preArgs := context.GetTillerlessArgs(helm) env := context.getTillerlessEnv() out, err := helm.exec(append(append(preArgs, "secrets", "dec", absPath), flags...), env) helm.info(out) if err != nil { secret.err = err return "", err } // HELM_SECRETS_DEC_SUFFIX is used by the helm-secrets plugin to define the output file decSuffix := os.Getenv("HELM_SECRETS_DEC_SUFFIX") if len(decSuffix) == 0 { decSuffix = ".yaml.dec" } decFilename := strings.Replace(absPath, ".yaml", decSuffix, 1) secretBytes, err := ioutil.ReadFile(decFilename) if err != nil { secret.err = err return "", err } secret.bytes = secretBytes if err := os.Remove(decFilename); err != nil { return "", err } } else { // Cache hit helm.logger.Debugf("Found secret in cache %v", absPath) secret.mutex.RLock() helm.decryptedSecretMutex.Unlock() defer secret.mutex.RUnlock() if secret.err != nil { return "", secret.err } } tempFile := helm.writeTempFile if tempFile == nil { tempFile = func(content []byte) (string, error) { tmpFile, err := ioutil.TempFile("", "secret") if err != nil { return "", err } _, err = tmpFile.Write(content) if err != nil { return "", err } return tmpFile.Name(), nil } } tmpFileName, err := tempFile(secret.bytes) if err != nil { return "", err } helm.logger.Debugf("Decrypted %s into %s", absPath, tmpFileName) return tmpFileName, err } func (helm *execer) TemplateRelease(name string, chart string, flags ...string) error { helm.logger.Infof("Templating release=%v, chart=%v", name, chart) var args []string if helm.IsHelm3() { args = []string{"template", name, chart} } else { args = []string{"template", chart, "--name", name} } out, err := helm.exec(append(args, flags...), map[string]string{}) var outputToFile bool for _, f := range flags { if strings.HasPrefix("--output-dir", f) { outputToFile = true break } } if outputToFile { // With --output-dir is passed to helm-template, // we can safely direct all the logs from it to our logger. // // It's safe because anything written to stdout by helm-template with output-dir is logs, // like excessive `wrote path/to/output/dir/chart/template/file.yaml` messages, // but manifets. // // See https://github.com/roboll/helmfile/pull/1691#issuecomment-805636021 for more information. helm.info(out) } else { // Always write to stdout for use with e.g. `helmfile template | kubectl apply -f -` helm.write(nil, out) } return err } func (helm *execer) DiffRelease(context HelmContext, name, chart string, suppressDiff bool, flags ...string) error { if context.Writer != nil { fmt.Fprintf(context.Writer, "Comparing release=%v, chart=%v\n", name, chart) } else { helm.logger.Infof("Comparing release=%v, chart=%v", name, chart) } preArgs := context.GetTillerlessArgs(helm) env := context.getTillerlessEnv() out, err := helm.exec(append(append(preArgs, "diff", "upgrade", "--reset-values", "--allow-unreleased", name, chart), flags...), env) // Do our best to write STDOUT only when diff existed // Unfortunately, this works only when you run helmfile with `--detailed-exitcode` detailedExitcodeEnabled := false for _, f := range flags { if strings.Contains(f, "detailed-exitcode") { detailedExitcodeEnabled = true break } } if detailedExitcodeEnabled { switch e := err.(type) { case ExitError: if e.ExitStatus() == 2 { if !(suppressDiff) { helm.write(context.Writer, out) } return err } } } else if !(suppressDiff) { helm.write(context.Writer, out) } return err } func (helm *execer) Lint(name, chart string, flags ...string) error { helm.logger.Infof("Linting release=%v, chart=%v", name, chart) out, err := helm.exec(append([]string{"lint", chart}, flags...), map[string]string{}) helm.write(nil, out) return err } func (helm *execer) Fetch(chart string, flags ...string) error { helm.logger.Infof("Fetching %v", chart) out, err := helm.exec(append([]string{"fetch", chart}, flags...), map[string]string{}) helm.info(out) return err } func (helm *execer) ChartPull(chart string, flags ...string) error { helm.logger.Infof("Pulling %v", chart) out, err := helm.exec(append([]string{"chart", "pull", chart}, flags...), map[string]string{"HELM_EXPERIMENTAL_OCI": "1"}) helm.info(out) return err } func (helm *execer) ChartExport(chart string, path string, flags ...string) error { helm.logger.Infof("Exporting %v", chart) out, err := helm.exec(append([]string{"chart", "export", chart, "--destination", path}, flags...), map[string]string{"HELM_EXPERIMENTAL_OCI": "1"}) helm.info(out) return err } func (helm *execer) DeleteRelease(context HelmContext, name string, flags ...string) error { helm.logger.Infof("Deleting %v", name) preArgs := context.GetTillerlessArgs(helm) env := context.getTillerlessEnv() out, err := helm.exec(append(append(preArgs, "delete", name), flags...), env) helm.write(nil, out) return err } func (helm *execer) TestRelease(context HelmContext, name string, flags ...string) error { helm.logger.Infof("Testing %v", name) preArgs := context.GetTillerlessArgs(helm) env := context.getTillerlessEnv() args := []string{"test", name} out, err := helm.exec(append(append(preArgs, args...), flags...), env) helm.write(nil, out) return err } func (helm *execer) exec(args []string, env map[string]string) ([]byte, error) { cmdargs := args if len(helm.extra) > 0 { cmdargs = append(cmdargs, helm.extra...) } if helm.kubeContext != "" { cmdargs = append([]string{"--kube-context", helm.kubeContext}, cmdargs...) } cmd := fmt.Sprintf("exec: %s %s", helm.helmBinary, strings.Join(cmdargs, " ")) helm.logger.Debug(cmd) outBytes, err := helm.runner.Execute(helm.helmBinary, cmdargs, env) return outBytes, err } func (helm *execer) execStdIn(args []string, env map[string]string, stdin io.Reader) ([]byte, error) { cmdargs := args if len(helm.extra) > 0 { cmdargs = append(cmdargs, helm.extra...) } if helm.kubeContext != "" { cmdargs = append([]string{"--kube-context", helm.kubeContext}, cmdargs...) } cmd := fmt.Sprintf("exec: %s %s", helm.helmBinary, strings.Join(cmdargs, " ")) helm.logger.Debug(cmd) outBytes, err := helm.runner.ExecuteStdIn(helm.helmBinary, cmdargs, env, stdin) return outBytes, err } func (helm *execer) azcli(name string) ([]byte, error) { cmdargs := append(strings.Split("acr helm repo add --name", " "), name) cmd := fmt.Sprintf("exec: az %s", strings.Join(cmdargs, " ")) helm.logger.Debug(cmd) outBytes, err := helm.runner.Execute("az", cmdargs, map[string]string{}) helm.logger.Debugf("%s: %s", cmd, outBytes) return outBytes, err } func (helm *execer) info(out []byte) { if len(out) > 0 { helm.logger.Infof("%s", out) } } func (helm *execer) write(w io.Writer, out []byte) { if len(out) > 0 { if w == nil { w = os.Stdout } fmt.Fprintf(w, "%s\n", out) } } func (helm *execer) IsHelm3() bool { return helm.version.Major() == 3 } func (helm *execer) GetVersion() Version { return Version{ Major: int(helm.version.Major()), Minor: int(helm.version.Minor()), Patch: int(helm.version.Patch()), } } func (helm *execer) IsVersionAtLeast(versionStr string) bool { ver := semver.MustParse(versionStr) return helm.version.Equal(ver) || helm.version.GreaterThan(ver) }