Merge branch 'databus23:master' into plugin-install-mktemp

Author: keymon

Makefile

@@ -22,7 +22,7 @@ install: build
 	cp plugin.yaml $(HELM_HOME)/plugins/helm-diff/
 
 .PHONY: install/helm3
-install/helm3:
+install/helm3: build
 	mkdir -p $(HELM_3_PLUGINS)/helm-diff/bin
 	cp bin/diff $(HELM_3_PLUGINS)/helm-diff/bin
 	cp plugin.yaml $(HELM_3_PLUGINS)/helm-diff/

README.md

@@ -28,6 +28,27 @@ E.g.
 curl -L $TARBALL_URL | tar -C $(helm home)/plugins -xzv
 ```
 
+### From Source
+#### Prerequisites
+ - GoLang `>= 1.14`
+
+Make sure you do not have a verison of `helm-diff` installed. You can remove it by running `helm plugin uninstall diff`
+
+#### Installation Steps
+The first step is to download the repository and enter the directory. You can do this via `git clone` or downloaing and extracting the release. If you clone via git, remember to checkout the latest tag for the latest release.
+
+Next, depending on which helm version you have, install the plugin into helm.
+
+##### Helm 2
+```bash
+make install
+```
+
+##### Helm 3
+```bash
+make install/helm3
+```
+
 
 ## Usage
 
@@ -103,6 +124,7 @@ Flags:
       --post-renderer string   the path to an executable to be used for post rendering. If it exists in $PATH, the binary will be used, otherwise it will try to look for the executable at the given path
       --reset-values           reset the values to the ones built into the chart and merge in any new values
       --reuse-values           reuse the last release's values and merge in any new values
+      --strip-trailing-cr      strip trailing carriage return on input
       --set stringArray        set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
       --suppress stringArray   allows suppression of the values listed in the diff output
   -q, --suppress-secrets       suppress secrets in the output
@@ -135,6 +157,7 @@ Flags:
   -h, --help                   help for release
       --home string            location of your Helm config. Overrides $HELM_HOME (default "/home/aananth/.helm")
       --include-tests          enable the diffing of the helm test hooks
+      --strip-trailing-cr      strip trailing carriage return on input
       --suppress stringArray   allows suppression of the values listed in the diff output
   -q, --suppress-secrets       suppress secrets in the output
       --tls                    enable TLS for request
@@ -157,7 +180,7 @@ This command compares the manifests details of a named release.
 
 It can be used to compare the manifests of 
  
- - lastest REVISION with specified REVISION
+ - latest REVISION with specified REVISION
 	$ helm diff revision [flags] RELEASE REVISION1
    Example: 
 	$ helm diff revision my-release 2
@@ -172,6 +195,7 @@ Usage:
 
 Flags:
   -h, --help                   help for revision
+      --strip-trailing-cr      strip trailing carriage return on input
       --suppress stringArray   allows suppression of the values listed in the diff output
   -q, --suppress-secrets       suppress secrets in the output
 
@@ -197,6 +221,7 @@ Examples:
 
 Flags:
   -h, --help                   help for rollback
+      --strip-trailing-cr      strip trailing carriage return on input
       --suppress stringArray   allows suppression of the values listed in the diff output
   -q, --suppress-secrets       suppress secrets in the output
 

cmd/helm3.go

@@ -92,6 +92,9 @@ func (d *diffCmd) template(isUpgrade bool) ([]byte, error) {
 	if d.chartVersion != "" {
 		flags = append(flags, "--version", d.chartVersion)
 	}
+	if d.chartRepo != "" {
+		flags = append(flags, "--repo", d.chartRepo)
+	}
 	if d.namespace != "" {
 		flags = append(flags, "--namespace", d.namespace)
 	}

cmd/release.go

@@ -13,14 +13,16 @@ import (
 )
 
 type release struct {
-	client           helm.Interface
-	detailedExitCode bool
-	suppressedKinds  []string
-	releases         []string
-	outputContext    int
-	includeTests     bool
-	showSecrets      bool
-	output           string
+	client             helm.Interface
+	detailedExitCode   bool
+	suppressedKinds    []string
+	releases           []string
+	outputContext      int
+	includeTests       bool
+	showSecrets        bool
+	output             string
+	stripTrailingCR    bool
+	normalizeManifests bool
 }
 
 const releaseCmdLongUsage = `
@@ -79,6 +81,8 @@ func releaseCmd() *cobra.Command {
 	releaseCmd.Flags().IntVarP(&diff.outputContext, "context", "C", -1, "output NUM lines of context around changes")
 	releaseCmd.Flags().BoolVar(&diff.includeTests, "include-tests", false, "enable the diffing of the helm test hooks")
 	releaseCmd.Flags().StringVar(&diff.output, "output", "diff", "Possible values: diff, simple, template. When set to \"template\", use the env var HELM_DIFF_TPL to specify the template.")
+	releaseCmd.Flags().BoolVar(&diff.stripTrailingCR, "strip-trailing-cr", false, "strip trailing carriage return on input")
+	releaseCmd.Flags().BoolVar(&diff.normalizeManifests, "normalize-manifests", false, "normalize manifests before running diff to exclude style differences from the output")
 
 	releaseCmd.SuggestionsMinimumDistance = 1
 
@@ -115,12 +119,13 @@ func (d *release) differentiateHelm3() error {
 
 	if releaseChart1 == releaseChart2 {
 		seenAnyChanges := diff.Releases(
-			manifest.Parse(string(releaseResponse1), namespace, excludes...),
-			manifest.Parse(string(releaseResponse2), namespace, excludes...),
+			manifest.Parse(string(releaseResponse1), namespace, d.normalizeManifests, excludes...),
+			manifest.Parse(string(releaseResponse2), namespace, d.normalizeManifests, excludes...),
 			d.suppressedKinds,
 			d.showSecrets,
 			d.outputContext,
 			d.output,
+			d.stripTrailingCR,
 			os.Stdout)
 
 		if d.detailedExitCode && seenAnyChanges {
@@ -149,12 +154,13 @@ func (d *release) differentiate() error {
 
 	if releaseResponse1.Release.Chart.Metadata.Name == releaseResponse2.Release.Chart.Metadata.Name {
 		seenAnyChanges := diff.Releases(
-			manifest.ParseRelease(releaseResponse1.Release, d.includeTests),
-			manifest.ParseRelease(releaseResponse2.Release, d.includeTests),
+			manifest.ParseRelease(releaseResponse1.Release, d.includeTests, d.normalizeManifests),
+			manifest.ParseRelease(releaseResponse2.Release, d.includeTests, d.normalizeManifests),
 			d.suppressedKinds,
 			d.showSecrets,
 			d.outputContext,
 			d.output,
+			d.stripTrailingCR,
 			os.Stdout)
 
 		if d.detailedExitCode && seenAnyChanges {

cmd/revision.go

@@ -14,15 +14,17 @@ import (
 )
 
 type revision struct {
-	release          string
-	client           helm.Interface
-	detailedExitCode bool
-	suppressedKinds  []string
-	revisions        []string
-	outputContext    int
-	includeTests     bool
-	showSecrets      bool
-	output           string
+	release            string
+	client             helm.Interface
+	detailedExitCode   bool
+	suppressedKinds    []string
+	revisions          []string
+	outputContext      int
+	includeTests       bool
+	showSecrets        bool
+	output             string
+	stripTrailingCR    bool
+	normalizeManifests bool
 }
 
 const revisionCmdLongUsage = `
@@ -89,6 +91,8 @@ func revisionCmd() *cobra.Command {
 	revisionCmd.Flags().IntVarP(&diff.outputContext, "context", "C", -1, "output NUM lines of context around changes")
 	revisionCmd.Flags().BoolVar(&diff.includeTests, "include-tests", false, "enable the diffing of the helm test hooks")
 	revisionCmd.Flags().StringVar(&diff.output, "output", "diff", "Possible values: diff, simple, template. When set to \"template\", use the env var HELM_DIFF_TPL to specify the template.")
+	revisionCmd.Flags().BoolVar(&diff.stripTrailingCR, "strip-trailing-cr", false, "strip trailing carriage return on input")
+	revisionCmd.Flags().BoolVar(&diff.normalizeManifests, "normalize-manifests", false, "normalize manifests before running diff to exclude style differences from the output")
 
 	revisionCmd.SuggestionsMinimumDistance = 1
 
@@ -120,12 +124,13 @@ func (d *revision) differentiateHelm3() error {
 		}
 
 		diff.Manifests(
-			manifest.Parse(string(revisionResponse), namespace, excludes...),
-			manifest.Parse(string(releaseResponse), namespace, excludes...),
+			manifest.Parse(string(revisionResponse), namespace, d.normalizeManifests, excludes...),
+			manifest.Parse(string(releaseResponse), namespace, d.normalizeManifests, excludes...),
 			d.suppressedKinds,
 			d.showSecrets,
 			d.outputContext,
 			d.output,
+			d.stripTrailingCR,
 			os.Stdout)
 
 	case 2:
@@ -146,12 +151,13 @@ func (d *revision) differentiateHelm3() error {
 		}
 
 		seenAnyChanges := diff.Manifests(
-			manifest.Parse(string(revisionResponse1), namespace, excludes...),
-			manifest.Parse(string(revisionResponse2), namespace, excludes...),
+			manifest.Parse(string(revisionResponse1), namespace, d.normalizeManifests, excludes...),
+			manifest.Parse(string(revisionResponse2), namespace, d.normalizeManifests, excludes...),
 			d.suppressedKinds,
 			d.showSecrets,
 			d.outputContext,
 			d.output,
+			d.stripTrailingCR,
 			os.Stdout)
 
 		if d.detailedExitCode && seenAnyChanges {
@@ -185,12 +191,13 @@ func (d *revision) differentiate() error {
 		}
 
 		diff.Manifests(
-			manifest.ParseRelease(revisionResponse.Release, d.includeTests),
-			manifest.ParseRelease(releaseResponse.Release, d.includeTests),
+			manifest.ParseRelease(revisionResponse.Release, d.includeTests, d.normalizeManifests),
+			manifest.ParseRelease(releaseResponse.Release, d.includeTests, d.normalizeManifests),
 			d.suppressedKinds,
 			d.showSecrets,
 			d.outputContext,
 			d.output,
+			d.stripTrailingCR,
 			os.Stdout)
 
 	case 2:
@@ -211,12 +218,13 @@ func (d *revision) differentiate() error {
 		}
 
 		seenAnyChanges := diff.Manifests(
-			manifest.ParseRelease(revisionResponse1.Release, d.includeTests),
-			manifest.ParseRelease(revisionResponse2.Release, d.includeTests),
+			manifest.ParseRelease(revisionResponse1.Release, d.includeTests, d.normalizeManifests),
+			manifest.ParseRelease(revisionResponse2.Release, d.includeTests, d.normalizeManifests),
 			d.suppressedKinds,
 			d.showSecrets,
 			d.outputContext,
 			d.output,
+			d.stripTrailingCR,
 			os.Stdout)
 
 		if d.detailedExitCode && seenAnyChanges {

cmd/rollback.go

@@ -14,15 +14,17 @@ import (
 )
 
 type rollback struct {
-	release          string
-	client           helm.Interface
-	detailedExitCode bool
-	suppressedKinds  []string
-	revisions        []string
-	outputContext    int
-	includeTests     bool
-	showSecrets      bool
-	output           string
+	release            string
+	client             helm.Interface
+	detailedExitCode   bool
+	suppressedKinds    []string
+	revisions          []string
+	outputContext      int
+	includeTests       bool
+	showSecrets        bool
+	output             string
+	stripTrailingCR    bool
+	normalizeManifests bool
 }
 
 const rollbackCmdLongUsage = `
@@ -81,6 +83,8 @@ func rollbackCmd() *cobra.Command {
 	rollbackCmd.Flags().IntVarP(&diff.outputContext, "context", "C", -1, "output NUM lines of context around changes")
 	rollbackCmd.Flags().BoolVar(&diff.includeTests, "include-tests", false, "enable the diffing of the helm test hooks")
 	rollbackCmd.Flags().StringVar(&diff.output, "output", "diff", "Possible values: diff, simple, template. When set to \"template\", use the env var HELM_DIFF_TPL to specify the template.")
+	rollbackCmd.Flags().BoolVar(&diff.stripTrailingCR, "strip-trailing-cr", false, "strip trailing carriage return on input")
+	rollbackCmd.Flags().BoolVar(&diff.normalizeManifests, "normalize-manifests", false, "normalize manifests before running diff to exclude style differences from the output")
 
 	rollbackCmd.SuggestionsMinimumDistance = 1
 
@@ -113,12 +117,13 @@ func (d *rollback) backcastHelm3() error {
 
 	// create a diff between the current manifest and the version of the manifest that a user is intended to rollback
 	seenAnyChanges := diff.Manifests(
-		manifest.Parse(string(releaseResponse), namespace, excludes...),
-		manifest.Parse(string(revisionResponse), namespace, excludes...),
+		manifest.Parse(string(releaseResponse), namespace, d.normalizeManifests, excludes...),
+		manifest.Parse(string(revisionResponse), namespace, d.normalizeManifests, excludes...),
 		d.suppressedKinds,
 		d.showSecrets,
 		d.outputContext,
 		d.output,
+		d.stripTrailingCR,
 		os.Stdout)
 
 	if d.detailedExitCode && seenAnyChanges {
@@ -149,12 +154,13 @@ func (d *rollback) backcast() error {
 
 	// create a diff between the current manifest and the version of the manifest that a user is intended to rollback
 	seenAnyChanges := diff.Manifests(
-		manifest.ParseRelease(releaseResponse.Release, d.includeTests),
-		manifest.ParseRelease(revisionResponse.Release, d.includeTests),
+		manifest.ParseRelease(releaseResponse.Release, d.includeTests, d.normalizeManifests),
+		manifest.ParseRelease(revisionResponse.Release, d.includeTests, d.normalizeManifests),
 		d.suppressedKinds,
 		d.showSecrets,
 		d.outputContext,
 		d.output,
+		d.stripTrailingCR,
 		os.Stdout)
 
 	if d.detailedExitCode && seenAnyChanges {

cmd/root.go

@@ -1,8 +1,11 @@
 package cmd
 
 import (
+	"os"
+
 	"github.com/mgutz/ansi"
 	"github.com/spf13/cobra"
+	"golang.org/x/crypto/ssh/terminal"
 )
 
 const rootCmdLongUsage = `
@@ -40,6 +43,8 @@ func New() *cobra.Command {
 		PersistentPreRun: func(cmd *cobra.Command, args []string) {
 			if nc, _ := cmd.Flags().GetBool("no-color"); nc {
 				ansi.DisableColors(true)
+			} else if !cmd.Flags().Changed("no-color") {
+				ansi.DisableColors(!terminal.IsTerminal(int(os.Stdout.Fd())))
 			}
 		},
 		RunE: func(cmd *cobra.Command, args []string) error {