feat(common): Release common 4.0.0 (#398)

Co-authored-by: lab-assistant[bot] <180935599+lab-assistant[bot]@users.noreply.github.com>

charts/library/common/test-chart/unittests/secret/metadata_annotations_test.yaml

@@ -0,0 +1,49 @@
+---
+# yaml-language-server: $schema=https://raw.githubusercontent.com/helm-unittest/helm-unittest/main/schema/helm-testsuite.json
+suite: secret - metadata - annotations
+templates:
+  - common.yaml
+values:
+  - ../_values/controllers_main_default_container.yaml
+set:
+  secrets:
+    secret:
+      stringData:
+        test: test
+tests:
+  - it: no annotations are set by default
+    documentSelector:
+      path: $[?(@.kind == "Secret")].metadata.name
+      value: release-name
+    asserts:
+      - notExists:
+          path: metadata.annotations
+
+  - it: custom annotations
+    set:
+      secrets.secret.annotations:
+        test_annotation: test
+    documentSelector:
+      path: $[?(@.kind == "Secret")].metadata.name
+      value: release-name
+    asserts:
+      - equal:
+          path: metadata.annotations
+          value:
+            test_annotation: test
+
+  - it: custom annotations mixed with global annotations
+    set:
+      global.annotations:
+        global_annotation: test
+      secrets.secret.annotations:
+        test_annotation: test
+    documentSelector:
+      path: $[?(@.kind == "Secret")].metadata.name
+      value: release-name
+    asserts:
+      - equal:
+          path: metadata.annotations
+          value:
+            global_annotation: test
+            test_annotation: test

charts/library/common/test-chart/unittests/secret/metadata_labels_test.yaml

@@ -0,0 +1,62 @@
+---
+# yaml-language-server: $schema=https://raw.githubusercontent.com/helm-unittest/helm-unittest/main/schema/helm-testsuite.json
+suite: secret - metadata - labels
+templates:
+  - common.yaml
+values:
+  - ../_values/controllers_main_default_container.yaml
+set:
+  secrets:
+    secret:
+      stringData:
+        test: test
+tests:
+  - it: default labels
+    documentSelector:
+      path: $[?(@.kind == "Secret")].metadata.name
+      value: release-name
+    asserts:
+      - equal:
+          path: metadata.labels
+          value:
+            app.kubernetes.io/instance: RELEASE-NAME
+            app.kubernetes.io/managed-by: Helm
+            app.kubernetes.io/name: RELEASE-NAME
+            helm.sh/chart: common-test-1.0.0
+
+  - it: custom labels
+    set:
+      secrets.secret.labels:
+        test_label: test
+    documentSelector:
+      path: $[?(@.kind == "Secret")].metadata.name
+      value: release-name
+    asserts:
+      - equal:
+          path: metadata.labels
+          value:
+            app.kubernetes.io/instance: RELEASE-NAME
+            app.kubernetes.io/managed-by: Helm
+            app.kubernetes.io/name: RELEASE-NAME
+            helm.sh/chart: common-test-1.0.0
+            test_label: test
+
+  - it: custom labels mixed with global labels
+    set:
+      global.labels:
+        global_label: test
+      secrets.secret.labels:
+        test_label: test
+    documentSelector:
+      path: $[?(@.kind == "Secret")].metadata.name
+      value: release-name
+    asserts:
+      - equal:
+          path: metadata.labels
+          value:
+            app.kubernetes.io/instance: RELEASE-NAME
+            app.kubernetes.io/managed-by: Helm
+            app.kubernetes.io/name: RELEASE-NAME
+            global_label: test
+            helm.sh/chart: common-test-1.0.0
+            test_label: test

charts/library/common/test-chart/unittests/secret/metadata_name_test.yaml

@@ -0,0 +1,183 @@
+---
+# yaml-language-server: $schema=https://raw.githubusercontent.com/helm-unittest/helm-unittest/main/schema/helm-testsuite.json
+suite: secret - metadata - name
+templates:
+  - common.yaml
+values:
+  - ../_values/controllers_main_default_container.yaml
+set:
+  secrets.main:
+    stringData:
+      test: test
+tests:
+  - it: name defaults to chart fullName
+    asserts:
+      - containsDocument:
+          kind: Secret
+          apiVersion: v1
+          name: release-name
+          any: true
+
+  - it: forceRename
+    set:
+      secrets.main.forceRename: forceRename
+    asserts:
+      - containsDocument:
+          kind: Secret
+          apiVersion: v1
+          name: forcerename
+          any: true
+
+  - it: forceRename with template
+    set:
+      secrets.main.forceRename: "{{ .Chart.Name }}"
+    asserts:
+      - containsDocument:
+          kind: Secret
+          apiVersion: v1
+          name: common-test
+          any: true
+
+  - it: prefix
+    set:
+      secrets.main.prefix: prefix
+    asserts:
+      - containsDocument:
+          kind: Secret
+          apiVersion: v1
+          name: prefix-release-name
+          any: true
+
+  - it: prefix with template
+    set:
+      secrets.main.prefix: "{{ .Chart.Name }}"
+    asserts:
+      - containsDocument:
+          kind: Secret
+          apiVersion: v1
+          name: common-test-release-name
+          any: true
+
+  - it: suffix
+    set:
+      secrets.main.suffix: suffix
+    asserts:
+      - containsDocument:
+          kind: Secret
+          apiVersion: v1
+          name: release-name-suffix
+          any: true
+
+  - it: suffix with template
+    set:
+      secrets.main.suffix: "{{ .Chart.Name }}"
+    asserts:
+      - containsDocument:
+          kind: Secret
+          apiVersion: v1
+          name: release-name-common-test
+          any: true
+
+  - it: both prefix and suffix
+    set:
+      secrets.main.prefix: prefix
+      secrets.main.suffix: suffix
+    asserts:
+      - containsDocument:
+          kind: Secret
+          apiVersion: v1
+          name: prefix-release-name-suffix
+          any: true
+
+  - it: prefix, suffix and forceRename (illegal combination)
+    set:
+      secrets.main.forceRename: forceRename
+      secrets.main.prefix: prefix
+      secrets.main.suffix: suffix
+    asserts:
+      - failedTemplate:
+          errorPattern: "values don't meet the specifications of the schema"
+
+  - it: multiple items
+    set:
+      secrets.second:
+        stringData:
+          test: test
+    asserts:
+      - containsDocument:
+          kind: Secret
+          apiVersion: v1
+          name: release-name-main
+          any: true
+      - containsDocument:
+          kind: Secret
+          apiVersion: v1
+          name: release-name-second
+          any: true
+
+  - it: multiple items with prefix
+    set:
+      secrets.second:
+        prefix: prefix
+        stringData:
+          test: test
+    asserts:
+      - containsDocument:
+          kind: Secret
+          apiVersion: v1
+          name: release-name-main
+          any: true
+      - containsDocument:
+          kind: Secret
+          apiVersion: v1
+          name: prefix-release-name-second
+          any: true
+
+  - it: multiple items with suffix
+    set:
+      secrets.second:
+        suffix: suffix
+        stringData:
+          test: test
+    asserts:
+      - containsDocument:
+          kind: Secret
+          apiVersion: v1
+          name: release-name-main
+          any: true
+      - containsDocument:
+          kind: Secret
+          apiVersion: v1
+          name: release-name-second-suffix
+          any: true
+
+  - it: multiple items with prefix and suffix
+    set:
+      secrets.second:
+        prefix: prefix
+        suffix: suffix
+        stringData:
+          test: test
+    asserts:
+      - containsDocument:
+          kind: Secret
+          apiVersion: v1
+          name: release-name-main
+          any: true
+      - containsDocument:
+          kind: Secret
+          apiVersion: v1
+          name: prefix-release-name-second-suffix
+          any: true
+
+  - it: multiple items with prefix, suffix and forceRename (illegal combination)
+    set:
+      secrets.second:
+        forceRename: forceRename
+        prefix: prefix
+        suffix: suffix
+        stringData:
+          test: test
+    asserts:
+      - failedTemplate:
+          errorPattern: "values don't meet the specifications of the schema"

charts/library/common/test-chart/unittests/secret/metadata_test.yaml

@@ -1,118 +0,0 @@
----
-# yaml-language-server: $schema=https://raw.githubusercontent.com/helm-unittest/helm-unittest/main/schema/helm-testsuite.json
-suite: secret metadata
-templates:
-  - common.yaml
-values:
-  - ../_values/controllers_main_default_container.yaml
-tests:
-  - it: default metadata should pass
-    set:
-      secrets:
-        secret:
-          stringData:
-            test: test
-    asserts:
-      - hasDocuments:
-          count: 2
-      - documentIndex: &SecretDocument 1
-        isKind:
-          of: Secret
-      - documentIndex: *SecretDocument
-        notExists:
-          path: metadata.annotations
-      - documentIndex: *SecretDocument
-        equal:
-          path: metadata.labels
-          value:
-            app.kubernetes.io/instance: RELEASE-NAME
-            app.kubernetes.io/managed-by: Helm
-            app.kubernetes.io/name: RELEASE-NAME
-            helm.sh/chart: common-test-1.0.0
-
-  - it: custom metadata should pass
-    set:
-      secrets:
-        secret:
-          stringData:
-            test: test
-          annotations:
-            test_annotation: test
-          labels:
-            test_label: test
-    asserts:
-      - hasDocuments:
-          count: 2
-      - documentIndex: &SecretDocument 1
-        isKind:
-          of: Secret
-      - documentIndex: *SecretDocument
-        equal:
-          path: metadata.annotations
-          value:
-            test_annotation: test
-      - documentIndex: *SecretDocument
-        equal:
-          path: metadata.labels
-          value:
-            app.kubernetes.io/instance: RELEASE-NAME
-            app.kubernetes.io/managed-by: Helm
-            app.kubernetes.io/name: RELEASE-NAME
-            helm.sh/chart: common-test-1.0.0
-            test_label: test
-
-  - it: custom metadata with global metadata should pass
-    set:
-      global:
-        labels:
-          global_label: test
-        annotations:
-          global_annotation: test
-      secrets:
-        secret:
-          stringData:
-            test: test
-          annotations:
-            test_annotation: test
-          labels:
-            test_label: test
-    asserts:
-      - hasDocuments:
-          count: 2
-      - documentIndex: &SecretDocument 1
-        isKind:
-          of: Secret
-      - documentIndex: *SecretDocument
-        equal:
-          path: metadata.annotations
-          value:
-            global_annotation: test
-            test_annotation: test
-      - documentIndex: *SecretDocument
-        equal:
-          path: metadata.labels
-          value:
-            app.kubernetes.io/instance: RELEASE-NAME
-            app.kubernetes.io/managed-by: Helm
-            app.kubernetes.io/name: RELEASE-NAME
-            global_label: test
-            helm.sh/chart: common-test-1.0.0
-            test_label: test
-
-  - it: custom secret type should pass
-    set:
-      secrets:
-        secret:
-          stringData:
-            test: test
-          type: &type kubernetes.io/service-account-token
-    asserts:
-      - hasDocuments:
-          count: 2
-      - documentIndex: &SecretDocument 1
-        isKind:
-          of: Secret
-      - documentIndex: *SecretDocument
-        equal:
-          path: type
-          value: *type

charts/library/common/test-chart/unittests/secret/names_test.yaml

@@ -1,93 +0,0 @@
----
-# yaml-language-server: $schema=https://raw.githubusercontent.com/helm-unittest/helm-unittest/main/schema/helm-testsuite.json
-suite: secret names
-templates:
-  - common.yaml
-values:
-  - ../_values/controllers_main_default_container.yaml
-tests:
-  - it: default should pass
-    asserts:
-      - hasDocuments:
-          count: 1
-      - documentIndex: 0
-        not: true
-        isKind:
-          of: Secret
-
-  - it: with disabled secret should pass
-    set:
-      secrets:
-        secret:
-          enabled: false
-          stringData:
-            test: test
-    asserts:
-      - hasDocuments:
-          count: 1
-      - documentIndex: 0
-        not: true
-        isKind:
-          of: Secret
-
-  - it: with multiple secrets should pass
-    set:
-      secrets:
-        secret:
-          enabled: true
-          stringData:
-            foo: bar
-        secondary:
-          enabled: true
-          stringData:
-            test: test
-    asserts:
-      - hasDocuments:
-          count: 3
-      - documentIndex: &FirstSecretDocument 1
-        isKind:
-          of: Secret
-      - documentIndex: *FirstSecretDocument
-        isNotNullOrEmpty:
-          path: metadata.name
-      - documentIndex: &SecondSecretDocument 2
-        isKind:
-          of: Secret
-      - documentIndex: *SecondSecretDocument
-        isNotNullOrEmpty:
-          path: metadata.name
-
-  - it: default name should pass
-    set:
-      secrets:
-        secret:
-          stringData:
-            test: test
-    asserts:
-      - hasDocuments:
-          count: 2
-      - documentIndex: &SecretDocument 1
-        isKind:
-          of: Secret
-      - documentIndex: *SecretDocument
-        equal:
-          path: metadata.name
-          value: RELEASE-NAME-secret
-
-  - it: with nameOverride should pass
-    set:
-      secrets:
-        secret:
-          stringData:
-            test: test
-          nameOverride: http
-    asserts:
-      - hasDocuments:
-          count: 2
-      - documentIndex: &SecretDocument 1
-        isKind:
-          of: Secret
-      - documentIndex: *SecretDocument
-        equal:
-          path: metadata.name
-          value: RELEASE-NAME-http

charts/library/common/test-chart/unittests/secret/pod_metadata_test.yaml

@@ -1,35 +0,0 @@
----
-# yaml-language-server: $schema=https://raw.githubusercontent.com/helm-unittest/helm-unittest/main/schema/helm-testsuite.json
-suite: secret Pod metadata
-templates:
-  - common.yaml
-values:
-  - ../_values/controllers_main_default_container.yaml
-tests:
-  - it: default metadata should pass
-    set:
-      secrets:
-        secret_1:
-          stringData:
-            test: value 1
-        secret_2: # default enabled
-          stringData:
-            test_1: value 1
-            test_2: value 2
-        test_not_in_checksum:
-          includeInChecksum: false
-          stringData:
-            test: value 1
-        test_disabled:
-          enabled: false
-          stringData:
-            test: value 1
-    asserts:
-      - documentIndex: &ControllerDoc 0
-        isKind:
-          of: Deployment
-      - documentIndex: *ControllerDoc
-        equal:
-          path: spec.template.metadata.annotations
-          value:
-            checksum/secrets: cd4e5076088172611ca1c43c659a275232d9eeb887acc20575ac141038b9aacb

charts/library/common/test-chart/unittests/secret/presence_test.yaml

@@ -0,0 +1,64 @@
+---
+# yaml-language-server: $schema=https://raw.githubusercontent.com/helm-unittest/helm-unittest/main/schema/helm-testsuite.json
+suite: secret - presence
+templates:
+  - common.yaml
+values:
+  - ../_values/controllers_main_default_container.yaml
+tests:
+  - it: secret is not present by default
+    asserts:
+      - not: true
+        containsDocument:
+          apiVersion: v1
+          kind: Secret
+          any: true
+
+  - it: secrets are enabled by default
+    set:
+      secrets:
+        secret:
+          stringData:
+            test: test
+    asserts:
+      - containsDocument:
+          apiVersion: v1
+          kind: Secret
+          any: true
+          name: release-name
+
+  - it: secret is not present when disabled
+    set:
+      secrets:
+        secret:
+          enabled: false
+          stringData:
+            test: test
+    asserts:
+      - not: true
+        containsDocument:
+          apiVersion: v1
+          kind: Secret
+          any: true
+          name: release-name
+
+  - it: multiple secrets can be enabled
+    set:
+      secrets:
+        secret:
+          stringData:
+            foo: bar
+        secondary:
+          stringData:
+            test: test
+    asserts:
+      - containsDocument:
+          apiVersion: v1
+          kind: Secret
+          any: true
+          name: release-name-secret
+      - containsDocument:
+          apiVersion: v1
+          kind: Secret
+          any: true
+          name: release-name-secondary