volker.raschekandCopilot
eeacda2a25
The chart conventions demand camelCase file names, forbid short names like `svc` and require the unit tests to
mirror the template structure. The unit tests followed none of that consistently. Four casings existed side by
side - camelCase (extraInitContainers.yaml), kebab-case (checksum-annotations.yaml), a snake and kebab mix
(init_directory_structure.sh-rootless.yaml) and all caps (HA.yaml) - so there was no pattern to copy when
adding a suite, which is how the inconsistency kept growing.
Three groups of problems are fixed:
- svc-configuration.yaml used exactly the short name the conventions forbid for files and keys.
- Several file names repeated their own directory, for example deployment/deployment-additional-config.yaml and
metric-secret/metrics-secret-servicemonitor-disabled.yaml, which names the subject three times. The directory
already carries that information, so the file name now only carries the scenario. The default scenario of a
template is named basics.yaml.
- Four suites lived in a directory of a template they do not assert on. They were filed under deployment/
because the deployment is rendered as a side effect, not because it is the subject:
deployment/deprecations.yaml -> deprecation/deployment.yaml
deployment/inline-config.yaml -> config/inlineConfig.yaml
deployment/storage-class-configuration.yaml -> persistentVolumeClaim/storageClass.yaml
deployment/svc-configuration.yaml -> service/configuration.yaml
storage-class-configuration.yaml is the clearest case: a persistentVolumeClaim directory already existed next
to it. The suite titles of the two suites whose subject changed are adjusted accordingly.
The Makefile passed `--file unittests/helm/values-conflicting-checks.yaml`, but that file does not exist in the
tree. `helm unittest` ignores a missing path without a warning, so the flag has been dead for an unknown amount
of time while still suggesting the checks run. It is removed; the `unittests/helm/**/*.yaml` glob would pick
the file up anyway if it ever returns.
The naming rule is written down in the copilot instructions, together with the constraint that the glob matches
only a single directory level, so a suite can never be placed directly in unittests/helm/.
All 49 suites and 267 tests still pass.
Co-authored-by: Copilot <copilot@github.com>
159 lines
5.6 KiB
YAML
159 lines
5.6 KiB
YAML
suite: Test deployment checksum annotations
|
|
release:
|
|
name: gitea-unittests
|
|
namespace: testing
|
|
templates:
|
|
- templates/deployment.yaml
|
|
- templates/secret_admin.yaml
|
|
- templates/secret_config.yaml
|
|
- templates/secret_gpg.yaml
|
|
- templates/secret_init.yaml
|
|
- templates/secret_inlineConfig.yaml
|
|
- templates/secret_metrics.yaml
|
|
tests:
|
|
- it: "Omit the checksum annotations by default"
|
|
template: templates/deployment.yaml
|
|
set:
|
|
secrets.admin.enabled: true
|
|
secrets.config.enabled: true
|
|
secrets.gpg.enabled: true
|
|
secrets.gpg.new.privateKey: |
|
|
-----BEGIN PGP PRIVATE KEY BLOCK-----
|
|
-----END PGP PRIVATE KEY BLOCK-----
|
|
secrets.init.enabled: true
|
|
secrets.inlineConfig.enabled: true
|
|
secrets.metrics.enabled: true
|
|
asserts:
|
|
- notExists:
|
|
path: spec.template.metadata.annotations["checksum/admin"]
|
|
- notExists:
|
|
path: spec.template.metadata.annotations["checksum/config"]
|
|
- notExists:
|
|
path: spec.template.metadata.annotations["checksum/gpg"]
|
|
- notExists:
|
|
path: spec.template.metadata.annotations["checksum/init"]
|
|
- notExists:
|
|
path: spec.template.metadata.annotations["checksum/inlineConfig"]
|
|
- notExists:
|
|
path: spec.template.metadata.annotations["checksum/metrics"]
|
|
|
|
- it: "Add a checksum annotation for every Secret when addSHASumAnnotation is enabled"
|
|
template: templates/deployment.yaml
|
|
set:
|
|
secrets.admin.addSHASumAnnotation: true
|
|
secrets.admin.enabled: true
|
|
|
|
secrets.config.addSHASumAnnotation: true
|
|
secrets.config.enabled: true
|
|
|
|
secrets.gpg.addSHASumAnnotation: true
|
|
secrets.gpg.enabled: true
|
|
secrets.gpg.new.privateKey: |
|
|
-----BEGIN PGP PRIVATE KEY BLOCK-----
|
|
-----END PGP PRIVATE KEY BLOCK-----
|
|
|
|
secrets.init.addSHASumAnnotation: true
|
|
secrets.init.enabled: true
|
|
|
|
secrets.inlineConfig.addSHASumAnnotation: true
|
|
secrets.inlineConfig.enabled: true
|
|
|
|
secrets.metrics.addSHASumAnnotation: true
|
|
secrets.metrics.enabled: true
|
|
asserts:
|
|
- exists:
|
|
path: spec.template.metadata.annotations["checksum/admin"]
|
|
- exists:
|
|
path: spec.template.metadata.annotations["checksum/config"]
|
|
- exists:
|
|
path: spec.template.metadata.annotations["checksum/gpg"]
|
|
- exists:
|
|
path: spec.template.metadata.annotations["checksum/init"]
|
|
- exists:
|
|
path: spec.template.metadata.annotations["checksum/inlineConfig"]
|
|
- exists:
|
|
path: spec.template.metadata.annotations["checksum/metrics"]
|
|
|
|
- it: "Omit the checksum annotation of a single disabled Secret only"
|
|
template: templates/deployment.yaml
|
|
set:
|
|
secrets.admin.addSHASumAnnotation: false
|
|
secrets.admin.enabled: true
|
|
|
|
secrets.config.addSHASumAnnotation: false
|
|
secrets.config.enabled: true
|
|
|
|
secrets.gpg.addSHASumAnnotation: false
|
|
secrets.gpg.enabled: true
|
|
secrets.gpg.new.privateKey: |
|
|
-----BEGIN PGP PRIVATE KEY BLOCK-----
|
|
-----END PGP PRIVATE KEY BLOCK-----
|
|
|
|
secrets.init.addSHASumAnnotation: false
|
|
secrets.init.enabled: true
|
|
|
|
secrets.inlineConfig.addSHASumAnnotation: false
|
|
secrets.inlineConfig.enabled: true
|
|
|
|
secrets.metrics.addSHASumAnnotation: false
|
|
secrets.metrics.enabled: true
|
|
asserts:
|
|
- notExists:
|
|
path: spec.template.metadata.annotations["checksum/admin"]
|
|
- notExists:
|
|
path: spec.template.metadata.annotations["checksum/config"]
|
|
- notExists:
|
|
path: spec.template.metadata.annotations["checksum/gpg"]
|
|
- notExists:
|
|
path: spec.template.metadata.annotations["checksum/init"]
|
|
- notExists:
|
|
path: spec.template.metadata.annotations["checksum/inlineConfig"]
|
|
- notExists:
|
|
path: spec.template.metadata.annotations["checksum/metrics"]
|
|
|
|
- it: "Add the checksum of Secrets provided by the user"
|
|
template: templates/deployment.yaml
|
|
set:
|
|
secrets.admin.enabled: true
|
|
secrets.admin.addSHASumAnnotation: true
|
|
secrets.admin.existingSecret.enabled: true
|
|
secrets.admin.existingSecret.secretName: custom-admin
|
|
|
|
secrets.config.enabled: true
|
|
secrets.config.addSHASumAnnotation: true
|
|
secrets.config.existingSecret.enabled: true
|
|
secrets.config.existingSecret.secretName: custom-config
|
|
|
|
secrets.gpg.enabled: true
|
|
secrets.gpg.addSHASumAnnotation: true
|
|
secrets.gpg.existingSecret.enabled: true
|
|
secrets.gpg.existingSecret.secretName: custom-gpg
|
|
|
|
secrets.init.enabled: true
|
|
secrets.init.addSHASumAnnotation: true
|
|
secrets.init.existingSecret.enabled: true
|
|
secrets.init.existingSecret.secretName: custom-init
|
|
|
|
secrets.inlineConfig.enabled: true
|
|
secrets.inlineConfig.addSHASumAnnotation: true
|
|
secrets.inlineConfig.existingSecret.enabled: true
|
|
secrets.inlineConfig.existingSecret.secretName: custom-inline-config
|
|
|
|
secrets.metrics.enabled: true
|
|
secrets.metrics.addSHASumAnnotation: true
|
|
secrets.metrics.existingSecret.enabled: true
|
|
secrets.metrics.existingSecret.secretName: custom-metrics
|
|
asserts:
|
|
- exists:
|
|
path: spec.template.metadata.annotations["checksum/admin"]
|
|
- exists:
|
|
path: spec.template.metadata.annotations["checksum/config"]
|
|
- exists:
|
|
path: spec.template.metadata.annotations["checksum/gpg"]
|
|
- exists:
|
|
path: spec.template.metadata.annotations["checksum/init"]
|
|
- exists:
|
|
path: spec.template.metadata.annotations["checksum/inlineConfig"]
|
|
- exists:
|
|
path: spec.template.metadata.annotations["checksum/metrics"]
|