Files
Stavros Kois 07d4558f5e feat(common): explicitly set the namespace on all the objects (#488)
**Description**
<!--
Please include a summary of the change and which issue is fixed. Please
also include relevant motivation and context. List any dependencies that
are required for this change.
-->
⚒️ Fixes  #441 

- Added a function to "generate" the namespace and also validate in
terms of length and format.

Current blockers:
Some objects added after the initial refactor use a different code style
and currently is not straightforward to use the above function.

Those will have to be revisited once they have some tests for
themselves.
And after everything else is working and have tests in place (in regards
with the namespace change)

TODO:
  - [x] adjusts regex for validation on name and namespace. 
  - [x] Doc updates

Tests:
  - [x] Configmap
  - [x] CronJob
  - [x] DaemonSet
  - [x] Deployment
  - [x] Endpoint
  - [x] EndpointSlice
  - [x] Job
- [x] NetworkAttachmentDefinition (Due to being only used in Scale and
the way the config is fetched, only global and root level namespaces are
used. You just can't define the NS on the object itself.)
  - [x] PesistentVolumeClaim
  - [x] RBAC
  - [x] Secret
  - [x] Service
  - [x] ServiceAccount
  - [x] StatefulSet

Objects with the implementation (but no tests):
Also those objects do not have per object override and do not support
TPL.
The above issues will be fixed on each one after they are refactored.
  - [x] Certificate
  - [x] Cluster
  - [x] Pooler
  - [x] HorizontalPodAutoscaler
  - [x] Ingress
  - [x] NetworkPolicy
  - [x] PodMonitor
  - [x] PrometheusRule
  - [x] Route
  - [x] ServiceMonitor

**⚙️ Type of change**

- [x] ⚙️ Feature/App addition
- [ ] 🪛 Bugfix
- [ ] ⚠️ Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] 🔃 Refactor of current code

**🧪 How Has This Been Tested?**
<!--
Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details
for your test configuration
-->

**📃 Notes:**
<!-- Please enter any other relevant information here -->

**✔️ Checklist:**

- [x] ⚖️ My code follows the style guidelines of this project
- [x] 👀 I have performed a self-review of my own code
- [ ] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [x] 📄 I have made corresponding changes to the documentation
- [x] ⚠️ My changes generate no new warnings
- [x] 🧪 I have added tests to this description that prove my fix is
effective or that my feature works
- [x] ⬆️ I increased versions for any altered app according to semantic
versioning

** App addition**

If this PR is an app addition please make sure you have done the
following.

- [ ] 🪞 I have opened a PR on
[truecharts/containers](https://github.com/truecharts/containers) adding
the container to TrueCharts mirror repo.
- [ ] 🖼️ I have added an icon in the Chart's root directory called
`icon.png`

---

_Please don't blindly check all the boxes. Read them and only check
those that apply.
Those checkboxes are there for the reviewer to see what is this all
about and
the status of this PR with a quick glance._
2023-07-15 19:14:48 +02:00

302 lines
9.7 KiB
YAML

suite: externalInterface metadata test
templates:
- common.yaml
release:
name: test-release-name
namespace: test-release-namespace
tests:
- it: should generate correct annotations without selector
set:
# Simulate middleware injection
ixExternalInterfacesConfiguration:
- '{"cniVersion": "0.3.1", "name": "ix-test-release-name-0", "type": "macvlan", "master": "ens3s0", "ipam": {"type": "dhcp"}}'
- '{"cniVersion": "0.3.1", "name": "ix-test-release-name-0", "type": "macvlan", "master": "ens4s0", "ipam": {"type": "dhcp"}}'
ixExternalInterfacesConfigurationNames:
- ix-test-release-name-0
- ix-test-release-name-1
scaleExternalInterface:
- hostInterface: enp0s3
ipam:
type: dhcp
- hostInterface: enp0s4
ipam:
type: dhcp
image: &image
repository: nginx
tag: 1.21.4
pullPolicy: IfNotPresent
workload:
workload-name1:
enabled: true
primary: true
type: Deployment
podSpec:
containers:
container-name1:
enabled: true
primary: true
imageSelector: image
probes: &probes
liveness:
enabled: false
readiness:
enabled: false
startup:
enabled: false
workload-name2:
enabled: true
primary: false
type: StatefulSet
podSpec:
containers:
container-name1:
enabled: true
primary: true
imageSelector: image
probes: *probes
asserts:
- documentIndex: &deploymentDoc 2
isKind:
of: Deployment
- documentIndex: *deploymentDoc
isAPIVersion:
of: apps/v1
- documentIndex: *deploymentDoc
equal:
path: metadata.name
value: test-release-name-common-test
- documentIndex: *deploymentDoc
isSubset:
path: spec.template.metadata.annotations
content:
k8s.v1.cni.cncf.io/networks: ix-test-release-name-0, ix-test-release-name-1
- documentIndex: &statefulSetDoc 3
isKind:
of: StatefulSet
- documentIndex: *statefulSetDoc
isAPIVersion:
of: apps/v1
- documentIndex: *statefulSetDoc
equal:
path: metadata.name
value: test-release-name-common-test-workload-name2
- documentIndex: *statefulSetDoc
isNotSubset:
path: spec.template.metadata.annotations
content:
k8s.v1.cni.cncf.io/networks: ix-test-release-name-0, ix-test-release-name-1
- it: should generate correct annotations with targetSelectAll
set:
# Simulate middleware injection
ixExternalInterfacesConfiguration:
- '{"cniVersion": "0.3.1", "name": "ix-test-release-name-0", "type": "macvlan", "master": "ens3s0", "ipam": {"type": "dhcp"}}'
- '{"cniVersion": "0.3.1", "name": "ix-test-release-name-0", "type": "macvlan", "master": "ens4s0", "ipam": {"type": "dhcp"}}'
ixExternalInterfacesConfigurationNames:
- ix-test-release-name-0
- ix-test-release-name-1
scaleExternalInterface:
- hostInterface: enp0s3
ipam:
type: dhcp
targetSelectAll: true
- hostInterface: enp0s4
ipam:
type: dhcp
targetSelectAll: true
image: *image
workload:
workload-name1:
enabled: true
primary: true
type: DaemonSet
podSpec:
containers:
container-name1:
enabled: true
primary: true
imageSelector: image
probes: *probes
workload-name2:
enabled: true
primary: false
type: Job
podSpec:
containers:
container-name1:
enabled: true
primary: true
imageSelector: image
probes: *probes
asserts:
- documentIndex: &daemonSetDoc 2
isKind:
of: DaemonSet
- documentIndex: *daemonSetDoc
isAPIVersion:
of: apps/v1
- documentIndex: *daemonSetDoc
equal:
path: metadata.name
value: test-release-name-common-test
- documentIndex: *daemonSetDoc
isSubset:
path: spec.template.metadata.annotations
content:
k8s.v1.cni.cncf.io/networks: ix-test-release-name-0, ix-test-release-name-1
- documentIndex: &jobDoc 3
isKind:
of: Job
- documentIndex: *jobDoc
isAPIVersion:
of: batch/v1
- documentIndex: *jobDoc
equal:
path: metadata.name
value: test-release-name-common-test-workload-name2
- documentIndex: *jobDoc
isSubset:
path: spec.template.metadata.annotations
content:
k8s.v1.cni.cncf.io/networks: ix-test-release-name-0, ix-test-release-name-1
- it: should generate correct annotations with targetSelector
set:
# Simulate middleware injection
ixExternalInterfacesConfiguration:
- '{"cniVersion": "0.3.1", "name": "ix-test-release-name-0", "type": "macvlan", "master": "ens3s0", "ipam": {"type": "dhcp"}}'
- '{"cniVersion": "0.3.1", "name": "ix-test-release-name-0", "type": "macvlan", "master": "ens4s0", "ipam": {"type": "dhcp"}}'
ixExternalInterfacesConfigurationNames:
- ix-test-release-name-0
- ix-test-release-name-1
scaleExternalInterface:
- hostInterface: enp0s3
ipam:
type: dhcp
targetSelector:
- workload-name1
- workload-name2
- hostInterface: enp0s4
ipam:
type: dhcp
targetSelector:
- workload-name1
image: *image
workload:
workload-name1:
enabled: true
primary: true
type: DaemonSet
podSpec:
containers:
container-name1:
enabled: true
primary: true
imageSelector: image
probes: *probes
workload-name2:
enabled: true
primary: false
type: CronJob
schedule: "*/1 * * * *"
podSpec:
containers:
container-name1:
enabled: true
primary: true
imageSelector: image
probes: *probes
asserts:
- documentIndex: &daemonSetDoc 2
isKind:
of: DaemonSet
- documentIndex: *daemonSetDoc
isAPIVersion:
of: apps/v1
- documentIndex: *daemonSetDoc
equal:
path: metadata.name
value: test-release-name-common-test
- documentIndex: *daemonSetDoc
isSubset:
path: spec.template.metadata.annotations
content:
k8s.v1.cni.cncf.io/networks: ix-test-release-name-0, ix-test-release-name-1
- documentIndex: &cronJobDoc 3
isKind:
of: CronJob
- documentIndex: *cronJobDoc
isAPIVersion:
of: batch/v1
- documentIndex: *cronJobDoc
equal:
path: metadata.name
value: test-release-name-common-test-workload-name2
- documentIndex: *cronJobDoc
isSubset:
path: spec.jobTemplate.spec.template.metadata.annotations
content:
k8s.v1.cni.cncf.io/networks: ix-test-release-name-0
- it: should pass with networkattachmentdefinition created with namespace from global with tpl
set:
# Simulate middleware injection
ixExternalInterfacesConfiguration:
- '{"cniVersion": "0.3.1", "name": "ix-test-release-name-0", "type": "macvlan", "master": "ens3s0", "ipam": {"type": "dhcp"}}'
ixExternalInterfacesConfigurationNames: []
scaleExternalInterface:
- hostInterface: enp0s3
ipam:
type: dhcp
key: global-namespace
global:
namespace: "{{ .Values.key }}"
asserts:
- documentIndex: &networkDoc 0
isKind:
of: NetworkAttachmentDefinition
- documentIndex: *networkDoc
equal:
path: metadata.namespace
value: global-namespace
- it: should pass with networkattachmentdefinition created with namespace from root with tpl
set:
# Simulate middleware injection
ixExternalInterfacesConfiguration:
- '{"cniVersion": "0.3.1", "name": "ix-test-release-name-0", "type": "macvlan", "master": "ens3s0", "ipam": {"type": "dhcp"}}'
ixExternalInterfacesConfigurationNames: []
scaleExternalInterface:
- hostInterface: enp0s3
ipam:
type: dhcp
key: local-namespace
namespace: "{{ .Values.key }}"
global:
namespace: global-namespace
asserts:
- documentIndex: *networkDoc
equal:
path: metadata.namespace
value: local-namespace
- it: should pass with networkattachmentdefinition created with namespace in TrueNAS SCALE
set:
global:
ixChartContext:
iAmNotEmpty: true
# Simulate middleware injection
ixExternalInterfacesConfiguration:
- '{"cniVersion": "0.3.1", "name": "ix-test-release-name-0", "type": "macvlan", "master": "ens3s0", "ipam": {"type": "dhcp"}}'
ixExternalInterfacesConfigurationNames: []
scaleExternalInterface:
- hostInterface: enp0s3
ipam:
type: dhcp
namespace: ix-namespace
asserts:
- documentIndex: *networkDoc
equal:
path: metadata.namespace
value: ix-namespace