netbox-interface-name-rules 1.2.2__tar.gz → 1.3.0__tar.gz

{netbox_interface_name_rules-1.2.2 → netbox_interface_name_rules-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: netbox-interface-name-rules
-Version: 1.2.2
+Version: 1.3.0
 Summary: NetBox plugin for automatic interface renaming when modules are installed
 Author: Marcin Zieba
 License-Expression: Apache-2.0
@@ -23,10 +23,6 @@ Dynamic: license-file
 
 # NetBox Interface Name Rules Plugin
 
-<p align="center">
-  <img src="https://raw.githubusercontent.com/marcinpsk/netbox-InterfaceNameRules-plugin/main/docs/icon.svg" alt="NetBox Interface Name Rules" width="80"/>
-</p>
-
 [![PyPI](https://img.shields.io/pypi/v/netbox-interface-name-rules)](https://pypi.org/project/netbox-interface-name-rules/)
 [![PyPI - Downloads](https://img.shields.io/pypi/dm/netbox-interface-name-rules)](https://pypi.org/project/netbox-interface-name-rules/)
 [![CI](https://img.shields.io/github/actions/workflow/status/marcinpsk/netbox-InterfaceNameRules-plugin/test.yaml?branch=main&label=tests)](https://github.com/marcinpsk/netbox-InterfaceNameRules-plugin/actions/workflows/test.yaml)
@@ -35,6 +31,7 @@ Dynamic: license-file
 [![Python](https://img.shields.io/pypi/pyversions/netbox-interface-name-rules)](https://pypi.org/project/netbox-interface-name-rules/)
 [![NetBox](https://img.shields.io/badge/NetBox-%E2%89%A54.2.0-blue)](https://github.com/netbox-community/netbox)
 [![Contributors](https://img.shields.io/github/contributors/marcinpsk/netbox-InterfaceNameRules-plugin)](https://github.com/marcinpsk/netbox-InterfaceNameRules-plugin/graphs/contributors)
+[![REUSE status](https://api.reuse.software/badge/github.com/marcinpsk/netbox-InterfaceNameRules-plugin)](https://api.reuse.software/info/github.com/marcinpsk/netbox-InterfaceNameRules-plugin)
 
 Automatic interface renaming when modules are installed into NetBox device bays.
 
@@ -83,6 +80,9 @@ Rules are managed through the NetBox UI under **Plugins → Interface Name Rules
 See the [full configuration guide](https://marcinpsk.github.io/netbox-InterfaceNameRules-plugin/configuration/) for all rule fields, priority scoring, and template variable reference.
 
 ## Screenshots
+<p align="center">
+  <img src="https://raw.githubusercontent.com/marcinpsk/netbox-InterfaceNameRules-plugin/main/docs/icon.svg" alt="NetBox Interface Name Rules" width="30"/>
+</p>
 
 <p align="center">
   <img src="https://raw.githubusercontent.com/marcinpsk/netbox-InterfaceNameRules-plugin/main/docs/screenshots/01-rule-list.png" alt="Rule list" width="700"/>

{netbox_interface_name_rules-1.2.2 → netbox_interface_name_rules-1.3.0}/README.md

@@ -1,9 +1,5 @@
 # NetBox Interface Name Rules Plugin
 
-<p align="center">
-  <img src="https://raw.githubusercontent.com/marcinpsk/netbox-InterfaceNameRules-plugin/main/docs/icon.svg" alt="NetBox Interface Name Rules" width="80"/>
-</p>
-
 [![PyPI](https://img.shields.io/pypi/v/netbox-interface-name-rules)](https://pypi.org/project/netbox-interface-name-rules/)
 [![PyPI - Downloads](https://img.shields.io/pypi/dm/netbox-interface-name-rules)](https://pypi.org/project/netbox-interface-name-rules/)
 [![CI](https://img.shields.io/github/actions/workflow/status/marcinpsk/netbox-InterfaceNameRules-plugin/test.yaml?branch=main&label=tests)](https://github.com/marcinpsk/netbox-InterfaceNameRules-plugin/actions/workflows/test.yaml)
@@ -12,6 +8,7 @@
 [![Python](https://img.shields.io/pypi/pyversions/netbox-interface-name-rules)](https://pypi.org/project/netbox-interface-name-rules/)
 [![NetBox](https://img.shields.io/badge/NetBox-%E2%89%A54.2.0-blue)](https://github.com/netbox-community/netbox)
 [![Contributors](https://img.shields.io/github/contributors/marcinpsk/netbox-InterfaceNameRules-plugin)](https://github.com/marcinpsk/netbox-InterfaceNameRules-plugin/graphs/contributors)
+[![REUSE status](https://api.reuse.software/badge/github.com/marcinpsk/netbox-InterfaceNameRules-plugin)](https://api.reuse.software/info/github.com/marcinpsk/netbox-InterfaceNameRules-plugin)
 
 Automatic interface renaming when modules are installed into NetBox device bays.
 
@@ -60,6 +57,9 @@ Rules are managed through the NetBox UI under **Plugins → Interface Name Rules
 See the [full configuration guide](https://marcinpsk.github.io/netbox-InterfaceNameRules-plugin/configuration/) for all rule fields, priority scoring, and template variable reference.
 
 ## Screenshots
+<p align="center">
+  <img src="https://raw.githubusercontent.com/marcinpsk/netbox-InterfaceNameRules-plugin/main/docs/icon.svg" alt="NetBox Interface Name Rules" width="30"/>
+</p>
 
 <p align="center">
   <img src="https://raw.githubusercontent.com/marcinpsk/netbox-InterfaceNameRules-plugin/main/docs/screenshots/01-rule-list.png" alt="Rule list" width="700"/>
@@ -86,4 +86,4 @@ Apache 2.0
 
 See [CONTRIBUTING.md](CONTRIBUTING.md) for how to submit code or interface name rules.
 
-Community-contributed rules for various vendors are in the [`contrib/`](contrib/) directory.
+Community-contributed rules for various vendors are in the [`contrib/`](contrib/) directory.

{netbox_interface_name_rules-1.2.2 → netbox_interface_name_rules-1.3.0}/netbox_interface_name_rules/__init__.py

@@ -2,7 +2,7 @@
 # Copyright (C) 2025 Marcin Zieba <marcinpsk@gmail.com>
 from netbox.plugins import PluginConfig
 
-__version__ = "1.2.2"
+__version__ = "1.3.0"
 
 
 class InterfaceNameRulesConfig(PluginConfig):

{netbox_interface_name_rules-1.2.2 → netbox_interface_name_rules-1.3.0}/netbox_interface_name_rules/engine.py

@@ -10,7 +10,8 @@ import ast
 import logging
 import re
 
-from django.db import transaction
+from django.core.exceptions import ValidationError
+from django.db import IntegrityError, transaction
 from django.db.models.functions import Length
 
 logger = logging.getLogger(__name__)
@@ -128,7 +129,7 @@ def _try_rename_device_interface(rule, iface, vc_position, device, renamed_pks):
 
     try:
         new_name = evaluate_name_template(rule.name_template, variables)
-    except Exception:
+    except (ValueError, TypeError, re.error):
         logger.exception(
             "Failed to evaluate template %r for interface %s (rule %s)",
             rule.name_template,
@@ -144,7 +145,7 @@ def _try_rename_device_interface(rule, iface, vc_position, device, renamed_pks):
     iface.name = new_name
     try:
         iface.full_clean()
-    except Exception:
+    except ValidationError:
         logger.exception(
             "Validation failed for device interface %s → %s (rule %s, device %s)",
             old_name,
@@ -156,7 +157,7 @@ def _try_rename_device_interface(rule, iface, vc_position, device, renamed_pks):
         return False
     try:
         iface.save()
-    except Exception:
+    except (IntegrityError, ValidationError):
         logger.exception(
             "DB save failed for device interface %s → %s (rule %s, device %s)",
             old_name,
@@ -401,7 +402,7 @@ def _resolve_bay_position(module_bay):
         digits = _extract_trailing_digits(module_bay.name)
         bay_position = digits if digits else "0"
     digits = _extract_trailing_digits(bay_position)
-    bay_position_num = digits if digits else bay_position
+    bay_position_num = digits if digits else "0"
     return bay_position, bay_position_num
 
 
@@ -524,6 +525,8 @@ def _find_channel_base(rule, ifaces, variables):
     _apply_rule_to_interface exactly ONCE per module for channel rules, preventing
     duplicate-name IntegrityErrors when channels already exist.
     """
+    if not ifaces:
+        return None
     for iface in ifaces:
         vars_copy = dict(variables)
         vars_copy["base"] = iface.name
@@ -558,8 +561,7 @@ def has_applicable_interfaces(rule) -> bool:
     Calls find_interfaces_for_rule(limit=1) to determine if any currently installed
     interface would receive a new name.  Returns False when:
       - no matching modules/interfaces are installed, OR
-      - all matching interfaces are already correctly named (e.g. NetBox resolved
-        {module_path} at install time, making the rule a no-op for existing interfaces).
+      - all matching interfaces are already correctly named.
 
     This is more expensive than a plain EXISTS query but ensures the Applicable
     column in the Apply Rules list accurately reflects "would something change?"
@@ -568,7 +570,7 @@ def has_applicable_interfaces(rule) -> bool:
     try:
         results, _ = find_interfaces_for_rule(rule, limit=1)
         return len(results) > 0
-    except Exception:
+    except (ValueError, re.error):
         return False
 
 
@@ -608,6 +610,8 @@ def _evaluate_plain_interface(rule, module, iface, variables) -> dict | None:
 def _channel_rule_entry(rule, module, ifaces, variables) -> dict | None:
     """Return a result dict if the channel rule would change any name for this module, else None."""
     base_iface = _find_channel_base(rule, ifaces, variables)
+    if base_iface is None:
+        return None
     vars_copy = {**variables, "base": base_iface.name}
     expected_names = []
     try:
@@ -680,6 +684,8 @@ def find_interfaces_for_rule(rule, limit=None):
     If *limit* is set the list is truncated after that many changed entries, but
     *total_checked* always reflects the full count of interfaces examined.
     """
+    from collections import defaultdict
+
     from dcim.models import Interface
 
     module_qs = _build_module_qs(rule).select_related(
@@ -693,13 +699,18 @@ def find_interfaces_for_rule(rule, limit=None):
     )
     process_fn = _process_channel_module if rule.channel_count > 0 else _process_plain_module
 
-    processed_pks = []
+    # Batch-load all interfaces for matching modules to avoid N+1 queries.
+    ifaces_by_module = defaultdict(list)
+    for iface in Interface.objects.filter(module__in=module_qs).order_by("module_id", "name"):
+        ifaces_by_module[iface.module_id].append(iface)
+
+    processed_pks = set()
     results = []
     total_checked = 0
     for module in module_qs:
-        processed_pks.append(module.pk)
+        processed_pks.add(module.pk)
         variables = build_variables(module.module_bay, device=module.device)
-        ifaces = list(Interface.objects.filter(module=module).order_by("name"))
+        ifaces = ifaces_by_module.get(module.pk, [])
         checked, stop = process_fn(rule, module, ifaces, variables, limit, results, module_qs, processed_pks)
         total_checked += checked
         if stop:
@@ -726,6 +737,8 @@ def apply_rule_to_existing(rule, limit=None, interface_ids=None):
 
     Returns the number of interfaces renamed/created.
     """
+    from collections import defaultdict
+
     from dcim.models import Interface
 
     id_set = frozenset(interface_ids) if interface_ids is not None else None
@@ -737,15 +750,20 @@ def apply_rule_to_existing(rule, limit=None, interface_ids=None):
 
     module_qs = _build_module_qs(rule)
 
+    # Batch-load interfaces to avoid N+1 queries in the module loop.
+    ifaces_by_module = defaultdict(list)
+    for iface in Interface.objects.filter(module__in=module_qs).order_by("module_id", "name"):
+        ifaces_by_module[iface.module_id].append(iface)
+
     count = 0
     for module in module_qs.select_related("module_bay", "module_type", "device", "device__virtual_chassis"):
         variables = build_variables(module.module_bay, device=module.device)
+        ifaces = ifaces_by_module.get(module.pk, [])
 
         if rule.channel_count > 0:
             # Channel rule: process module ONCE using the best base interface.
             # Calling _apply_rule_to_interface for each existing interface would
             # attempt to create the same channel names multiple times.
-            ifaces = list(Interface.objects.filter(module=module).order_by("name"))
             if not ifaces:
                 continue
             base_iface = _find_channel_base(rule, ifaces, variables)
@@ -755,7 +773,7 @@ def apply_rule_to_existing(rule, limit=None, interface_ids=None):
             vars_copy["base"] = base_iface.name
             try:
                 count += _apply_rule_to_interface(rule, base_iface, vars_copy, module)
-            except Exception:
+            except (ValueError, ValidationError, IntegrityError):
                 logger.exception(
                     "Failed to apply channel rule '%s' to module '%s' (id=%s); skipping.",
                     rule,
@@ -763,14 +781,14 @@ def apply_rule_to_existing(rule, limit=None, interface_ids=None):
                     module.pk,
                 )
         else:
-            for iface in list(Interface.objects.filter(module=module).order_by("name")):
+            for iface in ifaces:
                 if id_set is not None and iface.pk not in id_set:
                     continue
                 vars_copy = dict(variables)
                 vars_copy["base"] = iface.name
                 try:
                     count += _apply_rule_to_interface(rule, iface, vars_copy, module)
-                except Exception:
+                except (ValueError, ValidationError, IntegrityError):
                     logger.exception(
                         "Failed to apply rule '%s' to interface '%s' (id=%s); skipping.",
                         rule,

{netbox_interface_name_rules-1.2.2 → netbox_interface_name_rules-1.3.0}/netbox_interface_name_rules/filters.py

@@ -53,7 +53,7 @@ class InterfaceNameRuleFilterSet(NetBoxModelFilterSet):
 
     def search(self, queryset, name, value):
         """Filter by pattern, template, description, or module type model name."""
-        return queryset.filter(
+        return queryset.select_related("module_type").filter(
             Q(module_type_pattern__icontains=value)
             | Q(name_template__icontains=value)
             | Q(description__icontains=value)

{netbox_interface_name_rules-1.2.2 → netbox_interface_name_rules-1.3.0}/netbox_interface_name_rules/models.py

@@ -283,3 +283,45 @@ class InterfaceNameRule(NetBoxModel):
         device = f" on {self.device_type.model}" if self.device_type else ""
         platform = f" [{self.platform.name}]" if self.platform else ""
         return f"{module}{parent}{device}{platform} → {self.name_template}"
+
+    csv_headers = [
+        "module_type",
+        "module_type_pattern",
+        "module_type_is_regex",
+        "parent_module_type",
+        "device_type",
+        "platform",
+        "name_template",
+        "channel_count",
+        "channel_start",
+        "description",
+        "enabled",
+        "applies_to_device_interfaces",
+    ]
+
+    def to_csv(self):
+        """Return a tuple of field values for CSV export (matches csv_headers order)."""
+        return (
+            self.module_type.model if self.module_type else "",
+            self.module_type_pattern,
+            self.module_type_is_regex,
+            self.parent_module_type.model if self.parent_module_type else "",
+            self.device_type.model if self.device_type else "",
+            self.platform.name if self.platform else "",
+            self.name_template,
+            self.channel_count,
+            self.channel_start,
+            self.description,
+            self.enabled,
+            self.applies_to_device_interfaces,
+        )
+
+    def to_yaml(self):
+        """Return a YAML document for this rule (used by NetBox's built-in Export)."""
+        import yaml
+
+        entry = {}
+        for header, value in zip(self.csv_headers, self.to_csv()):
+            if (value != "" and value is not None) or header in {"name_template"}:
+                entry[header] = value
+        return yaml.dump([entry], default_flow_style=False, allow_unicode=True, sort_keys=False)

{netbox_interface_name_rules-1.2.2 → netbox_interface_name_rules-1.3.0}/netbox_interface_name_rules/signals.py

@@ -37,6 +37,7 @@ def on_module_pre_save(sender, instance, **kwargs):
         old = sender.objects.filter(pk=instance.pk).values("module_type_id").first()
         instance._prev_module_type_id = old["module_type_id"] if old else None
     except Exception:
+        logger.warning("Failed to capture previous module_type_id for Module pk=%s", instance.pk, exc_info=True)
         instance._prev_module_type_id = None
 
 
@@ -141,6 +142,7 @@ def on_device_pre_save(sender, instance, **kwargs):
         instance._prev_virtual_chassis_id = old["virtual_chassis_id"] if old else None
         instance._prev_vc_position = old["vc_position"] if old else None
     except Exception:
+        logger.warning("Failed to capture previous VC state for Device pk=%s", instance.pk, exc_info=True)
         instance._prev_virtual_chassis_id = None
         instance._prev_vc_position = None
 

{netbox_interface_name_rules-1.2.2 → netbox_interface_name_rules-1.3.0}/netbox_interface_name_rules/tables.py

@@ -96,7 +96,7 @@ class InterfaceNameRuleTable(NetBoxTable):
     applies_to_device_interfaces = columns.BooleanColumn(verbose_name="Device Ifaces")
     name_template = tables.Column(verbose_name="Name Template")
     channel_count = tables.Column(verbose_name="Channels")
-    channel_start = tables.Column(verbose_name="Ch. Start")
+    channel_start = tables.Column(verbose_name="Channel Start")
     description = tables.Column(verbose_name="Description", linkify=False)
     actions = columns.ActionsColumn(
         actions=("edit", "delete"),

netbox_interface_name_rules-1.3.0/netbox_interface_name_rules/templates/netbox_interface_name_rules/buttons/export_yaml_only.html

@@ -0,0 +1,33 @@
+{# SPDX-License-Identifier: Apache-2.0 #}
+{# Copyright (C) 2025 Marcin Zieba <marcinpsk@gmail.com> #}
+{% load i18n %}
+<div class="dropdown">
+  <button type="button" class="btn btn-purple dropdown-toggle" data-bs-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+    <i class="mdi mdi-download" aria-hidden="true"></i> {{ label }}
+  </button>
+  <ul class="dropdown-menu dropdown-menu-end">
+    <li><a class="dropdown-item" href="?{% if url_params %}{{ url_params }}&{% endif %}export">{% trans "All Data" %} ({{ data_format }})</a></li>
+    {% if export_templates %}
+      <li>
+        <hr class="dropdown-divider">
+      </li>
+      {% for et in export_templates %}
+        <li>
+          <a class="dropdown-item" href="?{% if url_params %}{{ url_params }}&{% endif %}export={{ et.name|urlencode }}"
+            {% if et.description %} title="{{ et.description }}"{% endif %}
+          >
+            {{ et.name }}
+          </a>
+        </li>
+      {% endfor %}
+    {% endif %}
+    {% if perms.extras.add_exporttemplate %}
+      <li>
+        <hr class="dropdown-divider">
+      </li>
+      <li>
+        <a class="dropdown-item" href="{% url 'extras:exporttemplate_add' %}?object_types={{ object_type.pk }}">{% trans "Add export template" %}...</a>
+      </li>
+    {% endif %}
+  </ul>
+</div>

{netbox_interface_name_rules-1.2.2 → netbox_interface_name_rules-1.3.0}/netbox_interface_name_rules/templates/netbox_interface_name_rules/interfacenamerule_list.html

@@ -78,23 +78,6 @@
                     (device-level rule, pattern <code>Ethernet\d+/\d+</code>)</li>
             </ul>
 
-            {% if supports_module_path %}
-            <div class="alert alert-success mt-3 mb-0">
-                <i class="mdi mdi-check-circle me-1"></i>
-                <strong><code>{module_path}</code> supported:</strong>
-                Platform naming rules (e.g., <code>et-0/0/{bay_position}</code>)
-                may be replaceable by using <code>{module_path}</code> in module type interface templates directly.
-                Converter offset and breakout rules are still needed.
-            </div>
-            {% else %}
-            <div class="alert alert-warning mt-3 mb-0">
-                <i class="mdi mdi-information-outline me-1"></i>
-                <strong><code>{module_path}</code> not available:</strong>
-                Platform naming rules
-                (e.g., Juniper <code>et-0/0/{bay_position}</code>) are required for correct interface naming.
-                Upgrade NetBox to get native <code>{module_path}</code> support.
-            </div>
-            {% endif %}
         </div>
     </div>
     <script>

{netbox_interface_name_rules-1.2.2 → netbox_interface_name_rules-1.3.0}/netbox_interface_name_rules/tests/test_api.py

@@ -116,6 +116,20 @@ class InterfaceNameRuleAPITest(APITestCase):
         response = self.client.post(url, data, format="json", **self.header)
         self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
 
+    def test_create_with_both_module_type_and_pattern_fails(self):
+        """POST with both module_type FK and module_type_pattern set is rejected."""
+        url = self._get_list_url()
+        data = {
+            "module_type": self.module_type.pk,
+            "module_type_is_regex": True,
+            "module_type_pattern": "QSFP-.*",
+            "name_template": "port{bay_position}",
+            "channel_count": 0,
+            "channel_start": 0,
+        }
+        response = self.client.post(url, data, format="json", **self.header)
+        self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
+
     def test_update_rule_to_regex(self):
         """PATCH a rule to switch it to regex mode."""
         rule = InterfaceNameRule.objects.create(

{netbox_interface_name_rules-1.2.2 → netbox_interface_name_rules-1.3.0}/netbox_interface_name_rules/tests/test_device_rules.py

@@ -283,3 +283,49 @@ class ApplyDeviceInterfaceRulesModuleTypeTest(TestCase):
         self.assertEqual(result, 1)
         iface.refresh_from_db()
         self.assertEqual(iface.name, "Gi2/3")
+
+
+class DeviceInterfaceEdgeCaseNamesTest(TestCase):
+    """Test _try_rename_device_interface with edge-case interface names."""
+
+    @classmethod
+    def setUpTestData(cls):
+        mfg = Manufacturer.objects.create(name="EdgeMfg", slug="edgemfg")
+        cls.device_type = DeviceType.objects.create(manufacturer=mfg, model="Edge-Dev", slug="edge-dev")
+        role = DeviceRole.objects.create(name="EdgeRole", slug="edgerole")
+        site = Site.objects.create(name="EdgeSite", slug="edgesite")
+        vc = VirtualChassis.objects.create(name="edge-vc")
+        cls.device = Device.objects.create(
+            name="edge-sw1",
+            device_type=cls.device_type,
+            role=role,
+            site=site,
+            virtual_chassis=vc,
+            vc_position=1,
+        )
+
+    def test_name_with_multiple_slashes(self):
+        """Interface name like FortyGigE1/2/3/4 extracts port='4'."""
+        InterfaceNameRule.objects.create(
+            applies_to_device_interfaces=True,
+            name_template="Fo{vc_position}/2/3/{port}",
+        )
+        iface = Interface.objects.create(
+            device=self.device, name="FortyGigE1/2/3/4", type="40gbase-x-qsfpp", module=None
+        )
+        result = apply_device_interface_rules(self.device)
+        self.assertEqual(result, 1)
+        iface.refresh_from_db()
+        self.assertEqual(iface.name, "Fo1/2/3/4")
+
+    def test_name_without_slash(self):
+        """Interface name without / uses full name as port."""
+        InterfaceNameRule.objects.create(
+            applies_to_device_interfaces=True,
+            name_template="eth{vc_position}-{port}",
+        )
+        iface = Interface.objects.create(device=self.device, name="eth0", type="1000base-t", module=None)
+        result = apply_device_interface_rules(self.device)
+        self.assertEqual(result, 1)
+        iface.refresh_from_db()
+        self.assertEqual(iface.name, "eth1-eth0")

{netbox_interface_name_rules-1.2.2 → netbox_interface_name_rules-1.3.0}/netbox_interface_name_rules/tests/test_engine.py

@@ -101,3 +101,15 @@ class EvaluateNameTemplateTest(TestCase):
             {},
         )
         self.assertEqual(result, "port4")
+
+    def test_bay_position_num_non_numeric_uses_zero(self):
+        """When bay_position has no trailing digits, bay_position_num falls back to '0'."""
+        from netbox_interface_name_rules.engine import _resolve_bay_position
+
+        class FakeBay:
+            position = "abc"
+            name = "Bay abc"
+
+        bay_position, bay_position_num = _resolve_bay_position(FakeBay())
+        self.assertEqual(bay_position, "abc")
+        self.assertEqual(bay_position_num, "0")