Adds helm test to reject a helm install with apiGateway.enabled=true

hashicorp · Mar 13, 2024 · c2efc8f · c2efc8f
1 parent 7c0506d
commit c2efc8f
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 0 deletions.
diff --git a/charts/consul/templates/_helpers.tpl b/charts/consul/templates/_helpers.tpl
@@ -682,4 +682,17 @@ Usage: {{ template "consul.versionInfo" }}
     {{- $sanitizedVersion = $versionInfo }}
 {{- end -}}
 {{- printf "%s" $sanitizedVersion | quote }}
+{{- end -}}
+
+{{/*
+Validate that the depraced stanze for .Values.apiGateway is not set.
+Cleanup server.extraConfig entries to avoid conflicting entries:
+    - server.enableAgentDebug:
+      - `enable_debug` should not exist in extraConfig
+Usage: {{ template "consul.validateExtraConfig" . }}
+*/}}
+{{- define "consul.validate_deprecated_apigateway_not_set" -}}
+    {{- if .Values.apiGateway}}
+    {{fail "[DEPRECATED and REMOVED] .Values.apiGateway is no longer supported as of Consul 1.19.0. Use connectInject.apiGateway instead."}}
+    {{- end -}}
 {{- end -}}
diff --git a/charts/consul/templates/gateway-resources-job.yaml b/charts/consul/templates/gateway-resources-job.yaml
@@ -1,3 +1,4 @@
+{{ template "consul.validate_deprecated_apigateway_not_set" . }}
 {{- if .Values.connectInject.enabled }}
 apiVersion: batch/v1
 kind: Job

diff --git a/charts/consul/test/unit/helpers.bats b/charts/consul/test/unit/helpers.bats
@@ -454,3 +454,12 @@ load _helpers
   [ "$status" -eq 1 ]
   [[ "$output" =~ "When the value global.experiments.resourceAPIs is set, terminatingGateways.enabled is currently unsupported." ]]
 }
+
+@test "helper/consul.validate_deprecated_apiGateway_not_set: fails if .values.apiGateway is set" {
+  cd `chart_dir`
+  run helm template \
+      -s templates/tests/test-runner.yaml \
+      --set 'apiGateway.enabled=true' .
+  [ "$status" -eq 1 ]
+  [[ "$output" =~ "[DEPRECATED and REMOVED] .Values.apiGateway is no longer supported as of Consul 1.19.0. Use connectInject.apiGateway instead." ]]
+}