truenas/chart
1
0
Fork 0
mirror of https://github.com/truenas/charts.git synced 2026-06-17 07:27:44 +08:00
Code Issues Packages Projects Releases Wiki Activity

add externalInterfaces + unittests

Browse Source
This commit is contained in:
Stavros kois
2022-12-05 20:22:26 +02:00
parent f917d7a2cd
commit 6ca5f7f4dc
4 changed files with 403 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

371
library/common-test/tests/externalInterfaces/externalInterfaces_test.yaml Normal file
View File

@@ -0,0 +1,371 @@
suite: external interfaces test
templates:
- common.yaml
chart:
appVersion: &appVer v1.2.3
tests:
- it: should pass with default values
documentIndex: &deploymentDoc 0
asserts:
- hasDocuments:
count: 2
- isKind:
of: Deployment
- it: should fail without hostInterface
set:
externalInterfaces:
- hostInterface: ""
asserts:
- failedTemplate:
errorMessage: <hostInterface> is required when configuring External Interfaces.
- it: should fail without ipam type
set:
externalInterfaces:
- hostInterface: ens3s0
ipam: {}
asserts:
- failedTemplate:
errorMessage: <ipam.type> is required. Interface (ens3s0)
- it: should fail with invalid ipam type
set:
externalInterfaces:
- hostInterface: ens3s0
ipam:
type: invalid_type
asserts:
- failedTemplate:
errorMessage: Invalid option for <ipam.type> (invalid_type). Valid options are static and dhcp. Interface (ens3s0)
- it: should fail with dhcp ipam and staticIPConfigurations
set:
externalInterfaces:
- hostInterface: ens3s0
ipam:
type: dhcp
staticIPConfigurations:
- 1.1.1.1
asserts:
- failedTemplate:
errorMessage: <staticIPConfigurations> and <staticRoutes> cannot be used with <ipam.type> of (dhcp). Interface (ens3s0)
- it: should fail with dhcp ipam and staticRoutes
set:
externalInterfaces:
- hostInterface: ens3s0
ipam:
type: dhcp
staticRoutes:
- gateway: 1.1.1.1
destination: 1.1.1.1
asserts:
- failedTemplate:
errorMessage: <staticIPConfigurations> and <staticRoutes> cannot be used with <ipam.type> of (dhcp). Interface (ens3s0)
- it: should fail with static ipam and no staticIPConfigurations
set:
externalInterfaces:
- hostInterface: ens3s0
ipam:
type: static
staticIPConfigurations: []
asserts:
- failedTemplate:
errorMessage: Static IP is required when <ipam.type> is static. Interface (ens3s0)
- it: should fail with static ipam and no staticRoutes.gateway
set:
externalInterfaces:
- hostInterface: ens3s0
ipam:
type: static
staticIPConfigurations:
- 1.1.1.1
staticRoutes:
- gateway: ""
asserts:
- failedTemplate:
errorMessage: <destination> and <gateway> are required when <staticRoutes> are defined. Interface (ens3s0)
- it: should fail with static ipam and no staticRoutes.destination
set:
externalInterfaces:
- hostInterface: ens3s0
ipam:
type: static
staticIPConfigurations:
- 1.1.1.1
staticRoutes:
- gateway: 1.1.1.1
destination: ""
asserts:
- failedTemplate:
errorMessage: <destination> and <gateway> are required when <staticRoutes> are defined. Interface (ens3s0)
- it: should pass with externalInterface defined
documentIndex: &externalInterfaceDoc 0
set:
# Only to pass validation
externalInterfaces:
- hostInterface: ens3s0
ipam:
type: dhcp
# Simulate the ix Injected values
ixExternalInterfacesConfiguration:
- '{"cniVersion": "0.3.1", "name": "ix-RELEASE-NAME-0", "type": "macvlan", "master": "ens3s0", "ipam": {"type": "dhcp"}}'
asserts:
- hasDocuments:
count: 3
- isKind:
of: NetworkAttachmentDefinition
- isAPIVersion:
of: k8s.cni.cncf.io/v1
- equal:
path: spec
value:
config: '{"cniVersion": "0.3.1", "name": "ix-RELEASE-NAME-0", "type": "macvlan", "master": "ens3s0", "ipam": {"type": "dhcp"}}'
- equal:
path: metadata.name
value: ix-RELEASE-NAME-0
- it: should pass with externalInterface defined (annotation check)
documentIndex: &deploymentDoc 1
set:
# Only to pass validation
externalInterfaces:
- hostInterface: ens3s0
ipam:
type: dhcp
# Simulate the ix Injected values
ixExternalInterfacesConfiguration:
- '{"cniVersion": "0.3.1", "name": "ix-RELEASE-NAME-0", "type": "macvlan", "master": "ens3s0", "ipam": {"type": "dhcp"}}'
ixExternalInterfacesConfigurationNames:
- ix-RELEASE-NAME-0
asserts:
- hasDocuments:
count: 3
- isKind:
of: Deployment
- isSubset:
path: metadata.annotations
content:
k8s.v1.cni.cncf.io/networks: ix-RELEASE-NAME-0
- isNotNull:
path: metadata.annotations.rollme
- it: should pass with externalInterface defined, multiple entries (First Doc)
documentIndex: *externalInterfaceDoc
set:
# Only to pass validation
externalInterfaces:
- hostInterface: ens3s0
ipam:
type: dhcp
# Simulate the ix Injected values
ixExternalInterfacesConfiguration:
- '{"cniVersion": "0.3.1", "name": "ix-RELEASE-NAME-0", "type": "macvlan", "master": "ens3s0", "ipam": {"type": "dhcp"}}'
- '{"cniVersion": "0.3.1", "name": "ix-RELEASE-NAME-1", "type": "macvlan", "master": "ens5s0", "ipam": {"type": "dhcp"}}'
ixExternalInterfacesConfigurationNames:
- ix-RELEASE-NAME-0
asserts:
- hasDocuments:
count: 4
- isKind:
of: NetworkAttachmentDefinition
- isAPIVersion:
of: k8s.cni.cncf.io/v1
- equal:
path: spec
value:
config: '{"cniVersion": "0.3.1", "name": "ix-RELEASE-NAME-0", "type": "macvlan", "master": "ens3s0", "ipam": {"type": "dhcp"}}'
- equal:
path: metadata.name
value: ix-RELEASE-NAME-0
- it: should pass with externalInterface defined, multiple entries (Second Doc)
documentIndex: &otherExternalInterfaceDoc 1
set:
# Only to pass validation
externalInterfaces:
- hostInterface: ens3s0
ipam:
type: dhcp
# Simulate the ix Injected values
ixExternalInterfacesConfiguration:
- '{"cniVersion": "0.3.1", "name": "ix-RELEASE-NAME-0", "type": "macvlan", "master": "ens3s0", "ipam": {"type": "dhcp"}}'
- '{"cniVersion": "0.3.1", "name": "ix-RELEASE-NAME-1", "type": "macvlan", "master": "ens5s0", "ipam": {"type": "dhcp"}}'
asserts:
- hasDocuments:
count: 4
- isKind:
of: NetworkAttachmentDefinition
- isAPIVersion:
of: k8s.cni.cncf.io/v1
- equal:
path: spec
value:
config: '{"cniVersion": "0.3.1", "name": "ix-RELEASE-NAME-1", "type": "macvlan", "master": "ens5s0", "ipam": {"type": "dhcp"}}'
- equal:
path: metadata.name
value: ix-RELEASE-NAME-1
- it: should pass with externalInterface defined, multiple entries (annotation check)
documentIndex: &deploymentDoc 2
set:
# Only to pass validation
externalInterfaces:
- hostInterface: ens3s0
ipam:
type: dhcp
# Simulate the ix Injected values
ixExternalInterfacesConfiguration:
- '{"cniVersion": "0.3.1", "name": "ix-RELEASE-NAME-0", "type": "macvlan", "master": "ens3s0", "ipam": {"type": "dhcp"}}'
- '{"cniVersion": "0.3.1", "name": "ix-RELEASE-NAME-1", "type": "macvlan", "master": "ens5s0", "ipam": {"type": "dhcp"}}'
ixExternalInterfacesConfigurationNames:
- ix-RELEASE-NAME-0
- ix-RELEASE-NAME-1
asserts:
- hasDocuments:
count: 4
- isKind:
of: Deployment
- isSubset:
path: metadata.annotations
content:
k8s.v1.cni.cncf.io/networks: ix-RELEASE-NAME-0, ix-RELEASE-NAME-1
- isNotNull:
path: metadata.annotations.rollme
- it: should pass with externalInterface defined and global annotations, multiple entries
documentIndex: &externalInterfaceDoc 0
set:
global:
annotations:
key1: value1
key2: value2
# Only to pass validation
externalInterfaces:
- hostInterface: ens3s0
ipam:
type: dhcp
# Simulate the ix Injected values
ixExternalInterfacesConfiguration:
- '{"cniVersion": "0.3.1", "name": "ix-RELEASE-NAME-0", "type": "macvlan", "master": "ens3s0", "ipam": {"type": "dhcp"}}'
asserts:
- hasDocuments:
count: 3
- isKind:
of: NetworkAttachmentDefinition
- isAPIVersion:
of: k8s.cni.cncf.io/v1
- equal:
path: metadata.annotations
value:
key1: value1
key2: value2
- it: should pass with externalInterface defined and global annotations from tpl, multiple entries
documentIndex: &externalInterfaceDoc 0
set:
k1: value1
k2: value2
global:
annotations:
key1: "{{ .Values.k1 }}"
key2: "{{ .Values.k2 }}"
# Only to pass validation
externalInterfaces:
- hostInterface: ens3s0
ipam:
type: dhcp
# Simulate the ix Injected values
ixExternalInterfacesConfiguration:
- '{"cniVersion": "0.3.1", "name": "ix-RELEASE-NAME-0", "type": "macvlan", "master": "ens3s0", "ipam": {"type": "dhcp"}}'
asserts:
- hasDocuments:
count: 3
- isKind:
of: NetworkAttachmentDefinition
- isAPIVersion:
of: k8s.cni.cncf.io/v1
- equal:
path: metadata.annotations
value:
key1: value1
key2: value2
- it: should pass with externalInterface defined and global labels, multiple entries
documentIndex: &externalInterfaceDoc 0
set:
global:
labels:
key1: value1
key2: value2
# Only to pass validation
externalInterfaces:
- hostInterface: ens3s0
ipam:
type: dhcp
# Simulate the ix Injected values
ixExternalInterfacesConfiguration:
- '{"cniVersion": "0.3.1", "name": "ix-RELEASE-NAME-0", "type": "macvlan", "master": "ens3s0", "ipam": {"type": "dhcp"}}'
asserts:
- hasDocuments:
count: 3
- isKind:
of: NetworkAttachmentDefinition
- isAPIVersion:
of: k8s.cni.cncf.io/v1
- equal:
path: metadata.labels
value:
app: common-test
app.kubernetes.io/instance: RELEASE-NAME
app.kubernetes.io/managed-by: Helm
app.kubernetes.io/name: common-test
app.kubernetes.io/version: v1.2.3
helm-revision: "0"
helm.sh/chart: common-test-1.0.0
key1: value1
key2: value2
release: RELEASE-NAME
- it: should pass with externalInterface defined and global labels from tpl, multiple entries
documentIndex: &externalInterfaceDoc 0
set:
k1: value1
k2: value2
global:
labels:
key1: "{{ .Values.k1 }}"
key2: "{{ .Values.k2 }}"
# Only to pass validation
externalInterfaces:
- hostInterface: ens3s0
ipam:
type: dhcp
# Simulate the ix Injected values
ixExternalInterfacesConfiguration:
- '{"cniVersion": "0.3.1", "name": "ix-RELEASE-NAME-0", "type": "macvlan", "master": "ens3s0", "ipam": {"type": "dhcp"}}'
asserts:
- hasDocuments:
count: 3
- isKind:
of: NetworkAttachmentDefinition
- isAPIVersion:
of: k8s.cni.cncf.io/v1
- equal:
path: metadata.labels
value:
app: common-test
app.kubernetes.io/instance: RELEASE-NAME
app.kubernetes.io/managed-by: Helm
app.kubernetes.io/name: common-test
app.kubernetes.io/version: v1.2.3
helm-revision: "0"
helm.sh/chart: common-test-1.0.0
key1: value1
key2: value2
release: RELEASE-NAME

22
library/common/1.0.0/templates/class/_externalInterfaces.tpl Normal file
View File

@@ -0,0 +1,22 @@
{{- define "ix.v1.common.class.externalInterface" -}}
{{- $iface := .iface -}}
{{- $index := .index -}}
{{- $root := .root }}
---
apiVersion: {{ include "ix.v1.common.capabilities.externalInterfaces.apiVersion" . }}
kind: NetworkAttachmentDefinition
metadata:
name: ix-{{ $root.Release.Name }}-{{ $index }}
{{- $labels := (include "ix.v1.common.labels" $root | fromYaml) -}}
{{- with (include "ix.v1.common.util.labels.render" (dict "root" $root "labels" $labels) | trim) }}
labels:
{{- . | nindent 4 }}
{{- end }}
{{- $annotations := (include "ix.v1.common.annotations" $root | fromYaml) -}}
{{- with (include "ix.v1.common.util.annotations.render" (dict "root" $root "annotations" $annotations) | trim) }}
annotations:
{{- . | nindent 4 }}
{{- end }}
spec:
config: {{ $iface | squote }}
{{- end -}}

2
library/common/1.0.0/templates/lib/pod/_volumes.tpl
View File

@@ -79,7 +79,7 @@ you can specify a size for memory backed volumes.
server: {{ required (printf "NFS Server not set on item %s" $index) $persistence.server }}
path: {{ required (printf "NFS Path not set on item %s" $index) $persistence.path }}
{{- else if eq $persistence.type "ix-volumes" -}} {{/* ix-volumes */}}
{{/* TODO: Implement ix-volumes */}}
{{/* TODO: Implement ix-volumes + add hostpathvalidation? */}}
{{- else if eq $persistence.type "custom" }} {{/* Custom, in case we want to add something once */}}
{{- tpl ( toYaml $persistence.volumeSpec ) $root | nindent 2 }}
{{- else -}}

9
library/common/1.0.0/templates/spawner/_externalInterfaces.tpl Normal file
View File

@@ -0,0 +1,9 @@
{{- define "ix.v1.common.spawner.externalInterface" -}}
{{/* Validate that data from externalInterfaces are correct before start creating objects */}}
{{- range .Values.externalInterfaces -}}
{{- include "ix.v1.common.externalInterface.validate" (dict "iface" .) -}}
{{- end -}}
{{- range $index, $iface := .Values.ixExternalInterfacesConfiguration -}}
{{- include "ix.v1.common.class.externalInterface" (dict "iface" $iface "index" $index "root" $) -}}
{{- end -}}
{{- end -}}