Support --include-tests in helm3 mode

Signed-off-by: Jonas Rutishauser <[email protected]>

Author: jonasrutishauser

cmd/helpers.go

@@ -16,6 +16,9 @@ const (
 	tlsCaCertDefault = "$HELM_HOME/ca.pem"
 	tlsCertDefault   = "$HELM_HOME/cert.pem"
 	tlsKeyDefault    = "$HELM_HOME/key.pem"
+
+	helm2TestSuccessHook = "test-success"
+	helm3TestHook        = "test"
 )
 
 var (

cmd/release.go

@@ -73,9 +73,7 @@ func releaseCmd() *cobra.Command {
 	releaseCmd.Flags().BoolP("suppress-secrets", "q", false, "suppress secrets in the output")
 	releaseCmd.Flags().StringArrayVar(&diff.suppressedKinds, "suppress", []string{}, "allows suppression of the values listed in the diff output")
 	releaseCmd.Flags().IntVarP(&diff.outputContext, "context", "C", -1, "output NUM lines of context around changes")
-	if !isHelm3() {
-		releaseCmd.Flags().BoolVar(&diff.includeTests, "include-tests", false, "enable the diffing of the helm test hooks")
-	}
+	releaseCmd.Flags().BoolVar(&diff.includeTests, "include-tests", false, "enable the diffing of the helm test hooks")
 	releaseCmd.SuggestionsMinimumDistance = 1
 
 	if !isHelm3() {
@@ -86,28 +84,33 @@ func releaseCmd() *cobra.Command {
 }
 
 func (d *release) differentiateHelm3() error {
-	releaseResponse1, err := getRelease(d.releases[0], "")
+	namespace := os.Getenv("HELM_NAMESPACE")
+	excludes := []string{helm3TestHook, helm2TestSuccessHook}
+	if d.includeTests {
+		excludes = []string{}
+	}
+	releaseResponse1, err := getRelease(d.releases[0], namespace)
 	if err != nil {
 		return err
 	}
-	releaseChart1, err := getChart(d.releases[0], "")
+	releaseChart1, err := getChart(d.releases[0], namespace)
 	if err != nil {
 		return err
 	}
 
-	releaseResponse2, err := getRelease(d.releases[1], "")
+	releaseResponse2, err := getRelease(d.releases[1], namespace)
 	if err != nil {
 		return err
 	}
-	releaseChart2, err := getChart(d.releases[1], "")
+	releaseChart2, err := getChart(d.releases[1], namespace)
 	if err != nil {
 		return err
 	}
 
 	if releaseChart1 == releaseChart2 {
 		seenAnyChanges := diff.Releases(
-			manifest.Parse(string(releaseResponse1), ""),
-			manifest.Parse(string(releaseResponse2), ""),
+			manifest.Parse(string(releaseResponse1), namespace, excludes...),
+			manifest.Parse(string(releaseResponse2), namespace, excludes...),
 			d.suppressedKinds,
 			d.outputContext,
 			os.Stdout)

cmd/revision.go

@@ -83,9 +83,7 @@ func revisionCmd() *cobra.Command {
 	revisionCmd.Flags().BoolP("suppress-secrets", "q", false, "suppress secrets in the output")
 	revisionCmd.Flags().StringArrayVar(&diff.suppressedKinds, "suppress", []string{}, "allows suppression of the values listed in the diff output")
 	revisionCmd.Flags().IntVarP(&diff.outputContext, "context", "C", -1, "output NUM lines of context around changes")
-	if !isHelm3() {
-		revisionCmd.Flags().BoolVar(&diff.includeTests, "include-tests", false, "enable the diffing of the helm test hooks")
-	}
+	revisionCmd.Flags().BoolVar(&diff.includeTests, "include-tests", false, "enable the diffing of the helm test hooks")
 	revisionCmd.SuggestionsMinimumDistance = 1
 
 	if !isHelm3() {
@@ -96,23 +94,28 @@ func revisionCmd() *cobra.Command {
 }
 
 func (d *revision) differentiateHelm3() error {
+	namespace := os.Getenv("HELM_NAMESPACE")
+	excludes := []string{helm3TestHook, helm2TestSuccessHook}
+	if d.includeTests {
+		excludes = []string{}
+	}
 	switch len(d.revisions) {
 	case 1:
-		releaseResponse, err := getRelease(d.release, "")
+		releaseResponse, err := getRelease(d.release, namespace)
 
 		if err != nil {
 			return err
 		}
 
 		revision, _ := strconv.Atoi(d.revisions[0])
-		revisionResponse, err := getRevision(d.release, revision, "")
+		revisionResponse, err := getRevision(d.release, revision, namespace)
 		if err != nil {
 			return err
 		}
 
 		diff.Manifests(
-			manifest.Parse(string(revisionResponse), ""),
-			manifest.Parse(string(releaseResponse), ""),
+			manifest.Parse(string(revisionResponse), namespace, excludes...),
+			manifest.Parse(string(releaseResponse), namespace, excludes...),
 			d.suppressedKinds,
 			d.outputContext,
 			os.Stdout)
@@ -124,19 +127,19 @@ func (d *revision) differentiateHelm3() error {
 			revision1, revision2 = revision2, revision1
 		}
 
-		revisionResponse1, err := getRevision(d.release, revision1, "")
+		revisionResponse1, err := getRevision(d.release, revision1, namespace)
 		if err != nil {
 			return prettyError(err)
 		}
 
-		revisionResponse2, err := getRevision(d.release, revision2, "")
+		revisionResponse2, err := getRevision(d.release, revision2, namespace)
 		if err != nil {
 			return prettyError(err)
 		}
 
 		seenAnyChanges := diff.Manifests(
-			manifest.Parse(string(revisionResponse1), ""),
-			manifest.Parse(string(revisionResponse2), ""),
+			manifest.Parse(string(revisionResponse1), namespace, excludes...),
+			manifest.Parse(string(revisionResponse2), namespace, excludes...),
 			d.suppressedKinds,
 			d.outputContext,
 			os.Stdout)

cmd/rollback.go

@@ -75,9 +75,7 @@ func rollbackCmd() *cobra.Command {
 	rollbackCmd.Flags().BoolP("suppress-secrets", "q", false, "suppress secrets in the output")
 	rollbackCmd.Flags().StringArrayVar(&diff.suppressedKinds, "suppress", []string{}, "allows suppression of the values listed in the diff output")
 	rollbackCmd.Flags().IntVarP(&diff.outputContext, "context", "C", -1, "output NUM lines of context around changes")
-	if !isHelm3() {
-		rollbackCmd.Flags().BoolVar(&diff.includeTests, "include-tests", false, "enable the diffing of the helm test hooks")
-	}
+	rollbackCmd.Flags().BoolVar(&diff.includeTests, "include-tests", false, "enable the diffing of the helm test hooks")
 	rollbackCmd.SuggestionsMinimumDistance = 1
 
 	if !isHelm3() {
@@ -88,24 +86,29 @@ func rollbackCmd() *cobra.Command {
 }
 
 func (d *rollback) backcastHelm3() error {
+	namespace := os.Getenv("HELM_NAMESPACE")
+	excludes := []string{helm3TestHook, helm2TestSuccessHook}
+	if d.includeTests {
+		excludes = []string{}
+	}
 	// get manifest of the latest release
-	releaseResponse, err := getRelease(d.release, "")
+	releaseResponse, err := getRelease(d.release, namespace)
 
 	if err != nil {
 		return err
 	}
 
 	// get manifest of the release to rollback
 	revision, _ := strconv.Atoi(d.revisions[0])
-	revisionResponse, err := getRevision(d.release, revision, "")
+	revisionResponse, err := getRevision(d.release, revision, namespace)
 	if err != nil {
 		return err
 	}
 
 	// 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), ""),
-		manifest.Parse(string(revisionResponse), ""),
+		manifest.Parse(string(releaseResponse), namespace, excludes...),
+		manifest.Parse(string(revisionResponse), namespace, excludes...),
 		d.suppressedKinds,
 		d.outputContext,
 		os.Stdout)

cmd/upgrade.go

@@ -91,9 +91,7 @@ func newChartCommand() *cobra.Command {
 	f.BoolVar(&diff.resetValues, "reset-values", false, "reset the values to the ones built into the chart and merge in any new values")
 	f.BoolVar(&diff.allowUnreleased, "allow-unreleased", false, "enables diffing of releases that are not yet deployed via Helm")
 	f.BoolVar(&diff.noHooks, "no-hooks", false, "disable diffing of hooks")
-	if !isHelm3() {
-		f.BoolVar(&diff.includeTests, "include-tests", false, "enable the diffing of the helm test hooks")
-	}
+	f.BoolVar(&diff.includeTests, "include-tests", false, "enable the diffing of the helm test hooks")
 	f.BoolVar(&diff.devel, "devel", false, "use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored.")
 	f.StringArrayVar(&diff.suppressedKinds, "suppress", []string{}, "allows suppression of the values listed in the diff output")
 	f.IntVarP(&diff.outputContext, "context", "C", -1, "output NUM lines of context around changes")
@@ -141,9 +139,18 @@ func (d *diffCmd) runHelm3() error {
 			}
 			releaseManifest = append(releaseManifest, hooks...)
 		}
-		currentSpecs = manifest.Parse(string(releaseManifest), d.namespace)
+		if d.includeTests {
+			currentSpecs = manifest.Parse(string(releaseManifest), d.namespace)
+		} else {
+			currentSpecs = manifest.Parse(string(releaseManifest), d.namespace, helm3TestHook, helm2TestSuccessHook)
+		}
+	}
+	var newSpecs map[string]*manifest.MappingResult
+	if d.includeTests {
+		newSpecs = manifest.Parse(string(installManifest), d.namespace)
+	} else {
+		newSpecs = manifest.Parse(string(installManifest), d.namespace, helm3TestHook, helm2TestSuccessHook)
 	}
-	newSpecs := manifest.Parse(string(installManifest), d.namespace)
 
 	seenAnyChanges := diff.Manifests(currentSpecs, newSpecs, d.suppressedKinds, d.outputContext, os.Stdout)
 

manifest/parse.go

@@ -11,6 +11,10 @@ import (
 	"k8s.io/helm/pkg/proto/hapi/release"
 )
 
+const (
+	hookAnnotation = "helm.sh/hook"
+)
+
 var yamlSeperator = []byte("\n---\n")
 
 // MappingResult to store result of diff
@@ -24,8 +28,9 @@ type metadata struct {
 	APIVersion string `yaml:"apiVersion"`
 	Kind       string
 	Metadata   struct {
-		Namespace string
-		Name      string
+		Namespace   string
+		Name        string
+		Annotations map[string]string
 	}
 }
 
@@ -78,7 +83,7 @@ func ParseRelease(release *release.Release, includeTests bool) map[string]*Mappi
 }
 
 // Parse parses manifest strings into MappingResult
-func Parse(manifest string, defaultNamespace string) map[string]*MappingResult {
+func Parse(manifest string, defaultNamespace string, excludedHooks ...string) map[string]*MappingResult {
 	scanner := bufio.NewScanner(strings.NewReader(manifest))
 	scanner.Split(scanYamlSpecs)
 	//Allow for tokens (specs) up to 1M in size
@@ -100,7 +105,10 @@ func Parse(manifest string, defaultNamespace string) map[string]*MappingResult {
 
 		//Skip content without any metadata.  It is probably a template that
 		//only contains comments in the current state.
-		if (metadata{}) == parsedMetadata {
+		if parsedMetadata.APIVersion == "" && parsedMetadata.Kind == "" {
+			continue
+		}
+		if isHook(parsedMetadata, excludedHooks...) {
 			continue
 		}
 
@@ -124,6 +132,15 @@ func Parse(manifest string, defaultNamespace string) map[string]*MappingResult {
 	return result
 }
 
+func isHook(metadata metadata, hooks ...string) bool {
+	for _, hook := range hooks {
+		if metadata.Metadata.Annotations[hookAnnotation] == hook {
+			return true
+		}
+	}
+	return false
+}
+
 func isTestHook(hookEvents []release.Hook_Event) bool {
 	for _, event := range hookEvents {
 		if event == release.Hook_RELEASE_TEST_FAILURE || event == release.Hook_RELEASE_TEST_SUCCESS {

manifest/parse_test.go

@@ -39,6 +39,26 @@ func TestPodNamespace(t *testing.T) {
 	)
 }
 
+func TestPodHook(t *testing.T) {
+	spec, err := ioutil.ReadFile("testdata/pod_hook.yaml")
+	require.NoError(t, err)
+
+	require.Equal(t,
+		[]string{"default, nginx, Pod (v1)"},
+		foundObjects(Parse(string(spec), "default")),
+	)
+
+	require.Equal(t,
+		[]string{"default, nginx, Pod (v1)"},
+		foundObjects(Parse(string(spec), "default", "test-success")),
+	)
+
+	require.Equal(t,
+		[]string{},
+		foundObjects(Parse(string(spec), "default", "test")),
+	)
+}
+
 func TestDeployV1(t *testing.T) {
 	spec, err := ioutil.ReadFile("testdata/deploy_v1.yaml")
 	require.NoError(t, err)

manifest/testdata/pod_hook.yaml

@@ -0,0 +1,15 @@
+
+---
+# Source: nginx/pod.yaml
+apiVersion: v1
+kind: Pod
+metadata:
+  name: nginx
+  annotations:
+    helm.sh/hook: test
+spec:
+  containers:
+  - name: nginx
+    image: nginx:1.7.9
+    ports:
+    - containerPort: 80