infrahub-server 1.2.1__py3-none-any.whl → 1.2.3__py3-none-any.whl

infrahub_sdk/template/__init__.py

@@ -0,0 +1,209 @@
+from __future__ import annotations
+
+import linecache
+from pathlib import Path
+from typing import Any, Callable, NoReturn
+
+import jinja2
+from jinja2 import meta, nodes
+from jinja2.sandbox import SandboxedEnvironment
+from netutils.utils import jinja2_convenience_function
+from rich.syntax import Syntax
+from rich.traceback import Traceback
+
+from .exceptions import (
+    JinjaTemplateError,
+    JinjaTemplateNotFoundError,
+    JinjaTemplateOperationViolationError,
+    JinjaTemplateSyntaxError,
+    JinjaTemplateUndefinedError,
+)
+from .filters import AVAILABLE_FILTERS
+from .models import UndefinedJinja2Error
+
+netutils_filters = jinja2_convenience_function()
+
+
+class Jinja2Template:
+    def __init__(
+        self,
+        template: str | Path,
+        template_directory: Path | None = None,
+        filters: dict[str, Callable] | None = None,
+    ) -> None:
+        self.is_string_based = isinstance(template, str)
+        self.is_file_based = isinstance(template, Path)
+        self._template = str(template)
+        self._template_directory = template_directory
+        self._environment: jinja2.Environment | None = None
+
+        self._available_filters = [filter_definition.name for filter_definition in AVAILABLE_FILTERS]
+        self._trusted_filters = [
+            filter_definition.name for filter_definition in AVAILABLE_FILTERS if filter_definition.trusted
+        ]
+
+        self._filters = filters or {}
+        for user_filter in self._filters:
+            self._available_filters.append(user_filter)
+            self._trusted_filters.append(user_filter)
+
+        self._template_definition: jinja2.Template | None = None
+
+    def get_environment(self) -> jinja2.Environment:
+        if self._environment:
+            return self._environment
+
+        if self.is_string_based:
+            return self._get_string_based_environment()
+
+        return self._get_file_based_environment()
+
+    def get_template(self) -> jinja2.Template:
+        if self._template_definition:
+            return self._template_definition
+
+        try:
+            if self.is_string_based:
+                template = self._get_string_based_template()
+            else:
+                template = self._get_file_based_template()
+        except jinja2.TemplateSyntaxError as exc:
+            self._raise_template_syntax_error(error=exc)
+        except jinja2.TemplateNotFound as exc:
+            raise JinjaTemplateNotFoundError(message=exc.message, filename=str(exc.name))
+
+        return template
+
+    def get_variables(self) -> list[str]:
+        env = self.get_environment()
+
+        template_source = self._template
+        if self.is_file_based and env.loader:
+            template_source = env.loader.get_source(env, self._template)[0]
+
+        template = env.parse(template_source)
+
+        return sorted(meta.find_undeclared_variables(template))
+
+    def validate(self, restricted: bool = True) -> None:
+        allowed_list = self._available_filters
+        if restricted:
+            allowed_list = self._trusted_filters
+
+        env = self.get_environment()
+        template_source = self._template
+        if self.is_file_based and env.loader:
+            template_source = env.loader.get_source(env, self._template)[0]
+
+        template = env.parse(template_source)
+        for node in template.find_all(nodes.Filter):
+            if node.name not in allowed_list:
+                raise JinjaTemplateOperationViolationError(f"The '{node.name}' filter isn't allowed to be used")
+
+        forbidden_operations = ["Call", "Import", "Include"]
+        if self.is_string_based and any(node.__class__.__name__ in forbidden_operations for node in template.body):
+            raise JinjaTemplateOperationViolationError(
+                f"These operations are forbidden for string based templates: {forbidden_operations}"
+            )
+
+    async def render(self, variables: dict[str, Any]) -> str:
+        template = self.get_template()
+        try:
+            output = await template.render_async(variables)
+        except jinja2.exceptions.TemplateNotFound as exc:
+            raise JinjaTemplateNotFoundError(message=exc.message, filename=str(exc.name), base_template=template.name)
+        except jinja2.TemplateSyntaxError as exc:
+            self._raise_template_syntax_error(error=exc)
+        except jinja2.UndefinedError as exc:
+            traceback = Traceback(show_locals=False)
+            errors = _identify_faulty_jinja_code(traceback=traceback)
+            raise JinjaTemplateUndefinedError(message=exc.message, errors=errors)
+        except Exception as exc:
+            if error_message := getattr(exc, "message", None):
+                message = error_message
+            else:
+                message = str(exc)
+            raise JinjaTemplateError(message=message or "Unknown template error")
+
+        return output
+
+    def _get_string_based_environment(self) -> jinja2.Environment:
+        env = SandboxedEnvironment(enable_async=True, undefined=jinja2.StrictUndefined)
+        self._set_filters(env=env)
+        self._environment = env
+        return self._environment
+
+    def _get_file_based_environment(self) -> jinja2.Environment:
+        template_loader = jinja2.FileSystemLoader(searchpath=str(self._template_directory))
+        env = jinja2.Environment(
+            loader=template_loader,
+            trim_blocks=True,
+            lstrip_blocks=True,
+            enable_async=True,
+        )
+        self._set_filters(env=env)
+        self._environment = env
+        return self._environment
+
+    def _set_filters(self, env: jinja2.Environment) -> None:
+        for default_filter in list(env.filters.keys()):
+            if default_filter not in self._available_filters:
+                del env.filters[default_filter]
+
+        # Add filters from netutils
+        env.filters.update(
+            {name: jinja_filter for name, jinja_filter in netutils_filters.items() if name in self._available_filters}
+        )
+        # Add user supplied filters
+        env.filters.update(self._filters)
+
+    def _get_string_based_template(self) -> jinja2.Template:
+        env = self.get_environment()
+        self._template_definition = env.from_string(self._template)
+        return self._template_definition
+
+    def _get_file_based_template(self) -> jinja2.Template:
+        env = self.get_environment()
+        self._template_definition = env.get_template(self._template)
+        return self._template_definition
+
+    def _raise_template_syntax_error(self, error: jinja2.TemplateSyntaxError) -> NoReturn:
+        filename: str | None = None
+        if error.filename and self._template_directory:
+            filename = error.filename
+            if error.filename.startswith(str(self._template_directory)):
+                filename = error.filename[len(str(self._template_directory)) :]
+
+        raise JinjaTemplateSyntaxError(message=error.message, filename=filename, lineno=error.lineno)
+
+
+def _identify_faulty_jinja_code(traceback: Traceback, nbr_context_lines: int = 3) -> list[UndefinedJinja2Error]:
+    """This function identifies the faulty Jinja2 code and beautify it to provide meaningful information to the user.
+
+    We use the rich's Traceback to parse the complete stack trace and extract Frames for each exception found in the trace.
+    """
+    response = []
+
+    # Extract only the Jinja related exception
+    for frame in [frame for frame in traceback.trace.stacks[0].frames if not frame.filename.endswith(".py")]:
+        code = "".join(linecache.getlines(frame.filename))
+        if frame.filename == "<template>":
+            lexer_name = "text"
+        else:
+            lexer_name = Traceback._guess_lexer(frame.filename, code)
+        syntax = Syntax(
+            code,
+            lexer_name,
+            line_numbers=True,
+            line_range=(
+                frame.lineno - nbr_context_lines,
+                frame.lineno + nbr_context_lines,
+            ),
+            highlight_lines={frame.lineno},
+            code_width=88,
+            theme=traceback.theme,
+            dedent=False,
+        )
+        response.append(UndefinedJinja2Error(frame=frame, syntax=syntax))
+
+    return response

infrahub_sdk/template/exceptions.py

@@ -0,0 +1,38 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from infrahub_sdk.exceptions import Error
+
+if TYPE_CHECKING:
+    from .models import UndefinedJinja2Error
+
+
+class JinjaTemplateError(Error):
+    def __init__(self, message: str) -> None:
+        self.message = message
+
+
+class JinjaTemplateNotFoundError(JinjaTemplateError):
+    def __init__(self, message: str | None, filename: str, base_template: str | None = None) -> None:
+        self.message = message or "Template Not Found"
+        self.filename = filename
+        self.base_template = base_template
+
+
+class JinjaTemplateSyntaxError(JinjaTemplateError):
+    def __init__(self, message: str | None, lineno: int, filename: str | None = None) -> None:
+        self.message = message or "Syntax Error"
+        self.filename = filename
+        self.lineno = lineno
+
+
+class JinjaTemplateUndefinedError(JinjaTemplateError):
+    def __init__(self, message: str | None, errors: list[UndefinedJinja2Error]) -> None:
+        self.message = message or "Undefined Error"
+        self.errors = errors
+
+
+class JinjaTemplateOperationViolationError(JinjaTemplateError):
+    def __init__(self, message: str | None = None) -> None:
+        self.message = message or "Forbidden code found in the template"

infrahub_sdk/template/filters.py

@@ -0,0 +1,151 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class FilterDefinition:
+    name: str
+    trusted: bool
+    source: str
+
+
+BUILTIN_FILTERS = [
+    FilterDefinition(name="abs", trusted=True, source="jinja2"),
+    FilterDefinition(name="attr", trusted=False, source="jinja2"),
+    FilterDefinition(name="batch", trusted=False, source="jinja2"),
+    FilterDefinition(name="capitalize", trusted=True, source="jinja2"),
+    FilterDefinition(name="center", trusted=True, source="jinja2"),
+    FilterDefinition(name="count", trusted=True, source="jinja2"),
+    FilterDefinition(name="d", trusted=True, source="jinja2"),
+    FilterDefinition(name="default", trusted=True, source="jinja2"),
+    FilterDefinition(name="dictsort", trusted=False, source="jinja2"),
+    FilterDefinition(name="e", trusted=True, source="jinja2"),
+    FilterDefinition(name="escape", trusted=True, source="jinja2"),
+    FilterDefinition(name="filesizeformat", trusted=True, source="jinja2"),
+    FilterDefinition(name="first", trusted=True, source="jinja2"),
+    FilterDefinition(name="float", trusted=True, source="jinja2"),
+    FilterDefinition(name="forceescape", trusted=True, source="jinja2"),
+    FilterDefinition(name="format", trusted=True, source="jinja2"),
+    FilterDefinition(name="groupby", trusted=False, source="jinja2"),
+    FilterDefinition(name="indent", trusted=True, source="jinja2"),
+    FilterDefinition(name="int", trusted=True, source="jinja2"),
+    FilterDefinition(name="items", trusted=False, source="jinja2"),
+    FilterDefinition(name="join", trusted=True, source="jinja2"),
+    FilterDefinition(name="last", trusted=True, source="jinja2"),
+    FilterDefinition(name="length", trusted=True, source="jinja2"),
+    FilterDefinition(name="list", trusted=True, source="jinja2"),
+    FilterDefinition(name="lower", trusted=True, source="jinja2"),
+    FilterDefinition(name="map", trusted=False, source="jinja2"),
+    FilterDefinition(name="max", trusted=True, source="jinja2"),
+    FilterDefinition(name="min", trusted=True, source="jinja2"),
+    FilterDefinition(name="pprint", trusted=False, source="jinja2"),
+    FilterDefinition(name="random", trusted=False, source="jinja2"),
+    FilterDefinition(name="reject", trusted=False, source="jinja2"),
+    FilterDefinition(name="rejectattr", trusted=False, source="jinja2"),
+    FilterDefinition(name="replace", trusted=True, source="jinja2"),
+    FilterDefinition(name="reverse", trusted=True, source="jinja2"),
+    FilterDefinition(name="round", trusted=True, source="jinja2"),
+    FilterDefinition(name="safe", trusted=False, source="jinja2"),
+    FilterDefinition(name="select", trusted=False, source="jinja2"),
+    FilterDefinition(name="selectattr", trusted=False, source="jinja2"),
+    FilterDefinition(name="slice", trusted=True, source="jinja2"),
+    FilterDefinition(name="sort", trusted=False, source="jinja2"),
+    FilterDefinition(name="string", trusted=True, source="jinja2"),
+    FilterDefinition(name="striptags", trusted=True, source="jinja2"),
+    FilterDefinition(name="sum", trusted=True, source="jinja2"),
+    FilterDefinition(name="title", trusted=True, source="jinja2"),
+    FilterDefinition(name="tojson", trusted=False, source="jinja2"),
+    FilterDefinition(name="trim", trusted=True, source="jinja2"),
+    FilterDefinition(name="truncate", trusted=True, source="jinja2"),
+    FilterDefinition(name="unique", trusted=False, source="jinja2"),
+    FilterDefinition(name="upper", trusted=True, source="jinja2"),
+    FilterDefinition(name="urlencode", trusted=True, source="jinja2"),
+    FilterDefinition(name="urlize", trusted=False, source="jinja2"),
+    FilterDefinition(name="wordcount", trusted=True, source="jinja2"),
+    FilterDefinition(name="wordwrap", trusted=True, source="jinja2"),
+    FilterDefinition(name="xmlattr", trusted=False, source="jinja2"),
+]
+
+
+NETUTILS_FILTERS = [
+    FilterDefinition(name="abbreviated_interface_name", trusted=True, source="netutils"),
+    FilterDefinition(name="abbreviated_interface_name_list", trusted=True, source="netutils"),
+    FilterDefinition(name="asn_to_int", trusted=True, source="netutils"),
+    FilterDefinition(name="bits_to_name", trusted=True, source="netutils"),
+    FilterDefinition(name="bytes_to_name", trusted=True, source="netutils"),
+    FilterDefinition(name="canonical_interface_name", trusted=True, source="netutils"),
+    FilterDefinition(name="canonical_interface_name_list", trusted=True, source="netutils"),
+    FilterDefinition(name="cidr_to_netmask", trusted=True, source="netutils"),
+    FilterDefinition(name="cidr_to_netmaskv6", trusted=True, source="netutils"),
+    FilterDefinition(name="clean_config", trusted=True, source="netutils"),
+    FilterDefinition(name="compare_version_loose", trusted=True, source="netutils"),
+    FilterDefinition(name="compare_version_strict", trusted=True, source="netutils"),
+    FilterDefinition(name="config_compliance", trusted=True, source="netutils"),
+    FilterDefinition(name="config_section_not_parsed", trusted=True, source="netutils"),
+    FilterDefinition(name="delimiter_change", trusted=True, source="netutils"),
+    FilterDefinition(name="diff_network_config", trusted=True, source="netutils"),
+    FilterDefinition(name="feature_compliance", trusted=True, source="netutils"),
+    FilterDefinition(name="find_unordered_cfg_lines", trusted=True, source="netutils"),
+    FilterDefinition(name="fqdn_to_ip", trusted=False, source="netutils"),
+    FilterDefinition(name="get_all_host", trusted=False, source="netutils"),
+    FilterDefinition(name="get_broadcast_address", trusted=True, source="netutils"),
+    FilterDefinition(name="get_first_usable", trusted=True, source="netutils"),
+    FilterDefinition(name="get_ips_sorted", trusted=True, source="netutils"),
+    FilterDefinition(name="get_nist_urls", trusted=True, source="netutils"),
+    FilterDefinition(name="get_nist_vendor_platform_urls", trusted=True, source="netutils"),
+    FilterDefinition(name="get_oui", trusted=True, source="netutils"),
+    FilterDefinition(name="get_peer_ip", trusted=True, source="netutils"),
+    FilterDefinition(name="get_range_ips", trusted=True, source="netutils"),
+    FilterDefinition(name="get_upgrade_path", trusted=True, source="netutils"),
+    FilterDefinition(name="get_usable_range", trusted=True, source="netutils"),
+    FilterDefinition(name="hash_data", trusted=True, source="netutils"),
+    FilterDefinition(name="int_to_asdot", trusted=True, source="netutils"),
+    FilterDefinition(name="interface_range_compress", trusted=True, source="netutils"),
+    FilterDefinition(name="interface_range_expansion", trusted=True, source="netutils"),
+    FilterDefinition(name="ip_addition", trusted=True, source="netutils"),
+    FilterDefinition(name="ip_subtract", trusted=True, source="netutils"),
+    FilterDefinition(name="ip_to_bin", trusted=True, source="netutils"),
+    FilterDefinition(name="ip_to_hex", trusted=True, source="netutils"),
+    FilterDefinition(name="ipaddress_address", trusted=True, source="netutils"),
+    FilterDefinition(name="ipaddress_interface", trusted=True, source="netutils"),
+    FilterDefinition(name="ipaddress_network", trusted=True, source="netutils"),
+    FilterDefinition(name="is_classful", trusted=True, source="netutils"),
+    FilterDefinition(name="is_fqdn_resolvable", trusted=False, source="netutils"),
+    FilterDefinition(name="is_ip", trusted=True, source="netutils"),
+    FilterDefinition(name="is_ip_range", trusted=True, source="netutils"),
+    FilterDefinition(name="is_ip_within", trusted=True, source="netutils"),
+    FilterDefinition(name="is_netmask", trusted=True, source="netutils"),
+    FilterDefinition(name="is_network", trusted=True, source="netutils"),
+    FilterDefinition(name="is_reversible_wildcardmask", trusted=True, source="netutils"),
+    FilterDefinition(name="is_valid_mac", trusted=True, source="netutils"),
+    FilterDefinition(name="longest_prefix_match", trusted=True, source="netutils"),
+    FilterDefinition(name="mac_normalize", trusted=True, source="netutils"),
+    FilterDefinition(name="mac_to_format", trusted=True, source="netutils"),
+    FilterDefinition(name="mac_to_int", trusted=True, source="netutils"),
+    FilterDefinition(name="mac_type", trusted=True, source="netutils"),
+    FilterDefinition(name="name_to_bits", trusted=True, source="netutils"),
+    FilterDefinition(name="name_to_bytes", trusted=True, source="netutils"),
+    FilterDefinition(name="name_to_name", trusted=True, source="netutils"),
+    FilterDefinition(name="netmask_to_cidr", trusted=True, source="netutils"),
+    FilterDefinition(name="netmask_to_wildcardmask", trusted=True, source="netutils"),
+    FilterDefinition(name="normalise_delimiter_caret_c", trusted=True, source="netutils"),
+    FilterDefinition(name="paloalto_panos_brace_to_set", trusted=True, source="netutils"),
+    FilterDefinition(name="paloalto_panos_clean_newlines", trusted=True, source="netutils"),
+    FilterDefinition(name="regex_findall", trusted=False, source="netutils"),
+    FilterDefinition(name="regex_match", trusted=False, source="netutils"),
+    FilterDefinition(name="regex_search", trusted=False, source="netutils"),
+    FilterDefinition(name="regex_split", trusted=False, source="netutils"),
+    FilterDefinition(name="regex_sub", trusted=False, source="netutils"),
+    FilterDefinition(name="sanitize_config", trusted=True, source="netutils"),
+    FilterDefinition(name="section_config", trusted=True, source="netutils"),
+    FilterDefinition(name="sort_interface_list", trusted=True, source="netutils"),
+    FilterDefinition(name="split_interface", trusted=True, source="netutils"),
+    FilterDefinition(name="uptime_seconds_to_string", trusted=True, source="netutils"),
+    FilterDefinition(name="uptime_string_to_seconds", trusted=True, source="netutils"),
+    FilterDefinition(name="version_metadata", trusted=True, source="netutils"),
+    FilterDefinition(name="vlanconfig_to_list", trusted=True, source="netutils"),
+    FilterDefinition(name="vlanlist_to_config", trusted=True, source="netutils"),
+    FilterDefinition(name="wildcardmask_to_netmask", trusted=True, source="netutils"),
+]
+
+
+AVAILABLE_FILTERS = BUILTIN_FILTERS + NETUTILS_FILTERS

infrahub_sdk/template/models.py

@@ -0,0 +1,10 @@
+from dataclasses import dataclass
+
+from rich.syntax import Syntax
+from rich.traceback import Frame
+
+
+@dataclass
+class UndefinedJinja2Error:
+    frame: Frame
+    syntax: Syntax

infrahub_sdk/utils.py

@@ -1,7 +1,9 @@
 from __future__ import annotations
 
+import base64
 import hashlib
 import json
+import uuid
 from itertools import groupby
 from pathlib import Path
 from typing import TYPE_CHECKING, Any
@@ -25,6 +27,11 @@ if TYPE_CHECKING:
     from whenever import TimeDelta
 
 
+def generate_short_id() -> str:
+    """Generate a short unique ID"""
+    return base64.urlsafe_b64encode(uuid.uuid4().bytes).rstrip(b"=").decode("ascii").lower()
+
+
 def base36encode(number: int) -> str:
     if not isinstance(number, (int)):
         raise TypeError("number must be an integer")

{infrahub_server-1.2.1.dist-info → infrahub_server-1.2.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: infrahub-server
-Version: 1.2.1
+Version: 1.2.3
 Summary: Infrahub is taking a new approach to Infrastructure Management by providing a new generation of datastore to organize and control all the data that defines how an infrastructure should run.
 Home-page: https://opsmill.com
 License: AGPL-3.0-only
@@ -32,6 +32,7 @@ Requires-Dist: nats-py (>=2.7.2,<3.0.0)
 Requires-Dist: neo4j (>=5.28,<5.29)
 Requires-Dist: neo4j-rust-ext (>=5.28,<5.29)
 Requires-Dist: netaddr (==1.3.0)
+Requires-Dist: netutils (==1.12.0)
 Requires-Dist: numpy (>=1.24.2,<2.0.0) ; python_version >= "3.9" and python_version < "3.12"
 Requires-Dist: numpy (>=1.26.2,<2.0.0) ; python_version >= "3.12"
 Requires-Dist: opentelemetry-exporter-otlp-proto-grpc (==1.28.1)