|
| 1 | +#!/usr/bin/env bash |
| 2 | +set -euo pipefail |
| 3 | + |
| 4 | +CHART_DIR="${CHART_DIR:-otel-integration/k8s-helm}" |
| 5 | +GOLDEN_DIR="${GOLDEN_DIR:-${CHART_DIR}/tests/golden}" |
| 6 | +RELEASE_NAME="${HELM_GOLDEN_RELEASE_NAME:-render-check}" |
| 7 | +DOMAIN="${HELM_GOLDEN_DOMAIN:-eu2.coralogix.com}" |
| 8 | +CLUSTER_NAME="${HELM_GOLDEN_CLUSTER_NAME:-golden-render}" |
| 9 | +UPDATE_GOLDEN=false |
| 10 | + |
| 11 | +cases=( |
| 12 | + "tail-sampling:tail-sampling-values.yaml" |
| 13 | + "windows:values-windows.yaml" |
| 14 | + "eks-fargate:values-eks-fargate.yaml" |
| 15 | + "ebpf-profiler:values-ebpf-profiler.yaml" |
| 16 | +) |
| 17 | + |
| 18 | +usage() { |
| 19 | + cat <<'EOF' |
| 20 | +Usage: .github/scripts/check-helm-golden-renders.sh [--update] |
| 21 | +
|
| 22 | +Renders high-risk otel-integration Helm presets and compares them with the |
| 23 | +checked-in golden files. |
| 24 | +
|
| 25 | + --update Regenerate the checked-in golden files instead of diffing them. |
| 26 | +EOF |
| 27 | +} |
| 28 | + |
| 29 | +while (($#)); do |
| 30 | + case "$1" in |
| 31 | + --update) |
| 32 | + UPDATE_GOLDEN=true |
| 33 | + ;; |
| 34 | + -h|--help) |
| 35 | + usage |
| 36 | + exit 0 |
| 37 | + ;; |
| 38 | + *) |
| 39 | + echo "Unknown argument: $1" >&2 |
| 40 | + usage >&2 |
| 41 | + exit 1 |
| 42 | + ;; |
| 43 | + esac |
| 44 | + shift |
| 45 | +done |
| 46 | + |
| 47 | +require_cmd() { |
| 48 | + local cmd="$1" |
| 49 | + if ! command -v "$cmd" >/dev/null 2>&1; then |
| 50 | + echo "Missing required command: $cmd" >&2 |
| 51 | + exit 1 |
| 52 | + fi |
| 53 | +} |
| 54 | + |
| 55 | +render_case() { |
| 56 | + local name="$1" |
| 57 | + local values_file="$2" |
| 58 | + local output_file="$3" |
| 59 | + |
| 60 | + helm template "$RELEASE_NAME" "$CHART_DIR" \ |
| 61 | + -f "${CHART_DIR}/values.yaml" \ |
| 62 | + -f "${CHART_DIR}/${values_file}" \ |
| 63 | + --set-string "global.domain=${DOMAIN}" \ |
| 64 | + --set-string "global.clusterName=${CLUSTER_NAME}" | |
| 65 | + sed -e 's/[[:blank:]]*$//' \ |
| 66 | + | awk ' |
| 67 | + /^$/ { blanks++; next } |
| 68 | + /^---$/ { blanks = 0; print; next } |
| 69 | + { |
| 70 | + while (blanks > 0) { |
| 71 | + print ""; |
| 72 | + blanks--; |
| 73 | + } |
| 74 | + print; |
| 75 | + } |
| 76 | + END { |
| 77 | + while (blanks > 0) { |
| 78 | + print ""; |
| 79 | + blanks--; |
| 80 | + } |
| 81 | + } |
| 82 | + ' \ |
| 83 | + > "$output_file" |
| 84 | +} |
| 85 | + |
| 86 | +require_cmd helm |
| 87 | +require_cmd diff |
| 88 | +require_cmd sed |
| 89 | +require_cmd awk |
| 90 | + |
| 91 | +helm repo add --force-update open-telemetry https://open-telemetry.github.io/opentelemetry-helm-charts >/dev/null |
| 92 | +helm repo add --force-update coralogix-charts-virtual https://cgx.jfrog.io/artifactory/coralogix-charts-virtual >/dev/null |
| 93 | +helm repo add --force-update coralogix-charts https://cgx.jfrog.io/artifactory/coralogix-charts >/dev/null |
| 94 | +helm repo update >/dev/null |
| 95 | +helm dependency build "$CHART_DIR" |
| 96 | + |
| 97 | +if [ "$UPDATE_GOLDEN" = true ]; then |
| 98 | + mkdir -p "$GOLDEN_DIR" |
| 99 | +fi |
| 100 | + |
| 101 | +tmpdir="$(mktemp -d)" |
| 102 | +trap 'rm -rf "$tmpdir"' EXIT |
| 103 | + |
| 104 | +failed=0 |
| 105 | +for case in "${cases[@]}"; do |
| 106 | + name="${case%%:*}" |
| 107 | + values_file="${case#*:}" |
| 108 | + actual="${tmpdir}/${name}.yaml" |
| 109 | + expected="${GOLDEN_DIR}/${name}.yaml" |
| 110 | + |
| 111 | + if [ "$UPDATE_GOLDEN" = true ]; then |
| 112 | + render_case "$name" "$values_file" "$expected" |
| 113 | + echo "Rendered ${expected}" |
| 114 | + continue |
| 115 | + fi |
| 116 | + |
| 117 | + if [ ! -f "$expected" ]; then |
| 118 | + echo "Missing golden render: $expected" >&2 |
| 119 | + failed=1 |
| 120 | + continue |
| 121 | + fi |
| 122 | + |
| 123 | + render_case "$name" "$values_file" "$actual" |
| 124 | + |
| 125 | + if ! diff -u "$expected" "$actual"; then |
| 126 | + echo "Golden render mismatch for ${name}. Re-render with .github/scripts/check-helm-golden-renders.sh --update after reviewing the manifest change." >&2 |
| 127 | + failed=1 |
| 128 | + fi |
| 129 | +done |
| 130 | + |
| 131 | +exit "$failed" |
0 commit comments