fix: Ensure 822 template renders correctly on Debian (#6381)

Fixes GH-6380

Author: TheRealFalcon

templates/sources.list.debian.deb822.tmpl

@@ -29,6 +29,6 @@ Signed-By: {{primary_key | default('/usr/share/keyrings/debian-archive-keyring.g
 ## Major bug fix updates produced after the final release of the distribution.
 Types: deb deb-src
 URIs: {{security}}
-Suites: {{codename}}{% if codename in ('buster', 'stretch') %}/updates{% else %}-security{% endif %}
+Suites: {{codename}}{% if codename in ('buster', 'stretch') %}/updates{% else %}-security{% endif +%}
 Components: main
 Signed-By: {{security_key | default(primary_key, true) | default('/usr/share/keyrings/debian-archive-keyring.gpg', true)}}

tests/unittests/helpers.py

@@ -475,6 +475,16 @@ def skipUnlessJinja():
     return skipIf(not JINJA_AVAILABLE, "No jinja dependency present.")
 
 
+@skipUnlessJinja()
+def skipUnlessJinjaVersionGreaterThan(version=(0, 0, 0)):
+    import jinja2
+
+    return skipIf(
+        condition=tuple(map(int, jinja2.__version__.split("."))) < version,
+        reason=f"jinj2 version is less than {version}",
+    )
+
+
 def skipIfJinja():
     return skipIf(JINJA_AVAILABLE, "Jinja dependency present.")
 

tests/unittests/test_render_template.py

@@ -6,6 +6,7 @@
 
 from cloudinit import subp, templater, util
 from tests.helpers import cloud_init_project_dir
+from tests.unittests.helpers import skipUnlessJinjaVersionGreaterThan
 
 # TODO(Look to align with tools.render-template or cloudinit.distos.OSFAMILIES)
 DISTRO_VARIANTS = [
@@ -124,3 +125,99 @@ def test_variant_sets_network_renderer_priority_in_cloud_cfg(
             system_cfg = util.load_yaml(stream.read())
 
         assert renderers == system_cfg["system_info"]["network"]["renderers"]
+
+
+EXPECTED_DEBIAN = """\
+deb testmirror testcodename main
+deb-src testmirror testcodename main
+deb testsecurity testcodename-security main
+deb-src testsecurity testcodename-security main
+deb testmirror testcodename-updates main
+deb-src testmirror testcodename-updates main
+deb testmirror testcodename-backports main
+deb-src testmirror testcodename-backports main
+"""
+
+EXPECTED_DEBIAN_DEB822 = """\
+Types: deb deb-src
+URIs: testmirror
+Suites: testcodename testcodename-updates testcodename-backports
+Components: main
+Signed-By: /usr/share/keyrings/debian-archive-keyring.gpg
+Types: deb deb-src
+URIs: testsecurity
+Suites: testcodename-security
+Components: main
+Signed-By: /usr/share/keyrings/debian-archive-keyring.gpg
+"""
+
+EXPECTED_UBUNTU = """\
+deb testmirror testcodename main restricted
+deb testmirror testcodename-updates main restricted
+deb testmirror testcodename universe
+deb testmirror testcodename-updates universe
+deb testmirror testcodename multiverse
+deb testmirror testcodename-updates multiverse
+deb testmirror testcodename-backports main restricted universe multiverse
+deb testsecurity testcodename-security main restricted
+deb testsecurity testcodename-security universe
+deb testsecurity testcodename-security multiverse
+"""
+
+EXPECTED_UBUNTU_DEB822 = """\
+Types: deb
+URIs: testmirror
+Suites: testcodename testcodename-updates testcodename-backports
+Components: main universe restricted multiverse
+Signed-By: /usr/share/keyrings/ubuntu-archive-keyring.gpg
+Types: deb
+URIs: testsecurity
+Suites: testcodename-security
+Components: main universe restricted multiverse
+Signed-By: /usr/share/keyrings/ubuntu-archive-keyring.gpg
+"""
+
+
+class TestRenderSourcesList:
+    @pytest.mark.parametrize(
+        "template_path,expected",
+        [
+            pytest.param(
+                "templates/sources.list.debian.tmpl",
+                EXPECTED_DEBIAN,
+                id="debian",
+            ),
+            pytest.param(
+                "templates/sources.list.debian.deb822.tmpl",
+                EXPECTED_DEBIAN_DEB822,
+                id="debian_822",
+            ),
+            pytest.param(
+                "templates/sources.list.ubuntu.tmpl",
+                EXPECTED_UBUNTU,
+                id="ubuntu",
+            ),
+            pytest.param(
+                "templates/sources.list.ubuntu.deb822.tmpl",
+                EXPECTED_UBUNTU_DEB822,
+                id="ubuntu_822",
+            ),
+        ],
+    )
+    @skipUnlessJinjaVersionGreaterThan((3, 0, 0))
+    def test_render_sources_list_templates(
+        self, tmpdir, template_path, expected
+    ):
+        params = {
+            "mirror": "testmirror",
+            "security": "testsecurity",
+            "codename": "testcodename",
+        }
+        template_path = cloud_init_project_dir(template_path)
+        rendered = templater.render_string(open(template_path).read(), params)
+        filtered = "\n".join(
+            line
+            for line in rendered.splitlines()
+            if line.strip() and not line.strip().startswith("#")
+        )
+        assert filtered.strip() == expected.strip()