remove duplicate annotation in nats statefulset (#2176)

* Update statefulset.yaml combined config from two metadata.annotations * update nats statefulset annotation work * add basic annotation tests * add key assertion * fix pre-commit * fix test failures --------- Co-authored-by: pgvishnuram <vishnu@astronomer.io> Co-authored-by: Rishabh Karajgi <rishabh.karajgi@gmail.com>
astronomer · Apr 8, 2024 · a3d90ec · a3d90ec
1 parent 385f524
commit a3d90ec
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 7 deletions.
diff --git a/charts/nats/templates/statefulset.yaml b/charts/nats/templates/statefulset.yaml
@@ -22,8 +22,11 @@ spec:
   serviceName: {{ template "nats.name" . }}
   template:
     metadata:
-      {{- if or .Values.podAnnotations .Values.exporter.enabled }}
       annotations:
+        checksum/nats-config: {{ include (print $.Template.BasePath "/configmap.yaml") . | sha256sum }}
+      {{- if and  .Values.global.nats.jetStream.enabled .Values.global.nats.jetStream.tls }}
+        checksum/nats-tls: {{ include (print $.Template.BasePath "/nats-jetstream-tls-secret.yaml") . | sha256sum }}
+      {{- end }}
       {{- if .Values.exporter.enabled }}
         prometheus.io/path: /metrics
         prometheus.io/port: "7777"
@@ -32,19 +35,13 @@ spec:
       {{- range $key, $value := .Values.podAnnotations }}
         {{ $key }}: {{ $value | quote }}
       {{- end }}
-      {{- end }}
       labels:
         tier: astronomer
         app: {{ template "nats.name" . }}
         version: {{ .Chart.Version }}
         release: {{ .Release.Name }}
         component: nats
         chart: {{ .Chart.Name }}-{{ .Chart.Version | replace "+" "_" }}
-      annotations:
-        {{- if and  .Values.global.nats.jetStream.enabled .Values.global.nats.jetStream.tls }}
-        checksum/nats-tls: {{ include (print $.Template.BasePath "/nats-jetstream-tls-secret.yaml") . | sha256sum }}
-        {{- end }}
-        checksum/nats-config: {{ include (print $.Template.BasePath "/configmap.yaml") . | sha256sum }}
     spec:
 {{- include "nats.imagePullSecrets" . | indent 6 }}
 {{- if eq .Values.global.openshiftEnabled false }}

diff --git a/tests/chart_tests/test_nats_sts.py b/tests/chart_tests/test_nats_sts.py
@@ -203,3 +203,40 @@ def test_nats_statefulset_with_default_cluster_name_overrides(self, kube_version
 
         nats_cm = docs[0]["data"]["nats.conf"]
         assert "release-name-astronats" in nats_cm
+
+    def test_nats_statefulset_template_annotation_defaults(self, kube_version):
+        """Test that nats template default annotations."""
+        docs = render_chart(
+            kube_version=kube_version,
+            show_only=["charts/nats/templates/statefulset.yaml"],
+        )
+        doc = docs[0]
+        assert set(
+            {
+                "checksum/nats-config": "8173240e8d81e0c797b3ce1c4a97b3031176e057483524bc185419df1d52b54a",
+                "prometheus.io/path": "/metrics",
+                "prometheus.io/port": "7777",
+                "prometheus.io/scrape": "true",
+            }.keys()
+        ) == set(doc["spec"]["template"]["metadata"]["annotations"].keys())
+
+    def test_nats_statefulset_template_annotation_with_podAnnotations_overrides(
+        self, kube_version
+    ):
+        """Test that nats template default annotations."""
+        docs = render_chart(
+            kube_version=kube_version,
+            show_only=["charts/nats/templates/statefulset.yaml"],
+            values={
+                "nats": {
+                    "podAnnotations": {
+                        "app.test.io": "sampleannotation",
+                    }
+                }
+            },
+        )
+        doc = docs[0]
+        assert (
+            "sampleannotation"
+            in doc["spec"]["template"]["metadata"]["annotations"]["app.test.io"]
+        )