feat: helmfile as a go library (#639)

* feat: helmfile as a go library This removes almost all the dependencies from the helmfile core logic to urfave/cli. `main.go` is now a thin wrapper around the core logic implemented in `pkg/app`.
2026-09-30 13:16:12 +02:00 · 2019-06-04 09:12:00 +09:00
parent f6057a1cca
commit e2d6dc4afa
8 changed files with 710 additions and 444 deletions
@@ -24,6 +24,12 @@ type App struct {
 	Env         string
 	Namespace   string
 	Selectors   []string
+	HelmBinary  string
+	Args        string
+
+	FileOrDir string
+
+	ErrorHandler func(error) error

 	readFile          func(string) ([]byte, error)
 	fileExists        func(string) (bool, error)
@@ -36,6 +42,19 @@ type App struct {
 	chdir func(string) error
 }

+func New(conf ConfigProvider) *App {
+	return Init(&App{
+		KubeContext: conf.KubeContext(),
+		Logger:      conf.Logger(),
+		Env:         conf.Env(),
+		Namespace:   conf.Namespace(),
+		Selectors:   conf.Selectors(),
+		HelmBinary:  conf.HelmBinary(),
+		Args:        conf.Args(),
+		FileOrDir:   conf.FileOrDir(),
+	})
+}
+
 func Init(app *App) *App {
 	app.readFile = ioutil.ReadFile
 	app.glob = filepath.Glob
@@ -48,6 +67,84 @@ func Init(app *App) *App {
 	return app
 }

+func (a *App) Deps(c DepsConfigProvider) error {
+	return a.ForEachState(func(run *Run) []error {
+		return run.Deps(c)
+	})
+}
+
+func (a *App) Repos(c ReposConfigProvider) error {
+	return a.ForEachState(func(run *Run) []error {
+		return run.Repos(c)
+	})
+}
+
+func (a *App) reverse() *App {
+	new := *a
+	new.Reverse = true
+	return &new
+}
+
+func (a *App) DeprecatedSyncCharts(c DeprecatedChartsConfigProvider) error {
+	return a.ForEachState(func(run *Run) []error {
+		return run.DeprecatedSyncCharts(c)
+	})
+}
+
+func (a *App) Diff(c DiffConfigProvider) error {
+	return a.ForEachState(func(run *Run) []error {
+		return run.Diff(c)
+	})
+}
+
+func (a *App) Template(c TemplateConfigProvider) error {
+	return a.ForEachState(func(run *Run) []error {
+		return run.Template(c)
+	})
+}
+
+func (a *App) Lint(c LintConfigProvider) error {
+	return a.ForEachState(func(run *Run) []error {
+		return run.Lint(c)
+	})
+}
+
+func (a *App) Sync(c SyncConfigProvider) error {
+	return a.ForEachState(func(run *Run) []error {
+		return run.Sync(c)
+	})
+}
+
+func (a *App) Apply(c ApplyConfigProvider) error {
+	return a.ForEachState(func(run *Run) []error {
+		return run.Apply(c)
+	})
+}
+
+func (a *App) Status(c StatusesConfigProvider) error {
+	return a.ForEachState(func(run *Run) []error {
+		return run.Status(c)
+	})
+}
+
+func (a *App) Delete(c DeleteConfigProvider) error {
+	return a.reverse().ForEachState(func(run *Run) []error {
+		return run.Delete(c)
+	})
+}
+
+func (a *App) Destroy(c DestroyConfigProvider) error {
+	return a.reverse().ForEachState(func(run *Run) []error {
+		return run.Destroy(c)
+	})
+}
+
+func (a *App) Test(c TestConfigProvider) error {
+	return a.ForEachState(func(run *Run) []error {
+		return run.Test(c)
+	})
+}
+
 func (a *App) within(dir string, do func() error) error {
 	if dir == "." {
 		return do()
@@ -140,7 +237,7 @@ func (a *App) loadDesiredStateFromYaml(file string, opts ...LoadOpts) (*state.He
 	return ld.Load(file, op)
 }

-func (a *App) VisitDesiredStates(fileOrDir string, opts LoadOpts, converge func(*state.HelmState, helmexec.Interface) (bool, []error)) error {
+func (a *App) visitStates(fileOrDir string, opts LoadOpts, converge func(*state.HelmState, helmexec.Interface) (bool, []error)) error {
 	noMatchInHelmfiles := true

 	err := a.visitStateFiles(fileOrDir, func(f, d string) error {
@@ -195,7 +292,7 @@ func (a *App) VisitDesiredStates(fileOrDir string, opts LoadOpts, converge func(
 				} else {
 					optsForNestedState.Selectors = m.Selectors
 				}
-				if err := a.VisitDesiredStates(m.Path, optsForNestedState, converge); err != nil {
+				if err := a.visitStates(m.Path, optsForNestedState, converge); err != nil {
 					switch err.(type) {
 					case *NoMatchingHelmfileError:

@@ -229,10 +326,26 @@ func (a *App) VisitDesiredStates(fileOrDir string, opts LoadOpts, converge func(
 	return nil
 }

+func (a *App) ForEachState(do func(*Run) []error) error {
+	err := a.VisitDesiredStatesWithReleasesFiltered(a.FileOrDir, func(st *state.HelmState, helm helmexec.Interface) []error {
+		ctx := NewContext()
+
+		run := NewRun(st, helm, ctx)
+
+		return do(run)
+	})
+
+	if err != nil && a.ErrorHandler != nil {
+		return a.ErrorHandler(err)
+	}
+
+	return err
+}
+
 func (a *App) VisitDesiredStatesWithReleasesFiltered(fileOrDir string, converge func(*state.HelmState, helmexec.Interface) []error) error {
 	opts := LoadOpts{Selectors: a.Selectors}

-	err := a.VisitDesiredStates(fileOrDir, opts, func(st *state.HelmState, helm helmexec.Interface) (bool, []error) {
+	err := a.visitStates(fileOrDir, opts, func(st *state.HelmState, helm helmexec.Interface) (bool, []error) {
 		if len(st.Selectors) > 0 {
 			err := st.FilterReleases()
 			if err != nil {
@@ -240,6 +353,10 @@ func (a *App) VisitDesiredStatesWithReleasesFiltered(fileOrDir string, converge
 			}
 		}

+		if a.HelmBinary != "" {
+			helm.SetHelmBinary(a.HelmBinary)
+		}
+
 		type Key struct {
 			TillerNamespace, Name string
 		}
@@ -0,0 +1,33 @@
+package app
+
+import (
+	"bufio"
+	"fmt"
+	"log"
+	"os"
+	"strings"
+)
+
+// Copyright (c) 2017 Roland Singer [roland.singer@desertbit.com]
+//
+// Shamelessly borrowed from @r0l1's awesome work that is available at https://gist.github.com/r0l1/3dcbb0c8f6cfe9c66ab8008f55f8f28b
+func AskForConfirmation(s string) bool {
+	reader := bufio.NewReader(os.Stdin)
+
+	for {
+		fmt.Printf("%s [y/n]: ", s)
+
+		response, err := reader.ReadString('\n')
+		if err != nil {
+			log.Fatal(err)
+		}
+
+		response = strings.ToLower(strings.TrimSpace(response))
+
+		if response == "y" || response == "yes" {
+			return true
+		} else if response == "n" || response == "no" {
+			return false
+		}
+	}
+}
@@ -0,0 +1,128 @@
+package app
+
+import "go.uber.org/zap"
+
+type ConfigProvider interface {
+	Args() string
+	HelmBinary() string
+
+	FileOrDir() string
+	KubeContext() string
+	Namespace() string
+	Selectors() []string
+	Env() string
+
+	loggingConfig
+}
+
+type DeprecatedChartsConfigProvider interface {
+	Values() []string
+
+	concurrencyConfig
+	loggingConfig
+}
+
+type DepsConfigProvider interface {
+	Args() string
+}
+
+type ReposConfigProvider interface {
+	Args() string
+}
+
+type ApplyConfigProvider interface {
+	Args() string
+
+	Values() []string
+	SkipDeps() bool
+
+	SuppressSecrets() bool
+
+	concurrencyConfig
+	interactive
+	loggingConfig
+}
+
+type SyncConfigProvider interface {
+	Args() string
+
+	Values() []string
+	SkipDeps() bool
+
+	concurrencyConfig
+	loggingConfig
+}
+
+type DiffConfigProvider interface {
+	Args() string
+
+	Values() []string
+	SkipDeps() bool
+
+	SuppressSecrets() bool
+
+	DetailedExitcode() bool
+
+	concurrencyConfig
+}
+
+type DeleteConfigProvider interface {
+	Args() string
+
+	Purge() bool
+
+	interactive
+	loggingConfig
+}
+
+type DestroyConfigProvider interface {
+	Args() string
+
+	interactive
+	loggingConfig
+}
+
+type TestConfigProvider interface {
+	Args() string
+
+	Timeout() int
+	Cleanup() bool
+
+	concurrencyConfig
+}
+
+type LintConfigProvider interface {
+	Args() string
+
+	Values() []string
+	SkipDeps() bool
+
+	concurrencyConfig
+}
+
+type TemplateConfigProvider interface {
+	Args() string
+
+	Values() []string
+	SkipDeps() bool
+
+	concurrencyConfig
+}
+
+type StatusesConfigProvider interface {
+	Args() string
+
+	concurrencyConfig
+}
+
+type concurrencyConfig interface {
+	Concurrency() int
+}
+
+type loggingConfig interface {
+	Logger() *zap.SugaredLogger
+}
+
+type interactive interface {
+	Interactive() bool
+}
@@ -0,0 +1,302 @@
+package app
+
+import (
+	"fmt"
+	"github.com/roboll/helmfile/pkg/argparser"
+	"github.com/roboll/helmfile/pkg/helmexec"
+	"github.com/roboll/helmfile/pkg/state"
+	"strings"
+)
+
+type Run struct {
+	state *state.HelmState
+	helm  helmexec.Interface
+	ctx   Context
+
+	Ask func(string) bool
+}
+
+func NewRun(st *state.HelmState, helm helmexec.Interface, ctx Context) *Run {
+	return &Run{state: st, helm: helm, ctx: ctx}
+}
+
+func (r *Run) askForConfirmation(msg string) bool {
+	if r.Ask != nil {
+		return r.Ask(msg)
+	}
+	return AskForConfirmation(msg)
+}
+
+func (r *Run) Deps(c DepsConfigProvider) []error {
+	r.helm.SetExtraArgs(argparser.GetArgs(c.Args(), r.state)...)
+
+	return r.state.UpdateDeps(r.helm)
+}
+
+func (r *Run) Repos(c ReposConfigProvider) []error {
+	r.helm.SetExtraArgs(argparser.GetArgs(c.Args(), r.state)...)
+
+	return r.ctx.SyncReposOnce(r.state, r.helm)
+}
+
+func (r *Run) DeprecatedSyncCharts(c DeprecatedChartsConfigProvider) []error {
+	st := r.state
+	helm := r.helm
+
+	affectedReleases := state.AffectedReleases{}
+	errs := st.SyncReleases(&affectedReleases, helm, c.Values(), c.Concurrency())
+	affectedReleases.DisplayAffectedReleases(c.Logger())
+	return errs
+}
+
+func (r *Run) Status(c StatusesConfigProvider) []error {
+	workers := c.Concurrency()
+
+	r.helm.SetExtraArgs(argparser.GetArgs(c.Args(), r.state)...)
+
+	return r.state.ReleaseStatuses(r.helm, workers)
+}
+
+func (r *Run) Delete(c DeleteConfigProvider) []error {
+	affectedReleases := state.AffectedReleases{}
+	purge := c.Purge()
+
+	errs := []error{}
+
+	names := make([]string, len(r.state.Releases))
+	for i, r := range r.state.Releases {
+		names[i] = fmt.Sprintf("  %s (%s)", r.Name, r.Chart)
+	}
+
+	msg := fmt.Sprintf(`Affected releases are:
+%s
+
+Do you really want to delete?
+  Helmfile will delete all your releases, as shown above.
+
+`, strings.Join(names, "\n"))
+	interactive := c.Interactive()
+	if !interactive || interactive && r.askForConfirmation(msg) {
+		r.helm.SetExtraArgs(argparser.GetArgs(c.Args(), r.state)...)
+
+		errs = r.state.DeleteReleases(&affectedReleases, r.helm, purge)
+	}
+	affectedReleases.DisplayAffectedReleases(c.Logger())
+	return errs
+}
+
+func (r *Run) Destroy(c DestroyConfigProvider) []error {
+	errs := []error{}
+	affectedReleases := state.AffectedReleases{}
+
+	names := make([]string, len(r.state.Releases))
+	for i, r := range r.state.Releases {
+		names[i] = fmt.Sprintf("  %s (%s)", r.Name, r.Chart)
+	}
+
+	msg := fmt.Sprintf(`Affected releases are:
+%s
+
+Do you really want to delete?
+  Helmfile will delete all your releases, as shown above.
+
+`, strings.Join(names, "\n"))
+	interactive := c.Interactive()
+	if !interactive || interactive && r.askForConfirmation(msg) {
+		r.helm.SetExtraArgs(argparser.GetArgs(c.Args(), r.state)...)
+
+		errs = r.state.DeleteReleases(&affectedReleases, r.helm, true)
+	}
+	affectedReleases.DisplayAffectedReleases(c.Logger())
+	return errs
+}
+
+func (r *Run) Apply(c ApplyConfigProvider) []error {
+	st := r.state
+	helm := r.helm
+	ctx := r.ctx
+
+	affectedReleases := state.AffectedReleases{}
+	if !c.SkipDeps() {
+		if errs := ctx.SyncReposOnce(st, helm); errs != nil && len(errs) > 0 {
+			return errs
+		}
+		if errs := st.BuildDeps(helm); errs != nil && len(errs) > 0 {
+			return errs
+		}
+	}
+	if errs := st.PrepareReleases(helm, "apply"); errs != nil && len(errs) > 0 {
+		return errs
+	}
+
+	// helm must be 2.11+ and helm-diff should be provided `--detailed-exitcode` in order for `helmfile apply` to work properly
+	detailedExitCode := true
+
+	releases, errs := st.DiffReleases(helm, c.Values(), c.Concurrency(), detailedExitCode, c.SuppressSecrets(), false)
+
+	releasesToBeDeleted, err := st.DetectReleasesToBeDeleted(helm)
+	if err != nil {
+		errs = append(errs, err)
+	}
+
+	fatalErrs := []error{}
+
+	noError := true
+	for _, e := range errs {
+		switch err := e.(type) {
+		case *state.ReleaseError:
+			if err.Code != 2 {
+				noError = false
+				fatalErrs = append(fatalErrs, e)
+			}
+		default:
+			noError = false
+			fatalErrs = append(fatalErrs, e)
+		}
+	}
+
+	// sync only when there are changes
+	if noError {
+		if len(releases) == 0 && len(releasesToBeDeleted) == 0 {
+			// TODO better way to get the logger
+			logger := c.Logger()
+			logger.Infof("")
+			logger.Infof("No affected releases")
+		} else {
+			names := []string{}
+			for _, r := range releases {
+				names = append(names, fmt.Sprintf("  %s (%s) UPDATED", r.Name, r.Chart))
+			}
+			for _, r := range releasesToBeDeleted {
+				names = append(names, fmt.Sprintf("  %s (%s) DELETED", r.Name, r.Chart))
+			}
+
+			msg := fmt.Sprintf(`Affected releases are:
+%s
+
+Do you really want to apply?
+  Helmfile will apply all your changes, as shown above.
+
+`, strings.Join(names, "\n"))
+			interactive := c.Interactive()
+			if !interactive || interactive && r.askForConfirmation(msg) {
+				rs := []state.ReleaseSpec{}
+				for _, r := range releases {
+					rs = append(rs, *r)
+				}
+				for _, r := range releasesToBeDeleted {
+					rs = append(rs, *r)
+				}
+
+				r.helm.SetExtraArgs(argparser.GetArgs(c.Args(), r.state)...)
+
+				st.Releases = rs
+				return st.SyncReleases(&affectedReleases, helm, c.Values(), c.Concurrency())
+			}
+		}
+	}
+
+	affectedReleases.DisplayAffectedReleases(c.Logger())
+	return fatalErrs
+}
+
+func (r *Run) Diff(c DiffConfigProvider) []error {
+	st := r.state
+	helm := r.helm
+	ctx := r.ctx
+
+	if !c.SkipDeps() {
+		if errs := ctx.SyncReposOnce(st, helm); errs != nil && len(errs) > 0 {
+			return errs
+		}
+		if errs := st.BuildDeps(helm); errs != nil && len(errs) > 0 {
+			return errs
+		}
+	}
+	if errs := st.PrepareReleases(helm, "diff"); errs != nil && len(errs) > 0 {
+		return errs
+	}
+
+	r.helm.SetExtraArgs(argparser.GetArgs(c.Args(), r.state)...)
+
+	_, errs := st.DiffReleases(helm, c.Values(), c.Concurrency(), c.DetailedExitcode(), c.SuppressSecrets(), true)
+	return errs
+}
+
+func (r *Run) Sync(c SyncConfigProvider) []error {
+	st := r.state
+	helm := r.helm
+	ctx := r.ctx
+
+	affectedReleases := state.AffectedReleases{}
+	if !c.SkipDeps() {
+		if errs := ctx.SyncReposOnce(st, helm); errs != nil && len(errs) > 0 {
+			return errs
+		}
+		if errs := st.BuildDeps(helm); errs != nil && len(errs) > 0 {
+			return errs
+		}
+	}
+	if errs := st.PrepareReleases(helm, "sync"); errs != nil && len(errs) > 0 {
+		return errs
+	}
+
+	r.helm.SetExtraArgs(argparser.GetArgs(c.Args(), r.state)...)
+
+	errs := st.SyncReleases(&affectedReleases, helm, c.Values(), c.Concurrency())
+	affectedReleases.DisplayAffectedReleases(c.Logger())
+	return errs
+}
+
+func (r *Run) Template(c TemplateConfigProvider) []error {
+	state := r.state
+	helm := r.helm
+	ctx := r.ctx
+
+	if !c.SkipDeps() {
+		if errs := ctx.SyncReposOnce(state, helm); errs != nil && len(errs) > 0 {
+			return errs
+		}
+		if errs := state.BuildDeps(helm); errs != nil && len(errs) > 0 {
+			return errs
+		}
+	}
+	if errs := state.PrepareReleases(helm, "template"); errs != nil && len(errs) > 0 {
+		return errs
+	}
+
+	args := argparser.GetArgs(c.Args(), state)
+	return state.TemplateReleases(helm, c.Values(), args, c.Concurrency())
+}
+
+func (r *Run) Test(c TestConfigProvider) []error {
+	cleanup := c.Cleanup()
+	timeout := c.Timeout()
+	concurrency := c.Concurrency()
+
+	r.helm.SetExtraArgs(argparser.GetArgs(c.Args(), r.state)...)
+
+	return r.state.TestReleases(r.helm, cleanup, timeout, concurrency)
+}
+
+func (r *Run) Lint(c LintConfigProvider) []error {
+	state := r.state
+	helm := r.helm
+	ctx := r.ctx
+
+	values := c.Values()
+	args := argparser.GetArgs(c.Args(), state)
+	workers := c.Concurrency()
+	if !c.SkipDeps() {
+		if errs := ctx.SyncReposOnce(state, helm); errs != nil && len(errs) > 0 {
+			return errs
+		}
+		if errs := state.BuildDeps(helm); errs != nil && len(errs) > 0 {
+			return errs
+		}
+	}
+	if errs := state.PrepareReleases(helm, "lint"); errs != nil && len(errs) > 0 {
+		return errs
+	}
+	return state.LintReleases(helm, values, args, workers)
+}
@@ -514,6 +514,9 @@ func (st *HelmState) downloadCharts(helm helmexec.Interface, dir string, concurr

 // TemplateReleases wrapper for executing helm template on the releases
 func (st *HelmState) TemplateReleases(helm helmexec.Interface, additionalValues []string, args []string, workerLimit int) []error {
+	// Reset the extra args if already set, not to break `helm fetch` by adding the args intended for `lint`
+	helm.SetExtraArgs()
+
 	errs := []error{}
 	// Create tmp directory and bail immediately if it fails
 	dir, err := ioutil.TempDir("", "")
@@ -577,6 +580,9 @@ func (st *HelmState) TemplateReleases(helm helmexec.Interface, additionalValues

 // LintReleases wrapper for executing helm lint on the releases
 func (st *HelmState) LintReleases(helm helmexec.Interface, additionalValues []string, args []string, workerLimit int) []error {
+	// Reset the extra args if already set, not to break `helm fetch` by adding the args intended for `lint`
+	helm.SetExtraArgs()
+
 	errs := []error{}
 	// Create tmp directory and bail immediately if it fails
 	dir, err := ioutil.TempDir("", "")