Added custom service account annotations test (#3803)

SumoLogic · Jul 18, 2024 · 2ea0cff · 2ea0cff
1 parent 8c9a6bf
commit 2ea0cff
Show file tree

Hide file tree

Showing 7 changed files with 71 additions and 1 deletion.
diff --git a/.changelog/3803.changed.txt b/.changelog/3803.changed.txt
@@ -0,0 +1 @@
+test: Added custom service account annotation tests for global configuration attributes
diff --git a/deploy/helm/sumologic/templates/logs/collector/common/serviceaccount.yaml b/deploy/helm/sumologic/templates/logs/collector/common/serviceaccount.yaml
@@ -7,6 +7,10 @@ metadata:
   labels:
     app: {{ template "sumologic.labels.app.logs.collector.serviceaccount" . }}
     {{- include "sumologic.labels.common" . | nindent 4 }}
+  {{- if .Values.sumologic.serviceAccount.annotations }}
+  annotations:
+  {{ toYaml .Values.sumologic.serviceAccount.annotations | indent 2 }}
+  {{- end }}
 {{- if .Values.sumologic.pullSecrets }}
 imagePullSecrets:
 {{ toYaml .Values.sumologic.pullSecrets | indent 2 }}

diff --git a/...oy/helm/sumologic/templates/metrics/collector/otelcol/serviceaccount-targetallocator.yaml b/...oy/helm/sumologic/templates/metrics/collector/otelcol/serviceaccount-targetallocator.yaml
@@ -7,6 +7,10 @@ metadata:
   labels:
     {{- include "sumologic.labels.metrics.serviceaccount" . | nindent 4 }}
     {{- include "sumologic.labels.common" . | nindent 4 }}
+  {{- if .Values.sumologic.serviceAccount.annotations }}
+  annotations:
+  {{ toYaml .Values.sumologic.serviceAccount.annotations | indent 2 }}
+  {{- end }}    
 {{- if .Values.sumologic.pullSecrets }}
 imagePullSecrets:
 {{ toYaml .Values.sumologic.pullSecrets | indent 2 }}

diff --git a/deploy/helm/sumologic/templates/metrics/collector/otelcol/serviceaccount.yaml b/deploy/helm/sumologic/templates/metrics/collector/otelcol/serviceaccount.yaml
@@ -7,6 +7,10 @@ metadata:
   labels:
     {{- include "sumologic.labels.metrics.serviceaccount" . | nindent 4 }}
     {{- include "sumologic.labels.common" . | nindent 4 }}
+  {{- if .Values.sumologic.serviceAccount.annotations }}
+  annotations:
+  {{ toYaml .Values.sumologic.serviceAccount.annotations | indent 2 }}
+  {{- end }}    
 {{- if .Values.sumologic.pullSecrets }}
 imagePullSecrets:
 {{ toYaml .Values.sumologic.pullSecrets | indent 2 }}

diff --git a/tests/helm/common_test.go b/tests/helm/common_test.go
@@ -563,7 +563,7 @@ func TestServiceAccountPullSecrets(t *testing.T) {
 // tests podLabels and podAnnotations
 func TestCustomPodData(t *testing.T) {
 	t.Parallel()
-	valuesFilePath := path.Join(testDataDirectory, "custom-podData.yaml")
+	valuesFilePath := path.Join(testDataDirectory, "custom-global-config-attributes.yaml")
 	renderedYamlString := RenderTemplate(
 		t,
 		&helm.Options{
@@ -642,3 +642,53 @@ func TestCustomPodData(t *testing.T) {
 		)
 	}
 }
+
+func TestCustomServiceAccountAnnotations(t *testing.T) {
+	t.Parallel()
+	valuesFilePath := path.Join(testDataDirectory, "custom-global-config-attributes.yaml")
+	renderedYamlString := RenderTemplate(
+		t,
+		&helm.Options{
+			ValuesFiles: []string{valuesFilePath},
+			SetStrValues: map[string]string{
+				"sumologic.accessId":  "accessId",
+				"sumologic.accessKey": "accessKey",
+			},
+			Logger: logger.Discard, // the log output is noisy and doesn't help much
+		},
+		chartDirectory,
+		releaseName,
+		[]string{},
+		true,
+		"--namespace",
+		defaultNamespace,
+	)
+
+	renderedObjects, err := UnmarshalMultipleK8sObjectsFromYaml(renderedYamlString)
+	require.NoError(t, err)
+
+	for _, object := range renderedObjects {
+		kind := object.GetObjectKind().GroupVersionKind().Kind
+		if kind != "ServiceAccount" {
+			continue
+		}
+		serviceAccount := object.(*corev1.ServiceAccount)
+		if isSubchartObject(serviceAccount) {
+			continue
+		}
+
+		for key, expectedValue := range expectedAnnotations {
+			actualValue, exists := serviceAccount.Annotations[key]
+			require.True(t, exists, "Annotation %s not found in service account %s", key, serviceAccount.Name)
+
+			assert.Equal(
+				t,
+				expectedValue,
+				actualValue,
+				"Annotation %s value mismatch in service account %s",
+				key,
+				serviceAccount.Name,
+			)
+		}
+	}
+}
diff --git a/tests/helm/const.go b/tests/helm/const.go
@@ -36,6 +36,10 @@ var subChartNames []string = []string{
 	"opentelemetry-operator",
 }
 
+var expectedAnnotations = map[string]string{
+	"customServiceAccountAnnotationKey": "customServiceAccountAnnotationValue",
+}
+
 var toleration = corev1.Toleration{
 	Key:      "key",
 	Value:    "value",

diff --git a/tests/helm/testdata/custom-podData.yaml → ...data/custom-global-config-attributes.yaml b/tests/helm/testdata/custom-podData.yaml → ...data/custom-global-config-attributes.yaml
@@ -7,6 +7,9 @@ sumologic:
     customLabelKey: customLabelValue
   podAnnotations:
     customAnnotationsKey: customAnnotationsValue
+  serviceAccount:
+    annotations:
+      customServiceAccountAnnotationKey: customServiceAccountAnnotationValue
 
 kube-prometheus-stack:
   kube-state-metrics: