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>
156 lines
5.3 KiB
YAML
156 lines
5.3 KiB
YAML
suite: Test deployment additional config
|
|
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: "Render a Deployment with additionalConfigFromEnvs"
|
|
template: templates/deployment.yaml
|
|
asserts:
|
|
- hasDocuments:
|
|
count: 1
|
|
- containsDocument:
|
|
kind: Deployment
|
|
apiVersion: apps/v1
|
|
name: gitea-unittests
|
|
- it: "Render the Deployment with empty additionalConfigFromEnvs"
|
|
template: templates/deployment.yaml
|
|
set:
|
|
gitea.additionalConfigFromEnvs: []
|
|
asserts:
|
|
- hasDocuments:
|
|
count: 1
|
|
- exists:
|
|
path: spec.template.spec.initContainers[1].env
|
|
- lengthEqual:
|
|
path: spec.template.spec.initContainers[1].env
|
|
count: 6
|
|
- isSubset:
|
|
path: spec.template.spec.initContainers[1]
|
|
content:
|
|
env:
|
|
- name: GITEA_APP_INI
|
|
value: /data/gitea/conf/app.ini
|
|
- name: GITEA_CUSTOM
|
|
value: /data/gitea
|
|
- name: GITEA_WORK_DIR
|
|
value: /data
|
|
- name: GITEA_TEMP
|
|
value: /tmp/gitea
|
|
- name: TMP_EXISTING_ENVS_FILE
|
|
value: /tmp/existing-envs
|
|
- name: ENV_TO_INI_MOUNT_POINT
|
|
value: /env-to-ini-mounts
|
|
- it: "Render the Deployment with standard additionalConfigFromEnvs"
|
|
template: templates/deployment.yaml
|
|
set:
|
|
gitea.additionalConfigFromEnvs: [{name: GITEA_database_HOST, value: my-db:123}, {name: GITEA_database_USER, value: my-user}]
|
|
asserts:
|
|
- hasDocuments:
|
|
count: 1
|
|
- exists:
|
|
path: spec.template.spec.initContainers[1].env
|
|
- lengthEqual:
|
|
path: spec.template.spec.initContainers[1].env
|
|
count: 8
|
|
- isSubset:
|
|
path: spec.template.spec.initContainers[1]
|
|
content:
|
|
env:
|
|
- name: GITEA_APP_INI
|
|
value: /data/gitea/conf/app.ini
|
|
- name: GITEA_CUSTOM
|
|
value: /data/gitea
|
|
- name: GITEA_WORK_DIR
|
|
value: /data
|
|
- name: GITEA_TEMP
|
|
value: /tmp/gitea
|
|
- name: TMP_EXISTING_ENVS_FILE
|
|
value: /tmp/existing-envs
|
|
- name: ENV_TO_INI_MOUNT_POINT
|
|
value: /env-to-ini-mounts
|
|
- name: GITEA_database_HOST
|
|
value: my-db:123
|
|
- name: GITEA_database_USER
|
|
value: my-user
|
|
- it: "Render the Deployment with templated additionalConfigFromEnvs"
|
|
template: templates/deployment.yaml
|
|
set:
|
|
gitea.misc.host: my-db-host:321
|
|
gitea.misc.user: my-db-user
|
|
gitea.additionalConfigFromEnvs: [{name: GITEA_database_HOST, value: "{{ .Values.gitea.misc.host }}"}, {name: GITEA_database_USER, value: "{{ .Values.gitea.misc.user }}"}]
|
|
asserts:
|
|
- hasDocuments:
|
|
count: 1
|
|
- exists:
|
|
path: spec.template.spec.initContainers[1].env
|
|
- lengthEqual:
|
|
path: spec.template.spec.initContainers[1].env
|
|
count: 8
|
|
- isSubset:
|
|
path: spec.template.spec.initContainers[1]
|
|
content:
|
|
env:
|
|
- name: GITEA_APP_INI
|
|
value: /data/gitea/conf/app.ini
|
|
- name: GITEA_CUSTOM
|
|
value: /data/gitea
|
|
- name: GITEA_WORK_DIR
|
|
value: /data
|
|
- name: GITEA_TEMP
|
|
value: /tmp/gitea
|
|
- name: TMP_EXISTING_ENVS_FILE
|
|
value: /tmp/existing-envs
|
|
- name: ENV_TO_INI_MOUNT_POINT
|
|
value: /env-to-ini-mounts
|
|
- name: GITEA_database_HOST
|
|
value: my-db-host:321
|
|
- name: GITEA_database_USER
|
|
value: my-db-user
|
|
- it: "Render the Deployment with a templated Secret name in additionalConfigFromEnvs"
|
|
template: templates/deployment.yaml
|
|
set:
|
|
gitea.misc.existingSecret: my-db-secret
|
|
gitea.additionalConfigFromEnvs[0]:
|
|
name: GITEA_database_HOST
|
|
valueFrom:
|
|
secretKeyRef:
|
|
name: "{{ .Values.gitea.misc.existingSecret }}"
|
|
key: password
|
|
asserts:
|
|
- hasDocuments:
|
|
count: 1
|
|
- exists:
|
|
path: spec.template.spec.initContainers[1].env
|
|
- lengthEqual:
|
|
path: spec.template.spec.initContainers[1].env
|
|
count: 7
|
|
- isSubset:
|
|
path: spec.template.spec.initContainers[1]
|
|
content:
|
|
env:
|
|
- name: GITEA_APP_INI
|
|
value: /data/gitea/conf/app.ini
|
|
- name: GITEA_CUSTOM
|
|
value: /data/gitea
|
|
- name: GITEA_WORK_DIR
|
|
value: /data
|
|
- name: GITEA_TEMP
|
|
value: /tmp/gitea
|
|
- name: TMP_EXISTING_ENVS_FILE
|
|
value: /tmp/existing-envs
|
|
- name: ENV_TO_INI_MOUNT_POINT
|
|
value: /env-to-ini-mounts
|
|
- name: GITEA_database_HOST
|
|
valueFrom:
|
|
secretKeyRef:
|
|
name: "my-db-secret"
|
|
key: password
|