feat: ✨Add jinja settings support for golden config plugin (#527)

* feat: 🔧 Add jinja settings support for golden config plugin --------- Co-authored-by: Eric M. Hansen <eric.hansen@cox.com>
nautobot · Aug 29, 2023 · cdf7faf · cdf7faf
1 parent 3231fae
commit cdf7faf
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 2 deletions.
diff --git a/development/nautobot_config.py b/development/nautobot_config.py
@@ -3,8 +3,10 @@
 import os
 import sys
 
+from django.utils.module_loading import import_string
+
 from nautobot.core.settings import *  # noqa: F403
-from nautobot.core.settings_funcs import parse_redis_connection
+from nautobot.core.settings_funcs import is_truthy, parse_redis_connection
 
 
 #
@@ -174,6 +176,11 @@
         "enable_postprocessing": is_truthy(os.environ.get("ENABLE_POSTPROCESSING", True)),
         "postprocessing_callables": os.environ.get("POSTPROCESSING_CALLABLES", []),
         "postprocessing_subscribed": os.environ.get("POSTPROCESSING_SUBSCRIBED", []),
+        "jinja_env": {
+            "undefined": import_string("jinja2.StrictUndefined"),
+            "trim_blocks": is_truthy(os.getenv("NAUTOBOT_JINJA_ENV_TRIM_BLOCKS", True)),
+            "lstrip_blocks": is_truthy(os.getenv("NAUTOBOT_JINJA_ENV_LSTRIP_BLOCKS", False)),
+        },
         # The platform_slug_map maps an arbitrary platform slug to its corresponding parser.
         # Use this if the platform slug names in your Nautobot instance don't correspond exactly
         # to the Nornir driver names ("arista_eos", "cisco_ios", etc.).

diff --git a/docs/admin/admin_install.md b/docs/admin/admin_install.md
@@ -59,6 +59,11 @@ PLUGINS_CONFIG = {
         "postprocessing_callables": [],
         "postprocessing_subscribed": [],
         "platform_slug_map": None,
+        "jinja_env": {
+            "undefined": StrictUndefined,  # jinja2.StrictUndefined
+            "trim_blocks": True,
+            "lstrip_blocks": False,
+        },
         # "get_custom_compliance": "my.custom_compliance.func"
     },
 }
@@ -101,9 +106,21 @@ The plugin behavior can be controlled with the following list of settings.
 | per_feature_bar_width     | 0.15                          | 0.15    | The width of the table bar within the overview report                                                                                                                      |
 | per_feature_width         | 13                            | 13      | The width in inches that the overview table can be.                                                                                                                        |
 | per_feature_height        | 4                             | 4       | The height in inches that the overview table can be.                                                                                                                       |
+| jinja_env | {"lstrip_blocks": False} | See Note Below | A dictionary of Jinja2 Environment options compatible with Jinja2.SandboxEnvironment() |
 
 !!! note
     Over time the compliance report will become more dynamic, but for now allow users to configure the `per_*` configs in a way that fits best for them.
 
 !!! note
     Review [`nautobot_plugin_nornir`](https://docs.nautobot.com/projects/plugin-nornir/en/latest/user/app_feature_dispatcher/) for Nornir and dispatcher configuration options.
+
+!!! note
+    Defaults for Jinja2 environment settings (`jinja_env`) are as follows:
+
+    ```python
+        jinja_env = {
+            "undefined": import_string("jinja2.StrictUndefined"),
+            "trim_blocks": True,
+            "lstrip_blocks": False,
+        }
+    ```
diff --git a/nautobot_golden_config/__init__.py b/nautobot_golden_config/__init__.py
@@ -5,6 +5,7 @@
 
 __version__ = metadata.version(__name__)
 
+from jinja2 import StrictUndefined
 from django.db.models.signals import post_migrate
 from nautobot.extras.plugins import PluginConfig
 
@@ -33,6 +34,11 @@ class GoldenConfig(PluginConfig):
         "per_feature_width": 13,
         "per_feature_height": 4,
         "get_custom_compliance": None,
+        "jinja_env": {
+            "undefined": StrictUndefined,
+            "trim_blocks": True,
+            "lstrip_blocks": False,
+        },
     }
 
     def ready(self):

diff --git a/nautobot_golden_config/nornir_plays/config_intended.py b/nautobot_golden_config/nornir_plays/config_intended.py
@@ -9,6 +9,7 @@
 from nornir.core.task import Result, Task
 
 from django.template import engines
+from jinja2.sandbox import SandboxedEnvironment
 
 from nornir_nautobot.exceptions import NornirNautobotException
 from nornir_nautobot.plugins.tasks.dispatcher import dispatcher
@@ -18,6 +19,7 @@
 from nautobot_plugin_nornir.constants import NORNIR_SETTINGS
 from nautobot_plugin_nornir.utils import get_dispatcher
 
+from nautobot_golden_config.utilities.constant import PLUGIN_CFG
 from nautobot_golden_config.utilities.db_management import close_threaded_db_connections
 from nautobot_golden_config.models import GoldenConfigSetting, GoldenConfig
 from nautobot_golden_config.utilities.helper import (
@@ -32,7 +34,12 @@
 InventoryPluginRegister.register("nautobot-inventory", NautobotORMInventory)
 LOGGER = logging.getLogger(__name__)
 
-jinja_env = engines["jinja"].env
+# Use a custom Jinja2 environment instead of Django's to avoid HTML escaping
+JINJA_ENV = PLUGIN_CFG["jinja_env"]
+jinja_env = SandboxedEnvironment(**JINJA_ENV)
+
+# Retrieve filters from the Django jinja template engine
+jinja_env.filters = engines["jinja"].env.filters
 
 
 @close_threaded_db_connections
@@ -85,6 +92,7 @@ def run_template(  # pylint: disable=too-many-arguments
         output_file_location=output_file_location,
         default_drivers_mapping=get_dispatcher(),
         jinja_filters=jinja_env.filters,
+        jinja_env=jinja_env,
     )[1].result["config"]
     intended_obj.intended_last_success_date = task.host.defaults.data["now"]
     intended_obj.intended_config = generated_config