feat: Add --suppress option for diff and apply commands (#2077)

This commit is contained in:
Sören Jentzsch 2022-02-03 00:46:39 +01:00 committed by GitHub
parent 061644c5d0
commit 19927fc147
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 36 additions and 6 deletions

12
main.go
View File

@ -211,6 +211,10 @@ func main() {
Name: "skip-diff-on-install", Name: "skip-diff-on-install",
Usage: "Skips running helm-diff on releases being newly installed on this apply. Useful when the release manifests are too huge to be reviewed, or it's too time-consuming to diff at all", Usage: "Skips running helm-diff on releases being newly installed on this apply. Useful when the release manifests are too huge to be reviewed, or it's too time-consuming to diff at all",
}, },
cli.StringSliceFlag{
Name: "suppress",
Usage: "suppress specified Kubernetes objects in the output. Can be provided multiple times. For example: --suppress KeycloakClient --suppress VaultSecret",
},
cli.BoolFlag{ cli.BoolFlag{
Name: "suppress-secrets", Name: "suppress-secrets",
Usage: "suppress secrets in the output. highly recommended to specify on CI/CD use-cases", Usage: "suppress secrets in the output. highly recommended to specify on CI/CD use-cases",
@ -517,6 +521,10 @@ func main() {
Name: "include-tests", Name: "include-tests",
Usage: "enable the diffing of the helm test hooks", Usage: "enable the diffing of the helm test hooks",
}, },
cli.StringSliceFlag{
Name: "suppress",
Usage: "suppress specified Kubernetes objects in the diff output. Can be provided multiple times. For example: --suppress KeycloakClient --suppress VaultSecret",
},
cli.BoolFlag{ cli.BoolFlag{
Name: "suppress-secrets", Name: "suppress-secrets",
Usage: "suppress secrets in the diff output. highly recommended to specify on CI/CD use-cases", Usage: "suppress secrets in the diff output. highly recommended to specify on CI/CD use-cases",
@ -823,6 +831,10 @@ func (c configImpl) IncludeTests() bool {
return c.c.Bool("include-tests") return c.c.Bool("include-tests")
} }
func (c configImpl) Suppress() []string {
return c.c.StringSlice("suppress")
}
func (c configImpl) SuppressSecrets() bool { func (c configImpl) SuppressSecrets() bool {
return c.c.Bool("suppress-secrets") return c.c.Bool("suppress-secrets")
} }

View File

@ -2360,6 +2360,7 @@ type applyConfig struct {
includeNeeds bool includeNeeds bool
includeTransitiveNeeds bool includeTransitiveNeeds bool
includeTests bool includeTests bool
suppress []string
suppressSecrets bool suppressSecrets bool
showSecrets bool showSecrets bool
suppressDiff bool suppressDiff bool
@ -2427,6 +2428,10 @@ func (a applyConfig) IncludeTests() bool {
return a.includeTests return a.includeTests
} }
func (a applyConfig) Suppress() []string {
return a.suppress
}
func (a applyConfig) SuppressSecrets() bool { func (a applyConfig) SuppressSecrets() bool {
return a.suppressSecrets return a.suppressSecrets
} }

View File

@ -49,6 +49,7 @@ type ApplyConfigProvider interface {
IncludeTests() bool IncludeTests() bool
Suppress() []string
SuppressSecrets() bool SuppressSecrets() bool
ShowSecrets() bool ShowSecrets() bool
SuppressDiff() bool SuppressDiff() bool
@ -102,6 +103,7 @@ type DiffConfigProvider interface {
IncludeTests() bool IncludeTests() bool
Suppress() []string
SuppressSecrets() bool SuppressSecrets() bool
ShowSecrets() bool ShowSecrets() bool
SuppressDiff() bool SuppressDiff() bool

View File

@ -27,6 +27,7 @@ type diffConfig struct {
includeTests bool includeTests bool
includeNeeds bool includeNeeds bool
skipNeeds bool skipNeeds bool
suppress []string
suppressSecrets bool suppressSecrets bool
showSecrets bool showSecrets bool
suppressDiff bool suppressDiff bool
@ -76,6 +77,10 @@ func (a diffConfig) SkipNeeds() bool {
return a.skipNeeds return a.skipNeeds
} }
func (a diffConfig) Suppress() []string {
return a.suppress
}
func (a diffConfig) SuppressSecrets() bool { func (a diffConfig) SuppressSecrets() bool {
return a.suppressSecrets return a.suppressSecrets
} }

View File

@ -127,7 +127,7 @@ func (r *Run) diff(triggerCleanupEvent bool, detailedExitCode bool, c DiffConfig
// TODO Better way to detect diff on only filtered releases // TODO Better way to detect diff on only filtered releases
{ {
changedReleases, planningErrs = st.DiffReleases(helm, c.Values(), c.Concurrency(), detailedExitCode, c.IncludeTests(), c.SuppressSecrets(), c.ShowSecrets(), c.SuppressDiff(), triggerCleanupEvent, diffOpts) changedReleases, planningErrs = st.DiffReleases(helm, c.Values(), c.Concurrency(), detailedExitCode, c.IncludeTests(), c.Suppress(), c.SuppressSecrets(), c.ShowSecrets(), c.SuppressDiff(), triggerCleanupEvent, diffOpts)
var err error var err error
deletingReleases, err = st.DetectReleasesToBeDeletedForSync(helm, st.Releases) deletingReleases, err = st.DetectReleasesToBeDeletedForSync(helm, st.Releases)

View File

@ -1598,7 +1598,7 @@ type diffPrepareResult struct {
upgradeDueToSkippedDiff bool upgradeDueToSkippedDiff bool
} }
func (st *HelmState) prepareDiffReleases(helm helmexec.Interface, additionalValues []string, concurrency int, detailedExitCode, includeTests, suppressSecrets bool, showSecrets bool, opt ...DiffOpt) ([]diffPrepareResult, []error) { func (st *HelmState) prepareDiffReleases(helm helmexec.Interface, additionalValues []string, concurrency int, detailedExitCode bool, includeTests bool, suppress []string, suppressSecrets bool, showSecrets bool, opt ...DiffOpt) ([]diffPrepareResult, []error) {
opts := &DiffOpts{} opts := &DiffOpts{}
for _, o := range opt { for _, o := range opt {
o.Apply(opts) o.Apply(opts)
@ -1699,6 +1699,12 @@ func (st *HelmState) prepareDiffReleases(helm helmexec.Interface, additionalValu
flags = append(flags, "--include-tests") flags = append(flags, "--include-tests")
} }
if suppress != nil {
for _, s := range suppress {
flags = append(flags, "--suppress", s)
}
}
if suppressSecrets { if suppressSecrets {
flags = append(flags, "--suppress-secrets") flags = append(flags, "--suppress-secrets")
} }
@ -1815,13 +1821,13 @@ type DiffOpt interface{ Apply(*DiffOpts) }
// For example, terraform-provider-helmfile runs a helmfile-diff on `terraform plan` and another on `terraform apply`. // For example, terraform-provider-helmfile runs a helmfile-diff on `terraform plan` and another on `terraform apply`.
// `terraform`, by design, fails when helmfile-diff outputs were not equivalent. // `terraform`, by design, fails when helmfile-diff outputs were not equivalent.
// Stabilized helmfile-diff output rescues that. // Stabilized helmfile-diff output rescues that.
func (st *HelmState) DiffReleases(helm helmexec.Interface, additionalValues []string, workerLimit int, detailedExitCode, includeTests, suppressSecrets, showSecrets, suppressDiff, triggerCleanupEvents bool, opt ...DiffOpt) ([]ReleaseSpec, []error) { func (st *HelmState) DiffReleases(helm helmexec.Interface, additionalValues []string, workerLimit int, detailedExitCode bool, includeTests bool, suppress []string, suppressSecrets, showSecrets, suppressDiff, triggerCleanupEvents bool, opt ...DiffOpt) ([]ReleaseSpec, []error) {
opts := &DiffOpts{} opts := &DiffOpts{}
for _, o := range opt { for _, o := range opt {
o.Apply(opts) o.Apply(opts)
} }
preps, prepErrs := st.prepareDiffReleases(helm, additionalValues, workerLimit, detailedExitCode, includeTests, suppressSecrets, showSecrets, opts) preps, prepErrs := st.prepareDiffReleases(helm, additionalValues, workerLimit, detailedExitCode, includeTests, suppress, suppressSecrets, showSecrets, opts)
if !opts.SkipCleanup { if !opts.SkipCleanup {
defer func() { defer func() {

View File

@ -1612,7 +1612,7 @@ func TestHelmState_DiffReleases(t *testing.T) {
valsRuntime: valsRuntime, valsRuntime: valsRuntime,
RenderedValues: map[string]interface{}{}, RenderedValues: map[string]interface{}{},
} }
_, errs := state.DiffReleases(tt.helm, []string{}, 1, false, false, false, false, false, false) _, errs := state.DiffReleases(tt.helm, []string{}, 1, false, false, []string{}, false, false, false, false)
if errs != nil && len(errs) > 0 { if errs != nil && len(errs) > 0 {
t.Errorf("unexpected error: %v", errs) t.Errorf("unexpected error: %v", errs)
} }
@ -1783,7 +1783,7 @@ func TestHelmState_DiffReleasesCleanup(t *testing.T) {
`, `,
}) })
state = injectFs(state, testfs) state = injectFs(state, testfs)
if _, errs := state.DiffReleases(tt.helm, []string{}, 1, false, false, false, false, false, false); errs != nil && len(errs) > 0 { if _, errs := state.DiffReleases(tt.helm, []string{}, 1, false, false, []string{}, false, false, false, false); errs != nil && len(errs) > 0 {
t.Errorf("unexpected errors: %v", errs) t.Errorf("unexpected errors: %v", errs)
} }