Fix newlines / whitespace trimming if opsrecipe is *not* specified or…

… a dashboard *is* specified (#1411)
giantswarm · Oct 11, 2023 · b84b570 · b84b570
1 parent c11309f
commit b84b570
Show file tree

Hide file tree

Showing 8 changed files with 43 additions and 17 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -110,6 +110,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Support absolute Grafana dashboard URLs.
 - Fix api server url in case the CAPI provider sets https prefix in the CAPI CR status.
+- Alert template: fix newlines / whitespace trimming if opsrecipe is *not* specified or a dashboard *is* specified
 
 ## [4.48.0] - 2023-09-19
 

diff --git a/files/templates/alertmanager/notification-template.tmpl b/files/templates/alertmanager/notification-template.tmpl
@@ -35,9 +35,13 @@
 
 ---
 
-{{ if (index .Alerts 0).Annotations.opsrecipe }}📗 Runbook: {{ template "__runbookurl" . }}{{- end }}
+{{ if (index .Alerts 0).Annotations.opsrecipe -}}
+📗 Runbook: {{ template "__runbookurl" . }}
+{{ end -}}
 🔔 Alertmanager {{ template "__alertmanagerurl" . }}
-{{- if (index .Alerts 0).Annotations.dashboard }}📈 Dashboard: {{ template "__dashboardurl" . }}{{- end }}
+{{ if (index .Alerts 0).Annotations.dashboard -}}
+📈 Dashboard: {{ template "__dashboardurl" . }}
+{{ end -}}
 👀 Prometheus: {{ (index .Alerts 0).GeneratorURL }}
 
 ---

diff --git a/pkg/unittest/unittest.go b/pkg/unittest/unittest.go
@@ -106,7 +106,8 @@ func NewRunner(config Config) (*Runner, error) {
 func (r *Runner) Run() error {
 	for _, file := range r.files {
 		r.T.Run(file.Name(), func(t *testing.T) {
-			input, err := inputValue(filepath.Join(r.inputDir, file.Name()))
+			inputFilePath := filepath.Join(r.inputDir, file.Name())
+			input, err := inputValue(inputFilePath)
 			if err != nil {
 				t.Fatal(err)
 			}
@@ -126,21 +127,21 @@ func (r *Runner) Run() error {
 				}
 			}
 
-			outputFile := filepath.Join(r.OutputDir, file.Name())
+			outputFilePath := filepath.Join(r.OutputDir, file.Name())
 			if r.Update {
-				err := os.WriteFile(outputFile, testResult, 0644) // #nosec
+				err := os.WriteFile(outputFilePath, testResult, 0644) // #nosec
 				if err != nil {
 					t.Fatal(err)
 				}
 			}
 
-			output, err := os.ReadFile(outputFile)
+			output, err := os.ReadFile(outputFilePath)
 			if err != nil {
 				t.Fatal(err)
 			}
 
 			if !bytes.Equal(testResult, output) {
-				t.Fatalf("\n\n%s\n", cmp.Diff(string(output), string(testResult)))
+				t.Fatalf("Rendered output does not match (input: %s, expected output: %s)\n\n%s\n", inputFilePath, outputFilePath, cmp.Diff(string(output), string(testResult)))
 			}
 		})
 	}

diff --git a/.../resource/alerting/alertmanagerconfig/test/notification-template/case-1-vintage-mc.golden b/.../resource/alerting/alertmanagerconfig/test/notification-template/case-1-vintage-mc.golden
@@ -35,9 +35,13 @@
 
 ---
 
-{{ if (index .Alerts 0).Annotations.opsrecipe }}📗 Runbook: {{ template "__runbookurl" . }}{{- end }}
+{{ if (index .Alerts 0).Annotations.opsrecipe -}}
+📗 Runbook: {{ template "__runbookurl" . }}
+{{ end -}}
 🔔 Alertmanager {{ template "__alertmanagerurl" . }}
-{{- if (index .Alerts 0).Annotations.dashboard }}📈 Dashboard: {{ template "__dashboardurl" . }}{{- end }}
+{{ if (index .Alerts 0).Annotations.dashboard -}}
+📈 Dashboard: {{ template "__dashboardurl" . }}
+{{ end -}}
 👀 Prometheus: {{ (index .Alerts 0).GeneratorURL }}
 
 ---

diff --git a/...ler/resource/alerting/alertmanagerconfig/test/notification-template/case-2-aws-v16.golden b/...ler/resource/alerting/alertmanagerconfig/test/notification-template/case-2-aws-v16.golden
@@ -35,9 +35,13 @@
 
 ---
 
-{{ if (index .Alerts 0).Annotations.opsrecipe }}📗 Runbook: {{ template "__runbookurl" . }}{{- end }}
+{{ if (index .Alerts 0).Annotations.opsrecipe -}}
+📗 Runbook: {{ template "__runbookurl" . }}
+{{ end -}}
 🔔 Alertmanager {{ template "__alertmanagerurl" . }}
-{{- if (index .Alerts 0).Annotations.dashboard }}📈 Dashboard: {{ template "__dashboardurl" . }}{{- end }}
+{{ if (index .Alerts 0).Annotations.dashboard -}}
+📈 Dashboard: {{ template "__dashboardurl" . }}
+{{ end -}}
 👀 Prometheus: {{ (index .Alerts 0).GeneratorURL }}
 
 ---

diff --git a/...ler/resource/alerting/alertmanagerconfig/test/notification-template/case-3-aws-v18.golden b/...ler/resource/alerting/alertmanagerconfig/test/notification-template/case-3-aws-v18.golden
@@ -35,9 +35,13 @@
 
 ---
 
-{{ if (index .Alerts 0).Annotations.opsrecipe }}📗 Runbook: {{ template "__runbookurl" . }}{{- end }}
+{{ if (index .Alerts 0).Annotations.opsrecipe -}}
+📗 Runbook: {{ template "__runbookurl" . }}
+{{ end -}}
 🔔 Alertmanager {{ template "__alertmanagerurl" . }}
-{{- if (index .Alerts 0).Annotations.dashboard }}📈 Dashboard: {{ template "__dashboardurl" . }}{{- end }}
+{{ if (index .Alerts 0).Annotations.dashboard -}}
+📈 Dashboard: {{ template "__dashboardurl" . }}
+{{ end -}}
 👀 Prometheus: {{ (index .Alerts 0).GeneratorURL }}
 
 ---

diff --git a/...r/resource/alerting/alertmanagerconfig/test/notification-template/case-4-azure-v18.golden b/...r/resource/alerting/alertmanagerconfig/test/notification-template/case-4-azure-v18.golden
@@ -35,9 +35,13 @@
 
 ---
 
-{{ if (index .Alerts 0).Annotations.opsrecipe }}📗 Runbook: {{ template "__runbookurl" . }}{{- end }}
+{{ if (index .Alerts 0).Annotations.opsrecipe -}}
+📗 Runbook: {{ template "__runbookurl" . }}
+{{ end -}}
 🔔 Alertmanager {{ template "__alertmanagerurl" . }}
-{{- if (index .Alerts 0).Annotations.dashboard }}📈 Dashboard: {{ template "__dashboardurl" . }}{{- end }}
+{{ if (index .Alerts 0).Annotations.dashboard -}}
+📈 Dashboard: {{ template "__dashboardurl" . }}
+{{ end -}}
 👀 Prometheus: {{ (index .Alerts 0).GeneratorURL }}
 
 ---

diff --git a/...ler/resource/alerting/alertmanagerconfig/test/notification-template/case-5-eks-v18.golden b/...ler/resource/alerting/alertmanagerconfig/test/notification-template/case-5-eks-v18.golden
@@ -35,9 +35,13 @@
 
 ---
 
-{{ if (index .Alerts 0).Annotations.opsrecipe }}📗 Runbook: {{ template "__runbookurl" . }}{{- end }}
+{{ if (index .Alerts 0).Annotations.opsrecipe -}}
+📗 Runbook: {{ template "__runbookurl" . }}
+{{ end -}}
 🔔 Alertmanager {{ template "__alertmanagerurl" . }}
-{{- if (index .Alerts 0).Annotations.dashboard }}📈 Dashboard: {{ template "__dashboardurl" . }}{{- end }}
+{{ if (index .Alerts 0).Annotations.dashboard -}}
+📈 Dashboard: {{ template "__dashboardurl" . }}
+{{ end -}}
 👀 Prometheus: {{ (index .Alerts 0).GeneratorURL }}
 
 ---