Merge pull request 'OZG-3328-new-helm-unittest-framework' (#96) from...

Merge pull request 'OZG-3328-new-helm-unittest-framework' (#96) from OZG-3328-new-helm-unittest-framework into master

Reviewed-on: https://git.ozg-sh.de/ozgcloud-app/user-manager/pulls/96

Jenkinsfile

@@ -159,10 +159,9 @@ pipeline {
                     FAILED_STAGE=env.STAGE_NAME
                     HELM_CHART_VERSION = generateHelmChartVersion()
 
-                    dir('src/main/helm') {
-                        sh "helm lint -f ../../test/linter-values.yaml"
+                    sh "./run_helm_test.sh"
                     
-                        sh "helm unittest --helm3 -f '../../test/helm/*.yaml' -v '../../test/unit-values.yaml' ."
+                    dir('src/main/helm') {
     
                         sh "helm package --version=${HELM_CHART_VERSION} ."
 

run_helm_test.sh

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

src/main/helm/templates/_helpers.tpl

@@ -57,7 +57,7 @@ app.kubernetes.io/namespace: {{ include "app.namespace" . }}
 {{- end -}}
 
 {{- define "app.ssoServerUrl" -}}
-{{- if contains "https://" .Values.sso.serverUrl -}}
+{{- if contains "https://" (required "sso.serverUrl must be set" (.Values.sso).serverUrl) -}}
 {{- .Values.sso.serverUrl -}}
 {{- else -}}
 {{- printf "https://%s" .Values.sso.serverUrl -}}
@@ -99,7 +99,7 @@ app.kubernetes.io/namespace: {{ include "app.namespace" . }}
 {{- end -}}
 
 {{- define "app.alfaAddress" -}}
-{{ printf "https://%s.%s" (include "app.ozgcloudBezeichner" .) .Values.baseUrl }}
+{{ printf "https://%s.%s" (include "app.ozgcloudBezeichner" .) (required "baseUrl must be set" .Values.baseUrl) }}
 {{- end -}}
 
 {{- define "app.replaceAllNonAlphanumeric" -}}

src/test/helm/api-password-secret_test.yaml

@@ -4,6 +4,11 @@ release:
   namespace: sh-test-test
 templates:
   - templates/api-password-secret.yaml
+set:
+  ozgcloud:
+    keycloak:
+      api: 
+        password: testPassword
 tests:
   - it: test api secret kind
     asserts:
@@ -13,7 +18,7 @@ tests:
     asserts:
       - equal:
           path: stringData.password
-          value: geheim
+          value: testPassword
   - it: should use Keycloak User Operator
     set:
       sso:

src/test/helm/deployment-keycloak-values-test.yaml

@@ -27,11 +27,16 @@ release:
   name: user-manager
 templates:
   - templates/deployment.yaml
+set:
+  ozgcloud:
+    bundesland: by
+    bezeichner: helm
+    environment: dev
+  sso:
+    serverUrl: https://sso.test.by.ozg-cloud.local
+  baseUrl: test.company.local
 tests:
   - it: validate keycloak configuration values
-    template: deployment.yaml
-    release:
-      namespace: sh-helm-test
     asserts:
       - contains:
           path: spec.template.spec.containers[0].env
@@ -51,17 +56,17 @@ tests:
           path: spec.template.spec.containers[0].env
           content: 
             name: OZGCLOUD_KEYCLOAK_API_REALM
-            value: sh-helm-test
+            value: by-helm-dev
       - contains:
           path: spec.template.spec.containers[0].env
           content: 
             name: QUARKUS_OIDC_AUTH_SERVER_URL
-            value: https://sso.test.sh.ozg-cloud.de/realms/sh-helm-test
+            value: https://sso.test.by.ozg-cloud.local/realms/by-helm-dev
       - contains:
           path: spec.template.spec.containers[0].env
           content: 
             name: KEYCLOAK_URL
-            value: https://sso.test.sh.ozg-cloud.de
+            value: https://sso.test.by.ozg-cloud.local
       - contains:
           path: spec.template.spec.containers[0].env
           content: 
@@ -69,12 +74,10 @@ tests:
             value: alfa
 
   - it: should set keycloak client name
-    template: deployment.yaml
-    release:
-      namespace: sh-helm-test
     set:
       sso:
         client_name: alfa
+        serverUrl: https://sso.company.local
     asserts:
       - contains:
           path: spec.template.spec.containers[0].env
@@ -83,9 +86,6 @@ tests:
             value: alfa
 
   - it: sso.serverurl with https
-    template: deployment.yaml
-    release:
-      namespace: sh-helm-test
     set:
       sso.serverUrl: https://sso.test.by.ozg-cloud.de
     asserts:
@@ -93,16 +93,13 @@ tests:
           path: spec.template.spec.containers[0].env
           content: 
             name: QUARKUS_OIDC_AUTH_SERVER_URL
-            value: https://sso.test.by.ozg-cloud.de/realms/sh-helm-test
+            value: https://sso.test.by.ozg-cloud.de/realms/by-helm-dev
       - contains:
           path: spec.template.spec.containers[0].env
           content: 
             name: KEYCLOAK_URL
             value: https://sso.test.by.ozg-cloud.de
   - it: sso.serverurl without https
-    template: deployment.yaml
-    release:
-      namespace: sh-helm-test
     set:
       sso.serverUrl: sso.test.by.ozg-cloud.de
     asserts:
@@ -110,20 +107,19 @@ tests:
           path: spec.template.spec.containers[0].env
           content: 
             name: QUARKUS_OIDC_AUTH_SERVER_URL
-            value: https://sso.test.by.ozg-cloud.de/realms/sh-helm-test
+            value: https://sso.test.by.ozg-cloud.de/realms/by-helm-dev
       - contains:
           path: spec.template.spec.containers[0].env
           content: 
             name: KEYCLOAK_URL
             value: https://sso.test.by.ozg-cloud.de
+
   - it: should use Keycloak User Operator
-    template: deployment.yaml
-    release:
-      namespace: sh-helm-test
     set:
       sso:
         api_user:
           name: -userManager-ApiUser
+        serverUrl: https://sso.company.local
     asserts:
       - contains:
           path: spec.template.spec.containers[0].env

src/test/helm/deployment-mongodb-passwort-secretref-test.yaml

@@ -27,6 +27,13 @@ release:
   name: user-manager
 templates:
   - templates/deployment.yaml
+set:
+  ozgcloud:
+    bundesland: by
+    bezeichner: helm
+    environment: dev
+  sso.serverUrl: https://sso.company.local
+  baseUrl: test.company.local
 tests:
   - it: should reference mongodb connectionString for user-manager
     set:

src/test/helm/deployment-test.yaml

@@ -27,6 +27,13 @@ release:
   name: user-manager
 templates:
   - templates/deployment.yaml
+set:
+  ozgcloud:
+    bundesland: by
+    bezeichner: helm
+    environment: dev
+  sso.serverUrl: https://sso.company.local
+  baseUrl: test.company.local
 tests:
   - it: test resources for prod environment
     release:

src/test/helm/deployment-url-value-test.yaml

@@ -27,6 +27,13 @@ release:
   name: user-manager
 templates:
   - templates/deployment.yaml
+set:
+  ozgcloud:
+    bundesland: by
+    bezeichner: helm
+    environment: dev
+  sso.serverUrl: https://sso.company.local
+  baseUrl: test.company.local
 tests:
   - it: validate keycloak configuration values
     template: deployment.yaml
@@ -37,4 +44,4 @@ tests:
           path: spec.template.spec.containers[0].env
           content:
             name: OZGCLOUD_USER_MANAGER_URL
-            value: https://helm-user-manager.test.sh.ozg-cloud.de
+            value: https://helm-user-manager.test.company.local
\ No newline at end of file

src/test/helm/deployment_container_security_context_test.yaml

@@ -28,6 +28,13 @@ release:
   namespace: sh-helm-test
 templates:
   - templates/deployment.yaml
+set:
+  ozgcloud:
+    bundesland: by
+    bezeichner: helm
+    environment: dev
+  sso.serverUrl: https://sso.company.local
+  baseUrl: test.company.local
 tests:
   - it: check default values
     asserts:

src/test/helm/deployment_defaults_labels_test.yaml

@@ -30,39 +30,47 @@ templates:
   - templates/deployment.yaml
   - templates/service.yaml
   - templates/service_monitor.yaml
+set:
+  ozgcloud:
+    bundesland: by
+    bezeichner: helm
+    environment: dev
+  sso:
+    serverUrl: https://sso.company.local
+  baseUrl: test.sh.ozg-cloud.local
 tests:
   - it: check default labels
     asserts:
       - equal:
-          path: metadata.labels.[app.kubernetes.io/instance]
+          path: metadata.labels["app.kubernetes.io/instance"]
           value: user-manager
       - equal:
-          path: metadata.labels.[app.kubernetes.io/name]
+          path: metadata.labels["app.kubernetes.io/name"]
           value: user-manager
       - equal:
-          path: metadata.labels.[app.kubernetes.io/part-of]
+          path: metadata.labels["app.kubernetes.io/part-of"]
           value: ozgcloud
       - equal:
-          path: metadata.labels.[app.kubernetes.io/namespace]
+          path: metadata.labels["app.kubernetes.io/namespace"]
           value: sh-helm-test
   - it: check component label for deployment
     templates:
       - templates/deployment.yaml
     asserts:
       - equal:
-          path: spec.template.metadata.labels.[component]
+          path: spec.template.metadata.labels["component"]
           value: user-manager
   - it: check component label for service
     templates:
       - templates/service.yaml
     asserts:
       - equal:
-          path: metadata.labels.[component]
+          path: metadata.labels["component"]
           value: user-manager-service
   - it: check component label for service monitor
     templates:
       - templates/service_monitor.yaml
     asserts:
       - equal:
-          path: metadata.labels.[component]
+          path: metadata.labels["component"]
           value: user-manager-service-monitor

src/test/helm/deployment_env_test.yaml

@@ -25,6 +25,14 @@
 suite: test environments
 templates:
   - templates/deployment.yaml
+set:
+  ozgcloud:
+    bundesland: by
+    bezeichner: helm
+    environment: dev
+  sso:
+    serverUrl: sso.test.sh.ozg-cloud.de
+  baseUrl: test.sh.ozg-cloud.de
 tests:
   - it: check customList
     template: deployment.yaml
@@ -71,7 +79,12 @@ tests:
             value: test-database
   - it: check user sync period set
     set:
-      ozgcloud.usersync.period: "6h"
+      ozgcloud:
+        bundesland: by
+        bezeichner: helm
+        environment: dev  
+        usersync:
+          period: "6h"
     asserts:
       - contains:
           path: spec.template.spec.containers[0].env

src/test/helm/deployment_host_aliases_test.yaml

@@ -28,6 +28,14 @@ release:
   namespace: sh-helm-test
 templates:
   - templates/deployment.yaml
+set:
+  ozgcloud:
+    bundesland: by
+    bezeichner: helm
+    environment: dev
+  sso:
+    serverUrl: sso.test.sh.ozg-cloud.de
+  baseUrl: test.sh.ozg-cloud.de
 tests:
   - it: should not set hostAliases
     asserts:

src/test/helm/deployment_imagepull_secret_test.yaml

@@ -28,6 +28,14 @@ release:
   namespace: sh-helm-test
 templates:
   - templates/deployment.yaml
+set:
+  ozgcloud:
+    bundesland: by
+    bezeichner: helm
+    environment: dev
+  sso:
+    serverUrl: sso.test.sh.ozg-cloud.de
+  baseUrl: test.sh.ozg-cloud.de
 tests:
   - it: should use default imagePull secret
     asserts:

src/test/helm/deployment_optional_trust_store_test.yaml

@@ -25,10 +25,18 @@
 suite: test environments
 templates:
   - templates/deployment.yaml
+set:
+  ozgcloud:
+    bundesland: by
+    bezeichner: helm
+    environment: dev
+  sso:
+    serverUrl: sso.test.sh.ozg-cloud.de
+  baseUrl: test.sh.ozg-cloud.de
 tests:
   - it: check without truststore
     asserts:
-      - isEmpty:
+      - notExists:
           path: spec.template.spec.containers[0].args
       - notContains:
           path: spec.template.spec.containers[0].env

src/test/helm/deployment_resources_test.yaml

@@ -27,6 +27,14 @@ release:
   name: user-manager
 templates:
   - templates/deployment.yaml
+set:
+  ozgcloud:
+    bundesland: by
+    bezeichner: helm
+    environment: dev
+  sso:
+    serverUrl: sso.test.sh.ozg-cloud.de
+  baseUrl: test.sh.ozg-cloud.de
 tests:
   - it: test resources
     template: deployment.yaml

src/test/helm/deployment_scrapeMetrics_test.yaml

@@ -29,6 +29,15 @@ release:
 templates:
   - templates/deployment.yaml
   - templates/secret_database_quarkus.yaml
+set:
+  ozgcloud:
+    bundesland: by
+    bezeichner: helm
+    environment: dev
+  sso:
+    serverUrl: sso.test.sh.ozg-cloud.de
+  baseUrl: test.sh.ozg-cloud.de
+
 tests:
   - it: should set the metrics port by default
     template: deployment.yaml

src/test/helm/deployment_service_account_test.yaml

@@ -28,6 +28,15 @@ release:
   namespace: sh-helm-test
 templates:
   - templates/deployment.yaml
+set:
+  ozgcloud:
+    bundesland: by
+    bezeichner: helm
+    environment: dev
+  sso:
+    serverUrl: sso.test.sh.ozg-cloud.de
+  baseUrl: test.sh.ozg-cloud.de
+
 tests:
   - it: should use service account with default name
     set:

src/test/helm/deplyoment_cert_bindings_test.yaml

@@ -28,10 +28,16 @@ release:
   namespace: user-manager
 templates:
   - templates/deployment.yaml
+set:
+  ozgcloud:
+    bezeichner: helm
+    bundesland: by
+    environment: dev
+  baseUrl: test.sh.ozg-cloud.de
+  sso:
+    serverUrl: sso.test.sh.ozg-cloud.de
 tests:
   - it: should mount volumes for user-manager root ca
-    set:
-      ozgcloud.environment: dev
     asserts:
        - contains:
            path: spec.template.spec.containers[0].volumeMounts

src/test/helm/imagepull_secret_test.yaml

@@ -48,8 +48,8 @@ tests:
       - equal:
           path: metadata.namespace
           value: helm-test
-      - isNotEmpty:
-          path: data.[.dockerconfigjson]
+      - isNotNullOrEmpty:
+          path: data[".dockerconfigjson"]
 
   - it: should not create image pull secret
     set:

src/test/helm/ingress-nginx-tests.yaml

@@ -28,6 +28,10 @@ release:
   namespace: sh-helm-test
 templates:
   - templates/ingress.yaml
+set:
+  baseUrl: test.sh.ozg-cloud.de
+  ozgcloud:
+    bezeichner: helm
 tests:
   - it: should create ingress tls
     asserts:
@@ -56,19 +60,19 @@ tests:
   - it: should use default letsencrypt-prod cluster-issuer
     asserts:
       - equal:
-          path: metadata.annotations.[cert-manager.io/cluster-issuer]
+          path: metadata.annotations["cert-manager.io/cluster-issuer"]
           value: letsencrypt-prod
   - it: should use letsencrypt-staging cluster-issuer
     set:
       ingress.use_staging_cert: true
     asserts:
       - equal:
-          path: metadata.annotations.[cert-manager.io/cluster-issuer]
+          path: metadata.annotations["cert-manager.io/cluster-issuer"]
           value: letsencrypt-staging
   - it: should use letsencrypt-prod cluster-issuer
     set:
       ingress.use_staging_cert: false
     asserts:
       - equal:
-          path: metadata.annotations.[cert-manager.io/cluster-issuer]
+          path: metadata.annotations["cert-manager.io/cluster-issuer"]
           value: letsencrypt-prod
\ No newline at end of file