chore: drop outdated code (#6798)

The biggest change is dropping jinja2 import handling code and testing
handlers. The jinja2 module has been imported directly in templater.py
since 24.1.

The unit test helper has some additional helpers that can be dropped as
well as overridden mock imports.

Author: holmanb

cloudinit/handlers/jinja_template.py

@@ -5,7 +5,9 @@
 import os
 import re
 from errno import EACCES
-from typing import Optional, Type
+from typing import Optional
+
+from jinja2 import exceptions, lexer
 
 from cloudinit import handlers
 from cloudinit.atomic_helper import b64d, json_dumps
@@ -19,15 +21,6 @@
 )
 from cloudinit.util import load_json, load_text_file
 
-JUndefinedError: Type[Exception]
-try:
-    from jinja2.exceptions import UndefinedError as JUndefinedError
-    from jinja2.lexer import operator_re
-except ImportError:
-    # No jinja2 dependency
-    JUndefinedError = Exception
-    operator_re = re.compile(r"[-.]")
-
 LOG = logging.getLogger(__name__)
 
 
@@ -147,7 +140,7 @@ def render_jinja_payload(payload, payload_fn, instance_data, debug=False):
         )
     try:
         rendered_payload = render_string(payload, instance_jinja_vars)
-    except (TypeError, JUndefinedError) as e:
+    except (TypeError, exceptions.UndefinedError) as e:
         LOG.warning("Ignoring jinja template for %s: %s", payload_fn, str(e))
         return None
     warnings = [
@@ -180,7 +173,7 @@ def get_jinja_variable_alias(orig_name: str) -> Optional[str]:
     :return: A string with any jinja operators replaced if needed. Otherwise,
         none if no alias required.
     """
-    alias_name = re.sub(operator_re, "_", orig_name)
+    alias_name = re.sub(lexer.operator_re, "_", orig_name)
     if alias_name != orig_name:
         return alias_name
     return None

cloudinit/templater.py

@@ -16,29 +16,14 @@
 import logging
 import re
 import sys
-from typing import Any
 
-from jinja2 import TemplateSyntaxError
+from jinja2 import DebugUndefined, Template, TemplateSyntaxError
 
 from cloudinit import performance
 from cloudinit import type_utils as tu
 from cloudinit import util
 from cloudinit.atomic_helper import write_file
 
-# After bionic EOL, mypy==1.0.0 will be able to type-analyse dynamic
-# base types, substitute this by:
-# JUndefined: typing.Type
-JUndefined: Any
-try:
-    from jinja2 import DebugUndefined as _DebugUndefined
-    from jinja2 import Template as JTemplate
-
-    JINJA_AVAILABLE = True
-    JUndefined = _DebugUndefined
-except (ImportError, AttributeError):
-    JINJA_AVAILABLE = False
-    JUndefined = object
-
 LOG = logging.getLogger(__name__)
 MISSING_JINJA_PREFIX = "CI_MISSING_JINJA_VAR/"
 
@@ -86,7 +71,7 @@ def format_error_message(
 
 # Mypy, and the PEP 484 ecosystem in general, does not support creating
 # classes with dynamic base types: https://stackoverflow.com/a/59636248
-class UndefinedJinjaVariable(JUndefined):
+class UndefinedJinjaVariable(DebugUndefined):
     """Class used to represent any undefined jinja template variable."""
 
     def __str__(self):
@@ -150,7 +135,7 @@ def jinja_render(content, params):
         try:
             with performance.Timed("Rendering jinja2 template"):
                 return (
-                    JTemplate(
+                    Template(
                         content,
                         undefined=UndefinedJinjaVariable,
                         trim_blocks=True,
@@ -181,13 +166,7 @@ def jinja_render(content, params):
                 "Unknown template rendering type '%s' requested"
                 % template_type
             )
-        if template_type == "jinja" and not JINJA_AVAILABLE:
-            LOG.warning(
-                "Jinja not available as the selected renderer for"
-                " desired template, reverting to the basic renderer."
-            )
-            return ("basic", basic_render, rest)
-        elif template_type == "jinja" and JINJA_AVAILABLE:
+        elif template_type == "jinja":
             return ("jinja", jinja_render, rest)
         # Only thing left over is the basic renderer (it is always available).
         return ("basic", basic_render, rest)

tests/unittests/analyze/test_boot.py

@@ -1,4 +1,5 @@
 import os
+from unittest import mock
 
 import pytest
 
@@ -11,7 +12,6 @@
     dist_check_timestamp,
     gather_timestamps_using_systemd,
 )
-from tests.unittests.helpers import mock
 
 err_code = (FAIL_CODE, -1, -1, -1)
 

tests/unittests/analyze/test_dump.py

@@ -4,6 +4,7 @@
 from contextlib import suppress
 from datetime import datetime, timezone
 from textwrap import dedent
+from unittest import mock
 
 import pytest
 
@@ -14,7 +15,6 @@
     parse_timestamp,
 )
 from cloudinit.util import write_file
-from tests.unittests.helpers import mock
 
 
 class TestParseTimestamp:

tests/unittests/cmd/devel/test_net_convert.py

@@ -1,13 +1,13 @@
 # This file is part of cloud-init. See LICENSE file for license information.
 
 import itertools
+from unittest import mock
 
 import pytest
 import yaml
 
 from cloudinit.cmd.devel import net_convert
 from cloudinit.distros.debian import NETWORK_FILE_HEADER
-from tests.unittests.helpers import mock
 
 M_PATH = "cloudinit.cmd.devel.net_convert."
 

tests/unittests/cmd/devel/test_render.py

@@ -1,14 +1,14 @@
 # This file is part of cloud-init. See LICENSE file for license information.
 
 from io import StringIO
+from unittest import mock
 
 import pytest
 
 from cloudinit.cmd.devel import render
 from cloudinit.helpers import Paths
 from cloudinit.templater import JinjaSyntaxParsingException
 from cloudinit.util import ensure_dir, write_file
-from tests.unittests.helpers import mock, skipUnlessJinja
 
 M_PATH = "cloudinit.cmd.devel.render."
 
@@ -87,7 +87,6 @@ def test_root_uses_sensitive_instance_data(self, m_paths, tmpdir):
                 assert render.render_template(user_data, None, False) == 0
         assert "rendering: jinja worked" in m_stdout.getvalue()
 
-    @skipUnlessJinja()
     def test_renders_instance_data_vars_in_template(self, caplog, tmpdir):
         """If user_data file is a jinja template render instance-data vars."""
         user_data = tmpdir.join("user-data")
@@ -103,7 +102,6 @@ def test_renders_instance_data_vars_in_template(self, caplog, tmpdir):
         )
         assert "rendering: jinja worked" == m_stdout.getvalue()
 
-    @skipUnlessJinja()
     def test_render_warns_and_gives_up_on_invalid_jinja_operation(
         self, caplog, tmpdir
     ):
@@ -119,7 +117,6 @@ def test_render_warns_and_gives_up_on_invalid_jinja_operation(
             ' "my_var"?' % user_data
         ) in caplog.text
 
-    @skipUnlessJinja()
     def test_jinja_load_error(self, caplog, tmpdir):
         user_data = tmpdir.join("user-data")
         write_file(user_data, "##template: jinja\nrendering: {{ my-var }}")
@@ -130,7 +127,6 @@ def test_jinja_load_error(self, caplog, tmpdir):
             "Cannot render from instance data due to exception" in caplog.text
         )
 
-    @skipUnlessJinja()
     def test_not_jinja_error(self, caplog, tmpdir):
         user_data = tmpdir.join("user-data")
         write_file(user_data, "{{ my-var }}")
@@ -141,7 +137,6 @@ def test_not_jinja_error(self, caplog, tmpdir):
             "Cannot render from instance data due to exception" in caplog.text
         )
 
-    @skipUnlessJinja()
     def test_no_user_data(self, caplog, tmpdir):
         user_data = tmpdir.join("user-data")
         write_file(user_data, "##template: jinja")
@@ -150,7 +145,6 @@ def test_no_user_data(self, caplog, tmpdir):
         render.render_template(user_data, instance_data, False)
         assert "Unable to render user-data file" in caplog.text
 
-    @skipUnlessJinja()
     def test_invalid_jinja_syntax(self, caplog, tmpdir):
         user_data = tmpdir.join("user-data")
         write_file(user_data, "##template: jinja\nrendering: {{ my_var } }")

tests/unittests/cmd/test_cloud_id.py

@@ -2,12 +2,13 @@
 
 """Tests for cloud-id command line utility."""
 
+from unittest import mock
+
 import pytest
 
 from cloudinit import atomic_helper
 from cloudinit.cmd import cloud_id, status
 from cloudinit.helpers import Paths
-from tests.unittests.helpers import mock
 
 M_PATH = "cloudinit.cmd.cloud_id."
 

tests/unittests/cmd/test_query.py

@@ -8,6 +8,7 @@
 from io import BytesIO
 from pathlib import Path
 from textwrap import dedent
+from unittest import mock
 
 import pytest
 
@@ -17,7 +18,6 @@
 from cloudinit.sources import REDACT_SENSITIVE_VALUE
 from cloudinit.templater import JinjaSyntaxParsingException
 from cloudinit.util import write_file
-from tests.unittests.helpers import mock
 
 M_PATH = "cloudinit.cmd.query."
 

tests/unittests/config/test_cc_apt_pipelining.py

@@ -3,6 +3,7 @@
 """Tests cc_apt_pipelining handler"""
 
 import re
+from unittest import mock
 
 import pytest
 
@@ -12,7 +13,7 @@
     get_schema,
     validate_cloudconfig_schema,
 )
-from tests.unittests.helpers import mock, skipUnlessJsonSchema
+from tests.unittests.helpers import skipUnlessJsonSchema
 
 
 class TestAptPipelining:

tests/unittests/config/test_cc_disable_ec2_metadata.py

@@ -3,6 +3,8 @@
 """Tests cc_disable_ec2_metadata handler"""
 
 
+from unittest import mock
+
 import pytest
 
 import cloudinit.config.cc_disable_ec2_metadata as ec2_meta
@@ -11,7 +13,7 @@
     get_schema,
     validate_cloudconfig_schema,
 )
-from tests.unittests.helpers import mock, skipUnlessJsonSchema
+from tests.unittests.helpers import skipUnlessJsonSchema
 
 DISABLE_CFG = {"disable_ec2_metadata": "true"}