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>
141 lines
5.3 KiB
YAML
141 lines
5.3 KiB
YAML
suite: Test deployment image configuration
|
|
release:
|
|
name: gitea-unittests
|
|
namespace: testing
|
|
chart:
|
|
# Override appVersion to be consistent with used digest :)
|
|
appVersion: 1.19.3
|
|
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 the default image reference"
|
|
template: templates/deployment.yaml
|
|
asserts:
|
|
- equal:
|
|
path: spec.template.spec.containers[0].image
|
|
value: "docker.gitea.com/gitea:1.19.3-rootless"
|
|
- it: "Render a custom image tag"
|
|
template: templates/deployment.yaml
|
|
set:
|
|
deployment.gitea.image.tag: "1.19.4"
|
|
asserts:
|
|
- equal:
|
|
path: spec.template.spec.containers[0].image
|
|
value: "docker.gitea.com/gitea:1.19.4-rootless"
|
|
- it: "Render the root-based image variant"
|
|
template: templates/deployment.yaml
|
|
set:
|
|
deployment.gitea.image.rootless: false
|
|
asserts:
|
|
- equal:
|
|
path: spec.template.spec.containers[0].image
|
|
value: "docker.gitea.com/gitea:1.19.3"
|
|
- it: "Render a scoped image registry"
|
|
template: templates/deployment.yaml
|
|
set:
|
|
deployment.gitea.image.registry: "example.com"
|
|
asserts:
|
|
- equal:
|
|
path: spec.template.spec.containers[0].image
|
|
value: "example.com/gitea:1.19.3-rootless"
|
|
- it: "Render the global image registry"
|
|
template: templates/deployment.yaml
|
|
set:
|
|
global.imageRegistry: "global.example.com"
|
|
asserts:
|
|
- equal:
|
|
path: spec.template.spec.containers[0].image
|
|
value: "global.example.com/gitea:1.19.3-rootless"
|
|
- it: "Render a digest for the rootless image"
|
|
template: templates/deployment.yaml
|
|
set:
|
|
deployment:
|
|
gitea:
|
|
image:
|
|
rootless: true
|
|
digest: sha256:b28e8f3089b52ebe6693295df142f8c12eff354e9a4a5bfbb5c10f296c3a537a
|
|
asserts:
|
|
- equal:
|
|
path: spec.template.spec.containers[0].image
|
|
value: "docker.gitea.com/gitea:1.19.3-rootless@sha256:b28e8f3089b52ebe6693295df142f8c12eff354e9a4a5bfbb5c10f296c3a537a"
|
|
- it: "Render image.fullOverride without appending the rootless suffix"
|
|
template: templates/deployment.yaml
|
|
set:
|
|
deployment:
|
|
gitea:
|
|
image:
|
|
fullOverride: docker.gitea.com/gitea:1.19.3
|
|
# setting rootless, registry, repository, tag, and digest to prove that override works
|
|
rootless: true
|
|
registry: example.com
|
|
repository: example/image
|
|
tag: "1.0.0"
|
|
digest: sha256:b28e8f3089b52ebe6693295df142f8c12eff354e9a4a5bfbb5c10f296c3a537a
|
|
asserts:
|
|
- equal:
|
|
path: spec.template.spec.containers[0].image
|
|
value: "docker.gitea.com/gitea:1.19.3"
|
|
- it: "Render a digest for the root-based image"
|
|
template: templates/deployment.yaml
|
|
set:
|
|
deployment:
|
|
gitea:
|
|
image:
|
|
rootless: false
|
|
digest: sha256:b28e8f3089b52ebe6693295df142f8c12eff354e9a4a5bfbb5c10f296c3a537a
|
|
asserts:
|
|
- equal:
|
|
path: spec.template.spec.containers[0].image
|
|
value: "docker.gitea.com/gitea:1.19.3@sha256:b28e8f3089b52ebe6693295df142f8c12eff354e9a4a5bfbb5c10f296c3a537a"
|
|
- it: "Render a digest together with the global image registry"
|
|
template: templates/deployment.yaml
|
|
set:
|
|
global.imageRegistry: "global.example.com"
|
|
deployment.gitea.image.digest: "sha256:b28e8f3089b52ebe6693295df142f8c12eff354e9a4a5bfbb5c10f296c3a537a"
|
|
asserts:
|
|
- equal:
|
|
path: spec.template.spec.containers[0].image
|
|
value: "global.example.com/gitea:1.19.3-rootless@sha256:b28e8f3089b52ebe6693295df142f8c12eff354e9a4a5bfbb5c10f296c3a537a"
|
|
- it: "Render unquoted floating tag references"
|
|
template: templates/deployment.yaml
|
|
set:
|
|
# use non-quoted values on purpose. See: https://gitea.com/gitea/helm-gitea/issues/631
|
|
deployment.gitea.image.tag: 1.21
|
|
deployment.initDirectories.image.tag: 1.21
|
|
deployment.initAppIni.image.tag: 1.21
|
|
deployment.initConfigureGitea.image.tag: 1.21
|
|
asserts:
|
|
- equal:
|
|
path: spec.template.spec.initContainers[0].image
|
|
value: "docker.gitea.com/gitea:1.21-rootless"
|
|
- equal:
|
|
path: spec.template.spec.initContainers[1].image
|
|
value: "docker.gitea.com/gitea:1.21-rootless"
|
|
- equal:
|
|
path: spec.template.spec.initContainers[2].image
|
|
value: "docker.gitea.com/gitea:1.21-rootless"
|
|
- equal:
|
|
path: spec.template.spec.containers[0].image
|
|
value: "docker.gitea.com/gitea:1.21-rootless"
|
|
- it: "Render the own image configuration of the init containers"
|
|
template: templates/deployment.yaml
|
|
set:
|
|
deployment.initDirectories.image.registry: "init.example.com"
|
|
deployment.initDirectories.image.tag: "1.19.4"
|
|
asserts:
|
|
- equal:
|
|
path: spec.template.spec.initContainers[0].image
|
|
value: "init.example.com/gitea:1.19.4-rootless"
|
|
- equal:
|
|
path: spec.template.spec.initContainers[1].image
|
|
value: "docker.gitea.com/gitea:1.19.3-rootless"
|
|
- equal:
|
|
path: spec.template.spec.containers[0].image
|
|
value: "docker.gitea.com/gitea:1.19.3-rootless"
|