Merge pull request #791 from element-hq/bbz/template-ingress-hosts-in-notes

Template `<component>.ingress.host` correctly in `NOTES.txt`

Author: benbz

charts/matrix-stack/templates/NOTES.txt

@@ -30,13 +30,13 @@ kubectl exec -n {{ $.Release.Namespace }} -it deployment/{{ $.Release.Name }}-ma
 
 {{- if and $.Values.elementWeb.enabled $.Values.elementWeb.ingress.host }}
 
-Your chat client is available at: https://{{ $.Values.elementWeb.ingress.host }}
+Your chat client is available at: https://{{ tpl $.Values.elementWeb.ingress.host $ }}
 {{- end }}
 {{- if and $.Values.matrixAuthenticationService.enabled $.Values.matrixAuthenticationService.ingress.host }}
 
-You can manage your account at: https://{{ $.Values.matrixAuthenticationService.ingress.host }}
+You can manage your account at: https://{{ tpl $.Values.matrixAuthenticationService.ingress.host $ }}
 {{- end }}
 {{- if $.Values.wellKnownDelegation.enabled }}
 
-To successfully federate, make sure that the Well-Known Delegation works properly using the matrix-federation-tester: https://federationtester.matrix.org/#{{ $.Values.serverName }}
+To successfully federate, make sure that the Well-Known Delegation works properly using the matrix-federation-tester: https://federationtester.matrix.org/#{{ tpl $.Values.serverName $ }}
 {{- end }}

newsfragments/791.fixed.md

@@ -0,0 +1 @@
+Fix templated `<component>.ingress.host` values not being rendered correctly in `NOTES.txt`.

newsfragments/791.internal.md

@@ -0,0 +1 @@
+CI: add a test that we don't have anything that looks like a template string in the rendered files.

tests/manifests/test_basic.py

@@ -3,6 +3,7 @@
 # SPDX-License-Identifier: AGPL-3.0-only
 
 import pytest
+import yaml
 
 from . import PropertyType, all_deployables_details, values_files_to_test
 from .utils import template_id
@@ -123,3 +124,15 @@ async def test_default_values_file_sets_stub_values(base_values):
             assert hostAliases == unset_marker, (
                 f"{deployable_details.name} has default {hostAliases=} rather than being unset"
             )
+
+
+@pytest.mark.parametrize("values_file", values_files_to_test)
+@pytest.mark.asyncio_cooperative
+async def test_doesnt_contain_any_unrendered_helm_templates(templates):
+    # This test does not cover `NOTES.txt` as https://github.com/helm/helm/issues/6901
+    for template in templates:
+        for idx, line in enumerate(yaml.safe_dump(template).splitlines()):
+            assert ".Values." not in line, (
+                f"{template_id(template)} contains what looks like an un-rendered Helm template "
+                f"on line number {idx + 1}"
+            )