feat: Add listen-helmfile-sync

Author: machine424

README.md

@@ -22,6 +22,7 @@ Diff without `collapse-helm-diff`:
 After hiding `image: docker.foo.fr...` diffs:
 
 ```
+  # Don't forget to set -o pipefail (in bash e.g.) to pervent helm diff errors from being masked.
   - helm diff | ./cicdbox collapse-helm-diff '^\s+-?image: docker\.foo\.fr' 
 ```
 
@@ -60,8 +61,8 @@ metadata:
   name: sh.helm.release.v1.SELECTED-RELEASE.v1
   ...
   annotations:
-    cicdbox/releaser: $GITLAB_USER_LOGIN
-    cicdbox/gitlab-ci-pipeline-url: $CI_PIPELINE_URL
+    cicdbox/releaser: username
+    cicdbox/gitlab-ci-pipeline-url: https://gitlab.foo.bar/foo/bar/foo/-/pipelines/173171
 ...
 ```
 
@@ -70,3 +71,19 @@ This can help understanding how a release ended up there, how to fix it, whom to
 `./cicdbox annotate-helmfile-releases --help` for more details.
 
 Supposes `helmfile` and `kubectl` are available.
+
+### listen-helm-debug
+
+Get Helm relevant `--debug` logs and hide the rest in a collapsed section, these logs can tell you for which resources Helm is waiting and provide users a fast feedback. No more `Help! my deploy job is stuck`
+
+Example:
+
+```
+  # Don't forget to set -o pipefail (in bash e.g.) to pervent helm diff errors from being masked.
+  # Don't forget to set the --debug flag
+  - helmfile --debug sync | ./cicdbox listen-helm-debug
+```
+
+The output would look like:
+
+![listen_helm_output](./images/listen_helm_output.png)

annotate_helmfile_releases_test.go

@@ -37,6 +37,7 @@ func TestAnnotateHelmfileReleases(t *testing.T) {
 		TEST SUITE: None
 		
 		`, []namespacedSecret{{namespace: "foo", secretName: "sh.helm.release.v1.bar.v5"}}},
+		{"no release", ``, []namespacedSecret(nil)},
 	}
 	for _, tc := range tt {
 		t.Run(tc.description, func(t *testing.T) {

collapse_helm_diff.go

@@ -3,7 +3,6 @@ package main
 import (
 	"bufio"
 	"flag"
-	"fmt"
 	"io"
 	"log"
 	"os"
@@ -13,18 +12,12 @@ import (
 )
 
 const (
-	COLOR_RESET   = "[0m"
-	RESOURCE_DIFF = "[0;33m"
+	COLOR_RESET   = "\x1b[0m"
+	RESOURCE_DIFF = "\x1b[0;33m"
 	ELLIPSIS      = "..."
-
-	COLLAPSED_SECTION_END = `\e[0Ksection_end:1664723888:section\r\e[0K`
 )
 
-var DIFF_COLOR_PREFIXES = []string{"-", "+"}
-
-func collapsedSectionStart(header string) string {
-	return fmt.Sprintf(`\e[0Ksection_start:1664723888:section[collapsed=true]\r\e[0K%s`, header)
-}
+var DIFF_COLOR_PREFIXES = []string{"\x1b[0;31m-", "\x1b[0;32m+"}
 
 func matchesPattern(str string, patterns []*regexp.Regexp) bool {
 	for _, pattern := range patterns {
@@ -67,20 +60,16 @@ func echo(w io.Writer, str string) {
 	}
 }
 
-func collapse(w io.Writer, diffs []string, patterns []*regexp.Regexp) {
-	if len(diffs) == 0 {
+func collapse(w io.Writer, lines []string, patterns []*regexp.Regexp) {
+	if len(lines) == 0 {
 		return
 	}
-	header, body := diffs[0], diffs[1:]
+	header, body := lines[0], lines[1:]
 	if matchesPattern(uncolor(header), patterns) {
 		header = ELLIPSIS
-		body = diffs
+		body = lines
 	}
-	echo(w, collapsedSectionStart(header))
-	for _, line := range body {
-		echo(w, line)
-	}
-	echo(w, COLLAPSED_SECTION_END)
+	echoCollapsed(w, header, body)
 }
 
 func processResourceDiff(w io.Writer, diffs []string, patterns []*regexp.Regexp) {
@@ -125,10 +114,7 @@ func collapseHelmDiff(input *bufio.Scanner, output io.Writer, args []string) {
 	}
 	patterns := make([]*regexp.Regexp, len(regexes))
 	for i, regex := range regexes {
-		pattern, err := regexp.Compile(regex)
-		if err != nil {
-			log.Fatal(err)
-		}
+		pattern := regexp.MustCompile(regex)
 		patterns[i] = pattern
 	}
 
@@ -144,7 +130,7 @@ func collapseHelmDiff(input *bufio.Scanner, output io.Writer, args []string) {
 	processResourceDiff(output, resourceDiff, patterns)
 
 	if err := input.Err(); err != nil {
-		log.Println(err)
+		log.Fatal(err)
 	}
 }
 

collapse_helm_diff_test.go

@@ -9,19 +9,13 @@ import (
 	"testing"
 )
 
-func check(e error) {
-	if e != nil {
-		panic(e)
-	}
-}
-
-func absolutePath(name string) string {
-	return fmt.Sprintf("files/collapse_helm_diff/%s", name)
+func absoluteTestPath(name string) string {
+	return fmt.Sprintf("files/%s", name)
 }
 
 func openFile(name string) *os.File {
 	file, err := os.Open(name)
-	check(err)
+	panicOnError(err)
 	return file
 }
 
@@ -31,6 +25,20 @@ func echoLines(input *bufio.Scanner, output io.Writer) {
 	}
 }
 
+func loadTestFiles(inputFilePath, expectFilePath string) (*bufio.Scanner, strings.Builder) {
+	// input (we d not close it explicitly)
+	inputFile := openFile(inputFilePath)
+	input := bufio.NewScanner(inputFile)
+
+	// expected output
+	expectFile := openFile(expectFilePath)
+	defer expectFile.Close()
+	var expect strings.Builder
+	echoLines(bufio.NewScanner(expectFile), &expect)
+
+	return input, expect
+}
+
 func TestEcho(t *testing.T) {
 	input := "foo-bar"
 	expect := fmt.Sprintf("%s\n", input)
@@ -41,36 +49,30 @@ func TestEcho(t *testing.T) {
 	}
 }
 
+func assertEqual(t *testing.T, expect, output strings.Builder) {
+	if expect.String() != output.String() {
+		t.Errorf("got %s but expected %s", output.String(), expect.String())
+	}
+}
+
 func TestCollapseHelmDiff(t *testing.T) {
 	tt := []struct {
 		description string
 		diff        string
 		args        []string
 		expect      string
 	}{
-		{"", absolutePath("diff_1.in"), []string{`bar`}, absolutePath("diff_1.outt")},
-		{"", absolutePath("diff_2.in"), []string{`^\s+-?image: docker\.foo\.fr`}, absolutePath("diff_2.outt")},
-		{"", absolutePath("diff_3.in"), []string{`^\s+-?image: docker\.foo\.fr`}, absolutePath("diff_3.outt")},
+		{"no diff", absoluteTestPath("diff_1.in"), []string{`bar`}, absoluteTestPath("diff_1.outt")},
+		{"diff to callapse", absoluteTestPath("diff_2.in"), []string{`^\s+-?image: docker\.foo\.fr`}, absoluteTestPath("diff_2.outt")},
+		{"diff to keep", absoluteTestPath("diff_3.in"), []string{`^\s+-?image: docker\.foo\.fr`}, absoluteTestPath("diff_3.outt")},
 	}
 	for _, tc := range tt {
 		t.Run(tc.description, func(t *testing.T) {
-			// input
-			diffInFile := openFile(tc.diff)
-			defer diffInFile.Close()
-			input := bufio.NewScanner(diffInFile)
-
-			// expected output
-			rawExpectInFile := openFile(tc.expect)
-			defer rawExpectInFile.Close()
-			var expect strings.Builder
-			echoLines(bufio.NewScanner(rawExpectInFile), &expect)
+			input, expect := loadTestFiles(tc.diff, tc.expect)
 
-			// run
 			var output strings.Builder
 			collapseHelmDiff(input, &output, tc.args)
-			if expect.String() != output.String() {
-				t.Errorf("got %s but expected %s", output.String(), expect.String())
-			}
+			assertEqual(t, expect, output)
 		})
 	}
 }

files/collapse_helm_diff/diff_1.in files/diff_1.in

@@ -0,0 +1,32 @@
+...
+foo:
+  nodeAffinity:
+    requiredDuringSchedulingIgnoredDuringExecution:
+      nodeSelectorTerms:
+      - matchExpressions:
+        - key: Preemptible
+          operator: In
+          values:
+          - "true"
+  podAnnotations:
+    cluster-autoscaler.kubernetes.io/safe-to-evict: "true"
+  tolerations:
+  - effect: NoSchedule
+    key: Preemptible
+    value: "true"
+Successfully generated the value file at values/per-environment/review-values.yaml.gotmpl. produced:
+worker:
+        replicaCount: 0
+Upgrading release=release, chart=chart
+exec: helm upgrade --install --debug ...
+helm:vaGzI> history.go:56: [debug] getting history for release release
+helm:vaGzI> upgrade.go:142: [debug] preparing upgrade for release
+helm:vaGzI> upgrade.go:499: [debug] resetting values to the chart's original version
+helm:vaGzI> coalesce.go:175: warning: skipped value for etcd-patroni.tolerations: Not a table.
+
+helm:vaGzI> upgrade.go:150: [debug] performing update for release
+helm:vaGzI> upgrade.go:322: [debug] creating upgraded release for release
+helm:vaGzI> client.go:310: [debug] Starting delete for "release-ephemeral" ServiceAccount
+helm:vaGzI> client.go:128: [debug] creating 1 resource(s)
+helm:vaGzI> client.go:310: [debug] Starting delete for "release-ephemeral" Secret
+...

files/collapse_helm_diff/diff_1.outt files/diff_1.outt

@@ -0,0 +1,43 @@
+\x1b[0;33mcicdbox: Only Helm debug logs will be displayed...\x1b[0m
+getting history for release release
+preparing upgrade for release
+resetting values to the chart's original version
+performing update for release
+creating upgraded release for release
+Starting delete for "release-ephemeral" ServiceAccount
+creating 1 resource(s)
+Starting delete for "release-ephemeral" Secret
+\e[0Ksection_start:1664723888:section[collapsed=true]\r\e[0K\x1b[0;33mExpand to see the entire output.\x1b[0m
+...
+foo:
+  nodeAffinity:
+    requiredDuringSchedulingIgnoredDuringExecution:
+      nodeSelectorTerms:
+      - matchExpressions:
+        - key: Preemptible
+          operator: In
+          values:
+          - "true"
+  podAnnotations:
+    cluster-autoscaler.kubernetes.io/safe-to-evict: "true"
+  tolerations:
+  - effect: NoSchedule
+    key: Preemptible
+    value: "true"
+Successfully generated the value file at values/per-environment/review-values.yaml.gotmpl. produced:
+worker:
+        replicaCount: 0
+Upgrading release=release, chart=chart
+exec: helm upgrade --install --debug ...
+helm:vaGzI> history.go:56: [debug] getting history for release release
+helm:vaGzI> upgrade.go:142: [debug] preparing upgrade for release
+helm:vaGzI> upgrade.go:499: [debug] resetting values to the chart's original version
+helm:vaGzI> coalesce.go:175: warning: skipped value for etcd-patroni.tolerations: Not a table.
+
+helm:vaGzI> upgrade.go:150: [debug] performing update for release
+helm:vaGzI> upgrade.go:322: [debug] creating upgraded release for release
+helm:vaGzI> client.go:310: [debug] Starting delete for "release-ephemeral" ServiceAccount
+helm:vaGzI> client.go:128: [debug] creating 1 resource(s)
+helm:vaGzI> client.go:310: [debug] Starting delete for "release-ephemeral" Secret
+...
+\e[0Ksection_end:1664723888:section\r\e[0K

files/collapse_helm_diff/diff_2.in files/diff_2.in

@@ -0,0 +1,2 @@
+foo
+bar

files/collapse_helm_diff/diff_2.outt files/diff_2.outt

@@ -0,0 +1,5 @@
+\x1b[0;33mcicdbox: Only Helm debug logs will be displayed...\x1b[0m
+\e[0Ksection_start:1664723888:section[collapsed=true]\r\e[0K\x1b[0;33mExpand to see the entire output.\x1b[0m
+foo
+bar
+\e[0Ksection_end:1664723888:section\r\e[0K

files/collapse_helm_diff/diff_3.in files/diff_3.in

@@ -0,0 +1,54 @@
+package main
+
+import (
+	"bufio"
+	"flag"
+	"io"
+	"log"
+	"os"
+	"regexp"
+)
+
+var debugLineRegex = regexp.MustCompile(`.+\[debug\]\s*(?P<debug_log>.*)$`)
+
+// TODO: also warnings?
+func printIfDebugLine(output io.Writer, line []byte) {
+	result := debugLineRegex.FindSubmatch(line)
+	if len(result) > 0 {
+		debugLog := result[len(result)-1]
+		_, err := output.Write(append(debugLog, []byte("\n")...))
+		panicOnError(err)
+	}
+}
+
+func listenHelmDebug(input *bufio.Scanner, output io.Writer, args []string) {
+	flag := flag.NewFlagSet(LISTEN_HELM_DEBUG_CMD_NAME, flag.ExitOnError)
+	err := flag.Parse(args)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	_, err = output.Write([]byte("\x1b[0;33mcicdbox: Only Helm debug logs will be displayed...\x1b[0m\n"))
+	panicOnError(err)
+
+	var outputToCollapse []string
+	for input.Scan() {
+		rawLine := input.Bytes()
+		// Keep for the end
+		outputToCollapse = append(outputToCollapse, string(rawLine))
+		printIfDebugLine(output, rawLine)
+	}
+	echoCollapsed(output, "\x1b[0;33mExpand to see the entire output.\x1b[0m", outputToCollapse)
+
+	if err := input.Err(); err != nil {
+		log.Fatal(err)
+	}
+}
+
+func ListenHelmDebug(args []string) {
+	// read stdin
+	input := bufio.NewScanner(os.Stdin)
+	// write to stdout
+	output := os.Stdout
+	listenHelmDebug(input, output, args)
+}

files/collapse_helm_diff/diff_3.outt files/diff_3.outt

@@ -0,0 +1,26 @@
+package main
+
+import (
+	"strings"
+	"testing"
+)
+
+func TestListenHelmDebug(t *testing.T) {
+	tt := []struct {
+		description string
+		diff        string
+		expect      string
+	}{
+		{"debug logs", absoluteTestPath("helm_debug_1.in"), absoluteTestPath("helm_debug_1.outt")},
+		{"no debug logs", absoluteTestPath("helm_debug_2.in"), absoluteTestPath("helm_debug_2.outt")},
+	}
+	for _, tc := range tt {
+		t.Run(tc.description, func(t *testing.T) {
+			input, expect := loadTestFiles(tc.diff, tc.expect)
+
+			var output strings.Builder
+			listenHelmDebug(input, &output, []string{})
+			assertEqual(t, expect, output)
+		})
+	}
+}