Skip to content

Commit

Permalink
Add chart validation tests
Browse files Browse the repository at this point in the history
validate-charts runs as part of 'make validate' step and checks
that all images used in packaged charts:
- use systemGlobalRegistry
- are present in script/build-images

Signed-off-by: Thomas Ferrandiz <[email protected]>
  • Loading branch information
thomasferrandiz committed Sep 29, 2023
1 parent 30f03ac commit 2da819b
Show file tree
Hide file tree
Showing 7 changed files with 217 additions and 22 deletions.
21 changes: 5 additions & 16 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ RUN set -x && \
py3-pip \
pigz \
tar \
yq
yq \
helm

RUN if [ "${ARCH}" = "amd64" ]; then \
apk --no-cache add mingw-w64-gcc; \
Expand Down Expand Up @@ -105,21 +106,9 @@ ARG KUBERNETES_VERSION=""
ARG CACHEBUST="cachebust"
COPY charts/ /charts/
RUN echo ${CACHEBUST}>/dev/null
RUN CHART_VERSION="1.14.100" CHART_FILE=/charts/rke2-cilium.yaml CHART_BOOTSTRAP=true /charts/build-chart.sh
RUN CHART_VERSION="v3.26.1-build2023080200" CHART_FILE=/charts/rke2-canal.yaml CHART_BOOTSTRAP=true /charts/build-chart.sh
RUN CHART_VERSION="v3.26.101" CHART_FILE=/charts/rke2-calico.yaml CHART_BOOTSTRAP=true /charts/build-chart.sh
RUN CHART_VERSION="v3.26.101" CHART_FILE=/charts/rke2-calico-crd.yaml CHART_BOOTSTRAP=true /charts/build-chart.sh
RUN CHART_VERSION="1.24.004" CHART_FILE=/charts/rke2-coredns.yaml CHART_BOOTSTRAP=true /charts/build-chart.sh
RUN CHART_VERSION="4.6.100" CHART_FILE=/charts/rke2-ingress-nginx.yaml CHART_BOOTSTRAP=false /charts/build-chart.sh
RUN CHART_VERSION="2.11.100-build2023051509" CHART_FILE=/charts/rke2-metrics-server.yaml CHART_BOOTSTRAP=false /charts/build-chart.sh
RUN CHART_VERSION="v4.0.2-build2023081100" CHART_FILE=/charts/rke2-multus.yaml CHART_BOOTSTRAP=true /charts/build-chart.sh
RUN CHART_VERSION="1.5.100" CHART_FILE=/charts/rancher-vsphere-cpi.yaml CHART_BOOTSTRAP=true /charts/build-chart.sh
RUN CHART_VERSION="3.0.1-rancher101" CHART_FILE=/charts/rancher-vsphere-csi.yaml CHART_BOOTSTRAP=true /charts/build-chart.sh
RUN CHART_VERSION="0.2.200" CHART_FILE=/charts/harvester-cloud-provider.yaml CHART_BOOTSTRAP=true /charts/build-chart.sh
RUN CHART_VERSION="0.1.1600" CHART_FILE=/charts/harvester-csi-driver.yaml CHART_BOOTSTRAP=true /charts/build-chart.sh
RUN CHART_VERSION="1.7.202" CHART_FILE=/charts/rke2-snapshot-controller.yaml CHART_BOOTSTRAP=false /charts/build-chart.sh
RUN CHART_VERSION="1.7.202" CHART_FILE=/charts/rke2-snapshot-controller-crd.yaml CHART_BOOTSTRAP=false /charts/build-chart.sh
RUN CHART_VERSION="1.7.300" CHART_FILE=/charts/rke2-snapshot-validation-webhook.yaml CHART_BOOTSTRAP=false /charts/build-chart.sh
RUN /charts/build-charts.sh


RUN rm -vf /charts/*.sh /charts/*.md

# rke2-runtime image
Expand Down
7 changes: 6 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ ci-shell: clean .dapper ## Launch a shell in the CI environment
.PHONY: dapper-ci
dapper-ci: .ci ## Used by Drone CI, does the same as "ci" but in a Drone way

.ci: validate build package
.ci: validate validate-charts build package

.PHONY: build
build: ## Build using host go tools
Expand Down Expand Up @@ -71,6 +71,11 @@ validate: ## Run go fmt/vet
validate-release:
./scripts/validate-release

.PHONY: validate-charts
validate-charts:
./scripts/validate-charts


.PHONY: run
run: build-debug
./scripts/run
Expand Down
12 changes: 12 additions & 0 deletions charts/build-charts.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
#!/usr/bin/env bash

set -eux -o pipefail

readarray charts < <(yq e -o=j -I=0 '.charts[]' charts/chart_versions.yaml )
for chart in "${charts[@]}"; do
version=$(echo "$chart" | yq e '.version' -)
filename=$(echo "$chart" | yq e '.filename' -)
bootstrap=$(echo "$chart" | yq e '.bootstrap' -)

CHART_VERSION=$version CHART_FILE=$filename CHART_BOOTSTRAP=$bootstrap /charts/build-chart.sh
done
46 changes: 46 additions & 0 deletions charts/chart_versions.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
charts:
- version: 1.14.100
filename: /charts/rke2-cilium.yaml
bootstrap: true
- version: v3.26.1-build2023080200
filename: /charts/rke2-canal.yaml
bootstrap: true
- version: v3.26.101
filename: /charts/rke2-calico.yaml
bootstrap: true
- version: v3.26.101
filename: /charts/rke2-calico-crd.yaml
bootstrap: true
- version: 1.24.004
filename: /charts/rke2-coredns.yaml
bootstrap: true
- version: 4.6.100
filename: /charts/rke2-ingress-nginx.yaml
bootstrap: false
- version: 2.11.100-build2023051509
filename: /charts/rke2-metrics-server.yaml
bootstrap: false
- version: v4.0.2-build2023081100
filename: /charts/rke2-multus.yaml
bootstrap: true
- version: 1.5.100
filename: /charts/rancher-vsphere-cpi.yaml
bootstrap: true
- version: 3.0.1-rancher101
filename: /charts/rancher-vsphere-csi.yaml
bootstrap: true
- version: 0.2.200
filename: /charts/harvester-cloud-provider.yaml
bootstrap: true
- version: 0.1.1600
filename: /charts/harvester-csi-driver.yaml
bootstrap: true
- version: 1.7.202
filename: /charts/rke2-snapshot-controller.yaml
bootstrap: false
- version: 1.7.202
filename: /charts/rke2-snapshot-controller-crd.yaml
bootstrap: false
- version: 1.7.300
filename: /charts/rke2-snapshot-validation-webhook.yaml
bootstrap: false
8 changes: 4 additions & 4 deletions scripts/build-images
Original file line number Diff line number Diff line change
Expand Up @@ -89,10 +89,10 @@ xargs -n1 -t docker image pull --quiet << EOF > build/images-harvester.txt
${REGISTRY}/rancher/harvester-cloud-provider:v0.2.0
${REGISTRY}/rancher/mirrored-kube-vip-kube-vip-iptables:v0.6.0
${REGISTRY}/rancher/harvester-csi-driver:v0.1.5
${REGISTRY}/rancher/longhornio-csi-node-driver-registrar:v2.3.0
${REGISTRY}/rancher/longhornio-csi-resizer:v1.2.0
${REGISTRY}/rancher/longhornio-csi-provisioner:v2.1.2
${REGISTRY}/rancher/longhornio-csi-attacher:v3.2.1
${REGISTRY}/rancher/mirrored-longhornio-csi-node-driver-registrar:v2.3.0
${REGISTRY}/rancher/mirrored-longhornio-csi-resizer:v1.2.0
${REGISTRY}/rancher/mirrored-longhornio-csi-provisioner:v2.1.2
${REGISTRY}/rancher/mirrored-longhornio-csi-attacher:v3.2.1
EOF
fi
# Continue to provide a legacy airgap archive set with the default CNI images
Expand Down
2 changes: 1 addition & 1 deletion scripts/validate
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ function check_win_binaries() {
#fi

CALICO_WINDOWS_VERSION=$(grep 'CALICO_VERSION=' Dockerfile.windows | cut -d '=' -f 2- | grep -oE "v([0-9]+)\.([0-9]+)")
CALICO_LINUX_VERSION=$(grep "rke2-calico.yaml" Dockerfile | grep 'CHART_VERSION=' | cut -d '=' -f 2- | grep -oE "v([0-9]+)\.([0-9]+)")
CALICO_LINUX_VERSION=$(yq '.charts[] | select(.filename == "/charts/rke2-canal.yaml").version' charts/chart_versions.yaml | cut -d ',' -f 1- | grep -oE "v([0-9]+)\.([0-9]+)")
if [ ! "$CALICO_WINDOWS_VERSION" = "$CALICO_LINUX_VERSION" ]; then
fatal "Calico windows binary version [$CALICO_WINDOWS_VERSION] does not match Calico chart version [$CALICO_LINUX_VERSION]"
fi
Expand Down
143 changes: 143 additions & 0 deletions scripts/validate-charts
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
#!/usr/bin/env bash
set -e

info() {
echo '[INFO] ' "$@"
}

error() {
echo '[ERROR] ' "$@" >&2
}

fatal() {
echo '[ERROR] ' "$@" >&2
exit 1
}

cleanup() {
exit_code=$?
trap - EXIT INT
rm -rf /tmp/tmp.*.tar.gz
exit ${exit_code}
}
trap cleanup EXIT INT


download_chart() {
chart_version=$1
chart_name=$2
bootstrap=$3

chart_package=${chart_name%%-crd}

chart_url=${CHART_REPO:="https://rke2-charts.rancher.io"}/assets/${chart_package}/${chart_name}-${chart_version:="v0.0.0"}.tgz

chart_tmp=$(mktemp --suffix .tar.gz)

curl -fsSL "${chart_url}" -o "${chart_tmp}"

echo $chart_tmp
}

check_system_registry() {
chart_version=$1
chart_name=$2
chart_tmp=$3

yaml_tmp=$(mktemp --suffix .yaml)

values="global.systemDefaultRegistry=my-registry,global.cattle.systemDefaultRegistry=my-registry"
if [[ $chart_name == 'rancher-vsphere-csi' ]]; then
values="$values,vCenter.clusterId=test-id"
fi
helm template test-chart --set $values $chart_tmp > $yaml_tmp;

awk '$1 ~ /^image:/ {
if( $2 !~ /my-registry/ && $2 !~ busybox) {
print $2
}
}
' $yaml_tmp
}

check_airgap() {
chart_version=$1
chart_name=$2
chart_tmp=$3

if [[ $chart_name == 'rancher-vsphere-cpi' ]]; then
return 0
fi

yaml_tmp=$(mktemp --suffix .yaml)
if [[ $chart_name == 'rancher-vsphere-csi' ]]; then
values="vCenter.clusterId=test-id"
helm template test-chart --set $values $chart_tmp > $yaml_tmp;
else
helm template test-chart $chart_tmp > $yaml_tmp;
fi

awk '$1 ~ /^image:/ {
gsub(/"/, "", $2)
gsub(/^docker.io/, "", $2)
print $2
}
' $yaml_tmp | \
while read image
do
[ "$image" = "busybox" ] && continue
if ! grep -q $image scripts/build-images; then
echo $image
fi
done
}

declare -A NO_SYSTEM_REGISTRY
declare -A NOT_FOUND


readarray charts < <(yq e -o=j -I=0 '.charts[]' charts/chart_versions.yaml )
for chart in "${charts[@]}"; do
version=$(echo "$chart" | yq e '.version' -)
filename=$(echo "$chart" | yq e '.filename' -)
bootstrap=$(echo "$chart" | yq e '.bootstrap' -)

chart_name=$(basename "${filename%%.yaml}")
chart_tmp=$(download_chart $version $chart_name $bootstrap)

info "Validating chart $chart_name, version $version..."

no_system_registry=$(check_system_registry $version $chart_name $chart_tmp)
if ! [ -z "$no_system_registry" ]; then
NO_SYSTEM_REGISTRY[$chart_name]=$no_system_registry
fi

not_found=$(check_airgap $version $chart_name $chart_tmp)
if ! [ -z "$not_found" ]; then
NOT_FOUND[$chart_name]=$not_found
fi
done

failed=0

if [ ${#NO_SYSTEM_REGISTRY[@]} -ge 1 ]; then
failed=1
for chart in "${!NO_SYSTEM_REGISTRY[@]}"
do
error "Images not using systemGlobalRegistry in chart '$chart': ${NO_SYSTEM_REGISTRY[$chart]}"
done
error "Please use systemGlobalRegistry for above images"
fi

if [ ${#NOT_FOUND[@]} -ge 1 ]; then
failed=1
for chart in "${!NOT_FOUND[@]}"
do
error "Missing images for chart '$chart': ${NOT_FOUND[$chart]}"
done
error "Please include above images in build-images"
fi

[ $failed = 1 ] && fatal "Please fix the issues above"

exit 0

0 comments on commit 2da819b

Please sign in to comment.