Merge pull request 'OZG-3328 cleanup helm unittests and add tests for full...

Merge pull request 'OZG-3328 cleanup helm unittests and add tests for full coverage	OZG-5115 update helm unittest command' (#110) from OZG-3328 into master

run_helm_test.sh

@@ -4,4 +4,4 @@ set -e
 
 helm template  ./src/main/helm/ -f src/test/helm-linter-values.yaml
 helm lint -f src/test/helm-linter-values.yaml ./src/main/helm/
-cd src/main/helm && helm unittest -f '../../test/helm/*.yaml' .
\ No newline at end of file
+cd src/main/helm && helm unittest  -f '../../test/helm/**/*test.yaml' .
\ No newline at end of file

src/main/helm/templates/_helpers.tpl

@@ -42,11 +42,6 @@ app.kubernetes.io/name: {{ .Release.Name }}
 app.kubernetes.io/namespace: {{ include "app.namespace" . }}
 {{- end -}}
 
-{{- define "app.imagePullSecret" }}
-{{- with .Values.imageCredentials }}
-{{- printf "{\"auths\":{\"%s\":{\"username\":\"%s\",\"password\":\"%s\",\"email\":\"%s\",\"auth\":\"%s\"}}}" .registry .username .password .email (printf "%s:%s" .username .password | b64enc) | b64enc }}
-{{- end }}
-{{- end }}
 
 {{- define "app.envSpringProfiles" }}
 {{- if (.Values.env).overrideSpringProfiles -}}

src/main/helm/templates/deployment.yaml

@@ -156,11 +156,7 @@ spec:
       dnsConfig: {}
       dnsPolicy: ClusterFirst
       imagePullSecrets:
-      {{- if .Values.imagePullSecret }}
-      - name: {{ .Values.imagePullSecret }}
-      {{ else }}
-      - name: {{ .Release.Name }}-image-pull-secret
-      {{- end }}
+      - name: {{ required "imagePullSecret must be set" .Values.imagePullSecret }}
       restartPolicy: Always
       {{- with .Values.hostAliases }}
       hostAliases:

src/main/helm/templates/image-pull-secret.yaml

-#
-# Copyright (C) 2022 Das Land Schleswig-Holstein vertreten durch den
-# Ministerpräsidenten des Landes Schleswig-Holstein
-# Staatskanzlei
-# Abteilung Digitalisierung und zentrales IT-Management der Landesregierung
-#
-# Lizenziert unter der EUPL, Version 1.2 oder - sobald
-# diese von der Europäischen Kommission genehmigt wurden -
-# Folgeversionen der EUPL ("Lizenz");
-# Sie dürfen dieses Werk ausschließlich gemäß
-# dieser Lizenz nutzen.
-# Eine Kopie der Lizenz finden Sie hier:
-#
-# https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12
-#
-# Sofern nicht durch anwendbare Rechtsvorschriften
-# gefordert oder in schriftlicher Form vereinbart, wird
-# die unter der Lizenz verbreitete Software "so wie sie
-# ist", OHNE JEGLICHE GEWÄHRLEISTUNG ODER BEDINGUNGEN -
-# ausdrücklich oder stillschweigend - verbreitet.
-# Die sprachspezifischen Genehmigungen und Beschränkungen
-# unter der Lizenz sind dem Lizenztext zu entnehmen.
-#
-
-{{- if not (.Values.imagePullSecret) }}
-apiVersion: v1
-kind: Secret
-metadata:
-  name: {{ .Release.Name }}-image-pull-secret
-  namespace: {{ include "app.namespace" . }}
-type: kubernetes.io/dockerconfigjson
-data:
-  .dockerconfigjson: {{ include "app.imagePullSecret" . }}
-{{- end }}
\ No newline at end of file

src/test/helm-linter-values.yaml

@@ -29,3 +29,5 @@ ozgcloud:
 
 networkPolicy:
   dnsServerNamespace: test-dns-server-namespace
+
+imagePullSecret: image-pull-secret
\ No newline at end of file

src/test/helm/deployment_63_chars_test.yaml

@@ -31,6 +31,7 @@ chart:
   name: eingang-manager
 set:
   ozgcloud.environment: test
+  imagePullSecret: image-pull-secret
 templates:
   - templates/deployment.yaml
 

src/test/helm/deployment_bindings_test.yaml

@@ -27,6 +27,7 @@ templates:
   - templates/deployment.yaml
 set:
   ozgcloud.environment: test
+  imagePullSecret: image-pull-secret
 tests:
   - it: should have temp-dir volume
     asserts:

src/test/helm/deployment_container_security_context_test.yaml

@@ -22,7 +22,7 @@
 # unter der Lizenz sind dem Lizenztext zu entnehmen.
 #
 
-suite: test deployment
+suite: test deployment container security
 release:
   name: eingang-manager
   namespace: sh-helm-test
@@ -30,11 +30,10 @@ templates:
   - templates/deployment.yaml
 set:
   ozgcloud.environment: test
+  imagePullSecret: image-pull-secret
 tests:
   - it: check default values
     asserts:
-      - isKind:
-          of: Deployment
       - equal:
           path: spec.template.spec.containers[0].securityContext.allowPrivilegeEscalation
           value: false

src/test/helm/deployment_defaults_containers_health_test.yaml

+#
+# Copyright (C) 2022 Das Land Schleswig-Holstein vertreten durch den
+# Ministerpräsidenten des Landes Schleswig-Holstein
+# Staatskanzlei
+# Abteilung Digitalisierung und zentrales IT-Management der Landesregierung
+#
+# Lizenziert unter der EUPL, Version 1.2 oder - sobald
+# diese von der Europäischen Kommission genehmigt wurden -
+# Folgeversionen der EUPL ("Lizenz");
+# Sie dürfen dieses Werk ausschließlich gemäß
+# dieser Lizenz nutzen.
+# Eine Kopie der Lizenz finden Sie hier:
+#
+# https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12
+#
+# Sofern nicht durch anwendbare Rechtsvorschriften
+# gefordert oder in schriftlicher Form vereinbart, wird
+# die unter der Lizenz verbreitete Software "so wie sie
+# ist", OHNE JEGLICHE GEWÄHRLEISTUNG ODER BEDINGUNGEN -
+# ausdrücklich oder stillschweigend - verbreitet.
+# Die sprachspezifischen Genehmigungen und Beschränkungen
+# unter der Lizenz sind dem Lizenztext zu entnehmen.
+#
+
+suite: test deployment health check
+release:
+  name: eingang-manager
+  namespace: sh-helm-test
+templates:
+  - templates/deployment.yaml
+set:
+  ozgcloud.environment: test
+  imagePullSecret: image-pull-secret
+tests:
+  - it: should have correct health check values
+    asserts:
+      - equal:
+          path: spec.template.spec.containers[0].readinessProbe.failureThreshold
+          value: 3
+      - equal:
+          path: spec.template.spec.containers[0].readinessProbe.httpGet.path
+          value: /actuator/health/readiness
+      - equal:
+          path: spec.template.spec.containers[0].readinessProbe.httpGet.port
+          value: 8081
+      - equal:
+          path: spec.template.spec.containers[0].readinessProbe.httpGet.scheme
+          value: HTTP
+      - equal:
+          path: spec.template.spec.containers[0].readinessProbe.periodSeconds
+          value: 10
+      - equal:
+          path: spec.template.spec.containers[0].readinessProbe.successThreshold
+          value: 1
+      - equal:
+          path: spec.template.spec.containers[0].readinessProbe.timeoutSeconds
+          value: 3  
+      - equal:
+          path: spec.template.spec.containers[0].startupProbe.failureThreshold
+          value: 10
+      - equal:
+          path: spec.template.spec.containers[0].startupProbe.httpGet.path
+          value: /actuator/health/readiness
+      - equal:
+          path: spec.template.spec.containers[0].startupProbe.httpGet.port
+          value: 8081
+      - equal:
+          path: spec.template.spec.containers[0].startupProbe.httpGet.scheme
+          value: HTTP
+      - equal:
+          path: spec.template.spec.containers[0].startupProbe.initialDelaySeconds
+          value: 30
+      - equal:
+          path: spec.template.spec.containers[0].startupProbe.periodSeconds
+          value: 5
+      - equal:
+          path: spec.template.spec.containers[0].startupProbe.successThreshold
+          value: 1
+      - equal:
+          path: spec.template.spec.containers[0].startupProbe.timeoutSeconds
+          value: 5
+      
\ No newline at end of file

src/test/helm/deployment_defaults_labels_test.yaml

@@ -22,28 +22,28 @@
 # unter der Lizenz sind dem Lizenztext zu entnehmen.
 #
 
-suite: test deployment
+suite: test deployment default label
 release:
   name: intelliform-adapter
   namespace: sh-helm-test
 templates:
   - templates/deployment.yaml
-  - templates/service_monitor.yaml
-  - templates/service.yaml
+
 set:
   ozgcloud.environment: test
+  imagePullSecret: image-pull-secret
 tests:
   - it: check default labels
     asserts:
       - equal:
-          path: metadata.labels["app.kubernetes.io/instance"]
-          value: afm-adapter
-      - equal:
-          path: metadata.labels["app.kubernetes.io/name"]
-          value: intelliform-adapter
-      - equal:
-          path: metadata.labels["app.kubernetes.io/part-of"]
-          value: ozgcloud
-      - equal:
-          path: metadata.labels["app.kubernetes.io/namespace"]
-          value: sh-helm-test
+          path: metadata.labels
+          value: 
+            app.kubernetes.io/instance: afm-adapter
+            app.kubernetes.io/managed-by: Helm
+            app.kubernetes.io/name: intelliform-adapter
+            app.kubernetes.io/namespace: sh-helm-test
+            app.kubernetes.io/part-of: ozgcloud
+            app.kubernetes.io/version: 0.0.0-MANAGED-BY-JENKINS
+            helm.sh/chart: Intelliform-Adapter-0.0.0-MANAGED-BY-JENKINS
+            ozg-component: eingangsadapter
+

src/test/helm/deployment_defaults_spec_containers_test.yaml

+#
+# Copyright (C) 2022 Das Land Schleswig-Holstein vertreten durch den
+# Ministerpräsidenten des Landes Schleswig-Holstein
+# Staatskanzlei
+# Abteilung Digitalisierung und zentrales IT-Management der Landesregierung
+#
+# Lizenziert unter der EUPL, Version 1.2 oder - sobald
+# diese von der Europäischen Kommission genehmigt wurden -
+# Folgeversionen der EUPL ("Lizenz");
+# Sie dürfen dieses Werk ausschließlich gemäß
+# dieser Lizenz nutzen.
+# Eine Kopie der Lizenz finden Sie hier:
+#
+# https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12
+#
+# Sofern nicht durch anwendbare Rechtsvorschriften
+# gefordert oder in schriftlicher Form vereinbart, wird
+# die unter der Lizenz verbreitete Software "so wie sie
+# ist", OHNE JEGLICHE GEWÄHRLEISTUNG ODER BEDINGUNGEN -
+# ausdrücklich oder stillschweigend - verbreitet.
+# Die sprachspezifischen Genehmigungen und Beschränkungen
+# unter der Lizenz sind dem Lizenztext zu entnehmen.
+#
+
+suite: test deployment actuator
+release:
+  name: eingang-manager
+  namespace: sh-helm-test
+templates:
+  - templates/deployment.yaml
+set:  
+  ozgcloud.environment: test
+  imagePullSecret: image-pull-secret
+tests:
+  - it: check for some standard values
+    asserts:
+      - equal:
+          path: spec.template.spec.containers[0].image
+          value: docker.ozg-sh.de/intelliform-adapter:latest
+      - equal:
+          path: spec.template.spec.containers[0].imagePullPolicy
+          value: Always
+      - equal:
+          path: spec.template.spec.containers[0].name
+          value: intelliform-adapter
+      - equal:
+          path: spec.template.spec.containers[0].ports[0].containerPort
+          value: 8080
+      - equal:
+          path: spec.template.spec.containers[0].ports[0].name
+          value: 8080tcp1
+      - equal:
+          path: spec.template.spec.containers[0].ports[0].protocol
+          value: TCP
+      - equal:
+          path: spec.template.spec.containers[0].stdin
+          value: true
+      - equal:
+          path: spec.template.spec.containers[0].terminationMessagePath
+          value: /dev/termination-log
+      - equal:
+          path: spec.template.spec.containers[0].terminationMessagePolicy
+          value: File
+      - equal:
+          path: spec.template.spec.containers[0].tty
+          value: true
+      - equal:
+          path: spec.template.spec.containers[0].ports[1].containerPort
+          value: 8081
+      - equal:
+          path: spec.template.spec.containers[0].ports[1].name
+          value: metrics
+      - equal:
+          path: spec.template.spec.containers[0].ports[1].protocol
+          value: TCP
\ No newline at end of file

src/test/helm/deployment_test.yaml → src/test/helm/deployment_defaults_topologySpreadConstraints_test.yaml

@@ -22,33 +22,27 @@
 # unter der Lizenz sind dem Lizenztext zu entnehmen.
 #
 
-suite: test deployment
+suite: test deployment topology
 release:
-  name: intelliform-adapter
+  name: eingang-manager
   namespace: sh-helm-test
 templates:
-  - deployment.yaml
+  - templates/deployment.yaml
 set:  
   ozgcloud.environment: test
+  imagePullSecret: image-pull-secret
 tests:
-  - it: validate image type and container image
+  - it: check default values
     asserts:
-      - isKind:
-          of: Deployment
       - equal:
-          path: spec.template.spec.containers[0].image
-          value: docker.ozg-sh.de/intelliform-adapter:latest
-  - it: validate image pull secret resource name
-    asserts:
+          path: spec.template.spec.topologySpreadConstraints[0].maxSkew
+          value: 1
       - equal:
-          path: spec.template.spec.imagePullSecrets[0].name
-          value: intelliform-adapter-image-pull-secret
+          path: spec.template.spec.topologySpreadConstraints[0].topologyKey
+          value: kubernetes.io/hostname
       - equal:
-          path: spec.template.spec.containers[0].image
-          value: docker.ozg-sh.de/intelliform-adapter:latest
-  - it: should have label ozg-component
-    asserts:
+          path: spec.template.spec.topologySpreadConstraints[0].whenUnsatisfiable
+          value: DoNotSchedule
       - equal:
-          path: metadata.labels.ozg-component
-          value: eingangsadapter
-
+          path: spec.template.spec.topologySpreadConstraints[0].labelSelector.matchLabels["app.kubernetes.io/name"]
+          value: eingang-manager
\ No newline at end of file

src/test/helm/deployment_env_test.yaml → src/test/helm/deployment_env_customList_test.yaml

@@ -22,14 +22,14 @@
 # unter der Lizenz sind dem Lizenztext zu entnehmen.
 #
 
-suite: test environments
+suite: test environments customList
 templates:
   - templates/deployment.yaml
 set:
   ozgcloud.environment: test
+  imagePullSecret: image-pull-secret
 tests:
   - it: check customList
-    template: deployment.yaml
     set:
       env.customList:
         - name: my_test_environment_name
@@ -41,7 +41,6 @@ tests:
             name: my_test_environment_name
             value: "A test value"
   - it: check customList test value is not set by default
-    template: deployment.yaml
     asserts:
       - notContains:
           path: spec.template.spec.containers[0].env

src/test/helm/deployment_host_aliases_test.yaml

@@ -31,6 +31,7 @@ templates:
 
 set:
   ozgcloud.environment: test
+  imagePullSecret: image-pull-secret
 tests:
   - it: should not set hostAliases
     asserts:

src/test/helm/deployment_imagepull_secret_test.yaml

@@ -22,7 +22,7 @@
 # unter der Lizenz sind dem Lizenztext zu entnehmen.
 #
 
-suite: test deployment
+suite: test deployment imagepullsecret
 release:
   name: afm-adapter
   namespace: sh-helm-test
@@ -31,19 +31,14 @@ templates:
 set:
   ozgcloud.environment: test
 tests:
-  - it: should use default imagePull secret
-    asserts:
-      - isKind:
-          of: Deployment
-      - equal:
-          path: spec.template.spec.imagePullSecrets[0].name
-          value: afm-adapter-image-pull-secret
   - it: should set the imagePull secret
     set:
       imagePullSecret: image-pull-secret
     asserts:
-      - isKind:
-          of: Deployment
       - equal:
           path: spec.template.spec.imagePullSecrets[0].name
           value: image-pull-secret
+  - it: should fail tempalte when not set
+    asserts:
+      - failedTemplate:
+          errorMessage: imagePullSecret must be set
\ No newline at end of file

src/test/helm/deployment_liveness_probe_test.yaml

@@ -22,20 +22,19 @@
 # unter der Lizenz sind dem Lizenztext zu entnehmen.
 #
 
-suite: test deployment
+suite: test deployment liveness probe
 templates:
   - templates/deployment.yaml
 set:
   ozgcloud.environment: test
+  imagePullSecret: image-pull-secret
 tests:
   - it: livenessProbe should be disabled by default
-    template: deployment.yaml
     asserts:
       - notExists:
           path: spec.template.spec.containers[0].livenessProbe
 
   - it: enable livenessProbe
-    template: deployment.yaml
     set:
       enableLivenessProbe: true
     asserts:

src/test/helm/deployment_pod_default_spec_values_test.yaml

+ #
+# Copyright (C) 2024 Das Land Schleswig-Holstein vertreten durch den
+# Ministerpräsidenten des Landes Schleswig-Holstein
+# Staatskanzlei
+# Abteilung Digitalisierung und zentrales IT-Management der Landesregierung
+#
+# Lizenziert unter der EUPL, Version 1.2 oder - sobald
+# diese von der Europäischen Kommission genehmigt wurden -
+# Folgeversionen der EUPL ("Lizenz");
+# Sie dürfen dieses Werk ausschließlich gemäß
+# dieser Lizenz nutzen.
+# Eine Kopie der Lizenz finden Sie hier:
+#
+# https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12
+#
+# Sofern nicht durch anwendbare Rechtsvorschriften
+# gefordert oder in schriftlicher Form vereinbart, wird
+# die unter der Lizenz verbreitete Software "so wie sie
+# ist", OHNE JEGLICHE GEWÄHRLEISTUNG ODER BEDINGUNGEN -
+# ausdrücklich oder stillschweigend - verbreitet.
+# Die sprachspezifischen Genehmigungen und Beschränkungen
+# unter der Lizenz sind dem Lizenztext zu entnehmen.
+#
+
+suite: test deployment container basics
+release:
+  name: eingang-manager
+  namespace: sh-helm-test
+templates:
+  - templates/deployment.yaml
+set:
+  ozgcloud.environment: test
+  imagePullSecret: image-pull-secret
+tests:
+ - it: should have correct pod template values
+   asserts:
+      - isEmpty:
+          path: spec.template.spec.dnsConfig
+      - equal:
+          path: spec.template.spec.dnsPolicy
+          value: "ClusterFirst"
+      - equal:
+          path: spec.template.spec.restartPolicy
+          value: "Always"
+      - equal:
+          path: spec.template.spec.schedulerName
+          value: "default-scheduler"
+      - equal:
+          path: spec.template.spec.terminationGracePeriodSeconds
+          value: 30
\ No newline at end of file

src/test/helm/deployment_resources_test.yaml

@@ -22,13 +22,14 @@
 # unter der Lizenz sind dem Lizenztext zu entnehmen.
 #
 
-suite: test deployment
+suite: test deployment resources
 release:
   name: afm-adapter
 templates:
   - templates/deployment.yaml
 set:
   ozgcloud.environment: test
+  imagePullSecret: image-pull-secret
 tests:
   - it: test resources
     set:

src/test/helm/deployment_routing-strategy.yaml → src/test/helm/deployment_routing_strategy_env.yaml

@@ -22,7 +22,7 @@
 # unter der Lizenz sind dem Lizenztext zu entnehmen.
 #
 
-suite: test deployment
+suite: test deployment routing strategy
 release:
   name: intelliform-adapter
   namespace: sh-helm-test
@@ -31,6 +31,7 @@ templates:
 set:
   image.tag: latest
   ozgcloud.environment: test
+  imagePullSecret: image-pull-secret
 tests:
   - it: validate default routing values without questions.yaml
     asserts:

src/test/helm/deployment_service_account_test.yaml

@@ -31,6 +31,7 @@ templates:
 
 set:
   ozgcloud.environment: test
+  imagePullSecret: image-pull-secret
 tests:
   - it: should use afm-adapter service account name
     set: