row html")
+
+ def test_swallows_render_errors(self):
+ from django.http import HttpResponse
+
+ from netbox_librenms_plugin.views.imports.actions import _attach_messages_oob
+
+ response = HttpResponse(b"
row html
")
+ original = response.content
+ with patch(
+ "netbox_librenms_plugin.views.imports.actions.render_to_string",
+ side_effect=RuntimeError("db not available"),
+ ):
+ result = _attach_messages_oob(response, MagicMock())
+
+ assert result.content == original
+
+
class TestDeviceValidationDetailsView:
"""Tests for DeviceValidationDetailsView (lines 477-822)."""
@@ -665,11 +720,13 @@ def _make_view(self):
view._librenms_api = _make_api()
return view
- def test_device_not_found_returns_404(self):
+ def test_device_not_found_renders_htmx_error_toast(self):
view = self._make_view()
with patch.object(view, "get_validated_device_with_selections", return_value=(None, None, {})):
result = view.post(MagicMock(), device_id=1)
- assert result.status_code == 404
+ assert result.status_code == 200
+ assert result.headers.get("HX-Reswap") == "none"
+ assert b"Device not found" in result.content
@patch("netbox_librenms_plugin.views.imports.actions.render")
def test_device_found_renders_row(self, mock_render):
@@ -699,11 +756,13 @@ def _make_view(self):
view._librenms_api = _make_api()
return view
- def test_device_not_found_returns_404(self):
+ def test_device_not_found_renders_htmx_error_toast(self):
view = self._make_view()
with patch.object(view, "get_validated_device_with_selections", return_value=(None, None, {})):
result = view.post(MagicMock(), device_id=1)
- assert result.status_code == 404
+ assert result.status_code == 200
+ assert result.headers.get("HX-Reswap") == "none"
+ assert b"Device not found" in result.content
class TestDeviceRackUpdateView:
@@ -716,11 +775,13 @@ def _make_view(self):
view._librenms_api = _make_api()
return view
- def test_device_not_found_returns_404(self):
+ def test_device_not_found_renders_htmx_error_toast(self):
view = self._make_view()
with patch.object(view, "get_validated_device_with_selections", return_value=(None, None, {})):
result = view.post(MagicMock(), device_id=1)
- assert result.status_code == 404
+ assert result.status_code == 200
+ assert result.headers.get("HX-Reswap") == "none"
+ assert b"Device not found" in result.content
class TestDeviceConflictActionView:
@@ -740,21 +801,25 @@ def test_no_permission_returns_error(self):
result = view.post(MagicMock(), device_id=1)
assert result is error_resp
- def test_missing_action_returns_400(self):
+ def test_missing_action_renders_htmx_error_toast(self):
view = self._make_view()
with patch.object(view, "require_write_permission", return_value=None):
request = _make_request(post={"existing_device_id": "1"})
result = view.post(request, device_id=1)
- assert result.status_code == 400
+ assert result.status_code == 200
+ assert result.headers.get("HX-Reswap") == "none"
+ assert b"Missing action or existing_device_id" in result.content
- def test_missing_existing_device_id_returns_400(self):
+ def test_missing_existing_device_id_renders_htmx_error_toast(self):
view = self._make_view()
with patch.object(view, "require_write_permission", return_value=None):
request = _make_request(post={"action": "link"})
result = view.post(request, device_id=1)
- assert result.status_code == 400
+ assert result.status_code == 200
+ assert result.headers.get("HX-Reswap") == "none"
+ assert b"Missing action or existing_device_id" in result.content
- def test_vm_with_unsupported_action_returns_400(self):
+ def test_vm_with_unsupported_action_renders_htmx_error_toast(self):
view = self._make_view()
with patch.object(view, "require_write_permission", return_value=None):
request = _make_request(
@@ -765,9 +830,11 @@ def test_vm_with_unsupported_action_returns_400(self):
}
)
result = view.post(request, device_id=1)
- assert result.status_code == 400
+ assert result.status_code == 200
+ assert result.headers.get("HX-Reswap") == "none"
+ assert b"is not supported for virtual machines" in result.content
- def test_existing_device_not_found_returns_404(self):
+ def test_existing_device_not_found_renders_htmx_error_toast(self):
view = self._make_view()
with patch.object(view, "require_write_permission", return_value=None):
with patch("dcim.models.Device") as MockDevice:
@@ -777,9 +844,11 @@ def test_existing_device_not_found_returns_404(self):
request = _make_request(post={"action": "link", "existing_device_id": "abc"})
result = view.post(request, device_id=1)
- assert result.status_code == 404
+ assert result.status_code == 200
+ assert result.headers.get("HX-Reswap") == "none"
+ assert b"Existing device not found" in result.content
- def test_unknown_action_returns_400(self):
+ def test_unknown_action_renders_htmx_error_toast(self):
view = self._make_view()
with patch.object(view, "require_write_permission", return_value=None):
with patch("dcim.models.Device") as MockDevice:
@@ -802,7 +871,9 @@ def test_unknown_action_returns_400(self):
)
result = view.post(request, device_id=1)
- assert result.status_code == 400
+ assert result.status_code == 200
+ assert result.headers.get("HX-Reswap") == "none"
+ assert b"Unknown action: unknown_action" in result.content
class TestSaveUserPrefView:
@@ -943,7 +1014,10 @@ def test_no_explicit_vc_detection_still_returns_true(self):
def test_enable_vc_detection_from_post(self):
view = self._make_view()
request = _make_request(post={"enable_vc_detection": "on"})
- assert view._should_enable_vc_detection(1, request) is True
+ with patch("netbox_librenms_plugin.views.imports.actions.cache") as mock_cache:
+ mock_cache.get.return_value = None
+ result = view._should_enable_vc_detection(1, request)
+ assert result is True
class TestBuildSyncInfoNoPlatform:
@@ -1094,7 +1168,7 @@ def _make_view(self):
view.request = MagicMock()
return view
- def test_non_migrate_action_for_vm_returns_400(self):
+ def test_non_migrate_action_for_vm_renders_htmx_error_toast(self):
"""Lines 995-999: VM + non-migrate action = 400."""
view = self._make_view()
request = _make_request(
@@ -1108,17 +1182,21 @@ def test_non_migrate_action_for_vm_returns_400(self):
with patch.object(view, "require_all_permissions", return_value=None):
response = view.post(request, device_id=1)
- assert response.status_code == 400
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"is not supported for virtual machines" in response.content
- def test_missing_action_returns_400(self):
- """Line 989-990: missing action returns 400."""
+ def test_missing_action_renders_htmx_error_toast(self):
+ """Line 989-990: missing action renders htmx error toast (200)."""
view = self._make_view()
request = _make_request(post={"existing_device_id": "1"}) # No action
with patch.object(view, "require_all_permissions", return_value=None):
response = view.post(request, device_id=1)
- assert response.status_code == 400
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"Missing action or existing_device_id" in response.content
def test_server_key_override_creates_new_api(self):
"""Line 987: POST server_key creates new LibreNMSAPI."""
@@ -1153,7 +1231,7 @@ class TestDeviceRoleClusterRackViews:
"""Tests for DeviceRoleUpdateView, DeviceClusterUpdateView, DeviceRackUpdateView."""
def test_device_role_update_not_found(self):
- """DeviceRoleUpdateView returns 404 when device not found."""
+ """DeviceRoleUpdateView renders htmx error toast (200) when device not found."""
from netbox_librenms_plugin.views.imports.actions import DeviceRoleUpdateView
view = object.__new__(DeviceRoleUpdateView)
@@ -1165,10 +1243,12 @@ def test_device_role_update_not_found(self):
with patch.object(view, "get_validated_device_with_selections", return_value=(None, None, None)):
response = view.post(request, device_id=1)
- assert response.status_code == 404
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"Device not found" in response.content
def test_device_cluster_update_not_found(self):
- """DeviceClusterUpdateView returns 404 when device not found."""
+ """DeviceClusterUpdateView renders htmx error toast (200) when device not found."""
from netbox_librenms_plugin.views.imports.actions import DeviceClusterUpdateView
view = object.__new__(DeviceClusterUpdateView)
@@ -1180,10 +1260,12 @@ def test_device_cluster_update_not_found(self):
with patch.object(view, "get_validated_device_with_selections", return_value=(None, None, None)):
response = view.post(request, device_id=1)
- assert response.status_code == 404
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"Device not found" in response.content
def test_device_rack_update_not_found(self):
- """DeviceRackUpdateView returns 404 when device not found."""
+ """DeviceRackUpdateView renders htmx error toast (200) when device not found."""
from netbox_librenms_plugin.views.imports.actions import DeviceRackUpdateView
view = object.__new__(DeviceRackUpdateView)
@@ -1195,7 +1277,9 @@ def test_device_rack_update_not_found(self):
with patch.object(view, "get_validated_device_with_selections", return_value=(None, None, None)):
response = view.post(request, device_id=1)
- assert response.status_code == 404
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"Device not found" in response.content
def test_device_role_update_renders_row(self):
"""DeviceRoleUpdateView renders row when device found."""
@@ -1589,8 +1673,8 @@ def _make_view(self):
view.request = MagicMock()
return view
- def test_existing_device_not_found_returns_404(self):
- """Line 1008-1009: Device.objects.get raises DoesNotExist β 404."""
+ def test_existing_device_not_found_renders_htmx_error_toast(self):
+ """Line 1008-1009: Device.objects.get raises DoesNotExist β htmx error toast (200)."""
view = self._make_view()
request = _make_request(
post={
@@ -1605,7 +1689,9 @@ def test_existing_device_not_found_returns_404(self):
MockDevice.objects.get.side_effect = ValueError("Not found")
response = view.post(request, device_id=1)
- assert response.status_code == 404
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"Existing device not found" in response.content
class TestDeviceConflictActionMorePaths:
@@ -1625,8 +1711,8 @@ def _base_patches(self, view, mock_existing, libre_device, validation):
return ExitStack()
- def test_unknown_action_returns_400(self):
- """Line 1338: unknown action returns 400."""
+ def test_unknown_action_renders_htmx_error_toast(self):
+ """Line 1338: unknown action renders htmx error toast (200)."""
view = self._make_view()
request = _make_request(
post={
@@ -1653,9 +1739,11 @@ def test_unknown_action_returns_400(self):
):
response = view.post(request, device_id=42)
- assert response.status_code == 400
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"Unknown action: unknown_action_xyz" in response.content
- def test_force_required_without_force_returns_400(self):
+ def test_force_required_without_force_renders_htmx_error_toast(self):
"""Lines 1044/1047-1048: device_type_mismatch + force required but not provided."""
view = self._make_view()
request = _make_request(
@@ -1683,10 +1771,12 @@ def test_force_required_without_force_returns_400(self):
):
response = view.post(request, device_id=42)
- assert response.status_code == 400
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"Device type mismatch detected" in response.content
- def test_validated_existing_pk_mismatch_returns_400(self):
- """Line 1027: validated_existing.pk != existing_device.pk β 400."""
+ def test_validated_existing_pk_mismatch_renders_htmx_error_toast(self):
+ """Line 1027: validated_existing.pk != existing_device.pk β htmx error toast (200)."""
view = self._make_view()
request = _make_request(
post={
@@ -1717,10 +1807,12 @@ def test_validated_existing_pk_mismatch_returns_400(self):
):
response = view.post(request, device_id=42)
- assert response.status_code == 400
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"Device ID mismatch" in response.content
- def test_validated_existing_none_returns_400(self):
- """Line 1025: validated_existing is None β 400."""
+ def test_validated_existing_none_renders_htmx_error_toast(self):
+ """Line 1025: validated_existing is None β htmx error toast (200)."""
view = self._make_view()
request = _make_request(
post={
@@ -1748,7 +1840,9 @@ def test_validated_existing_none_returns_400(self):
):
response = view.post(request, device_id=42)
- assert response.status_code == 400
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"Missing validated conflict target" in response.content
def test_require_object_permissions_fails(self):
"""Line 1014: require_object_permissions returns error."""
@@ -1774,8 +1868,8 @@ def test_require_object_permissions_fails(self):
assert response.status_code == 403
- def test_migrate_not_flagged_returns_400(self):
- """Line 1252-1255: migrate_librenms_id with unflagged device β 400."""
+ def test_migrate_not_flagged_renders_htmx_error_toast(self):
+ """Line 1252-1255: migrate_librenms_id with unflagged device β htmx error toast (200)."""
view = self._make_view()
request = _make_request(
post={
@@ -1804,10 +1898,12 @@ def test_migrate_not_flagged_returns_400(self):
):
response = view.post(request, device_id=42)
- assert response.status_code == 400
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"already in JSON format" in response.content
- def test_migrate_already_json_format_returns_400(self):
- """Lines 1260-1265: cf_value already dict β 400."""
+ def test_migrate_already_json_format_renders_htmx_error_toast(self):
+ """Lines 1260-1265: cf_value already dict β htmx error toast (200)."""
view = self._make_view()
request = _make_request(
post={
@@ -1837,10 +1933,12 @@ def test_migrate_already_json_format_returns_400(self):
):
response = view.post(request, device_id=42)
- assert response.status_code == 400
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"already in JSON format" in response.content
- def test_migrate_id_mismatch_returns_400(self):
- """Line 1272-1275: cf_int != librenms_id β 400."""
+ def test_migrate_id_mismatch_renders_htmx_error_toast(self):
+ """Line 1272-1275: cf_int != librenms_id β htmx error toast (200)."""
view = self._make_view()
request = _make_request(
post={
@@ -1870,10 +1968,12 @@ def test_migrate_id_mismatch_returns_400(self):
):
response = view.post(request, device_id=42)
- assert response.status_code == 400
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"does not match the active device ID" in response.content
- def test_sync_device_type_no_match_returns_400(self):
- """Line 1241: sync_device_type with no HW match β 400."""
+ def test_sync_device_type_no_match_renders_htmx_error_toast(self):
+ """Line 1241: sync_device_type with no HW match β htmx error toast (200)."""
view = self._make_view()
request = _make_request(
post={
@@ -1905,10 +2005,12 @@ def test_sync_device_type_no_match_returns_400(self):
):
response = view.post(request, device_id=42)
- assert response.status_code == 400
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"No matching device type for" in response.content
- def test_sync_platform_no_os_returns_400(self):
- """Line 1227: sync_platform with empty OS β 400."""
+ def test_sync_platform_no_os_renders_htmx_error_toast(self):
+ """Line 1227: sync_platform with empty OS β htmx error toast (200)."""
view = self._make_view()
request = _make_request(
post={
@@ -1936,10 +2038,12 @@ def test_sync_platform_no_os_returns_400(self):
):
response = view.post(request, device_id=42)
- assert response.status_code == 400
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"No OS info from LibreNMS" in response.content
def test_sync_platform_not_found_in_netbox(self):
- """Line 1225: sync_platform platform not in NetBox β 400."""
+ """Line 1225: sync_platform platform not in NetBox β htmx error toast (200)."""
view = self._make_view()
request = _make_request(
post={
@@ -1970,7 +2074,9 @@ def test_sync_platform_not_found_in_netbox(self):
):
response = view.post(request, device_id=42)
- assert response.status_code == 400
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"not found in NetBox" in response.content
class TestDeviceConflictUpdateAction:
@@ -2098,8 +2204,8 @@ def _make_view(self):
view.request = MagicMock()
return view
- def test_bool_librenms_id_returns_400(self):
- """Line 1044: librenms_id is a boolean β 400."""
+ def test_bool_librenms_id_renders_htmx_error_toast(self):
+ """Line 1044: librenms_id is a boolean β htmx error toast (200)."""
view = self._make_view()
request = _make_request(
post={
@@ -2126,10 +2232,12 @@ def test_bool_librenms_id_returns_400(self):
):
response = view.post(request, device_id=1)
- assert response.status_code == 400
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"Invalid or missing LibreNMS device_id in payload" in response.content
- def test_non_int_librenms_id_returns_400(self):
- """Lines 1047-1048: librenms_id is non-int string β 400."""
+ def test_non_int_librenms_id_renders_htmx_error_toast(self):
+ """Lines 1047-1048: librenms_id is non-int string β htmx error toast (200)."""
view = self._make_view()
request = _make_request(
post={
@@ -2156,7 +2264,9 @@ def test_non_int_librenms_id_returns_400(self):
):
response = view.post(request, device_id=1)
- assert response.status_code == 400
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"Invalid or missing LibreNMS device_id in payload" in response.content
class TestDeviceConflictLinkIdConflict:
@@ -2170,8 +2280,8 @@ def _make_view(self):
view.request = MagicMock()
return view
- def test_id_conflict_returns_409(self):
- """Lines 1075-1079: LibreNMS ID conflict β 409."""
+ def test_id_conflict_renders_htmx_error_toast(self):
+ """Lines 1075-1079: LibreNMS ID conflict β htmx error toast (200)."""
view = self._make_view()
request = _make_request(
post={
@@ -2210,7 +2320,9 @@ def test_id_conflict_returns_409(self):
mock_tx.atomic.return_value.__exit__ = MagicMock(return_value=False)
response = view.post(request, device_id=42)
- assert response.status_code == 409
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"LibreNMS ID conflict" in response.content
class TestBulkImportConfirmViewVMRole:
@@ -2329,7 +2441,7 @@ class TestSaveDevicePath:
"""Test _save_device IntegrityError and ValidationError paths (line 168)."""
def test_save_device_validation_error(self):
- """Lines 50-52: ValidationError during save."""
+ """ValidationError during full_clean β 400 response."""
from netbox_librenms_plugin.views.imports.actions import _save_device
from django.core.exceptions import ValidationError as DjangoValidationError
@@ -2339,9 +2451,10 @@ def test_save_device_validation_error(self):
result = _save_device(mock_device)
assert result is not None
assert result.status_code == 400
+ assert b"Validation error" in result.content
def test_save_device_integrity_error(self):
- """Lines 54-56: IntegrityError during save."""
+ """IntegrityError during save β 409 response."""
from netbox_librenms_plugin.views.imports.actions import _save_device
from django.db import IntegrityError
@@ -2351,7 +2464,8 @@ def test_save_device_integrity_error(self):
result = _save_device(mock_device)
assert result is not None
- assert result.status_code == 409 # IntegrityError returns 409
+ assert result.status_code == 409
+ assert b"Integrity error" in result.content
def test_should_enable_vc_detection_when_cached(self):
"""Line 168: VC data already cached β returns True."""
@@ -2390,8 +2504,8 @@ def _make_view(self):
view.request = MagicMock()
return view
- def test_device_deleted_during_lock_returns_409(self):
- """Lines 1069-1073: Device.DoesNotExist during select_for_update β 409."""
+ def test_device_deleted_during_lock_renders_htmx_error_toast(self):
+ """Lines 1069-1073: Device.DoesNotExist during select_for_update β htmx error toast (200)."""
view = self._make_view()
request = _make_request(
post={
@@ -2427,7 +2541,9 @@ def test_device_deleted_during_lock_returns_409(self):
mock_tx.atomic.return_value.__exit__ = MagicMock(return_value=False)
response = view.post(request, device_id=42)
- assert response.status_code == 409
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"Device no longer exists" in response.content
class TestMigrateLibreNMSIdMorePaths:
@@ -2461,8 +2577,8 @@ def _make_base_context(self, mock_existing):
{},
)
- def test_serial_not_confirmed_no_force_returns_400(self):
- """Line 1277-1280: serial not confirmed, no force β 400."""
+ def test_serial_not_confirmed_no_force_renders_htmx_error_toast(self):
+ """Line 1277-1280: serial not confirmed, no force β htmx error toast (200)."""
view = self._make_view()
request = self._make_base_request()
@@ -2486,7 +2602,9 @@ def test_serial_not_confirmed_no_force_returns_400(self):
):
response = view.post(request, device_id=42)
- assert response.status_code == 400
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"Serial number not confirmed" in response.content
def test_migration_succeeds_and_renders_row(self):
"""Lines 1282-1323: successful migration renders row."""
@@ -2637,8 +2755,8 @@ def test_link_save_error_returns_error(self):
assert response.status_code == 400
- def test_update_serial_conflict_returns_409(self):
- """Line 1139: update_serial with serial conflict β 409."""
+ def test_update_serial_conflict_renders_htmx_error_toast(self):
+ """Line 1139: update_serial with serial conflict β htmx error toast (200)."""
view, request, mock_existing, libre_device, validation = self._base_setup("update_serial")
conflict_device = MagicMock()
conflict_device.name = "router99"
@@ -2650,7 +2768,9 @@ def test_update_serial_conflict_returns_409(self):
with patch("netbox_librenms_plugin.views.imports.actions._save_device", return_value=None):
response = view.post(request, device_id=42)
- assert response.status_code == 409
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"Serial conflict" in response.content
def test_update_serial_save_success_renders_row(self):
"""Lines 1146-1149: update_serial with no conflict β save + render."""
@@ -2687,8 +2807,8 @@ def test_sync_name_save_error(self):
assert response.status_code == 400
- def test_update_type_no_device_type_returns_400(self):
- """Line 1171: update_type with no librenms_device_type β 400."""
+ def test_update_type_no_device_type_renders_htmx_error_toast(self):
+ """Line 1171: update_type with no librenms_device_type β htmx error toast (200)."""
view, request, mock_existing, libre_device, validation = self._base_setup("update_type")
# No device_type_mismatch + no force β librenms_device_type = None
@@ -2696,7 +2816,9 @@ def test_update_type_no_device_type_returns_400(self):
with patch("netbox_librenms_plugin.views.imports.actions._save_device", return_value=None):
response = view.post(request, device_id=42)
- assert response.status_code == 400
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"No LibreNMS device type available to update" in response.content
def test_sync_platform_success_renders_row(self):
"""Line 1222: sync_platform with found platform β save + render."""
@@ -2732,7 +2854,7 @@ def test_sync_device_type_success_renders_row(self):
mock_render.assert_called_once()
- def test_device_not_found_after_action_returns_404(self):
+ def test_device_not_found_after_action_renders_htmx_error_toast(self):
"""Line 1338: get_validated_device_with_selections returns None after action."""
view, request, mock_existing, libre_device, validation = self._base_setup("sync_name")
@@ -2751,7 +2873,9 @@ def side_effect(*args, **kwargs):
with patch("netbox_librenms_plugin.views.imports.actions._save_device", return_value=None):
response = view.post(request, device_id=42)
- assert response.status_code == 404
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"Device not found after action" in response.content
class TestMoreSaveErrorPaths:
@@ -2824,7 +2948,7 @@ def _setup_common(self, view, mock_existing, libre_device, validation, save_retu
return stack, MockDevice
def test_update_serial_conflict_in_update(self):
- """Line 1108: update action with serial conflict β 409."""
+ """Line 1108: update action with serial conflict β htmx error toast (200)."""
view, request, mock_existing, libre_device, validation = self._base_setup("update")
conflict = MagicMock()
conflict.name = "other"
@@ -2835,7 +2959,9 @@ def test_update_serial_conflict_in_update(self):
MockDevice.objects.select_for_update.return_value.filter.return_value.exclude.return_value.first.return_value = conflict
response = view.post(request, device_id=42)
- assert response.status_code == 409
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"Serial conflict" in response.content
def test_update_with_device_type_mismatch_forced(self):
"""Lines 1116, 1119: update with force + device_type_mismatch β device_type applied."""
@@ -2926,8 +3052,8 @@ def _make_view(self):
view.request = MagicMock()
return view
- def test_sync_serial_no_serial_returns_400(self):
- """Line 1210: sync_serial with empty serial β 400."""
+ def test_sync_serial_no_serial_renders_htmx_error_toast(self):
+ """Line 1210: sync_serial with empty serial β htmx error toast (200)."""
view = self._make_view()
request = _make_request(post={"action": "sync_serial", "existing_device_id": "1"})
mock_existing = MagicMock()
@@ -2950,7 +3076,9 @@ def test_sync_serial_no_serial_returns_400(self):
):
response = view.post(request, device_id=42)
- assert response.status_code == 400
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"No valid serial from LibreNMS" in response.content
class TestUpdateAndSerialSaveErrors:
@@ -3071,7 +3199,7 @@ def _common_patches_for_serial(self, view, mock_existing, libre_device, validati
return stack, MockDevice, DoesNotExistExc
def test_sync_serial_device_deleted_under_lock(self):
- """Lines 1182-1183: Device.DoesNotExist during select_for_update β 409."""
+ """Lines 1182-1183: Device.DoesNotExist during select_for_update β htmx error toast (200)."""
view = self._make_view()
request = _make_request(post={"action": "sync_serial", "existing_device_id": "1"})
mock_existing = MagicMock()
@@ -3086,10 +3214,12 @@ def test_sync_serial_device_deleted_under_lock(self):
MockDevice.objects.select_for_update.return_value.get.side_effect = DoesNotExistExc("gone")
response = view.post(request, device_id=42)
- assert response.status_code == 409
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"Device no longer exists" in response.content
def test_sync_serial_conflict_under_lock(self):
- """Lines 1196-1200: sync_serial serial conflict β 409."""
+ """Lines 1196-1200: sync_serial serial conflict β htmx error toast (200)."""
view = self._make_view()
request = _make_request(post={"action": "sync_serial", "existing_device_id": "1"})
mock_existing = MagicMock()
@@ -3111,7 +3241,9 @@ def test_sync_serial_conflict_under_lock(self):
MockDevice.objects.filter.return_value.exclude.return_value.first.return_value = conflict_device
response = view.post(request, device_id=42)
- assert response.status_code == 409
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"Serial conflict" in response.content
def test_sync_serial_save_error(self):
"""Line 1207: sync_serial β _save_device returns error."""
@@ -3186,7 +3318,7 @@ def _make_valid_migrate_context(self, view, extra_mock=None):
return request, mock_existing, libre_device, validation, locked_device, MockDevice, DoesNotExistExc, mock_tx
def test_migrate_device_deleted_under_lock(self):
- """Lines 1285-1289: DoesNotExist during select_for_update β 409."""
+ """Lines 1285-1289: DoesNotExist during select_for_update β htmx error toast (200)."""
view = self._make_view()
req, mock_ex, libre, val, locked, MockDevice, DNE, mock_tx = self._make_valid_migrate_context(view)
MockDevice.objects.select_for_update.return_value.get.side_effect = DNE("gone")
@@ -3198,10 +3330,12 @@ def test_migrate_device_deleted_under_lock(self):
with patch("netbox_librenms_plugin.views.imports.actions.transaction", mock_tx):
response = view.post(req, device_id=42)
- assert response.status_code == 409
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"Object no longer exists" in response.content
def test_migrate_already_migrated_under_lock(self):
- """Lines 1292-1298: cf_locked already dict under lock β 400."""
+ """Lines 1292-1298: cf_locked already dict under lock β htmx error toast (200)."""
view = self._make_view()
req, mock_ex, libre, val, locked, MockDevice, DNE, mock_tx = self._make_valid_migrate_context(view)
locked.custom_field_data = {"librenms_id": {"default": 42}} # Already migrated under lock
@@ -3213,10 +3347,12 @@ def test_migrate_already_migrated_under_lock(self):
with patch("netbox_librenms_plugin.views.imports.actions.transaction", mock_tx):
response = view.post(req, device_id=42)
- assert response.status_code == 400
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"already in JSON format" in response.content
def test_migrate_id_changed_under_lock(self):
- """Lines 1300-1303: cf_locked_int != librenms_id under lock β 400."""
+ """Lines 1300-1303: cf_locked_int != librenms_id under lock β htmx error toast (200)."""
view = self._make_view()
req, mock_ex, libre, val, locked, MockDevice, DNE, mock_tx = self._make_valid_migrate_context(view)
locked.custom_field_data = {"librenms_id": 99} # Different ID under lock
@@ -3228,10 +3364,12 @@ def test_migrate_id_changed_under_lock(self):
with patch("netbox_librenms_plugin.views.imports.actions.transaction", mock_tx):
response = view.post(req, device_id=42)
- assert response.status_code == 400
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"changed under lock" in response.content
def test_migrate_id_conflict_with_other_device(self):
- """Lines 1309-1315: another device already has this ID β 409."""
+ """Lines 1309-1315: another device already has this ID β htmx error toast (200)."""
view = self._make_view()
req, mock_ex, libre, val, locked, MockDevice, DNE, mock_tx = self._make_valid_migrate_context(view)
conflict_dev = MagicMock()
@@ -3245,10 +3383,12 @@ def test_migrate_id_conflict_with_other_device(self):
with patch("netbox_librenms_plugin.utils.find_by_librenms_id", return_value=conflict_dev):
response = view.post(req, device_id=42)
- assert response.status_code == 409
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"Another device already has librenms_id" in response.content
def test_migrate_migration_fails(self):
- """Lines 1316-1320: migrate_legacy_librenms_id returns False β 400."""
+ """Lines 1316-1320: migrate_legacy_librenms_id returns False β htmx error toast (200)."""
view = self._make_view()
req, mock_ex, libre, val, locked, MockDevice, DNE, mock_tx = self._make_valid_migrate_context(view)
@@ -3263,15 +3403,17 @@ def test_migrate_migration_fails(self):
):
response = view.post(req, device_id=42)
- assert response.status_code == 400
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"Migration failed" in response.content
def test_migrate_save_error(self):
- """Line 1321-1322: _save_device returns error."""
+ """Migrate path saves only librenms_id field; IntegrityError on save β htmx toast."""
view = self._make_view()
req, mock_ex, libre, val, locked, MockDevice, DNE, mock_tx = self._make_valid_migrate_context(view)
- from django.http import HttpResponse
+ from django.db import IntegrityError
- err = HttpResponse("save error", status=400)
+ locked.save.side_effect = IntegrityError("dup")
with patch.object(view, "require_all_permissions", return_value=None):
with patch("dcim.models.Device", MockDevice):
@@ -3282,12 +3424,11 @@ def test_migrate_save_error(self):
with patch(
"netbox_librenms_plugin.utils.migrate_legacy_librenms_id", return_value=True
):
- with patch(
- "netbox_librenms_plugin.views.imports.actions._save_device", return_value=err
- ):
- response = view.post(req, device_id=42)
+ response = view.post(req, device_id=42)
- assert response.status_code == 400
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
+ assert b"Unable to migrate the LibreNMS mapping" in response.content
def test_migrate_success_renders_row(self):
"""Lines 1323+: successful migration renders row."""
@@ -3604,6 +3745,37 @@ def get_side_effect(k, d=None):
mock_redirect.assert_called()
+ def test_vc_detection_disabled_in_post_is_passed_to_device_import(self):
+ """vc_detection_enabled=off from POST must propagate to bulk import call."""
+ view = self._make_view()
+ request = self._make_base_request(["1"])
+ request.POST.get = MagicMock(side_effect=lambda k, d=None: "off" if k == "enable_vc_detection" else None)
+
+ with patch.object(view, "require_write_permission", return_value=None):
+ with patch(
+ "netbox_librenms_plugin.views.imports.actions.resolve_naming_preferences", return_value=(True, False)
+ ):
+ with patch(
+ "netbox_librenms_plugin.views.imports.actions.bulk_import_devices",
+ return_value={"success": [], "failed": [], "skipped": [], "virtual_chassis_created": 0},
+ ) as mock_bulk_import:
+ with patch(
+ "netbox_librenms_plugin.views.imports.actions.bulk_import_vms",
+ return_value={"success": [], "failed": [], "skipped": []},
+ ):
+ with patch(
+ "netbox_librenms_plugin.views.imports.actions.fetch_device_with_cache",
+ return_value={"device_id": 1},
+ ):
+ with patch("netbox_librenms_plugin.views.imports.actions.messages"):
+ with patch(
+ "netbox_librenms_plugin.views.imports.actions.redirect", return_value=MagicMock()
+ ):
+ view.post(request)
+
+ call_kwargs = mock_bulk_import.call_args.kwargs
+ assert call_kwargs["sync_options"]["vc_detection_enabled"] is False
+
def test_invalid_role_and_rack_values_log_warning(self):
"""Lines 534-535, 544-546: invalid role_id/rack_id β warning."""
view = self._make_view()
@@ -3906,11 +4078,15 @@ def test_permission_denied_htmx_returns_htmx_redirect(self):
"netbox_librenms_plugin.views.imports.actions.resolve_naming_preferences", return_value=(True, False)
):
with patch(
- "netbox_librenms_plugin.views.imports.actions.bulk_import_devices",
- side_effect=DjPD("No permission"),
+ "netbox_librenms_plugin.views.imports.actions.fetch_device_with_cache",
+ return_value={"device_id": 1, "hostname": "test-device"},
):
- with patch("netbox_librenms_plugin.views.imports.actions.messages"):
- response = view.post(request)
+ with patch(
+ "netbox_librenms_plugin.views.imports.actions.bulk_import_devices",
+ side_effect=DjPD("No permission"),
+ ):
+ with patch("netbox_librenms_plugin.views.imports.actions.messages"):
+ response = view.post(request)
assert response.headers.get("HX-Redirect") is not None
@@ -3953,3 +4129,106 @@ def get_side_effect(k, d=None):
view.post(request)
mock_redirect.assert_called()
+
+
+class TestBulkImportConfirmCollisions:
+ """Tests for Stage 3 collision-blocking behaviour."""
+
+ def _make_view(self):
+ from netbox_librenms_plugin.views.imports.actions import BulkImportConfirmView
+
+ view = object.__new__(BulkImportConfirmView)
+ view._librenms_api = _make_api()
+ return view
+
+ def _run_with_two_devices(self, validation_a, validation_b):
+ """Drive BulkImportConfirmView.post with two LibreNMS rows whose
+ validations are stubbed to whatever the test wants. Returns the
+ actual response object returned by view.post()."""
+ view = self._make_view()
+ request = _make_request(post={"select": ["1", "2"]})
+ request.POST.getlist = MagicMock(return_value=["1", "2"])
+ request.GET = MagicMock()
+ request.GET.get = MagicMock(return_value=None)
+
+ libre_devices = {
+ 1: {"device_id": 1, "hostname": "alpha"},
+ 2: {"device_id": 2, "hostname": "beta"},
+ }
+ validations = {1: validation_a, 2: validation_b}
+
+ def fake_validate(libre_device, **_kwargs):
+ return validations[libre_device["device_id"]]
+
+ with patch.object(view, "require_write_permission", return_value=None):
+ with patch(
+ "netbox_librenms_plugin.views.imports.actions.fetch_device_with_cache",
+ side_effect=lambda did, _api: libre_devices.get(did),
+ ):
+ with patch(
+ "netbox_librenms_plugin.views.imports.actions.extract_device_selections",
+ return_value={"cluster_id": None, "role_id": None, "rack_id": None},
+ ):
+ with patch(
+ "netbox_librenms_plugin.views.imports.actions.validate_device_for_import",
+ side_effect=fake_validate,
+ ):
+ with patch(
+ "netbox_librenms_plugin.views.imports.actions.resolve_naming_preferences",
+ return_value=(True, False),
+ ):
+ with patch(
+ "netbox_librenms_plugin.views.imports.actions.render",
+ ) as mock_render:
+ mock_render.side_effect = lambda req, tpl, ctx, status=200: MagicMock(
+ status_code=status,
+ template_name=tpl,
+ context=ctx,
+ )
+ response = view.post(request)
+ return response
+
+ def test_collision_path_renders_collision_template_with_409(self):
+ from types import SimpleNamespace
+
+ nb_device = SimpleNamespace(pk=42, name="srv-collide")
+ validation_a = {
+ "status": "importable",
+ "resolved_name": "alpha",
+ "virtual_chassis": {},
+ "existing_device": nb_device,
+ }
+ validation_b = {
+ "status": "importable",
+ "resolved_name": "beta",
+ "virtual_chassis": {},
+ "oob_candidate": {"device": nb_device, "type": "idrac"},
+ }
+ response = self._run_with_two_devices(validation_a, validation_b)
+ # Response itself should be the collision template at status 409.
+ assert response is not None, "view.post returned None instead of a rendered response"
+ assert "bulk_import_collision.html" in response.template_name
+ assert response.status_code == 409
+ assert len(response.context["collisions"]) == 1
+ assert response.context["collisions"][0]["nb_device_pk"] == 42
+
+ def test_clean_batch_renders_normal_confirm_template(self):
+ from types import SimpleNamespace
+
+ validation_a = {
+ "status": "importable",
+ "resolved_name": "alpha",
+ "virtual_chassis": {},
+ "existing_device": SimpleNamespace(pk=1, name="nb-a"),
+ }
+ validation_b = {
+ "status": "importable",
+ "resolved_name": "beta",
+ "virtual_chassis": {},
+ "existing_device": SimpleNamespace(pk=2, name="nb-b"),
+ }
+ response = self._run_with_two_devices(validation_a, validation_b)
+ assert response is not None, "view.post returned None instead of a rendered response"
+ assert "bulk_import_confirm.html" in response.template_name
+ # Default render() status is 200.
+ assert response.status_code == 200
diff --git a/netbox_librenms_plugin/tests/test_coverage_api.py b/netbox_librenms_plugin/tests/test_coverage_api.py
index 9b8ff68293..3e00037fdf 100644
--- a/netbox_librenms_plugin/tests/test_coverage_api.py
+++ b/netbox_librenms_plugin/tests/test_coverage_api.py
@@ -204,6 +204,28 @@ def test_dict_cf_routes_to_get_librenms_device_id(self):
assert result is None
mock_get_id.assert_called_once_with(obj, "default", auto_save=False)
+ def test_get_librenms_id_zero_is_valid(self):
+ """Regression: librenms_id == 0 must be returned directly without falling through to API lookup.
+ The code uses 'is not None' guards, so 0 is a valid cached/stored ID."""
+ api = _make_api()
+
+ obj = MagicMock()
+ obj.cf = {"librenms_id": {"default": 0}}
+ obj.custom_field_data = {"librenms_id": {"default": 0}}
+ obj._meta.model_name = "device"
+ obj.pk = 1
+ obj.primary_ip = None
+ obj.name = "zero-device"
+
+ # get_librenms_device_id returns 0 (valid ID, must not be treated as falsy)
+ with patch("netbox_librenms_plugin.utils.get_librenms_device_id", return_value=0) as mock_get_id:
+ with patch("netbox_librenms_plugin.librenms_api.cache") as mock_cache:
+ mock_cache.get.return_value = None
+ result = api.get_librenms_id(obj)
+ # 0 is a valid ID β method should return 0, not fall through to hostname lookup
+ assert result == 0
+ mock_get_id.assert_called_once_with(obj, "default", auto_save=False)
+
def test_store_librenms_id_via_hostname_lookup(self):
"""get_librenms_id reaches _store_librenms_id when CF/cache miss but hostname API hit."""
api = _make_api()
@@ -877,6 +899,7 @@ def test_add_device_with_port(self):
with patch("requests.post", return_value=mock_resp) as mock_post:
ok, msg = api.add_device(data)
assert ok is True
+ assert msg == "Device added successfully."
assert "port" in mock_post.call_args[1]["json"]
def test_add_device_with_transport(self):
@@ -888,6 +911,7 @@ def test_add_device_with_transport(self):
with patch("requests.post", return_value=mock_resp) as mock_post:
ok, msg = api.add_device(data)
assert ok is True
+ assert msg == "Device added successfully."
assert "transport" in mock_post.call_args[1]["json"]
def test_add_device_with_port_association_mode(self):
@@ -899,6 +923,7 @@ def test_add_device_with_port_association_mode(self):
with patch("requests.post", return_value=mock_resp) as mock_post:
ok, msg = api.add_device(data)
assert ok is True
+ assert msg == "Device added successfully."
assert "port_association_mode" in mock_post.call_args[1]["json"]
def test_add_device_with_poller_group(self):
@@ -910,6 +935,7 @@ def test_add_device_with_poller_group(self):
with patch("requests.post", return_value=mock_resp) as mock_post:
ok, msg = api.add_device(data)
assert ok is True
+ assert msg == "Device added successfully."
assert "poller_group" in mock_post.call_args[1]["json"]
@@ -1199,15 +1225,14 @@ def test_get_device_vlans_none_vlans(self):
assert ok is False
assert msg is not None
- def test_get_device_vlans_skips_non_dict_items(self):
- """get_device_vlans: non-dict items in vlans list are skipped safely."""
+ def test_get_device_vlans_fails_closed_on_non_dict_items(self):
+ """get_device_vlans: non-dict items in vlans list cause fail-closed (False, error message)."""
api = _make_api()
vlans = [None, "bad", {"device_id": 1, "vlan_id": 10}]
with patch("requests.get", return_value=self._ok_resp({"status": "ok", "vlans": vlans})):
- ok, data = api.get_device_vlans(1)
- assert ok is True
- assert len(data) == 1
- assert data[0]["vlan_id"] == 10
+ ok, msg = api.get_device_vlans(1)
+ assert ok is False
+ assert "invalid item shape" in msg
def test_get_device_ips_none_addresses(self):
"""get_device_ips: addresses=None returns (False, ...)."""
diff --git a/netbox_librenms_plugin/tests/test_coverage_api2.py b/netbox_librenms_plugin/tests/test_coverage_api2.py
index 65260421e6..68bd4ad728 100644
--- a/netbox_librenms_plugin/tests/test_coverage_api2.py
+++ b/netbox_librenms_plugin/tests/test_coverage_api2.py
@@ -280,6 +280,8 @@ class _DoesNotExist(Exception):
assert data["status"] == "updated"
assert data["rq_status"] == "not_found"
mock_db_job.save.assert_called_once_with(update_fields=["status", "completed"])
+ assert mock_db_job.status == JobStatusChoices.STATUS_FAILED
+ assert mock_db_job.completed == "2024-01-03"
def test_no_change_when_not_running_and_not_in_rq(self):
from core.choices import JobStatusChoices
@@ -348,6 +350,14 @@ class _DoesNotExist(Exception):
mock_tz.now.assert_not_called()
assert response.status_code == 200
+ data = json.loads(response.content)
+ assert data["status"] == "updated"
+ assert data["rq_status"] == "not_found"
+ # Verify the DB job was marked failed and persisted
+ assert mock_db_job.status == JobStatusChoices.STATUS_FAILED
+ mock_db_job.save.assert_called_once_with(update_fields=["status", "completed"])
+ # completed must NOT be overwritten β it was already set
+ assert mock_db_job.completed == "2024-01-01T08:00:00"
# ===========================================================================
diff --git a/netbox_librenms_plugin/tests/test_coverage_base_views2.py b/netbox_librenms_plugin/tests/test_coverage_base_views2.py
index e75abcc1b7..5e039a61d8 100644
--- a/netbox_librenms_plugin/tests/test_coverage_base_views2.py
+++ b/netbox_librenms_plugin/tests/test_coverage_base_views2.py
@@ -1581,8 +1581,8 @@ def test_invalid_json_returns_400(self):
data = json_mod.loads(response.content)
assert data["status"] == "error"
- def test_interface_from_device_used_when_no_cache(self):
- """When no cache entry (port_id=None), first device interface is used."""
+ def test_interface_from_device_used_when_cache_has_no_port_id(self):
+ """When cache contains an IP entry with no port_id, first device interface is used."""
import json as json_mod
view = self._make_view()
@@ -1610,18 +1610,12 @@ def test_interface_from_device_used_when_no_cache(self):
patch.object(view, "_parse_ip_address", return_value=("10.0.0.1", 24)),
patch.object(view, "get_cache_key", return_value="cache-key"),
patch("netbox_librenms_plugin.views.base.ip_addresses_view.cache") as mock_cache,
- patch.object(
- view,
- "_find_in_cache",
- # Truthy cache_entry whose port_id (third element) is None
- # β both cache enrichment and interfaces.first() fallback run
- return_value=({"ip_address": "10.0.0.1", "prefix_length": 24}, None, None),
- ),
patch.object(view, "_find_existing_ip", return_value=(False, False, None)),
patch.object(view, "_determine_status", return_value="sync"),
patch("netbox_librenms_plugin.views.base.ip_addresses_view.IPAddressTable") as MockTable,
):
- mock_cache.get.return_value = None
+ # Cache has an entry for this IP but no port_id β interfaces.first() fallback runs
+ mock_cache.get.return_value = {"ip_addresses": [{"ip_address": "10.0.0.1", "prefix_length": 24}]}
mock_table_instance = MagicMock()
mock_table_instance.render_status.return_value = "
sync"
MockTable.return_value = mock_table_instance
@@ -1629,8 +1623,13 @@ def test_interface_from_device_used_when_no_cache(self):
response = view.post(req)
assert response.status_code == 200
- # Cache entry was truthy but had no port_id β first device interface used
+ # Cache entry found but has no port_id β first device interface used
mock_obj.interfaces.first.assert_called_once()
+ # And that interface's name/url must actually flow into the rendered record,
+ # not just be queried.
+ rendered_record = mock_table_instance.render_status.call_args[0][1]
+ assert rendered_record["interface_name"] == "eth0"
+ assert rendered_record["interface_url"] == "/interface/1/"
def test_verify_with_non_default_server_key(self):
"""server_key='secondary' propagates to get_cache_key call."""
diff --git a/netbox_librenms_plugin/tests/test_coverage_bulk_import.py b/netbox_librenms_plugin/tests/test_coverage_bulk_import.py
new file mode 100644
index 0000000000..2c92406b7f
--- /dev/null
+++ b/netbox_librenms_plugin/tests/test_coverage_bulk_import.py
@@ -0,0 +1,2337 @@
+"""
+Coverage tests for import_utils/bulk_import.py.
+
+Exercises error paths, cancellation flows, cache behaviour,
+and edge cases in bulk_import_devices_shared and process_device_filters.
+"""
+
+from unittest.mock import MagicMock, patch
+
+import pytest
+
+# ---------------------------------------------------------------------------
+# Shared helpers
+# ---------------------------------------------------------------------------
+
+
+def _make_job(logger=True):
+ """
+ Return a minimal JobRunner-like mock.
+
+ Args:
+ logger: If True (default) attach a MagicMock logger; if False set it
+ to None so the ``else: logger.warning(...)`` branches fire.
+ """
+ job = MagicMock()
+ job.job = MagicMock()
+ job.job.job_id = "test-uuid-1234"
+ job.job.pk = 1
+ job.logger = MagicMock() if logger else None
+ return job
+
+
+def _make_rq_running():
+ """RQ job that is actively running (not stopped/failed)."""
+ rq_job = MagicMock()
+ rq_job.is_stopped = False
+ rq_job.is_failed = False
+ rq_job.get_status.return_value = "started"
+ return rq_job
+
+
+def _make_rq_stopped():
+ """RQ job that has been stopped."""
+ rq_job = MagicMock()
+ rq_job.is_stopped = True
+ rq_job.is_failed = False
+ rq_job.get_status.return_value = "stopped"
+ return rq_job
+
+
+def _make_validation(existing_device=None, import_as_vm=False, issues=None):
+ """Minimal valid validation dict used throughout the tests."""
+ return {
+ "resolved_name": "test-device",
+ "is_ready": True,
+ "can_import": True,
+ "status": "active",
+ "existing_device": existing_device,
+ "import_as_vm": import_as_vm,
+ "existing_match_type": None,
+ "virtual_chassis": {"is_stack": False},
+ "site": {"found": True, "site": MagicMock()},
+ "device_type": {"found": True, "device_type": MagicMock()},
+ "device_role": {"found": True, "role": MagicMock()},
+ "platform": {"found": True, "platform": MagicMock()},
+ "cluster": {"found": True},
+ "issues": issues or [],
+ }
+
+
+def _make_import_result(success=True, device=None, message="Imported", error=None):
+ """Return value for mocked ``import_single_device``."""
+ return {
+ "success": success,
+ "device": device or (MagicMock() if success else None),
+ "message": message,
+ "error": error or ("" if success else "Import failed"),
+ }
+
+
+# ===========================================================================
+# 1. TestBulkImportDevices# ===========================================================================
+
+
+class TestBulkImportDevices:
+ """Tests for the thin ``bulk_import_devices`` wrapper."""
+
+ def test_delegates_to_shared_with_job_none(self):
+ """bulk_import_devices must call bulk_import_devices_shared with job=None."""
+ with patch("netbox_librenms_plugin.import_utils.bulk_import.bulk_import_devices_shared") as mock_shared:
+ from netbox_librenms_plugin.import_utils.bulk_import import bulk_import_devices
+
+ expected = {
+ "total": 2,
+ "success": [],
+ "failed": [],
+ "skipped": [],
+ "virtual_chassis_created": 0,
+ }
+ mock_shared.return_value = expected
+ user = MagicMock()
+
+ result = bulk_import_devices(
+ device_ids=[1, 2],
+ server_key="default",
+ sync_options={"use_sysname": True},
+ manual_mappings_per_device={1: {"device_role_id": 5}},
+ libre_devices_cache={1: {"hostname": "test"}},
+ user=user,
+ )
+
+ mock_shared.assert_called_once_with(
+ device_ids=[1, 2],
+ server_key="default",
+ sync_options={"use_sysname": True},
+ manual_mappings_per_device={1: {"device_role_id": 5}},
+ libre_devices_cache={1: {"hostname": "test"}},
+ job=None,
+ user=user,
+ )
+ assert result == expected
+
+
+# ===========================================================================
+# 2. TestBulkImportDevicesShared# 183, 203-254
+# ===========================================================================
+
+
+class TestBulkImportDevicesShared:
+ """Tests for ``bulk_import_devices_shared``."""
+
+ # ------------------------------------------------------------------
+ # Lines 129 & 140 β "else: logger.warning(...)" when job.logger=None
+ # ------------------------------------------------------------------
+
+ def test_rq_stopped_logs_via_module_logger_when_job_logger_none(self):
+ """job.logger=None: module logger.warning fires on RQ stop."""
+ job = _make_job(logger=False) # job.logger is None β else branch
+ libre_cache = {1: {"device_id": 1, "hostname": "test"}}
+
+ with (
+ patch("netbox_librenms_plugin.import_utils.bulk_import.require_permissions"),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.LibreNMSAPI"),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.import_single_device") as mock_import,
+ patch("netbox_librenms_plugin.import_utils.bulk_import.logger") as mock_logger,
+ patch("django_rq.get_queue") as mock_get_queue,
+ patch("rq.job.Job") as mock_rq_cls,
+ ):
+ mock_queue = MagicMock()
+ mock_get_queue.return_value = mock_queue
+ mock_rq_cls.fetch.return_value = _make_rq_stopped()
+
+ from netbox_librenms_plugin.import_utils.bulk_import import bulk_import_devices_shared
+
+ result = bulk_import_devices_shared(
+ device_ids=[1],
+ job=job,
+ libre_devices_cache=libre_cache,
+ )
+
+ mock_import.assert_not_called()
+ mock_logger.warning.assert_called()
+ assert result["success"] == []
+
+ def test_rq_unavailable_does_not_cancel_import(self):
+ """When RQ/Redis is unavailable, _is_job_cancelled returns False β import continues."""
+ job = _make_job(logger=False) # job.logger is None
+ libre_cache = {1: {"device_id": 1, "hostname": "test"}}
+
+ with (
+ patch("netbox_librenms_plugin.import_utils.bulk_import.require_permissions"),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.LibreNMSAPI"),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.import_single_device") as mock_import,
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ return_value=_make_validation(),
+ ),
+ patch("django_rq.get_queue", side_effect=Exception("RQ unavailable")),
+ ):
+ from netbox_librenms_plugin.import_utils.bulk_import import bulk_import_devices_shared
+
+ bulk_import_devices_shared(
+ device_ids=[1],
+ job=job,
+ libre_devices_cache=libre_cache,
+ )
+
+ mock_import.assert_called()
+
+ # ------------------------------------------------------------------
+ # Lines 146-147 β libre_devices_cache hit path
+ # ------------------------------------------------------------------
+
+ def test_libre_devices_cache_hit_skips_api_call(self):
+ """Devices in libre_devices_cache skip the API call."""
+ libre_cache = {
+ 1: {"device_id": 1, "hostname": "cached-host"},
+ }
+
+ with (
+ patch("netbox_librenms_plugin.import_utils.bulk_import.require_permissions"),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.LibreNMSAPI") as mock_api_cls,
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ return_value=_make_validation(),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.import_single_device",
+ return_value=_make_import_result(),
+ ),
+ ):
+ mock_api = MagicMock()
+ mock_api.server_key = "default"
+ mock_api_cls.return_value = mock_api
+
+ from netbox_librenms_plugin.import_utils.bulk_import import bulk_import_devices_shared
+
+ result = bulk_import_devices_shared(
+ device_ids=[1],
+ user=MagicMock(),
+ libre_devices_cache=libre_cache,
+ )
+
+ # API.get_device_info should NOT have been called for this device
+ mock_api.get_device_info.assert_not_called()
+ assert len(result["success"]) == 1
+
+ # ------------------------------------------------------------------
+ # Line 183 β job.logger.info("Imported device X of Y")
+ # ------------------------------------------------------------------
+
+ def test_successful_import_emits_job_progress_log(self):
+ """job.logger.info('Imported device X of Y') on success."""
+ job = _make_job()
+ libre_cache = {1: {"device_id": 1, "hostname": "test"}}
+
+ with (
+ patch("netbox_librenms_plugin.import_utils.bulk_import.require_permissions"),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.LibreNMSAPI"),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ return_value=_make_validation(),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.import_single_device",
+ return_value=_make_import_result(),
+ ),
+ patch("django_rq.get_queue") as mock_get_queue,
+ patch("rq.job.Job") as mock_rq_cls,
+ ):
+ mock_queue = MagicMock()
+ mock_get_queue.return_value = mock_queue
+ mock_rq_cls.fetch.return_value = _make_rq_running()
+
+ from netbox_librenms_plugin.import_utils.bulk_import import bulk_import_devices_shared
+
+ result = bulk_import_devices_shared(
+ device_ids=[1],
+ job=job,
+ libre_devices_cache=libre_cache,
+ )
+
+ assert len(result["success"]) == 1
+ job.logger.info.assert_any_call("Imported device 1 of 1")
+
+ # ------------------------------------------------------------------
+ # Lines 203-254 β virtual chassis creation (is_stack=True)
+ # ------------------------------------------------------------------
+
+ def test_vc_creation_triggered_for_stack(self):
+ """is_stack=True β create_virtual_chassis_with_members called."""
+ libre_cache = {1: {"device_id": 1, "hostname": "test"}}
+ mock_device = MagicMock()
+ mock_vc = MagicMock()
+ mock_vc.name = "VC-Stack"
+
+ validation = _make_validation()
+ validation["virtual_chassis"] = {
+ "is_stack": True,
+ "members": [
+ {"serial": "SN001", "position": 1},
+ {"serial": "SN002", "position": 2},
+ ],
+ }
+
+ with (
+ patch("netbox_librenms_plugin.import_utils.bulk_import.require_permissions"),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.LibreNMSAPI"),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ return_value=validation,
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.import_single_device",
+ return_value=_make_import_result(device=mock_device),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.create_virtual_chassis_with_members",
+ return_value=mock_vc,
+ ) as mock_create_vc,
+ ):
+ from netbox_librenms_plugin.import_utils.bulk_import import bulk_import_devices_shared
+
+ result = bulk_import_devices_shared(
+ device_ids=[1],
+ user=MagicMock(),
+ libre_devices_cache=libre_cache,
+ )
+
+ mock_create_vc.assert_called_once()
+ assert result["virtual_chassis_created"] == 1
+ assert len(result["success"]) == 1
+
+ def test_vc_creation_with_job_logger(self):
+ """VC creation with job β job.logger.info logged."""
+ job = _make_job()
+ libre_cache = {1: {"device_id": 1, "hostname": "test"}}
+ mock_vc = MagicMock()
+ mock_vc.name = "VC-Stack"
+
+ validation = _make_validation()
+ validation["virtual_chassis"] = {
+ "is_stack": True,
+ "members": [{"serial": "SN001", "position": 1}],
+ }
+
+ with (
+ patch("netbox_librenms_plugin.import_utils.bulk_import.require_permissions"),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.LibreNMSAPI"),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ return_value=validation,
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.import_single_device",
+ return_value=_make_import_result(),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.create_virtual_chassis_with_members",
+ return_value=mock_vc,
+ ),
+ patch("django_rq.get_queue") as mock_get_queue,
+ patch("rq.job.Job") as mock_rq_cls,
+ ):
+ mock_queue = MagicMock()
+ mock_get_queue.return_value = mock_queue
+ mock_rq_cls.fetch.return_value = _make_rq_running()
+
+ from netbox_librenms_plugin.import_utils.bulk_import import bulk_import_devices_shared
+
+ result = bulk_import_devices_shared(
+ device_ids=[1],
+ job=job,
+ libre_devices_cache=libre_cache,
+ )
+
+ assert result["virtual_chassis_created"] == 1
+ # Confirm job logger was called for the VC creation
+ assert any("VC" in c.args[0] for c in job.logger.info.call_args_list if c.args)
+
+ def test_vc_creation_deduplicates_by_member_serials(self):
+ """Two devices with identical member serials β VC created only once."""
+ libre_cache = {
+ 1: {"device_id": 1, "hostname": "stack-1"},
+ 2: {"device_id": 2, "hostname": "stack-2"},
+ }
+ mock_vc = MagicMock()
+ mock_vc.name = "VC-Stack"
+
+ # Both devices share the same physical stack (same member serials)
+ shared_vc_data = {
+ "is_stack": True,
+ "members": [
+ {"serial": "SN001", "position": 1},
+ {"serial": "SN002", "position": 2},
+ ],
+ }
+ v1 = _make_validation()
+ v1["virtual_chassis"] = shared_vc_data
+ v2 = _make_validation()
+ v2["virtual_chassis"] = shared_vc_data
+
+ with (
+ patch("netbox_librenms_plugin.import_utils.bulk_import.require_permissions"),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.LibreNMSAPI"),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ side_effect=[v1, v2],
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.import_single_device",
+ return_value=_make_import_result(),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.create_virtual_chassis_with_members",
+ return_value=mock_vc,
+ ) as mock_create_vc,
+ ):
+ from netbox_librenms_plugin.import_utils.bulk_import import bulk_import_devices_shared
+
+ result = bulk_import_devices_shared(
+ device_ids=[1, 2],
+ user=MagicMock(),
+ libre_devices_cache=libre_cache,
+ )
+
+ assert mock_create_vc.call_count == 1
+ assert result["virtual_chassis_created"] == 1
+
+ def test_vc_creation_failure_continues_import(self):
+ """VC creation exception β import device still succeeds."""
+ libre_cache = {1: {"device_id": 1, "hostname": "test"}}
+ validation = _make_validation()
+ validation["virtual_chassis"] = {
+ "is_stack": True,
+ "members": [{"serial": "SN001", "position": 1}],
+ }
+
+ with (
+ patch("netbox_librenms_plugin.import_utils.bulk_import.require_permissions"),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.LibreNMSAPI"),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ return_value=validation,
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.import_single_device",
+ return_value=_make_import_result(),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.create_virtual_chassis_with_members",
+ side_effect=Exception("VC creation failed"),
+ ) as mock_create_vc,
+ ):
+ from netbox_librenms_plugin.import_utils.bulk_import import bulk_import_devices_shared
+
+ result = bulk_import_devices_shared(
+ device_ids=[1],
+ user=MagicMock(),
+ libre_devices_cache=libre_cache,
+ )
+
+ # Import succeeded despite VC failure
+ assert len(result["success"]) == 1
+ assert result["virtual_chassis_created"] == 0
+ mock_create_vc.assert_called_once()
+
+ def test_vc_creation_skipped_without_vc_permission(self):
+ """User lacks dcim.add_virtualchassis β stack device import fails fast (PR #257)."""
+ libre_cache = {1: {"device_id": 1, "hostname": "test"}}
+ validation = _make_validation()
+ validation["virtual_chassis"] = {
+ "is_stack": True,
+ "members": [{"serial": "SN001", "position": 1}, {"serial": "SN002", "position": 2}],
+ }
+
+ user = MagicMock()
+ user.has_perm.side_effect = lambda p: p != "dcim.add_virtualchassis"
+
+ with (
+ patch("netbox_librenms_plugin.import_utils.bulk_import.require_permissions"),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.LibreNMSAPI"),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ return_value=validation,
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.import_single_device",
+ return_value=_make_import_result(),
+ ) as mock_import,
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.create_virtual_chassis_with_members",
+ ) as mock_create_vc,
+ ):
+ from netbox_librenms_plugin.import_utils.bulk_import import bulk_import_devices_shared
+
+ result = bulk_import_devices_shared(
+ device_ids=[1],
+ user=user,
+ libre_devices_cache=libre_cache,
+ )
+
+ mock_create_vc.assert_not_called()
+ mock_import.assert_not_called()
+ assert len(result["success"]) == 0
+ assert len(result["failed"]) == 1
+ assert "dcim.add_virtualchassis" in result["failed"][0]["error"]
+ assert result["virtual_chassis_created"] == 0
+
+ def test_vc_creation_skipped_without_permission_logs_job_warning(self):
+ """Missing VC permission with job context logs error via job.logger (PR #257)."""
+ job = _make_job()
+ libre_cache = {1: {"device_id": 1, "hostname": "test"}}
+ validation = _make_validation()
+ validation["virtual_chassis"] = {
+ "is_stack": True,
+ "members": [{"serial": "SN001", "position": 1}],
+ }
+
+ user = MagicMock()
+ user.has_perm.side_effect = lambda p: p != "dcim.add_virtualchassis"
+
+ with (
+ patch("netbox_librenms_plugin.import_utils.bulk_import.require_permissions"),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.LibreNMSAPI"),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ return_value=validation,
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.import_single_device",
+ return_value=_make_import_result(),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.create_virtual_chassis_with_members",
+ ) as mock_create_vc,
+ patch("django_rq.get_queue") as mock_get_queue,
+ patch("rq.job.Job") as mock_rq_cls,
+ ):
+ mock_queue = MagicMock()
+ mock_get_queue.return_value = mock_queue
+ mock_rq_cls.fetch.return_value = _make_rq_running()
+ from netbox_librenms_plugin.import_utils.bulk_import import bulk_import_devices_shared
+
+ result = bulk_import_devices_shared(
+ device_ids=[1],
+ user=user,
+ job=job,
+ libre_devices_cache=libre_cache,
+ )
+
+ mock_create_vc.assert_not_called()
+ job.logger.error.assert_called()
+ assert len(result["success"]) == 0
+ assert len(result["failed"]) == 1
+ assert "dcim.add_virtualchassis" in result["failed"][0]["error"]
+
+ def test_vc_with_no_members_falls_back_to_device_id_domain(self):
+ """No serials and no member fingerprint triggers device-id vc_domain fallback."""
+ libre_cache = {1: {"device_id": 1, "hostname": "test"}}
+ validation = _make_validation()
+ validation["virtual_chassis"] = {"is_stack": True, "members": []}
+
+ with (
+ patch("netbox_librenms_plugin.import_utils.bulk_import.require_permissions"),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.LibreNMSAPI"),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ return_value=validation,
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.import_single_device",
+ return_value=_make_import_result(),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.create_virtual_chassis_with_members",
+ return_value=MagicMock(name="vc"),
+ ) as mock_create_vc,
+ ):
+ from netbox_librenms_plugin.import_utils.bulk_import import bulk_import_devices_shared
+
+ result = bulk_import_devices_shared(
+ device_ids=[1],
+ user=MagicMock(),
+ libre_devices_cache=libre_cache,
+ )
+
+ mock_create_vc.assert_called_once()
+ assert result["virtual_chassis_created"] == 1
+
+ def test_vc_creation_proceeds_with_vc_permission(self):
+ """User has dcim.add_virtualchassis β VC creation proceeds normally."""
+ libre_cache = {1: {"device_id": 1, "hostname": "test"}}
+ mock_vc = MagicMock()
+ mock_vc.name = "VC-Stack"
+ validation = _make_validation()
+ validation["virtual_chassis"] = {
+ "is_stack": True,
+ "members": [{"serial": "SN001", "position": 1}, {"serial": "SN002", "position": 2}],
+ }
+
+ user = MagicMock()
+ user.has_perm.return_value = True # all perms granted
+
+ with (
+ patch("netbox_librenms_plugin.import_utils.bulk_import.require_permissions"),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.LibreNMSAPI"),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ return_value=validation,
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.import_single_device",
+ return_value=_make_import_result(),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.create_virtual_chassis_with_members",
+ return_value=mock_vc,
+ ) as mock_create_vc,
+ ):
+ from netbox_librenms_plugin.import_utils.bulk_import import bulk_import_devices_shared
+
+ result = bulk_import_devices_shared(
+ device_ids=[1],
+ user=user,
+ libre_devices_cache=libre_cache,
+ )
+
+ mock_create_vc.assert_called_once()
+ assert result["virtual_chassis_created"] == 1
+
+ def test_vc_no_member_serials_uses_device_id_domain(self):
+ """Members with no valid serials β vc_domain falls back to device_id."""
+ libre_cache = {1: {"device_id": 1, "hostname": "test"}}
+ mock_vc = MagicMock()
+ mock_vc.name = "VC-1"
+
+ validation = _make_validation()
+ validation["virtual_chassis"] = {
+ "is_stack": True,
+ "members": [
+ {"serial": None, "position": 1},
+ {"serial": "-", "position": 2},
+ ],
+ }
+
+ with (
+ patch("netbox_librenms_plugin.import_utils.bulk_import.require_permissions"),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.LibreNMSAPI"),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ return_value=validation,
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.import_single_device",
+ return_value=_make_import_result(),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.create_virtual_chassis_with_members",
+ return_value=mock_vc,
+ ) as mock_create_vc,
+ ):
+ from netbox_librenms_plugin.import_utils.bulk_import import bulk_import_devices_shared
+
+ result = bulk_import_devices_shared(
+ device_ids=[1],
+ user=MagicMock(),
+ libre_devices_cache=libre_cache,
+ )
+
+ mock_create_vc.assert_called_once()
+ assert result["virtual_chassis_created"] == 1
+
+ def test_failed_import_with_job_logs_error(self):
+ """result.success=False, device=None β job.logger.error called."""
+ job = _make_job()
+ libre_cache = {1: {"device_id": 1, "hostname": "test"}}
+
+ with (
+ patch("netbox_librenms_plugin.import_utils.bulk_import.require_permissions"),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.LibreNMSAPI"),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ return_value=_make_validation(),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.import_single_device",
+ return_value=_make_import_result(success=False, device=None, error="Import failed"),
+ ),
+ patch("django_rq.get_queue") as mock_get_queue,
+ patch("rq.job.Job") as mock_rq_cls,
+ ):
+ mock_queue = MagicMock()
+ mock_get_queue.return_value = mock_queue
+ mock_rq_cls.fetch.return_value = _make_rq_running()
+
+ from netbox_librenms_plugin.import_utils.bulk_import import bulk_import_devices_shared
+
+ result = bulk_import_devices_shared(
+ device_ids=[1],
+ job=job,
+ libre_devices_cache=libre_cache,
+ )
+
+ assert len(result["failed"]) == 1
+ job.logger.error.assert_called()
+
+ def test_manual_mappings_applied_to_device(self):
+ """manual_mappings_per_device overrides are applied for the matching device."""
+ libre_cache = {1: {"device_id": 1, "hostname": "test"}}
+ captured_mappings = {}
+
+ def capture_import(device_id, server_key, validation, sync_options, manual_mappings, libre_device):
+ captured_mappings.update(manual_mappings or {})
+ return _make_import_result()
+
+ with (
+ patch("netbox_librenms_plugin.import_utils.bulk_import.require_permissions"),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.LibreNMSAPI"),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ return_value=_make_validation(),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.import_single_device",
+ side_effect=capture_import,
+ ),
+ ):
+ from netbox_librenms_plugin.import_utils.bulk_import import bulk_import_devices_shared
+
+ result = bulk_import_devices_shared(
+ device_ids=[1],
+ user=MagicMock(),
+ libre_devices_cache=libre_cache,
+ manual_mappings_per_device={1: {"device_role_id": 42}},
+ )
+
+ assert result["success"]
+ assert captured_mappings.get("device_role_id") == 42
+
+ def test_device_skipped_when_already_exists(self):
+ """result.success=False, result.device is truthy β device skipped."""
+ libre_cache = {1: {"device_id": 1, "hostname": "test"}}
+ existing_device = MagicMock()
+
+ with (
+ patch("netbox_librenms_plugin.import_utils.bulk_import.require_permissions"),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.LibreNMSAPI"),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ return_value=_make_validation(),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.import_single_device",
+ return_value=_make_import_result(success=False, device=existing_device, error="Device already exists"),
+ ),
+ ):
+ from netbox_librenms_plugin.import_utils.bulk_import import bulk_import_devices_shared
+
+ result = bulk_import_devices_shared(
+ device_ids=[1],
+ user=MagicMock(),
+ libre_devices_cache=libre_cache,
+ )
+
+ assert len(result["skipped"]) == 1
+ assert result["skipped"][0]["reason"] == "Device already exists"
+ assert result["failed"] == []
+
+ def test_vc_creation_failure_with_job_logs_warning(self):
+ """VC failure with job.logger set β job.logger.warning fired."""
+ job = _make_job()
+ libre_cache = {1: {"device_id": 1, "hostname": "test"}}
+ validation = _make_validation()
+ validation["virtual_chassis"] = {
+ "is_stack": True,
+ "members": [{"serial": "SN001", "position": 1}],
+ }
+
+ with (
+ patch("netbox_librenms_plugin.import_utils.bulk_import.require_permissions"),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.LibreNMSAPI"),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ return_value=validation,
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.import_single_device",
+ return_value=_make_import_result(),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.create_virtual_chassis_with_members",
+ side_effect=Exception("VC error"),
+ ),
+ patch("django_rq.get_queue") as mock_get_queue,
+ patch("rq.job.Job") as mock_rq_cls,
+ ):
+ mock_get_queue.return_value = MagicMock()
+ mock_rq_cls.fetch.return_value = _make_rq_running()
+
+ from netbox_librenms_plugin.import_utils.bulk_import import bulk_import_devices_shared
+
+ result = bulk_import_devices_shared(
+ device_ids=[1],
+ job=job,
+ libre_devices_cache=libre_cache,
+ )
+
+ assert len(result["success"]) == 1
+ assert result["virtual_chassis_created"] == 0
+ job.logger.warning.assert_called()
+
+
+# ===========================================================================
+# 3. TestRefreshExistingDevice# 400-402, 420-421
+# ===========================================================================
+
+
+class TestRefreshExistingDevice:
+ """Tests for ``_refresh_existing_device``."""
+
+ # ------------------------------------------------------------------
+ # Lines 336-341: Device path β refreshed device with role
+ # ------------------------------------------------------------------
+
+ def test_device_path_refreshes_role(self):
+ """Non-VM existing device refreshed; role updated on result."""
+ from netbox_librenms_plugin.import_utils.bulk_import import _refresh_existing_device
+
+ existing = MagicMock()
+ existing.pk = 1
+ refreshed = MagicMock()
+ refreshed.role = MagicMock(name="switch")
+
+ validation = {
+ "existing_device": existing,
+ "import_as_vm": False,
+ "device_role": {},
+ }
+
+ with patch("dcim.models.Device") as mock_Device:
+ mock_Device.objects.filter.return_value.first.return_value = refreshed
+ _refresh_existing_device(validation)
+
+ assert validation["existing_device"] is refreshed
+ assert validation["device_role"]["found"] is True
+ assert validation["device_role"]["role"] is refreshed.role
+
+ # ------------------------------------------------------------------
+ # Lines 342-345: Device path β refreshed device without role
+ # ------------------------------------------------------------------
+
+ def test_device_path_refreshes_no_role(self):
+ """Refreshed device has no role β device_role = {'found': False}."""
+ from netbox_librenms_plugin.import_utils.bulk_import import _refresh_existing_device
+
+ existing = MagicMock()
+ existing.pk = 2
+ refreshed = MagicMock()
+ refreshed.role = None # role removed since caching
+
+ validation = {
+ "existing_device": existing,
+ "import_as_vm": False,
+ "device_role": {"found": True, "role": MagicMock()},
+ }
+
+ with patch("dcim.models.Device") as mock_Device:
+ mock_Device.objects.filter.return_value.first.return_value = refreshed
+ _refresh_existing_device(validation)
+
+ assert validation["existing_device"] is refreshed
+ assert validation["device_role"] == {"found": False, "role": None, "available_roles": []}
+
+ # ------------------------------------------------------------------
+ # Lines 346-365: Existing device was deleted (Device.objects returns None)
+ # ------------------------------------------------------------------
+
+ def test_deleted_device_clears_existing_and_recomputes_readiness(self):
+ """Device deleted β existing_device=None, readiness recomputed."""
+ from netbox_librenms_plugin.import_utils.bulk_import import _refresh_existing_device
+
+ existing = MagicMock()
+ existing.pk = 3
+ validation = {
+ "existing_device": existing,
+ "import_as_vm": False,
+ "issues": [],
+ "site": {"found": True},
+ "device_type": {"found": True},
+ "device_role": {"found": True},
+ }
+
+ with patch("dcim.models.Device") as mock_Device:
+ mock_Device.objects.filter.return_value.first.return_value = None # deleted
+ _refresh_existing_device(validation)
+
+ assert validation["existing_device"] is None
+ assert validation["existing_match_type"] is None
+ assert validation["device_role"] == {"found": False, "role": None, "available_roles": []}
+ assert validation["can_import"] is True # no issues
+ assert validation["is_ready"] is False # device_role.found is now missing
+
+ def test_deleted_vm_recomputes_readiness_from_cluster(self):
+ """VM deleted β is_ready reflects cluster.found."""
+ from netbox_librenms_plugin.import_utils.bulk_import import _refresh_existing_device
+
+ existing = MagicMock()
+ existing.pk = 4
+ validation = {
+ "existing_device": existing,
+ "import_as_vm": True,
+ "issues": [],
+ "cluster": {"found": True},
+ }
+
+ with patch("virtualization.models.VirtualMachine") as mock_VM:
+ mock_VM.objects.filter.return_value.first.return_value = None # deleted
+ _refresh_existing_device(validation)
+
+ assert validation["existing_device"] is None
+ assert validation["can_import"] is True
+ assert validation["is_ready"] is True # cluster.found=True
+
+ def test_deleted_vm_not_ready_when_no_cluster(self):
+ """Deleted VM with no cluster β is_ready=False."""
+ from netbox_librenms_plugin.import_utils.bulk_import import _refresh_existing_device
+
+ existing = MagicMock()
+ existing.pk = 5
+ validation = {
+ "existing_device": existing,
+ "import_as_vm": True,
+ "issues": ["some issue"],
+ "cluster": {"found": False},
+ }
+
+ with patch("virtualization.models.VirtualMachine") as mock_VM:
+ mock_VM.objects.filter.return_value.first.return_value = None
+ _refresh_existing_device(validation)
+
+ assert validation["can_import"] is False # has issues
+ assert validation["is_ready"] is False
+
+ # ------------------------------------------------------------------
+ # Lines 366-368: Exception caught β logger.error called
+ # ------------------------------------------------------------------
+
+ def test_exception_during_refresh_logs_error(self):
+ """DB error during refresh is caught and logged."""
+ from netbox_librenms_plugin.import_utils.bulk_import import _refresh_existing_device
+
+ existing = MagicMock()
+ existing.pk = 99
+ validation = {"existing_device": existing, "import_as_vm": False}
+
+ with (
+ patch("dcim.models.Device") as mock_Device,
+ patch("netbox_librenms_plugin.import_utils.bulk_import.logger") as mock_logger,
+ ):
+ mock_Device.objects.filter.side_effect = Exception("DB down")
+ _refresh_existing_device(validation) # must not raise
+
+ mock_logger.error.assert_called_once()
+ assert "99" in mock_logger.error.call_args[0][0]
+
+ # ------------------------------------------------------------------
+ # Line 373: no existing_device, no libre_device β early return
+ # ------------------------------------------------------------------
+
+ def test_no_existing_device_no_libre_device_returns_early(self):
+ """existing=None + libre_device=None β immediate return."""
+ from netbox_librenms_plugin.import_utils.bulk_import import _refresh_existing_device
+
+ validation = {"existing_device": None}
+ # No exception and validation unchanged
+ _refresh_existing_device(validation, libre_device=None)
+ assert validation == {"existing_device": None}
+
+ # ------------------------------------------------------------------
+ # Lines 393-395: existing=None, found via librenms_id
+ # ------------------------------------------------------------------
+
+ def test_no_existing_device_found_by_librenms_id(self):
+ """existing=None: device found by librenms_id custom field."""
+ from netbox_librenms_plugin.import_utils.bulk_import import _refresh_existing_device
+
+ new_device = MagicMock()
+ new_device.role = MagicMock(name="switch")
+ libre_device = {"device_id": 42, "hostname": "sw01", "sysName": "sw01"}
+
+ validation = {
+ "existing_device": None,
+ "import_as_vm": False,
+ "resolved_name": "sw01",
+ "device_role": {"found": False, "role": None},
+ "site": {"found": True, "site": MagicMock()},
+ "device_type": {"found": True, "device_type": MagicMock()},
+ "issues": [],
+ }
+
+ with (
+ patch("dcim.models.Device") as mock_Device,
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.find_by_librenms_id",
+ return_value=new_device,
+ ),
+ ):
+ mock_Device.objects.filter.return_value.first.return_value = None
+ _refresh_existing_device(validation, libre_device=libre_device, server_key="default")
+
+ assert validation["existing_device"] is new_device
+ assert validation["existing_match_type"] == "librenms_id"
+ # Late-found existing match must never be import-ready, even if recalculate
+ # would otherwise set can_import=True (no issues + all fields found).
+ assert validation["can_import"] is False
+ assert validation["is_ready"] is False
+ # Device has a role β device_role should be set
+ assert validation["device_role"]["found"] is True
+
+ # ------------------------------------------------------------------
+ # Lines 400-402: existing=None, found by resolved_name
+ # ------------------------------------------------------------------
+
+ def test_no_existing_device_found_by_resolved_name(self):
+ """existing=None: not found by librenms_id, but found by resolved_name."""
+ from netbox_librenms_plugin.import_utils.bulk_import import _refresh_existing_device
+
+ new_device = MagicMock()
+ new_device.role = None # no role
+ libre_device = {"device_id": 43, "hostname": "sw02", "sysName": "sw02"}
+
+ validation = {
+ "existing_device": None,
+ "import_as_vm": False,
+ "resolved_name": "sw02-resolved",
+ }
+
+ with (
+ patch("dcim.models.Device") as mock_Device,
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.find_by_librenms_id",
+ return_value=None,
+ ),
+ ):
+ # resolved_name match
+ mock_Device.objects.filter.return_value.first.return_value = new_device
+ _refresh_existing_device(validation, libre_device=libre_device, server_key="default")
+
+ assert validation["existing_device"] is new_device
+ assert validation["existing_match_type"] == "resolved_name"
+ assert validation["can_import"] is False
+
+ # ------------------------------------------------------------------
+ # Lines 420-421: exception in the "no existing device" lookup path
+ # ------------------------------------------------------------------
+
+ def test_exception_during_new_device_lookup_logs_error(self):
+ """Exception in the newly-imported-device check is caught and logged."""
+ from netbox_librenms_plugin.import_utils.bulk_import import _refresh_existing_device
+
+ libre_device = {"device_id": 44, "hostname": "sw03", "sysName": "sw03"}
+ validation = {"existing_device": None, "import_as_vm": False, "resolved_name": None}
+
+ with (
+ patch("dcim.models.Device"),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.find_by_librenms_id",
+ side_effect=Exception("lookup failed"),
+ ),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.logger") as mock_logger,
+ ):
+ _refresh_existing_device(validation, libre_device=libre_device, server_key="default")
+
+ mock_logger.error.assert_called()
+
+ def test_no_existing_device_non_numeric_librenms_id_skips_id_lookup(self):
+ """Non-numeric device_id raises ValueError β except pass, falls back to name."""
+ from netbox_librenms_plugin.import_utils.bulk_import import _refresh_existing_device
+
+ new_device = MagicMock()
+ new_device.role = None
+ # Non-numeric device_id triggers ValueError inside int() β except (ValueError, TypeError): pass
+ libre_device = {"device_id": "not-an-int", "hostname": "sw05", "sysName": "sw05"}
+
+ validation = {
+ "existing_device": None,
+ "import_as_vm": False,
+ "resolved_name": "sw05",
+ }
+
+ with (
+ patch("dcim.models.Device") as mock_Device,
+ patch("netbox_librenms_plugin.import_utils.bulk_import.find_by_librenms_id") as mock_find,
+ ):
+ mock_Device.objects.filter.return_value.first.return_value = new_device
+ _refresh_existing_device(validation, libre_device=libre_device, server_key="default")
+
+ # Should find via resolved_name (librenms_id lookup was skipped due to ValueError)
+ assert validation["existing_device"] is new_device
+ assert validation["existing_match_type"] == "resolved_name"
+ # Crucially: find_by_librenms_id must never have been called β int("not-an-int")
+ # raises ValueError before the call site is reached.
+ mock_find.assert_not_called()
+
+ def test_no_existing_device_hostname_fallback(self):
+ """existing=None, not found by id or resolved_name β hostname fallback."""
+ from netbox_librenms_plugin.import_utils.bulk_import import _refresh_existing_device
+
+ new_device = MagicMock()
+ new_device.role = None
+ libre_device = {"device_id": 45, "hostname": "sw04", "sysName": "sw04-sysname"}
+
+ validation = {
+ "existing_device": None,
+ "import_as_vm": False,
+ "resolved_name": None, # no resolved_name β fall through to hostname
+ }
+
+ # filter returns new_device only for the hostname kwargs; any other filter
+ # call (e.g. resolved_name or sysname) returns None β so the test fails if
+ # the wrong lookup path is exercised.
+ def filter_first(*args, **kwargs):
+ m = MagicMock()
+ m.first.return_value = new_device if kwargs.get("name__iexact") == "sw04" else None
+ return m
+
+ with (
+ patch("dcim.models.Device") as mock_Device,
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.find_by_librenms_id",
+ return_value=None,
+ ),
+ ):
+ mock_Device.objects.filter.side_effect = filter_first
+ _refresh_existing_device(validation, libre_device=libre_device, server_key="default")
+
+ assert validation["existing_device"] is new_device
+ assert validation["existing_match_type"] == "hostname"
+ # Verify the hostname-keyed filter call was actually made
+ mock_Device.objects.filter.assert_any_call(name__iexact="sw04")
+
+
+# ===========================================================================
+# 4. TestProcessDeviceFilters# 548-566, 596-598, 604-641, 665, 687-694
+# ===========================================================================
+
+
+class TestProcessDeviceFilters:
+ """Tests for ``process_device_filters``."""
+
+ # Minimal set of patches required for every call
+ _BASE_PATCHES = [
+ "netbox_librenms_plugin.import_utils.bulk_import.get_librenms_devices_for_import",
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ "netbox_librenms_plugin.import_utils.bulk_import.prefetch_vc_data_for_devices",
+ "netbox_librenms_plugin.import_utils.bulk_import.empty_virtual_chassis_data",
+ "netbox_librenms_plugin.import_utils.bulk_import.cache",
+ "netbox_librenms_plugin.import_utils.bulk_import.get_validated_device_cache_key",
+ "netbox_librenms_plugin.import_utils.bulk_import.get_import_device_cache_key",
+ "netbox_librenms_plugin.import_utils.bulk_import.get_cache_metadata_key",
+ ]
+
+ def _make_api(self, server_key="default", cache_timeout=300):
+ api = MagicMock()
+ api.server_key = server_key
+ api.cache_timeout = cache_timeout
+ return api
+
+ def _make_device(self, device_id=1, hostname="sw01"):
+ return {"device_id": device_id, "hostname": hostname, "disabled": 0}
+
+ # ------------------------------------------------------------------
+ # Lines 469, 489: job logger on fetch and device-count messages
+ # ------------------------------------------------------------------
+
+ def test_job_logs_fetch_and_count_messages(self):
+ """With job set, info logs for 'Fetching' and 'Found N devices' fire."""
+ job = _make_job()
+ device = self._make_device()
+ api = self._make_api()
+
+ with (
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_librenms_devices_for_import",
+ return_value=([device], False),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ return_value=_make_validation(),
+ ),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.empty_virtual_chassis_data", return_value={}),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.cache") as mock_cache,
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_validated_device_cache_key",
+ return_value="vkey",
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_import_device_cache_key",
+ return_value="ikey",
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_cache_metadata_key",
+ return_value="mkey",
+ ),
+ patch("django_rq.get_queue") as mock_get_queue,
+ patch("rq.job.Job") as mock_rq_cls,
+ ):
+ mock_cache.get.side_effect = lambda key, default=None: default # no cache hit
+ mock_get_queue.return_value = MagicMock()
+ mock_rq_cls.fetch.return_value = _make_rq_running()
+
+ from netbox_librenms_plugin.import_utils.bulk_import import process_device_filters
+
+ result = process_device_filters(
+ api,
+ filters={},
+ vc_detection_enabled=False,
+ clear_cache=True,
+ show_disabled=True,
+ job=job,
+ )
+
+ assert len(result) == 1
+ # Verify the two job-specific log calls were made
+ log_calls = [c.args[0] for c in job.logger.info.call_args_list]
+ assert any("Fetching" in s for s in log_calls)
+ assert any("Found" in s for s in log_calls)
+
+ # ------------------------------------------------------------------
+ # Lines 495-506: VC prefetch with job logging
+ # ------------------------------------------------------------------
+
+ def test_vc_prefetch_with_job_logs_prefetch_messages(self):
+ """With vc_detection_enabled+job, prefetch job-log messages fire."""
+ job = _make_job()
+ device = self._make_device()
+ api = self._make_api()
+
+ with (
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_librenms_devices_for_import",
+ return_value=([device], False),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ return_value=_make_validation(),
+ ),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.prefetch_vc_data_for_devices") as mock_prefetch,
+ patch("netbox_librenms_plugin.import_utils.bulk_import.empty_virtual_chassis_data", return_value={}),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.cache") as mock_cache,
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_validated_device_cache_key",
+ return_value="vkey",
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_import_device_cache_key",
+ return_value="ikey",
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_cache_metadata_key",
+ return_value="mkey",
+ ),
+ patch("django_rq.get_queue") as mock_get_queue,
+ patch("rq.job.Job") as mock_rq_cls,
+ ):
+ mock_cache.get.side_effect = lambda key, default=None: default
+ mock_get_queue.return_value = MagicMock()
+ mock_rq_cls.fetch.return_value = _make_rq_running()
+
+ from netbox_librenms_plugin.import_utils.bulk_import import process_device_filters
+
+ process_device_filters(
+ api,
+ filters={},
+ vc_detection_enabled=True,
+ clear_cache=True,
+ show_disabled=True,
+ job=job,
+ )
+
+ mock_prefetch.assert_called_once()
+ log_calls = [c.args[0] for c in job.logger.info.call_args_list]
+ assert any("Pre-fetch" in s or "pre-fetch" in s or "virtual chassis" in s.lower() for s in log_calls)
+
+ # ------------------------------------------------------------------
+ # Lines 507-511: BrokenPipeError during VC prefetch + request set
+ # ------------------------------------------------------------------
+
+ def test_vc_prefetch_client_disconnect_with_request_returns_empty(self):
+ """BrokenPipeError during prefetch + request set β _empty_return."""
+ api = self._make_api()
+ request = MagicMock()
+ device = self._make_device()
+
+ with (
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_librenms_devices_for_import",
+ return_value=([device], False),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.prefetch_vc_data_for_devices",
+ side_effect=BrokenPipeError("client gone"),
+ ),
+ ):
+ from netbox_librenms_plugin.import_utils.bulk_import import process_device_filters
+
+ result = process_device_filters(
+ api,
+ filters={},
+ vc_detection_enabled=True,
+ clear_cache=False,
+ show_disabled=True,
+ request=request,
+ )
+
+ assert result == []
+
+ def test_vc_prefetch_client_disconnect_with_return_cache_status(self):
+ """BrokenPipeError + request + return_cache_status=True β ([], False)."""
+ api = self._make_api()
+ request = MagicMock()
+ device = self._make_device()
+
+ with (
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_librenms_devices_for_import",
+ return_value=([device], False),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.prefetch_vc_data_for_devices",
+ side_effect=BrokenPipeError("client gone"),
+ ),
+ ):
+ from netbox_librenms_plugin.import_utils.bulk_import import process_device_filters
+
+ result = process_device_filters(
+ api,
+ filters={},
+ vc_detection_enabled=True,
+ clear_cache=False,
+ show_disabled=True,
+ request=request,
+ return_cache_status=True,
+ )
+
+ assert result == ([], False)
+
+ def test_vc_prefetch_client_disconnect_no_request_reraises(self):
+ """BrokenPipeError during prefetch with request=None β exception re-raised."""
+
+ api = self._make_api()
+ device = self._make_device()
+
+ with (
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_librenms_devices_for_import",
+ return_value=([device], False),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.prefetch_vc_data_for_devices",
+ side_effect=BrokenPipeError("client gone"),
+ ),
+ ):
+ from netbox_librenms_plugin.import_utils.bulk_import import process_device_filters
+
+ with pytest.raises(BrokenPipeError):
+ process_device_filters(
+ api,
+ filters={},
+ vc_detection_enabled=True,
+ clear_cache=False,
+ show_disabled=True,
+ request=None,
+ )
+
+ # ------------------------------------------------------------------
+ # Lines 520-531: Job pre-loop RQ check β job was already stopped
+ # ------------------------------------------------------------------
+
+ def test_job_rq_stopped_before_validation_loop_returns_empty(self):
+ """RQ job stopped before loop β empty result returned."""
+ job = _make_job()
+ api = self._make_api()
+ device = self._make_device()
+
+ with (
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_librenms_devices_for_import",
+ return_value=([device], False),
+ ),
+ patch("django_rq.get_queue") as mock_get_queue,
+ patch("rq.job.Job") as mock_rq_cls,
+ ):
+ mock_get_queue.return_value = MagicMock()
+ mock_rq_cls.fetch.return_value = _make_rq_stopped()
+
+ from netbox_librenms_plugin.import_utils.bulk_import import process_device_filters
+
+ result = process_device_filters(
+ api,
+ filters={},
+ vc_detection_enabled=False,
+ clear_cache=True,
+ show_disabled=True,
+ job=job,
+ )
+
+ assert result == []
+ job.logger.warning.assert_called()
+
+ def test_job_rq_stopped_before_loop_with_cache_status(self):
+ """RQ job stopped + return_cache_status=True β ([], False)."""
+ job = _make_job()
+ api = self._make_api()
+ device = self._make_device()
+
+ with (
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_librenms_devices_for_import",
+ return_value=([device], False),
+ ),
+ patch("django_rq.get_queue") as mock_get_queue,
+ patch("rq.job.Job") as mock_rq_cls,
+ ):
+ mock_get_queue.return_value = MagicMock()
+ mock_rq_cls.fetch.return_value = _make_rq_stopped()
+
+ from netbox_librenms_plugin.import_utils.bulk_import import process_device_filters
+
+ result = process_device_filters(
+ api,
+ filters={},
+ vc_detection_enabled=False,
+ clear_cache=True,
+ show_disabled=True,
+ job=job,
+ return_cache_status=True,
+ )
+
+ assert result == ([], False)
+
+ # ------------------------------------------------------------------
+ # Lines 532-537: Job pre-loop RQ raises β DB fallback β stopped
+ # ------------------------------------------------------------------
+
+ def test_job_cancelled_before_validation_loop_returns_empty(self):
+ """Job cancelled at pre-loop check β returns empty list."""
+ job = _make_job()
+ api = self._make_api()
+ device = self._make_device()
+
+ with (
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_librenms_devices_for_import",
+ return_value=([device], False),
+ ),
+ patch("netbox_librenms_plugin.import_utils.bulk_import._is_job_cancelled", return_value=True),
+ ):
+ from netbox_librenms_plugin.import_utils.bulk_import import process_device_filters
+
+ result = process_device_filters(
+ api,
+ filters={},
+ vc_detection_enabled=False,
+ clear_cache=True,
+ show_disabled=True,
+ job=job,
+ )
+
+ assert result == []
+
+ def test_rq_unavailable_job_not_cancelled_in_preloop(self):
+ """RQ unavailable before loop β _is_job_cancelled returns False β processing continues."""
+ job = _make_job()
+ api = self._make_api()
+ device = self._make_device()
+
+ with (
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_librenms_devices_for_import",
+ return_value=([device], False),
+ ),
+ patch("django_rq.get_queue", side_effect=Exception("RQ down")),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ return_value=_make_validation(),
+ ),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.empty_virtual_chassis_data", return_value={}),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.cache") as mock_cache,
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_validated_device_cache_key",
+ return_value="vkey",
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_import_device_cache_key",
+ return_value="ikey",
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_cache_metadata_key",
+ return_value="mkey",
+ ),
+ ):
+ mock_cache.get.side_effect = lambda key, default=None: default
+ from netbox_librenms_plugin.import_utils.bulk_import import process_device_filters
+
+ result = process_device_filters(
+ api,
+ filters={},
+ vc_detection_enabled=False,
+ clear_cache=True,
+ show_disabled=True,
+ job=job,
+ )
+
+ assert len(result) == 1
+
+ # ------------------------------------------------------------------
+ # Lines 548-560: Per-device loop RQ stop detected
+ # ------------------------------------------------------------------
+
+ def test_job_validation_loop_rq_stop_returns_empty(self):
+ """RQ stop detected during loop at idx=1 β return empty."""
+ job = _make_job()
+ api = self._make_api()
+ device = self._make_device()
+
+ with (
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_librenms_devices_for_import",
+ return_value=([device], False),
+ ),
+ patch("django_rq.get_queue") as mock_get_queue,
+ patch("rq.job.Job") as mock_rq_cls,
+ ):
+ mock_get_queue.return_value = MagicMock()
+ # _is_job_cancelled is called 4 times before the in-loop check:
+ # pre-fetch, pre-VC, pre-validation-loop, then once per device.
+ mock_rq_cls.fetch.side_effect = [
+ _make_rq_running(),
+ _make_rq_running(),
+ _make_rq_running(),
+ _make_rq_stopped(),
+ ]
+
+ from netbox_librenms_plugin.import_utils.bulk_import import process_device_filters
+
+ result = process_device_filters(
+ api,
+ filters={},
+ vc_detection_enabled=False,
+ clear_cache=True,
+ show_disabled=True,
+ job=job,
+ )
+
+ assert result == []
+
+ # ------------------------------------------------------------------
+ # Lines 561-566: Per-device loop DB fallback stop
+ # ------------------------------------------------------------------
+
+ def test_job_cancelled_in_validation_loop_returns_empty(self):
+ """Job cancellation detected during loop β returns empty list."""
+ job = _make_job()
+ api = self._make_api()
+ device = self._make_device()
+
+ with (
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_librenms_devices_for_import",
+ return_value=([device], False),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import._is_job_cancelled",
+ side_effect=[False, False, False, True], # 3 pre-loop checks pass, in-loop check cancels
+ ),
+ ):
+ from netbox_librenms_plugin.import_utils.bulk_import import process_device_filters
+
+ result = process_device_filters(
+ api,
+ filters={},
+ vc_detection_enabled=False,
+ clear_cache=True,
+ show_disabled=True,
+ job=job,
+ )
+
+ assert result == []
+
+ # ------------------------------------------------------------------
+ # Lines 584-601: Cache-hit path (clear_cache=False + cache miss=None)
+ # NOTE: cache hit with exclude_existing=False is in existing tests.
+ # ------------------------------------------------------------------
+
+ def test_cache_hit_uses_cached_validation(self):
+ """Cache hit β device validation taken from cache."""
+ api = self._make_api()
+ device = self._make_device()
+
+ existing = MagicMock()
+ cached_validation = _make_validation()
+ cached_validation["existing_device"] = existing # truthy β refresh skips new-device lookup
+ cached_entry = dict(device)
+ cached_entry["_validation"] = cached_validation
+
+ with (
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_librenms_devices_for_import",
+ return_value=([device], True),
+ ),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.cache") as mock_cache,
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_validated_device_cache_key",
+ return_value="vkey",
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_cache_metadata_key",
+ return_value="mkey",
+ ),
+ patch("netbox_librenms_plugin.import_utils.bulk_import._refresh_existing_device"),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import") as mock_validate,
+ ):
+ # First get β device cache hit; second get β metadata (truthy)
+ mock_cache.get.side_effect = [cached_entry, MagicMock()]
+
+ from netbox_librenms_plugin.import_utils.bulk_import import process_device_filters
+
+ result = process_device_filters(
+ api,
+ filters={},
+ vc_detection_enabled=False,
+ clear_cache=False,
+ show_disabled=True,
+ )
+
+ # validate_device_for_import must NOT be called (cache hit)
+ mock_validate.assert_not_called()
+ assert len(result) == 1
+
+ # ------------------------------------------------------------------
+ # Lines 596-598: Cache-hit + exclude_existing β device skipped
+ # ------------------------------------------------------------------
+
+ def test_cache_hit_with_exclude_existing_skips_device(self):
+ """Cache hit + exclude_existing + existing_device β device skipped."""
+ api = self._make_api()
+ device = self._make_device()
+
+ existing = MagicMock()
+ existing.pk = 1
+ cached_validation = _make_validation(existing_device=existing)
+ # Ensure _refresh_existing_device returns quickly without a real DB call
+ cached_validation["existing_device"] = existing
+ cached_entry = dict(device)
+ cached_entry["_validation"] = cached_validation
+
+ with (
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_librenms_devices_for_import",
+ return_value=([device], True),
+ ),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.cache") as mock_cache,
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_validated_device_cache_key",
+ return_value="vkey",
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_cache_metadata_key",
+ return_value="mkey",
+ ),
+ # Patch _refresh_existing_device to be a no-op so we can control existing_device
+ patch("netbox_librenms_plugin.import_utils.bulk_import._refresh_existing_device"),
+ ):
+ mock_cache.get.return_value = cached_entry
+
+ from netbox_librenms_plugin.import_utils.bulk_import import process_device_filters
+
+ result = process_device_filters(
+ api,
+ filters={},
+ vc_detection_enabled=False,
+ clear_cache=False,
+ show_disabled=True,
+ exclude_existing=True,
+ )
+
+ # Device should be excluded because existing_device is set
+ assert result == []
+
+ # ------------------------------------------------------------------
+ # Lines 604-641: Validate-and-cache path (clear_cache=True)
+ # ------------------------------------------------------------------
+
+ def test_validate_and_cache_path_no_vc_detection(self):
+ """clear_cache=True β validate + set empty VC data + cache stored."""
+ api = self._make_api()
+ device = self._make_device()
+
+ with (
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_librenms_devices_for_import",
+ return_value=([device], False),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ return_value=_make_validation(),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.empty_virtual_chassis_data",
+ return_value={"is_stack": False},
+ ) as mock_empty_vc,
+ patch("netbox_librenms_plugin.import_utils.bulk_import.cache") as mock_cache,
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_validated_device_cache_key",
+ return_value="vkey",
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_import_device_cache_key",
+ return_value="ikey",
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_cache_metadata_key",
+ return_value="mkey",
+ ),
+ ):
+ mock_cache.get.side_effect = lambda key, default=None: default # no cache hit
+
+ from netbox_librenms_plugin.import_utils.bulk_import import process_device_filters
+
+ result = process_device_filters(
+ api,
+ filters={},
+ vc_detection_enabled=False,
+ clear_cache=True,
+ show_disabled=True,
+ )
+
+ assert len(result) == 1
+ # empty_virtual_chassis_data should have been called for vc=False
+ mock_empty_vc.assert_called()
+ # cache.set called for the validated device and simple key
+ assert mock_cache.set.call_count >= 2
+
+ def test_validate_path_exclude_existing_skips_device(self):
+ """validate path + exclude_existing + existing_device β device skipped."""
+ api = self._make_api()
+ device = self._make_device()
+
+ validation_with_existing = _make_validation(existing_device=MagicMock())
+
+ with (
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_librenms_devices_for_import",
+ return_value=([device], False),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ return_value=validation_with_existing,
+ ),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.empty_virtual_chassis_data", return_value={}),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.cache") as mock_cache,
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_validated_device_cache_key",
+ return_value="vkey",
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_cache_metadata_key",
+ return_value="mkey",
+ ),
+ ):
+ mock_cache.get.return_value = None
+
+ from netbox_librenms_plugin.import_utils.bulk_import import process_device_filters
+
+ result = process_device_filters(
+ api,
+ filters={},
+ vc_detection_enabled=False,
+ clear_cache=True,
+ show_disabled=True,
+ exclude_existing=True,
+ )
+
+ assert result == []
+
+ def test_validate_path_client_disconnect_with_request_returns_empty(self):
+ """validate raises BrokenPipeError + request set β _empty_return."""
+ api = self._make_api()
+ request = MagicMock()
+ device = self._make_device()
+
+ with (
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_librenms_devices_for_import",
+ return_value=([device], False),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ side_effect=BrokenPipeError("client gone"),
+ ),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.cache") as mock_cache,
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_validated_device_cache_key",
+ return_value="vkey",
+ ),
+ ):
+ mock_cache.get.return_value = None
+
+ from netbox_librenms_plugin.import_utils.bulk_import import process_device_filters
+
+ result = process_device_filters(
+ api,
+ filters={},
+ vc_detection_enabled=False,
+ clear_cache=True,
+ show_disabled=True,
+ request=request,
+ )
+
+ assert result == []
+
+ def test_validate_path_client_disconnect_no_request_reraises(self):
+ """validate raises BrokenPipeError, request=None β re-raised."""
+
+ api = self._make_api()
+ device = self._make_device()
+
+ with (
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_librenms_devices_for_import",
+ return_value=([device], False),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ side_effect=BrokenPipeError("client gone"),
+ ),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.cache") as mock_cache,
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_validated_device_cache_key",
+ return_value="vkey",
+ ),
+ ):
+ mock_cache.get.return_value = None
+
+ from netbox_librenms_plugin.import_utils.bulk_import import process_device_filters
+
+ with pytest.raises(BrokenPipeError):
+ process_device_filters(
+ api,
+ filters={},
+ vc_detection_enabled=False,
+ clear_cache=True,
+ show_disabled=True,
+ request=None,
+ )
+
+ # ------------------------------------------------------------------
+ # Line 665: pass β metadata already exists and should_update=False
+ # ------------------------------------------------------------------
+
+ def test_cache_metadata_not_updated_when_from_cache_and_existing(self):
+ """from_cache=True + existing metadata β metadata preserved (pass branch)."""
+ api = self._make_api()
+ device = self._make_device()
+
+ with (
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_librenms_devices_for_import",
+ return_value=([device], True), # from_cache=True
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ return_value=_make_validation(),
+ ),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.empty_virtual_chassis_data", return_value={}),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.cache") as mock_cache,
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_validated_device_cache_key",
+ return_value="vkey",
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_import_device_cache_key",
+ return_value="ikey",
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_cache_metadata_key",
+ return_value="mkey",
+ ),
+ ):
+ existing_metadata = {"cached_at": "2024-01-01T00:00:00+00:00", "cache_timeout": 300}
+ # First cache.get β None (no device cache hit β forces validation)
+ # Second cache.get β existing metadata (truthy)
+ mock_cache.get.side_effect = [None, existing_metadata]
+
+ from netbox_librenms_plugin.import_utils.bulk_import import process_device_filters
+
+ result = process_device_filters(
+ api,
+ filters={},
+ vc_detection_enabled=False,
+ clear_cache=False, # not clearing cache
+ show_disabled=True,
+ )
+
+ assert len(result) == 1
+ # cache.set for metadata should NOT have been called (existing preserved)
+ set_calls = [c for c in mock_cache.set.call_args_list if c.args[0] == "mkey"]
+ assert len(set_calls) == 0
+
+ # ------------------------------------------------------------------
+ # Lines 604-641: Cache metadata stored when clear_cache=False + from_cache=False
+ # ------------------------------------------------------------------
+
+ def test_cache_metadata_stored_when_fresh_data(self):
+ """Fresh data (from_cache=False) β metadata and index stored."""
+ api = self._make_api()
+ device = self._make_device()
+
+ with (
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_librenms_devices_for_import",
+ return_value=([device], False), # from_cache=False
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ return_value=_make_validation(),
+ ),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.empty_virtual_chassis_data", return_value={}),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.cache") as mock_cache,
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_validated_device_cache_key",
+ return_value="vkey",
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_import_device_cache_key",
+ return_value="ikey",
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_cache_metadata_key",
+ return_value="mkey",
+ ),
+ ):
+ mock_cache.get.side_effect = lambda key, default=None: default # no cache hit anywhere
+
+ from netbox_librenms_plugin.import_utils.bulk_import import process_device_filters
+
+ result = process_device_filters(
+ api,
+ filters={},
+ vc_detection_enabled=False,
+ clear_cache=True,
+ show_disabled=True,
+ )
+
+ assert len(result) == 1
+ # cache.set must have been called at least for metadata
+ assert mock_cache.set.call_count >= 1
+
+ # ------------------------------------------------------------------
+ # Lines 687-694: Final job logging
+ # ------------------------------------------------------------------
+
+ def test_job_final_log_without_exclude_existing(self):
+ """With job + validated devices (no exclude_existing) β final log."""
+ job = _make_job()
+ api = self._make_api()
+ device = self._make_device()
+
+ with (
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_librenms_devices_for_import",
+ return_value=([device], False),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ return_value=_make_validation(),
+ ),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.empty_virtual_chassis_data", return_value={}),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.cache") as mock_cache,
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_validated_device_cache_key",
+ return_value="vkey",
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_import_device_cache_key",
+ return_value="ikey",
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_cache_metadata_key",
+ return_value="mkey",
+ ),
+ patch("django_rq.get_queue") as mock_get_queue,
+ patch("rq.job.Job") as mock_rq_cls,
+ ):
+ mock_cache.get.side_effect = lambda key, default=None: default
+ mock_get_queue.return_value = MagicMock()
+ mock_rq_cls.fetch.return_value = _make_rq_running()
+
+ from netbox_librenms_plugin.import_utils.bulk_import import process_device_filters
+
+ result = process_device_filters(
+ api,
+ filters={},
+ vc_detection_enabled=False,
+ clear_cache=True,
+ show_disabled=True,
+ exclude_existing=False,
+ job=job,
+ )
+
+ assert len(result) == 1
+ final_calls = [str(c) for c in job.logger.info.call_args_list]
+ assert any("Validation complete" in s for s in final_calls)
+
+ def test_job_final_log_with_exclude_existing(self):
+ """With job + exclude_existing + some devices filtered β extended final log."""
+ job = _make_job()
+ api = self._make_api()
+ device = self._make_device()
+
+ # Device will be excluded because it has an existing_device
+ validation_with_existing = _make_validation(existing_device=MagicMock())
+
+ with (
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_librenms_devices_for_import",
+ return_value=([device], False),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ return_value=validation_with_existing,
+ ),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.empty_virtual_chassis_data", return_value={}),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.cache") as mock_cache,
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_validated_device_cache_key",
+ return_value="vkey",
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_cache_metadata_key",
+ return_value="mkey",
+ ),
+ patch("django_rq.get_queue") as mock_get_queue,
+ patch("rq.job.Job") as mock_rq_cls,
+ ):
+ mock_cache.get.return_value = None
+ mock_get_queue.return_value = MagicMock()
+ mock_rq_cls.fetch.return_value = _make_rq_running()
+
+ from netbox_librenms_plugin.import_utils.bulk_import import process_device_filters
+
+ result = process_device_filters(
+ api,
+ filters={},
+ vc_detection_enabled=False,
+ clear_cache=True,
+ show_disabled=True,
+ exclude_existing=True,
+ job=job,
+ )
+
+ # Device excluded β empty result; job should log the "filtered out" message
+ assert result == []
+ final_calls = [str(c) for c in job.logger.info.call_args_list]
+ assert any("filtered out" in s for s in final_calls)
+
+ # ------------------------------------------------------------------
+ # Lines 698-699: return_cache_status=True β returns tuple
+ # ------------------------------------------------------------------
+
+ def test_return_cache_status_true_returns_tuple(self):
+ """return_cache_status=True β (devices, from_cache) tuple."""
+ api = self._make_api()
+ device = self._make_device()
+
+ with (
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_librenms_devices_for_import",
+ return_value=([device], True),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ return_value=_make_validation(),
+ ),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.empty_virtual_chassis_data", return_value={}),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.cache") as mock_cache,
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_validated_device_cache_key",
+ return_value="vkey",
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_import_device_cache_key",
+ return_value="ikey",
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_cache_metadata_key",
+ return_value="mkey",
+ ),
+ ):
+ mock_cache.get.side_effect = lambda key, default=None: default
+
+ from netbox_librenms_plugin.import_utils.bulk_import import process_device_filters
+
+ result = process_device_filters(
+ api,
+ filters={},
+ vc_detection_enabled=False,
+ clear_cache=True,
+ show_disabled=True,
+ return_cache_status=True,
+ )
+
+ assert isinstance(result, tuple)
+ devices, from_cache = result
+ assert len(devices) == 1
+ assert from_cache is True
+
+ def test_rq_fetch_exception_does_not_cancel_process_filters(self):
+ """RQ Job.fetch raises β _is_job_cancelled returns False β processing continues."""
+ job = _make_job()
+ api = self._make_api()
+ device = self._make_device()
+
+ with (
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_librenms_devices_for_import",
+ return_value=([device], False),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ return_value=_make_validation(),
+ ),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.empty_virtual_chassis_data", return_value={}),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.cache") as mock_cache,
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_validated_device_cache_key",
+ return_value="vkey",
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_import_device_cache_key",
+ return_value="ikey",
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_cache_metadata_key",
+ return_value="mkey",
+ ),
+ patch("django_rq.get_queue") as mock_get_queue,
+ ):
+ mock_cache.get.side_effect = lambda key, default=None: default
+ mock_get_queue.return_value = MagicMock()
+ with patch("rq.job.Job") as mock_rq_cls:
+ mock_rq_cls.fetch.side_effect = Exception("RQ unavailable")
+ from netbox_librenms_plugin.import_utils.bulk_import import process_device_filters
+
+ result = process_device_filters(
+ api,
+ filters={},
+ vc_detection_enabled=False,
+ clear_cache=True,
+ show_disabled=True,
+ job=job,
+ )
+
+ assert len(result) == 1
+
+
+# ===========================================================================
+# Issue #26 β device_role reset must NOT clear VMs
+# ===========================================================================
+
+
+class TestDeviceRoleResetGuard:
+ """#26: device_role should only be reset when the device was deleted and import_as_vm is False."""
+
+ def _call_refresh(self, validation, libre_device=None):
+ """Simulate a device that was found at cache time but has since been deleted."""
+ from netbox_librenms_plugin.import_utils.bulk_import import _refresh_existing_device
+
+ # Set a mock existing_device so the function takes the "deleted" path
+ existing = MagicMock()
+ existing.pk = 42
+ validation["existing_device"] = existing
+
+ with patch("dcim.models.Device") as mock_dev_cls:
+ with patch("virtualization.models.VirtualMachine") as mock_vm_cls:
+ mock_dev_cls.objects.filter.return_value.first.return_value = None # deleted
+ mock_vm_cls.objects.filter.return_value.first.return_value = None # deleted
+ _refresh_existing_device(validation, server_key="default")
+
+ def test_device_role_reset_for_plain_device(self):
+ """When import_as_vm=False and device deleted, device_role is reset to not-found but available_roles preserved."""
+ mock_role = MagicMock()
+ validation = _make_validation(import_as_vm=False)
+ validation["device_role"] = {"found": True, "role": mock_role}
+ self._call_refresh(validation)
+ assert validation["device_role"] == {"found": False, "role": None, "available_roles": []}
+
+ def test_device_role_preserved_for_vm(self):
+ """When import_as_vm=True and device deleted, device_role must NOT be cleared."""
+ mock_role = MagicMock()
+ validation = _make_validation(import_as_vm=True)
+ validation["device_role"] = {"found": True, "role": mock_role}
+ self._call_refresh(validation)
+ # device_role should remain untouched
+ assert validation["device_role"]["found"] is True
+ assert validation["device_role"]["role"] is mock_role
+
+
+# ===========================================================================
+# Issue #28 β cache index TTL always refreshed
+# ===========================================================================
+
+
+class TestCacheIndexTTLRefresh:
+ """#28: cache index must be re-written even when the key is already present."""
+
+ def _make_api(self, server_key="default", cache_timeout=300):
+ api = MagicMock()
+ api.server_key = server_key
+ api.cache_timeout = cache_timeout
+ return api
+
+ def _run_process_with_cache(self, cache_index_before, api=None):
+ """Run process_device_filters with a pre-seeded cache index and return the mock_cache."""
+ if api is None:
+ api = self._make_api()
+ device = {"device_id": 1, "hostname": "sw01", "sysName": "sw01"}
+ validation = _make_validation()
+
+ with (
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_librenms_devices_for_import",
+ return_value=([device], False),
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.validate_device_for_import",
+ return_value=validation,
+ ),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.empty_virtual_chassis_data", return_value={}),
+ patch("netbox_librenms_plugin.import_utils.bulk_import.cache") as mock_cache,
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_validated_device_cache_key",
+ return_value="vkey",
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_import_device_cache_key",
+ return_value="ikey",
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.bulk_import.get_cache_metadata_key",
+ return_value="mkey",
+ ),
+ ):
+ mock_cache.get.side_effect = lambda key, default=None: (
+ cache_index_before if "cache_index" in key else default
+ )
+ from netbox_librenms_plugin.import_utils.bulk_import import process_device_filters
+
+ process_device_filters(api, filters={}, vc_detection_enabled=False, clear_cache=False, show_disabled=False)
+ return mock_cache
+
+ def test_cache_index_refreshed_when_key_already_present(self):
+ """cache.set is called for the index even when the metadata key is already present."""
+ existing_key = "mkey"
+ mock_cache = self._run_process_with_cache(cache_index_before=[existing_key])
+ # Find the cache.set call that updates the index
+ index_set_calls = [c for c in mock_cache.set.call_args_list if "cache_index" in (c.args[0] if c.args else "")]
+ assert len(index_set_calls) >= 1, "cache.set for cache_index was never called"
+ # The stored index must still contain the key (not duplicated)
+ stored_index = index_set_calls[0].args[1]
+ assert stored_index.count(existing_key) == 1
+
+ def test_cache_index_refreshed_for_new_key(self):
+ """cache.set is called when the key is new."""
+ mock_cache = self._run_process_with_cache(cache_index_before=[])
+ index_set_calls = [c for c in mock_cache.set.call_args_list if "cache_index" in (c.args[0] if c.args else "")]
+ assert len(index_set_calls) >= 1
+
+
+# ===========================================================================
+# Issue #36 β cross-model conflict detection in stale cache refresh
+# ===========================================================================
+
+
+class TestCrossModelConflictDetection:
+ """#36: stale-cache refresh must detect device imported as VM (or vice versa)."""
+
+ def test_vm_found_when_device_imported_as_vm(self):
+ """
+ import_as_vm=False (cached as device) but the object was actually imported as VM.
+ The refresh should detect the VM and mark the import as conflicting.
+ """
+ from netbox_librenms_plugin.import_utils.bulk_import import _refresh_existing_device
+
+ validation = _make_validation(import_as_vm=False)
+ # existing_device=None means "check if imported since caching" branch
+ validation["existing_device"] = None
+ libre_device = {"device_id": 99, "hostname": "sw-cross", "sysName": "sw-cross"}
+
+ mock_vm = MagicMock()
+ mock_vm.role = None
+
+ with (
+ patch("netbox_librenms_plugin.import_utils.bulk_import.find_by_librenms_id", return_value=None),
+ patch("dcim.models.Device") as mock_dev_cls,
+ patch("virtualization.models.VirtualMachine") as mock_vm_cls,
+ ):
+ # Primary model (Device) finds nothing; cross model (VirtualMachine) finds it
+ mock_dev_cls.objects.filter.return_value.first.return_value = None
+ mock_vm_cls.objects.filter.return_value.first.return_value = mock_vm
+
+ _refresh_existing_device(validation, libre_device, server_key="default")
+
+ assert validation["existing_device"] is mock_vm
+ # import_as_vm must be flipped to True so future refreshes query VirtualMachine
+ assert validation["import_as_vm"] is True
+ # A late-found cross-model match must never be import-ready:
+ # _refresh_existing_device re-asserts can_import=False/is_ready=False after
+ # recalculate_validation_status regardless of issues/fields state.
+ assert validation["can_import"] is False
+ assert validation["is_ready"] is False
+
+ def test_device_found_when_vm_imported_as_device(self):
+ """
+ import_as_vm=True but the object was imported as a Device.
+ The refresh should detect the Device through cross-model lookup.
+ """
+ from netbox_librenms_plugin.import_utils.bulk_import import _refresh_existing_device
+
+ validation = _make_validation(import_as_vm=True)
+ validation["existing_device"] = None
+ libre_device = {"device_id": 77, "hostname": "vm-but-device", "sysName": "vm-but-device"}
+
+ mock_device = MagicMock()
+ mock_device.role = MagicMock()
+
+ with (
+ patch("netbox_librenms_plugin.import_utils.bulk_import.find_by_librenms_id", return_value=None),
+ patch("dcim.models.Device") as mock_dev_cls,
+ patch("virtualization.models.VirtualMachine") as mock_vm_cls,
+ ):
+ # Primary model (VirtualMachine) finds nothing; cross model (Device) finds it
+ mock_vm_cls.objects.filter.return_value.first.return_value = None
+ mock_dev_cls.objects.filter.return_value.first.return_value = mock_device
+
+ _refresh_existing_device(validation, libre_device, server_key="default")
+
+ assert validation["existing_device"] is mock_device
+ # import_as_vm must be flipped to False so future refreshes query Device
+ assert validation["import_as_vm"] is False
+ # A late-found cross-model match must never be import-ready:
+ # _refresh_existing_device re-asserts can_import=False/is_ready=False after
+ # recalculate_validation_status regardless of issues/fields state.
+ assert validation["can_import"] is False
+ assert validation["is_ready"] is False
diff --git a/netbox_librenms_plugin/tests/test_coverage_device_fields.py b/netbox_librenms_plugin/tests/test_coverage_device_fields.py
index 137c70e85e..9e6247faaa 100644
--- a/netbox_librenms_plugin/tests/test_coverage_device_fields.py
+++ b/netbox_librenms_plugin/tests/test_coverage_device_fields.py
@@ -50,6 +50,7 @@ def test_no_librenms_id_returns_error(self):
view._librenms_api.get_librenms_id.return_value = None
mock_device = MagicMock()
+ mock_device.virtual_chassis = None
with (
patch("netbox_librenms_plugin.views.sync.device_fields.get_object_or_404", return_value=mock_device),
patch("netbox_librenms_plugin.views.sync.device_fields.messages") as mock_msg,
@@ -66,6 +67,7 @@ def test_get_device_info_failure(self):
view._librenms_api.get_device_info.return_value = (False, None)
mock_device = MagicMock()
+ mock_device.virtual_chassis = None
with (
patch("netbox_librenms_plugin.views.sync.device_fields.get_object_or_404", return_value=mock_device),
patch("netbox_librenms_plugin.views.sync.device_fields.messages") as mock_msg,
@@ -82,6 +84,7 @@ def test_get_device_info_empty_dict(self):
view._librenms_api.get_device_info.return_value = (True, {})
mock_device = MagicMock()
+ mock_device.virtual_chassis = None
with (
patch("netbox_librenms_plugin.views.sync.device_fields.get_object_or_404", return_value=mock_device),
patch("netbox_librenms_plugin.views.sync.device_fields.messages") as mock_msg,
@@ -95,11 +98,15 @@ def test_get_device_info_empty_dict(self):
def test_no_sysname_returns_warning(self):
view = self._view()
view._librenms_api.get_librenms_id.return_value = 42
- view._librenms_api.get_device_info.return_value = (True, {"sysName": None})
+ view._librenms_api.get_device_info.return_value = (True, {"sysName": None, "hostname": None})
mock_device = MagicMock()
+ mock_device.virtual_chassis = None
with (
patch("netbox_librenms_plugin.views.sync.device_fields.get_object_or_404", return_value=mock_device),
+ patch(
+ "netbox_librenms_plugin.views.sync.device_fields.resolve_naming_preferences", return_value=(True, False)
+ ),
patch("netbox_librenms_plugin.views.sync.device_fields.messages") as mock_msg,
patch("netbox_librenms_plugin.views.sync.device_fields.redirect"),
):
@@ -117,6 +124,14 @@ def test_save_success(self):
mock_device.virtual_chassis = None
with (
patch("netbox_librenms_plugin.views.sync.device_fields.get_object_or_404", return_value=mock_device),
+ patch(
+ "netbox_librenms_plugin.views.sync.device_fields.resolve_naming_preferences",
+ return_value=(True, False),
+ ),
+ patch(
+ "netbox_librenms_plugin.views.sync.device_fields._determine_device_name",
+ return_value="router1",
+ ),
patch("netbox_librenms_plugin.views.sync.device_fields.messages") as mock_msg,
patch("netbox_librenms_plugin.views.sync.device_fields.redirect") as mock_redir,
):
@@ -143,6 +158,14 @@ def test_save_validation_error_with_message_dict(self):
with (
patch("netbox_librenms_plugin.views.sync.device_fields.get_object_or_404", return_value=mock_device),
+ patch(
+ "netbox_librenms_plugin.views.sync.device_fields.resolve_naming_preferences",
+ return_value=(True, False),
+ ),
+ patch(
+ "netbox_librenms_plugin.views.sync.device_fields._determine_device_name",
+ return_value="router1",
+ ),
patch("netbox_librenms_plugin.views.sync.device_fields.messages") as mock_msg,
patch("netbox_librenms_plugin.views.sync.device_fields.redirect"),
):
@@ -166,6 +189,14 @@ def test_save_integrity_error_without_message_dict(self):
with (
patch("netbox_librenms_plugin.views.sync.device_fields.get_object_or_404", return_value=mock_device),
+ patch(
+ "netbox_librenms_plugin.views.sync.device_fields.resolve_naming_preferences",
+ return_value=(True, False),
+ ),
+ patch(
+ "netbox_librenms_plugin.views.sync.device_fields._determine_device_name",
+ return_value="router1",
+ ),
patch("netbox_librenms_plugin.views.sync.device_fields.messages") as mock_msg,
patch("netbox_librenms_plugin.views.sync.device_fields.redirect"),
):
@@ -393,6 +424,27 @@ def test_no_match_result(self):
view.post(_make_request(), pk=1)
mock_msg.error.assert_called_once()
+ def test_match_none_returns_ambiguous_error(self):
+ """match_librenms_hardware_to_device_type returns None β ambiguous-match error path."""
+ view = self._view()
+ view._librenms_api.get_librenms_id.return_value = 7
+ view._librenms_api.get_device_info.return_value = (True, {"hardware": "Cisco 3750"})
+ mock_device = MagicMock()
+ with (
+ patch("netbox_librenms_plugin.views.sync.device_fields.get_object_or_404", return_value=mock_device),
+ patch(
+ "netbox_librenms_plugin.views.sync.device_fields.match_librenms_hardware_to_device_type",
+ return_value=None,
+ ),
+ patch("netbox_librenms_plugin.views.sync.device_fields.messages") as mock_msg,
+ patch("netbox_librenms_plugin.views.sync.device_fields.redirect"),
+ ):
+ view.post(_make_request(), pk=1)
+ mock_msg.error.assert_called_once()
+ assert "Ambiguous" in mock_msg.error.call_args[0][1]
+ mock_device.full_clean.assert_not_called()
+ mock_device.save.assert_not_called()
+
def test_save_success(self):
view = self._view()
view._librenms_api.get_librenms_id.return_value = 7
@@ -517,13 +569,12 @@ def test_platform_does_not_exist(self):
view._librenms_api.get_librenms_id.return_value = 3
view._librenms_api.get_device_info.return_value = (True, {"os": "ios"})
- mock_platform_cls = MagicMock()
- mock_platform_cls.DoesNotExist = type("DoesNotExist", (Exception,), {})
- mock_platform_cls.objects.get.side_effect = mock_platform_cls.DoesNotExist()
-
with (
patch("netbox_librenms_plugin.views.sync.device_fields.get_object_or_404", return_value=MagicMock()),
- patch("netbox_librenms_plugin.views.sync.device_fields.Platform", mock_platform_cls),
+ patch(
+ "netbox_librenms_plugin.views.sync.device_fields.find_matching_platform",
+ return_value={"found": False, "platform": None, "match_type": None},
+ ),
patch("netbox_librenms_plugin.views.sync.device_fields.messages") as mock_msg,
patch("netbox_librenms_plugin.views.sync.device_fields.redirect"),
):
@@ -536,16 +587,16 @@ def test_save_success_with_old_platform(self):
view._librenms_api.get_device_info.return_value = (True, {"os": "ios"})
mock_platform = MagicMock()
- mock_platform_cls = MagicMock()
- mock_platform_cls.DoesNotExist = type("DoesNotExist", (Exception,), {})
- mock_platform_cls.objects.get.return_value = mock_platform
mock_device = MagicMock()
mock_device.platform = MagicMock() # old platform exists
with (
patch("netbox_librenms_plugin.views.sync.device_fields.get_object_or_404", return_value=mock_device),
- patch("netbox_librenms_plugin.views.sync.device_fields.Platform", mock_platform_cls),
+ patch(
+ "netbox_librenms_plugin.views.sync.device_fields.find_matching_platform",
+ return_value={"found": True, "platform": mock_platform, "match_type": "exact"},
+ ),
patch("netbox_librenms_plugin.views.sync.device_fields.messages") as mock_msg,
patch("netbox_librenms_plugin.views.sync.device_fields.redirect"),
):
@@ -562,16 +613,16 @@ def test_save_success_no_old_platform(self):
view._librenms_api.get_device_info.return_value = (True, {"os": "ios"})
mock_platform = MagicMock()
- mock_platform_cls = MagicMock()
- mock_platform_cls.DoesNotExist = type("DoesNotExist", (Exception,), {})
- mock_platform_cls.objects.get.return_value = mock_platform
mock_device = MagicMock()
mock_device.platform = None # no old platform
with (
patch("netbox_librenms_plugin.views.sync.device_fields.get_object_or_404", return_value=mock_device),
- patch("netbox_librenms_plugin.views.sync.device_fields.Platform", mock_platform_cls),
+ patch(
+ "netbox_librenms_plugin.views.sync.device_fields.find_matching_platform",
+ return_value={"found": True, "platform": mock_platform, "match_type": "exact"},
+ ),
patch("netbox_librenms_plugin.views.sync.device_fields.messages") as mock_msg,
patch("netbox_librenms_plugin.views.sync.device_fields.redirect"),
):
@@ -582,6 +633,49 @@ def test_save_success_no_old_platform(self):
mock_device.full_clean.assert_called_once()
mock_device.save.assert_called_once()
+ def test_save_success_via_platform_mapping(self):
+ """Sync button works when a PlatformMapping maps LibreNMS OS to a differently-named NetBox platform."""
+ view = self._view()
+ view._librenms_api.get_librenms_id.return_value = 3
+ view._librenms_api.get_device_info.return_value = (True, {"os": "junos"})
+
+ mock_platform = MagicMock()
+ mock_platform.__str__ = lambda self: "JunOS"
+
+ mock_device = MagicMock()
+ mock_device.platform = None
+
+ with (
+ patch("netbox_librenms_plugin.views.sync.device_fields.get_object_or_404", return_value=mock_device),
+ patch(
+ "netbox_librenms_plugin.views.sync.device_fields.find_matching_platform",
+ return_value={"found": True, "platform": mock_platform, "match_type": "mapping"},
+ ),
+ patch("netbox_librenms_plugin.views.sync.device_fields.messages") as mock_msg,
+ patch("netbox_librenms_plugin.views.sync.device_fields.redirect"),
+ ):
+ view.post(_make_request(), pk=1)
+ mock_msg.success.assert_called_once()
+ assert mock_device.platform is mock_platform
+
+ def test_ambiguous_platform_returns_error(self):
+ view = self._view()
+ view._librenms_api.get_librenms_id.return_value = 3
+ view._librenms_api.get_device_info.return_value = (True, {"os": "ios"})
+
+ with (
+ patch("netbox_librenms_plugin.views.sync.device_fields.get_object_or_404", return_value=MagicMock()),
+ patch(
+ "netbox_librenms_plugin.views.sync.device_fields.find_matching_platform",
+ return_value={"found": False, "platform": None, "match_type": "ambiguous"},
+ ),
+ patch("netbox_librenms_plugin.views.sync.device_fields.messages") as mock_msg,
+ patch("netbox_librenms_plugin.views.sync.device_fields.redirect"),
+ ):
+ view.post(_make_request(), pk=1)
+ mock_msg.error.assert_called_once()
+ assert "ambiguity" in mock_msg.error.call_args[0][1].lower()
+
def test_save_validation_error(self):
from django.core.exceptions import ValidationError
@@ -590,9 +684,6 @@ def test_save_validation_error(self):
view._librenms_api.get_device_info.return_value = (True, {"os": "ios"})
mock_platform = MagicMock()
- mock_platform_cls = MagicMock()
- mock_platform_cls.DoesNotExist = type("DoesNotExist", (Exception,), {})
- mock_platform_cls.objects.get.return_value = mock_platform
mock_device = MagicMock()
mock_device.platform = None
@@ -600,7 +691,10 @@ def test_save_validation_error(self):
with (
patch("netbox_librenms_plugin.views.sync.device_fields.get_object_or_404", return_value=mock_device),
- patch("netbox_librenms_plugin.views.sync.device_fields.Platform", mock_platform_cls),
+ patch(
+ "netbox_librenms_plugin.views.sync.device_fields.find_matching_platform",
+ return_value={"found": True, "platform": mock_platform, "match_type": "exact"},
+ ),
patch("netbox_librenms_plugin.views.sync.device_fields.messages") as mock_msg,
patch("netbox_librenms_plugin.views.sync.device_fields.redirect"),
):
@@ -717,6 +811,40 @@ def test_success_no_manufacturer(self):
assert mock_locked.platform == mock_platform_instance
mock_locked.save.assert_called_once()
+ def test_platform_constructor_includes_slug(self):
+ """Platform must be constructed with slug=slugify(name) β regression for #279."""
+ from django.utils.text import slugify
+
+ view = self._view()
+ platform_name = "Cisco IOS-XE 17.x"
+ req = _make_request({"platform_name": platform_name, "manufacturer": ""})
+
+ mock_platform_cls = MagicMock()
+ mock_platform_cls.objects.filter.return_value.exists.return_value = False
+ mock_platform_instance = MagicMock()
+ mock_platform_cls.return_value = mock_platform_instance
+
+ mock_device_cls = MagicMock()
+ mock_device_cls.DoesNotExist = type("DoesNotExist", (Exception,), {})
+ mock_locked = MagicMock()
+ mock_device_cls.objects.select_for_update.return_value.get.return_value = mock_locked
+
+ with (
+ patch("netbox_librenms_plugin.views.sync.device_fields.get_object_or_404", return_value=MagicMock()),
+ patch("netbox_librenms_plugin.views.sync.device_fields.Platform", mock_platform_cls),
+ patch("netbox_librenms_plugin.views.sync.device_fields.Device", mock_device_cls),
+ patch("netbox_librenms_plugin.views.sync.device_fields.transaction"),
+ patch("netbox_librenms_plugin.views.sync.device_fields.messages"),
+ patch("netbox_librenms_plugin.views.sync.device_fields.redirect"),
+ ):
+ view.post(req, pk=1)
+
+ mock_platform_cls.assert_called_once_with(
+ name=platform_name,
+ slug=slugify(platform_name),
+ manufacturer=None,
+ )
+
def test_platform_validation_error(self):
from django.core.exceptions import ValidationError
@@ -838,6 +966,153 @@ def test_integrity_error(self):
mock_msg.error.assert_called_once()
mock_txn.set_rollback.assert_called_once_with(True)
+ def _success_patches(self, platform_name="ios", librenms_os="ios", create_mapping="1"):
+ """Return (view, req, mock_platform_cls, mock_platform_instance, mock_device_cls, mock_locked)."""
+ view = self._view()
+ req = _make_request(
+ {
+ "platform_name": platform_name,
+ "manufacturer": "",
+ "librenms_os": librenms_os,
+ "create_mapping": create_mapping,
+ }
+ )
+ mock_platform_cls = MagicMock()
+ mock_platform_cls.objects.filter.return_value.exists.return_value = False
+ mock_platform_instance = MagicMock()
+ mock_platform_cls.return_value = mock_platform_instance
+ mock_device_cls = MagicMock()
+ mock_device_cls.DoesNotExist = type("DoesNotExist", (Exception,), {})
+ mock_locked = MagicMock()
+ mock_device_cls.objects.select_for_update.return_value.get.return_value = mock_locked
+ return view, req, mock_platform_cls, mock_platform_instance, mock_device_cls, mock_locked
+
+ def test_mapping_created_when_name_differs(self):
+ """A PlatformMapping is created when name differs from librenms_os and checkbox is on."""
+ view, req, mock_platform_cls, mock_platform_instance, mock_device_cls, _ = self._success_patches(
+ platform_name="Cisco IOS", librenms_os="ios", create_mapping="1"
+ )
+ mock_mapping_cls = MagicMock()
+ mock_mapping_instance = MagicMock()
+ mock_mapping_cls.return_value = mock_mapping_instance
+ mock_mapping_cls.objects.filter.return_value.first.return_value = None
+
+ with (
+ patch("netbox_librenms_plugin.views.sync.device_fields.get_object_or_404", return_value=MagicMock()),
+ patch("netbox_librenms_plugin.views.sync.device_fields.Platform", mock_platform_cls),
+ patch("netbox_librenms_plugin.views.sync.device_fields.Device", mock_device_cls),
+ patch("netbox_librenms_plugin.views.sync.device_fields.transaction"),
+ patch("netbox_librenms_plugin.views.sync.device_fields.messages") as mock_msg,
+ patch("netbox_librenms_plugin.views.sync.device_fields.redirect"),
+ patch("netbox_librenms_plugin.views.sync.device_fields.PlatformMapping", mock_mapping_cls),
+ ):
+ view.post(req, pk=1)
+
+ mock_mapping_cls.assert_called_once_with(librenms_os="ios", netbox_platform=mock_platform_instance)
+ mock_mapping_instance.full_clean.assert_called_once()
+ mock_mapping_instance.save.assert_called_once()
+ success_msg = mock_msg.success.call_args[0][1]
+ assert "platform mapping" in success_msg
+
+ def test_mapping_skipped_when_checkbox_off(self):
+ """No PlatformMapping is created when checkbox is unchecked."""
+ view, req, mock_platform_cls, mock_platform_instance, mock_device_cls, _ = self._success_patches(
+ platform_name="Cisco IOS", librenms_os="ios", create_mapping=""
+ )
+ mock_mapping_cls = MagicMock()
+
+ with (
+ patch("netbox_librenms_plugin.views.sync.device_fields.get_object_or_404", return_value=MagicMock()),
+ patch("netbox_librenms_plugin.views.sync.device_fields.Platform", mock_platform_cls),
+ patch("netbox_librenms_plugin.views.sync.device_fields.Device", mock_device_cls),
+ patch("netbox_librenms_plugin.views.sync.device_fields.transaction"),
+ patch("netbox_librenms_plugin.views.sync.device_fields.messages"),
+ patch("netbox_librenms_plugin.views.sync.device_fields.redirect"),
+ patch("netbox_librenms_plugin.views.sync.device_fields.PlatformMapping", mock_mapping_cls),
+ ):
+ view.post(req, pk=1)
+
+ mock_mapping_cls.assert_not_called()
+
+ def test_mapping_skipped_when_already_exists(self):
+ """No duplicate PlatformMapping is created when one already exists for the OS."""
+ view, req, mock_platform_cls, mock_platform_instance, mock_device_cls, _ = self._success_patches(
+ platform_name="Cisco IOS", librenms_os="ios", create_mapping="1"
+ )
+ mock_mapping_cls = MagicMock()
+ mock_mapping_cls.objects.filter.return_value.first.return_value = MagicMock() # existing mapping
+
+ with (
+ patch("netbox_librenms_plugin.views.sync.device_fields.get_object_or_404", return_value=MagicMock()),
+ patch("netbox_librenms_plugin.views.sync.device_fields.Platform", mock_platform_cls),
+ patch("netbox_librenms_plugin.views.sync.device_fields.Device", mock_device_cls),
+ patch("netbox_librenms_plugin.views.sync.device_fields.transaction"),
+ patch("netbox_librenms_plugin.views.sync.device_fields.messages"),
+ patch("netbox_librenms_plugin.views.sync.device_fields.redirect"),
+ patch("netbox_librenms_plugin.views.sync.device_fields.PlatformMapping", mock_mapping_cls),
+ ):
+ view.post(req, pk=1)
+
+ mock_mapping_cls.assert_not_called()
+
+ def test_required_object_permissions_include_platformmapping_when_create_mapping(self):
+ """When create_mapping is checked, ('add', PlatformMapping) is added to required_object_permissions
+ BEFORE require_all_permissions runs (so the authorization check sees it)."""
+ from netbox_librenms_plugin.models import PlatformMapping as RealPlatformMapping
+
+ view, req, mock_platform_cls, _, mock_device_cls, _ = self._success_patches(
+ platform_name="Cisco IOS", librenms_os="ios", create_mapping="1"
+ )
+
+ captured = {}
+
+ def fake_require(method):
+ captured["perms"] = view.required_object_permissions.get(method, [])
+ # Short-circuit by returning a sentinel response so post() exits early.
+ return MagicMock()
+
+ view.require_all_permissions = fake_require
+
+ with (
+ patch("netbox_librenms_plugin.views.sync.device_fields.get_object_or_404", return_value=MagicMock()),
+ patch("netbox_librenms_plugin.views.sync.device_fields.Platform", mock_platform_cls),
+ patch("netbox_librenms_plugin.views.sync.device_fields.Device", mock_device_cls),
+ patch("netbox_librenms_plugin.views.sync.device_fields.PlatformMapping", RealPlatformMapping),
+ ):
+ view.post(req, pk=1)
+
+ assert ("add", RealPlatformMapping) in captured["perms"], (
+ "Expected ('add', PlatformMapping) in required_object_permissions when create_mapping=True"
+ )
+
+ def test_required_object_permissions_exclude_platformmapping_when_no_create_mapping(self):
+ """When create_mapping is NOT checked, ('add', PlatformMapping) must NOT be added."""
+ from netbox_librenms_plugin.models import PlatformMapping as RealPlatformMapping
+
+ view, req, mock_platform_cls, _, mock_device_cls, _ = self._success_patches(
+ platform_name="Cisco IOS", librenms_os="ios", create_mapping=""
+ )
+
+ captured = {}
+
+ def fake_require(method):
+ captured["perms"] = view.required_object_permissions.get(method, [])
+ return MagicMock()
+
+ view.require_all_permissions = fake_require
+
+ with (
+ patch("netbox_librenms_plugin.views.sync.device_fields.get_object_or_404", return_value=MagicMock()),
+ patch("netbox_librenms_plugin.views.sync.device_fields.Platform", mock_platform_cls),
+ patch("netbox_librenms_plugin.views.sync.device_fields.Device", mock_device_cls),
+ patch("netbox_librenms_plugin.views.sync.device_fields.PlatformMapping", RealPlatformMapping),
+ ):
+ view.post(req, pk=1)
+
+ assert ("add", RealPlatformMapping) not in captured["perms"], (
+ "Did not expect ('add', PlatformMapping) when create_mapping is unchecked"
+ )
+
# ---------------------------------------------------------------------------
# AssignVCSerialView
diff --git a/netbox_librenms_plugin/tests/test_coverage_device_operations.py b/netbox_librenms_plugin/tests/test_coverage_device_operations.py
index 2c2848bdfb..50eebabff5 100644
--- a/netbox_librenms_plugin/tests/test_coverage_device_operations.py
+++ b/netbox_librenms_plugin/tests/test_coverage_device_operations.py
@@ -234,7 +234,7 @@ def _run_validate(self, libre_device, patches_overrides=None, **kwargs):
),
patch(
"netbox_librenms_plugin.import_utils.device_operations.get_virtual_chassis_data",
- return_value={"is_stack": False, "member_count": 0, "members": []},
+ return_value={"is_stack": False, "member_count": 0, "members": [], "detection_error": None},
),
patch("netbox_librenms_plugin.import_utils.device_operations.DeviceRole", mock_role),
patch("netbox_librenms_plugin.import_utils.device_operations.Cluster", mock_cluster),
@@ -533,7 +533,7 @@ def _patch_all_db(self):
),
patch(
"netbox_librenms_plugin.import_utils.device_operations.get_virtual_chassis_data",
- return_value={"is_stack": False, "member_count": 0, "members": []},
+ return_value={"is_stack": False, "member_count": 0, "members": [], "detection_error": None},
),
patch("netbox_librenms_plugin.import_utils.device_operations.DeviceRole", mock_device_role),
patch("netbox_librenms_plugin.import_utils.device_operations.Cluster", mock_cluster),
@@ -590,16 +590,22 @@ def test_vm_import_uses_correct_model(self):
api = self._make_api()
patches = self._patch_all_db()
+ mock_vm_cls = MagicMock()
+ mock_vm_cls.objects.filter.return_value.first.return_value = None
try:
for p in patches:
p.start()
- result = validate_device_for_import(libre_device, import_as_vm=True, api=api)
+ # Override with a controlled mock so we can assert the VM model was consulted
+ with patch("virtualization.models.VirtualMachine", mock_vm_cls):
+ result = validate_device_for_import(libre_device, import_as_vm=True, api=api)
finally:
for p in patches:
p.stop()
assert result is not None
assert result.get("import_as_vm") is True
+ # Verify VirtualMachine model (not Device) was used for the hostname lookup
+ mock_vm_cls.objects.filter.assert_called()
def test_existing_device_detected(self):
"""When device with same librenms_id exists, sets existing_device in result."""
@@ -779,7 +785,7 @@ def _start_patches(self, extra_patches=None):
),
patch(
"netbox_librenms_plugin.import_utils.device_operations.get_virtual_chassis_data",
- return_value={"is_stack": False, "member_count": 0, "members": []},
+ return_value={"is_stack": False, "member_count": 0, "members": [], "detection_error": None},
),
patch("netbox_librenms_plugin.import_utils.device_operations.DeviceRole", mock_role),
patch("netbox_librenms_plugin.import_utils.device_operations.Cluster", mock_cluster),
@@ -896,6 +902,8 @@ def test_vc_detection_called_for_device_with_api(self):
self._stop_patches(patches)
assert result["virtual_chassis"] is not None
+ assert result["virtual_chassis"]["is_stack"] is True
+ assert result["virtual_chassis"]["member_count"] == 2
mock_get_vc.assert_called_once()
mock_update_vc.assert_called_once()
@@ -1055,7 +1063,7 @@ def _get_patches(self):
),
patch(
"netbox_librenms_plugin.import_utils.device_operations.get_virtual_chassis_data",
- return_value={"is_stack": False, "member_count": 0, "members": []},
+ return_value={"is_stack": False, "member_count": 0, "members": [], "detection_error": None},
),
patch("netbox_librenms_plugin.import_utils.device_operations.DeviceRole", mock_role),
patch("netbox_librenms_plugin.import_utils.device_operations.Cluster", mock_cluster),
@@ -1397,6 +1405,12 @@ def test_manual_mappings_are_applied(self, MockAPI):
mock_new_device.full_clean.assert_called_once()
mock_new_device.save.assert_called_once()
mock_set_id.assert_called_once()
+ # Verify Device was constructed with the resolved site, device_type, and role
+ mock_device_cls.assert_called_once()
+ call_kwargs = mock_device_cls.call_args[1]
+ assert call_kwargs["site"] is mock_site
+ assert call_kwargs["device_type"] is mock_dt
+ assert call_kwargs["role"] is mock_role
class TestImportSingleDeviceMoreEdgeCases:
@@ -1665,3 +1679,699 @@ def test_chassis_match_overrides_hardware_match(self):
device_patch.stop()
assert result["device_type"].get("device_type") is chassis_dt
+
+
+class TestOOBDetection:
+ """Tests for OOB candidate detection in validate_device_for_import (Phase 2)."""
+
+ def _make_api(self, server_key="default"):
+ api = MagicMock()
+ api.server_key = server_key
+ return api
+
+ def _base_patches(self, mock_device_cls, mock_vm_cls=None):
+ """Return a list of common patches (start/stop must be called by caller).
+
+ Does NOT patch find_by_librenms_id β each test adds it explicitly so that
+ when the same target is patched twice the stop order (reversed) is clear.
+ """
+ if mock_vm_cls is None:
+ mock_vm_cls = MagicMock()
+ mock_vm_cls.objects.filter.return_value.first.return_value = None
+ return [
+ patch("netbox_librenms_plugin.import_utils.device_operations.Site"),
+ patch("netbox_librenms_plugin.import_utils.device_operations.DeviceType"),
+ patch("netbox_librenms_plugin.import_utils.device_operations.DeviceRole"),
+ patch("netbox_librenms_plugin.import_utils.device_operations.cache"),
+ patch("ipam.models.IPAddress"),
+ patch("virtualization.models.VirtualMachine", new=mock_vm_cls),
+ patch(
+ "netbox_librenms_plugin.import_utils.device_operations.match_librenms_hardware_to_device_type",
+ return_value={"matched": False},
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.device_operations.find_matching_site",
+ return_value={"found": False, "site": None, "match_type": None},
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.device_operations.find_matching_platform",
+ return_value={"found": False, "platform": None, "match_type": None},
+ ),
+ ]
+
+ # ------------------------------------------------------------------
+ # Case 1: Serial match + OOB regex β oob_candidate
+ # ------------------------------------------------------------------
+ def test_serial_match_oob_type_sets_oob_candidate(self):
+ """Serial matches + device os=idrac β serial_action='oob_candidate', oob_candidate populated."""
+ from netbox_librenms_plugin.import_utils.device_operations import validate_device_for_import
+
+ libre_device = {
+ "device_id": 17,
+ "hostname": "idrac-server01",
+ "sysName": "idrac-server01",
+ "hardware": "iDRAC9",
+ "serial": "ABC123",
+ "os": "idrac",
+ "ip": "10.0.0.5",
+ "version": "5.10.50",
+ "location": "",
+ }
+ api = self._make_api()
+
+ existing = MagicMock()
+ existing.name = "server01"
+ existing.custom_field_data = {"librenms_id": {"default": 42}}
+
+ mock_device_cls = MagicMock()
+ # hostname check β None, serial check β existing
+ mock_device_cls.objects.filter.return_value.first.side_effect = [None, existing]
+ mock_device_cls.objects.filter.return_value.exclude.return_value.first.return_value = None
+
+ patches = self._base_patches(mock_device_cls) + [
+ patch(
+ "netbox_librenms_plugin.import_utils.device_operations.find_by_librenms_id",
+ return_value=None,
+ ),
+ patch("netbox_librenms_plugin.import_utils.device_operations.Device", new=mock_device_cls),
+ patch("netbox_librenms_plugin.import_utils.device_operations.get_librenms_oob", return_value=None),
+ ]
+ for p in patches:
+ p.start()
+ try:
+ result = validate_device_for_import(libre_device, api=api)
+ finally:
+ for p in reversed(patches):
+ p.stop()
+
+ assert result["serial_action"] == "oob_candidate"
+ assert result["oob_candidate"] is not None
+ assert result["oob_candidate"]["type"] == "idrac"
+ assert result["oob_candidate"]["ip"] == "10.0.0.5"
+ assert result["oob_candidate"]["version"] == "5.10.50"
+ assert result["can_import"] is False
+
+ # ------------------------------------------------------------------
+ # Case 2: Serial match + OOB regex + OOB already set β serial_action="link"
+ # ------------------------------------------------------------------
+ def test_serial_match_oob_already_linked_falls_back_to_link(self):
+ """Serial matches + OOB type + existing OOB already set β serial_action='link'."""
+ from netbox_librenms_plugin.import_utils.device_operations import validate_device_for_import
+
+ libre_device = {
+ "device_id": 17,
+ "hostname": "idrac-server01",
+ "sysName": "idrac-server01",
+ "hardware": "iDRAC9",
+ "serial": "ABC123",
+ "os": "idrac",
+ "ip": "10.0.0.5",
+ "version": "5.10.50",
+ "location": "",
+ }
+ api = self._make_api()
+
+ existing = MagicMock()
+ existing.name = "server01"
+ existing.custom_field_data = {"librenms_id": {"default": {"id": 42, "oob": {"id": 17, "type": "idrac"}}}}
+
+ mock_device_cls = MagicMock()
+ mock_device_cls.objects.filter.return_value.first.side_effect = [None, existing]
+ mock_device_cls.objects.filter.return_value.exclude.return_value.first.return_value = None
+
+ existing_oob = {"id": 17, "type": "idrac"}
+
+ patches = self._base_patches(mock_device_cls) + [
+ patch(
+ "netbox_librenms_plugin.import_utils.device_operations.find_by_librenms_id",
+ return_value=None,
+ ),
+ patch("netbox_librenms_plugin.import_utils.device_operations.Device", new=mock_device_cls),
+ patch("netbox_librenms_plugin.import_utils.device_operations.get_librenms_oob", return_value=existing_oob),
+ ]
+ for p in patches:
+ p.start()
+ try:
+ result = validate_device_for_import(libre_device, api=api)
+ finally:
+ for p in reversed(patches):
+ p.stop()
+
+ assert result["serial_action"] == "link"
+ assert result["oob_candidate"] is None
+
+ # ------------------------------------------------------------------
+ # Case 3: Serial match + NOT an OOB type β link/hostname_differs unchanged
+ # ------------------------------------------------------------------
+ def test_serial_match_non_oob_type_uses_standard_logic(self):
+ """Serial matches but os=linux β standard serial_action (link or hostname_differs)."""
+ from netbox_librenms_plugin.import_utils.device_operations import validate_device_for_import
+
+ libre_device = {
+ "device_id": 42,
+ "hostname": "server01",
+ "sysName": "server01",
+ "hardware": "PowerEdge R640",
+ "serial": "ABC123",
+ "os": "linux",
+ "ip": "192.168.1.1",
+ "version": "",
+ "location": "",
+ }
+ api = self._make_api()
+
+ existing = MagicMock()
+ existing.name = "server01"
+
+ mock_device_cls = MagicMock()
+ # hostname check β None, serial check β existing
+ mock_device_cls.objects.filter.return_value.first.side_effect = [None, existing]
+ mock_device_cls.objects.filter.return_value.exclude.return_value.first.return_value = None
+
+ patches = self._base_patches(mock_device_cls) + [
+ patch(
+ "netbox_librenms_plugin.import_utils.device_operations.find_by_librenms_id",
+ return_value=None,
+ ),
+ patch("netbox_librenms_plugin.import_utils.device_operations.Device", new=mock_device_cls),
+ ]
+ for p in patches:
+ p.start()
+ try:
+ result = validate_device_for_import(libre_device, api=api)
+ finally:
+ for p in reversed(patches):
+ p.stop()
+
+ assert result["serial_action"] in ("link", "hostname_differs")
+ assert result["oob_candidate"] is None
+
+ # ------------------------------------------------------------------
+ # Case 4: result dict always has oob_candidate key (even when not set)
+ # ------------------------------------------------------------------
+ def test_result_always_contains_oob_candidate_key(self):
+ """result dict always includes oob_candidate key regardless of detection path."""
+ from netbox_librenms_plugin.import_utils.device_operations import validate_device_for_import
+
+ libre_device = {
+ "device_id": 1,
+ "hostname": "sw01",
+ "sysName": "sw01",
+ "hardware": "SomeSwitch",
+ "serial": "",
+ "os": "ios",
+ "ip": "",
+ "version": "",
+ "location": "",
+ }
+ api = self._make_api()
+
+ mock_device_cls = MagicMock()
+ mock_device_cls.objects.filter.return_value.first.return_value = None
+ mock_device_cls.objects.filter.return_value.exclude.return_value.first.return_value = None
+
+ patches = self._base_patches(mock_device_cls) + [
+ patch(
+ "netbox_librenms_plugin.import_utils.device_operations.find_by_librenms_id",
+ return_value=None,
+ ),
+ patch("netbox_librenms_plugin.import_utils.device_operations.Device", new=mock_device_cls),
+ ]
+ for p in patches:
+ p.start()
+ try:
+ result = validate_device_for_import(libre_device, api=api)
+ finally:
+ for p in reversed(patches):
+ p.stop()
+
+ assert "oob_candidate" in result
+ assert result["oob_candidate"] is None
+
+ # ------------------------------------------------------------------
+ # Case 4b: Inverse-OOB β existing NetBox device named like an OOB,
+ # already linked to a different LibreNMS id, incoming is the host.
+ # ------------------------------------------------------------------
+ def test_serial_match_inverse_oob_sets_promote_to_host(self):
+ """Existing device named 'idrac-*' linked to libre #99; incoming host (os=linux) shares serial β promote_to_host."""
+ from netbox_librenms_plugin.import_utils.device_operations import validate_device_for_import
+
+ libre_device = {
+ "device_id": 42,
+ "hostname": "eve-ng-02",
+ "sysName": "eve-ng-02",
+ "hardware": "Dell PowerEdge R770",
+ "serial": "ABC123",
+ "os": "linux",
+ "ip": "10.0.0.10",
+ "version": "",
+ "location": "",
+ }
+ api = self._make_api()
+
+ existing = MagicMock()
+ existing.name = "idrac-jhw6nc4"
+ existing.cf = {"librenms_id": {"default": {"id": 99}}}
+
+ mock_device_cls = MagicMock()
+ mock_device_cls.objects.filter.return_value.first.side_effect = [None, existing]
+ mock_device_cls.objects.filter.return_value.exclude.return_value.first.return_value = None
+
+ patches = self._base_patches(mock_device_cls) + [
+ patch(
+ "netbox_librenms_plugin.import_utils.device_operations.find_by_librenms_id",
+ return_value=None,
+ ),
+ patch("netbox_librenms_plugin.import_utils.device_operations.Device", new=mock_device_cls),
+ ]
+ for p in patches:
+ p.start()
+ try:
+ result = validate_device_for_import(libre_device, api=api)
+ finally:
+ for p in reversed(patches):
+ p.stop()
+
+ assert result["serial_action"] == "promote_to_host"
+ assert result["promote_to_host"] == {
+ "existing_libre_id": 99,
+ "existing_oob_type": "idrac",
+ }
+ assert result["existing_librenms_link"] == {
+ "host_id": 99,
+ "oob_id": None,
+ "oob_type": None,
+ }
+ assert result["can_import"] is False
+
+ def test_serial_match_inverse_oob_skipped_when_existing_already_has_oob(self):
+ """If existing device already has an OOB linked, do NOT offer promote_to_host."""
+ from netbox_librenms_plugin.import_utils.device_operations import validate_device_for_import
+
+ libre_device = {
+ "device_id": 42,
+ "hostname": "eve-ng-02",
+ "sysName": "eve-ng-02",
+ "hardware": "Dell PowerEdge R770",
+ "serial": "ABC123",
+ "os": "linux",
+ "ip": "10.0.0.10",
+ "version": "",
+ "location": "",
+ }
+ api = self._make_api()
+
+ existing = MagicMock()
+ existing.name = "idrac-jhw6nc4"
+ # Both host id and OOB already set β the merge has already happened.
+ existing.cf = {"librenms_id": {"default": {"id": 100, "oob": {"id": 99, "type": "idrac"}}}}
+
+ mock_device_cls = MagicMock()
+ mock_device_cls.objects.filter.return_value.first.side_effect = [None, existing]
+ mock_device_cls.objects.filter.return_value.exclude.return_value.first.return_value = None
+
+ patches = self._base_patches(mock_device_cls) + [
+ patch(
+ "netbox_librenms_plugin.import_utils.device_operations.find_by_librenms_id",
+ return_value=None,
+ ),
+ patch("netbox_librenms_plugin.import_utils.device_operations.Device", new=mock_device_cls),
+ ]
+ for p in patches:
+ p.start()
+ try:
+ result = validate_device_for_import(libre_device, api=api)
+ finally:
+ for p in reversed(patches):
+ p.stop()
+
+ assert result["serial_action"] != "promote_to_host"
+ assert result["promote_to_host"] is None
+ assert result["existing_librenms_link"]["oob_id"] == 99
+
+ def test_serial_role_choice_available_offers_both_options_when_feasible(self):
+ """When existing has a different LibreNMS host id linked, no OOB, and no name match,
+ both oob_candidate and promote_to_host are populated and serial_role_choice_available
+ signals the UI to render the host/OOB toggle."""
+ from netbox_librenms_plugin.import_utils.device_operations import validate_device_for_import
+
+ libre_device = {
+ "device_id": 42,
+ "hostname": "eve-ng-02",
+ "sysName": "eve-ng-02",
+ "hardware": "Dell PowerEdge R770",
+ "serial": "ABC123",
+ "os": "linux",
+ "ip": "10.0.0.10",
+ "version": "",
+ "location": "",
+ }
+ api = self._make_api()
+
+ existing = MagicMock()
+ existing.name = "idrac-jhw6nc4" # OOB pattern in name -> heuristic picks promote
+ existing.cf = {"librenms_id": {"default": {"id": 25}}}
+
+ mock_device_cls = MagicMock()
+ mock_device_cls.objects.filter.return_value.first.side_effect = [None, existing]
+ mock_device_cls.objects.filter.return_value.exclude.return_value.first.return_value = None
+
+ patches = self._base_patches(mock_device_cls) + [
+ patch(
+ "netbox_librenms_plugin.import_utils.device_operations.find_by_librenms_id",
+ return_value=None,
+ ),
+ patch("netbox_librenms_plugin.import_utils.device_operations.Device", new=mock_device_cls),
+ ]
+ for p in patches:
+ p.start()
+ try:
+ result = validate_device_for_import(libre_device, api=api)
+ finally:
+ for p in reversed(patches):
+ p.stop()
+
+ # Heuristic chose promote_to_host (existing name suggests OOB, host link demote-able).
+ assert result["serial_action"] == "promote_to_host"
+ # Toggle is available so the user can flip to "Add as OOB" instead.
+ assert result["serial_role_choice_available"] is True
+ assert result["oob_candidate"] is not None
+ assert result["oob_candidate"]["device"] is existing
+ assert result["promote_to_host"] is not None
+ assert result["promote_to_host"]["existing_libre_id"] == 25
+
+ def test_serial_role_choice_not_available_when_names_match_and_no_link(self):
+ """Exact name match with no existing LibreNMS link -> simple link case, no toggle."""
+ from netbox_librenms_plugin.import_utils.device_operations import validate_device_for_import
+
+ libre_device = {
+ "device_id": 42,
+ "hostname": "server01",
+ "sysName": "server01",
+ "hardware": "PowerEdge R640",
+ "serial": "XYZ789",
+ "os": "linux",
+ "ip": "192.168.1.1",
+ "version": "",
+ "location": "",
+ }
+ api = self._make_api()
+
+ existing = MagicMock()
+ existing.name = "server01"
+ existing.cf = {} # not linked
+
+ mock_device_cls = MagicMock()
+ mock_device_cls.objects.filter.return_value.first.side_effect = [None, existing]
+ mock_device_cls.objects.filter.return_value.exclude.return_value.first.return_value = None
+
+ patches = self._base_patches(mock_device_cls) + [
+ patch(
+ "netbox_librenms_plugin.import_utils.device_operations.find_by_librenms_id",
+ return_value=None,
+ ),
+ patch("netbox_librenms_plugin.import_utils.device_operations.Device", new=mock_device_cls),
+ ]
+ for p in patches:
+ p.start()
+ try:
+ result = validate_device_for_import(libre_device, api=api)
+ finally:
+ for p in reversed(patches):
+ p.stop()
+
+ assert result["serial_action"] == "link"
+ assert result.get("serial_role_choice_available") is False
+ assert result["oob_candidate"] is None
+ assert result["promote_to_host"] is None
+
+ def test_serial_match_inverse_oob_requires_oob_pattern_in_name(self):
+ """Existing device without OOB pattern in its name but with a different LibreNMS link
+ is now treated as an ambiguous host/OOB chassis pair: both options are populated and a
+ UI role-toggle is offered, defaulting to oob_candidate (least-destructive)."""
+ from netbox_librenms_plugin.import_utils.device_operations import validate_device_for_import
+
+ libre_device = {
+ "device_id": 42,
+ "hostname": "eve-ng-02",
+ "sysName": "eve-ng-02",
+ "hardware": "Dell PowerEdge R770",
+ "serial": "ABC123",
+ "os": "linux",
+ "ip": "10.0.0.10",
+ "version": "",
+ "location": "",
+ }
+ api = self._make_api()
+
+ existing = MagicMock()
+ existing.name = "old-server-name" # no OOB pattern
+ existing.cf = {"librenms_id": {"default": {"id": 99}}}
+
+ mock_device_cls = MagicMock()
+ mock_device_cls.objects.filter.return_value.first.side_effect = [None, existing]
+ mock_device_cls.objects.filter.return_value.exclude.return_value.first.return_value = None
+
+ patches = self._base_patches(mock_device_cls) + [
+ patch(
+ "netbox_librenms_plugin.import_utils.device_operations.find_by_librenms_id",
+ return_value=None,
+ ),
+ patch("netbox_librenms_plugin.import_utils.device_operations.Device", new=mock_device_cls),
+ ]
+ for p in patches:
+ p.start()
+ try:
+ result = validate_device_for_import(libre_device, api=api)
+ finally:
+ for p in reversed(patches):
+ p.stop()
+
+ assert result["serial_action"] == "oob_candidate"
+ assert result["serial_role_choice_available"] is True
+ assert result["oob_candidate"] is not None
+ assert result["promote_to_host"] is not None
+ assert result["promote_to_host"]["existing_libre_id"] == 99
+ # existing link state is still surfaced
+ assert result["existing_librenms_link"]["host_id"] == 99
+
+ # ------------------------------------------------------------------
+ # Stage 2: two-NetBox-device merge detection
+ # ------------------------------------------------------------------
+ def test_merge_candidates_detected_when_hostname_and_serial_match_different_devices(self):
+ """Hostname matches device A, serial matches different device B (A has link) β merge_netbox_devices."""
+ from netbox_librenms_plugin.import_utils.device_operations import validate_device_for_import
+
+ libre_device = {
+ "device_id": 42,
+ "hostname": "eve-ng-02",
+ "sysName": "eve-ng-02",
+ "hardware": "Dell PowerEdge R770",
+ "serial": "ABC123",
+ "os": "linux",
+ "ip": "10.0.0.10",
+ "version": "",
+ "location": "",
+ }
+ api = self._make_api()
+
+ host_named = MagicMock()
+ host_named.name = "eve-ng-02"
+ host_named.pk = 100
+ host_named.serial = "ABC123" # same β skips serial-conflict path inside hostname branch
+ host_named.cf = {"librenms_id": {"default": {"id": 42}}}
+ host_named.custom_field_data = {"librenms_id": {"default": {"id": 42}}}
+
+ oob_named = MagicMock()
+ oob_named.name = "idrac-jhw6nc4"
+ oob_named.pk = 200
+ oob_named.serial = "ABC123"
+ oob_named.cf = {"librenms_id": {"default": {"id": 99}}}
+ oob_named.custom_field_data = {"librenms_id": {"default": {"id": 99}}}
+
+ mock_device_cls = MagicMock()
+ # filter().first() β hostname lookup β host_named
+ mock_device_cls.objects.filter.return_value.first.return_value = host_named
+ # filter().exclude().first() β used by my merge-detect branch to find the serial-twin
+ mock_device_cls.objects.filter.return_value.exclude.return_value.first.return_value = oob_named
+ # isinstance(existing_device, Device) check β make it accept MagicMock objects.
+
+ patches = self._base_patches(mock_device_cls) + [
+ patch(
+ "netbox_librenms_plugin.import_utils.device_operations.find_by_librenms_id",
+ return_value=None,
+ ),
+ patch("netbox_librenms_plugin.import_utils.device_operations.Device", new=mock_device_cls),
+ ]
+ for p in patches:
+ p.start()
+ try:
+ result = validate_device_for_import(libre_device, api=api)
+ finally:
+ for p in reversed(patches):
+ p.stop()
+
+ assert result["serial_action"] == "merge_netbox_devices"
+ assert result["merge_candidates"] is not None
+ assert result["merge_candidates"]["host_named"]["pk"] == 100
+ assert result["merge_candidates"]["host_named"]["name"] == "eve-ng-02"
+ assert result["merge_candidates"]["oob_named"]["pk"] == 200
+ assert result["merge_candidates"]["oob_named"]["name"] == "idrac-jhw6nc4"
+ assert result["merge_candidates"]["host_named"]["librenms_link"]["host_id"] == 42
+ assert result["merge_candidates"]["oob_named"]["librenms_link"]["host_id"] == 99
+ assert result["can_import"] is False
+
+ def test_merge_candidates_skipped_when_neither_device_has_librenms_link(self):
+ """Two different devices share serial but neither has librenms link β conservative skip."""
+ from netbox_librenms_plugin.import_utils.device_operations import validate_device_for_import
+
+ libre_device = {
+ "device_id": 42,
+ "hostname": "eve-ng-02",
+ "sysName": "eve-ng-02",
+ "hardware": "Dell PowerEdge R770",
+ "serial": "ABC123",
+ "os": "linux",
+ "ip": "10.0.0.10",
+ "version": "",
+ "location": "",
+ }
+ api = self._make_api()
+
+ host_named = MagicMock()
+ host_named.name = "eve-ng-02"
+ host_named.pk = 100
+ host_named.serial = "ABC123"
+ host_named.cf = {} # no librenms link
+ host_named.custom_field_data = {}
+
+ oob_named = MagicMock()
+ oob_named.name = "idrac-jhw6nc4"
+ oob_named.pk = 200
+ oob_named.serial = "ABC123"
+ oob_named.cf = {}
+ oob_named.custom_field_data = {}
+
+ mock_device_cls = MagicMock()
+ mock_device_cls.objects.filter.return_value.first.return_value = host_named
+ mock_device_cls.objects.filter.return_value.exclude.return_value.first.return_value = oob_named
+
+ patches = self._base_patches(mock_device_cls) + [
+ patch(
+ "netbox_librenms_plugin.import_utils.device_operations.find_by_librenms_id",
+ return_value=None,
+ ),
+ patch("netbox_librenms_plugin.import_utils.device_operations.Device", new=mock_device_cls),
+ ]
+ for p in patches:
+ p.start()
+ try:
+ result = validate_device_for_import(libre_device, api=api)
+ finally:
+ for p in reversed(patches):
+ p.stop()
+
+ assert result["serial_action"] != "merge_netbox_devices"
+ assert result["merge_candidates"] is None
+
+ def test_merge_candidates_skipped_when_only_one_device(self):
+ """Hostname matches, no other device by serial β no merge candidates."""
+ from netbox_librenms_plugin.import_utils.device_operations import validate_device_for_import
+
+ libre_device = {
+ "device_id": 42,
+ "hostname": "eve-ng-02",
+ "sysName": "eve-ng-02",
+ "hardware": "Dell PowerEdge R770",
+ "serial": "ABC123",
+ "os": "linux",
+ "ip": "10.0.0.10",
+ "version": "",
+ "location": "",
+ }
+ api = self._make_api()
+
+ host_named = MagicMock()
+ host_named.name = "eve-ng-02"
+ host_named.pk = 100
+ host_named.serial = "ABC123"
+ host_named.cf = {"librenms_id": {"default": {"id": 42}}}
+ host_named.custom_field_data = {"librenms_id": {"default": {"id": 42}}}
+
+ mock_device_cls = MagicMock()
+ mock_device_cls.objects.filter.return_value.first.return_value = host_named
+ # No serial twin
+ mock_device_cls.objects.filter.return_value.exclude.return_value.first.return_value = None
+
+ patches = self._base_patches(mock_device_cls) + [
+ patch(
+ "netbox_librenms_plugin.import_utils.device_operations.find_by_librenms_id",
+ return_value=None,
+ ),
+ patch("netbox_librenms_plugin.import_utils.device_operations.Device", new=mock_device_cls),
+ ]
+ for p in patches:
+ p.start()
+ try:
+ result = validate_device_for_import(libre_device, api=api)
+ finally:
+ for p in reversed(patches):
+ p.stop()
+
+ assert result["serial_action"] != "merge_netbox_devices"
+ assert result["merge_candidates"] is None
+
+ # ------------------------------------------------------------------
+ # Case 5: Re-import via OOB id β existing_match_type = "librenms_oob"
+ # ------------------------------------------------------------------
+ def test_reimport_via_oob_id_sets_match_type_librenms_oob(self):
+ """find_by_librenms_id returns device when OOB id matches β existing_match_type='librenms_oob'."""
+ from netbox_librenms_plugin.import_utils.device_operations import validate_device_for_import
+
+ libre_device = {
+ "device_id": 17,
+ "hostname": "idrac-server01",
+ "sysName": "idrac-server01",
+ "hardware": "iDRAC9",
+ "serial": "ABC123",
+ "os": "idrac",
+ "ip": "10.0.0.5",
+ "version": "5.10.50",
+ "location": "",
+ }
+ api = self._make_api()
+
+ existing = MagicMock()
+ existing.name = "server01"
+
+ # Simulate: find_by_librenms_id matched on OOB id (id=17 is oob.id)
+ existing_oob = {"id": 17, "type": "idrac"}
+
+ mock_device_cls = MagicMock()
+ mock_device_cls.objects.filter.return_value.first.return_value = None
+ mock_device_cls.objects.filter.return_value.exclude.return_value.first.return_value = None
+
+ # find_by_librenms_id: first call for VM returns None, second call for Device returns existing
+ find_by_id_mock = MagicMock(side_effect=[None, existing])
+
+ patches = self._base_patches(mock_device_cls) + [
+ patch("netbox_librenms_plugin.import_utils.device_operations.Device", new=mock_device_cls),
+ patch(
+ "netbox_librenms_plugin.import_utils.device_operations.find_by_librenms_id",
+ new=find_by_id_mock,
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.device_operations.get_librenms_oob",
+ return_value=existing_oob,
+ ),
+ ]
+ for p in patches:
+ p.start()
+ try:
+ result = validate_device_for_import(libre_device, api=api)
+ finally:
+ for p in reversed(patches):
+ p.stop()
+
+ assert result["existing_match_type"] == "librenms_oob"
+ assert result["existing_device"] is existing
diff --git a/netbox_librenms_plugin/tests/test_coverage_devices.py b/netbox_librenms_plugin/tests/test_coverage_devices.py
new file mode 100644
index 0000000000..dab958f7ff
--- /dev/null
+++ b/netbox_librenms_plugin/tests/test_coverage_devices.py
@@ -0,0 +1,952 @@
+"""Coverage tests for views/object_sync/devices.py."""
+
+from unittest.mock import MagicMock, patch
+
+
+def _make_device_view():
+ """Create a DeviceLibreNMSSyncView instance bypassing __init__."""
+ from netbox_librenms_plugin.views.object_sync.devices import DeviceLibreNMSSyncView
+
+ view = object.__new__(DeviceLibreNMSSyncView)
+ view.request = MagicMock()
+ view.request.path = "/dcim/devices/1/librenms-sync/"
+ view.kwargs = {}
+ view._librenms_api = MagicMock()
+ view._librenms_api.server_key = "default"
+ view._librenms_api.cache_timeout = 300
+ return view
+
+
+def _make_interface_view():
+ """Create a DeviceInterfaceTableView instance bypassing __init__."""
+ from netbox_librenms_plugin.views.object_sync.devices import DeviceInterfaceTableView
+
+ view = object.__new__(DeviceInterfaceTableView)
+ view.request = MagicMock()
+ view.request.path = "/dcim/devices/1/librenms-sync/"
+ view._librenms_api = MagicMock()
+ view._librenms_api.server_key = "default"
+ return view
+
+
+class TestDeviceLibreNMSSyncViewContextMethods:
+ """Tests for DeviceLibreNMSSyncView context delegation."""
+
+ def test_get_interface_context_delegates_to_interface_view(self):
+ """get_interface_context() creates DeviceInterfaceTableView, copies request, and calls get_context_data."""
+
+ view = _make_device_view()
+ request = MagicMock()
+ obj = MagicMock()
+
+ mock_ctx = {"interfaces": []}
+ with patch(
+ "netbox_librenms_plugin.views.object_sync.devices.DeviceInterfaceTableView.get_context_data",
+ autospec=True,
+ return_value=mock_ctx,
+ ) as mock_get_context:
+ with patch(
+ "netbox_librenms_plugin.views.object_sync.devices.get_interface_name_field", return_value="ifName"
+ ):
+ result = view.get_interface_context(request, obj)
+ assert result == mock_ctx
+ assert mock_get_context.called
+ child_instance = mock_get_context.call_args[0][0]
+ # Identity check: the child view must store a *copy* of the request,
+ # not the original β equality (==) would silently pass even if the
+ # original were reused (MagicMock instances compare equal).
+ assert child_instance.request is not request
+ assert mock_get_context.call_args[0][1] is request
+ assert mock_get_context.call_args[0][2] is obj
+
+ def test_get_cable_context_delegates_to_cable_view(self):
+ """get_cable_context() creates DeviceCableTableView, copies request, and calls get_context_data."""
+
+ view = _make_device_view()
+ request = MagicMock()
+ obj = MagicMock()
+
+ mock_ctx = {"cables": []}
+ with patch(
+ "netbox_librenms_plugin.views.object_sync.devices.DeviceCableTableView.get_context_data",
+ autospec=True,
+ return_value=mock_ctx,
+ ) as mock_get_context:
+ result = view.get_cable_context(request, obj)
+ assert result == mock_ctx
+ assert mock_get_context.called
+ child_instance = mock_get_context.call_args[0][0]
+ assert child_instance.request is not request
+ assert mock_get_context.call_args[0][1] is request
+ assert mock_get_context.call_args[0][2] is obj
+
+ def test_get_ip_context_delegates_to_ip_view(self):
+ """get_ip_context() creates DeviceIPAddressTableView and calls get_context_data with request and obj."""
+
+ view = _make_device_view()
+ request = MagicMock()
+ obj = MagicMock()
+
+ mock_ctx = {"ips": []}
+ with patch(
+ "netbox_librenms_plugin.views.object_sync.devices.DeviceIPAddressTableView.get_context_data",
+ autospec=True,
+ return_value=mock_ctx,
+ ) as mock_get_context:
+ result = view.get_ip_context(request, obj)
+ assert result == mock_ctx
+ assert mock_get_context.called
+ assert mock_get_context.call_args[0][1] is request
+ assert mock_get_context.call_args[0][2] is obj
+ child_instance = mock_get_context.call_args[0][0]
+ assert child_instance.request is not request
+
+ def test_get_vlan_context_delegates_to_vlan_view(self):
+ """get_vlan_context() creates DeviceVLANTableView, copies request, and calls get_vlan_context."""
+
+ view = _make_device_view()
+ request = MagicMock()
+ obj = MagicMock()
+
+ mock_ctx = {"vlans": []}
+ with patch(
+ "netbox_librenms_plugin.views.object_sync.devices.DeviceVLANTableView.get_vlan_context",
+ autospec=True,
+ return_value=mock_ctx,
+ ) as mock_get_context:
+ result = view.get_vlan_context(request, obj)
+ assert result == mock_ctx
+ assert mock_get_context.called
+ child_instance = mock_get_context.call_args[0][0]
+ assert child_instance.request is not request
+ assert mock_get_context.call_args[0][1] is request
+ assert mock_get_context.call_args[0][2] is obj
+
+ def test_get_module_context_delegates_to_module_view(self):
+ """get_module_context() creates DeviceModuleTableView, copies request, and calls get_context_data."""
+
+ view = _make_device_view()
+ request = MagicMock()
+ obj = MagicMock()
+
+ mock_ctx = {"modules": []}
+ with patch(
+ "netbox_librenms_plugin.views.object_sync.devices.DeviceModuleTableView.get_context_data",
+ autospec=True,
+ return_value=mock_ctx,
+ ) as mock_get_context:
+ result = view.get_module_context(request, obj)
+ assert result == mock_ctx
+ assert mock_get_context.called
+ child_instance = mock_get_context.call_args[0][0]
+ assert child_instance.request is not request
+ assert mock_get_context.call_args[0][1] is request
+ assert mock_get_context.call_args[0][2] is obj
+
+
+class TestDeviceInterfaceTableView:
+ """Tests for DeviceInterfaceTableView."""
+
+ def test_get_interfaces_returns_all_interfaces(self):
+ """get_interfaces() returns obj.interfaces.all()."""
+ view = _make_interface_view()
+ obj = MagicMock()
+ mock_qs = MagicMock()
+ obj.interfaces.all.return_value = mock_qs
+
+ result = view.get_interfaces(obj)
+ assert result is mock_qs
+ obj.interfaces.all.assert_called_once()
+
+ def test_get_redirect_url_returns_device_url(self):
+ """get_redirect_url() returns the device interface sync URL."""
+ view = _make_interface_view()
+ obj = MagicMock()
+ obj.pk = 42
+
+ with patch("netbox_librenms_plugin.views.object_sync.devices.reverse") as mock_reverse:
+ mock_reverse.return_value = "/dcim/devices/42/interface-sync/"
+ result = view.get_redirect_url(obj)
+ mock_reverse.assert_called_once_with("plugins:netbox_librenms_plugin:device_interface_sync", kwargs={"pk": 42})
+ assert result == "/dcim/devices/42/interface-sync/"
+
+ def test_get_table_returns_vc_table_for_vc_device(self):
+ """get_table() returns VCInterfaceTable when device has virtual_chassis."""
+
+ view = _make_interface_view()
+ obj = MagicMock()
+ obj.virtual_chassis = MagicMock() # Has VC
+ view._librenms_api = MagicMock()
+ view._librenms_api.server_key = "default"
+
+ with patch("netbox_librenms_plugin.views.object_sync.devices.VCInterfaceTable") as mock_vc_table:
+ mock_table = MagicMock()
+ mock_vc_table.return_value = mock_table
+ result = view.get_table([], obj, "ifName", vlan_groups=[])
+
+ mock_vc_table.assert_called_once_with(
+ [], device=obj, interface_name_field="ifName", vlan_groups=[], server_key="default"
+ )
+ assert result is mock_table
+
+ def test_get_table_returns_librenms_table_for_non_vc_device(self):
+ """get_table() returns LibreNMSInterfaceTable when no virtual_chassis."""
+ view = _make_interface_view()
+ obj = MagicMock()
+ obj.virtual_chassis = None # No VC
+
+ with patch("netbox_librenms_plugin.views.object_sync.devices.LibreNMSInterfaceTable") as mock_table_cls:
+ mock_table = MagicMock()
+ mock_table_cls.return_value = mock_table
+ result = view.get_table([], obj, "ifName")
+
+ mock_table_cls.assert_called_once_with(
+ [], device=obj, interface_name_field="ifName", vlan_groups=None, server_key="default"
+ )
+ assert result is mock_table
+
+ def test_get_table_sets_htmx_url(self):
+ """get_table() sets htmx_url on the returned table."""
+ view = _make_interface_view()
+ view.request.path = "/dcim/devices/1/librenms-sync/"
+ obj = MagicMock()
+ obj.virtual_chassis = None
+
+ with patch("netbox_librenms_plugin.views.object_sync.devices.LibreNMSInterfaceTable") as mock_table_cls:
+ mock_table = MagicMock()
+ mock_table_cls.return_value = mock_table
+ view.get_table([], obj, "ifName")
+
+ assert mock_table.htmx_url == "/dcim/devices/1/librenms-sync/?tab=interfaces&server_key=default"
+
+
+class TestSingleInterfaceVerifyView:
+ """Tests for SingleInterfaceVerifyView."""
+
+ def _make_view(self):
+ from netbox_librenms_plugin.views.object_sync.devices import SingleInterfaceVerifyView
+ from unittest.mock import MagicMock
+
+ view = object.__new__(SingleInterfaceVerifyView)
+ view._librenms_api = MagicMock()
+ view._librenms_api.server_key = "default"
+ return view
+
+ def test_returns_400_when_no_device_id(self):
+ """Returns 400 JSON error when no device_id in request body."""
+ import json
+
+ from django.http import JsonResponse
+
+ view = self._make_view()
+ request = MagicMock()
+ request.body = json.dumps({"interface_name": "eth0"}).encode()
+
+ response = view.post(request)
+ assert isinstance(response, JsonResponse)
+ assert response.status_code == 400
+
+ def test_returns_404_when_no_cached_data(self):
+ """Returns 404 when cached ports data not found."""
+ import json
+
+ from django.http import JsonResponse
+
+ view = self._make_view()
+ request = MagicMock()
+ request.body = json.dumps({"device_id": 1, "interface_name": "eth0"}).encode()
+
+ mock_device = MagicMock()
+ mock_device.virtual_chassis = None
+
+ with patch("netbox_librenms_plugin.views.object_sync.devices.get_object_or_404", return_value=mock_device):
+ with patch(
+ "netbox_librenms_plugin.views.object_sync.devices.get_librenms_sync_device", return_value=mock_device
+ ):
+ with patch("netbox_librenms_plugin.views.object_sync.devices.cache") as mock_cache:
+ mock_cache.get.return_value = None
+ with patch.object(view, "get_cache_key", return_value="test_key"):
+ response = view.post(request)
+
+ assert isinstance(response, JsonResponse)
+ assert response.status_code == 404
+
+ def test_returns_404_when_interface_not_in_cache(self):
+ """Returns 404 when interface not found in cached ports data."""
+ import json
+
+ from django.http import JsonResponse
+
+ view = self._make_view()
+ request = MagicMock()
+ request.body = json.dumps({"device_id": 1, "interface_name": "eth99"}).encode()
+
+ mock_device = MagicMock()
+ mock_device.virtual_chassis = None
+
+ cached_data = {"ports": [{"ifName": "eth0", "speed": 1000}]}
+
+ with patch("netbox_librenms_plugin.views.object_sync.devices.get_object_or_404", return_value=mock_device):
+ with patch(
+ "netbox_librenms_plugin.views.object_sync.devices.get_librenms_sync_device", return_value=mock_device
+ ):
+ with patch("netbox_librenms_plugin.views.object_sync.devices.cache") as mock_cache:
+ mock_cache.get.return_value = cached_data
+ with patch.object(view, "get_cache_key", return_value="test_key"):
+ response = view.post(request)
+
+ assert isinstance(response, JsonResponse)
+ assert response.status_code == 404
+
+ def test_returns_success_when_interface_found(self):
+ """Returns success JSON with formatted_row when interface found in cache."""
+ import json
+
+ from django.http import JsonResponse
+
+ view = self._make_view()
+ request = MagicMock()
+ request.body = json.dumps({"device_id": 1, "interface_name": "eth0", "interface_name_field": "ifName"}).encode()
+
+ mock_device = MagicMock()
+ mock_device.virtual_chassis = None
+
+ port_data = {"ifName": "eth0", "speed": 1000}
+ cached_data = {"ports": [port_data]}
+
+ mock_table = MagicMock()
+ mock_table.format_interface_data.return_value = "
row
"
+
+ with patch("netbox_librenms_plugin.views.object_sync.devices.get_object_or_404", return_value=mock_device):
+ with patch(
+ "netbox_librenms_plugin.views.object_sync.devices.get_librenms_sync_device", return_value=mock_device
+ ):
+ with patch("netbox_librenms_plugin.views.object_sync.devices.cache") as mock_cache:
+ mock_cache.get.return_value = cached_data
+ with patch.object(view, "get_cache_key", return_value="test_key"):
+ with patch(
+ "netbox_librenms_plugin.views.object_sync.devices.LibreNMSInterfaceTable",
+ return_value=mock_table,
+ ):
+ response = view.post(request)
+
+ assert isinstance(response, JsonResponse)
+ assert response.status_code == 200
+ data = json.loads(response.content)
+ assert data["status"] == "success"
+ assert "formatted_row" in data
+
+ def test_non_vc_device_skips_sync_device_lookup(self):
+ """For non-VC devices, get_librenms_sync_device is not called; selected_device used directly."""
+ import json
+
+ from django.http import JsonResponse
+
+ view = self._make_view()
+ request = MagicMock()
+ request.body = json.dumps({"device_id": 1, "interface_name": "eth0", "interface_name_field": "ifName"}).encode()
+
+ mock_device = MagicMock()
+ mock_device.virtual_chassis = None
+ port_data = {"ifName": "eth0", "speed": 1000}
+ cached_data = {"ports": [port_data]}
+ mock_table = MagicMock()
+ mock_table.format_interface_data.return_value = "
row
"
+
+ with patch("netbox_librenms_plugin.views.object_sync.devices.get_object_or_404", return_value=mock_device):
+ with patch(
+ "netbox_librenms_plugin.views.object_sync.devices.get_librenms_sync_device", return_value=None
+ ) as mock_get_sync_device:
+ with patch("netbox_librenms_plugin.views.object_sync.devices.cache") as mock_cache:
+ mock_cache.get.return_value = cached_data
+ with patch.object(view, "get_cache_key", return_value="test_key") as get_cache_key_mock:
+ with patch(
+ "netbox_librenms_plugin.views.object_sync.devices.LibreNMSInterfaceTable",
+ return_value=mock_table,
+ ):
+ response = view.post(request)
+
+ assert isinstance(response, JsonResponse)
+ assert response.status_code == 200
+ # Non-VC device: get_librenms_sync_device should NOT be called
+ mock_get_sync_device.assert_not_called()
+ # The cache key builder was called with mock_device directly
+ assert get_cache_key_mock.call_args[0][0] is mock_device
+
+
+class TestSingleVlanGroupVerifyView:
+ """Tests for SingleVlanGroupVerifyView."""
+
+ def _make_view(self):
+ from netbox_librenms_plugin.views.object_sync.devices import SingleVlanGroupVerifyView
+
+ view = object.__new__(SingleVlanGroupVerifyView)
+ view._librenms_api = MagicMock()
+ view._librenms_api.server_key = "default"
+ return view
+
+ def test_returns_400_when_no_device_id(self):
+ """Returns 400 when no device_id provided."""
+ import json
+
+ from django.http import JsonResponse
+
+ view = self._make_view()
+ request = MagicMock()
+ request.body = json.dumps({"vid": "10"}).encode()
+
+ response = view.post(request)
+ assert isinstance(response, JsonResponse)
+ assert response.status_code == 400
+
+ def test_returns_400_when_no_vid(self):
+ """Returns 400 when no vid provided."""
+ import json
+
+ from django.http import JsonResponse
+
+ view = self._make_view()
+ request = MagicMock()
+ request.body = json.dumps({"device_id": 1}).encode()
+
+ response = view.post(request)
+ assert isinstance(response, JsonResponse)
+ assert response.status_code == 400
+
+ def test_returns_400_when_invalid_vid(self):
+ """Returns 400 when vid is not a valid integer."""
+ import json
+
+ from django.http import JsonResponse
+
+ view = self._make_view()
+ request = MagicMock()
+ request.body = json.dumps({"device_id": 1, "vid": "notanumber"}).encode()
+
+ mock_device = MagicMock()
+ with patch("netbox_librenms_plugin.views.object_sync.devices.get_object_or_404", return_value=mock_device):
+ response = view.post(request)
+
+ assert isinstance(response, JsonResponse)
+ assert response.status_code == 400
+
+ def test_returns_success_with_vlan_group(self):
+ """Returns success with css_class when valid vlan_group_id provided."""
+ import json
+
+ from django.http import JsonResponse
+
+ view = self._make_view()
+ request = MagicMock()
+ request.body = json.dumps(
+ {
+ "device_id": 1,
+ "vid": "10",
+ "vlan_group_id": "5",
+ "vlan_type": "U",
+ }
+ ).encode()
+
+ mock_device = MagicMock()
+ mock_netbox_iface = MagicMock()
+ mock_netbox_iface.untagged_vlan = None
+ mock_netbox_iface.tagged_vlans.all.return_value = []
+ mock_device.interfaces.filter.return_value.first.return_value = mock_netbox_iface
+
+ mock_vlan_group = MagicMock()
+ mock_vlan_qs = MagicMock()
+ mock_vlan_qs.values_list.return_value = [10]
+ mock_global_qs = MagicMock()
+ mock_global_qs.values_list.return_value = []
+
+ mock_vlan_model = MagicMock()
+ mock_vlan_model.objects.filter.return_value = mock_vlan_qs
+ mock_vlan_group_model = MagicMock()
+ mock_vlan_group_model.objects.filter.return_value = mock_global_qs
+
+ with patch("netbox_librenms_plugin.views.object_sync.devices.get_object_or_404") as mock_get_obj:
+ mock_get_obj.side_effect = [mock_device, mock_vlan_group]
+ with patch(
+ "netbox_librenms_plugin.views.object_sync.devices.get_untagged_vlan_css_class",
+ return_value="text-success",
+ ):
+ with patch(
+ "netbox_librenms_plugin.views.object_sync.devices.get_tagged_vlan_css_class",
+ return_value="text-success",
+ ):
+ with patch(
+ "netbox_librenms_plugin.views.object_sync.devices.get_missing_vlan_warning", return_value=""
+ ):
+ # Patch the VLAN/VLANGroup imports inside the method
+ mock_ipam = MagicMock()
+ mock_ipam.VLAN = mock_vlan_model
+ mock_ipam.VLANGroup = mock_vlan_group_model
+
+ with patch.dict("sys.modules", {"ipam.models": mock_ipam}):
+ response = view.post(request)
+
+ assert isinstance(response, JsonResponse)
+ assert response.status_code == 200
+ data = json.loads(response.content)
+ assert data["status"] == "success"
+ assert data["css_class"] == "text-success"
+ assert data["is_missing"] is False
+
+ def test_returns_success_without_vlan_group(self):
+ """Returns success with global VLANs when no vlan_group_id provided."""
+ import json
+
+ from django.http import JsonResponse
+
+ view = self._make_view()
+ request = MagicMock()
+ request.body = json.dumps(
+ {
+ "device_id": 1,
+ "vid": "100",
+ "vlan_type": "T",
+ }
+ ).encode()
+
+ mock_device = MagicMock()
+ mock_device.interfaces.filter.return_value.first.return_value = None
+
+ mock_vlan_qs = MagicMock()
+ mock_vlan_qs.values_list.return_value = []
+ mock_vlan_model = MagicMock()
+ mock_vlan_model.objects.filter.return_value = mock_vlan_qs
+
+ with patch("netbox_librenms_plugin.views.object_sync.devices.get_object_or_404", return_value=mock_device):
+ with patch(
+ "netbox_librenms_plugin.views.object_sync.devices.get_untagged_vlan_css_class",
+ return_value="text-danger",
+ ):
+ with patch(
+ "netbox_librenms_plugin.views.object_sync.devices.get_tagged_vlan_css_class",
+ return_value="text-danger",
+ ):
+ with patch(
+ "netbox_librenms_plugin.views.object_sync.devices.get_missing_vlan_warning", return_value=""
+ ):
+ mock_ipam = MagicMock()
+ mock_ipam.VLAN = mock_vlan_model
+ mock_ipam.VLANGroup = MagicMock()
+
+ with patch.dict("sys.modules", {"ipam.models": mock_ipam}):
+ response = view.post(request)
+
+ assert isinstance(response, JsonResponse)
+ assert response.status_code == 200
+ data = json.loads(response.content)
+ assert data["status"] == "success"
+ assert data["css_class"] == "text-danger"
+ assert data["is_missing"] is True # vid=100 not in empty group VID list
+
+ def test_existing_interface_with_untagged_and_tagged_vlans(self):
+ """Covers NetBox VLAN extraction branches for untagged and tagged VLANs."""
+ import json
+
+ from django.http import JsonResponse
+
+ view = self._make_view()
+ request = MagicMock()
+ request.body = json.dumps(
+ {
+ "device_id": 1,
+ "vid": "10",
+ "vlan_group_id": "5",
+ "vlan_type": "T",
+ "interface_name": "eth0",
+ }
+ ).encode()
+
+ untagged = MagicMock()
+ untagged.vid = 1
+ untagged.group_id = 9
+ tagged = MagicMock()
+ tagged.vid = 10
+ tagged.group_id = 5
+
+ mock_iface = MagicMock()
+ mock_iface.untagged_vlan = untagged
+ mock_iface.tagged_vlans.all.return_value = [tagged]
+ mock_device = MagicMock()
+ mock_device.interfaces.filter.return_value.first.return_value = mock_iface
+
+ mock_vlan_group = MagicMock()
+ mock_group_qs = MagicMock()
+ mock_group_qs.values_list.return_value = [10]
+ mock_global_qs = MagicMock()
+ mock_global_qs.values_list.return_value = []
+ mock_vlan_model = MagicMock()
+ mock_vlan_model.objects.filter.side_effect = [mock_group_qs, mock_global_qs]
+
+ with patch("netbox_librenms_plugin.views.object_sync.devices.get_object_or_404") as mock_get_obj:
+ mock_get_obj.side_effect = [mock_device, mock_vlan_group]
+ with patch(
+ "netbox_librenms_plugin.views.object_sync.devices.get_tagged_vlan_css_class",
+ return_value="text-success",
+ ):
+ with patch(
+ "netbox_librenms_plugin.views.object_sync.devices.get_missing_vlan_warning", return_value=""
+ ):
+ mock_ipam = MagicMock()
+ mock_ipam.VLAN = mock_vlan_model
+ mock_ipam.VLANGroup = MagicMock()
+ with patch.dict("sys.modules", {"ipam.models": mock_ipam}):
+ response = view.post(request)
+
+ assert isinstance(response, JsonResponse)
+ assert response.status_code == 200
+
+ def test_render_vlans_cell_returns_dash_for_empty_values(self):
+ """Empty VLAN inputs render em dash placeholder."""
+ view = self._make_view()
+ assert view._render_vlans_cell(None, [], [], False, None, set()) == "β"
+
+
+class TestVerifyVlanSyncGroupView:
+ """Tests for VerifyVlanSyncGroupView."""
+
+ def _make_view(self):
+ from netbox_librenms_plugin.views.object_sync.devices import VerifyVlanSyncGroupView
+
+ view = object.__new__(VerifyVlanSyncGroupView)
+ view._librenms_api = MagicMock()
+ view._librenms_api.server_key = "default"
+ return view
+
+ def test_returns_400_when_no_vid(self):
+ """Returns 400 when no vid provided."""
+ import json
+
+ from django.http import JsonResponse
+
+ view = self._make_view()
+ request = MagicMock()
+ request.body = json.dumps({"vlan_group_id": "1"}).encode()
+
+ response = view.post(request)
+ assert isinstance(response, JsonResponse)
+ assert response.status_code == 400
+
+ def test_returns_400_when_invalid_vid(self):
+ """Returns 400 when vid is not a valid integer."""
+ import json
+
+ from django.http import JsonResponse
+
+ view = self._make_view()
+ request = MagicMock()
+ request.body = json.dumps({"vid": "badvalue"}).encode()
+
+ response = view.post(request)
+ assert isinstance(response, JsonResponse)
+ assert response.status_code == 400
+
+ def test_returns_success_with_vlan_group(self):
+ """Returns success with exists_in_netbox and css_class for vlan_group_id path."""
+ import json
+
+ from django.http import JsonResponse
+
+ view = self._make_view()
+ request = MagicMock()
+ request.body = json.dumps({"vid": "10", "vlan_group_id": "3", "name": "vlan10"}).encode()
+
+ mock_vlan = MagicMock()
+ mock_vlan.name = "vlan10"
+ mock_vlan_group = MagicMock()
+
+ with patch("netbox_librenms_plugin.views.object_sync.devices.get_object_or_404") as mock_get_obj:
+ mock_get_obj.return_value = mock_vlan_group
+ with patch(
+ "netbox_librenms_plugin.views.object_sync.devices.get_vlan_sync_css_class", return_value="text-success"
+ ):
+ mock_ipam = MagicMock()
+ mock_vlan_model = MagicMock()
+ mock_vlan_model.objects.filter.return_value.first.return_value = mock_vlan
+ mock_ipam.VLAN = mock_vlan_model
+ mock_ipam.VLANGroup = MagicMock()
+
+ with patch.dict("sys.modules", {"ipam.models": mock_ipam}):
+ response = view.post(request)
+
+ assert isinstance(response, JsonResponse)
+ data = json.loads(response.content)
+ assert response.status_code == 200
+ assert data["status"] == "success"
+ assert "exists_in_netbox" in data
+ assert data["css_class"] == "text-success"
+
+ def test_returns_success_without_vlan_group(self):
+ """Returns success with global VLAN lookup when no vlan_group_id."""
+ import json
+
+ from django.http import JsonResponse
+
+ view = self._make_view()
+ request = MagicMock()
+ request.body = json.dumps({"vid": "20", "name": "vlan20"}).encode()
+
+ with patch(
+ "netbox_librenms_plugin.views.object_sync.devices.get_vlan_sync_css_class", return_value="text-danger"
+ ):
+ mock_ipam = MagicMock()
+ mock_vlan_model = MagicMock()
+ mock_vlan_model.objects.filter.return_value.first.return_value = None
+ mock_ipam.VLAN = mock_vlan_model
+ mock_ipam.VLANGroup = MagicMock()
+
+ with patch.dict("sys.modules", {"ipam.models": mock_ipam}):
+ response = view.post(request)
+
+ assert isinstance(response, JsonResponse)
+ data = json.loads(response.content)
+ assert response.status_code == 200
+ assert data["status"] == "success"
+ assert data["exists_in_netbox"] is False
+ assert data["css_class"] == "text-danger"
+
+
+class TestSaveVlanGroupOverridesView:
+ """Tests for SaveVlanGroupOverridesView."""
+
+ def _make_view(self):
+ from netbox_librenms_plugin.views.object_sync.devices import SaveVlanGroupOverridesView
+
+ view = object.__new__(SaveVlanGroupOverridesView)
+ view._librenms_api = MagicMock()
+ view._librenms_api.server_key = "default"
+ return view
+
+ def test_returns_error_when_no_device_id(self):
+ """Returns 400 error when no device_id in request."""
+ import json
+
+ from django.http import JsonResponse
+
+ view = self._make_view()
+ request = MagicMock()
+ request.body = json.dumps({"vid_group_map": {}}).encode()
+
+ with patch.object(view, "require_write_permission_json", return_value=None):
+ response = view.post(request)
+
+ assert isinstance(response, JsonResponse)
+ assert response.status_code == 400
+
+ def test_requires_write_permission(self):
+ """Returns error response when user lacks write permission."""
+ import json
+
+ view = self._make_view()
+ request = MagicMock()
+ request.body = json.dumps({"device_id": 1}).encode()
+
+ error_response = MagicMock()
+ with patch.object(view, "require_write_permission_json", return_value=error_response):
+ result = view.post(request)
+
+ assert result is error_response
+
+ def test_returns_error_when_no_cached_ports(self):
+ """Returns 400 when ports cache TTL is zero (no cached data)."""
+ import json
+
+ from django.http import JsonResponse
+
+ view = self._make_view()
+ request = MagicMock()
+ request.body = json.dumps({"device_id": 1, "vid_group_map": {"10": "5"}}).encode()
+
+ mock_device = MagicMock()
+
+ with patch.object(view, "require_write_permission_json", return_value=None):
+ with patch("netbox_librenms_plugin.views.object_sync.devices.get_object_or_404", return_value=mock_device):
+ with patch(
+ "netbox_librenms_plugin.views.object_sync.devices.get_librenms_sync_device",
+ return_value=mock_device,
+ ):
+ with patch("netbox_librenms_plugin.views.object_sync.devices.cache") as mock_cache:
+ mock_cache.ttl.return_value = 0
+ with patch.object(view, "get_cache_key", return_value="ports_key"):
+ response = view.post(request)
+
+ assert isinstance(response, JsonResponse)
+ assert response.status_code == 400
+
+ def test_saves_overrides_to_cache(self):
+ """Successfully saves VLAN group overrides to cache."""
+ import json
+
+ from django.http import JsonResponse
+
+ view = self._make_view()
+ request = MagicMock()
+ request.body = json.dumps(
+ {
+ "device_id": 1,
+ "vid_group_map": {"10": "5", "20": "5"},
+ "server_key": "default",
+ }
+ ).encode()
+
+ mock_device = MagicMock()
+
+ with patch.object(view, "require_write_permission_json", return_value=None):
+ with patch("netbox_librenms_plugin.views.object_sync.devices.get_object_or_404", return_value=mock_device):
+ with patch(
+ "netbox_librenms_plugin.views.object_sync.devices.get_librenms_sync_device",
+ return_value=mock_device,
+ ):
+ with patch("netbox_librenms_plugin.views.object_sync.devices.cache") as mock_cache:
+ mock_cache.ttl.return_value = 300
+ mock_cache.get.return_value = {}
+ with patch.object(view, "get_cache_key", return_value="ports_key"):
+ with patch.object(view, "get_vlan_overrides_key", return_value="vlan_overrides_key"):
+ response = view.post(request)
+
+ assert isinstance(response, JsonResponse)
+ assert response.status_code == 200
+ data = json.loads(response.content)
+ assert data["status"] == "success"
+ mock_cache.set.assert_called_once()
+
+ def test_save_overrides_uses_device_when_sync_device_none(self):
+ """If VC sync-device resolution fails, fallback uses original device."""
+ import json
+
+ from django.http import JsonResponse
+
+ view = self._make_view()
+ request = MagicMock()
+ request.body = json.dumps({"device_id": 1, "vid_group_map": {"10": "5"}, "server_key": "default"}).encode()
+ mock_device = MagicMock()
+
+ with patch.object(view, "require_write_permission_json", return_value=None):
+ with patch("netbox_librenms_plugin.views.object_sync.devices.get_object_or_404", return_value=mock_device):
+ with patch(
+ "netbox_librenms_plugin.views.object_sync.devices.get_librenms_sync_device", return_value=None
+ ) as mock_get_sync_device:
+ with patch("netbox_librenms_plugin.views.object_sync.devices.cache") as mock_cache:
+ mock_cache.ttl.return_value = 300
+ mock_cache.get.return_value = {}
+ with patch.object(view, "get_cache_key", return_value="ports_key"):
+ with patch.object(view, "get_vlan_overrides_key", return_value="vlan_overrides_key"):
+ response = view.post(request)
+
+ assert isinstance(response, JsonResponse)
+ assert response.status_code == 200
+ # Verify fallback: get_librenms_sync_device was called with the selected device
+ mock_get_sync_device.assert_called_once()
+ assert mock_get_sync_device.call_args[0][0] is mock_device
+
+
+class TestDeviceCableTableView:
+ """Tests for DeviceCableTableView."""
+
+ def _make_view(self):
+ from netbox_librenms_plugin.views.object_sync.devices import DeviceCableTableView
+
+ view = object.__new__(DeviceCableTableView)
+ view._librenms_api = MagicMock()
+ return view
+
+ def test_get_table_returns_vc_cable_table_for_vc_device(self):
+ """get_table() returns VCCableTable when device has virtual_chassis."""
+ view = self._make_view()
+ obj = MagicMock()
+ obj.virtual_chassis = MagicMock()
+
+ with patch("netbox_librenms_plugin.views.object_sync.devices.VCCableTable") as mock_vc_table:
+ mock_table = MagicMock()
+ mock_vc_table.return_value = mock_table
+ result = view.get_table([], obj)
+
+ assert result is mock_table
+ mock_vc_table.assert_called_once_with([], device=obj)
+
+ def test_get_table_returns_librenms_cable_table_for_non_vc_device(self):
+ """get_table() returns LibreNMSCableTable when no virtual_chassis."""
+ view = self._make_view()
+ obj = MagicMock()
+ obj.virtual_chassis = None
+
+ with patch("netbox_librenms_plugin.views.object_sync.devices.LibreNMSCableTable") as mock_cable_table:
+ mock_table = MagicMock()
+ mock_cable_table.return_value = mock_table
+ result = view.get_table([], obj)
+
+ assert result is mock_table
+ mock_cable_table.assert_called_once_with([], device=obj)
+
+
+class TestDeviceModuleTableView:
+ """Tests for DeviceModuleTableView."""
+
+ def _make_view(self):
+ from netbox_librenms_plugin.views.object_sync.devices import DeviceModuleTableView
+
+ view = object.__new__(DeviceModuleTableView)
+ view.request = MagicMock()
+ view.request.path = "/dcim/devices/1/librenms-sync/"
+ view._librenms_api = MagicMock()
+ view._librenms_api.server_key = "prod-server"
+ view.has_write_permission = MagicMock(return_value=True)
+ view.request.user.has_perm = MagicMock(
+ side_effect=lambda p: (
+ p
+ in {
+ "dcim.add_module",
+ "dcim.change_module",
+ "dcim.delete_module",
+ "dcim.add_modulebaytemplate",
+ "dcim.add_moduletype",
+ "netbox_librenms_plugin.add_carrierautoinstallrule",
+ "netbox_librenms_plugin.add_modulebaymapping",
+ "netbox_librenms_plugin.add_moduletypemapping",
+ }
+ )
+ )
+ return view
+
+ def test_get_table_returns_librenms_module_table(self):
+ """get_table() returns LibreNMSModuleTable with device and server_key."""
+ view = self._make_view()
+ obj = MagicMock()
+ obj.virtual_chassis = None
+
+ with patch("netbox_librenms_plugin.views.object_sync.devices.LibreNMSModuleTable") as mock_table_cls:
+ mock_table = MagicMock()
+ mock_table_cls.return_value = mock_table
+ result = view.get_table([], obj)
+
+ mock_table_cls.assert_called_once_with(
+ [],
+ device=obj,
+ server_key="prod-server",
+ has_write_permission=True,
+ can_add_module=True,
+ can_change_module=True,
+ can_delete_module=True,
+ can_add_module_bay_template=True,
+ can_add_module_type=True,
+ can_add_carrier_rule=True,
+ can_add_module_bay_mapping=True,
+ can_add_module_type_mapping=True,
+ )
+ assert result is mock_table
+
+ def test_get_table_sets_htmx_url(self):
+ """get_table() sets htmx_url with modules tab."""
+ view = self._make_view()
+ obj = MagicMock()
+ obj.virtual_chassis = None
+
+ with patch("netbox_librenms_plugin.views.object_sync.devices.LibreNMSModuleTable") as mock_table_cls:
+ mock_table = MagicMock()
+ mock_table_cls.return_value = mock_table
+ view.get_table([], obj)
+
+ assert mock_table.htmx_url == "/dcim/devices/1/librenms-sync/?tab=modules&server_key=prod-server"
diff --git a/netbox_librenms_plugin/tests/test_coverage_filters.py b/netbox_librenms_plugin/tests/test_coverage_filters.py
index 2b4250ba56..deac03ff54 100644
--- a/netbox_librenms_plugin/tests/test_coverage_filters.py
+++ b/netbox_librenms_plugin/tests/test_coverage_filters.py
@@ -766,3 +766,5 @@ def test_cache_key_uses_api_server_key(self, mock_cache):
assert mock_cache.set.call_count == 2
keys = [call.args[0] for call in mock_cache.set.call_args_list]
assert keys[0] != keys[1]
+ assert any("server1" in k for k in keys)
+ assert any("server2" in k for k in keys)
diff --git a/netbox_librenms_plugin/tests/test_coverage_forms.py b/netbox_librenms_plugin/tests/test_coverage_forms.py
index 30b38dd38f..5cff3fbf6e 100644
--- a/netbox_librenms_plugin/tests/test_coverage_forms.py
+++ b/netbox_librenms_plugin/tests/test_coverage_forms.py
@@ -59,3 +59,190 @@ def test_pagination_param_does_not_inject_background_job(self):
"""Auxiliary params like 'page' must not trigger background-job default injection."""
form = self._make_form({"page": "2"})
assert form.data.get("use_background_job") is None
+
+
+class TestPollerGroupCacheKeyServerScoped:
+ """Finding 6: verify the poller-group cache key is scoped by server_key."""
+
+ def test_cache_hit_returns_cached_choices(self):
+ """Cache lookup uses the server-scoped key; hit returns cached value without API call."""
+ from unittest.mock import MagicMock, patch
+
+ mock_api = MagicMock()
+ mock_api.server_key = "prod"
+ cached = [("0", "Default (0)"), ("1", "Group1 (1)")]
+
+ with (
+ patch("netbox_librenms_plugin.librenms_api.LibreNMSAPI", return_value=mock_api),
+ patch("django.core.cache.cache") as mock_cache,
+ ):
+ mock_cache.get.return_value = cached
+ from netbox_librenms_plugin.forms import _get_librenms_poller_group_choices
+
+ result = _get_librenms_poller_group_choices()
+
+ expected_key = f"librenms_poller_group_choices_{mock_api.server_key}"
+ mock_cache.get.assert_called_once_with(expected_key)
+ assert result is cached
+
+ def test_cache_miss_calls_api_and_stores_server_scoped_key(self):
+ """Cache miss fetches from API and stores under the server-scoped key."""
+ from unittest.mock import MagicMock, patch
+
+ mock_api = MagicMock()
+ mock_api.server_key = "staging"
+ mock_api.cache_timeout = 60
+ mock_api.get_poller_groups.return_value = (True, [{"id": 1, "group_name": "G1", "descr": ""}])
+
+ with (
+ patch("netbox_librenms_plugin.librenms_api.LibreNMSAPI", return_value=mock_api),
+ patch("django.core.cache.cache") as mock_cache,
+ ):
+ mock_cache.get.return_value = None # cache miss
+ from netbox_librenms_plugin.forms import _get_librenms_poller_group_choices
+
+ _get_librenms_poller_group_choices()
+
+ expected_key = f"librenms_poller_group_choices_{mock_api.server_key}"
+ set_call_key = mock_cache.set.call_args[0][0]
+ assert set_call_key == expected_key
+
+ def test_api_init_failure_returns_defaults_without_cache_lookup(self):
+ """If LibreNMSAPI() raises, return defaults β never read the legacy unscoped key."""
+ from unittest.mock import patch
+
+ with (
+ patch(
+ "netbox_librenms_plugin.librenms_api.LibreNMSAPI",
+ side_effect=RuntimeError("no config"),
+ ),
+ patch("django.core.cache.cache") as mock_cache,
+ ):
+ from netbox_librenms_plugin.forms import _get_librenms_poller_group_choices
+
+ result = _get_librenms_poller_group_choices()
+
+ assert result == [("0", "Default (0)")]
+ mock_cache.get.assert_not_called()
+ mock_cache.set.assert_not_called()
+
+
+class TestQueryDictNotMutated:
+ """Finding 7: LibreNMSImportFilterForm must not mutate the original QueryDict."""
+
+ def test_querydict_original_not_modified(self):
+ """When a QueryDict without use_background_job is passed, the original must be unchanged."""
+ from django.http import QueryDict
+ from unittest.mock import patch
+
+ # An empty QueryDict has no fields β should trigger auto-inject of use_background_job,
+ # but only on the copy, not on the original.
+ qd = QueryDict("")
+ assert qd.get("use_background_job") is None
+
+ with (
+ patch("netbox_librenms_plugin.forms.LibreNMSImportFilterForm._populate_librenms_locations"),
+ ):
+ from netbox_librenms_plugin.forms import LibreNMSImportFilterForm
+
+ LibreNMSImportFilterForm(qd)
+
+ # Original QueryDict must remain unmodified
+ assert qd.get("use_background_job") is None
+
+
+class TestDeviceImportConfigFormInitialValues:
+ """Finding 8: DeviceImportConfigForm sets/skips initial values correctly."""
+
+ def _make_form(self, libre_device=None, validation=None):
+ from unittest.mock import patch
+
+ with (
+ patch("dcim.models.Platform"),
+ patch("netbox_librenms_plugin.forms.Site"),
+ patch("netbox_librenms_plugin.forms.DeviceType"),
+ patch("netbox_librenms_plugin.forms.DeviceRole"),
+ ):
+ from netbox_librenms_plugin.forms import DeviceImportConfigForm
+
+ return DeviceImportConfigForm(
+ libre_device=libre_device or {},
+ validation=validation or {},
+ )
+
+ def test_empty_validation_dict_no_initial_set(self):
+ """With empty libre_device and validation, no field initials should be set by the form."""
+ form = self._make_form(libre_device={}, validation={})
+
+ # Fields populated from libre_device should have blank/None initials when no data given
+ assert form.fields["hostname"].initial in (None, "")
+ assert form.fields["hardware"].initial in (None, "")
+
+ def test_libre_device_sets_initial_hostname(self):
+ """libre_device dict populates hostname and hardware initial values."""
+ libre_device = {
+ "device_id": 5,
+ "hostname": "sw01",
+ "hardware": "Cisco 3850",
+ "location": "NYC",
+ }
+
+ form = self._make_form(libre_device=libre_device, validation={})
+
+ assert form.fields["hostname"].initial == "sw01"
+ assert form.fields["hardware"].initial == "Cisco 3850"
+ assert form.fields["device_id"].initial == 5
+
+
+class TestAddToLibreSNMPV3Validation:
+ """Tests for SNMPv3 form conditional field requirements based on authlevel."""
+
+ _BASE_DATA = {
+ "hostname": "10.0.0.1",
+ "snmp_version": "v3",
+ "authname": "admin",
+ }
+
+ def _make_form(self, extra):
+ from unittest.mock import patch
+
+ from netbox_librenms_plugin.forms import AddToLibreSNMPV3
+
+ data = {**self._BASE_DATA, **extra}
+ with patch(
+ "netbox_librenms_plugin.forms._get_librenms_poller_group_choices",
+ return_value=[("0", "Default (0)")],
+ ):
+ return AddToLibreSNMPV3(data=data)
+
+ def test_no_auth_no_priv_valid_without_auth_fields(self):
+ form = self._make_form({"authlevel": "noAuthNoPriv"})
+ assert form.is_valid(), form.errors
+
+ def test_auth_no_priv_requires_auth_fields(self):
+ form = self._make_form({"authlevel": "authNoPriv"})
+ assert not form.is_valid()
+ assert "authpass" in form.errors
+ assert "authalgo" in form.errors
+
+ def test_auth_no_priv_valid_with_auth_fields(self):
+ form = self._make_form({"authlevel": "authNoPriv", "authpass": "secret", "authalgo": "SHA"})
+ assert form.is_valid(), form.errors
+
+ def test_auth_priv_requires_all_fields(self):
+ form = self._make_form({"authlevel": "authPriv", "authpass": "secret", "authalgo": "SHA"})
+ assert not form.is_valid()
+ assert "cryptopass" in form.errors
+ assert "cryptoalgo" in form.errors
+
+ def test_auth_priv_valid_with_all_fields(self):
+ form = self._make_form(
+ {
+ "authlevel": "authPriv",
+ "authpass": "secret",
+ "authalgo": "SHA",
+ "cryptopass": "encrypt",
+ "cryptoalgo": "AES",
+ }
+ )
+ assert form.is_valid(), form.errors
diff --git a/netbox_librenms_plugin/tests/test_coverage_list.py b/netbox_librenms_plugin/tests/test_coverage_list.py
index 082a42e2c5..1ffb57c921 100644
--- a/netbox_librenms_plugin/tests/test_coverage_list.py
+++ b/netbox_librenms_plugin/tests/test_coverage_list.py
@@ -263,6 +263,33 @@ def test_all_cache_expired_logs_error(self):
assert result == []
mock_logger.error.assert_called_once()
+ def test_load_job_results_sets_name_flags_from_job_data(self):
+ """_load_job_results mirrors use_sysname/strip_domain from job metadata."""
+ from netbox_librenms_plugin.views.imports.list import LibreNMSImportView
+
+ view = object.__new__(LibreNMSImportView)
+ mock_job = MagicMock()
+ mock_job.status = "completed"
+ mock_job.data = {
+ "device_ids": [1],
+ "filters": {},
+ "server_key": "default",
+ "vc_detection_enabled": False,
+ "use_sysname": False,
+ "strip_domain": True,
+ }
+
+ with patch("core.models.Job") as mock_job_cls:
+ mock_job_cls.objects.get.return_value = mock_job
+ with patch("netbox_librenms_plugin.import_utils.get_validated_device_cache_key", return_value="cache_key"):
+ with patch("netbox_librenms_plugin.views.imports.list.cache") as mock_cache:
+ mock_cache.get.return_value = {"device_id": 1, "hostname": "router1"}
+ result = view._load_job_results(1)
+
+ assert len(result) == 1
+ assert view._use_sysname is False
+ assert view._strip_domain is True
+
class TestGetTable:
"""Tests for get_table()."""
@@ -477,7 +504,7 @@ def test_get_job_id_loads_results(self):
with patch.object(view, "get_server_info", return_value={}):
view.get(request)
- mock_load.assert_called_once_with(42)
+ mock_load.assert_called_once_with(42, request=request)
def test_get_job_id_preserves_vc_flag_when_query_flag_missing(self):
"""job_id pages keep vc_detection_enabled from loaded job results."""
@@ -488,7 +515,7 @@ def test_get_job_id_preserves_vc_flag_when_query_flag_missing(self):
mock_api = MagicMock()
mock_api.server_key = "default"
- def _load_job_side_effect(_job_id):
+ def _load_job_side_effect(_job_id, request=None):
view._vc_detection_enabled = True
return [{"device_id": 1, "hostname": "router1"}]
@@ -516,7 +543,7 @@ def _load_job_side_effect(_job_id):
with patch.object(view, "get_server_info", return_value={}):
view.get(request)
- mock_load.assert_called_once_with(42)
+ mock_load.assert_called_once_with(42, request=request)
context = mock_render.call_args[0][2]
assert context["vc_detection_enabled"] is True
@@ -1143,8 +1170,70 @@ def test_get_settings_exception_is_caught(self):
view.get(request)
mock_render.assert_called_once()
+ def test_get_settings_exception_in_inline_load(self):
+ """LibreNMSSettings exception inside filter block is caught."""
+ from netbox_librenms_plugin.views.imports.list import LibreNMSImportView
+
+ view, request = self._make_view(query_params={"apply_filters": "1", "librenms_location": "DC1"})
+
+ mock_api = MagicMock()
+ mock_api.server_key = "default"
+
+ with patch.object(LibreNMSImportView, "librenms_api", new_callable=lambda: property(lambda self: mock_api)):
+ with patch("netbox_librenms_plugin.views.imports.list.LibreNMSSettings") as mock_settings:
+ # First call (module-level read at top of get()) succeeds
+ # Second call (inline, inside the filter block) raises
+ first_call = [True]
+
+ def first_then_raise(*a, **kw):
+ if first_call:
+ first_call.pop()
+ return None
+ raise Exception("DB error")
+
+ mock_settings.objects.first.side_effect = first_then_raise
+ mock_settings.objects.get_or_create.return_value = (None, False)
+
+ with patch("netbox_librenms_plugin.views.imports.list.get_user_pref") as mock_pref:
+ mock_pref.return_value = None
+
+ mock_form_cls = MagicMock()
+ mock_form = MagicMock()
+ mock_form.is_valid.return_value = True
+ mock_form.cleaned_data = {
+ "enable_vc_detection": False,
+ "clear_cache": False,
+ "use_background_job": False,
+ }
+ mock_form_cls.return_value = mock_form
+ view.filterset_form = mock_form_cls
+
+ with patch("netbox_librenms_plugin.views.imports.list.render") as mock_render:
+ mock_render.return_value = MagicMock()
+
+ with patch("netbox_librenms_plugin.views.imports.list.DeviceImportTable"):
+ with patch(
+ "netbox_librenms_plugin.views.imports.list.get_active_cached_searches"
+ ) as mock_searches:
+ mock_searches.return_value = []
+
+ with patch.object(view, "get_server_info", return_value={}):
+ with patch(
+ "netbox_librenms_plugin.import_utils.get_cache_metadata_key"
+ ) as mock_meta:
+ mock_meta.return_value = "meta_key"
+ with patch(
+ "netbox_librenms_plugin.import_utils.get_device_count_for_filters"
+ ) as mock_count:
+ mock_count.return_value = 3
+ with patch("netbox_librenms_plugin.views.imports.list.cache") as mock_cache:
+ mock_cache.get.return_value = None
+ # Should not raise despite the settings exception
+ view.get(request)
+ mock_render.assert_called_once()
+
def test_get_device_count_exception_defaults_zero(self):
- """Device count exception falls back to 0 (lines 304-306)."""
+ """Device count exception falls back to 0."""
from netbox_librenms_plugin.views.imports.list import LibreNMSImportView
view, request = self._make_view(query_params={"apply_filters": "1", "librenms_location": "DC1"})
@@ -1202,7 +1291,7 @@ def test_get_device_count_exception_defaults_zero(self):
assert context["device_count"] == 0
def test_get_cache_check_exception_continues(self):
- """Cache check exception is logged and processing continues (lines 293-294)."""
+ """Cache check exception is logged and processing continues."""
from netbox_librenms_plugin.views.imports.list import LibreNMSImportView
view, request = self._make_view(query_params={"apply_filters": "1", "librenms_location": "DC1"})
@@ -1339,8 +1428,33 @@ def test_get_import_queryset_returns_empty_on_no_results(self):
result = view._get_import_queryset()
assert result == []
+ def test_settings_exception_in_get_import_queryset(self):
+ """LibreNMSSettings exception in _get_import_queryset is caught."""
+ view = self._make_view(
+ filter_data={
+ "librenms_location": "DC1",
+ "enable_vc_detection": False,
+ "clear_cache": False,
+ }
+ )
+
+ with patch("netbox_librenms_plugin.views.imports.list.process_device_filters") as mock_process:
+ mock_process.return_value = ([], False)
+
+ with patch("netbox_librenms_plugin.views.imports.list.get_user_pref") as mock_pref:
+ mock_pref.return_value = None
+
+ with patch("netbox_librenms_plugin.views.imports.list.LibreNMSSettings") as mock_settings:
+ mock_settings.objects.first.side_effect = Exception("DB error")
+
+ with patch("netbox_librenms_plugin.views.imports.list.cache") as mock_cache:
+ mock_cache.get.return_value = None
+ # Should not raise
+ result = view._get_import_queryset()
+ assert result == []
+
def test_cache_metadata_found_sets_timestamps(self):
- """When cache metadata is found, timestamps are set (lines 523-527)."""
+ """When cache metadata is found, timestamps are set."""
mock_device = {"device_id": 1, "_validation": {}}
view = self._make_view(
filter_data={
diff --git a/netbox_librenms_plugin/tests/test_coverage_mixins.py b/netbox_librenms_plugin/tests/test_coverage_mixins.py
index 4ef4297c13..5c38e7594e 100644
--- a/netbox_librenms_plugin/tests/test_coverage_mixins.py
+++ b/netbox_librenms_plugin/tests/test_coverage_mixins.py
@@ -169,8 +169,9 @@ def fake_scope(model_cls, objects):
# SiteGroup ancestors should have been processed
assert len(scope_calls) >= 1
- # Verify the SiteGroup model class was passed to _get_vlan_groups_for_scope
+ # Verify the SiteGroup model class and ancestor objects were passed to _get_vlan_groups_for_scope
assert any(c[0] is MockSiteGroup for c in scope_calls)
+ assert any(c[0] is MockSiteGroup and c[1] == [site_group] for c in scope_calls)
def test_device_with_location_triggers_location_scope_query(self):
"""When device.location is set, location-scoped VLAN groups are queried."""
@@ -566,6 +567,10 @@ def test_site_priority_path_executed(self):
site_group.scope_type = site_ct
site_group.scope_id = 7
+ # Competing global group (less specific β scope_type=None)
+ global_group = MagicMock()
+ global_group.scope_type = None
+
device = MagicMock()
device.rack = None
device.location = None
@@ -580,8 +585,9 @@ def test_site_priority_path_executed(self):
patch("django.contrib.contenttypes.models.ContentType") as MockCT,
):
MockCT.objects.get_for_model.return_value = site_ct
- result = mixin._select_most_specific_group([site_group], device)
+ result = mixin._select_most_specific_group([global_group, site_group], device)
+ # site-scoped group wins over global group
assert result is site_group
def test_region_priority_path_executed(self):
@@ -607,6 +613,10 @@ def test_region_priority_path_executed(self):
region_group.scope_type = region_ct
region_group.scope_id = 15
+ # Competing global group (less specific β scope_type=None)
+ global_group = MagicMock()
+ global_group.scope_type = None
+
device = MagicMock()
device.rack = None
device.location = None
@@ -629,21 +639,34 @@ def test_region_priority_path_executed(self):
id(MockRegion): region_ct,
}
MockCT.objects.get_for_model.side_effect = lambda m: ct_map[id(m)]
- result = mixin._select_most_specific_group([region_group], device)
+ result = mixin._select_most_specific_group([global_group, region_group], device)
+ # region-scoped group wins over global group
assert result is region_group
def test_global_scope_group_lowest_priority(self):
- """Global scope group (scope_type=None) gets global_priority (line 523)."""
+ """Global scope group (scope_type=None) loses to any scoped group."""
mixin = self._make_mixin()
global_group = MagicMock()
global_group.scope_type = None # global
+ site = MagicMock()
+ site.pk = 5
+ site.region = None
+ site.group = None
+
+ site_ct = MagicMock()
+ site_ct.pk = 3
+
+ site_group = MagicMock()
+ site_group.scope_type = site_ct
+ site_group.scope_id = 5
+
device = MagicMock()
device.rack = None
device.location = None
- device.site = None
+ device.site = site
with (
patch("dcim.models.Rack"),
@@ -651,11 +674,13 @@ def test_global_scope_group_lowest_priority(self):
patch("dcim.models.Site"),
patch("dcim.models.SiteGroup"),
patch("dcim.models.Region"),
- patch("django.contrib.contenttypes.models.ContentType"),
+ patch("django.contrib.contenttypes.models.ContentType") as MockCT,
):
- result = mixin._select_most_specific_group([global_group], device)
+ MockCT.objects.get_for_model.return_value = site_ct
+ result = mixin._select_most_specific_group([global_group, site_group], device)
- assert result is global_group
+ # site-scoped group wins over global (global has lowest priority)
+ assert result is site_group
def test_site_group_priority_path_executed(self):
"""Device with site.group executes site-group hierarchy path."""
diff --git a/netbox_librenms_plugin/tests/test_coverage_sync_view.py b/netbox_librenms_plugin/tests/test_coverage_sync_view.py
index c93647d0f7..36c6b0e7c5 100644
--- a/netbox_librenms_plugin/tests/test_coverage_sync_view.py
+++ b/netbox_librenms_plugin/tests/test_coverage_sync_view.py
@@ -62,7 +62,8 @@ def test_get_vc_member_always_delegates_to_sync_device(self, mock_get_sync, mock
view._librenms_api = MagicMock()
view._librenms_api.server_key = "default"
- view._librenms_api.get_librenms_id.return_value = 99
+ # Member has no own librenms_id; get_librenms_id returns None after delegation
+ view._librenms_api.get_librenms_id.return_value = None
view.get_context_data = MagicMock(return_value={})
mock_render.return_value = MagicMock()
@@ -151,6 +152,11 @@ def test_vc_context_sync_device_has_id_and_ip(self):
view._librenms_api = MagicMock()
view._librenms_api.server_key = "default"
view._librenms_api.librenms_url = "https://x.example.com"
+ # Explicitly set get_librenms_id return value so sync_device_has_librenms_id
+ # is determined by the patched get_librenms_device_id, not a bare MagicMock.
+ view._librenms_api.get_librenms_id.return_value = 42
+ # Note: production code calls get_librenms_device_id() (module-level function),
+ # not self.librenms_api.get_librenms_id(). The patch below is the correct target.
view.get_librenms_device_info = MagicMock(
return_value={
@@ -205,6 +211,179 @@ def test_vc_context_sync_device_has_id_and_ip(self):
assert ctx.get("sync_device_has_librenms_id") is True
assert ctx.get("sync_device_has_primary_ip") is True
+ def test_vc_context_sync_device_has_no_id(self):
+ """VC device where get_librenms_device_id returns None β sync_device_has_librenms_id is False."""
+ view = _make_view()
+ view.librenms_id = 42
+ view._librenms_lookup_device = MagicMock()
+
+ obj = MagicMock()
+ obj.virtual_chassis = MagicMock()
+ obj._meta = MagicMock()
+ obj._meta.model_name = "device"
+
+ sync_device = MagicMock()
+ sync_device.primary_ip = None # also no IP
+ sync_device._meta.model_name = "device"
+ sync_device.pk = 10
+
+ view._librenms_api = MagicMock()
+ view._librenms_api.server_key = "default"
+ view._librenms_api.librenms_url = "https://x.example.com"
+ # Explicitly set to None so sync_device_has_librenms_id computes as False
+ # (determined by the patched get_librenms_device_id returning None below).
+ view._librenms_api.get_librenms_id.return_value = None
+
+ view.get_librenms_device_info = MagicMock(
+ return_value={
+ "found_in_librenms": False,
+ "librenms_device_details": {
+ "librenms_device_serial": "",
+ "librenms_device_hardware": "-",
+ "librenms_device_os": "-",
+ "librenms_device_version": "-",
+ "librenms_device_features": "-",
+ "librenms_device_location": "-",
+ "librenms_device_hardware_match": None,
+ "vc_inventory_serials": [],
+ },
+ "mismatched_device": False,
+ }
+ )
+ view.get_interface_context = MagicMock(return_value=None)
+ view.get_cable_context = MagicMock(return_value=None)
+ view.get_ip_context = MagicMock(return_value=None)
+ view.get_vlan_context = MagicMock(return_value=None)
+
+ with patch("netbox_librenms_plugin.views.base.librenms_sync_view.get_librenms_sync_device") as mock_sync:
+ mock_sync.return_value = sync_device
+ with patch("netbox_librenms_plugin.views.base.librenms_sync_view.get_librenms_device_id") as mock_id:
+ mock_id.return_value = None # No ID β flag should be False
+ with patch(
+ "netbox_librenms_plugin.views.base.librenms_sync_view.get_interface_name_field",
+ return_value="ifName",
+ ):
+ with patch(
+ "netbox_librenms_plugin.views.base.librenms_sync_view.BaseLibreNMSSyncView._build_all_server_mappings",
+ return_value=None,
+ ):
+ with patch(
+ "netbox_librenms_plugin.views.base.librenms_sync_view.BaseLibreNMSSyncView._get_platform_info",
+ return_value={},
+ ):
+ with patch("netbox_librenms_plugin.views.base.librenms_sync_view.AddToLIbreSNMPV1V2"):
+ with patch("netbox_librenms_plugin.views.base.librenms_sync_view.AddToLIbreSNMPV3"):
+ with patch("dcim.models.Manufacturer") as MockMfr:
+ MockMfr.objects.all.return_value.order_by.return_value = []
+ with patch.object(view, "get_context_data", wraps=view.get_context_data):
+ with patch(
+ "netbox_librenms_plugin.views.base.librenms_sync_view.LibreNMSAPIMixin.get_context_data",
+ return_value={},
+ ):
+ ctx = view.get_context_data(MagicMock(), obj)
+
+ assert ctx.get("is_vc_member") is True
+ assert ctx.get("sync_device_has_librenms_id") is False
+ assert ctx.get("sync_device_has_primary_ip") is False
+
+
+class TestContextAllTabsPresent:
+ """Regression coverage for sync-tab context keys."""
+
+ def test_get_context_data_contains_all_sync_tabs(self):
+ """Context always exposes all tab keys, including module_sync."""
+ view = _make_view()
+ view.librenms_id = 42
+
+ obj = MagicMock()
+ obj.virtual_chassis = None
+ obj._meta = MagicMock()
+ obj._meta.model_name = "device"
+ obj.pk = 1
+ obj.cf = {"librenms_id": {"default": 42}}
+
+ interface_ctx = MagicMock()
+ cable_ctx = MagicMock()
+ ip_ctx = MagicMock()
+ vlan_ctx = MagicMock()
+ module_ctx = MagicMock()
+
+ view.get_librenms_device_info = MagicMock(
+ return_value={
+ "found_in_librenms": True,
+ "librenms_device_details": {
+ "librenms_device_serial": "SN001",
+ "librenms_device_hardware": "Cisco",
+ "librenms_device_os": "ios",
+ "librenms_device_version": "16.9",
+ "librenms_device_features": "-",
+ "librenms_device_location": "NYC",
+ "librenms_device_hardware_match": None,
+ "vc_inventory_serials": [],
+ },
+ "mismatched_device": False,
+ }
+ )
+ view.get_interface_context = MagicMock(return_value=interface_ctx)
+ view.get_cable_context = MagicMock(return_value=cable_ctx)
+ view.get_ip_context = MagicMock(return_value=ip_ctx)
+ view.get_vlan_context = MagicMock(return_value=vlan_ctx)
+ view.get_module_context = MagicMock(return_value=module_ctx)
+
+ with patch(
+ "netbox_librenms_plugin.views.base.librenms_sync_view.LibreNMSAPIMixin.get_context_data",
+ return_value={},
+ ):
+ with patch(
+ "netbox_librenms_plugin.views.base.librenms_sync_view.get_interface_name_field", return_value="ifName"
+ ):
+ with patch(
+ "netbox_librenms_plugin.views.base.librenms_sync_view.BaseLibreNMSSyncView._get_platform_info",
+ return_value={},
+ ):
+ with patch("netbox_librenms_plugin.views.base.librenms_sync_view.AddToLIbreSNMPV1V2"):
+ with patch("netbox_librenms_plugin.views.base.librenms_sync_view.AddToLIbreSNMPV3"):
+ with patch("dcim.models.Manufacturer") as MockMfr:
+ MockMfr.objects.all.return_value.order_by.return_value = []
+ ctx = view.get_context_data(MagicMock(), obj)
+
+ assert "interface_sync" in ctx
+ assert "cable_sync" in ctx
+ assert "ip_sync" in ctx
+ assert "vlan_sync" in ctx
+ assert "module_sync" in ctx
+ assert ctx["interface_sync"] is interface_ctx
+ assert ctx["module_sync"] is module_ctx
+
+
+class TestModuleContextDefaults:
+ """Tests for module-context defaults and concrete overrides."""
+
+ def test_module_sync_is_none_when_not_overridden(self):
+ from netbox_librenms_plugin.views.object_sync.vms import VMLibreNMSSyncView
+
+ base_view = _make_view()
+ assert base_view.get_module_context(MagicMock(), MagicMock()) is None
+
+ vm_view = object.__new__(VMLibreNMSSyncView)
+ assert vm_view.get_module_context(MagicMock(), MagicMock()) is None
+
+ def test_device_view_module_context_is_non_none(self):
+ from netbox_librenms_plugin.views.object_sync.devices import DeviceLibreNMSSyncView
+
+ request = MagicMock()
+ obj = MagicMock()
+ view = object.__new__(DeviceLibreNMSSyncView)
+
+ with patch(
+ "netbox_librenms_plugin.views.object_sync.devices.DeviceModuleTableView.get_context_data",
+ return_value={"modules": []},
+ ) as mock_get_context:
+ result = view.get_module_context(request, obj)
+
+ assert result == {"modules": []}
+ mock_get_context.assert_called_once()
+
class TestBuildAllServerMappings:
"""Tests for _build_all_server_mappings (lines 181, 193, 200, 207-208)."""
@@ -663,9 +842,10 @@ def test_matching_platform_found(self):
}
}
- with patch("dcim.models.Platform") as MockPlatform:
- MockPlatform.DoesNotExist = type("DoesNotExist", (Exception,), {})
- MockPlatform.objects.get.return_value = mock_platform
+ with patch(
+ "netbox_librenms_plugin.views.base.librenms_sync_view.find_matching_platform",
+ return_value={"found": True, "platform": mock_platform, "match_type": "exact"},
+ ):
result = view._get_platform_info(librenms_info, obj)
assert result["platform_exists"] is True
@@ -683,9 +863,10 @@ def test_platform_does_not_exist(self):
}
}
- with patch("dcim.models.Platform") as MockPlatform:
- MockPlatform.DoesNotExist = type("DoesNotExist", (Exception,), {})
- MockPlatform.objects.get.side_effect = MockPlatform.DoesNotExist()
+ with patch(
+ "netbox_librenms_plugin.views.base.librenms_sync_view.find_matching_platform",
+ return_value={"found": False, "platform": None, "match_type": None},
+ ):
result = view._get_platform_info(librenms_info, obj)
assert result["platform_exists"] is False
diff --git a/netbox_librenms_plugin/tests/test_coverage_sync_views.py b/netbox_librenms_plugin/tests/test_coverage_sync_views.py
index 042bceb916..552b67e252 100644
--- a/netbox_librenms_plugin/tests/test_coverage_sync_views.py
+++ b/netbox_librenms_plugin/tests/test_coverage_sync_views.py
@@ -549,53 +549,61 @@ def test_vm_type_fetches_vm(self):
result = view.get_object(5, "virtualmachine")
assert result is mock_vm
- def test_no_type_tries_device_first(self):
- from netbox_librenms_plugin.views.sync.devices import AddDeviceToLibreNMSView
+ def test_device_type_fetches_device(self):
+ from netbox_librenms_plugin.views.sync.devices import AddDeviceToLibreNMSView, Device
view = _make_view(AddDeviceToLibreNMSView)
mock_device = MagicMock()
- with patch("netbox_librenms_plugin.views.sync.devices.Device") as mock_dev_cls:
- mock_dev_cls.objects.get.return_value = mock_device
- mock_dev_cls.DoesNotExist = Exception
- result = view.get_object(1)
+ with patch("netbox_librenms_plugin.views.sync.devices.get_object_or_404", return_value=mock_device) as mock_get:
+ result = view.get_object(1, "device")
assert result is mock_device
+ mock_get.assert_called_once_with(Device, pk=1)
- def test_device_not_found_falls_back_to_vm(self):
- from dcim.models import Device
+class TestAddDeviceToLibreNMSViewPost:
+ def test_permission_denied_returns_early(self):
from netbox_librenms_plugin.views.sync.devices import AddDeviceToLibreNMSView
view = _make_view(AddDeviceToLibreNMSView)
- mock_vm = MagicMock()
- with patch("netbox_librenms_plugin.views.sync.devices.Device") as mock_dev_cls:
- mock_dev_cls.DoesNotExist = Device.DoesNotExist
- mock_dev_cls.objects.get.side_effect = Device.DoesNotExist
- with patch("netbox_librenms_plugin.views.sync.devices.get_object_or_404", return_value=mock_vm):
- result = view.get_object(1)
- assert result is mock_vm
+ view.request = _make_request({"object_type": "device"})
+ mock_obj = MagicMock()
+ mock_error = MagicMock()
+ # Perm check now runs after the object is resolved so the mixin can
+ # build the right object-permission set (Device vs VirtualMachine).
+ with patch.object(view, "get_object", return_value=mock_obj):
+ with patch.object(view, "require_all_permissions", return_value=mock_error) as mock_perm:
+ result = view.post(view.request, object_id=1)
+ assert result is mock_error
+ mock_perm.assert_called_once_with("POST")
+ # Exactly one model in the dynamically-set required_object_permissions.
+ from dcim.models import Device
+ assert view.required_object_permissions == {"POST": [("change", Device)]}
-class TestAddDeviceToLibreNMSViewPost:
- def test_permission_denied_returns_early(self):
+ def test_invalid_object_type_returns_400_without_perm_check(self):
+ """Bad client input (missing/unknown object_type) must surface a 400 immediately,
+ without triggering the permission check β there's no model to check against yet."""
from netbox_librenms_plugin.views.sync.devices import AddDeviceToLibreNMSView
view = _make_view(AddDeviceToLibreNMSView)
- mock_error = MagicMock()
- with patch.object(view, "require_write_permission", return_value=mock_error):
- result = view.post(view.request, object_id=1)
- assert result is mock_error
+ view.request = _make_request({"object_type": "bogus"})
+ with patch.object(view, "get_object", return_value=None):
+ with patch.object(view, "require_all_permissions") as mock_perm:
+ response = view.post(view.request, object_id=1)
+ assert response.status_code == 400
+ mock_perm.assert_not_called()
def test_form_invalid_shows_error_and_redirects(self):
from netbox_librenms_plugin.views.sync.devices import AddDeviceToLibreNMSView
view = _make_view(AddDeviceToLibreNMSView)
- view.request = _make_request({"v1v2-snmp_version": "v2c", "snmp_version": "v2c"})
+ view.request = _make_request({"v1v2-snmp_version": "v2c", "snmp_version": "v2c", "object_type": "device"})
mock_obj = MagicMock()
mock_obj.get_absolute_url.return_value = "/dcim/devices/1/"
mock_form = MagicMock()
mock_form.is_valid.return_value = False
mock_form.errors.items.return_value = [("hostname", ["This field is required."])]
- with patch.object(view, "require_write_permission", return_value=None):
+ with patch.object(view, "require_all_permissions", return_value=None):
with patch.object(view, "get_object", return_value=mock_obj):
with patch.object(view, "get_form_class", return_value=MagicMock(return_value=mock_form)):
with patch("netbox_librenms_plugin.views.sync.devices.messages") as mock_msg:
@@ -608,13 +616,13 @@ def test_form_valid_injects_snmp_version_for_v2c(self):
from netbox_librenms_plugin.views.sync.devices import AddDeviceToLibreNMSView
view = _make_view(AddDeviceToLibreNMSView)
- view.request = _make_request({"v1v2-snmp_version": "v2c"})
+ view.request = _make_request({"v1v2-snmp_version": "v2c", "object_type": "device"})
mock_obj = MagicMock()
mock_obj.get_absolute_url.return_value = "/dcim/devices/1/"
mock_form = MagicMock()
mock_form.is_valid.return_value = True
mock_form.cleaned_data = {}
- with patch.object(view, "require_write_permission", return_value=None):
+ with patch.object(view, "require_all_permissions", return_value=None):
with patch.object(view, "get_object", return_value=mock_obj):
with patch.object(view, "get_form_class", return_value=MagicMock(return_value=mock_form)):
with patch.object(view, "form_valid", return_value=MagicMock()):
diff --git a/netbox_librenms_plugin/tests/test_coverage_sync_views2.py b/netbox_librenms_plugin/tests/test_coverage_sync_views2.py
index e484babb10..12bc5464d7 100644
--- a/netbox_librenms_plugin/tests/test_coverage_sync_views2.py
+++ b/netbox_librenms_plugin/tests/test_coverage_sync_views2.py
@@ -117,7 +117,7 @@ def test_valid_cable_created(self):
view = object.__new__(SyncCablesView)
view.require_all_permissions = MagicMock(return_value=None)
- view.request = _make_request(post_data={"select": ["port1"]})
+ view.request = _make_request(post_data={"select": ["port1"], "device_selection_port1": "1"})
view.get_cache_key = MagicMock(return_value="key")
view._post_server_key = "default"
@@ -139,17 +139,18 @@ def test_valid_cable_created(self):
patch("netbox_librenms_plugin.views.sync.cables.reverse", return_value="/sync/"),
patch("netbox_librenms_plugin.views.sync.cables.Cable") as mock_cable_cls,
patch("netbox_librenms_plugin.views.sync.cables.Interface") as mock_iface_cls,
- patch("netbox_librenms_plugin.views.sync.cables.transaction"),
patch("netbox_librenms_plugin.views.sync.cables.ContentType") as mock_ct,
+ patch("netbox_librenms_plugin.views.sync.cables.transaction"),
patch.object(
type(view), "librenms_api", new_callable=lambda: property(lambda s: MagicMock(server_key="default"))
),
):
- mock_ct.objects.get_for_model.return_value = MagicMock()
mock_cache.get.return_value = {"links": [link_data]}
- local_iface.device_id = mock_device.id # match device_id to skip VC re-lookup
+ local_iface = MagicMock(pk=10)
+ local_iface.device_id = 1 # match selected_device_id ("1") to skip VC re-lookup
mock_iface_cls.objects.get.side_effect = [local_iface, remote_iface]
mock_cable_cls.objects.filter.return_value.exists.return_value = False
+ mock_ct.objects.get_for_model.return_value = MagicMock()
view.post(view.request, pk=1)
@@ -168,6 +169,7 @@ def test_duplicate_cable_shows_warning(self):
view._post_server_key = "default"
mock_device = MagicMock(pk=1)
+ mock_device.id = 1 # ensure id matches device_id on iface to skip VC branch
link_data = {
"local_port_id": "port1",
"local_port": "Gi0/1",
@@ -183,19 +185,19 @@ def test_duplicate_cable_shows_warning(self):
patch("netbox_librenms_plugin.views.sync.cables.reverse", return_value="/sync/"),
patch("netbox_librenms_plugin.views.sync.cables.Cable") as mock_cable_cls,
patch("netbox_librenms_plugin.views.sync.cables.Interface") as mock_iface_cls,
- patch("netbox_librenms_plugin.views.sync.cables.transaction"),
patch("netbox_librenms_plugin.views.sync.cables.ContentType") as mock_ct,
+ patch("netbox_librenms_plugin.views.sync.cables.transaction"),
patch.object(
type(view), "librenms_api", new_callable=lambda: property(lambda s: MagicMock(server_key="default"))
),
):
- mock_ct.objects.get_for_model.return_value = MagicMock()
mock_cache.get.return_value = {"links": [link_data]}
local_iface = MagicMock(pk=10)
- local_iface.device_id = mock_device.id # match device_id to skip VC re-lookup
+ local_iface.device_id = 1 # match the device pk to skip VC branch
remote_iface = MagicMock(pk=20)
mock_iface_cls.objects.get.side_effect = [local_iface, remote_iface]
mock_cable_cls.objects.filter.return_value.exists.return_value = True
+ mock_ct.objects.get_for_model.return_value = MagicMock()
view.post(view.request, pk=1)
@@ -431,8 +433,8 @@ def test_check_existing_cable(self):
patch("netbox_librenms_plugin.views.sync.cables.Cable") as mock_cable_cls,
patch("netbox_librenms_plugin.views.sync.cables.ContentType") as mock_ct,
):
- mock_ct.objects.get_for_model.return_value = MagicMock()
mock_cable_cls.objects.filter.return_value.exists.return_value = True
+ mock_ct.objects.get_for_model.return_value = MagicMock()
result = view.check_existing_cable(local, remote)
assert result is True
@@ -467,10 +469,12 @@ def test_permission_denied_returns_early(self):
from netbox_librenms_plugin.views.sync.devices import AddDeviceToLibreNMSView
view = object.__new__(AddDeviceToLibreNMSView)
- view.require_write_permission = MagicMock(return_value=_denied_response())
- view.request = _make_request(post_data={"snmp_version": "v2c"})
-
- result = view.post(view.request, object_id=1)
+ view.require_all_permissions = MagicMock(return_value=_denied_response())
+ view.request = _make_request(post_data={"snmp_version": "v2c", "object_type": "device"})
+ # Permission check now runs after object resolution, so the get_object
+ # lookup must be stubbed out to reach it.
+ with patch.object(view, "get_object", return_value=MagicMock()):
+ result = view.post(view.request, object_id=1)
assert result.status_code == 403
@@ -479,7 +483,7 @@ def test_invalid_form_shows_errors(self):
from netbox_librenms_plugin.views.sync.devices import AddDeviceToLibreNMSView
view = object.__new__(AddDeviceToLibreNMSView)
- view.require_write_permission = MagicMock(return_value=None)
+ view.require_all_permissions = MagicMock(return_value=None)
mock_device = MagicMock()
mock_device.get_absolute_url.return_value = "/device/1/"
@@ -490,6 +494,7 @@ def test_invalid_form_shows_errors(self):
patch("netbox_librenms_plugin.views.sync.devices.Device") as mock_device_cls,
patch("netbox_librenms_plugin.views.sync.devices.messages") as mock_msgs,
patch("netbox_librenms_plugin.views.sync.devices.redirect"),
+ patch("netbox_librenms_plugin.forms._get_librenms_poller_group_choices", return_value=[]),
):
mock_device_cls.objects.get.return_value = mock_device
view.request = _make_request(post_data=post_data)
@@ -498,8 +503,8 @@ def test_invalid_form_shows_errors(self):
# Provide an invalid form (missing required hostname)
view.post(view.request, object_id=1)
- # Should show form errors
- assert mock_msgs.error.call_count >= 0 # form validation may or may not find errors
+ # Should show form errors (hostname and community are required)
+ assert mock_msgs.error.call_count >= 1
class TestAddDeviceToLibreNMSViewFormValid:
@@ -507,7 +512,7 @@ def test_valid_v2c_form_calls_api(self):
from netbox_librenms_plugin.views.sync.devices import AddDeviceToLibreNMSView
view = object.__new__(AddDeviceToLibreNMSView)
- view.require_write_permission = MagicMock(return_value=None)
+ view.require_all_permissions = MagicMock(return_value=None)
mock_device = MagicMock()
mock_device.get_absolute_url.return_value = "/device/1/"
@@ -553,7 +558,7 @@ def test_valid_form_with_transport_and_pam(self):
from netbox_librenms_plugin.views.sync.devices import AddDeviceToLibreNMSView
view = object.__new__(AddDeviceToLibreNMSView)
- view.require_write_permission = MagicMock(return_value=None)
+ view.require_all_permissions = MagicMock(return_value=None)
mock_device = MagicMock()
mock_device.get_absolute_url.return_value = "/device/1/"
@@ -597,7 +602,7 @@ def test_invalid_poller_group_ignored(self):
from netbox_librenms_plugin.views.sync.devices import AddDeviceToLibreNMSView
view = object.__new__(AddDeviceToLibreNMSView)
- view.require_write_permission = MagicMock(return_value=None)
+ view.require_all_permissions = MagicMock(return_value=None)
mock_device = MagicMock()
mock_device.get_absolute_url.return_value = "/device/1/"
@@ -641,7 +646,7 @@ def test_v3_form_submits_v3_data(self):
from netbox_librenms_plugin.views.sync.devices import AddDeviceToLibreNMSView
view = object.__new__(AddDeviceToLibreNMSView)
- view.require_write_permission = MagicMock(return_value=None)
+ view.require_all_permissions = MagicMock(return_value=None)
view.request = _make_request()
mock_device = MagicMock()
@@ -689,7 +694,7 @@ def test_unknown_snmp_version_shows_error(self):
from netbox_librenms_plugin.views.sync.devices import AddDeviceToLibreNMSView
view = object.__new__(AddDeviceToLibreNMSView)
- view.require_write_permission = MagicMock(return_value=None)
+ view.require_all_permissions = MagicMock(return_value=None)
mock_device = MagicMock()
mock_device.get_absolute_url.return_value = "/device/1/"
@@ -755,23 +760,29 @@ def test_get_object_virtualmachine(self):
result = view.get_object(5, object_type="virtualmachine")
assert result is mock_vm
- def test_get_object_device_not_found_falls_back_to_vm(self):
+ def test_get_object_returns_none_for_missing_object_type(self):
+ """Missing object_type now returns None (caller turns it into HTTP 400)."""
from netbox_librenms_plugin.views.sync.devices import AddDeviceToLibreNMSView
view = object.__new__(AddDeviceToLibreNMSView)
- mock_vm = MagicMock()
+ assert view.get_object(5) is None
+ assert view.get_object(5, object_type="bogus") is None
- class _DNE(Exception):
- pass
+ def test_get_object_raises_http404_when_device_not_found(self):
+ from django.http import Http404
- with (
- patch("netbox_librenms_plugin.views.sync.devices.Device") as mock_dev_cls,
- patch("netbox_librenms_plugin.views.sync.devices.get_object_or_404", return_value=mock_vm),
+ from netbox_librenms_plugin.views.sync.devices import AddDeviceToLibreNMSView
+
+ view = object.__new__(AddDeviceToLibreNMSView)
+
+ import pytest
+
+ with patch(
+ "netbox_librenms_plugin.views.sync.devices.get_object_or_404",
+ side_effect=Http404,
):
- mock_dev_cls.DoesNotExist = _DNE
- mock_dev_cls.objects.get.side_effect = _DNE()
- result = view.get_object(5)
- assert result is mock_vm
+ with pytest.raises(Http404):
+ view.get_object(5, object_type="device")
def test_form_valid_with_poller_group(self):
"""poller_group valid int is passed to API."""
@@ -1494,8 +1505,11 @@ def test_vlan_created_in_group(self):
view.request = _make_request(post_data={"action": "create_vlans", "select": ["200"], "vlan_group_200": "3"})
view.post(view.request, object_type="device", object_id=1)
- call_kwargs = mock_vlan_cls.objects.get_or_create.call_args[1]
- assert call_kwargs.get("group") is mock_vlan_group or mock_vlan_cls.objects.get_or_create.called
+ mock_vlan_cls.objects.get_or_create.assert_called_once_with(
+ vid=200,
+ group=mock_vlan_group,
+ defaults={"name": "Production", "status": "active"},
+ )
def test_invalid_vlan_group_id_falls_back_to_global(self):
from netbox_librenms_plugin.views.sync.vlans import SyncVLANsView
diff --git a/netbox_librenms_plugin/tests/test_coverage_utils.py b/netbox_librenms_plugin/tests/test_coverage_utils.py
index b190a747f9..5f0fa2e003 100644
--- a/netbox_librenms_plugin/tests/test_coverage_utils.py
+++ b/netbox_librenms_plugin/tests/test_coverage_utils.py
@@ -451,22 +451,33 @@ def test_multiple_objects_returned_uses_first(self):
class TestFindMatchingPlatformMultipleReturned:
"""Tests for find_matching_platform MultipleObjectsReturned (lines 358-360)."""
- def test_multiple_objects_returned_uses_first(self):
+ def test_multiple_objects_returned_returns_ambiguous(self):
from netbox_librenms_plugin.utils import find_matching_platform
- mock_platform = MagicMock()
Platform_DoesNotExist = type("DoesNotExist", (Exception,), {})
Platform_MultipleObjectsReturned = type("MultipleObjectsReturned", (Exception,), {})
-
- with patch("dcim.models.Platform") as MockPlatform:
- MockPlatform.DoesNotExist = Platform_DoesNotExist
- MockPlatform.MultipleObjectsReturned = Platform_MultipleObjectsReturned
- MockPlatform.objects.get.side_effect = Platform_MultipleObjectsReturned("multiple")
- MockPlatform.objects.filter.return_value.first.return_value = mock_platform
-
- result = find_matching_platform("ios")
- assert result["found"] is True
- assert result["platform"] is mock_platform
+ PlatformMapping_DoesNotExist = type("DoesNotExist", (Exception,), {})
+
+ with patch("netbox_librenms_plugin.models.PlatformMapping") as MockPlatformMapping:
+ MockPlatformMapping.DoesNotExist = PlatformMapping_DoesNotExist
+ MockPlatformMapping.objects.get.side_effect = PlatformMapping_DoesNotExist("no mapping")
+
+ with patch("dcim.models.Platform") as MockPlatform:
+ MockPlatform.DoesNotExist = Platform_DoesNotExist
+ MockPlatform.MultipleObjectsReturned = Platform_MultipleObjectsReturned
+ MockPlatform.objects.get.side_effect = Platform_MultipleObjectsReturned("multiple")
+
+ result = find_matching_platform("ios")
+ assert result["found"] is False
+ assert result["platform"] is None
+ assert result["match_type"] == "ambiguous"
+ assert result["ambiguity_source"] == "platform"
+ # Per the fix for the "PlatformMapping never consulted" CodeRabbit
+ # finding: when Platform.MultipleObjectsReturned fires, the function
+ # now defers the ambiguity decision and consults PlatformMapping
+ # first so an explicit override can disambiguate. Only when the
+ # mapping also misses do we surface ambiguous(platform).
+ MockPlatformMapping.objects.get.assert_called_once_with(librenms_os__iexact="ios")
class TestGetMissingVlanWarning:
@@ -549,3 +560,128 @@ def test_none_id_returns_none_without_query(self):
result = find_by_librenms_id(model, None, server_key="default")
assert result is None
model.objects.filter.assert_not_called()
+
+
+class TestNetboxResolvesModuleTokenPerLeaf:
+ """Version-gating helper for {module} token resolution behaviour (NetBox #20467)."""
+
+ def test_returns_true_for_4_5_6(self):
+ from netbox_librenms_plugin import utils
+
+ with patch.object(utils, "_get_netbox_version_tuple", return_value=(4, 5, 6)):
+ assert utils.netbox_resolves_module_token_per_leaf() is True
+
+ def test_returns_true_for_4_6_0(self):
+ from netbox_librenms_plugin import utils
+
+ with patch.object(utils, "_get_netbox_version_tuple", return_value=(4, 6, 0)):
+ assert utils.netbox_resolves_module_token_per_leaf() is True
+
+ def test_returns_false_for_4_5_5(self):
+ from netbox_librenms_plugin import utils
+
+ with patch.object(utils, "_get_netbox_version_tuple", return_value=(4, 5, 5)):
+ assert utils.netbox_resolves_module_token_per_leaf() is False
+
+ def test_returns_false_for_4_4_10(self):
+ from netbox_librenms_plugin import utils
+
+ with patch.object(utils, "_get_netbox_version_tuple", return_value=(4, 4, 10)):
+ assert utils.netbox_resolves_module_token_per_leaf() is False
+
+ def test_returns_true_when_version_undetectable(self):
+ """Permissive default: avoid false positives on unknown versions."""
+ from netbox_librenms_plugin import utils
+
+ with patch.object(utils, "_get_netbox_version_tuple", return_value=None):
+ assert utils.netbox_resolves_module_token_per_leaf() is True
+
+
+class TestHasNestedNameConflictVersionGating:
+ """has_nested_name_conflict() must short-circuit on NetBox >= 4.5.6 (issue #20467)."""
+
+ def _build_args(self, with_module_token=True):
+ """Build (module_type, module_bay, sibling_counts) that would trigger
+ the legacy conflict (nested bay, sibling exists, {module} in template)."""
+ template = MagicMock()
+ template.name = "{module}" if with_module_token else "Gi0/1"
+ module_type = MagicMock()
+ module_type.model = "X2-10GB-LR"
+ module_type.interfacetemplates.all.return_value = [template]
+
+ module_bay = MagicMock()
+ module_bay.module_id = 820
+ module_bay.device = MagicMock()
+
+ sibling_counts = {820: 8}
+ return module_type, module_bay, sibling_counts
+
+ def test_skipped_on_supported_netbox(self):
+ from netbox_librenms_plugin import utils
+
+ module_type, module_bay, sibling_counts = self._build_args()
+ with patch.object(utils, "netbox_resolves_module_token_per_leaf", return_value=True):
+ result = utils.has_nested_name_conflict(module_type, module_bay, sibling_counts)
+ assert result == ""
+
+ def test_warns_on_old_netbox(self):
+ from netbox_librenms_plugin import utils
+
+ module_type, module_bay, sibling_counts = self._build_args()
+ with patch.object(utils, "netbox_resolves_module_token_per_leaf", return_value=False):
+ result = utils.has_nested_name_conflict(module_type, module_bay, sibling_counts)
+ assert result != ""
+ assert "X2-10GB-LR" in result
+ assert "4.5.6" in result
+ assert "20467" in result
+
+ def test_old_netbox_no_module_token_no_conflict(self):
+ from netbox_librenms_plugin import utils
+
+ module_type, module_bay, sibling_counts = self._build_args(with_module_token=False)
+ with patch.object(utils, "netbox_resolves_module_token_per_leaf", return_value=False):
+ result = utils.has_nested_name_conflict(module_type, module_bay, sibling_counts)
+ assert result == ""
+
+ def test_old_netbox_top_level_bay_no_conflict(self):
+ from netbox_librenms_plugin import utils
+
+ module_type, module_bay, sibling_counts = self._build_args()
+ module_bay.module_id = None
+ with patch.object(utils, "netbox_resolves_module_token_per_leaf", return_value=False):
+ result = utils.has_nested_name_conflict(module_type, module_bay, sibling_counts)
+ assert result == ""
+
+ def test_old_netbox_single_sibling_no_conflict(self):
+ from netbox_librenms_plugin import utils
+
+ module_type, module_bay, sibling_counts = self._build_args()
+ sibling_counts = {820: 1}
+ with patch.object(utils, "netbox_resolves_module_token_per_leaf", return_value=False):
+ result = utils.has_nested_name_conflict(module_type, module_bay, sibling_counts)
+ assert result == ""
+
+
+class TestGetNetboxVersionTuple:
+ """Parse netbox.settings.RELEASE.version into a comparable tuple."""
+
+ def test_parses_standard_version(self):
+ from netbox_librenms_plugin import utils
+
+ fake_release = MagicMock(version="4.5.8")
+ with patch("netbox.settings.RELEASE", fake_release):
+ assert utils._get_netbox_version_tuple() == (4, 5, 8)
+
+ def test_strips_build_suffix(self):
+ from netbox_librenms_plugin import utils
+
+ fake_release = MagicMock(version="4.5.8-Docker-4.0.2")
+ with patch("netbox.settings.RELEASE", fake_release):
+ assert utils._get_netbox_version_tuple() == (4, 5, 8)
+
+ def test_returns_none_on_unparseable(self):
+ from netbox_librenms_plugin import utils
+
+ fake_release = MagicMock(version="not-a-version")
+ with patch("netbox.settings.RELEASE", fake_release):
+ assert utils._get_netbox_version_tuple() is None
diff --git a/netbox_librenms_plugin/tests/test_import_utils.py b/netbox_librenms_plugin/tests/test_import_utils.py
index db0f70f079..89d1cde680 100644
--- a/netbox_librenms_plugin/tests/test_import_utils.py
+++ b/netbox_librenms_plugin/tests/test_import_utils.py
@@ -1723,11 +1723,22 @@ def device_filter(*args, **kwargs):
assert result["existing_match_type"] == "serial"
assert "not linked to LibreNMS" in result["warnings"][0]
- def test_serial_match_diff_hostname_offers_hostname_differs(self):
- """Serial matches but hostname differs offers hostname_differs action."""
+ def test_serial_match_diff_hostname_offers_role_choice(self):
+ """Serial matches but hostname differs offers a host/OOB role choice toggle.
+
+ Previously this returned `hostname_differs`. With the role-toggle work
+ (see device_validation_details.html + device_operations.py refactor),
+ when an existing NetBox device matches by serial but the names differ
+ AND neither host nor OOB role is conclusively chosen by the heuristic,
+ we now expose both `oob_candidate` and `promote_to_host` data blocks
+ and surface a role-choice toggle in the UI. Default action is
+ `oob_candidate` (least destructive).
+ """
existing = MagicMock()
existing.name = "old-hostname"
existing.serial = "ABC123"
+ existing.pk = 7
+ existing.custom_field_data = {}
self.mock_vm.objects.filter.return_value.first.return_value = None
@@ -1746,9 +1757,9 @@ def device_filter(*args, **kwargs):
device_data = {"device_id": 1, "hostname": "new-hostname", "serial": "ABC123"}
result = validate_device_for_import(device_data, include_vc_detection=False)
- assert result["serial_action"] == "hostname_differs"
+ assert result["serial_action"] == "oob_candidate"
assert result["existing_match_type"] == "serial"
- assert "hostname differs" in result["warnings"][0]
+ assert result.get("oob_candidate") is not None
def test_hostname_match_diff_serial_offers_update(self):
"""Hostname matches but serial differs offers update_serial action."""
@@ -2847,8 +2858,8 @@ def test_update_skips_dash_serial(self, mock_cache_key, mock_cache):
# Serial should NOT be updated to '-'
assert existing_device.serial == "EXISTING"
- def test_missing_action_returns_400(self):
- """Missing action or existing_device_id should return 400."""
+ def test_missing_action_returns_hx_noswap_response(self):
+ """Missing action or existing_device_id returns 200 with HX-Reswap=none."""
view = self._create_view()
request = MagicMock()
request.user.has_perm.return_value = True
@@ -2856,10 +2867,11 @@ def test_missing_action_returns_400(self):
view.request = request
response = view.post(request, device_id=10)
- assert response.status_code == 400
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
- def test_unknown_action_returns_400(self):
- """Unknown action should return 400."""
+ def test_unknown_action_returns_hx_noswap_response(self):
+ """Unknown action returns 200 with HX-Reswap=none."""
from netbox_librenms_plugin.views.imports.actions import DeviceConflictActionView
view = self._create_view()
@@ -2884,7 +2896,8 @@ def test_unknown_action_returns_400(self):
view.request = request
response = view.post(request, device_id=10)
- assert response.status_code == 400
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
@patch("netbox_librenms_plugin.views.imports.actions.cache")
@patch("netbox_librenms_plugin.views.imports.actions.get_import_device_cache_key")
@@ -2929,8 +2942,8 @@ def test_sync_name_action_updates_name(self, mock_cache_key, mock_cache):
@patch("netbox_librenms_plugin.views.imports.actions.cache")
@patch("netbox_librenms_plugin.views.imports.actions.get_import_device_cache_key")
- def test_device_type_mismatch_blocked_without_force(self, mock_cache_key, mock_cache):
- """Action should be blocked when device_type_mismatch is True and force is not set."""
+ def test_device_type_mismatch_blocked_without_force_returns_hx_noswap(self, mock_cache_key, mock_cache):
+ """Blocked mismatch returns 200 with HX-Reswap=none when force is not set."""
from netbox_librenms_plugin.views.imports.actions import DeviceConflictActionView
view = self._create_view()
@@ -2956,7 +2969,8 @@ def test_device_type_mismatch_blocked_without_force(self, mock_cache_key, mock_c
view.request = request
response = view.post(request, device_id=10)
- assert response.status_code == 400
+ assert response.status_code == 200
+ assert response.headers.get("HX-Reswap") == "none"
existing_device.save.assert_not_called()
@patch("netbox_librenms_plugin.views.imports.actions.cache")
diff --git a/netbox_librenms_plugin/tests/test_init.py b/netbox_librenms_plugin/tests/test_init.py
index fe2274fc95..f2c22797e5 100644
--- a/netbox_librenms_plugin/tests/test_init.py
+++ b/netbox_librenms_plugin/tests/test_init.py
@@ -63,6 +63,8 @@ def test_creates_custom_field_when_missing(
"is_cloneable": False,
},
)
+ MockCustomField.objects.using.assert_called_with("default")
+ MockContentType.objects.db_manager.assert_called_with("default")
# Should have added content types for all 4 models
assert mock_cf.object_types.add.call_count == 4
@@ -104,6 +106,8 @@ def test_existing_field_not_recreated(
# All pks already present, no types should be added
mock_cf.object_types.add.assert_not_called()
+ MockCustomField.objects.using.assert_called_with("default")
+ MockContentType.objects.db_manager.assert_called_with("default")
@patch("dcim.models.Interface", new_callable=MagicMock)
@patch("dcim.models.Device", new_callable=MagicMock)
diff --git a/netbox_librenms_plugin/tests/test_integration_virtual_chassis.py b/netbox_librenms_plugin/tests/test_integration_virtual_chassis.py
index a6dd1e98ed..cb89f6f84b 100644
--- a/netbox_librenms_plugin/tests/test_integration_virtual_chassis.py
+++ b/netbox_librenms_plugin/tests/test_integration_virtual_chassis.py
@@ -128,6 +128,9 @@ def test_members_sorted_by_position(self, mock_server):
assert result is not None
positions = [m["position"] for m in result["members"]]
assert positions == [1, 2, 3]
+ # Verify serial/position pairs are correctly associated after sorting
+ member_pairs = [(m["serial"], m["position"]) for m in result["members"]]
+ assert member_pairs == [("SN-1", 1), ("SN-2", 2), ("SN-3", 3)]
def test_position_zero_falls_back_to_idx_plus_one(self, mock_server):
"""position=0 in entPhysicalParentRelPos β fallback to idx+1 (never 0)."""
@@ -154,6 +157,9 @@ def test_position_zero_falls_back_to_idx_plus_one(self, mock_server):
positions = [m["position"] for m in result["members"]]
# Both had position=0, so they fall back to idx+1: positions [1, 2]
assert all(p >= 1 for p in positions)
+ # Verify each fallback position is uniquely paired with its serial
+ member_pairs = [(m["serial"], m["position"]) for m in result["members"]]
+ assert member_pairs == [("SN-X", 1), ("SN-Y", 2)]
def test_member_fields_extracted_correctly(self, mock_server):
"""serial, model, name, description all extracted from chassis entries."""
@@ -852,3 +858,56 @@ def test_all_port_fields_preserved(self, mock_server):
assert port["ifAlias"] == "server-link"
assert port["ifSpeed"] == 1_000_000_000
assert port["ifMtu"] == 9000
+
+
+class TestCrossServerCacheIsolation:
+ """Cache keys are scoped per server_key β data from one server must not bleed into another."""
+
+ def test_different_server_keys_use_isolated_cache_entries(self, mock_server):
+ """Data cached via server-a must not be returned when querying the same device via server-b."""
+ from netbox_librenms_plugin.import_utils.virtual_chassis import get_virtual_chassis_data
+
+ device_id = 300
+
+ api_a = _make_api(mock_server.url, server_key="server-a")
+ api_b = _make_api(mock_server.url, server_key="server-b")
+
+ # Register 2-member VC for server-a path
+ mock_server.device_info_response(device_id=device_id, hostname="sw-server-a")
+ root_items = [_stack_root(index=1)]
+ member_items = [_chassis(100, "SN-A1", position=1), _chassis(200, "SN-A2", position=2)]
+ mock_server.vc_inventory_callable(device_id, root_items, {1: member_items})
+
+ cache_store = {}
+
+ def mock_cache_set(key, val, timeout=None):
+ cache_store[key] = val
+
+ def mock_cache_get(key):
+ return cache_store.get(key)
+
+ with patch("netbox_librenms_plugin.import_utils.virtual_chassis.cache") as mock_cache:
+ mock_cache.get.side_effect = mock_cache_get
+ mock_cache.set.side_effect = mock_cache_set
+ with patch(
+ "netbox_librenms_plugin.import_utils.virtual_chassis._load_vc_member_name_pattern",
+ return_value="{master}-m{position}",
+ ):
+ # Warm cache via server-a
+ result_a = get_virtual_chassis_data(api_a, device_id)
+
+ # Query same device via server-b β cache must miss (different key)
+ result_b = get_virtual_chassis_data(api_b, device_id)
+
+ # server-a result is a 2-member VC
+ assert result_a is not None
+ assert result_a.get("member_count") == 2
+
+ # server-b was registered with the same mock routes, so it also fetches a 2-member VC.
+ # The key assertion is that TWO separate cache entries exist β one per server_key.
+ server_a_keys = [k for k in cache_store if "server-a" in k]
+ server_b_keys = [k for k in cache_store if "server-b" in k]
+ assert len(server_a_keys) >= 1, "server-a cache entry expected"
+ assert len(server_b_keys) >= 1, "server-b cache entry expected"
+ assert server_a_keys[0] != server_b_keys[0], "cache keys must differ between servers"
+ assert result_a is not result_b, "must not return the same cached object for different servers"
diff --git a/netbox_librenms_plugin/tests/test_ip_helpers.py b/netbox_librenms_plugin/tests/test_ip_helpers.py
new file mode 100644
index 0000000000..cde4d30fd4
--- /dev/null
+++ b/netbox_librenms_plugin/tests/test_ip_helpers.py
@@ -0,0 +1,173 @@
+"""
+Tests for netbox_librenms_plugin.import_utils.ip_helpers.
+
+All DB interactions are mocked β no @pytest.mark.django_db used.
+"""
+
+from unittest.mock import MagicMock, patch
+
+
+class TestGetOrCreateGlobalIP:
+ """Tests for ``get_or_create_global_ip``."""
+
+ def test_returns_none_for_empty_string(self):
+ from netbox_librenms_plugin.import_utils.ip_helpers import get_or_create_global_ip
+
+ assert get_or_create_global_ip("") == (None, False)
+ assert get_or_create_global_ip(None) == (None, False)
+ assert get_or_create_global_ip(" ") == (None, False)
+
+ def test_returns_none_for_invalid_ip(self):
+ from netbox_librenms_plugin.import_utils.ip_helpers import get_or_create_global_ip
+
+ assert get_or_create_global_ip("not-an-ip") == (None, False)
+ assert get_or_create_global_ip("192.168.1.999") == (None, False)
+
+ def test_returns_existing_when_present(self):
+ from netbox_librenms_plugin.import_utils.ip_helpers import get_or_create_global_ip
+
+ existing = MagicMock(name="existing-ip")
+ with patch("ipam.models.IPAddress") as mock_model:
+ mock_model.objects.filter.return_value.first.return_value = existing
+
+ result, created = get_or_create_global_ip("10.0.0.1")
+
+ mock_model.objects.filter.assert_called_once_with(address__net_host="10.0.0.1", vrf__isnull=True)
+ mock_model.objects.create.assert_not_called()
+ assert result is existing
+ assert created is False
+
+ def test_creates_ipv4_with_slash32_when_missing(self):
+ from netbox_librenms_plugin.import_utils.ip_helpers import get_or_create_global_ip
+
+ created = MagicMock(name="created-ip")
+ with patch("ipam.models.IPAddress") as mock_model:
+ mock_model.objects.filter.return_value.first.return_value = None
+ mock_model.objects.create.return_value = created
+
+ result, was_created = get_or_create_global_ip("10.0.0.1")
+
+ mock_model.objects.create.assert_called_once_with(address="10.0.0.1/32", status="active")
+ assert result is created
+ assert was_created is True
+
+ def test_creates_ipv6_with_slash128_when_missing(self):
+ from netbox_librenms_plugin.import_utils.ip_helpers import get_or_create_global_ip
+
+ created = MagicMock(name="created-ip-v6")
+ with patch("ipam.models.IPAddress") as mock_model:
+ mock_model.objects.filter.return_value.first.return_value = None
+ mock_model.objects.create.return_value = created
+
+ result, was_created = get_or_create_global_ip("2001:db8::1")
+
+ mock_model.objects.create.assert_called_once_with(address="2001:db8::1/128", status="active")
+ assert result is created
+ assert was_created is True
+
+ def test_strips_whitespace_before_lookup(self):
+ from netbox_librenms_plugin.import_utils.ip_helpers import get_or_create_global_ip
+
+ with patch("ipam.models.IPAddress") as mock_model:
+ mock_model.objects.filter.return_value.first.return_value = None
+ mock_model.objects.create.return_value = MagicMock()
+
+ result, was_created = get_or_create_global_ip(" 10.1.2.3 ")
+
+ mock_model.objects.filter.assert_called_once_with(address__net_host="10.1.2.3", vrf__isnull=True)
+ mock_model.objects.create.assert_called_once_with(address="10.1.2.3/32", status="active")
+ assert was_created is True
+
+ def test_integrity_error_on_create_returns_concurrently_created_record(self):
+ """A concurrent insert that races us is re-fetched and returned."""
+ from django.db import IntegrityError
+
+ from netbox_librenms_plugin.import_utils.ip_helpers import get_or_create_global_ip
+
+ racing_winner = MagicMock(name="racing-winner")
+ with patch("ipam.models.IPAddress") as mock_model:
+ # First filter (pre-create) β None, second filter (post-IntegrityError) β winner.
+ mock_model.objects.filter.return_value.first.side_effect = [None, racing_winner]
+ mock_model.objects.create.side_effect = IntegrityError("duplicate key")
+
+ result, was_created = get_or_create_global_ip("10.0.0.1")
+
+ assert result is racing_winner
+ assert was_created is False
+
+ def test_returns_none_and_logs_when_create_raises(self, caplog):
+ from netbox_librenms_plugin.import_utils.ip_helpers import get_or_create_global_ip
+
+ with patch("ipam.models.IPAddress") as mock_model:
+ mock_model.objects.filter.return_value.first.return_value = None
+ mock_model.objects.create.side_effect = RuntimeError("integrity failure")
+
+ with caplog.at_level("WARNING"):
+ result, was_created = get_or_create_global_ip("10.0.0.1")
+
+ assert result is None
+ assert was_created is False
+ assert any("failed to auto-create" in r.message for r in caplog.records)
+
+ def test_reexported_from_import_utils_package(self):
+ """The helper is re-exported from the package root for convenience."""
+ from netbox_librenms_plugin.import_utils import get_or_create_global_ip as pkg_helper
+ from netbox_librenms_plugin.import_utils.ip_helpers import (
+ get_or_create_global_ip as module_helper,
+ )
+
+ assert pkg_helper is module_helper
+
+
+class TestAutoCreateOptIn:
+ """``auto_create=False`` opt-out and ``auto_create_ipam_enabled()`` helper."""
+
+ def test_auto_create_false_returns_existing(self):
+ from netbox_librenms_plugin.import_utils.ip_helpers import get_or_create_global_ip
+
+ existing = MagicMock(name="existing-ip")
+ with patch("ipam.models.IPAddress") as mock_model:
+ mock_model.objects.filter.return_value.first.return_value = existing
+
+ result, created = get_or_create_global_ip("10.0.0.1", auto_create=False)
+
+ assert result is existing
+ assert created is False
+ mock_model.objects.create.assert_not_called()
+
+ def test_auto_create_false_skips_creation_when_missing(self):
+ from netbox_librenms_plugin.import_utils.ip_helpers import get_or_create_global_ip
+
+ with patch("ipam.models.IPAddress") as mock_model:
+ mock_model.objects.filter.return_value.first.return_value = None
+
+ result, created = get_or_create_global_ip("10.0.0.1", auto_create=False)
+
+ assert result is None
+ assert created is False
+ mock_model.objects.create.assert_not_called()
+
+ def test_auto_create_ipam_enabled_false_when_no_settings(self):
+ from netbox_librenms_plugin.import_utils.ip_helpers import auto_create_ipam_enabled
+
+ with patch("netbox_librenms_plugin.models.LibreNMSSettings") as mock_model:
+ mock_model.objects.first.return_value = None
+ assert auto_create_ipam_enabled() is False
+
+ def test_auto_create_ipam_enabled_reads_field(self):
+ from netbox_librenms_plugin.import_utils.ip_helpers import auto_create_ipam_enabled
+
+ with patch("netbox_librenms_plugin.models.LibreNMSSettings") as mock_model:
+ settings = MagicMock(auto_create_ipam_default=True)
+ mock_model.objects.first.return_value = settings
+ assert auto_create_ipam_enabled() is True
+
+ settings.auto_create_ipam_default = False
+ assert auto_create_ipam_enabled() is False
+
+ def test_auto_create_ipam_enabled_swallows_exceptions(self):
+ from netbox_librenms_plugin.import_utils.ip_helpers import auto_create_ipam_enabled
+
+ with patch("netbox_librenms_plugin.models.LibreNMSSettings") as mock_model:
+ mock_model.objects.first.side_effect = RuntimeError("db down")
+ assert auto_create_ipam_enabled() is False
diff --git a/netbox_librenms_plugin/tests/test_librenms_api.py b/netbox_librenms_plugin/tests/test_librenms_api.py
index 24bc9e9213..e623cc17dc 100644
--- a/netbox_librenms_plugin/tests/test_librenms_api.py
+++ b/netbox_librenms_plugin/tests/test_librenms_api.py
@@ -501,8 +501,10 @@ def test_get_librenms_id_empty_string_falls_through_to_discovery(self, mock_libr
device.cf = {"librenms_id": ""}
device.primary_ip = None
- with patch.object(api, "get_device_id_by_hostname", return_value=None):
- result = api.get_librenms_id(device)
+ with patch("netbox_librenms_plugin.librenms_api.cache") as mock_cache:
+ mock_cache.get.return_value = None
+ with patch.object(api, "get_device_id_by_hostname", return_value=None):
+ result = api.get_librenms_id(device)
assert result is None
@patch("netbox_librenms_plugin.librenms_api.cache")
@@ -1345,3 +1347,380 @@ def test_mixed_bad_entries_no_exception(self, mock_librenms_config):
assert result["tagged_vlans"] == [30]
assert result["untagged_vlan"] is None
+
+
+# ====================================================================================
+# Response-shape regression tests for get_device_transceivers / get_device_info /
+# get_device_vlans / get_port_vlan_details. These guard the malformed-payload
+# branches that were tightened up alongside the inventory/transceiver work.
+# ====================================================================================
+
+
+class TestGetDeviceInfoResponseShape:
+ """Cover response-shape branches in get_device_info()."""
+
+ pytest_plugins = ["netbox_librenms_plugin.tests.test_librenms_api_helpers"]
+
+ @patch("netbox_librenms_plugin.librenms_api.requests.get")
+ def test_non_dict_device_entry_returns_failure(self, mock_get, mock_librenms_config):
+ """A non-dict entry in the devices list must not propagate as truthy data."""
+ mock_get.return_value.status_code = 200
+ mock_get.return_value.json.return_value = {"status": "ok", "devices": ["not-a-dict"]}
+
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ api = LibreNMSAPI(server_key="default")
+ success, data = api.get_device_info(device_id=1)
+
+ assert success is False
+ assert data is None
+
+ @patch("netbox_librenms_plugin.librenms_api.requests.get")
+ def test_missing_devices_key_returns_failure(self, mock_get, mock_librenms_config):
+ """KeyError on missing 'devices' must be caught and return (False, None)."""
+ mock_get.return_value.status_code = 200
+ mock_get.return_value.json.return_value = {"status": "ok"}
+
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ api = LibreNMSAPI(server_key="default")
+ success, data = api.get_device_info(device_id=1)
+
+ assert success is False
+ assert data is None
+
+
+class TestGetDeviceTransceiversResponseShape:
+ """Cover response-shape branches in get_device_transceivers()."""
+
+ pytest_plugins = ["netbox_librenms_plugin.tests.test_librenms_api_helpers"]
+
+ @patch("netbox_librenms_plugin.librenms_api.requests.get")
+ def test_success_returns_transceiver_list(self, mock_get, mock_librenms_config):
+ mock_get.return_value.status_code = 200
+ mock_get.return_value.json.return_value = {
+ "status": "ok",
+ "transceivers": [
+ {"port_id": 1, "type": "QSFP28", "serial": "SN1"},
+ {"port_id": 2, "type": "SFP+", "serial": "SN2"},
+ ],
+ }
+
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ api = LibreNMSAPI(server_key="default")
+ success, data = api.get_device_transceivers(device_id=123)
+
+ assert success is True
+ assert len(data) == 2
+ assert data[0]["serial"] == "SN1"
+
+ @patch("netbox_librenms_plugin.librenms_api.requests.get")
+ def test_invalid_json_returns_failure(self, mock_get, mock_librenms_config):
+ mock_get.return_value.status_code = 200
+ mock_get.return_value.json.side_effect = ValueError("bad json")
+
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ api = LibreNMSAPI(server_key="default")
+ success, msg = api.get_device_transceivers(device_id=123)
+
+ assert success is False
+ assert "Invalid JSON" in msg
+
+ @patch("netbox_librenms_plugin.librenms_api.requests.get")
+ def test_non_dict_response_returns_failure(self, mock_get, mock_librenms_config):
+ mock_get.return_value.status_code = 200
+ mock_get.return_value.json.return_value = ["unexpected", "list"]
+
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ api = LibreNMSAPI(server_key="default")
+ success, msg = api.get_device_transceivers(device_id=123)
+
+ assert success is False
+ assert "Unexpected" in msg
+
+ @patch("netbox_librenms_plugin.librenms_api.requests.get")
+ def test_missing_transceivers_key_uses_server_message(self, mock_get, mock_librenms_config):
+ mock_get.return_value.status_code = 200
+ mock_get.return_value.json.return_value = {"status": "ok", "message": "no transceivers MIB"}
+
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ api = LibreNMSAPI(server_key="default")
+ success, msg = api.get_device_transceivers(device_id=123)
+
+ assert success is False
+ assert msg == "no transceivers MIB"
+
+ @patch("netbox_librenms_plugin.librenms_api.requests.get")
+ def test_status_not_ok_returns_failure(self, mock_get, mock_librenms_config):
+ mock_get.return_value.status_code = 200
+ mock_get.return_value.json.return_value = {
+ "status": "error",
+ "transceivers": [],
+ "message": "device offline",
+ }
+
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ api = LibreNMSAPI(server_key="default")
+ success, msg = api.get_device_transceivers(device_id=123)
+
+ assert success is False
+ assert msg == "device offline"
+
+ @patch("netbox_librenms_plugin.librenms_api.requests.get")
+ def test_transceivers_not_list_returns_failure(self, mock_get, mock_librenms_config):
+ mock_get.return_value.status_code = 200
+ mock_get.return_value.json.return_value = {
+ "status": "ok",
+ "transceivers": {"port_id": 1},
+ }
+
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ api = LibreNMSAPI(server_key="default")
+ success, msg = api.get_device_transceivers(device_id=123)
+
+ assert success is False
+ assert "Unexpected" in msg
+
+ @patch("netbox_librenms_plugin.librenms_api.requests.get")
+ def test_malformed_transceiver_entry_returns_failure(self, mock_get, mock_librenms_config):
+ mock_get.return_value.status_code = 200
+ mock_get.return_value.json.return_value = {
+ "status": "ok",
+ "transceivers": [{"port_id": 1}, None],
+ }
+
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ api = LibreNMSAPI(server_key="default")
+ success, msg = api.get_device_transceivers(device_id=123)
+
+ assert success is False
+ assert "Malformed" in msg
+
+ @patch("netbox_librenms_plugin.librenms_api.requests.get")
+ def test_request_exception_returns_failure(self, mock_get, mock_librenms_config):
+ mock_get.side_effect = requests.exceptions.ConnectionError("boom")
+
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ api = LibreNMSAPI(server_key="default")
+ success, msg = api.get_device_transceivers(device_id=123)
+
+ assert success is False
+ assert "boom" in msg
+
+
+class TestGetDeviceVlansResponseShape:
+ """Cover response-shape branches in get_device_vlans()."""
+
+ pytest_plugins = ["netbox_librenms_plugin.tests.test_librenms_api_helpers"]
+
+ @patch("netbox_librenms_plugin.librenms_api.requests.get")
+ def test_success_filters_by_device_id(self, mock_get, mock_librenms_config):
+ mock_get.return_value.status_code = 200
+ mock_get.return_value.json.return_value = {
+ "status": "ok",
+ "vlans": [
+ {"vlan_id": 1, "device_id": 7, "vlan_vlan": 10, "vlan_name": "DATA"},
+ {"vlan_id": 2, "device_id": 8, "vlan_vlan": 20, "vlan_name": "VOICE"},
+ ],
+ }
+
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ api = LibreNMSAPI(server_key="default")
+ success, vlans = api.get_device_vlans(device_id=7)
+
+ assert success is True
+ assert len(vlans) == 1
+ assert vlans[0]["vlan_vlan"] == 10
+
+ @patch("netbox_librenms_plugin.librenms_api.requests.get")
+ def test_vlans_not_list_returns_failure(self, mock_get, mock_librenms_config):
+ mock_get.return_value.status_code = 200
+ mock_get.return_value.json.return_value = {
+ "status": "ok",
+ "vlans": "oops",
+ "message": "bad payload",
+ }
+
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ api = LibreNMSAPI(server_key="default")
+ success, msg = api.get_device_vlans(device_id=7)
+
+ assert success is False
+ assert msg == "bad payload"
+
+ @patch("netbox_librenms_plugin.librenms_api.requests.get")
+ def test_non_dict_item_in_vlans_returns_failure(self, mock_get, mock_librenms_config):
+ mock_get.return_value.status_code = 200
+ mock_get.return_value.json.return_value = {
+ "status": "ok",
+ "vlans": [{"vlan_id": 1, "device_id": 7}, "not-a-dict"],
+ }
+
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ api = LibreNMSAPI(server_key="default")
+ success, msg = api.get_device_vlans(device_id=7)
+
+ assert success is False
+ assert "invalid item shape" in msg
+
+ @patch("netbox_librenms_plugin.librenms_api.requests.get")
+ def test_status_not_ok_returns_failure(self, mock_get, mock_librenms_config):
+ mock_get.return_value.status_code = 200
+ mock_get.return_value.json.return_value = {"status": "error", "message": "nope"}
+
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ api = LibreNMSAPI(server_key="default")
+ success, msg = api.get_device_vlans(device_id=7)
+
+ assert success is False
+ assert msg == "nope"
+
+ @patch("netbox_librenms_plugin.librenms_api.requests.get")
+ def test_non_dict_response_returns_failure(self, mock_get, mock_librenms_config):
+ mock_get.return_value.status_code = 200
+ mock_get.return_value.json.return_value = ["unexpected"]
+
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ api = LibreNMSAPI(server_key="default")
+ success, msg = api.get_device_vlans(device_id=7)
+
+ assert success is False
+ assert msg == "Unexpected response format"
+
+ @patch("netbox_librenms_plugin.librenms_api.requests.get")
+ def test_http_404_returns_dedicated_message(self, mock_get, mock_librenms_config):
+ response = MagicMock(status_code=404)
+ mock_get.return_value.raise_for_status.side_effect = requests.exceptions.HTTPError(response=response)
+
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ api = LibreNMSAPI(server_key="default")
+ success, msg = api.get_device_vlans(device_id=7)
+
+ assert success is False
+ assert msg == "VLANs resource not found"
+
+ @patch("netbox_librenms_plugin.librenms_api.requests.get")
+ def test_value_error_returns_connection_message(self, mock_get, mock_librenms_config):
+ mock_get.return_value.status_code = 200
+ mock_get.return_value.json.side_effect = ValueError("bad json")
+
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ api = LibreNMSAPI(server_key="default")
+ success, msg = api.get_device_vlans(device_id=7)
+
+ assert success is False
+ assert "Error connecting to LibreNMS" in msg
+
+
+class TestGetPortVlanDetailsResponseShape:
+ """Cover response-shape branches in get_port_vlan_details()."""
+
+ pytest_plugins = ["netbox_librenms_plugin.tests.test_librenms_api_helpers"]
+
+ @patch("netbox_librenms_plugin.librenms_api.requests.get")
+ def test_success_returns_port_dict(self, mock_get, mock_librenms_config):
+ mock_get.return_value.status_code = 200
+ mock_get.return_value.json.return_value = {
+ "status": "ok",
+ "port": [{"port_id": 11, "ifName": "Te1/1/1", "vlans": [{"vlan": 10, "untagged": 1}]}],
+ }
+
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ api = LibreNMSAPI(server_key="default")
+ success, port = api.get_port_vlan_details(port_id=11)
+
+ assert success is True
+ assert port["port_id"] == 11
+
+ @patch("netbox_librenms_plugin.librenms_api.requests.get")
+ def test_non_dict_response_returns_failure(self, mock_get, mock_librenms_config):
+ mock_get.return_value.status_code = 200
+ mock_get.return_value.json.return_value = ["unexpected"]
+
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ api = LibreNMSAPI(server_key="default")
+ success, msg = api.get_port_vlan_details(port_id=11)
+
+ assert success is False
+ assert msg == "Unexpected response format"
+
+ @patch("netbox_librenms_plugin.librenms_api.requests.get")
+ def test_status_not_ok_uses_server_message(self, mock_get, mock_librenms_config):
+ mock_get.return_value.status_code = 200
+ mock_get.return_value.json.return_value = {"status": "error", "message": "no port"}
+
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ api = LibreNMSAPI(server_key="default")
+ success, msg = api.get_port_vlan_details(port_id=11)
+
+ assert success is False
+ assert msg == "no port"
+
+ @patch("netbox_librenms_plugin.librenms_api.requests.get")
+ def test_missing_port_list_returns_failure(self, mock_get, mock_librenms_config):
+ mock_get.return_value.status_code = 200
+ mock_get.return_value.json.return_value = {"status": "ok", "port": {"port_id": 11}}
+
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ api = LibreNMSAPI(server_key="default")
+ success, msg = api.get_port_vlan_details(port_id=11)
+
+ assert success is False
+ assert "missing 'port' list" in msg
+
+ @patch("netbox_librenms_plugin.librenms_api.requests.get")
+ def test_empty_port_list_returns_not_found(self, mock_get, mock_librenms_config):
+ mock_get.return_value.status_code = 200
+ mock_get.return_value.json.return_value = {"status": "ok", "port": []}
+
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ api = LibreNMSAPI(server_key="default")
+ success, msg = api.get_port_vlan_details(port_id=11)
+
+ assert success is False
+ assert msg == "Port not found"
+
+ @patch("netbox_librenms_plugin.librenms_api.requests.get")
+ def test_non_dict_port_entry_returns_failure(self, mock_get, mock_librenms_config):
+ mock_get.return_value.status_code = 200
+ mock_get.return_value.json.return_value = {"status": "ok", "port": ["bad-entry"]}
+
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ api = LibreNMSAPI(server_key="default")
+ success, msg = api.get_port_vlan_details(port_id=11)
+
+ assert success is False
+ assert "invalid 'port' entry" in msg
+
+ @patch("netbox_librenms_plugin.librenms_api.requests.get")
+ def test_request_exception_returns_failure(self, mock_get, mock_librenms_config):
+ mock_get.side_effect = requests.exceptions.ConnectionError("net down")
+
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ api = LibreNMSAPI(server_key="default")
+ success, msg = api.get_port_vlan_details(port_id=11)
+
+ assert success is False
+ assert "net down" in msg
diff --git a/netbox_librenms_plugin/tests/test_librenms_id.py b/netbox_librenms_plugin/tests/test_librenms_id.py
index 075e716105..78c2c33ed8 100644
--- a/netbox_librenms_plugin/tests/test_librenms_id.py
+++ b/netbox_librenms_plugin/tests/test_librenms_id.py
@@ -1,5 +1,4 @@
-"""
-Tests for multi-server librenms_id helpers.
+"""Tests for multi-server librenms_id helpers.
Covers get_librenms_device_id, set_librenms_device_id, find_by_librenms_id,
and migrate_legacy_librenms_id.
@@ -28,8 +27,7 @@ def test_returns_int_for_legacy_bare_integer(self):
assert result == 42
def test_legacy_bare_int_returned_for_any_server_key(self):
- """
- Legacy bare integers are returned as a universal fallback for any server_key.
+ """Legacy bare integers are returned as a universal fallback for any server_key.
Devices imported before multi-server support store a bare integer in
librenms_id. These must remain discoverable regardless of which server is
@@ -106,8 +104,7 @@ class TestFindByLibreNMSId:
"""Tests for find_by_librenms_id()."""
def test_queries_server_key_and_legacy_integer(self):
- """
- find_by_librenms_id() issues a Q that covers both the JSON server-key branch
+ """find_by_librenms_id() issues a Q that covers both the JSON server-key branch
and the legacy bare-int branch in a single filter() call.
We inspect the Q object's children directly because the two branches must
@@ -131,12 +128,16 @@ def test_queries_server_key_and_legacy_integer(self):
q_arg = call_args[0][0]
assert isinstance(q_arg, Q)
assert q_arg.connector == "OR"
- # The combined Q should contain four children: JSON key (int), JSON key (str), bare-int, bare-string
- q_str = str(q_arg)
- assert "librenms_id__default" in q_str
- assert "custom_field_data__librenms_id__default" in q_str
- assert "custom_field_data__librenms_id" in q_str
- assert "42" in q_str
+ assert set(q_arg.children) == {
+ ("custom_field_data__librenms_id__default", 42),
+ ("custom_field_data__librenms_id__default", "42"),
+ ("custom_field_data__librenms_id__default__id", 42),
+ ("custom_field_data__librenms_id__default__id", "42"),
+ ("custom_field_data__librenms_id__default__oob__id", 42),
+ ("custom_field_data__librenms_id__default__oob__id", "42"),
+ ("custom_field_data__librenms_id", 42),
+ ("custom_field_data__librenms_id", "42"),
+ }
def test_returns_first_matching_object(self):
from netbox_librenms_plugin.utils import find_by_librenms_id
@@ -168,12 +169,20 @@ def test_returns_none_when_not_found(self):
call_args = mock_model.objects.filter.call_args
q_arg = call_args[0][0]
assert isinstance(q_arg, Q)
- q_str = str(q_arg)
- assert "custom_field_data__librenms_id__production" in q_str
- assert "custom_field_data__librenms_id" in q_str
+ assert set(q_arg.children) == {
+ ("custom_field_data__librenms_id__production", 999),
+ ("custom_field_data__librenms_id__production", "999"),
+ ("custom_field_data__librenms_id__production__id", 999),
+ ("custom_field_data__librenms_id__production__id", "999"),
+ ("custom_field_data__librenms_id__production__oob__id", 999),
+ ("custom_field_data__librenms_id__production__oob__id", "999"),
+ ("custom_field_data__librenms_id", 999),
+ ("custom_field_data__librenms_id", "999"),
+ }
def test_default_server_key_is_default(self):
- """find_by_librenms_id() uses "default" as the server key when no key is passed.
+ """
+ find_by_librenms_id() uses "default" as the server key when no key is passed.
We inspect the Q predicate's children to confirm the key embedded in the
JSON path is exactly "default", not some other fallback value.
@@ -194,8 +203,18 @@ def test_default_server_key_is_default(self):
q_arg = call_args[0][0]
assert isinstance(q_arg, Q)
assert q_arg.connector == "OR"
- q_str = str(q_arg)
- assert "custom_field_data__librenms_id__default" in q_str
+ # The JSON-path branch must use "default" as the server key; exact tuple check prevents
+ # duplicate or missing branches from going undetected.
+ assert set(q_arg.children) == {
+ ("custom_field_data__librenms_id__default", 42),
+ ("custom_field_data__librenms_id__default", "42"),
+ ("custom_field_data__librenms_id__default__id", 42),
+ ("custom_field_data__librenms_id__default__id", "42"),
+ ("custom_field_data__librenms_id__default__oob__id", 42),
+ ("custom_field_data__librenms_id__default__oob__id", "42"),
+ ("custom_field_data__librenms_id", 42),
+ ("custom_field_data__librenms_id", "42"),
+ }
class TestMigrateLegacyLibreNMSId:
@@ -365,3 +384,349 @@ def test_unexpected_cf_type_reset_to_empty(self):
obj.custom_field_data = {"librenms_id": "unexpected-string"}
set_librenms_device_id(obj, 5, server_key="primary")
assert obj.custom_field_data["librenms_id"] == {"primary": 5}
+
+
+class TestOOBHelpers:
+ """Tests for get_librenms_oob, set_librenms_oob, clear_librenms_oob,
+ and the dict-with-id changes to get/set_librenms_device_id and find_by_librenms_id.
+ """
+
+ # ββ get_librenms_device_id: dict-with-id form βββββββββββββββββββββββββββββ
+
+ def test_get_id_from_dict_with_id_form(self):
+ """get_librenms_device_id extracts 'id' from {"server": {"id": N}} form."""
+ from netbox_librenms_plugin.utils import get_librenms_device_id
+
+ obj = MagicMock()
+ obj.cf = {"librenms_id": {"primary": {"id": 42}}}
+ assert get_librenms_device_id(obj, "primary") == 42
+
+ def test_get_id_when_oob_also_present(self):
+ """get_librenms_device_id returns the main id, ignoring the oob sub-object."""
+ from netbox_librenms_plugin.utils import get_librenms_device_id
+
+ obj = MagicMock()
+ obj.cf = {"librenms_id": {"primary": {"id": 42, "oob": {"id": 17, "type": "drac"}}}}
+ assert get_librenms_device_id(obj, "primary") == 42
+
+ def test_get_returns_none_for_dict_without_id_key(self):
+ """dict entry without 'id' key returns None."""
+ from netbox_librenms_plugin.utils import get_librenms_device_id
+
+ obj = MagicMock()
+ obj.cf = {"librenms_id": {"primary": {"oob": {"id": 17}}}}
+ assert get_librenms_device_id(obj, "primary") is None
+
+ def test_get_normalises_string_id_inside_dict_with_id_form(self):
+ """String 'id' inside dict-with-id form is coerced to int."""
+ from netbox_librenms_plugin.utils import get_librenms_device_id
+
+ obj = MagicMock()
+ obj.cf = {"librenms_id": {"primary": {"id": "42"}}}
+ obj.custom_field_data = {"librenms_id": {"primary": {"id": "42"}}}
+ result = get_librenms_device_id(obj, "primary", auto_save=False)
+ assert result == 42
+
+ # ββ set_librenms_device_id: oob preservation βββββββββββββββββββββββββββββ
+
+ def test_set_preserves_oob_when_entry_has_oob(self):
+ """Updating main id preserves existing oob sub-object."""
+ from netbox_librenms_plugin.utils import set_librenms_device_id
+
+ obj = MagicMock()
+ obj.custom_field_data = {
+ "librenms_id": {"primary": {"id": 42, "oob": {"id": 17, "type": "drac", "ip": "10.0.0.5"}}}
+ }
+ set_librenms_device_id(obj, 99, server_key="primary")
+ assert obj.custom_field_data["librenms_id"] == {
+ "primary": {"id": 99, "oob": {"id": 17, "type": "drac", "ip": "10.0.0.5"}}
+ }
+
+ def test_set_bare_int_when_no_oob_present(self):
+ """When no oob in existing entry, set_librenms_device_id stores bare int (no regression)."""
+ from netbox_librenms_plugin.utils import set_librenms_device_id
+
+ obj = MagicMock()
+ obj.custom_field_data = {"librenms_id": {"primary": 42}}
+ set_librenms_device_id(obj, 99, server_key="primary")
+ assert obj.custom_field_data["librenms_id"] == {"primary": 99}
+
+ # ββ find_by_librenms_id: dict-with-id and oob id lookups βββββββββββββββββ
+
+ def test_find_by_matches_main_id_in_dict_with_id_form(self):
+ """find_by_librenms_id Q includes __id sub-key lookup."""
+ from netbox_librenms_plugin.utils import find_by_librenms_id
+
+ mock_model = MagicMock()
+ mock_qs = MagicMock()
+ mock_model.objects.filter.return_value = mock_qs
+ mock_qs.first.return_value = None
+
+ find_by_librenms_id(mock_model, 42, "primary")
+
+ call_args = mock_model.objects.filter.call_args
+ q_arg = call_args[0][0]
+ assert ("custom_field_data__librenms_id__primary__id", 42) in q_arg.children
+ assert ("custom_field_data__librenms_id__primary__id", "42") in q_arg.children
+
+ def test_find_by_matches_oob_id(self):
+ """find_by_librenms_id Q includes __oob__id sub-key lookup."""
+ from netbox_librenms_plugin.utils import find_by_librenms_id
+
+ mock_model = MagicMock()
+ mock_qs = MagicMock()
+ mock_model.objects.filter.return_value = mock_qs
+ mock_qs.first.return_value = None
+
+ find_by_librenms_id(mock_model, 17, "primary")
+
+ call_args = mock_model.objects.filter.call_args
+ q_arg = call_args[0][0]
+ assert ("custom_field_data__librenms_id__primary__oob__id", 17) in q_arg.children
+ assert ("custom_field_data__librenms_id__primary__oob__id", "17") in q_arg.children
+
+ def test_find_by_does_not_return_unrelated_id(self):
+ """find_by_librenms_id returns None when no model matches."""
+ from netbox_librenms_plugin.utils import find_by_librenms_id
+
+ mock_model = MagicMock()
+ mock_qs = MagicMock()
+ mock_model.objects.filter.return_value = mock_qs
+ mock_qs.first.return_value = None
+
+ result = find_by_librenms_id(mock_model, 999, "primary")
+ assert result is None
+
+ # ββ get_librenms_oob ββββββββββββββββββββββββββββββββββββββββββββββββββββββ
+
+ def test_get_oob_returns_none_for_legacy_bare_int(self):
+ from netbox_librenms_plugin.utils import get_librenms_oob
+
+ obj = MagicMock()
+ obj.cf = {"librenms_id": 42}
+ assert get_librenms_oob(obj, "primary") is None
+
+ def test_get_oob_returns_none_for_bare_int_entry(self):
+ """When server-key entry is a bare int (no oob), returns None."""
+ from netbox_librenms_plugin.utils import get_librenms_oob
+
+ obj = MagicMock()
+ obj.cf = {"librenms_id": {"primary": 42}}
+ assert get_librenms_oob(obj, "primary") is None
+
+ def test_get_oob_returns_oob_dict_when_present(self):
+ from netbox_librenms_plugin.utils import get_librenms_oob
+
+ oob_data = {"id": 17, "type": "drac", "version": "5.10", "ip": "10.0.0.5"}
+ obj = MagicMock()
+ obj.cf = {"librenms_id": {"primary": {"id": 42, "oob": oob_data}}}
+ result = get_librenms_oob(obj, "primary")
+ assert result == oob_data
+
+ # ββ set_librenms_oob ββββββββββββββββββββββββββββββββββββββββββββββββββββββ
+
+ def test_set_oob_round_trip(self):
+ """set_librenms_oob followed by get_librenms_oob returns equivalent values."""
+ from netbox_librenms_plugin.utils import get_librenms_oob, set_librenms_oob
+
+ obj = MagicMock()
+ obj.custom_field_data = {"librenms_id": {"primary": 42}}
+ obj.cf = obj.custom_field_data
+
+ set_librenms_oob(obj, 17, "primary", oob_type="drac", version="5.10", ip="10.0.0.5")
+ result = get_librenms_oob(obj, "primary")
+
+ assert result == {"id": 17, "type": "drac", "version": "5.10", "ip": "10.0.0.5"}
+
+ def test_set_oob_promotes_bare_int_entry(self):
+ """set_librenms_oob promotes a bare-int entry to dict form, preserving the main id."""
+ from netbox_librenms_plugin.utils import get_librenms_device_id, set_librenms_oob
+
+ obj = MagicMock()
+ obj.custom_field_data = {"librenms_id": {"primary": 42}}
+ obj.cf = obj.custom_field_data
+
+ set_librenms_oob(obj, 17, "primary", oob_type="idrac")
+ assert get_librenms_device_id(obj, "primary") == 42
+
+ def test_set_oob_rejects_unknown_type(self):
+ """set_librenms_oob raises ValueError for a type that doesn't match OOB_TYPE_PATTERN."""
+ from netbox_librenms_plugin.utils import set_librenms_oob
+
+ obj = MagicMock()
+ obj.custom_field_data = {"librenms_id": {"primary": 42}}
+
+ import pytest
+
+ with pytest.raises(ValueError, match="does not match any known OOB type"):
+ set_librenms_oob(obj, 17, "primary", oob_type="ubuntu")
+
+ def test_set_oob_does_not_call_save(self):
+ """set_librenms_oob must NOT call obj.save() β caller is responsible."""
+ from netbox_librenms_plugin.utils import set_librenms_oob
+
+ obj = MagicMock()
+ obj.custom_field_data = {"librenms_id": {"primary": 42}}
+
+ set_librenms_oob(obj, 17, "primary", oob_type="ilo")
+ obj.save.assert_not_called()
+
+ # ββ clear_librenms_oob ββββββββββββββββββββββββββββββββββββββββββββββββββββ
+
+ def test_clear_oob_removes_oob_sub_key(self):
+ from netbox_librenms_plugin.utils import clear_librenms_oob, get_librenms_oob
+
+ obj = MagicMock()
+ obj.custom_field_data = {"librenms_id": {"primary": {"id": 42, "oob": {"id": 17, "type": "drac"}}}}
+ obj.cf = obj.custom_field_data
+
+ clear_librenms_oob(obj, "primary")
+ assert get_librenms_oob(obj, "primary") is None
+ # Main id should still be accessible via dict-with-id form
+ assert obj.custom_field_data["librenms_id"]["primary"] == {"id": 42}
+
+ def test_clear_oob_is_noop_when_no_oob(self):
+ """clear_librenms_oob is a no-op when oob key is not present."""
+ from netbox_librenms_plugin.utils import clear_librenms_oob
+
+ obj = MagicMock()
+ obj.custom_field_data = {"librenms_id": {"primary": {"id": 42}}}
+
+ clear_librenms_oob(obj, "primary")
+ assert obj.custom_field_data["librenms_id"] == {"primary": {"id": 42}}
+
+ def test_clear_oob_does_not_call_save(self):
+ """clear_librenms_oob must NOT call obj.save() β caller is responsible."""
+ from netbox_librenms_plugin.utils import clear_librenms_oob
+
+ obj = MagicMock()
+ obj.custom_field_data = {"librenms_id": {"primary": {"id": 42, "oob": {"id": 17, "type": "bmc"}}}}
+
+ clear_librenms_oob(obj, "primary")
+ obj.save.assert_not_called()
+
+
+class TestMergeLibreNMSLinks:
+ """Tests for merge_librenms_links() β winner-wins conflict policy."""
+
+ def _make_dev(self, name, librenms_id_dict):
+ d = MagicMock()
+ d.name = name
+ d.custom_field_data = {"librenms_id": librenms_id_dict} if librenms_id_dict is not None else {}
+ return d
+
+ def test_winner_inherits_id_when_winner_has_no_id(self):
+ from netbox_librenms_plugin.utils import merge_librenms_links
+
+ winner = self._make_dev("eve-ng-02", {"default": {}})
+ donor = self._make_dev("idrac-jhw6nc4", {"default": {"id": 99}})
+ summary = merge_librenms_links(winner, donor, "default")
+
+ assert winner.custom_field_data["librenms_id"]["default"]["id"] == 99
+ assert summary["host_id_from_donor"] == 99
+ assert summary["donor_id_demoted_to_oob"] is None
+
+ def test_donor_id_demoted_to_oob_when_winner_has_id_and_donor_name_matches_oob_pattern(self):
+ from netbox_librenms_plugin.utils import merge_librenms_links
+
+ winner = self._make_dev("eve-ng-02", {"default": {"id": 42}})
+ donor = self._make_dev("idrac-jhw6nc4", {"default": {"id": 99}})
+ summary = merge_librenms_links(winner, donor, "default")
+
+ assert winner.custom_field_data["librenms_id"]["default"]["id"] == 42
+ assert winner.custom_field_data["librenms_id"]["default"]["oob"]["id"] == 99
+ assert winner.custom_field_data["librenms_id"]["default"]["oob"]["type"] == "idrac"
+ assert summary["donor_id_demoted_to_oob"] == {"id": 99, "type": "idrac"}
+
+ def test_donor_id_skipped_when_no_oob_pattern_in_donor_name(self):
+ from netbox_librenms_plugin.utils import merge_librenms_links
+
+ winner = self._make_dev("eve-ng-02", {"default": {"id": 42}})
+ donor = self._make_dev("eve-ng-03-spare", {"default": {"id": 99}})
+ summary = merge_librenms_links(winner, donor, "default")
+
+ assert winner.custom_field_data["librenms_id"]["default"]["id"] == 42
+ assert "oob" not in winner.custom_field_data["librenms_id"]["default"]
+ assert summary["donor_id_demoted_to_oob"] is None
+
+ def test_winner_inherits_donor_oob_when_winner_has_none(self):
+ from netbox_librenms_plugin.utils import merge_librenms_links
+
+ winner = self._make_dev("eve-ng-02", {"default": {"id": 42}})
+ donor = self._make_dev("eve-ng-02-old", {"default": {"oob": {"id": 77, "type": "ipmi"}}})
+ summary = merge_librenms_links(winner, donor, "default")
+
+ assert winner.custom_field_data["librenms_id"]["default"]["oob"] == {"id": 77, "type": "ipmi"}
+ assert summary["oob_from_donor"] == {"id": 77, "type": "ipmi"}
+
+ def test_winner_oob_never_overwritten(self):
+ from netbox_librenms_plugin.utils import merge_librenms_links
+
+ winner = self._make_dev("eve-ng-02", {"default": {"id": 42, "oob": {"id": 11, "type": "drac"}}})
+ donor = self._make_dev("eve-ng-02-old", {"default": {"oob": {"id": 77, "type": "ipmi"}}})
+ summary = merge_librenms_links(winner, donor, "default")
+
+ assert winner.custom_field_data["librenms_id"]["default"]["oob"] == {"id": 11, "type": "drac"}
+ assert summary["oob_from_donor"] is None
+
+ def test_legacy_bare_int_raises(self):
+ import pytest
+
+ from netbox_librenms_plugin.utils import merge_librenms_links
+
+ winner = MagicMock()
+ winner.custom_field_data = {"librenms_id": 42}
+ donor = self._make_dev("idrac-x", {"default": {"id": 99}})
+ with pytest.raises(ValueError):
+ merge_librenms_links(winner, donor, "default")
+
+
+class TestMarkLibreNMSMigrated:
+ """Tests for mark_librenms_migrated()."""
+
+ def test_clears_id_and_oob_and_writes_marker(self):
+ from netbox_librenms_plugin.utils import mark_librenms_migrated
+
+ donor = MagicMock()
+ donor.custom_field_data = {"librenms_id": {"default": {"id": 99, "oob": {"id": 11, "type": "drac"}}}}
+ mark_librenms_migrated(donor, winner_pk=42, server_key="default", at="2025-01-01T00:00:00Z")
+
+ entry = donor.custom_field_data["librenms_id"]["default"]
+ assert "id" not in entry
+ assert "oob" not in entry
+ assert entry["_migrated_to"] == {
+ "device_id": 42,
+ "server_key": "default",
+ "at": "2025-01-01T00:00:00Z",
+ }
+
+ def test_default_timestamp_is_iso_z(self):
+ from netbox_librenms_plugin.utils import mark_librenms_migrated
+
+ donor = MagicMock()
+ donor.custom_field_data = {"librenms_id": {"default": {"id": 99}}}
+ mark_librenms_migrated(donor, winner_pk=42, server_key="default")
+
+ ts = donor.custom_field_data["librenms_id"]["default"]["_migrated_to"]["at"]
+ assert ts.endswith("Z")
+ assert len(ts) == 20
+
+ def test_after_marker_find_by_librenms_id_no_longer_matches(self):
+ """Donor with only _migrated_to should not be returned by find_by_librenms_id."""
+ from netbox_librenms_plugin.utils import find_by_librenms_id, mark_librenms_migrated
+
+ donor = MagicMock()
+ donor.custom_field_data = {"librenms_id": {"default": {"id": 99}}}
+ donor.cf = donor.custom_field_data
+ mark_librenms_migrated(donor, winner_pk=42, server_key="default")
+
+ # cf.librenms_id[default] now only has _migrated_to β no id, no oob.
+ # find_by_librenms_id walks cf via the model query, but logic-wise: simulate
+ # by directly inspecting the entry.
+ entry = donor.cf["librenms_id"]["default"]
+ assert entry.get("id") is None
+ assert entry.get("oob") is None
+ # Mock model.objects.filter: should return empty queryset for either id or oob lookup
+ mock_model = MagicMock()
+ mock_model.objects.filter.return_value.first.return_value = None
+ assert find_by_librenms_id(mock_model, 99, "default") is None
diff --git a/netbox_librenms_plugin/tests/test_migrate_views.py b/netbox_librenms_plugin/tests/test_migrate_views.py
new file mode 100644
index 0000000000..95d60b3838
--- /dev/null
+++ b/netbox_librenms_plugin/tests/test_migrate_views.py
@@ -0,0 +1,323 @@
+"""
+Tests for Stage 2b: get_migrated_to_marker helper + the per-row
+"Move to winner" view endpoints (MoveInterfaceToWinnerView,
+MoveIPAddressToWinnerView, TransferDeviceIPView).
+
+The view tests use light MagicMock-based plumbing β we patch the model
+queryset chain so the views never touch a real database. This is
+appropriate because the views' job is glue: validate the marker, look
+up the winner, run a small ORM mutation, and return an HTMX response.
+"""
+
+from unittest.mock import MagicMock, patch
+
+
+# ββ helper: get_migrated_to_marker ββββββββββββββββββββββββββββββββββββββββ
+
+
+class TestGetMigratedToMarker:
+ def test_returns_marker_when_present_and_well_formed(self):
+ from netbox_librenms_plugin.utils import get_migrated_to_marker
+
+ donor = MagicMock()
+ donor.cf = {
+ "librenms_id": {
+ "default": {"_migrated_to": {"device_id": 42, "server_key": "default", "at": "2025-01-01T00:00:00Z"}}
+ }
+ }
+ marker = get_migrated_to_marker(donor, "default")
+ assert marker == {"device_id": 42, "server_key": "default", "at": "2025-01-01T00:00:00Z"}
+
+ def test_returns_none_when_no_cf(self):
+ from netbox_librenms_plugin.utils import get_migrated_to_marker
+
+ donor = MagicMock()
+ donor.cf = {}
+ assert get_migrated_to_marker(donor, "default") is None
+
+ def test_returns_none_when_server_key_missing(self):
+ from netbox_librenms_plugin.utils import get_migrated_to_marker
+
+ donor = MagicMock()
+ donor.cf = {"librenms_id": {"primary": {"_migrated_to": {"device_id": 42}}}}
+ assert get_migrated_to_marker(donor, "default") is None
+
+ def test_returns_none_when_marker_lacks_device_id(self):
+ from netbox_librenms_plugin.utils import get_migrated_to_marker
+
+ donor = MagicMock()
+ donor.cf = {"librenms_id": {"default": {"_migrated_to": {"server_key": "default"}}}}
+ assert get_migrated_to_marker(donor, "default") is None
+
+ def test_returns_none_when_legacy_bare_int(self):
+ from netbox_librenms_plugin.utils import get_migrated_to_marker
+
+ donor = MagicMock()
+ donor.cf = {"librenms_id": 42}
+ assert get_migrated_to_marker(donor, "default") is None
+
+ def test_returns_none_for_none_device(self):
+ from netbox_librenms_plugin.utils import get_migrated_to_marker
+
+ assert get_migrated_to_marker(None, "default") is None
+
+
+# ββ helper: _resolve_winner_for_donor βββββββββββββββββββββββββββββββββββββ
+
+
+class TestResolveWinnerForDonor:
+ def test_returns_winner_and_marker_when_both_exist(self):
+ from netbox_librenms_plugin.views.sync.migrate import _resolve_winner_for_donor
+
+ donor = MagicMock()
+ donor.cf = {"librenms_id": {"default": {"_migrated_to": {"device_id": 42, "server_key": "default", "at": "x"}}}}
+ winner = MagicMock(pk=42)
+
+ with patch("netbox_librenms_plugin.views.sync.migrate.Device") as mock_device:
+ mock_device.objects.filter.return_value.first.return_value = winner
+ result_winner, result_marker = _resolve_winner_for_donor(donor, "default")
+
+ assert result_winner is winner
+ assert result_marker["device_id"] == 42
+
+ def test_returns_none_winner_when_winner_deleted(self):
+ from netbox_librenms_plugin.views.sync.migrate import _resolve_winner_for_donor
+
+ donor = MagicMock()
+ donor.cf = {"librenms_id": {"default": {"_migrated_to": {"device_id": 42, "server_key": "default", "at": "x"}}}}
+
+ with patch("netbox_librenms_plugin.views.sync.migrate.Device") as mock_device:
+ mock_device.objects.filter.return_value.first.return_value = None
+ winner, marker = _resolve_winner_for_donor(donor, "default")
+
+ assert winner is None
+ assert marker["device_id"] == 42
+
+ def test_returns_none_when_no_marker(self):
+ from netbox_librenms_plugin.views.sync.migrate import _resolve_winner_for_donor
+
+ donor = MagicMock()
+ donor.cf = {}
+ winner, marker = _resolve_winner_for_donor(donor, "default")
+ assert winner is None
+ assert marker is None
+
+
+# ββ MoveInterfaceToWinnerView βββββββββββββββββββββββββββββββββββββββββββββ
+
+
+def _hx_request(post=None):
+ """Build an HTMX request."""
+ req = MagicMock()
+ post = post or {}
+ req.POST = MagicMock()
+ req.POST.get = lambda k, d=None: post.get(k, d)
+ req.headers = {"HX-Request": "true"}
+ req.META = {"HTTP_REFERER": "/back"}
+ req.user = MagicMock(is_superuser=True)
+ return req
+
+
+class TestMoveInterfaceToWinnerView:
+ def _setup_view(self):
+ from netbox_librenms_plugin.views.sync.migrate import MoveInterfaceToWinnerView
+
+ view = MoveInterfaceToWinnerView()
+ view.require_all_permissions = MagicMock(return_value=None)
+ return view
+
+ def test_rejects_when_donor_has_no_marker(self):
+ view = self._setup_view()
+ req = _hx_request({"server_key": "default"})
+
+ donor = MagicMock(pk=10, cf={})
+ interface = MagicMock(pk=5, name="Eth0", device=donor)
+
+ with (
+ patch("netbox_librenms_plugin.views.sync.migrate.get_object_or_404", return_value=interface),
+ patch(
+ "netbox_librenms_plugin.views.sync.migrate._resolve_winner_for_donor",
+ return_value=(None, None),
+ ),
+ ):
+ resp = view.post(req, pk=5)
+
+ assert resp.status_code == 409
+
+ def test_rejects_on_name_collision(self):
+ view = self._setup_view()
+ req = _hx_request({"server_key": "default"})
+
+ donor = MagicMock(pk=10)
+ winner = MagicMock(pk=20, name="winner")
+ interface = MagicMock(pk=5, name="Eth0", device=donor)
+
+ with (
+ patch("netbox_librenms_plugin.views.sync.migrate.get_object_or_404", return_value=interface),
+ patch(
+ "netbox_librenms_plugin.views.sync.migrate._resolve_winner_for_donor",
+ return_value=(winner, {"device_id": 20, "server_key": "default", "at": "x"}),
+ ),
+ patch("netbox_librenms_plugin.views.sync.migrate.Interface") as mock_iface_cls,
+ ):
+ mock_iface_cls.objects.filter.return_value.exists.return_value = True
+ resp = view.post(req, pk=5)
+
+ assert resp.status_code == 409
+
+ def test_happy_path_reassigns_device_and_returns_hx_refresh(self):
+ view = self._setup_view()
+ req = _hx_request({"server_key": "default"})
+
+ donor = MagicMock(pk=10)
+ winner = MagicMock(pk=20, name="winner")
+ interface = MagicMock(pk=5, name="Eth0", device=donor)
+
+ with (
+ patch("netbox_librenms_plugin.views.sync.migrate.get_object_or_404", return_value=interface),
+ patch(
+ "netbox_librenms_plugin.views.sync.migrate._resolve_winner_for_donor",
+ return_value=(winner, {"device_id": 20, "server_key": "default", "at": "x"}),
+ ),
+ patch("netbox_librenms_plugin.views.sync.migrate.Interface") as mock_iface_cls,
+ patch("netbox_librenms_plugin.views.sync.migrate.Device") as mock_device_cls,
+ patch("netbox_librenms_plugin.views.sync.migrate.transaction"),
+ patch("netbox_librenms_plugin.views.sync.migrate.messages"),
+ ):
+ mock_iface_cls.objects.filter.return_value.exists.return_value = False
+ mock_device_cls.objects.select_for_update.return_value.filter.return_value.order_by.return_value = []
+ resp = view.post(req, pk=5)
+
+ assert interface.device is winner
+ interface.save.assert_called_once()
+ assert resp.headers.get("HX-Refresh") == "true"
+
+ def test_perm_gate_short_circuits(self):
+ from django.http import HttpResponse
+
+ from netbox_librenms_plugin.views.sync.migrate import MoveInterfaceToWinnerView
+
+ view = MoveInterfaceToWinnerView()
+ view.require_all_permissions = MagicMock(return_value=HttpResponse(status=403))
+ req = _hx_request()
+ resp = view.post(req, pk=5)
+ assert resp.status_code == 403
+
+
+# ββ TransferDeviceIPView ββββββββββββββββββββββββββββββββββββββββββββββββββ
+
+
+class TestTransferDeviceIPView:
+ def _setup_view(self):
+ from netbox_librenms_plugin.views.sync.migrate import TransferDeviceIPView
+
+ view = TransferDeviceIPView()
+ view.require_all_permissions = MagicMock(return_value=None)
+ return view
+
+ def test_unknown_ip_kind_rejected(self):
+ view = self._setup_view()
+ req = _hx_request()
+ resp = view.post(req, pk=10, ip_kind="bogus")
+ assert resp.status_code == 400
+
+ def test_rejects_when_winner_already_has_field(self):
+ view = self._setup_view()
+ req = _hx_request({"server_key": "default"})
+
+ donor_ip = MagicMock(address="10.0.0.1/24")
+ donor = MagicMock(pk=10, primary_ip4=donor_ip)
+ winner = MagicMock(pk=20, name="winner", primary_ip4=MagicMock(address="10.0.0.99/24"))
+
+ with (
+ patch("netbox_librenms_plugin.views.sync.migrate.get_object_or_404", return_value=donor),
+ patch(
+ "netbox_librenms_plugin.views.sync.migrate._resolve_winner_for_donor",
+ return_value=(winner, {"device_id": 20, "server_key": "default", "at": "x"}),
+ ),
+ ):
+ resp = view.post(req, pk=10, ip_kind="primary4")
+
+ assert resp.status_code == 409
+
+ def test_happy_path_transfers_oob_ip(self):
+ view = self._setup_view()
+ req = _hx_request({"server_key": "default"})
+
+ oob_ip = MagicMock(address="10.0.0.5/24")
+ donor = MagicMock(pk=10, oob_ip=oob_ip)
+ winner = MagicMock(pk=20, name="winner", oob_ip=None)
+
+ with (
+ patch("netbox_librenms_plugin.views.sync.migrate.get_object_or_404", return_value=donor),
+ patch(
+ "netbox_librenms_plugin.views.sync.migrate._resolve_winner_for_donor",
+ return_value=(winner, {"device_id": 20, "server_key": "default", "at": "x"}),
+ ),
+ patch("netbox_librenms_plugin.views.sync.migrate.Device") as mock_device_cls,
+ patch("netbox_librenms_plugin.views.sync.migrate.transaction"),
+ patch("netbox_librenms_plugin.views.sync.migrate.messages"),
+ ):
+ mock_device_cls.objects.select_for_update.return_value.filter.return_value.order_by.return_value = []
+ resp = view.post(req, pk=10, ip_kind="oob")
+
+ assert winner.oob_ip is oob_ip
+ assert donor.oob_ip is None
+ winner.save.assert_called_once()
+ donor.save.assert_called_once()
+ assert resp.headers.get("HX-Refresh") == "true"
+
+
+# ββ MoveIPAddressToWinnerView ββββββββββββββββββββββββββββββββββββββββββββ
+
+
+class TestMoveIPAddressToWinnerView:
+ def _setup_view(self):
+ from netbox_librenms_plugin.views.sync.migrate import MoveIPAddressToWinnerView
+
+ view = MoveIPAddressToWinnerView()
+ view.require_all_permissions = MagicMock(return_value=None)
+ return view
+
+ def test_rejects_when_ip_not_assigned_to_interface(self):
+ view = self._setup_view()
+ req = _hx_request({"server_key": "default"})
+
+ ip = MagicMock(pk=7)
+ ip.assigned_object = None # not an Interface
+
+ with patch("netbox_librenms_plugin.views.sync.migrate.get_object_or_404", return_value=ip):
+ resp = view.post(req, pk=7)
+
+ assert resp.status_code == 409
+
+ def test_rejects_when_winner_lacks_same_name_interface(self):
+ from dcim.models import Interface
+
+ from netbox_librenms_plugin.views.sync.migrate import MoveIPAddressToWinnerView
+
+ view = MoveIPAddressToWinnerView()
+ view.require_all_permissions = MagicMock(return_value=None)
+
+ req = _hx_request({"server_key": "default"})
+
+ donor = MagicMock(pk=10)
+ winner = MagicMock(pk=20, name="winner")
+ donor_iface = MagicMock(spec=Interface)
+ donor_iface.name = "Eth0"
+ donor_iface.device = donor
+ ip = MagicMock(pk=7, address="10.0.0.1/24")
+ ip.assigned_object = donor_iface
+
+ with (
+ patch("netbox_librenms_plugin.views.sync.migrate.get_object_or_404", return_value=ip),
+ patch(
+ "netbox_librenms_plugin.views.sync.migrate._resolve_winner_for_donor",
+ return_value=(winner, {"device_id": 20, "server_key": "default", "at": "x"}),
+ ),
+ patch.object(Interface, "objects") as mock_objects,
+ ):
+ mock_objects.filter.return_value.first.return_value = None
+ resp = view.post(req, pk=7)
+
+ assert resp.status_code == 409
diff --git a/netbox_librenms_plugin/tests/test_module_replace.py b/netbox_librenms_plugin/tests/test_module_replace.py
new file mode 100644
index 0000000000..802f88cad8
--- /dev/null
+++ b/netbox_librenms_plugin/tests/test_module_replace.py
@@ -0,0 +1,488 @@
+"""Tests for ModuleMismatchPreviewView, ReplaceModuleView, and MoveModuleView."""
+
+from unittest.mock import MagicMock, patch
+
+
+# ---------------------------------------------------------------------------
+# Helpers
+# ---------------------------------------------------------------------------
+
+
+def _make_device(pk=24, name="test-device"):
+ d = MagicMock()
+ d.pk = pk
+ d.name = name
+ d.device_type = MagicMock()
+ d.device_type.manufacturer = None
+ return d
+
+
+def _make_module(pk=42, serial="OLD_SERIAL", bay_name="Slot 1", bay_id=10, type_id=5, type_model="XCM-7s"):
+ module = MagicMock()
+ module.pk = pk
+ module.serial = serial
+ module.module_bay = MagicMock()
+ module.module_bay.pk = bay_id
+ module.module_bay.name = bay_name
+ module.module_bay_id = bay_id
+ module.module_type = MagicMock()
+ module.module_type.pk = type_id
+ module.module_type.model = type_model
+ module.module_type_id = type_id
+ module.device = _make_device()
+ module.get_absolute_url.return_value = f"/dcim/modules/{pk}/"
+ return module
+
+
+def _make_request(method="GET", data=None):
+ req = MagicMock()
+ req.method = method
+ if method == "GET":
+ req.GET = data or {}
+ else:
+ req.POST = data or {}
+ return req
+
+
+# ---------------------------------------------------------------------------
+# ModuleMismatchPreviewView
+# ---------------------------------------------------------------------------
+
+
+class TestModuleMismatchPreviewView:
+ def _view(self):
+ from netbox_librenms_plugin.views.sync.modules import ModuleMismatchPreviewView
+
+ v = object.__new__(ModuleMismatchPreviewView)
+ v._librenms_api = MagicMock()
+ v._librenms_api.server_key = "default"
+ return v
+
+ def test_missing_params_returns_400(self):
+ """GET without module_id or ent_index returns 400."""
+ view = self._view()
+ device = _make_device()
+ request = _make_request(data={})
+ view.request = request
+
+ with patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", return_value=device):
+ resp = view.get(request, pk=24)
+
+ assert resp.status_code == 400
+
+ def test_invalid_ent_index_returns_400(self):
+ """GET with non-integer ent_index returns 400."""
+ view = self._view()
+ device = _make_device()
+ request = _make_request(data={"module_id": "42", "ent_index": "notanint"})
+ view.request = request
+
+ with patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", return_value=device):
+ resp = view.get(request, pk=24)
+
+ assert resp.status_code == 400
+
+ def test_no_cache_returns_400(self):
+ """GET with valid params but no cached inventory returns 400."""
+ view = self._view()
+ device = _make_device()
+ installed = _make_module()
+ request = _make_request(data={"module_id": "42", "ent_index": "100"})
+ view.request = request
+
+ with (
+ patch(
+ "netbox_librenms_plugin.views.sync.modules.get_object_or_404",
+ side_effect=[device, installed],
+ ),
+ patch.object(view, "get_cache_key", return_value="cache-key"),
+ patch("netbox_librenms_plugin.views.sync.modules.cache") as mock_cache,
+ ):
+ mock_cache.get.return_value = None
+ resp = view.get(request, pk=24)
+
+ assert resp.status_code == 400
+
+ def test_item_not_in_cache_returns_400(self):
+ """GET returns 400 when ent_index not found in cached data."""
+ view = self._view()
+ device = _make_device()
+ installed = _make_module()
+ request = _make_request(data={"module_id": "42", "ent_index": "999"})
+ view.request = request
+ cached = [{"entPhysicalIndex": 100, "entPhysicalModelName": "XCM-7s", "entPhysicalSerialNum": "S1"}]
+
+ with (
+ patch(
+ "netbox_librenms_plugin.views.sync.modules.get_object_or_404",
+ side_effect=[device, installed],
+ ),
+ patch.object(view, "get_cache_key", return_value="cache-key"),
+ patch("netbox_librenms_plugin.views.sync.modules.cache") as mock_cache,
+ ):
+ mock_cache.get.return_value = {"inventory": cached, "librenms_id": "test"}
+ resp = view.get(request, pk=24)
+
+ assert resp.status_code == 400
+
+ def test_renders_template_on_success(self):
+ """GET with valid data returns 200 with rendered template."""
+ from django.http import HttpResponse
+
+ view = self._view()
+ device = _make_device()
+ installed = _make_module(type_id=5, type_model="XCM-7s")
+ request = _make_request(data={"module_id": "42", "ent_index": "100"})
+ view.request = request
+ cached = [{"entPhysicalIndex": 100, "entPhysicalModelName": "XCM-7s", "entPhysicalSerialNum": "NS123"}]
+
+ matched_type = MagicMock()
+ matched_type.pk = 5
+
+ with (
+ patch(
+ "netbox_librenms_plugin.views.sync.modules.get_object_or_404",
+ side_effect=[device, installed],
+ ),
+ patch.object(view, "get_cache_key", return_value="cache-key"),
+ patch("netbox_librenms_plugin.views.sync.modules.cache") as mock_cache,
+ patch(
+ "netbox_librenms_plugin.views.sync.modules.get_module_types_indexed",
+ return_value={"XCM-7s": matched_type},
+ ),
+ patch("netbox_librenms_plugin.utils.apply_normalization_rules", return_value="XCM-7s"),
+ patch("dcim.models.Module") as mock_module_cls,
+ patch("netbox_librenms_plugin.views.sync.modules.render", return_value=HttpResponse("OK")) as mock_render,
+ ):
+ mock_cache.get.return_value = {"inventory": cached, "librenms_id": "test"}
+ mock_module_cls.objects.filter.return_value.exclude.return_value.select_related.return_value.count.return_value = 0
+ mock_module_cls.objects.filter.return_value.exclude.return_value.select_related.return_value.first.return_value = None
+ resp = view.get(request, pk=24)
+
+ assert resp.status_code == 200
+ mock_render.assert_called_once()
+ ctx = mock_render.call_args[0][2]
+ assert ctx["device_pk"] == 24
+ assert ctx["librenms_serial"] == "NS123"
+
+ def test_serial_conflict_passed_to_template(self):
+ """When serial exists elsewhere, serial_conflict is set in template context."""
+ from django.http import HttpResponse
+
+ view = self._view()
+ device = _make_device()
+ installed = _make_module(serial="OLD", type_id=5)
+ request = _make_request(data={"module_id": "42", "ent_index": "100"})
+ view.request = request
+ cached = [{"entPhysicalIndex": 100, "entPhysicalModelName": "XCM-7s", "entPhysicalSerialNum": "NEW_SERIAL"}]
+
+ matched_type = MagicMock()
+ matched_type.pk = 5
+ conflict_module = MagicMock()
+
+ with (
+ patch(
+ "netbox_librenms_plugin.views.sync.modules.get_object_or_404",
+ side_effect=[device, installed],
+ ),
+ patch.object(view, "get_cache_key", return_value="cache-key"),
+ patch("netbox_librenms_plugin.views.sync.modules.cache") as mock_cache,
+ patch(
+ "netbox_librenms_plugin.views.sync.modules.get_module_types_indexed",
+ return_value={"XCM-7s": matched_type},
+ ),
+ patch("netbox_librenms_plugin.utils.apply_normalization_rules", return_value="XCM-7s"),
+ patch("dcim.models.Module") as mock_module_cls,
+ patch("netbox_librenms_plugin.views.sync.modules.render", return_value=HttpResponse("OK")) as mock_render,
+ ):
+ mock_cache.get.return_value = {"inventory": cached, "librenms_id": "test"}
+ mock_module_cls.objects.filter.return_value.exclude.return_value.select_related.return_value.count.return_value = 1
+ mock_module_cls.objects.filter.return_value.exclude.return_value.select_related.return_value.first.return_value = conflict_module
+ view.get(request, pk=24)
+
+ ctx = mock_render.call_args[0][2]
+ assert ctx["serial_conflict"] is conflict_module
+
+
+# ---------------------------------------------------------------------------
+# ReplaceModuleView
+# ---------------------------------------------------------------------------
+
+
+class TestReplaceModuleView:
+ def _view(self):
+ from netbox_librenms_plugin.views.sync.modules import ReplaceModuleView
+
+ v = object.__new__(ReplaceModuleView)
+ # Bypass permission mixin
+ v.required_object_permissions = {}
+ v._librenms_api = MagicMock()
+ v._librenms_api.server_key = "default"
+ return v
+
+ def test_missing_params_redirects_with_error(self):
+ """POST without module_id or ent_index adds error and redirects."""
+ view = self._view()
+ device = _make_device()
+ request = _make_request("POST", data={})
+
+ with (
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", return_value=device),
+ patch.object(view, "require_all_permissions", return_value=None),
+ patch("netbox_librenms_plugin.views.sync.modules.reverse", return_value="/sync/"),
+ patch("netbox_librenms_plugin.views.sync.modules.messages") as mock_msg,
+ patch("netbox_librenms_plugin.views.sync.modules.redirect") as mock_redirect,
+ ):
+ view.post(request, pk=24)
+
+ mock_msg.error.assert_called_once()
+ mock_redirect.assert_called_once()
+
+ def test_no_cache_redirects_with_error(self):
+ """POST with valid params but no cache adds error and redirects."""
+ view = self._view()
+ device = _make_device()
+ installed = _make_module()
+ request = _make_request("POST", data={"module_id": "42", "ent_index": "100"})
+
+ with (
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", side_effect=[device, installed]),
+ patch.object(view, "require_all_permissions", return_value=None),
+ patch.object(view, "get_cache_key", return_value="ck"),
+ patch("netbox_librenms_plugin.views.sync.modules.reverse", return_value="/sync/"),
+ patch("netbox_librenms_plugin.views.sync.modules.cache") as mock_cache,
+ patch("netbox_librenms_plugin.views.sync.modules.messages") as mock_msg,
+ patch("netbox_librenms_plugin.views.sync.modules.redirect") as mock_redirect,
+ ):
+ mock_cache.get.return_value = None
+ view.post(request, pk=24)
+
+ mock_msg.error.assert_called_once()
+ mock_redirect.assert_called_once()
+
+ def test_replace_deletes_old_and_creates_new(self):
+ """POST with valid data deletes old module and creates new one."""
+ view = self._view()
+ device = _make_device()
+ sync_device = _make_device(pk=999, name="vc-sync-device")
+ installed = _make_module(serial="OLD", type_id=5)
+ request = _make_request("POST", data={"module_id": "42", "ent_index": "100", "server_key": "prod"})
+ cached = [{"entPhysicalIndex": 100, "entPhysicalModelName": "XCM-7s", "entPhysicalSerialNum": "NEW"}]
+ matched_type = MagicMock()
+ matched_type.model = "XCM-7s"
+
+ new_module = MagicMock()
+
+ with (
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", side_effect=[device, installed]),
+ patch.object(view, "require_all_permissions", return_value=None),
+ patch.object(view, "get_cache_key", return_value="ck") as mock_get_cache_key,
+ patch(
+ "netbox_librenms_plugin.views.sync.modules._get_sync_device_for_inventory",
+ return_value=sync_device,
+ ) as mock_get_sync_device,
+ patch("netbox_librenms_plugin.views.sync.modules.reverse", return_value="/sync/"),
+ patch("netbox_librenms_plugin.views.sync.modules.cache") as mock_cache,
+ patch(
+ "netbox_librenms_plugin.views.sync.modules.get_module_types_indexed",
+ return_value={"XCM-7s": matched_type},
+ ),
+ patch("netbox_librenms_plugin.utils.apply_normalization_rules", return_value="XCM-7s"),
+ patch("netbox_librenms_plugin.views.sync.modules.transaction") as mock_tx,
+ patch("netbox_librenms_plugin.views.sync.modules.messages") as mock_msg,
+ patch("netbox_librenms_plugin.views.sync.modules.redirect"),
+ patch("dcim.models.Module") as mock_module_cls,
+ ):
+ mock_cache.get.return_value = {"inventory": cached, "librenms_id": "test"}
+ mock_tx.atomic.return_value.__enter__ = lambda s: s
+ mock_tx.atomic.return_value.__exit__ = MagicMock(return_value=False)
+ mock_module_cls.return_value = new_module
+ # New code does TWO select_for_update() calls inside the atomic
+ # block β one for the installed-module re-fetch, one for the
+ # serial-conflict re-derivation (returns empty list here).
+ installed_chain = MagicMock()
+ installed_chain.filter.return_value.select_related.return_value.first.return_value = installed
+ conflict_chain = MagicMock()
+ conflict_chain.filter.return_value.exclude.return_value.select_related.return_value.__iter__ = lambda s: (
+ iter([])
+ )
+ mock_module_cls.objects.select_for_update.side_effect = [installed_chain, conflict_chain]
+
+ view.post(request, pk=24)
+
+ installed.delete.assert_called_once()
+ new_module.full_clean.assert_called_once()
+ new_module.save.assert_called_once()
+ mock_msg.success.assert_called_once()
+ # server_key from POST must be forwarded to the cache key lookup
+ mock_get_sync_device.assert_called_with(device, "prod")
+ mock_get_cache_key.assert_called_with(sync_device, "inventory", server_key="prod")
+
+ def test_replace_removes_serial_conflict_from_db(self):
+ """POST re-derives the conflicting module from serial, not from conflict_module_id."""
+ view = self._view()
+ device = _make_device()
+ installed = _make_module(serial="OLD", type_id=5)
+ # No conflict_module_id in POST β conflict must be derived from serial
+ request = _make_request("POST", data={"module_id": "42", "ent_index": "100", "server_key": "prod"})
+ cached = [
+ {"entPhysicalIndex": 100, "entPhysicalModelName": "XCM-7s", "entPhysicalSerialNum": "CONFLICT_SERIAL"}
+ ]
+ matched_type = MagicMock()
+ matched_type.model = "XCM-7s"
+
+ conflict = _make_module(pk=55, serial="CONFLICT_SERIAL", bay_name="Slot 3")
+ new_module = MagicMock()
+
+ with (
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", side_effect=[device, installed]),
+ patch.object(view, "require_all_permissions", return_value=None),
+ patch.object(view, "get_cache_key", return_value="ck"),
+ patch("netbox_librenms_plugin.views.sync.modules.reverse", return_value="/sync/"),
+ patch("netbox_librenms_plugin.views.sync.modules.cache") as mock_cache,
+ patch(
+ "netbox_librenms_plugin.views.sync.modules.get_module_types_indexed",
+ return_value={"XCM-7s": matched_type},
+ ),
+ patch("netbox_librenms_plugin.utils.apply_normalization_rules", return_value="XCM-7s"),
+ patch("netbox_librenms_plugin.views.sync.modules.transaction") as mock_tx,
+ patch("netbox_librenms_plugin.views.sync.modules.messages") as mock_msg,
+ patch("netbox_librenms_plugin.views.sync.modules.redirect"),
+ patch("dcim.models.Module") as mock_module_cls,
+ ):
+ mock_cache.get.return_value = {"inventory": cached, "librenms_id": "test"}
+ mock_tx.atomic.return_value.__enter__ = lambda s: s
+ mock_tx.atomic.return_value.__exit__ = MagicMock(return_value=False)
+ mock_module_cls.return_value = new_module
+ # New code: both the installed re-fetch and the serial-conflict
+ # re-derivation use select_for_update() to lock both rows inside
+ # the atomic block. Configure the chained mocks accordingly:
+ # 1. installed = Module.objects.select_for_update()
+ # .filter(pk=, device=).select_related().first()
+ # 2. conflicts = list(Module.objects.select_for_update()
+ # .filter(serial=).exclude(pk=).select_related(...))
+ installed_chain = MagicMock()
+ installed_chain.filter.return_value.select_related.return_value.first.return_value = installed
+ conflict_chain = MagicMock()
+ conflict_chain.filter.return_value.exclude.return_value.select_related.return_value.__iter__ = lambda s: (
+ iter([conflict])
+ )
+ mock_module_cls.objects.select_for_update.side_effect = [installed_chain, conflict_chain]
+
+ view.post(request, pk=24)
+
+ # Conflict module must be deleted, then the installed module, then new one saved
+ conflict.delete.assert_called_once()
+ installed.delete.assert_called_once()
+ new_module.save.assert_called_once()
+ mock_msg.info.assert_called_once()
+ mock_msg.success.assert_called_once()
+
+ def test_requires_all_permissions(self):
+ """POST returns early when require_all_permissions returns a response."""
+ from django.http import HttpResponse
+
+ view = self._view()
+ device = _make_device()
+ request = _make_request("POST", data={"module_id": "42", "ent_index": "100"})
+
+ deny = HttpResponse(status=403)
+
+ with (
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", return_value=device),
+ patch.object(view, "require_all_permissions", return_value=deny),
+ ):
+ resp = view.post(request, pk=24)
+
+ assert resp.status_code == 403
+
+
+# ---------------------------------------------------------------------------
+# MoveModuleView
+# ---------------------------------------------------------------------------
+
+
+class TestMoveModuleView:
+ def _view(self):
+ from netbox_librenms_plugin.views.sync.modules import MoveModuleView
+
+ v = object.__new__(MoveModuleView)
+ v.required_object_permissions = {}
+ return v
+
+ def test_missing_params_redirects_with_error(self):
+ """POST without conflict_module_id or target_bay_id redirects with error."""
+ view = self._view()
+ device = _make_device()
+ request = _make_request("POST", data={})
+
+ with (
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", return_value=device),
+ patch.object(view, "require_all_permissions", return_value=None),
+ patch("netbox_librenms_plugin.views.sync.modules.reverse", return_value="/sync/"),
+ patch("netbox_librenms_plugin.views.sync.modules.messages") as mock_msg,
+ patch("netbox_librenms_plugin.views.sync.modules.redirect") as mock_redirect,
+ ):
+ view.post(request, pk=24)
+
+ mock_msg.error.assert_called_once()
+ mock_redirect.assert_called_once()
+
+ def test_move_updates_module_bay(self):
+ """POST moves conflict_module to target_bay."""
+ view = self._view()
+ device = _make_device(pk=24)
+ conflict_module = _make_module(pk=99, serial="SN1", bay_name="Slot 3", bay_id=30)
+ target_bay = MagicMock()
+ target_bay.name = "Slot 1"
+ target_bay.pk = 10
+ request = _make_request("POST", data={"conflict_module_id": "99", "target_bay_id": "10"})
+
+ with (
+ patch(
+ "netbox_librenms_plugin.views.sync.modules.get_object_or_404",
+ side_effect=[device, target_bay],
+ ),
+ patch.object(view, "require_all_permissions", return_value=None),
+ patch("netbox_librenms_plugin.views.sync.modules.reverse", return_value="/sync/"),
+ patch("netbox_librenms_plugin.views.sync.modules.transaction") as mock_tx,
+ patch("netbox_librenms_plugin.views.sync.modules.messages") as mock_msg,
+ patch("netbox_librenms_plugin.views.sync.modules.redirect"),
+ patch("dcim.models.Module") as mock_module_cls,
+ patch("dcim.models.ModuleBay") as mock_bay_cls,
+ ):
+ mock_tx.atomic.return_value.__enter__ = lambda s: s
+ mock_tx.atomic.return_value.__exit__ = MagicMock(return_value=False)
+ # select_for_update on ModuleBay returns locked target_bay
+ mock_bay_cls.objects.select_for_update.return_value.get.return_value = target_bay
+ # select_for_update chain returns conflict_module
+ sfu_qs = MagicMock()
+ sfu_qs.filter.return_value.select_related.return_value.first.return_value = conflict_module
+ mock_module_cls.objects.select_for_update.return_value = sfu_qs
+ # No occupant in target bay
+ mock_module_cls.objects.select_for_update.return_value.filter.return_value.first.return_value = None
+
+ view.post(request, pk=24)
+
+ assert conflict_module.module_bay is target_bay
+ assert conflict_module.device is device
+ conflict_module.full_clean.assert_called_once()
+ conflict_module.save.assert_called_once()
+ mock_msg.success.assert_called_once()
+
+ def test_requires_all_permissions(self):
+ """POST returns early when require_all_permissions returns a response."""
+ from django.http import HttpResponse
+
+ view = self._view()
+ device = _make_device()
+ request = _make_request("POST", data={"conflict_module_id": "99", "target_bay_id": "10"})
+
+ deny = HttpResponse(status=403)
+ with (
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", return_value=device),
+ patch.object(view, "require_all_permissions", return_value=deny),
+ ):
+ resp = view.post(request, pk=24)
+
+ assert resp.status_code == 403
diff --git a/netbox_librenms_plugin/tests/test_modules_view.py b/netbox_librenms_plugin/tests/test_modules_view.py
new file mode 100644
index 0000000000..d4306fdfab
--- /dev/null
+++ b/netbox_librenms_plugin/tests/test_modules_view.py
@@ -0,0 +1,3797 @@
+"""
+Tests for BaseModuleTableView sync logic (modules_view.py).
+
+Focuses on the bay-scope tracking in _build_context and the serial
+comparison logic in _build_row.
+"""
+
+from unittest.mock import MagicMock, patch
+
+
+# ---------------------------------------------------------------------------
+# Helpers
+# ---------------------------------------------------------------------------
+
+
+def _make_view():
+ """Instantiate BaseModuleTableView bypassing __init__."""
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ view = object.__new__(BaseModuleTableView)
+ view._device_manufacturer = None
+ view._librenms_api = MagicMock(server_key="test-server")
+ view.get_cache_key = MagicMock(return_value="test_cache_key")
+ return view
+
+
+def _captured_table_view(view):
+ """Replace get_table with a version that captures the raw table_data list."""
+ rows_store = {}
+
+ def fake_get_table(table_data, obj):
+ rows_store["rows"] = table_data
+ m = MagicMock()
+ m.configure = MagicMock()
+ return m
+
+ view.get_table = fake_get_table
+ return rows_store
+
+
+def _run_build_context(view, inventory_data, device_bays, module_scoped_bays, module_types, bay_mappings=None):
+ """Call _build_context with all DB-accessing calls mocked out.
+
+ `bay_mappings` is an optional (exact_list, regex_list) tuple of ModuleBayMapping-like
+ objects. When None, mappings are empty and matching exercises only direct-name
+ and positional fallbacks.
+ """
+ rows_store = _captured_table_view(view)
+ view._get_module_bays = MagicMock(return_value=(device_bays, module_scoped_bays))
+ view._get_module_types = MagicMock(return_value=module_types)
+ view._get_generic_module_types = MagicMock(return_value={})
+ view._get_module_type_ambiguities = MagicMock(return_value={})
+ view._get_carrier_install_rules = MagicMock(return_value=[])
+
+ if bay_mappings is None:
+ bay_mappings = ([], [])
+
+ with (
+ patch("netbox_librenms_plugin.views.base.modules_view.cache") as mock_cache,
+ patch("netbox_librenms_plugin.utils.load_bay_mappings", return_value=bay_mappings),
+ patch("netbox_librenms_plugin.utils.get_enabled_ignore_rules", return_value=[]),
+ patch("netbox_librenms_plugin.utils.apply_normalization_rules", side_effect=lambda v, *a, **kw: v),
+ patch("netbox_librenms_plugin.utils.preload_normalization_rules", return_value={}),
+ patch("netbox_librenms_plugin.utils.has_nested_name_conflict", return_value=False),
+ # _detect_serial_conflicts makes a real DB query; mock it out for unit tests
+ patch.object(view.__class__, "_detect_serial_conflicts", return_value=None),
+ ):
+ mock_cache.ttl = MagicMock(return_value=None)
+
+ # Inline import: patch ModuleBayMapping inside models module
+ view._build_context(MagicMock(), MagicMock(), inventory_data)
+
+ return rows_store.get("rows", [])
+
+
+def _load_contrib_bay_mappings():
+ """Load contrib bay mappings as fake ModuleBayMapping objects (no DB)."""
+ import re as _re
+ from pathlib import Path
+
+ import yaml
+
+ contrib_path = Path(__file__).resolve().parents[2] / "contrib" / "module_bay_mappings.yaml"
+ with open(contrib_path) as f:
+ data = yaml.safe_load(f)
+
+ class _FakeMap:
+ def __init__(self, **kw):
+ self.librenms_name = kw["librenms_name"]
+ self.librenms_class = kw.get("librenms_class") or ""
+ self.netbox_bay_name = kw["netbox_bay_name"]
+ self.is_regex = kw.get("is_regex", False)
+ self._compiled_pattern = None
+ if self.is_regex:
+ try:
+ self._compiled_pattern = _re.compile(self.librenms_name)
+ except _re.error:
+ pass
+
+ mappings = [_FakeMap(**m) for m in data]
+ exact = [m for m in mappings if not m.is_regex]
+ regex = [m for m in mappings if m.is_regex]
+ return exact, regex
+
+
+# ---------------------------------------------------------------------------
+# Inventory data factories
+# ---------------------------------------------------------------------------
+
+
+def _linecard_inventory():
+ """
+ Minimal inventory modelling the prod-lab03-sw4 scenario:
+
+ Linecard(slot 3) [WS-X4908, module, top-level]
+ X2 Port 2 [container, no model]
+ Converter 3/2 [CVR-X2-SFP, other] β INSTALLED in NetBox
+ SFP slot [container, no model]
+ GE3/11 [GLC-TE, port, serial=MTC213403BB]
+ X2 Port 4 [container, no model]
+ Converter 3/4 [CVR-X2-SFP, other] β NOT installed in NetBox
+ SFP slot 4 [container, no model]
+ GE3/15 [GLC-T, port, serial=MTC19330SQC]
+ """
+ return [
+ {
+ "entPhysicalIndex": 1,
+ "entPhysicalName": "Slot 3",
+ "entPhysicalModelName": "WS-X4908",
+ "entPhysicalClass": "module",
+ "entPhysicalContainedIn": 0,
+ "entPhysicalSerialNum": "S_LINECARD",
+ "entPhysicalParentRelPos": 3,
+ },
+ # --- X2 Port 2 branch (installed CVR) ---
+ {
+ "entPhysicalIndex": 10,
+ "entPhysicalName": "X2 Port 2",
+ "entPhysicalModelName": "",
+ "entPhysicalClass": "container",
+ "entPhysicalContainedIn": 1,
+ "entPhysicalSerialNum": "",
+ "entPhysicalParentRelPos": 2,
+ },
+ {
+ "entPhysicalIndex": 11,
+ "entPhysicalName": "Converter 3/2",
+ "entPhysicalModelName": "CVR-X2-SFP",
+ "entPhysicalClass": "other",
+ "entPhysicalContainedIn": 10,
+ "entPhysicalSerialNum": "FDO_CVR2",
+ "entPhysicalParentRelPos": 1,
+ },
+ {
+ "entPhysicalIndex": 12,
+ "entPhysicalName": "SFP slot",
+ "entPhysicalModelName": "",
+ "entPhysicalClass": "container",
+ "entPhysicalContainedIn": 11,
+ "entPhysicalSerialNum": "",
+ "entPhysicalParentRelPos": 1,
+ },
+ {
+ "entPhysicalIndex": 13,
+ "entPhysicalName": "GigabitEthernet3/11",
+ "entPhysicalModelName": "GLC-TE",
+ "entPhysicalClass": "port",
+ "entPhysicalContainedIn": 12,
+ "entPhysicalSerialNum": "MTC213403BB",
+ "entPhysicalParentRelPos": 1,
+ },
+ # --- X2 Port 4 branch (NOT installed CVR) ---
+ {
+ "entPhysicalIndex": 20,
+ "entPhysicalName": "X2 Port 4",
+ "entPhysicalModelName": "",
+ "entPhysicalClass": "container",
+ "entPhysicalContainedIn": 1,
+ "entPhysicalSerialNum": "",
+ "entPhysicalParentRelPos": 4,
+ },
+ {
+ "entPhysicalIndex": 21,
+ "entPhysicalName": "Converter 3/4",
+ "entPhysicalModelName": "CVR-X2-SFP",
+ "entPhysicalClass": "other",
+ "entPhysicalContainedIn": 20,
+ "entPhysicalSerialNum": "FDO_CVR4",
+ "entPhysicalParentRelPos": 1,
+ },
+ {
+ "entPhysicalIndex": 22,
+ "entPhysicalName": "SFP slot 4",
+ "entPhysicalModelName": "",
+ "entPhysicalClass": "container",
+ "entPhysicalContainedIn": 21,
+ "entPhysicalSerialNum": "",
+ "entPhysicalParentRelPos": 1,
+ },
+ {
+ "entPhysicalIndex": 23,
+ "entPhysicalName": "GigabitEthernet3/15",
+ "entPhysicalModelName": "GLC-T",
+ "entPhysicalClass": "port",
+ "entPhysicalContainedIn": 22,
+ "entPhysicalSerialNum": "MTC19330SQC",
+ "entPhysicalParentRelPos": 1,
+ },
+ ]
+
+
+def _bay_setup():
+ """Build mock device_bays and module_scoped_bays matching _linecard_inventory."""
+ # --- module instances (NetBox Module objects) ---
+ linecard_module = MagicMock()
+ linecard_module.pk = 100
+ linecard_module.serial = "S_LINECARD"
+ linecard_module.module_type_id = 10 # matches mt_linecard.pk
+
+ cvr2_module = MagicMock()
+ cvr2_module.pk = 200
+ cvr2_module.serial = "FDO_CVR2"
+ cvr2_module.module_type_id = 20 # matches mt_cvr.pk
+
+ glc_te_installed = MagicMock()
+ glc_te_installed.serial = "MTC213403BB"
+ glc_te_installed.get_absolute_url.return_value = "/modules/99/"
+ glc_te_installed.module_type_id = 30 # matches mt_glc_te.pk
+
+ # --- device-level bays ---
+ slot3_bay = MagicMock()
+ slot3_bay.name = "Slot 3"
+ slot3_bay.installed_module = linecard_module
+ device_bays = {"Slot 3": slot3_bay}
+
+ # --- module-scoped bays created by the linecard ---
+ x2p2_bay = MagicMock()
+ x2p2_bay.name = "X2 Port 2"
+ x2p2_bay.installed_module = cvr2_module # INSTALLED
+
+ x2p4_bay = MagicMock()
+ x2p4_bay.name = "X2 Port 4"
+ x2p4_bay.installed_module = None # NOT installed
+
+ # --- module-scoped bays created by the installed CVR at X2 Port 2 ---
+ sfp1_bay = MagicMock()
+ sfp1_bay.name = "SFP 1"
+ sfp1_bay.installed_module = glc_te_installed
+
+ sfp2_bay = MagicMock()
+ sfp2_bay.name = "SFP 2"
+ sfp2_bay.installed_module = None
+
+ module_scoped_bays = {
+ 100: {"X2 Port 2": x2p2_bay, "X2 Port 4": x2p4_bay},
+ 200: {"SFP 1": sfp1_bay, "SFP 2": sfp2_bay},
+ }
+
+ return device_bays, module_scoped_bays
+
+
+def _module_types():
+ """Minimal module-type dict for the test scenario."""
+ mt_linecard = MagicMock()
+ mt_linecard.pk = 10
+ mt_linecard.model = "WS-X4908"
+ mt_cvr = MagicMock()
+ mt_cvr.pk = 20
+ mt_cvr.model = "CVR-X2-SFP"
+ mt_glc_te = MagicMock()
+ mt_glc_te.pk = 30
+ mt_glc_te.model = "GLC-TE"
+ mt_glc_t = MagicMock()
+ mt_glc_t.pk = 40
+ mt_glc_t.model = "GLC-T"
+ return {
+ "WS-X4908": mt_linecard,
+ "CVR-X2-SFP": mt_cvr,
+ "GLC-TE": mt_glc_te,
+ "GLC-T": mt_glc_t,
+ }
+
+
+# ---------------------------------------------------------------------------
+# Tests
+# ---------------------------------------------------------------------------
+
+
+class TestBayDepthScopeWithUninstalledParent:
+ """
+ Regression tests for the stale bays_by_depth bug.
+
+ Scenario: two converters at depth-1 share the same parent linecard.
+ Converter 3/2 IS installed (it has SFP child bays).
+ Converter 3/4 is NOT installed (no SFP child bays exist yet in NetBox).
+
+ Bug: bays_by_depth[2] is set when processing Converter 3/2, and NOT
+ cleared when processing Converter 3/4. GigabitEthernet3/15 (depth-2
+ child of Converter 3/4) then inherits the stale SFP scope and gets
+ "Serial Mismatch" instead of "No Bay".
+
+ Fix: when a matched bay has no installed module, set bays_by_depth[depth+1]
+ to {} to prevent leakage to subsequent siblings at the same depth.
+ """
+
+ def _build_rows(self):
+ view = _make_view()
+ device_bays, module_scoped_bays = _bay_setup()
+ module_types = _module_types()
+ return _run_build_context(view, _linecard_inventory(), device_bays, module_scoped_bays, module_types)
+
+ def _row(self, rows, name):
+ for r in rows:
+ if r.get("name") == name:
+ return r
+ return None
+
+ def test_glc_t_under_installed_converter_is_installed(self):
+ """GLC-TE under the installed Converter 3/2 must show 'Installed'."""
+ rows = self._build_rows()
+ row = self._row(rows, "GigabitEthernet3/11")
+ assert row is not None, "GigabitEthernet3/11 row not found"
+ assert row["status"] == "Installed", (
+ f"Expected 'Installed' but got {row['status']!r} β GLC-TE under an installed CVR should be Installed"
+ )
+
+ def test_glc_t_under_uninstalled_converter_is_no_bay_not_serial_mismatch(self):
+ """
+ GLC-T under the uninstalled Converter 3/4 must show 'No Bay'.
+
+ Before the fix, bays_by_depth[2] retains the SFP scope from
+ Converter 3/2 and GigabitEthernet3/15 incorrectly gets 'Serial Mismatch'.
+ """
+ rows = self._build_rows()
+ row = self._row(rows, "GigabitEthernet3/15")
+ assert row is not None, "GigabitEthernet3/15 row not found"
+ assert row["status"] != "Serial Mismatch", (
+ "GigabitEthernet3/15 shows 'Serial Mismatch' β stale bays_by_depth scope "
+ "leaking from Converter 3/2 into Converter 3/4's child items (regression)"
+ )
+ assert row["status"] == "No Bay", (
+ f"Expected 'No Bay' but got {row['status']!r}; "
+ "the parent converter is not installed so child SFPs cannot be matched"
+ )
+
+ def test_uninstalled_converter_itself_shows_matched(self):
+ """Converter 3/4 is matched to X2 Port 4 but not yet installed β 'Matched'."""
+ rows = self._build_rows()
+ row = self._row(rows, "Converter 3/4")
+ assert row is not None, "Converter 3/4 row not found"
+ assert row["status"] == "Matched", f"Expected 'Matched' but got {row['status']!r} for uninstalled converter"
+
+ def test_installed_converter_itself_shows_installed(self):
+ """Converter 3/2 is installed in X2 Port 2 with matching serial β 'Installed'."""
+ rows = self._build_rows()
+ row = self._row(rows, "Converter 3/2")
+ assert row is not None, "Converter 3/2 row not found"
+ assert row["status"] == "Installed", f"Expected 'Installed' but got {row['status']!r} for installed converter"
+
+ def test_no_stale_scope_across_multiple_siblings(self):
+ """
+ bays_by_depth is reset for EACH sibling, so the second uninstalled
+ converter does not leak into a third converter's children."""
+ # Add a second installed converter at X2 Port 6 and verify its SFP
+ # also shows correct status, unaffected by the reset for X2 Port 4.
+ inventory = _linecard_inventory() + [
+ {
+ "entPhysicalIndex": 30,
+ "entPhysicalName": "X2 Port 6",
+ "entPhysicalModelName": "",
+ "entPhysicalClass": "container",
+ "entPhysicalContainedIn": 1,
+ "entPhysicalSerialNum": "",
+ "entPhysicalParentRelPos": 6,
+ },
+ {
+ "entPhysicalIndex": 31,
+ "entPhysicalName": "Converter 3/6",
+ "entPhysicalModelName": "CVR-X2-SFP",
+ "entPhysicalClass": "other",
+ "entPhysicalContainedIn": 30,
+ "entPhysicalSerialNum": "FDO_CVR6",
+ "entPhysicalParentRelPos": 1,
+ },
+ {
+ "entPhysicalIndex": 32,
+ "entPhysicalName": "SFP slot 6",
+ "entPhysicalModelName": "",
+ "entPhysicalClass": "container",
+ "entPhysicalContainedIn": 31,
+ "entPhysicalSerialNum": "",
+ "entPhysicalParentRelPos": 1,
+ },
+ {
+ "entPhysicalIndex": 33,
+ "entPhysicalName": "GigabitEthernet3/22",
+ "entPhysicalModelName": "GLC-TE",
+ "entPhysicalClass": "port",
+ "entPhysicalContainedIn": 32,
+ "entPhysicalSerialNum": "SFP6_SERIAL",
+ "entPhysicalParentRelPos": 1,
+ },
+ ]
+
+ view = _make_view()
+ device_bays, module_scoped_bays = _bay_setup()
+ module_types = _module_types()
+
+ # Add a third installed CVR at X2 Port 6 with its own SFP 1 bay
+ cvr6_module = MagicMock()
+ cvr6_module.pk = 300
+ cvr6_module.serial = "FDO_CVR6"
+ cvr6_module.module_type_id = 20 # matches mt_cvr.pk
+
+ sfp1_bay_6 = MagicMock()
+ sfp1_bay_6.name = "SFP 1"
+ sfp6_installed = MagicMock()
+ sfp6_installed.serial = "SFP6_SERIAL"
+ sfp6_installed.get_absolute_url.return_value = "/modules/199/"
+ sfp6_installed.module_type_id = 30 # matches mt_glc_te.pk
+ sfp1_bay_6.installed_module = sfp6_installed
+
+ x2p6_bay = MagicMock()
+ x2p6_bay.name = "X2 Port 6"
+ x2p6_bay.installed_module = cvr6_module
+
+ module_scoped_bays[100]["X2 Port 6"] = x2p6_bay
+ module_scoped_bays[300] = {"SFP 1": sfp1_bay_6}
+
+ rows = _run_build_context(view, inventory, device_bays, module_scoped_bays, module_types)
+
+ def _row(name):
+ return next((r for r in rows if r.get("name") == name), None)
+
+ # The GE3/22 under the 3rd converter (installed) should be Installed
+ row6 = _row("GigabitEthernet3/22")
+ assert row6 is not None, "GigabitEthernet3/22 not found"
+ assert row6["status"] == "Installed", (
+ f"Expected 'Installed' but got {row6['status']!r} β "
+ "GLC-TE under installed Converter 3/6 should be Installed"
+ )
+ # And GE3/15 under the uninstalled converter is still No Bay
+ row15 = _row("GigabitEthernet3/15")
+ assert row15["status"] == "No Bay", f"GigabitEthernet3/15 status {row15['status']!r} β should still be No Bay"
+
+
+# ---------------------------------------------------------------------------
+# Production-shape inventory factories
+# ---------------------------------------------------------------------------
+
+
+def _prod_inventory_ws_x4908():
+ """
+ Inventory shape captured from a live Cisco WS-X4908-10GE linecard
+ (NetBox device prod-lab03-sw4 / LibreNMS production:7).
+
+ Real LibreNMS naming with anonymized indices:
+ chassis "Switch System"
+ container "Slot 3" [no model]
+ module "Linecard(slot 3)" [WS-X4908-10GE]
+ container "Port Container 3/2" [no model, relPos=3]
+ other "Converter 3/2" [CVR-X2-SFP, relPos=1]
+ container "Port Container 3/11" [no model, relPos=9]
+ port "GigabitEthernet3/11" [GLC-TE, relPos=1]
+ container "Port Container 3/12" [no model, relPos=10]
+ port "GigabitEthernet3/12" [GLC-T, relPos=1]
+
+ Distinct from `_linecard_inventory` whose container names ("Slot 3",
+ "X2 Port 2", "SFP slot") match NetBox bays directly and never exercise
+ the contrib regex paths. This fixture forces matching through:
+ - `^Linecard\\(slot (\\d+)\\)$` regex for the linecard itself
+ - `^Port Container (\\d+)/(\\d+)$` regex for X2 slot resolution
+ - positional fallback for SFP transceivers inside the CVR
+ """
+ return [
+ {
+ "entPhysicalIndex": 1,
+ "entPhysicalName": "Switch System",
+ "entPhysicalModelName": "MIDPLANE",
+ "entPhysicalClass": "chassis",
+ "entPhysicalContainedIn": 0,
+ "entPhysicalSerialNum": "S_CHASSIS",
+ "entPhysicalParentRelPos": 1,
+ },
+ {
+ "entPhysicalIndex": 4,
+ "entPhysicalName": "Slot 3",
+ "entPhysicalModelName": "",
+ "entPhysicalClass": "container",
+ "entPhysicalContainedIn": 1,
+ "entPhysicalSerialNum": "",
+ "entPhysicalParentRelPos": 3,
+ },
+ {
+ "entPhysicalIndex": 3000,
+ "entPhysicalName": "Linecard(slot 3)",
+ "entPhysicalModelName": "WS-X4908-10GE",
+ "entPhysicalClass": "module",
+ "entPhysicalContainedIn": 4,
+ "entPhysicalSerialNum": "S_LINECARD",
+ "entPhysicalParentRelPos": 1,
+ },
+ {
+ "entPhysicalIndex": 3003,
+ "entPhysicalName": "Port Container 3/2",
+ "entPhysicalDescr": "Port Container",
+ "entPhysicalModelName": "",
+ "entPhysicalClass": "container",
+ "entPhysicalContainedIn": 3000,
+ "entPhysicalSerialNum": "",
+ "entPhysicalParentRelPos": 3,
+ },
+ {
+ "entPhysicalIndex": 3019,
+ "entPhysicalName": "Converter 3/2",
+ "entPhysicalDescr": "Converter Module",
+ "entPhysicalModelName": "CVR-X2-SFP",
+ "entPhysicalClass": "other",
+ "entPhysicalContainedIn": 3003,
+ "entPhysicalSerialNum": "S_CVR2",
+ "entPhysicalParentRelPos": 1,
+ },
+ {
+ "entPhysicalIndex": 3028,
+ "entPhysicalName": "Port Container 3/11",
+ "entPhysicalDescr": "Port Container",
+ "entPhysicalModelName": "",
+ "entPhysicalClass": "container",
+ "entPhysicalContainedIn": 3019,
+ "entPhysicalSerialNum": "",
+ "entPhysicalParentRelPos": 9,
+ },
+ {
+ "entPhysicalIndex": 3044,
+ "entPhysicalName": "GigabitEthernet3/11",
+ "entPhysicalDescr": "1000BaseT",
+ "entPhysicalModelName": "GLC-TE",
+ "entPhysicalClass": "port",
+ "entPhysicalContainedIn": 3028,
+ "entPhysicalSerialNum": "MTC213403BB",
+ "entPhysicalParentRelPos": 1,
+ },
+ {
+ "entPhysicalIndex": 3029,
+ "entPhysicalName": "Port Container 3/12",
+ "entPhysicalDescr": "Port Container",
+ "entPhysicalModelName": "",
+ "entPhysicalClass": "container",
+ "entPhysicalContainedIn": 3019,
+ "entPhysicalSerialNum": "",
+ "entPhysicalParentRelPos": 10,
+ },
+ {
+ "entPhysicalIndex": 3045,
+ "entPhysicalName": "GigabitEthernet3/12",
+ "entPhysicalDescr": "1000BaseT",
+ "entPhysicalModelName": "GLC-T",
+ "entPhysicalClass": "port",
+ "entPhysicalContainedIn": 3029,
+ "entPhysicalSerialNum": "GE12_SERIAL",
+ "entPhysicalParentRelPos": 1,
+ },
+ ]
+
+
+def _prod_bay_setup_ws_x4908(cvr_installed=True):
+ """
+ NetBox bay structure mirroring prod-lab03-sw4:
+ Device-bays: Slot 3 (linecard installed)
+ WS-X4908-10GE bays: X2 Port 1..8 (X2 Port 2 holds CVR if cvr_installed)
+ CVR-X2-SFP bays: SFP 1, SFP 2 (none installed)
+ """
+ linecard_module = MagicMock()
+ linecard_module.pk = 100
+ linecard_module.serial = "S_LINECARD"
+ linecard_module.module_type_id = 10
+
+ cvr2_module = MagicMock()
+ cvr2_module.pk = 200
+ cvr2_module.serial = "S_CVR2"
+ cvr2_module.module_type_id = 20
+
+ slot3_bay = MagicMock()
+ slot3_bay.name = "Slot 3"
+ slot3_bay.installed_module = linecard_module
+ slot3_bay.get_absolute_url.return_value = "/bay/slot3"
+ device_bays = {"Slot 3": slot3_bay}
+
+ linecard_bays = {}
+ for n in range(1, 9):
+ b = MagicMock()
+ b.name = f"X2 Port {n}"
+ b.installed_module = cvr2_module if (n == 2 and cvr_installed) else None
+ b.get_absolute_url.return_value = f"/bay/x2-{n}"
+ linecard_bays[f"X2 Port {n}"] = b
+
+ module_scoped_bays = {100: linecard_bays}
+
+ if cvr_installed:
+ cvr_bays = {}
+ for n in range(1, 3):
+ b = MagicMock()
+ b.name = f"SFP {n}"
+ b.installed_module = None
+ b.get_absolute_url.return_value = f"/bay/sfp-{n}"
+ cvr_bays[f"SFP {n}"] = b
+ module_scoped_bays[200] = cvr_bays
+
+ return device_bays, module_scoped_bays
+
+
+def _prod_module_types():
+ mt_lc = MagicMock()
+ mt_lc.pk = 10
+ mt_lc.model = "WS-X4908-10GE"
+ mt_lc.get_absolute_url.return_value = "/mt/lc"
+ mt_cvr = MagicMock()
+ mt_cvr.pk = 20
+ mt_cvr.model = "CVR-X2-SFP"
+ mt_cvr.get_absolute_url.return_value = "/mt/cvr"
+ mt_glc_te = MagicMock()
+ mt_glc_te.pk = 30
+ mt_glc_te.model = "GLC-TE"
+ mt_glc_te.get_absolute_url.return_value = "/mt/glc-te"
+ mt_glc_t = MagicMock()
+ mt_glc_t.pk = 40
+ mt_glc_t.model = "GLC-T"
+ mt_glc_t.get_absolute_url.return_value = "/mt/glc-t"
+ return {
+ "WS-X4908-10GE": mt_lc,
+ "CVR-X2-SFP": mt_cvr,
+ "GLC-TE": mt_glc_te,
+ "GLC-T": mt_glc_t,
+ }
+
+
+class TestProdShapeWS4908Matching:
+ """
+ Bay matching against real production data shape from a Cisco WS-X4908-10GE.
+
+ Distinct from `TestBayDepthScopeWithUninstalledParent`, whose synthetic
+ container names match bay names directly without exercising the contrib
+ regex paths. This class loads the contrib YAML and asserts each level
+ of the chain β linecard regex, X2 slot regex, and CVR-internal positional
+ fallback β actually does what the contrib mappings claim.
+ """
+
+ def _build_rows(self, cvr_installed=True):
+ view = _make_view()
+ device_bays, module_scoped_bays = _prod_bay_setup_ws_x4908(cvr_installed=cvr_installed)
+ return _run_build_context(
+ view,
+ _prod_inventory_ws_x4908(),
+ device_bays,
+ module_scoped_bays,
+ _prod_module_types(),
+ bay_mappings=_load_contrib_bay_mappings(),
+ )
+
+ def _row(self, rows, name):
+ for r in rows:
+ if r.get("name") == name:
+ return r
+ return None
+
+ def test_linecard_matches_slot_via_regex(self):
+ """`Linecard(slot 3)` resolves to device-bay `Slot 3` via the Linecard regex."""
+ rows = self._build_rows()
+ row = self._row(rows, "Linecard(slot 3)")
+ assert row is not None, "Linecard(slot 3) row not found"
+ assert row["module_bay"] == "Slot 3", (
+ f"Expected module_bay='Slot 3' but got {row['module_bay']!r} β "
+ r"the `^Linecard\(slot (\d+)\)$` regex should resolve to `Slot N`"
+ )
+
+ def test_converter_matches_x2_port_via_parent_regex(self):
+ """`Converter 3/2`'s parent `Port Container 3/2` resolves to `X2 Port 2`."""
+ rows = self._build_rows()
+ row = self._row(rows, "Converter 3/2")
+ assert row is not None, "Converter 3/2 row not found"
+ assert row["module_bay"] == "X2 Port 2", (
+ f"Expected module_bay='X2 Port 2' but got {row['module_bay']!r} β "
+ r"parent name `Port Container 3/2` should regex-resolve to `X2 Port \2` = X2 Port 2"
+ )
+
+ def test_ge_matches_sfp1_via_positional_fallback(self):
+ """
+ `GigabitEthernet3/11` (first port-container child of Converter 3/2) matches
+ `SFP 1` on the CVR module via positional fallback.
+
+ The positional fallback indexes by **sibling order within the parent CVR**,
+ not by global port number β `Port Container 3/11` is the 1st child of
+ Converter 3/2, so it maps to `SFP 1`.
+ """
+ rows = self._build_rows()
+ row = self._row(rows, "GigabitEthernet3/11")
+ assert row is not None, "GigabitEthernet3/11 row not found"
+ assert row["module_bay"] == "SFP 1", (
+ f"Expected module_bay='SFP 1' but got {row['module_bay']!r} β "
+ "positional fallback should map the 1st port-container child of CVR-X2-SFP to SFP 1"
+ )
+
+ def test_ge_second_port_matches_sfp2_via_positional_fallback(self):
+ """`GigabitEthernet3/12` (2nd port-container child of CVR) matches `SFP 2`."""
+ rows = self._build_rows()
+ row = self._row(rows, "GigabitEthernet3/12")
+ assert row is not None, "GigabitEthernet3/12 row not found"
+ assert row["module_bay"] == "SFP 2", (
+ f"Expected module_bay='SFP 2' but got {row['module_bay']!r} β "
+ "positional fallback should map the 2nd port-container child of CVR-X2-SFP to SFP 2"
+ )
+
+ def test_ge_no_bay_when_cvr_not_installed_in_netbox(self):
+ """
+ When the CVR is matched (X2 Port 2) but no module is installed there in
+ NetBox, the deeper SFP scope is empty and GE inside the CVR shows 'No Bay'.
+
+ This is the original confusion that triggered the reverted commit
+ (216fb84): 'GE3/11 doesn't match a bay' was actually 'CVR module not
+ installed in NetBox' β the fix is to install the module, not to walk
+ ancestor names looking for a wrong bay to land on.
+ """
+ rows = self._build_rows(cvr_installed=False)
+ row = self._row(rows, "GigabitEthernet3/11")
+ assert row is not None, "GigabitEthernet3/11 row not found"
+ assert row["module_bay"] == "-", (
+ f"Expected no bay match (got {row['module_bay']!r}) β "
+ "without an installed CVR there is no SFP scope for positional fallback"
+ )
+ assert row["status"] == "No Bay", f"Expected status='No Bay' but got {row['status']!r}"
+
+ def test_no_cvr_entry_does_not_match_via_grandparent_walking(self):
+ """
+ Regression guard for reverted commit 216fb84.
+
+ Some Cisco devices expose only the Port-Container chain in ENTITY-MIB
+ (no Converter entry between linecard and port). The hierarchy is:
+
+ Linecard(slot 3)
+ Port Container 3/2 [no model β skipped, no row]
+ Port Container 3/11 [no model β skipped, no row]
+ GigabitEthernet3/11 [GLC-TE]
+
+ Because both intermediate containers are model-less, no row updates the
+ bay scope and GE3/11 inherits the linecard's bays as scope. In this
+ scope:
+ - immediate-parent regex `Port Container 3/11` β `X2 Port 11` (no such bay)
+ - grandparent regex `Port Container 3/2` β `X2 Port 2` (the bay holding
+ the CVR module, not a transceiver bay)
+
+ Correct behavior: no bay match. The reverted commit's "walk all
+ ancestors" logic resolved GE3/11 to `X2 Port 2`, semantically landing
+ the transceiver in the parent module's slot.
+ """
+ no_cvr_inventory = [
+ {
+ "entPhysicalIndex": 1,
+ "entPhysicalName": "Switch System",
+ "entPhysicalModelName": "MIDPLANE",
+ "entPhysicalClass": "chassis",
+ "entPhysicalContainedIn": 0,
+ "entPhysicalSerialNum": "S_CHASSIS",
+ "entPhysicalParentRelPos": 1,
+ },
+ {
+ "entPhysicalIndex": 4,
+ "entPhysicalName": "Slot 3",
+ "entPhysicalModelName": "",
+ "entPhysicalClass": "container",
+ "entPhysicalContainedIn": 1,
+ "entPhysicalSerialNum": "",
+ "entPhysicalParentRelPos": 3,
+ },
+ {
+ "entPhysicalIndex": 3000,
+ "entPhysicalName": "Linecard(slot 3)",
+ "entPhysicalModelName": "WS-X4908-10GE",
+ "entPhysicalClass": "module",
+ "entPhysicalContainedIn": 4,
+ "entPhysicalSerialNum": "S_LINECARD",
+ "entPhysicalParentRelPos": 1,
+ },
+ {
+ "entPhysicalIndex": 3003,
+ "entPhysicalName": "Port Container 3/2",
+ "entPhysicalModelName": "",
+ "entPhysicalClass": "container",
+ "entPhysicalContainedIn": 3000,
+ "entPhysicalSerialNum": "",
+ "entPhysicalParentRelPos": 3,
+ },
+ {
+ "entPhysicalIndex": 3028,
+ "entPhysicalName": "Port Container 3/11",
+ "entPhysicalModelName": "",
+ "entPhysicalClass": "container",
+ "entPhysicalContainedIn": 3003,
+ "entPhysicalSerialNum": "",
+ "entPhysicalParentRelPos": 9,
+ },
+ {
+ "entPhysicalIndex": 3044,
+ "entPhysicalName": "GigabitEthernet3/11",
+ "entPhysicalModelName": "GLC-TE",
+ "entPhysicalClass": "port",
+ "entPhysicalContainedIn": 3028,
+ "entPhysicalSerialNum": "MTC213403BB",
+ "entPhysicalParentRelPos": 1,
+ },
+ ]
+ view = _make_view()
+ device_bays, module_scoped_bays = _prod_bay_setup_ws_x4908(cvr_installed=True)
+ rows = _run_build_context(
+ view,
+ no_cvr_inventory,
+ device_bays,
+ module_scoped_bays,
+ _prod_module_types(),
+ bay_mappings=_load_contrib_bay_mappings(),
+ )
+ row = self._row(rows, "GigabitEthernet3/11")
+ assert row is not None, "GigabitEthernet3/11 row not found"
+ assert row["module_bay"] != "X2 Port 2", (
+ "GE3/11 matched X2 Port 2 β that bay holds the parent CVR module, "
+ "not a transceiver. An ancestor-walking matcher (reverted 216fb84) "
+ "would resolve `Port Container 3/2` (grandparent) to `X2 Port 2` "
+ "and incorrectly land the transceiver in the CVR's own bay."
+ )
+
+
+class TestPositionalMatchScaffoldingChain:
+ """
+ Regression coverage for `_match_bay_by_position` walking through deep
+ Cisco IOS-XR scaffolding (module ancestors with model="N/A").
+
+ Captured shape from a Cisco ASR-9904 (NetBox device prod-lab03d-ra1.lab,
+ LibreNMS production:30) β TenGigE ports inside a 24x10GE linecard:
+
+ chassis "Rack 0" [ASR-9904]
+ container "Rack 0-Line Card Slot 0" [no model]
+ module "0/0" [A9K-24X10GE-1G-TR]
+ module "0/0-Motherboard" [N/A]
+ module "0/0-Slice 0" [N/A]
+ module "0/0-Slice 0 EZChip" [N/A]
+ module "Slice 0 SFP Port Module #N" [N/A]
+ container "0/0-SFP+ bay N" [N/A]
+ module "TenGigE0/0/0/N" [SFP-10G-SR]
+
+ The 0/0 linecard's serial accidentally matches the device serial
+ (LibreNMS reports it that way for some IOS-XR units), which fires the
+ `Embedded RP / fixed-chassis system board` ignore rule with
+ action=transparent. As a result the linecard is hidden and every
+ TenGigE port is promoted to top-level β matched against the device's
+ bays {Slot 0, Slot 1, Slot 2, Slot 3}.
+
+ Bug pre-fix: the positional walk in `_match_bay_by_position` skipped
+ every modelless ancestor regardless of class, eventually landing
+ container_idx on `Motherboard` (the deepest item before the real-model
+ `0/0`). Every TenGigE port walked to the same Motherboard, took
+ position=1 inside `0/0`'s children, and matched `Slot 1` on the chassis
+ β the bay where the RSP0 line card belongs. Clicking install would
+ place SFP transceivers into the chassis line-card slots.
+
+ Fix: stop the walk on a non-container ancestor without a real model.
+ Modelless modules ("Motherboard", "Slice 0", "EZChip" et al.) are
+ scaffolding, not bay positions; treating them as walk-through containers
+ silently collapses sibling counts. After the fix the positional matcher
+ returns None and the row shows "No Bay".
+ """
+
+ def _scaffolding_inventory(self):
+ return [
+ {
+ "entPhysicalIndex": 8384513,
+ "entPhysicalName": "Rack 0",
+ "entPhysicalModelName": "ASR-9904",
+ "entPhysicalClass": "chassis",
+ "entPhysicalContainedIn": 0,
+ "entPhysicalSerialNum": "FOX2128PLQ8",
+ "entPhysicalParentRelPos": -1,
+ },
+ {
+ "entPhysicalIndex": 8384552,
+ "entPhysicalName": "Rack 0-Line Card Slot 0",
+ "entPhysicalModelName": "N/A",
+ "entPhysicalClass": "container",
+ "entPhysicalContainedIn": 8384513,
+ "entPhysicalParentRelPos": 3,
+ },
+ {
+ "entPhysicalIndex": 1,
+ "entPhysicalName": "0/0",
+ "entPhysicalModelName": "A9K-24X10GE-1G-TR",
+ "entPhysicalClass": "module",
+ "entPhysicalContainedIn": 8384552,
+ "entPhysicalSerialNum": "DEVICE_SERIAL", # matches device serial below
+ "entPhysicalParentRelPos": 0,
+ },
+ {
+ "entPhysicalIndex": 30,
+ "entPhysicalName": "0/0-Motherboard",
+ "entPhysicalModelName": "N/A",
+ "entPhysicalClass": "module",
+ "entPhysicalContainedIn": 1,
+ "entPhysicalParentRelPos": 0,
+ },
+ {
+ "entPhysicalIndex": 35,
+ "entPhysicalName": "0/0-Slice 0",
+ "entPhysicalModelName": "N/A",
+ "entPhysicalClass": "module",
+ "entPhysicalContainedIn": 30,
+ "entPhysicalParentRelPos": 4,
+ },
+ {
+ "entPhysicalIndex": 330,
+ "entPhysicalName": "0/0-Slice 0 EZChip",
+ "entPhysicalModelName": "N/A",
+ "entPhysicalClass": "module",
+ "entPhysicalContainedIn": 35,
+ "entPhysicalParentRelPos": 0,
+ },
+ {
+ "entPhysicalIndex": 601,
+ "entPhysicalName": "0/0-Slice 0 SFP Port Module #0",
+ "entPhysicalModelName": "N/A",
+ "entPhysicalClass": "module",
+ "entPhysicalContainedIn": 330,
+ "entPhysicalParentRelPos": 0,
+ },
+ {
+ "entPhysicalIndex": 801,
+ "entPhysicalName": "0/0-SFP+ bay 0",
+ "entPhysicalModelName": "N/A",
+ "entPhysicalClass": "container",
+ "entPhysicalContainedIn": 601,
+ "entPhysicalParentRelPos": 0,
+ },
+ {
+ "entPhysicalIndex": 409601,
+ "entPhysicalName": "TenGigE0/0/0/0",
+ "entPhysicalModelName": "SFP-10G-SR",
+ "entPhysicalClass": "module",
+ "entPhysicalContainedIn": 801,
+ "entPhysicalSerialNum": "SFP_SERIAL_0",
+ "entPhysicalParentRelPos": 0,
+ },
+ {
+ "entPhysicalIndex": 602,
+ "entPhysicalName": "0/0-Slice 0 SFP Port Module #1",
+ "entPhysicalModelName": "N/A",
+ "entPhysicalClass": "module",
+ "entPhysicalContainedIn": 330,
+ "entPhysicalParentRelPos": 1,
+ },
+ {
+ "entPhysicalIndex": 802,
+ "entPhysicalName": "0/0-SFP+ bay 1",
+ "entPhysicalModelName": "N/A",
+ "entPhysicalClass": "container",
+ "entPhysicalContainedIn": 602,
+ "entPhysicalParentRelPos": 0,
+ },
+ {
+ "entPhysicalIndex": 413697,
+ "entPhysicalName": "TenGigE0/0/0/1",
+ "entPhysicalModelName": "SFP-10G-SR",
+ "entPhysicalClass": "module",
+ "entPhysicalContainedIn": 802,
+ "entPhysicalSerialNum": "SFP_SERIAL_1",
+ "entPhysicalParentRelPos": 0,
+ },
+ ]
+
+ def _device_bays(self):
+ bays = {}
+ for n in range(0, 4):
+ b = MagicMock()
+ b.name = f"Slot {n}"
+ b.installed_module = None
+ b.get_absolute_url.return_value = f"/bay/slot-{n}"
+ bays[f"Slot {n}"] = b
+ return bays
+
+ def _module_types(self):
+ mt = MagicMock()
+ mt.pk = 50
+ mt.model = "SFP-10G-SR"
+ mt.get_absolute_url.return_value = "/mt/sfp"
+ return {"SFP-10G-SR": mt}
+
+ def _build_rows(self, device_serial="DEVICE_SERIAL"):
+ view = _make_view()
+ # Need a transparent rule that fires on serial_matches_device, like prod
+ from netbox_librenms_plugin.tests.test_modules_view import _make_view as _mv # noqa: F401
+
+ rows_store = _captured_table_view(view)
+ view._get_module_bays = MagicMock(return_value=(self._device_bays(), {}))
+ view._get_module_types = MagicMock(return_value=self._module_types())
+ view._get_generic_module_types = MagicMock(return_value={})
+ view._get_module_type_ambiguities = MagicMock(return_value={})
+ view._get_carrier_install_rules = MagicMock(return_value=[])
+
+ # Device-serial matches the linecard's serial β linecard becomes transparent
+ device = MagicMock()
+ device.serial = device_serial
+ device.virtual_chassis = None
+ device.id = 1
+ device_type = MagicMock()
+ device_type.manufacturer = None
+ device.device_type = device_type
+
+ # Build a fake "transparent" ignore rule matching serial_matches_device
+ transparent_rule = MagicMock()
+ transparent_rule.match_type = "serial_matches_device"
+ transparent_rule.action = "transparent"
+ transparent_rule.require_serial_match_parent = False
+
+ with (
+ patch("netbox_librenms_plugin.views.base.modules_view.cache") as mock_cache,
+ patch("netbox_librenms_plugin.utils.load_bay_mappings", return_value=([], [])),
+ patch("netbox_librenms_plugin.utils.get_enabled_ignore_rules", return_value=[transparent_rule]),
+ patch("netbox_librenms_plugin.utils.apply_normalization_rules", side_effect=lambda v, *a, **kw: v),
+ patch("netbox_librenms_plugin.utils.preload_normalization_rules", return_value={}),
+ patch("netbox_librenms_plugin.utils.has_nested_name_conflict", return_value=False),
+ patch.object(view.__class__, "_detect_serial_conflicts", return_value=None),
+ ):
+ mock_cache.ttl = MagicMock(return_value=None)
+ view._build_context(MagicMock(), device, self._scaffolding_inventory())
+ return rows_store.get("rows", [])
+
+ def _row(self, rows, name):
+ for r in rows:
+ if r.get("name") == name:
+ return r
+ return None
+
+ def test_tengig_does_not_match_chassis_slot_via_scaffolding_walk(self):
+ """
+ TenGigE ports at the bottom of a model="N/A" module chain must NOT be
+ positional-matched to a chassis bay. Pre-fix, every TenGigE walked
+ through Motherboard/Slice/EZChip and landed on Slot 1 (the RSP bay).
+ """
+ rows = self._build_rows()
+ for name in ("TenGigE0/0/0/0", "TenGigE0/0/0/1"):
+ row = self._row(rows, name)
+ assert row is not None, f"{name} row not found"
+ assert row["module_bay"] != "Slot 1", (
+ f"{name} matched 'Slot 1' on the chassis β that bay holds the "
+ "RSP line card, not a transceiver. Positional fallback walked "
+ "through model-less module-class scaffolding (Motherboard, "
+ "Slice 0, EZChip, SFP Port Module) before stopping at the "
+ "0/0 linecard, conflating every TenGigE to position=1."
+ )
+
+ def test_tengig_shows_no_bay_when_only_scaffolding_above(self):
+ """
+ With no real position-container chain and no bay templates on the
+ scaffolding modules' types, transceivers should resolve to 'No Bay'.
+ """
+ rows = self._build_rows()
+ row = self._row(rows, "TenGigE0/0/0/0")
+ assert row is not None
+ assert row["status"] == "No Bay", (
+ f"Expected 'No Bay' but got {row['status']!r}. With only chassis "
+ "Slot 0..3 bays in scope and modelless module scaffolding above the "
+ "transceiver, the positional fallback should bail rather than "
+ "confidently mismatching."
+ )
+
+ def test_tengig_siblings_resolve_independently(self):
+ """
+ Each TenGigE port must be evaluated independently. Pre-fix all ports
+ collapsed to the same `container_idx` and got identical (wrong) bays.
+ """
+ rows = self._build_rows()
+ bays = {r.get("name"): r.get("module_bay") for r in rows if r.get("name", "").startswith("TenGigE")}
+ # Either both resolve to "-" (no bay) or to distinct bays. They must
+ # NOT all share the same chassis bay.
+ non_dash = [b for b in bays.values() if b and b != "-"]
+ assert len(set(non_dash)) == len(non_dash), (
+ f"TenGigE ports collapsed to duplicate bay assignments: {bays}. "
+ "Positional fallback walked through scaffolding and produced the "
+ "same container_idx for siblings that have different physical positions."
+ )
+
+
+class TestCollectDescendants:
+ """Tests for _collect_descendants depth tracking."""
+
+ def _view(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ return object.__new__(BaseModuleTableView)
+
+ def test_empty_container_children_at_same_depth(self):
+ """Children of a no-model container are returned at the same depth as the container."""
+ inventory = [
+ {"entPhysicalIndex": 1, "entPhysicalModelName": "", "entPhysicalContainedIn": 0},
+ {"entPhysicalIndex": 2, "entPhysicalModelName": "REAL-MODULE", "entPhysicalContainedIn": 1},
+ ]
+ children_by_parent = {}
+ index_map = {}
+ for item in inventory:
+ p = item.get("entPhysicalContainedIn")
+ if p is not None:
+ children_by_parent.setdefault(p, []).append(item)
+ idx = item.get("entPhysicalIndex")
+ if idx is not None:
+ index_map[idx] = item
+ view = self._view()
+ results = []
+ view._collect_descendants(0, children_by_parent, index_map, ignore_rules=[], depth=1, results=results)
+ assert len(results) == 1
+ depth, item = results[0]
+ assert depth == 1, "Child of modelless container must be at the same depth"
+ assert item["entPhysicalModelName"] == "REAL-MODULE"
+
+ def test_model_children_at_incremented_depth(self):
+ """Children of a model-bearing item are at depth+1."""
+ inventory = [
+ {"entPhysicalIndex": 1, "entPhysicalModelName": "PARENT", "entPhysicalContainedIn": 0},
+ {"entPhysicalIndex": 2, "entPhysicalModelName": "CHILD", "entPhysicalContainedIn": 1},
+ ]
+ children_by_parent = {}
+ index_map = {}
+ for item in inventory:
+ p = item.get("entPhysicalContainedIn")
+ if p is not None:
+ children_by_parent.setdefault(p, []).append(item)
+ idx = item.get("entPhysicalIndex")
+ if idx is not None:
+ index_map[idx] = item
+ view = self._view()
+ results = []
+ view._collect_descendants(0, children_by_parent, index_map, ignore_rules=[], depth=1, results=results)
+ depths = [d for d, _ in results]
+ assert depths == [1, 2], f"Expected [1, 2] but got {depths}"
+
+
+class TestDetermineStatus:
+ """Tests for _determine_status logic."""
+
+ def _view(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ return object.__new__(BaseModuleTableView)
+
+ def test_matched_bay_and_type(self):
+ import types
+
+ view = self._view()
+ assert view._determine_status(types.SimpleNamespace(id=1), types.SimpleNamespace(id=1), "S1") == "Matched"
+
+ def test_no_bay(self):
+ import types
+
+ view = self._view()
+ assert view._determine_status(None, types.SimpleNamespace(id=1), "S1") == "No Bay"
+
+ def test_no_type(self):
+ import types
+
+ view = self._view()
+ assert view._determine_status(types.SimpleNamespace(id=1), None, "S1") == "No Type"
+
+ def test_unmatched_fallback(self):
+ view = self._view()
+ assert view._determine_status(None, None, "S1") == "No Bay"
+
+
+class TestBuildRowSerialMismatch:
+ """Tests for serial mismatch detection and can_update_serial flag in _build_row."""
+
+ def _view(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ view = object.__new__(BaseModuleTableView)
+ view._device_manufacturer = None
+ return view
+
+ def _make_bay(self, installed_serial=None, module_type_id=5):
+ """Create a mock bay with an optionally installed module."""
+ bay = MagicMock()
+ bay.pk = 10
+ bay.name = "Slot 1"
+ bay.get_absolute_url.return_value = "/dcim/module-bays/10/"
+ if installed_serial is not None:
+ module = MagicMock()
+ module.pk = 42
+ module.serial = installed_serial
+ module.module_type_id = module_type_id
+ module.get_absolute_url.return_value = "/dcim/modules/42/"
+ bay.installed_module = module
+ else:
+ bay.installed_module = None
+ return bay
+
+ def _make_item(self, model_name="XCM-7s-b", serial="NS225161205"):
+ return {
+ "entPhysicalModelName": model_name,
+ "entPhysicalSerialNum": serial,
+ "entPhysicalName": "Slot 1",
+ "entPhysicalDescr": "",
+ "entPhysicalClass": "module",
+ "entPhysicalIndex": 100,
+ }
+
+ def test_serial_match_sets_installed_status(self):
+ """When ENTITY-MIB serial matches NetBox serial, status is Installed."""
+ view = self._view()
+ bay = self._make_bay(installed_serial="NS225161205")
+ matched_type = MagicMock()
+ matched_type.model = "XCM-7s-b"
+ matched_type.pk = 5
+ matched_type.get_absolute_url.return_value = "/dcim/module-types/5/"
+
+ with (
+ patch.object(view, "_match_module_bay", return_value=bay),
+ patch("netbox_librenms_plugin.utils.apply_normalization_rules", return_value="XCM-7s-b"),
+ patch("netbox_librenms_plugin.utils.has_nested_name_conflict", return_value=False),
+ ):
+ row = view._build_row(
+ self._make_item(serial="NS225161205"),
+ {},
+ {"Slot 1": bay},
+ {"XCM-7s-b": matched_type},
+ )
+
+ assert row["status"] == "Installed"
+ assert "row_class" not in row
+ assert not row.get("can_update_serial")
+
+ def test_serial_mismatch_sets_can_update_serial(self):
+ """When serials differ, can_update_serial=True and installed_module_id set."""
+ view = self._view()
+ bay = self._make_bay(installed_serial="TESTSRL")
+ matched_type = MagicMock()
+ matched_type.model = "XCM-7s-b"
+ matched_type.pk = 5
+ matched_type.get_absolute_url.return_value = "/dcim/module-types/5/"
+
+ with (
+ patch.object(view, "_match_module_bay", return_value=bay),
+ patch("netbox_librenms_plugin.utils.apply_normalization_rules", return_value="XCM-7s-b"),
+ patch("netbox_librenms_plugin.utils.has_nested_name_conflict", return_value=False),
+ ):
+ row = view._build_row(
+ self._make_item(serial="NS225161205"),
+ {},
+ {"Slot 1": bay},
+ {"XCM-7s-b": matched_type},
+ )
+
+ assert row["status"] == "Serial Mismatch"
+ assert "row_class" not in row
+ assert row.get("can_update_serial") is True
+ assert row.get("installed_module_id") == 42
+
+ def test_empty_netbox_serial_flags_mismatch(self):
+ """When NetBox serial is empty but LibreNMS has one, status is Serial Mismatch."""
+ view = self._view()
+ bay = self._make_bay(installed_serial="")
+ matched_type = MagicMock()
+ matched_type.model = "XCM-7s-b"
+ matched_type.pk = 5
+ matched_type.get_absolute_url.return_value = "/dcim/module-types/5/"
+
+ with (
+ patch.object(view, "_match_module_bay", return_value=bay),
+ patch("netbox_librenms_plugin.utils.apply_normalization_rules", return_value="XCM-7s-b"),
+ patch("netbox_librenms_plugin.utils.has_nested_name_conflict", return_value=False),
+ ):
+ row = view._build_row(
+ self._make_item(serial="NS225161205"),
+ {},
+ {"Slot 1": bay},
+ {"XCM-7s-b": matched_type},
+ )
+
+ assert row["status"] == "Serial Mismatch"
+ assert row.get("can_update_serial")
+ assert row.get("can_replace")
+
+ def _common_patches(self, view, bay, matched_type_name):
+ """Return a stack of common patches for _build_row helper calls."""
+ from unittest.mock import patch
+
+ return [
+ patch.object(view, "_match_module_bay", return_value=bay),
+ patch("netbox_librenms_plugin.utils.apply_normalization_rules", return_value=matched_type_name),
+ patch("netbox_librenms_plugin.utils.has_nested_name_conflict", return_value=False),
+ ]
+
+ def _make_matched_type(self, model_name, pk=5):
+ matched_type = MagicMock()
+ matched_type.model = model_name
+ matched_type.pk = pk
+ matched_type.get_absolute_url.return_value = f"/dcim/module-types/{pk}/"
+ return matched_type
+
+ def test_type_mismatch_sets_type_mismatch_status(self):
+ """When installed module type differs from LibreNMS type, status is Type Mismatch."""
+ view = self._view()
+ bay = self._make_bay(installed_serial="S1")
+ # Installed type pk=99, matched type pk=5 β different
+ bay.installed_module.module_type_id = 99
+ matched_type = self._make_matched_type("XCM-7s-b", pk=5)
+
+ patches = self._common_patches(view, bay, "XCM-7s-b")
+ from contextlib import ExitStack
+
+ with ExitStack() as stack:
+ for p in patches:
+ stack.enter_context(p)
+ row = view._build_row(
+ self._make_item(model_name="XCM-7s-b", serial="NS225161205"),
+ {},
+ {"Slot 1": bay},
+ {"XCM-7s-b": matched_type},
+ )
+
+ assert row["status"] == "Type Mismatch"
+ assert "row_class" not in row
+
+ def test_type_mismatch_sets_can_replace(self):
+ """Type Mismatch row has can_replace=True and installed_module_id set."""
+ view = self._view()
+ bay = self._make_bay(installed_serial="S1")
+ bay.installed_module.module_type_id = 99
+ matched_type = self._make_matched_type("XCM-7s-b", pk=5)
+
+ patches = self._common_patches(view, bay, "XCM-7s-b")
+ from contextlib import ExitStack
+
+ with ExitStack() as stack:
+ for p in patches:
+ stack.enter_context(p)
+ row = view._build_row(
+ self._make_item(model_name="XCM-7s-b", serial="NS225161205"),
+ {},
+ {"Slot 1": bay},
+ {"XCM-7s-b": matched_type},
+ )
+
+ assert row.get("can_replace") is True
+ assert row.get("installed_module_id") == 42
+
+ def test_serial_mismatch_also_sets_can_replace(self):
+ """Serial Mismatch rows also get can_replace=True (same type)."""
+ view = self._view()
+ bay = self._make_bay(installed_serial="TESTSRL")
+ bay.installed_module.module_type_id = 5
+ matched_type = self._make_matched_type("XCM-7s-b", pk=5)
+
+ patches = self._common_patches(view, bay, "XCM-7s-b")
+ from contextlib import ExitStack
+
+ with ExitStack() as stack:
+ for p in patches:
+ stack.enter_context(p)
+ row = view._build_row(
+ self._make_item(serial="NS225161205"),
+ {},
+ {"Slot 1": bay},
+ {"XCM-7s-b": matched_type},
+ )
+
+ assert row["status"] == "Serial Mismatch"
+ assert row.get("can_replace") is True
+ assert row.get("can_update_serial") is True
+
+ def test_same_type_same_serial_no_replace(self):
+ """Clean Installed row has neither can_replace nor can_update_serial."""
+ view = self._view()
+ bay = self._make_bay(installed_serial="NS225161205")
+ bay.installed_module.module_type_id = 5
+ matched_type = self._make_matched_type("XCM-7s-b", pk=5)
+
+ patches = self._common_patches(view, bay, "XCM-7s-b")
+ from contextlib import ExitStack
+
+ with ExitStack() as stack:
+ for p in patches:
+ stack.enter_context(p)
+ row = view._build_row(
+ self._make_item(serial="NS225161205"),
+ {},
+ {"Slot 1": bay},
+ {"XCM-7s-b": matched_type},
+ )
+
+ assert row["status"] == "Installed"
+ assert not row.get("can_replace")
+ assert not row.get("can_update_serial")
+
+ def test_librenms_dash_serial_with_empty_installed_gives_installed(self):
+ """LibreNMS serial '-' normalizes to empty; both empty -> Installed, not mismatch."""
+ view = self._view()
+ bay = self._make_bay(installed_serial="")
+ bay.installed_module.module_type_id = 5
+ matched_type = self._make_matched_type("XCM-7s-b", pk=5)
+
+ patches = self._common_patches(view, bay, "XCM-7s-b")
+ from contextlib import ExitStack
+
+ with ExitStack() as stack:
+ for p in patches:
+ stack.enter_context(p)
+ row = view._build_row(
+ self._make_item(serial="-"),
+ {},
+ {"Slot 1": bay},
+ {"XCM-7s-b": matched_type},
+ )
+
+ assert row["status"] == "Installed"
+ assert "row_class" not in row
+ assert not row.get("can_update_serial")
+
+ def test_librenms_dash_serial_with_real_installed_gives_installed(self):
+ """LibreNMS serial '-' normalizes to empty; only NetBox has serial -> no mismatch."""
+ view = self._view()
+ bay = self._make_bay(installed_serial="REAL123")
+ bay.installed_module.module_type_id = 5
+ matched_type = self._make_matched_type("XCM-7s-b", pk=5)
+
+ patches = self._common_patches(view, bay, "XCM-7s-b")
+ from contextlib import ExitStack
+
+ with ExitStack() as stack:
+ for p in patches:
+ stack.enter_context(p)
+ row = view._build_row(
+ self._make_item(serial="-"),
+ {},
+ {"Slot 1": bay},
+ {"XCM-7s-b": matched_type},
+ )
+
+ assert row["status"] == "Installed"
+ assert "row_class" not in row
+ assert not row.get("can_update_serial")
+
+
+class TestDetectSerialConflicts:
+ """Tests for BaseModuleTableView._detect_serial_conflicts()."""
+
+ def _view(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ return object.__new__(BaseModuleTableView)
+
+ def test_no_can_replace_or_install_rows_does_nothing(self):
+ """When no rows have can_replace or can_install, the method returns without DB query."""
+ view = self._view()
+ table_data = [{"serial": "S1", "status": "Installed"}]
+ with patch("dcim.models.Module") as mock_module_cls:
+ view._detect_serial_conflicts(table_data)
+ mock_module_cls.objects.filter.assert_not_called()
+ assert "serial_conflict_module" not in table_data[0]
+
+ def test_conflict_detected_for_can_replace_row(self):
+ """When a conflicting module exists, serial_conflict_module is set on the row."""
+ view = self._view()
+ conflict = MagicMock()
+ conflict.serial = "CONFLICT_SERIAL"
+ conflict.pk = 999
+ conflict.module_bay = MagicMock()
+ conflict.device = MagicMock()
+
+ row = {
+ "can_replace": True,
+ "serial": "CONFLICT_SERIAL",
+ "installed_module_id": 42, # different from conflict.pk
+ }
+
+ with patch("dcim.models.Module") as mock_module_cls:
+ mock_module_cls.objects.filter.return_value.select_related.return_value = [conflict]
+ view._detect_serial_conflicts([row])
+
+ assert row.get("serial_conflict_module") is conflict
+ assert row.get("can_move_from") is True
+
+ def test_no_conflict_when_conflict_is_same_module(self):
+ """When the only module with the serial IS the installed module, no conflict is set."""
+ view = self._view()
+ conflict = MagicMock()
+ conflict.serial = "S1"
+ conflict.pk = 42 # Same as installed_module_id
+
+ row = {
+ "can_replace": True,
+ "serial": "S1",
+ "installed_module_id": 42,
+ }
+
+ with patch("dcim.models.Module") as mock_module_cls:
+ mock_module_cls.objects.filter.return_value.select_related.return_value = [conflict]
+ view._detect_serial_conflicts([row])
+
+ assert "serial_conflict_module" not in row
+ assert not row.get("can_move_from")
+
+ def test_conflict_detected_for_can_install_row(self):
+ """Serial conflicts are also detected for empty-bay (can_install) rows."""
+ view = self._view()
+ conflict = MagicMock()
+ conflict.serial = "CONFLICT_SERIAL"
+ conflict.pk = 999
+
+ row = {
+ "can_install": True,
+ "serial": "CONFLICT_SERIAL",
+ # No installed_module_id β bay is empty
+ }
+
+ with patch("dcim.models.Module") as mock_module_cls:
+ mock_module_cls.objects.filter.return_value.select_related.return_value = [conflict]
+ view._detect_serial_conflicts([row])
+
+ assert row.get("serial_conflict_module") is conflict
+ assert row.get("can_move_from") is True
+
+ def test_ambiguous_when_multiple_conflicts_for_same_serial(self):
+ """When multiple modules share the same serial, mark the row ambiguous instead of picking one."""
+ view = self._view()
+ conflict1 = MagicMock()
+ conflict1.serial = "DUP_SERIAL"
+ conflict1.pk = 100
+
+ conflict2 = MagicMock()
+ conflict2.serial = "DUP_SERIAL"
+ conflict2.pk = 200
+
+ row = {
+ "can_replace": True,
+ "serial": "DUP_SERIAL",
+ "installed_module_id": 42,
+ }
+
+ with patch("dcim.models.Module") as mock_module_cls:
+ mock_module_cls.objects.filter.return_value.select_related.return_value = [conflict1, conflict2]
+ view._detect_serial_conflicts([row])
+
+ assert row.get("serial_conflict_module") is None
+ assert not row.get("can_move_from")
+ assert row.get("serial_conflict_ambiguous") is True
+
+ def test_can_install_no_serial_not_flagged(self):
+ """A can_install row with no serial is not checked for conflicts."""
+ view = self._view()
+ row = {"can_install": True, "serial": "-"}
+ with patch("dcim.models.Module") as mock_module_cls:
+ view._detect_serial_conflicts([row])
+ mock_module_cls.objects.filter.assert_not_called()
+ assert "serial_conflict_module" not in row
+
+
+class TestInventoryIgnoreRuleMatchesName:
+ """Tests for InventoryIgnoreRule.matches_name() β all four match types."""
+
+ def _rule(self, match_type, pattern, require_serial=True):
+ from netbox_librenms_plugin.models import InventoryIgnoreRule
+
+ rule = InventoryIgnoreRule.__new__(InventoryIgnoreRule)
+ rule.match_type = match_type
+ rule.pattern = pattern
+ rule.require_serial_match_parent = require_serial
+ rule.enabled = True
+ return rule
+
+ # --- ends_with ---
+
+ def test_ends_with_optics_idprom(self):
+ assert self._rule("ends_with", "IDPROM").matches_name("Optics0/0/0/0-IDPROM") is True
+
+ def test_ends_with_fan_idprom(self):
+ assert self._rule("ends_with", "IDPROM").matches_name("0/FT0-FT IDPROM") is True
+
+ def test_ends_with_chassis_idprom(self):
+ assert self._rule("ends_with", "IDPROM").matches_name("Rack 0-Chassis IDPROM") is True
+
+ def test_ends_with_case_insensitive(self):
+ assert self._rule("ends_with", "IDPROM").matches_name("Optics0/0/0/0-idprom") is True
+
+ def test_ends_with_no_match(self):
+ assert self._rule("ends_with", "IDPROM").matches_name("Optics0/0/0/0") is False
+
+ def test_ends_with_idprom_in_middle(self):
+ assert self._rule("ends_with", "IDPROM").matches_name("IDPROM-Optics0/0/0/0") is False
+
+ # --- starts_with ---
+
+ def test_starts_with_match(self):
+ assert self._rule("starts_with", "Optics").matches_name("Optics0/0/0/0") is True
+
+ def test_starts_with_no_match(self):
+ assert self._rule("starts_with", "Optics").matches_name("0/FT0") is False
+
+ def test_starts_with_case_insensitive(self):
+ assert self._rule("starts_with", "OPTICS").matches_name("optics0/0/0/0") is True
+
+ # --- contains ---
+
+ def test_contains_match(self):
+ assert self._rule("contains", "IDPROM").matches_name("Rack 0-Chassis IDPROM") is True
+
+ def test_contains_middle_match(self):
+ assert self._rule("contains", "IDPROM").matches_name("IDPROM-Optics0/0/0/0") is True
+
+ def test_contains_case_insensitive(self):
+ assert self._rule("contains", "IDPROM").matches_name("chassis-idprom") is True
+
+ def test_contains_no_match(self):
+ assert self._rule("contains", "IDPROM").matches_name("Optics0/0/0/0") is False
+
+ # --- regex ---
+
+ def test_regex_match(self):
+ assert self._rule("regex", r"-IDPROM$").matches_name("Optics0/0/0/0-IDPROM") is True
+
+ def test_regex_no_match(self):
+ assert self._rule("regex", r"-IDPROM$").matches_name("Optics0/0/0/0") is False
+
+ def test_regex_complex_pattern(self):
+ assert self._rule("regex", r"^0/FT\d+-FT IDPROM$").matches_name("0/FT0-FT IDPROM") is True
+
+ # --- edge cases ---
+
+ def test_empty_name(self):
+ assert self._rule("ends_with", "IDPROM").matches_name("") is False
+
+ def test_none_name(self):
+ assert self._rule("ends_with", "IDPROM").matches_name(None) is False
+
+
+class TestCheckIgnoreRules:
+ """Tests for the _check_ignore_rules() module-level function."""
+
+ def _rule(self, match_type="ends_with", pattern="IDPROM", require_serial=True, action="skip"):
+ from netbox_librenms_plugin.models import InventoryIgnoreRule
+
+ rule = InventoryIgnoreRule.__new__(InventoryIgnoreRule)
+ rule.match_type = match_type
+ rule.pattern = pattern
+ rule.require_serial_match_parent = require_serial
+ rule.action = action
+ rule.enabled = True
+ return rule
+
+ def _check(self, item, parent_item, rules, index_map=None, device_serial=""):
+ from netbox_librenms_plugin.views.base.modules_view import _check_ignore_rules
+
+ return _check_ignore_rules(item, parent_item, rules, index_map, device_serial)
+
+ def test_match_with_serial_match_skips(self):
+ """Item matches rule name AND serial matches parent β should be skipped."""
+ item = {"entPhysicalName": "Optics0/0/0/0-IDPROM", "entPhysicalSerialNum": "ABC123"}
+ parent = {"entPhysicalName": "Optics0/0/0/0", "entPhysicalSerialNum": "ABC123"}
+ assert self._check(item, parent, [self._rule()]) == "skip"
+
+ def test_match_with_serial_mismatch_not_skipped(self):
+ """Name matches but serial differs from parent β NOT skipped (could be real module)."""
+ item = {"entPhysicalName": "Optics0/0/0/0-IDPROM", "entPhysicalSerialNum": "XYZ999"}
+ parent = {"entPhysicalName": "Optics0/0/0/0", "entPhysicalSerialNum": "ABC123"}
+ assert self._check(item, parent, [self._rule()]) is None
+
+ def test_match_with_no_parent_not_skipped(self):
+ """Name matches, require_serial=True, but no parent β conservative: NOT skipped."""
+ item = {"entPhysicalName": "Optics0/0/0/0-IDPROM", "entPhysicalSerialNum": "ABC123"}
+ assert self._check(item, None, [self._rule()]) is None
+
+ def test_match_no_serial_require_false_skips(self):
+ """require_serial_match_parent=False β skipped on name match alone."""
+ item = {"entPhysicalName": "Optics0/0/0/0-IDPROM", "entPhysicalSerialNum": ""}
+ parent = {"entPhysicalName": "Optics0/0/0/0", "entPhysicalSerialNum": "ABC123"}
+ assert self._check(item, parent, [self._rule(require_serial=False)]) == "skip"
+
+ def test_no_matching_rule_not_skipped(self):
+ """Name does not match any rule β NOT skipped."""
+ item = {"entPhysicalName": "Optics0/0/0/0", "entPhysicalSerialNum": "ABC123"}
+ parent = {"entPhysicalName": "Rack 0", "entPhysicalSerialNum": "ABC123"}
+ assert self._check(item, parent, [self._rule()]) is None
+
+ def test_empty_rules_not_skipped(self):
+ """Empty rules list β nothing skipped."""
+ item = {"entPhysicalName": "Optics0/0/0/0-IDPROM", "entPhysicalSerialNum": "ABC123"}
+ parent = {"entPhysicalName": "Optics0/0/0/0", "entPhysicalSerialNum": "ABC123"}
+ assert self._check(item, parent, []) is None
+
+ def test_item_serial_empty_not_skipped_when_serial_required(self):
+ """Item has empty serial β can't confirm match β NOT skipped."""
+ item = {"entPhysicalName": "Optics0/0/0/0-IDPROM", "entPhysicalSerialNum": ""}
+ parent = {"entPhysicalName": "Optics0/0/0/0", "entPhysicalSerialNum": "ABC123"}
+ assert self._check(item, parent, [self._rule()]) is None
+
+ def test_first_matching_rule_wins(self):
+ """First rule that matches and satisfies serial check is used; later rules ignored."""
+ rule_skip = self._rule(require_serial=False)
+ rule_serial = self._rule(require_serial=True)
+ item = {"entPhysicalName": "Optics0/0/0/0-IDPROM", "entPhysicalSerialNum": ""}
+ parent = {"entPhysicalName": "Optics0/0/0/0", "entPhysicalSerialNum": "ABC123"}
+ # rule_skip (require_serial=False) matches first β should skip
+ assert self._check(item, parent, [rule_skip, rule_serial]) == "skip"
+
+ def test_ancestor_walk_skips_when_grandparent_serial_matches(self):
+ """IOS-XR case: IDPROM is child of empty-serial Mother Board, but grandparent serial matches."""
+ # Mirrors actual 8201-SYS data: 0/RP0/CPU0-Base Board IDPROM (idx=7)
+ # parent=Mother Board (idx=30, serial=''), grandparent=0/RP0/CPU0 (idx=1, serial='FOC2418NHRK')
+ grandparent = {
+ "entPhysicalIndex": 1,
+ "entPhysicalName": "0/RP0/CPU0",
+ "entPhysicalSerialNum": "FOC2418NHRK",
+ "entPhysicalContainedIn": 0,
+ }
+ parent = {
+ "entPhysicalIndex": 30,
+ "entPhysicalName": "0/RP0/CPU0-Mother Board",
+ "entPhysicalSerialNum": "",
+ "entPhysicalContainedIn": 1,
+ }
+ item = {
+ "entPhysicalIndex": 7,
+ "entPhysicalName": "0/RP0/CPU0-Base Board IDPROM",
+ "entPhysicalSerialNum": "FOC2418NHRK",
+ "entPhysicalContainedIn": 30,
+ }
+ index_map = {1: grandparent, 30: parent, 7: item}
+ assert self._check(item, parent, [self._rule()], index_map=index_map) == "skip"
+
+ def test_ancestor_walk_stops_at_non_matching_serial(self):
+ """Ancestor walk stops at first non-empty serial; if it doesn't match β NOT skipped."""
+ grandparent = {
+ "entPhysicalIndex": 1,
+ "entPhysicalName": "Chassis",
+ "entPhysicalSerialNum": "DIFFERENT_SN",
+ "entPhysicalContainedIn": 0,
+ }
+ parent = {
+ "entPhysicalIndex": 30,
+ "entPhysicalName": "Board",
+ "entPhysicalSerialNum": "",
+ "entPhysicalContainedIn": 1,
+ }
+ item = {
+ "entPhysicalIndex": 7,
+ "entPhysicalName": "Board-IDPROM",
+ "entPhysicalSerialNum": "FOC2418NHRK",
+ "entPhysicalContainedIn": 30,
+ }
+ index_map = {1: grandparent, 30: parent, 7: item}
+ assert self._check(item, parent, [self._rule()], index_map=index_map) is None
+
+ def test_serial_matches_device_transparent(self):
+ """serial_matches_device rule with action=transparent returns 'transparent'."""
+ rule = self._rule(match_type="serial_matches_device", pattern="", action="transparent")
+ item = {"entPhysicalName": "0/RP0/CPU0", "entPhysicalSerialNum": "FOC2418NHRK", "entPhysicalIndex": 5}
+ assert self._check(item, None, [rule], device_serial="FOC2418NHRK") == "transparent"
+
+ def test_serial_matches_device_skip(self):
+ """serial_matches_device rule with action=skip returns 'skip'."""
+ rule = self._rule(match_type="serial_matches_device", pattern="", action="skip")
+ item = {"entPhysicalName": "0/RP0/CPU0", "entPhysicalSerialNum": "FOC2418NHRK"}
+ assert self._check(item, None, [rule], device_serial="FOC2418NHRK") == "skip"
+
+ def test_serial_matches_device_no_match(self):
+ """serial_matches_device: item serial differs from device serial β no match."""
+ rule = self._rule(match_type="serial_matches_device", pattern="", action="transparent")
+ item = {"entPhysicalName": "Optics0/0/0/0", "entPhysicalSerialNum": "XCVR001"}
+ assert self._check(item, None, [rule], device_serial="FOC2418NHRK") is None
+
+ def test_serial_matches_device_empty_device_serial(self):
+ """serial_matches_device: device serial empty β no match (defensive)."""
+ rule = self._rule(match_type="serial_matches_device", pattern="", action="transparent")
+ item = {"entPhysicalName": "0/RP0/CPU0", "entPhysicalSerialNum": "FOC2418NHRK"}
+ assert self._check(item, None, [rule], device_serial="") is None
+
+ def test_serial_matches_device_empty_item_serial(self):
+ """serial_matches_device: item serial empty β no match (defensive)."""
+ rule = self._rule(match_type="serial_matches_device", pattern="", action="transparent")
+ item = {"entPhysicalName": "0/RP0/CPU0", "entPhysicalSerialNum": ""}
+ assert self._check(item, None, [rule], device_serial="FOC2418NHRK") is None
+
+ def test_serial_matches_device_fires_when_parent_is_chassis(self):
+ """serial_matches_device: matches when direct parent has class='chassis'."""
+ rule = self._rule(match_type="serial_matches_device", pattern="", action="transparent")
+ item = {"entPhysicalName": "0/RP0/CPU0", "entPhysicalSerialNum": "FOC2418NHRK"}
+ chassis = {"entPhysicalName": "Rack 0", "entPhysicalClass": "chassis"}
+ assert self._check(item, chassis, [rule], device_serial="FOC2418NHRK") == "transparent"
+
+ def test_serial_matches_device_skipped_when_parent_is_container(self):
+ """
+ serial_matches_device: does NOT match when parent is a container
+ (e.g. ASR-9904 line card whose serial happens to equal the device
+ serial β the linecard is contained in a 'Line Card Slot N' container,
+ not the chassis). Treating it as transparent would silently promote
+ its TenGigE children to chassis-level bay matching.
+ """
+ rule = self._rule(match_type="serial_matches_device", pattern="", action="transparent")
+ item = {"entPhysicalName": "0/0", "entPhysicalSerialNum": "FOC2349N4UN"}
+ slot_container = {"entPhysicalName": "Rack 0-Line Card Slot 0", "entPhysicalClass": "container"}
+ assert self._check(item, slot_container, [rule], device_serial="FOC2349N4UN") is None
+
+ def test_serial_matches_device_skipped_when_parent_is_module(self):
+ """serial_matches_device: does NOT match when parent is a module."""
+ rule = self._rule(match_type="serial_matches_device", pattern="", action="transparent")
+ item = {"entPhysicalName": "Submodule", "entPhysicalSerialNum": "ABC123"}
+ parent_module = {"entPhysicalName": "Parent", "entPhysicalClass": "module"}
+ assert self._check(item, parent_module, [rule], device_serial="ABC123") is None
+
+ def test_transparent_action_returned_for_name_rule(self):
+ """A name-based rule with action=transparent returns 'transparent'."""
+ rule = self._rule(match_type="ends_with", pattern="IDPROM", require_serial=False, action="transparent")
+ item = {"entPhysicalName": "Optics0/0/0/0-IDPROM", "entPhysicalSerialNum": "ABC123"}
+ assert self._check(item, None, [rule]) == "transparent"
+
+
+class TestCollectDescendantsIgnoreRules:
+ """_collect_descendants must skip items matched by ignore rules."""
+
+ def _view(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ return object.__new__(BaseModuleTableView)
+
+ def _rule(self, match_type="ends_with", pattern="IDPROM", require_serial=True, action="skip"):
+ from netbox_librenms_plugin.models import InventoryIgnoreRule
+
+ rule = InventoryIgnoreRule.__new__(InventoryIgnoreRule)
+ rule.match_type = match_type
+ rule.pattern = pattern
+ rule.require_serial_match_parent = require_serial
+ rule.action = action
+ rule.enabled = True
+ return rule
+
+ def _build_maps(self, inventory):
+ children_by_parent = {}
+ index_map = {}
+ for item in inventory:
+ p = item.get("entPhysicalContainedIn")
+ if p is not None:
+ children_by_parent.setdefault(p, []).append(item)
+ idx = item.get("entPhysicalIndex")
+ if idx is not None:
+ index_map[idx] = item
+ return children_by_parent, index_map
+
+ def test_idprom_child_is_excluded(self):
+ """IDPROM child of a real module must not appear in results."""
+ inventory = [
+ {
+ "entPhysicalIndex": 1,
+ "entPhysicalName": "Optics0/0/0/0",
+ "entPhysicalModelName": "DP04QSDD-HE0",
+ "entPhysicalSerialNum": "SER001",
+ "entPhysicalContainedIn": 0,
+ },
+ {
+ "entPhysicalIndex": 2,
+ "entPhysicalName": "Optics0/0/0/0-IDPROM",
+ "entPhysicalModelName": "DP04QSDD-HE0",
+ "entPhysicalSerialNum": "SER001",
+ "entPhysicalContainedIn": 1,
+ },
+ ]
+ children_by_parent, index_map = self._build_maps(inventory)
+ view = self._view()
+ results = []
+ view._collect_descendants(0, children_by_parent, index_map, [self._rule()], depth=1, results=results)
+ assert len(results) == 1
+ _, item = results[0]
+ assert item["entPhysicalName"] == "Optics0/0/0/0"
+
+ def test_idprom_child_descendants_also_excluded(self):
+ """Nothing nested below a skipped entry should appear either."""
+ inventory = [
+ {
+ "entPhysicalIndex": 1,
+ "entPhysicalName": "Optics0/0/0/0",
+ "entPhysicalModelName": "DP04QSDD-HE0",
+ "entPhysicalSerialNum": "SER001",
+ "entPhysicalContainedIn": 0,
+ },
+ {
+ "entPhysicalIndex": 2,
+ "entPhysicalName": "Optics0/0/0/0-IDPROM",
+ "entPhysicalModelName": "DP04QSDD-HE0",
+ "entPhysicalSerialNum": "SER001",
+ "entPhysicalContainedIn": 1,
+ },
+ {
+ "entPhysicalIndex": 3,
+ "entPhysicalName": "Optics0/0/0/0-IDPROM-SubItem",
+ "entPhysicalModelName": "DP04QSDD-HE0",
+ "entPhysicalSerialNum": "SER001",
+ "entPhysicalContainedIn": 2,
+ },
+ ]
+ children_by_parent, index_map = self._build_maps(inventory)
+ view = self._view()
+ results = []
+ view._collect_descendants(0, children_by_parent, index_map, [self._rule()], depth=1, results=results)
+ names = [item["entPhysicalName"] for _, item in results]
+ assert "Optics0/0/0/0" in names
+ assert "Optics0/0/0/0-IDPROM" not in names
+ assert "Optics0/0/0/0-IDPROM-SubItem" not in names
+
+ def test_real_submodule_still_included(self):
+ """A legitimate non-matching child remains in results."""
+ inventory = [
+ {
+ "entPhysicalIndex": 1,
+ "entPhysicalName": "0/FT0",
+ "entPhysicalModelName": "FAN-1RU-PI",
+ "entPhysicalSerialNum": "SER002",
+ "entPhysicalContainedIn": 0,
+ },
+ {
+ "entPhysicalIndex": 2,
+ "entPhysicalName": "0/FT0-FT IDPROM",
+ "entPhysicalModelName": "FAN-1RU-PI",
+ "entPhysicalSerialNum": "SER002",
+ "entPhysicalContainedIn": 1,
+ },
+ {
+ "entPhysicalIndex": 3,
+ "entPhysicalName": "FanBlade-0",
+ "entPhysicalModelName": "BLADE-A",
+ "entPhysicalSerialNum": "SER003",
+ "entPhysicalContainedIn": 1,
+ },
+ ]
+ children_by_parent, index_map = self._build_maps(inventory)
+ view = self._view()
+ results = []
+ view._collect_descendants(0, children_by_parent, index_map, [self._rule()], depth=1, results=results)
+ names = [item["entPhysicalName"] for _, item in results]
+ assert "0/FT0" in names
+ assert "0/FT0-FT IDPROM" not in names
+ assert "FanBlade-0" in names
+
+ def test_no_rules_includes_all(self):
+ """With empty rules list, no items are filtered (regression guard)."""
+ inventory = [
+ {
+ "entPhysicalIndex": 1,
+ "entPhysicalName": "Optics0/0/0/0",
+ "entPhysicalModelName": "DP04QSDD-HE0",
+ "entPhysicalSerialNum": "SER001",
+ "entPhysicalContainedIn": 0,
+ },
+ {
+ "entPhysicalIndex": 2,
+ "entPhysicalName": "Optics0/0/0/0-IDPROM",
+ "entPhysicalModelName": "DP04QSDD-HE0",
+ "entPhysicalSerialNum": "SER001",
+ "entPhysicalContainedIn": 1,
+ },
+ ]
+ children_by_parent, index_map = self._build_maps(inventory)
+ view = self._view()
+ results = []
+ view._collect_descendants(0, children_by_parent, index_map, [], depth=1, results=results)
+ names = [item["entPhysicalName"] for _, item in results]
+ assert "Optics0/0/0/0" in names
+ assert "Optics0/0/0/0-IDPROM" in names
+
+ def test_transparent_item_children_promoted_to_same_depth(self):
+ """Children of a transparent-matched item are promoted to the transparent item's depth."""
+ inventory = [
+ {
+ "entPhysicalIndex": 1,
+ "entPhysicalName": "Module-Chassis-IDPROM",
+ "entPhysicalModelName": "CHASSIS-TYPE",
+ "entPhysicalSerialNum": "SER_CHASSIS",
+ "entPhysicalContainedIn": 0,
+ },
+ {
+ "entPhysicalIndex": 2,
+ "entPhysicalName": "Child-Module",
+ "entPhysicalModelName": "SFP-X2",
+ "entPhysicalSerialNum": "SER_SFP",
+ "entPhysicalContainedIn": 1,
+ },
+ ]
+ rule = self._rule(match_type="ends_with", pattern="IDPROM", require_serial=False, action="transparent")
+ children_by_parent, index_map = self._build_maps(inventory)
+ view = self._view()
+ results = []
+ view._collect_descendants(0, children_by_parent, index_map, [rule], depth=1, results=results)
+
+ names = [item["entPhysicalName"] for _, item in results]
+ depths = [d for d, _ in results]
+ # Transparent item itself must not appear
+ assert "Module-Chassis-IDPROM" not in names
+ # Its child must be promoted to the same depth (1) as the transparent item would occupy
+ assert "Child-Module" in names
+ assert depths[names.index("Child-Module")] == 1
+
+ def test_transparent_item_without_children_produces_no_rows(self):
+ """A transparent item with no children yields nothing."""
+ inventory = [
+ {
+ "entPhysicalIndex": 1,
+ "entPhysicalName": "Leaf-IDPROM",
+ "entPhysicalModelName": "LEAF-MODEL",
+ "entPhysicalSerialNum": "LEAF_SER",
+ "entPhysicalContainedIn": 0,
+ },
+ ]
+ rule = self._rule(match_type="ends_with", pattern="IDPROM", require_serial=False, action="transparent")
+ children_by_parent, index_map = self._build_maps(inventory)
+ view = self._view()
+ results = []
+ view._collect_descendants(0, children_by_parent, index_map, [rule], depth=1, results=results)
+ assert results == []
+
+
+class TestPositionalMatchClassAware:
+ """
+ Positional fallback only tries bay-name patterns appropriate for the item's
+ hardware class. Without this, items like fans and PSUs land in chassis
+ line-card "Slot N" bays just because the slot number happens to align.
+ """
+
+ @staticmethod
+ def _walk(item_class, slot_num, bays):
+ """Drive _match_bay_by_position via a minimal inventory: chassis -> container -> item."""
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ inventory = [
+ {
+ "entPhysicalIndex": 1,
+ "entPhysicalModelName": "REAL-CHASSIS",
+ "entPhysicalClass": "chassis",
+ "entPhysicalContainedIn": 0,
+ "entPhysicalParentRelPos": 0,
+ },
+ ]
+ # Add slot_num sibling containers under chassis so positional finds slot=slot_num
+ for n in range(1, slot_num + 1):
+ inventory.append(
+ {
+ "entPhysicalIndex": 100 + n,
+ "entPhysicalModelName": "",
+ "entPhysicalClass": "container",
+ "entPhysicalContainedIn": 1,
+ "entPhysicalParentRelPos": n,
+ }
+ )
+ item = {
+ "entPhysicalIndex": 999,
+ "entPhysicalModelName": "X",
+ "entPhysicalClass": item_class,
+ "entPhysicalContainedIn": 100 + slot_num,
+ "entPhysicalParentRelPos": 0,
+ }
+ inventory.append(item)
+ index_map = {i["entPhysicalIndex"]: i for i in inventory}
+ return BaseModuleTableView._match_bay_by_position(item, index_map, bays)
+
+ @staticmethod
+ def _bay(name):
+ b = MagicMock()
+ b.name = name
+ return b
+
+ def test_fan_does_not_match_slot_bay(self):
+ """A fan (class=fan) must not land in a 'Slot 1' bay even when positional says slot 1."""
+ bays = {"Slot 1": self._bay("Slot 1"), "Slot 2": self._bay("Slot 2")}
+ result = self._walk("fan", 1, bays)
+ assert result is None, (
+ "Fan was matched to a chassis 'Slot N' bay. Positional patterns must be "
+ "class-aware: fans only match Fan / Fan Tray / FT N bays."
+ )
+
+ def test_fan_matches_fan_tray_bay(self):
+ """A fan matches a 'Fan Tray N' or 'Fan N' bay."""
+ bays = {"Fan Tray 1": self._bay("Fan Tray 1"), "Slot 1": self._bay("Slot 1")}
+ result = self._walk("fan", 1, bays)
+ assert result is bays["Fan Tray 1"]
+
+ def test_powersupply_does_not_match_slot_bay(self):
+ """A power supply must not match a 'Slot N' bay."""
+ bays = {"Slot 2": self._bay("Slot 2"), "Slot 3": self._bay("Slot 3")}
+ result = self._walk("powerSupply", 2, bays)
+ assert result is None
+
+ def test_powersupply_matches_psu_bay(self):
+ """A PSU matches Power Supply / PSU / PEM patterns."""
+ bays = {"PSU 1": self._bay("PSU 1"), "Slot 1": self._bay("Slot 1")}
+ result = self._walk("powerSupply", 1, bays)
+ assert result is bays["PSU 1"]
+
+ def test_module_still_matches_slot_bay(self):
+ """A module continues to match Slot/SFP/Bay/Port patterns."""
+ bays = {"Slot 1": self._bay("Slot 1")}
+ result = self._walk("module", 1, bays)
+ assert result is bays["Slot 1"]
+
+ def test_unknown_class_returns_none(self):
+ """An item with an unknown / empty class doesn't get a positional guess."""
+ bays = {"Slot 1": self._bay("Slot 1")}
+ result = self._walk("sensor", 1, bays)
+ assert result is None
+
+
+class TestNoBayWarningHints:
+ """`_build_no_bay_warning` distinguishes the common 'No Bay' causes."""
+
+ def test_empty_scope_mentions_missing_templates(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ item = {"entPhysicalClass": "module", "entPhysicalModelName": "X"}
+ msg = BaseModuleTableView._build_no_bay_warning(item, {})
+ assert "no bay templates defined" in msg.lower()
+
+ def test_scope_uninstalled_recommends_install_parent(self):
+ """Empty scope due to an uninstalled ancestor -> hint to install parent first."""
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ item = {"entPhysicalClass": "module", "entPhysicalModelName": "X"}
+ msg = BaseModuleTableView._build_no_bay_warning(item, {}, scope_uninstalled=True)
+ assert "install the parent module first" in msg.lower()
+
+ def test_suggestion_appended_when_provided(self):
+ """`_build_no_bay_warning` includes the suggested mapping when one is provided."""
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ item = {"entPhysicalClass": "module"}
+ suggestion = {
+ "librenms_name": r"^0/(\d+)$",
+ "librenms_class": "module",
+ "netbox_bay_name": r"Slot \1",
+ "is_regex": True,
+ "example_item": "0/0",
+ "example_bay": "Slot 0",
+ }
+ msg = BaseModuleTableView._build_no_bay_warning(item, {"Slot 0": MagicMock()}, suggestion)
+ assert "0/(\\d+)" in msg
+ assert "Slot \\1" in msg
+ assert "0/0" in msg and "Slot 0" in msg
+
+ def test_fan_class_hint_names_fan_bays(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ item = {"entPhysicalClass": "fan"}
+ msg = BaseModuleTableView._build_no_bay_warning(item, {"Slot 1": MagicMock()})
+ assert "Fan" in msg
+
+ def test_powersupply_class_hint_names_psu_bays(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ item = {"entPhysicalClass": "powerSupply"}
+ msg = BaseModuleTableView._build_no_bay_warning(item, {"Slot 1": MagicMock()})
+ assert "PSU" in msg or "Power Supply" in msg or "PEM" in msg
+
+ def test_module_class_hint_names_slot_bays(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ item = {"entPhysicalClass": "module"}
+ msg = BaseModuleTableView._build_no_bay_warning(item, {"Slot 1": MagicMock()})
+ assert "Slot" in msg or "SFP" in msg
+
+
+class TestSuggestBayMapping:
+ """`_suggest_bay_mapping` produces a regex mapping when a trailing-number bay is in scope."""
+
+ def test_suggests_regex_when_trailing_number_matches_bay(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ item = {"entPhysicalName": "0/0", "entPhysicalClass": "module"}
+ bay = MagicMock()
+ bay.name = "Slot 0"
+ sug = BaseModuleTableView._suggest_bay_mapping(item, {"Slot 0": bay})
+ assert sug is not None
+ assert sug["is_regex"] is True
+ assert sug["librenms_name"] == r"^0/(\d+)$"
+ assert sug["netbox_bay_name"] == r"Slot \1"
+ assert sug["librenms_class"] == "module"
+ assert sug["example_item"] == "0/0"
+ assert sug["example_bay"] == "Slot 0"
+
+ def test_no_suggestion_when_no_bay_with_matching_trailing_number(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ item = {"entPhysicalName": "0/0", "entPhysicalClass": "module"}
+ bay = MagicMock()
+ bay.name = "Slot 7" # trailing 7, not 0
+ sug = BaseModuleTableView._suggest_bay_mapping(item, {"Slot 7": bay})
+ assert sug is None
+
+ def test_no_suggestion_when_item_has_no_trailing_number(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ item = {"entPhysicalName": "Mainboard", "entPhysicalClass": "module"}
+ bay = MagicMock()
+ bay.name = "Slot 0"
+ sug = BaseModuleTableView._suggest_bay_mapping(item, {"Slot 0": bay})
+ assert sug is None
+
+ def test_no_suggestion_when_module_bays_empty(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ item = {"entPhysicalName": "0/0", "entPhysicalClass": "module"}
+ sug = BaseModuleTableView._suggest_bay_mapping(item, {})
+ assert sug is None
+
+ def test_no_suggestion_when_scope_preserved(self):
+ """Suppress suggestions for sub-items whose scope was inherited from
+ an unmatched ancestor β the bays in scope are at the wrong level."""
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ item = {"entPhysicalName": "TenGigE0/0/0/0", "entPhysicalClass": "module"}
+ bay = MagicMock()
+ bay.name = "Slot 0"
+ sug = BaseModuleTableView._suggest_bay_mapping(item, {"Slot 0": bay}, scope_preserved=True)
+ assert sug is None
+
+ def test_no_suggestion_for_fan_when_only_slot_bays_exist(self):
+ """A fan must not be suggested into a chassis line-card slot bay."""
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ item = {"entPhysicalName": "0/FT0", "entPhysicalClass": "fan"}
+ bay = MagicMock()
+ bay.name = "Slot 0"
+ sug = BaseModuleTableView._suggest_bay_mapping(item, {"Slot 0": bay})
+ assert sug is None
+
+ def test_suggestion_for_fan_when_fan_named_bay_exists(self):
+ """A fan with a fan-named bay in scope yields a fan-targeted suggestion."""
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ item = {"entPhysicalName": "0/FT0", "entPhysicalClass": "fan"}
+ bay = MagicMock()
+ bay.name = "Fan Tray 0"
+ sug = BaseModuleTableView._suggest_bay_mapping(item, {"Fan Tray 0": bay})
+ assert sug is not None
+ assert "Fan Tray" in sug["netbox_bay_name"]
+
+ def test_no_suggestion_for_powersupply_when_only_slot_bays_exist(self):
+ """A power supply must not be suggested into a chassis line-card slot bay."""
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ item = {"entPhysicalName": "0/PT0-PM0", "entPhysicalClass": "powerSupply"}
+ bay = MagicMock()
+ bay.name = "Slot 0"
+ sug = BaseModuleTableView._suggest_bay_mapping(item, {"Slot 0": bay})
+ assert sug is None
+
+ def test_suggests_letter_trail_for_carrier_child_bays(self):
+ """`Slot A` should map to `CPM A` via a letter-capturing regex even
+ when prefix tokens differ (`Slot` vs `CPM`). This is the common
+ follow-up after the user installs a controller-card carrier whose
+ empty child bays are letter-named."""
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ item = {"entPhysicalName": "Slot A", "entPhysicalClass": "cpmModule"}
+ bay = MagicMock()
+ bay.name = "CPM A"
+ sug = BaseModuleTableView._suggest_bay_mapping(item, {"CPM A": bay})
+ assert sug is not None
+ assert sug["is_regex"] is True
+ assert sug["librenms_name"] == r"^Slot\ ([A-Za-z]+)$"
+ assert sug["netbox_bay_name"] == r"CPM \1"
+ assert sug["librenms_class"] == "cpmModule"
+ assert sug["example_item"] == "Slot A"
+ assert sug["example_bay"] == "CPM A"
+
+ def test_no_letter_trail_suggestion_when_no_letter_bay(self):
+ """`Slot A` should NOT match `Slot 0` β bay trail must be of same kind."""
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ item = {"entPhysicalName": "Slot A", "entPhysicalClass": "cpmModule"}
+ bay = MagicMock()
+ bay.name = "Slot 0"
+ sug = BaseModuleTableView._suggest_bay_mapping(item, {"Slot 0": bay})
+ assert sug is None
+
+
+class TestSuggestBayMappingFromDescr:
+ """`_suggest_bay_mapping` falls back to a description-based regex when the
+ LibreNMS name is just a model number with no positional info β e.g. Juniper
+ 'JNP304-LMIC16-BASE' with description 'MIC: ... @ 0/0/*' should suggest a
+ mapping that targets the existing 'MIC 0' bay."""
+
+ def test_juniper_mic_descr_yields_mapping(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ item = {
+ "entPhysicalName": "JNP304-LMIC16-BASE",
+ "entPhysicalDescr": "MIC: MRATE LMIC 16x100G/4x400G @ 0/0/*",
+ "entPhysicalClass": "container",
+ }
+ bays = {"MIC 0": MagicMock(), "RE 0": MagicMock(), "RE 1": MagicMock()}
+ sug = BaseModuleTableView._suggest_bay_mapping(item, bays)
+ assert sug is not None
+ assert sug["is_regex"] is True
+ assert sug["netbox_bay_name"] == "MIC \\1"
+ assert sug["example_bay"] == "MIC 0"
+ # The pattern must fullmatch the original description (so the saved
+ # mapping actually resolves at lookup time).
+ import re as _re
+
+ m = _re.fullmatch(sug["librenms_name"], item["entPhysicalDescr"])
+ assert m is not None
+ assert m.expand(sug["netbox_bay_name"]) == "MIC 0"
+
+ def test_no_descr_match_returns_none_for_container(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ item = {
+ "entPhysicalName": "X",
+ "entPhysicalDescr": "no class hint here",
+ "entPhysicalClass": "container",
+ }
+ sug = BaseModuleTableView._suggest_bay_mapping(item, {"MIC 0": MagicMock()})
+ assert sug is None
+
+ def test_descr_class_with_no_matching_bay_returns_none(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ item = {
+ "entPhysicalName": "X",
+ "entPhysicalDescr": "FPC: line card @ 5/0/*",
+ "entPhysicalClass": "container",
+ }
+ # Device only has MIC 0 β no FPC 5 bay β no suggestion
+ sug = BaseModuleTableView._suggest_bay_mapping(item, {"MIC 0": MagicMock()})
+ assert sug is None
+
+ def test_descr_fallback_preferred_over_none_for_module_class(self):
+ """When name-based heuristic finds no candidate AND the item is a
+ normal module class (not container), descr fallback should still fire
+ β useful for vendor inventories that put the model in entPhysicalName
+ but classify the row as 'module'."""
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ item = {
+ "entPhysicalName": "JNP304-LMIC16-BASE",
+ "entPhysicalDescr": "MIC: MRATE LMIC 16x100G/4x400G @ 1/0/*",
+ "entPhysicalClass": "module",
+ }
+ bays = {"MIC 0": MagicMock(), "MIC 1": MagicMock()}
+ sug = BaseModuleTableView._suggest_bay_mapping(item, bays)
+ assert sug is not None
+ assert sug["example_bay"] == "MIC 1"
+
+ def test_descr_trail_fallback_for_juniper_fan_tray_controller(self):
+ """Juniper fan trays carry the model in entPhysicalName ('JNP10008-FTC2')
+ and the human-readable position in entPhysicalDescr ('Fan Tray Controller 0').
+ The class+slot descr regex doesn't match, but the trailing-number heuristic
+ on the description should still surface a usable mapping suggestion that
+ targets the existing 'Fan Tray 0' bay (mapping evaluation already considers
+ entPhysicalDescr, so this resolves at lookup time)."""
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ item = {
+ "entPhysicalName": "JNP10008-FTC2",
+ "entPhysicalDescr": "Fan Tray Controller 0",
+ "entPhysicalClass": "fan",
+ "entPhysicalModelName": "JNP10008-FTC2",
+ }
+ bays = {"Fan Tray 0": MagicMock(), "Fan Tray 1": MagicMock(), "FPC 0": MagicMock()}
+ sug = BaseModuleTableView._suggest_bay_mapping(item, bays)
+ assert sug is not None
+ assert sug["is_regex"] is True
+ assert sug["librenms_class"] == "fan"
+ assert sug["netbox_bay_name"] == "Fan Tray \\1"
+ assert sug["example_bay"] == "Fan Tray 0"
+ assert sug["example_item"] == "Fan Tray Controller 0"
+ # The pattern must fullmatch the descr so the saved mapping resolves at lookup time.
+ import re as _re
+
+ m = _re.fullmatch(sug["librenms_name"], item["entPhysicalDescr"])
+ assert m is not None
+ assert m.expand(sug["netbox_bay_name"]) == "Fan Tray 0"
+
+ def test_descr_trail_fallback_skipped_when_descr_equals_name(self):
+ """If entPhysicalName already carries positional info and the
+ name-based heuristic still failed (e.g. no bay shares the trail),
+ the descr-trail fallback should not produce a suggestion when descr
+ is identical to name β the name-based pass was authoritative."""
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ item = {
+ "entPhysicalName": "Fan Tray 9",
+ "entPhysicalDescr": "Fan Tray 9",
+ "entPhysicalClass": "fan",
+ }
+ bays = {"Fan Tray 0": MagicMock(), "Fan Tray 1": MagicMock()}
+ sug = BaseModuleTableView._suggest_bay_mapping(item, bays)
+ assert sug is None
+
+ def test_descr_trail_fallback_respects_class_filter(self):
+ """The descr-trail fallback receives the already-class-filtered candidate
+ list, so a fan whose descr ends in '0' must not be mapped onto a 'Slot 0'
+ line-card bay."""
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ item = {
+ "entPhysicalName": "JNP10008-FTC2",
+ "entPhysicalDescr": "Fan Tray Controller 0",
+ "entPhysicalClass": "fan",
+ }
+ bays = {"Slot 0": MagicMock(), "Slot 1": MagicMock()} # no fan-named bays
+ sug = BaseModuleTableView._suggest_bay_mapping(item, bays)
+ assert sug is None
+
+
+class TestSuggestTypeMapping:
+ """`_suggest_type_mapping` produces a prefill dict for the ModuleTypeMapping form."""
+
+ def test_returns_none_when_model_blank(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ assert BaseModuleTableView._suggest_type_mapping({"entPhysicalModelName": ""}, None) is None
+ assert BaseModuleTableView._suggest_type_mapping({}, None) is None
+
+ def test_returns_dict_with_librenms_model(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ item = {"entPhysicalModelName": "SFP-10G-SR", "entPhysicalDescr": "10GBASE-SR"}
+ sug = BaseModuleTableView._suggest_type_mapping(item, None)
+ assert sug is not None
+ assert sug["librenms_model"] == "SFP-10G-SR"
+
+ def test_description_includes_physical_descr(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ item = {"entPhysicalModelName": "SFP-10G-SR", "entPhysicalDescr": "10GBASE-SR SFP+"}
+ sug = BaseModuleTableView._suggest_type_mapping(item, None)
+ assert "10GBASE-SR SFP+" in sug["description"]
+
+ def test_description_includes_bay_name_when_bay_available(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ bay = MagicMock()
+ bay.name = "SFP 1"
+ item = {"entPhysicalModelName": "SFP-10G-SR", "entPhysicalDescr": "10GBASE-SR"}
+ sug = BaseModuleTableView._suggest_type_mapping(item, bay)
+ assert "SFP 1" in sug["description"]
+
+ def test_description_omits_bay_name_when_no_bay(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ item = {"entPhysicalModelName": "GLC-TE", "entPhysicalDescr": "1000BaseT"}
+ sug = BaseModuleTableView._suggest_type_mapping(item, None)
+ assert sug is not None
+ assert "bay" not in sug["description"].lower() or "fitted" not in sug["description"]
+
+ def test_unspecified_model_produces_suggestion(self):
+ """'Unspecified' is a valid librenms_model β a mapping can still be created."""
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ bay = MagicMock()
+ bay.name = "SFP 2"
+ item = {"entPhysicalModelName": "Unspecified", "entPhysicalDescr": "1000BaseT"}
+ sug = BaseModuleTableView._suggest_type_mapping(item, bay)
+ assert sug is not None
+ assert sug["librenms_model"] == "Unspecified"
+ assert "SFP 2" in sug["description"]
+
+
+class TestSuggestModuleTypeCreate:
+ """`_suggest_module_type_create` produces a prefill dict for NetBox's native ModuleType create form."""
+
+ def test_returns_none_when_model_blank(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ assert BaseModuleTableView._suggest_module_type_create({"entPhysicalModelName": ""}, None) is None
+ assert BaseModuleTableView._suggest_module_type_create({}, None) is None
+
+ def test_prefills_model_and_part_number(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ item = {"entPhysicalModelName": "X2-10GB-LR", "entPhysicalDescr": "10Gbase-LR"}
+ sug = BaseModuleTableView._suggest_module_type_create(item, None)
+ assert sug["model"] == "X2-10GB-LR"
+ assert sug["part_number"] == "X2-10GB-LR"
+ assert sug["description"] == "10Gbase-LR"
+ assert "manufacturer" not in sug
+ assert "comments" not in sug
+
+ def test_prefills_manufacturer_pk(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ manufacturer = MagicMock()
+ manufacturer.pk = 42
+ item = {"entPhysicalModelName": "X2-10GB-LR"}
+ sug = BaseModuleTableView._suggest_module_type_create(item, manufacturer)
+ assert sug["manufacturer"] == 42
+
+ def test_truncates_long_model_to_100_and_part_number_to_50(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ long_model = "M" * 150
+ item = {"entPhysicalModelName": long_model}
+ sug = BaseModuleTableView._suggest_module_type_create(item, None)
+ assert len(sug["model"]) == 100
+ assert len(sug["part_number"]) == 50
+
+ def test_truncates_description_to_200_and_overflow_into_comments(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ long_desc = "D" * 250
+ item = {"entPhysicalModelName": "M", "entPhysicalDescr": long_desc}
+ sug = BaseModuleTableView._suggest_module_type_create(item, None)
+ assert len(sug["description"]) == 200
+ assert sug["comments"] == long_desc
+
+ def test_short_description_does_not_set_comments(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ item = {"entPhysicalModelName": "M", "entPhysicalDescr": "short"}
+ sug = BaseModuleTableView._suggest_module_type_create(item, None)
+ assert sug["description"] == "short"
+ assert "comments" not in sug
+
+
+class TestNoTypeWarningHints:
+ """`_build_no_type_warning` mentions the missing model name."""
+
+ def test_includes_model_name(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ msg = BaseModuleTableView._build_no_type_warning({"entPhysicalModelName": "ASR-9904-FAN"})
+ assert "ASR-9904-FAN" in msg
+ assert "ModuleType" in msg
+
+ def test_handles_missing_model_name(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ msg = BaseModuleTableView._build_no_type_warning({"entPhysicalModelName": ""})
+ assert msg # non-empty string
+
+
+class TestBuildRowModelWarning:
+ """`_build_row` populates `model_warning` for No Bay / No Type rows."""
+
+ def _view(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ v = object.__new__(BaseModuleTableView)
+ v._device_manufacturer = None
+ return v
+
+ def test_no_bay_row_gets_model_warning(self):
+ view = self._view()
+ view._match_module_bay = MagicMock(return_value=None)
+ item = {"entPhysicalName": "0/FT0", "entPhysicalClass": "fan", "entPhysicalModelName": "ASR-FAN"}
+ with (
+ patch("netbox_librenms_plugin.utils.has_nested_name_conflict", return_value=False),
+ patch("netbox_librenms_plugin.utils.resolve_module_type", return_value=MagicMock(model="ASR-FAN", pk=1)),
+ ):
+ row = view._build_row(item, {}, {"Slot 1": MagicMock()}, {"ASR-FAN": MagicMock(pk=1)})
+ assert row["status"] == "No Bay"
+ assert "model_warning" in row
+ assert row["model_warning"], "expected non-empty hint"
+
+ def test_no_type_row_gets_model_warning(self):
+ view = self._view()
+ bay = MagicMock()
+ bay.name = "Slot 1"
+ bay.installed_module = None
+ bay.get_absolute_url.return_value = "/b"
+ view._match_module_bay = MagicMock(return_value=bay)
+ item = {"entPhysicalName": "X", "entPhysicalClass": "module", "entPhysicalModelName": "UNKNOWN-MODEL"}
+ with (
+ patch("netbox_librenms_plugin.utils.has_nested_name_conflict", return_value=False),
+ patch("netbox_librenms_plugin.utils.resolve_module_type", return_value=None),
+ ):
+ row = view._build_row(item, {}, {}, {})
+ assert row["status"] == "No Type"
+ assert "UNKNOWN-MODEL" in row.get("model_warning", "")
+
+ def test_no_type_row_carries_module_type_create_prefill(self):
+ """A No Type row exposes a `module_type_create` dict so the table can
+ render the "Add Module Type" button linking to NetBox's native form."""
+ view = self._view()
+ bay = MagicMock()
+ bay.name = "Slot 1"
+ bay.installed_module = None
+ bay.get_absolute_url.return_value = "/b"
+ view._match_module_bay = MagicMock(return_value=bay)
+ manufacturer = MagicMock()
+ manufacturer.pk = 99
+ item = {
+ "entPhysicalName": "X",
+ "entPhysicalClass": "module",
+ "entPhysicalModelName": "X2-10GB-LR",
+ "entPhysicalDescr": "10Gbase-LR",
+ }
+ with (
+ patch("netbox_librenms_plugin.utils.has_nested_name_conflict", return_value=False),
+ patch("netbox_librenms_plugin.utils.resolve_module_type", return_value=None),
+ ):
+ row = view._build_row(item, {}, {}, {}, manufacturer=manufacturer)
+ assert row["status"] == "No Type"
+ create = row.get("module_type_create")
+ assert create is not None
+ assert create["model"] == "X2-10GB-LR"
+ assert create["part_number"] == "X2-10GB-LR"
+ assert create["manufacturer"] == 99
+ assert create["description"] == "10Gbase-LR"
+
+ def test_matched_row_has_no_model_warning(self):
+ view = self._view()
+ bay = MagicMock()
+ bay.name = "Slot 1"
+ bay.installed_module = None
+ bay.get_absolute_url.return_value = "/b"
+ view._match_module_bay = MagicMock(return_value=bay)
+ mt = MagicMock(pk=10)
+ mt.model = "M"
+ mt.get_absolute_url.return_value = "/mt"
+ item = {"entPhysicalName": "X", "entPhysicalClass": "module", "entPhysicalModelName": "M"}
+ with (
+ patch("netbox_librenms_plugin.utils.has_nested_name_conflict", return_value=False),
+ patch("netbox_librenms_plugin.utils.resolve_module_type", return_value=mt),
+ ):
+ row = view._build_row(item, {}, {"Slot 1": bay}, {"M": mt})
+ assert row["status"] == "Matched"
+ assert "model_warning" not in row
+
+ def test_no_bay_row_carries_model_suggestion_when_trailing_number_matches(self):
+ """A No Bay row whose item name shares a trailing number with a bay
+ in scope gets a `model_suggestion` field consumable by the table."""
+ view = self._view()
+ view._match_module_bay = MagicMock(return_value=None)
+ bay = MagicMock()
+ bay.name = "Slot 0"
+ item = {"entPhysicalName": "0/0", "entPhysicalClass": "module", "entPhysicalModelName": "X"}
+ with (
+ patch("netbox_librenms_plugin.utils.has_nested_name_conflict", return_value=False),
+ patch("netbox_librenms_plugin.utils.resolve_module_type", return_value=MagicMock(model="X", pk=1)),
+ ):
+ row = view._build_row(item, {}, {"Slot 0": bay}, {"X": MagicMock(pk=1)})
+ assert row["status"] == "No Bay"
+ sug = row.get("model_suggestion")
+ assert sug is not None
+ assert sug["librenms_name"] == r"^0/(\d+)$"
+ assert sug["netbox_bay_name"] == r"Slot \1"
+
+ def test_scope_uninstalled_no_bay_row_recommends_install_parent(self):
+ """When scope is empty due to an uninstalled ancestor, the warning
+ text instructs the user to install the parent module first."""
+ view = self._view()
+ view._match_module_bay = MagicMock(return_value=None)
+ item = {
+ "entPhysicalName": "TenGigE0/0/0/0",
+ "entPhysicalClass": "module",
+ "entPhysicalModelName": "SFP-X",
+ }
+ with (
+ patch("netbox_librenms_plugin.utils.has_nested_name_conflict", return_value=False),
+ patch(
+ "netbox_librenms_plugin.utils.resolve_module_type",
+ return_value=MagicMock(model="SFP-X", pk=1),
+ ),
+ ):
+ row = view._build_row(item, {}, {}, {"SFP-X": MagicMock(pk=1)}, scope_uninstalled=True)
+ assert row["status"] == "No Bay"
+ assert "install the parent module first" in row.get("model_warning", "").lower()
+
+ def test_no_bay_empty_parent_bays_sets_no_bay_reason(self):
+ """When parent module is installed but has no bay templates, _build_row
+ tags the row with no_bay_reason='empty_parent_bays'."""
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ view = object.__new__(BaseModuleTableView)
+ view._device_manufacturer = None
+ view._match_module_bay = MagicMock(return_value=None)
+ item = {
+ "entPhysicalName": "TenGigE0/0/0/0",
+ "entPhysicalClass": "module",
+ "entPhysicalModelName": "SFP-10G-SR",
+ }
+ with (
+ patch("netbox_librenms_plugin.utils.has_nested_name_conflict", return_value=False),
+ patch("netbox_librenms_plugin.utils.resolve_module_type", return_value=MagicMock(model="SFP-10G-SR", pk=1)),
+ ):
+ # scope_empty_installed_bays=True: installed parent has no bay templates
+ row = view._build_row(
+ item,
+ {},
+ {},
+ {"SFP-10G-SR": MagicMock(pk=1)},
+ scope_empty_installed_bays=True,
+ )
+ assert row["status"] == "No Bay"
+ assert row.get("no_bay_reason") == "empty_parent_bays"
+
+ def test_no_bay_empty_parent_bays_through_intermediate_container(self):
+ """Even with scope_preserved=True (intermediate unmatched container),
+ no_bay_reason is still set when scope_empty_installed_bays=True."""
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ view = object.__new__(BaseModuleTableView)
+ view._device_manufacturer = None
+ view._match_module_bay = MagicMock(return_value=None)
+ item = {
+ "entPhysicalName": "TenGigE0/0/0/0",
+ "entPhysicalClass": "module",
+ "entPhysicalModelName": "SFP-10G-SR",
+ }
+ with (
+ patch("netbox_librenms_plugin.utils.has_nested_name_conflict", return_value=False),
+ patch("netbox_librenms_plugin.utils.resolve_module_type", return_value=MagicMock(model="SFP-10G-SR", pk=1)),
+ ):
+ row = view._build_row(
+ item,
+ {},
+ {},
+ {"SFP-10G-SR": MagicMock(pk=1)},
+ scope_preserved=True,
+ scope_empty_installed_bays=True,
+ )
+ assert row["status"] == "No Bay"
+ assert row.get("no_bay_reason") == "empty_parent_bays"
+
+ def test_no_bay_default_scope_empty_flag_does_not_set_reason(self):
+ """Without scope_empty_installed_bays, plain empty scope gives no reason tag."""
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ view = object.__new__(BaseModuleTableView)
+ view._device_manufacturer = None
+ view._match_module_bay = MagicMock(return_value=None)
+ item = {
+ "entPhysicalName": "TenGigE0/0/0/0",
+ "entPhysicalClass": "module",
+ "entPhysicalModelName": "SFP-10G-SR",
+ }
+ with (
+ patch("netbox_librenms_plugin.utils.has_nested_name_conflict", return_value=False),
+ patch("netbox_librenms_plugin.utils.resolve_module_type", return_value=MagicMock(model="SFP-10G-SR", pk=1)),
+ ):
+ # Default scope_empty_installed_bays=False β could be unmatched ancestor
+ row = view._build_row(item, {}, {}, {"SFP-10G-SR": MagicMock(pk=1)})
+ assert row["status"] == "No Bay"
+ assert "no_bay_reason" not in row
+
+ def test_no_bay_with_bays_in_scope_does_not_set_no_bay_reason(self):
+ """When module_bays is non-empty (just no match), no_bay_reason is absent."""
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ view = object.__new__(BaseModuleTableView)
+ view._device_manufacturer = None
+ view._match_module_bay = MagicMock(return_value=None)
+ bay = MagicMock()
+ bay.name = "Slot 1"
+ item = {
+ "entPhysicalName": "0/5",
+ "entPhysicalClass": "module",
+ "entPhysicalModelName": "X",
+ }
+ with (
+ patch("netbox_librenms_plugin.utils.has_nested_name_conflict", return_value=False),
+ patch("netbox_librenms_plugin.utils.resolve_module_type", return_value=MagicMock(model="X", pk=1)),
+ ):
+ row = view._build_row(item, {}, {"Slot 1": bay}, {"X": MagicMock(pk=1)})
+ assert row["status"] == "No Bay"
+ assert "no_bay_reason" not in row
+
+ def test_no_bay_scope_uninstalled_does_not_set_no_bay_reason(self):
+ """scope_uninstalled=True is a different root cause; no_bay_reason absent."""
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ view = object.__new__(BaseModuleTableView)
+ view._device_manufacturer = None
+ view._match_module_bay = MagicMock(return_value=None)
+ item = {
+ "entPhysicalName": "TenGigE0/0/0/0",
+ "entPhysicalClass": "module",
+ "entPhysicalModelName": "SFP-X",
+ }
+ with (
+ patch("netbox_librenms_plugin.utils.has_nested_name_conflict", return_value=False),
+ patch("netbox_librenms_plugin.utils.resolve_module_type", return_value=MagicMock(model="SFP-X", pk=1)),
+ ):
+ row = view._build_row(item, {}, {}, {"SFP-X": MagicMock(pk=1)}, scope_uninstalled=True)
+ assert row["status"] == "No Bay"
+ assert "no_bay_reason" not in row
+
+
+class TestModelIncompleteFlag:
+ """_append_rows_for_item_context sets model_incomplete on parent when
+ installed module has no bay templates and children show no_bay_reason."""
+
+ def _make_parent_row(self, **kwargs):
+ row = {
+ "librenms_name": "0/0",
+ "status": "Installed",
+ "module_bay": "Slot 0",
+ "module_bay_id": 1,
+ }
+ row.update(kwargs)
+ return row
+
+ def test_model_incomplete_set_when_child_has_no_bay_reason(self):
+ """Parent is flagged model_incomplete when child rows have no_bay_reason='empty_parent_bays'."""
+ parent_row = self._make_parent_row()
+ child_row = {
+ "librenms_name": "TenGigE0/0/0/0",
+ "status": "No Bay",
+ "no_bay_reason": "empty_parent_bays",
+ }
+ table_data = [parent_row, child_row]
+ parent_row_idx = 0
+
+ mt = MagicMock()
+ mt.get_absolute_url.return_value = "/dcim/module-types/5/"
+ mt.__str__ = lambda self: "A9K-24X10GE-1G-TR"
+ installed_module = MagicMock()
+ installed_module.module_type = mt
+
+ # Simulate the flagging logic from _append_rows_for_item_context
+ child_bays = {}
+ if installed_module and not child_bays:
+ has_no_bay_children = any(
+ table_data[i].get("no_bay_reason") == "empty_parent_bays"
+ for i in range(parent_row_idx + 1, len(table_data))
+ )
+ if has_no_bay_children:
+ mt_ = installed_module.module_type
+ table_data[parent_row_idx]["model_incomplete"] = True
+ table_data[parent_row_idx]["model_incomplete_url"] = mt_.get_absolute_url()
+ table_data[parent_row_idx]["model_incomplete_name"] = str(mt_)
+
+ assert table_data[0].get("model_incomplete") is True
+ assert "/dcim/module-types/5/" in table_data[0].get("model_incomplete_url", "")
+
+ def test_model_incomplete_not_set_when_no_children_with_no_bay_reason(self):
+ """If children don't have no_bay_reason, parent stays unflagged even if child_bays empty."""
+ parent_row = self._make_parent_row()
+ child_row = {
+ "librenms_name": "TenGigE0/0/0/0",
+ "status": "Installed",
+ }
+ table_data = [parent_row, child_row]
+ parent_row_idx = 0
+
+ mt = MagicMock()
+ installed_module = MagicMock()
+ installed_module.module_type = mt
+ child_bays = {}
+
+ if installed_module and not child_bays:
+ has_no_bay_children = any(
+ table_data[i].get("no_bay_reason") == "empty_parent_bays"
+ for i in range(parent_row_idx + 1, len(table_data))
+ )
+ if has_no_bay_children:
+ table_data[parent_row_idx]["model_incomplete"] = True
+
+ assert "model_incomplete" not in table_data[0]
+
+ def test_model_incomplete_not_set_when_child_bays_nonempty(self):
+ """If the installed module DOES have bays in scope, no model_incomplete flag."""
+ parent_row = self._make_parent_row()
+ child_row = {
+ "librenms_name": "TenGigE0/0/0/0",
+ "status": "No Bay",
+ "no_bay_reason": "empty_parent_bays",
+ }
+ table_data = [parent_row, child_row]
+ parent_row_idx = 0
+
+ mt = MagicMock()
+ installed_module = MagicMock()
+ installed_module.module_type = mt
+ child_bays = {"Bay 0": MagicMock()} # non-empty
+
+ if installed_module and not child_bays:
+ has_no_bay_children = any(
+ table_data[i].get("no_bay_reason") == "empty_parent_bays"
+ for i in range(parent_row_idx + 1, len(table_data))
+ )
+ if has_no_bay_children:
+ table_data[parent_row_idx]["model_incomplete"] = True
+
+ assert "model_incomplete" not in table_data[0]
+
+
+class TestRenderStatusNoBayOnParent:
+ """render_status correctly labels child rows and parent 'Fix Model' badge."""
+
+ def _table(self):
+ from netbox_librenms_plugin.tables.modules import LibreNMSModuleTable
+
+ return object.__new__(LibreNMSModuleTable)
+
+ def test_no_bay_on_parent_label_for_empty_parent_bays(self):
+ """Status cell shows 'No Bay on Parent' when no_bay_reason == 'empty_parent_bays'."""
+ table = self._table()
+ record = {"status": "No Bay", "no_bay_reason": "empty_parent_bays"}
+ html = table.render_status("No Bay", record)
+ assert "No Bay on Parent" in str(html)
+ assert "No Bay" in str(html) # badge text changed but still present as substring
+
+ def test_plain_no_bay_label_without_reason(self):
+ """Without no_bay_reason, status cell shows plain 'No Bay'."""
+ table = self._table()
+ record = {"status": "No Bay"}
+ html = table.render_status("No Bay", record)
+ assert "No Bay on Parent" not in str(html)
+ assert "No Bay" in str(html)
+
+ def test_fix_model_badge_with_url(self):
+ """Parent row with model_incomplete + model_incomplete_url renders a link badge."""
+ table = self._table()
+ record = {
+ "status": "Installed",
+ "model_incomplete": True,
+ "model_incomplete_url": "/dcim/module-types/5/",
+ "model_incomplete_name": "A9K-24X10GE-1G-TR",
+ }
+ html = str(table.render_status("Installed", record))
+ assert "Fix Model" in html
+ assert "/dcim/module-types/5/" in html
+ assert "A9K-24X10GE-1G-TR" in html
+
+ def test_fix_model_badge_without_url_is_span(self):
+ """When model_incomplete_url is absent, badge is rendered as
."""
+ table = self._table()
+ record = {
+ "status": "Installed",
+ "model_incomplete": True,
+ "model_incomplete_name": "SomeType",
+ }
+ html = str(table.render_status("Installed", record))
+ assert "Fix Model" in html
+ assert " platform."""
+ from netbox_librenms_plugin.models import PlatformMapping
+
+ mapping = PlatformMapping.__new__(PlatformMapping)
+ mapping.librenms_os = "ios"
+ platform = MagicMock()
+ platform.__str__ = lambda s: "Cisco IOS"
+ _set_fk_cache(mapping, "netbox_platform", platform)
+ assert str(mapping) == "ios -> Cisco IOS"
+
+ def test_clean_strips_whitespace(self):
+ """clean() strips leading/trailing whitespace from librenms_os."""
+ from netbox_librenms_plugin.models import PlatformMapping
+
+ mapping = PlatformMapping.__new__(PlatformMapping)
+ mapping.librenms_os = " ios "
+ mapping.description = ""
+ with patch("netbox.models.NetBoxModel.clean"):
+ mapping.clean()
+ assert mapping.librenms_os == "ios"
+
+ def test_clean_normalizes_to_lowercase(self):
+ """clean() lowercases librenms_os to prevent case-variant duplicates."""
+ from netbox_librenms_plugin.models import PlatformMapping
+
+ mapping = PlatformMapping.__new__(PlatformMapping)
+ mapping.librenms_os = "IOS"
+ mapping.description = ""
+ with patch("netbox.models.NetBoxModel.clean"):
+ mapping.clean()
+ assert mapping.librenms_os == "ios"
+
+ def test_clean_strips_and_lowercases(self):
+ """clean() strips and lowercases in one pass."""
+ from netbox_librenms_plugin.models import PlatformMapping
+
+ mapping = PlatformMapping.__new__(PlatformMapping)
+ mapping.librenms_os = " EOS "
+ mapping.description = ""
+ with patch("netbox.models.NetBoxModel.clean"):
+ mapping.clean()
+ assert mapping.librenms_os == "eos"
+
+ def test_clean_raises_on_blank(self):
+ """clean() raises ValidationError when librenms_os is blank after strip."""
+ from django.core.exceptions import ValidationError
+
+ from netbox_librenms_plugin.models import PlatformMapping
+
+ mapping = PlatformMapping.__new__(PlatformMapping)
+ mapping.librenms_os = " "
+ mapping.description = ""
+
+ import pytest
+
+ with pytest.raises(ValidationError) as exc_info:
+ with patch("netbox.models.NetBoxModel.clean"):
+ mapping.clean()
+ assert "librenms_os" in str(exc_info.value)
+
+ def test_get_absolute_url(self):
+ """get_absolute_url returns correct URL."""
+ from netbox_librenms_plugin.models import PlatformMapping
+
+ mapping = PlatformMapping.__new__(PlatformMapping)
+ mapping.pk = 42
+
+ with patch("netbox_librenms_plugin.models.reverse") as mock_reverse:
+ mock_reverse.return_value = "/plugins/librenms/platform-mappings/42/"
+ url = mapping.get_absolute_url()
+ mock_reverse.assert_called_once_with("plugins:netbox_librenms_plugin:platformmapping_detail", args=[42])
+ assert url == "/plugins/librenms/platform-mappings/42/"
+
+ def test_meta_ordering(self):
+ """Model Meta ordering is by librenms_os."""
+ from netbox_librenms_plugin.models import PlatformMapping
+
+ assert PlatformMapping._meta.ordering == ["librenms_os"]
+
+
+# =============================================================================
+# TestDeviceTypeMappingModel
+# =============================================================================
+
+
+class TestDeviceTypeMappingModel:
+ """Tests for DeviceTypeMapping.clean() normalization."""
+
+ def test_clean_strips_whitespace(self):
+ """clean() strips leading/trailing whitespace from librenms_hardware."""
+ from netbox_librenms_plugin.models import DeviceTypeMapping
+
+ mapping = DeviceTypeMapping.__new__(DeviceTypeMapping)
+ mapping.librenms_hardware = " Cisco 4321 "
+ with patch("netbox.models.NetBoxModel.clean"):
+ mapping.clean()
+ assert mapping.librenms_hardware == "cisco 4321"
+
+ def test_clean_normalizes_to_lowercase(self):
+ """clean() lowercases librenms_hardware to prevent case-variant duplicates."""
+ from netbox_librenms_plugin.models import DeviceTypeMapping
+
+ mapping = DeviceTypeMapping.__new__(DeviceTypeMapping)
+ mapping.librenms_hardware = "Juniper MX480"
+ with patch("netbox.models.NetBoxModel.clean"):
+ mapping.clean()
+ assert mapping.librenms_hardware == "juniper mx480"
+
+ def test_clean_raises_on_blank(self):
+ """clean() raises ValidationError when librenms_hardware is blank after strip."""
+ import pytest
+ from django.core.exceptions import ValidationError
+
+ from netbox_librenms_plugin.models import DeviceTypeMapping
+
+ mapping = DeviceTypeMapping.__new__(DeviceTypeMapping)
+ mapping.librenms_hardware = " "
+ with pytest.raises(ValidationError) as exc_info:
+ with patch("netbox.models.NetBoxModel.clean"):
+ mapping.clean()
+ assert "librenms_hardware" in str(exc_info.value)
+
+
+class TestPlatformMappingToYaml:
+ """to_yaml() returns valid YAML string with expected keys."""
+
+ def test_to_yaml_returns_string(self):
+ """to_yaml() returns a string."""
+ from netbox_librenms_plugin.models import PlatformMapping
+
+ mapping = PlatformMapping.__new__(PlatformMapping)
+ mapping.librenms_os = "ios"
+ platform = MagicMock()
+ platform.__str__ = lambda s: "Cisco IOS"
+ _set_fk_cache(mapping, "netbox_platform", platform)
+ mapping.description = "Test description"
+
+ result = mapping.to_yaml()
+ assert isinstance(result, str)
+
+ def test_to_yaml_contains_expected_keys(self):
+ """to_yaml() output contains librenms_os, netbox_platform, description."""
+ import yaml
+
+ from netbox_librenms_plugin.models import PlatformMapping
+
+ mapping = PlatformMapping.__new__(PlatformMapping)
+ mapping.librenms_os = "ios"
+ platform = MagicMock()
+ platform.__str__ = lambda s: "Cisco IOS"
+ _set_fk_cache(mapping, "netbox_platform", platform)
+ mapping.description = "A description"
+
+ result = yaml.safe_load(mapping.to_yaml())
+ assert result["librenms_os"] == "ios"
+ assert result["netbox_platform"] == "Cisco IOS"
+ assert result["description"] == "A description"
+
+
+# =============================================================================
+# TestToYamlOnAllMappingModels
+# =============================================================================
+
+
+class TestToYamlOnAllMappingModels:
+ """All mapping models must have to_yaml() returning a YAML string."""
+
+ def test_device_type_mapping_has_to_yaml(self):
+ """DeviceTypeMapping.to_yaml() returns a YAML string."""
+ import yaml
+
+ from netbox_librenms_plugin.models import DeviceTypeMapping
+
+ mapping = DeviceTypeMapping.__new__(DeviceTypeMapping)
+ mapping.librenms_hardware = "Cisco 4321"
+ device_type = MagicMock()
+ device_type.__str__ = lambda s: "Cisco 4321"
+ _set_fk_cache(mapping, "netbox_device_type", device_type)
+ mapping.description = ""
+
+ result = mapping.to_yaml()
+ assert isinstance(result, str)
+ data = yaml.safe_load(result)
+ assert "librenms_hardware" in data
+ assert data["librenms_hardware"] == "Cisco 4321"
+
+ def test_module_type_mapping_has_to_yaml(self):
+ """ModuleTypeMapping.to_yaml() returns a YAML string."""
+ import yaml
+
+ from netbox_librenms_plugin.models import ModuleTypeMapping
+
+ mapping = ModuleTypeMapping.__new__(ModuleTypeMapping)
+ mapping.librenms_model = "WS-X4748-RJ45"
+ module_type = MagicMock()
+ module_type.__str__ = lambda s: "WS-X4748"
+ _set_fk_cache(mapping, "netbox_module_type", module_type)
+ mapping.manufacturer_id = None
+ mapping.description = ""
+
+ result = mapping.to_yaml()
+ assert isinstance(result, str)
+ data = yaml.safe_load(result)
+ assert "librenms_model" in data
+
+ def test_interface_type_mapping_has_to_yaml(self):
+ """InterfaceTypeMapping.to_yaml() returns a YAML string."""
+ import yaml
+
+ from netbox_librenms_plugin.models import InterfaceTypeMapping
+
+ mapping = InterfaceTypeMapping.__new__(InterfaceTypeMapping)
+ mapping.librenms_type = "ether"
+ mapping.librenms_speed = 1000000
+ mapping.netbox_type = "1000base-t"
+ mapping.description = ""
+
+ result = mapping.to_yaml()
+ assert isinstance(result, str)
+ data = yaml.safe_load(result)
+ assert "librenms_type" in data
+
+ def test_module_bay_mapping_has_to_yaml(self):
+ """ModuleBayMapping.to_yaml() returns a YAML string."""
+ import yaml
+
+ from netbox_librenms_plugin.models import ModuleBayMapping
+
+ mapping = ModuleBayMapping.__new__(ModuleBayMapping)
+ mapping.librenms_name = "Slot 1"
+ mapping.librenms_class = "container"
+ mapping.netbox_bay_name = "Slot 1"
+ mapping.is_regex = False
+ mapping.manufacturer_id = None
+ _set_fk_cache(mapping, "manufacturer", None)
+ mapping.description = ""
+
+ result = mapping.to_yaml()
+ assert isinstance(result, str)
+ data = yaml.safe_load(result)
+ assert "librenms_name" in data
+
+ def test_normalization_rule_has_to_yaml(self):
+ """NormalizationRule.to_yaml() returns a YAML string."""
+ import yaml
+
+ from netbox_librenms_plugin.models import NormalizationRule
+
+ rule = NormalizationRule.__new__(NormalizationRule)
+ rule.scope = "device_type"
+ _set_fk_cache(rule, "manufacturer", None)
+ rule.match_pattern = r"^Cisco\s+"
+ rule.replacement = "Cisco"
+ rule.priority = 10
+ rule.description = ""
+
+ result = rule.to_yaml()
+ assert isinstance(result, str)
+ data = yaml.safe_load(result)
+ assert "scope" in data
+ assert "match_pattern" in data
+
+ def test_inventory_ignore_rule_has_to_yaml(self):
+ """InventoryIgnoreRule.to_yaml() returns a YAML string."""
+ import yaml
+
+ from netbox_librenms_plugin.models import InventoryIgnoreRule
+
+ rule = InventoryIgnoreRule.__new__(InventoryIgnoreRule)
+ rule.name = "Skip IDPROM"
+ rule.match_type = "ends_with"
+ rule.pattern = "IDPROM"
+ rule.action = "skip"
+ rule.require_serial_match_parent = False
+ rule.enabled = True
+ rule.description = ""
+
+ result = rule.to_yaml()
+ assert isinstance(result, str)
+ data = yaml.safe_load(result)
+ assert "name" in data
+ assert "match_type" in data
+
+
+# =============================================================================
+# TestFindMatchingPlatformWithMapping
+# =============================================================================
+
+
+class TestFindMatchingPlatformWithMapping:
+ """find_matching_platform checks PlatformMapping before direct name match."""
+
+ def test_platform_mapping_used_as_fallback_when_no_name_match(self):
+ """When no Platform name matches, PlatformMapping is used as fallback."""
+ from netbox_librenms_plugin.utils import find_matching_platform
+
+ mock_mapped_platform = MagicMock(name="mapped_platform")
+ mock_mapping = MagicMock()
+ mock_mapping.netbox_platform = mock_mapped_platform
+
+ mock_pm_class = MagicMock()
+ mock_pm_class.objects.get.return_value = mock_mapping
+ mock_pm_class.DoesNotExist = type("DoesNotExist", (Exception,), {})
+
+ mock_platform_model = MagicMock()
+ mock_platform_model.DoesNotExist = type("DoesNotExist", (Exception,), {})
+ mock_platform_model.objects.get.side_effect = mock_platform_model.DoesNotExist
+
+ with (
+ patch("netbox_librenms_plugin.models.PlatformMapping", mock_pm_class),
+ patch("dcim.models.Platform", mock_platform_model),
+ ):
+ result = find_matching_platform("ios")
+
+ assert result["found"] is True
+ assert result["platform"] is mock_mapped_platform
+ assert result["match_type"] == "mapping"
+
+ def test_falls_back_to_name_match_when_no_platform_mapping(self):
+ """When no PlatformMapping exists, falls back to exact Platform name match."""
+ from netbox_librenms_plugin.utils import find_matching_platform
+
+ mock_platform = MagicMock()
+
+ mock_pm_class = MagicMock()
+ mock_pm_class.DoesNotExist = type("DoesNotExist", (Exception,), {})
+ mock_pm_class.objects.get.side_effect = mock_pm_class.DoesNotExist
+
+ mock_platform_model = MagicMock()
+ mock_platform_model.objects.get.return_value = mock_platform
+
+ with (
+ patch("netbox_librenms_plugin.models.PlatformMapping", mock_pm_class),
+ patch("dcim.models.Platform", mock_platform_model),
+ ):
+ result = find_matching_platform("ios")
+
+ assert result["found"] is True
+ assert result["platform"] is mock_platform
+ assert result["match_type"] == "exact"
+
+ def test_returns_not_found_when_neither_mapping_nor_platform(self):
+ """Returns found=False when neither PlatformMapping nor Platform name match exists."""
+ from netbox_librenms_plugin.utils import find_matching_platform
+
+ DoesNotExist = type("DoesNotExist", (Exception,), {})
+
+ mock_pm_class = MagicMock()
+ mock_pm_class.DoesNotExist = DoesNotExist
+ mock_pm_class.objects.get.side_effect = DoesNotExist
+
+ mock_platform_model = MagicMock()
+ mock_platform_model.DoesNotExist = DoesNotExist
+ mock_platform_model.objects.get.side_effect = DoesNotExist
+
+ with (
+ patch("netbox_librenms_plugin.models.PlatformMapping", mock_pm_class),
+ patch("dcim.models.Platform", mock_platform_model),
+ ):
+ result = find_matching_platform("unknown_os")
+
+ assert result["found"] is False
+ assert result["platform"] is None
+
+ def test_multiple_platform_mappings_returns_ambiguous(self):
+ """When exact name fails and PlatformMapping.MultipleObjectsReturned, returns ambiguous."""
+ from netbox_librenms_plugin.utils import find_matching_platform
+
+ DoesNotExist = type("DoesNotExist", (Exception,), {})
+ MultipleObjectsReturned = type("MultipleObjectsReturned", (Exception,), {})
+
+ mock_pm_class = MagicMock()
+ mock_pm_class.DoesNotExist = DoesNotExist
+ mock_pm_class.MultipleObjectsReturned = MultipleObjectsReturned
+ mock_pm_class.objects.get.side_effect = MultipleObjectsReturned
+
+ mock_platform_model = MagicMock()
+ mock_platform_model.DoesNotExist = DoesNotExist
+ mock_platform_model.objects.get.side_effect = DoesNotExist
+
+ with (
+ patch("netbox_librenms_plugin.models.PlatformMapping", mock_pm_class),
+ patch("dcim.models.Platform", mock_platform_model),
+ ):
+ result = find_matching_platform("ios")
+
+ assert result == {"found": False, "platform": None, "match_type": "ambiguous", "ambiguity_source": "mapping"}
+
+ def test_exact_platform_wins_over_existing_mapping(self):
+ """When a single Platform exists for the OS string, the exact match wins even if a PlatformMapping also exists."""
+ from netbox_librenms_plugin.utils import find_matching_platform
+
+ DoesNotExist = type("DoesNotExist", (Exception,), {})
+ MultipleObjectsReturned = type("MultipleObjectsReturned", (Exception,), {})
+
+ # Both an exact Platform and a PlatformMapping exist for "ios" β they would
+ # resolve to *different* Platform objects. Exact match must win; the mapping
+ # branch must never be consulted.
+ exact_platform = MagicMock(name="exact_platform")
+ mapping_platform = MagicMock(name="mapping_platform")
+ mapping = MagicMock(netbox_platform=mapping_platform)
+
+ mock_pm_class = MagicMock()
+ mock_pm_class.DoesNotExist = DoesNotExist
+ mock_pm_class.MultipleObjectsReturned = MultipleObjectsReturned
+ mock_pm_class.objects.get.return_value = mapping
+
+ mock_platform_model = MagicMock()
+ mock_platform_model.DoesNotExist = DoesNotExist
+ mock_platform_model.MultipleObjectsReturned = MultipleObjectsReturned
+ mock_platform_model.objects.get.return_value = exact_platform
+
+ with (
+ patch("netbox_librenms_plugin.models.PlatformMapping", mock_pm_class),
+ patch("dcim.models.Platform", mock_platform_model),
+ ):
+ result = find_matching_platform("ios")
+
+ assert result["found"] is True
+ assert result["platform"] is exact_platform
+ assert result["match_type"] == "exact"
+ # Mapping must not be consulted when exact resolves cleanly.
+ mock_pm_class.objects.get.assert_not_called()
+
+ def test_ambiguous_platform_falls_through_to_mapping_resolution(self):
+ """When Platform.MultipleObjectsReturned fires, PlatformMapping is consulted; if it resolves, mapping wins (not 'ambiguous')."""
+ from netbox_librenms_plugin.utils import find_matching_platform
+
+ DoesNotExist = type("DoesNotExist", (Exception,), {})
+ MultipleObjectsReturned = type("MultipleObjectsReturned", (Exception,), {})
+
+ mapping_platform = MagicMock(name="mapping_platform")
+ mapping = MagicMock(netbox_platform=mapping_platform)
+
+ mock_pm_class = MagicMock()
+ mock_pm_class.DoesNotExist = DoesNotExist
+ mock_pm_class.MultipleObjectsReturned = MultipleObjectsReturned
+ mock_pm_class.objects.get.return_value = mapping
+
+ mock_platform_model = MagicMock()
+ mock_platform_model.DoesNotExist = DoesNotExist
+ mock_platform_model.MultipleObjectsReturned = MultipleObjectsReturned
+ # Exact lookup is ambiguous β but mapping resolves cleanly, so mapping wins.
+ mock_platform_model.objects.get.side_effect = MultipleObjectsReturned
+
+ with (
+ patch("netbox_librenms_plugin.models.PlatformMapping", mock_pm_class),
+ patch("dcim.models.Platform", mock_platform_model),
+ ):
+ result = find_matching_platform("ios")
+
+ assert result["found"] is True
+ assert result["platform"] is mapping_platform
+ assert result["match_type"] == "mapping"
+
+ def test_ambiguous_platform_with_no_mapping_returns_platform_ambiguous(self):
+ """When Platform.MultipleObjectsReturned fires and PlatformMapping has no entry, ambiguity_source='platform'."""
+ from netbox_librenms_plugin.utils import find_matching_platform
+
+ DoesNotExist = type("DoesNotExist", (Exception,), {})
+ MultipleObjectsReturned = type("MultipleObjectsReturned", (Exception,), {})
+
+ mock_pm_class = MagicMock()
+ mock_pm_class.DoesNotExist = DoesNotExist
+ mock_pm_class.MultipleObjectsReturned = MultipleObjectsReturned
+ mock_pm_class.objects.get.side_effect = DoesNotExist
+
+ mock_platform_model = MagicMock()
+ mock_platform_model.DoesNotExist = DoesNotExist
+ mock_platform_model.MultipleObjectsReturned = MultipleObjectsReturned
+ mock_platform_model.objects.get.side_effect = MultipleObjectsReturned
+
+ with (
+ patch("netbox_librenms_plugin.models.PlatformMapping", mock_pm_class),
+ patch("dcim.models.Platform", mock_platform_model),
+ ):
+ result = find_matching_platform("ios")
+
+ assert result == {"found": False, "platform": None, "match_type": "ambiguous", "ambiguity_source": "platform"}
+
+
+# =============================================================================
+# TestBulkExportYAMLView
+# =============================================================================
+
+
+class TestBulkExportYAMLView:
+ """BulkExportYAMLView returns YAML for selected PKs."""
+
+ def _make_request(self, pk_list):
+ request = MagicMock()
+ request.POST = MagicMock()
+ request.POST.getlist = MagicMock(return_value=pk_list)
+ return request
+
+ def test_returns_yaml_content_type(self):
+ """Response has content-type text/yaml."""
+
+ from netbox_librenms_plugin.views.mapping_views import DeviceTypeMappingBulkExportYAMLView
+
+ view = DeviceTypeMappingBulkExportYAMLView.__new__(DeviceTypeMappingBulkExportYAMLView)
+ request = self._make_request(["1", "2"])
+
+ mock_mapping = MagicMock()
+ mock_mapping.to_yaml.return_value = "librenms_hardware: Cisco 4321\n"
+
+ mock_qs = MagicMock()
+ mock_qs.filter.return_value.order_by.return_value = [mock_mapping, mock_mapping]
+ view.queryset = mock_qs
+
+ with patch.object(view, "require_object_permissions", return_value=None):
+ response = view.post(request)
+
+ assert "text/yaml" in response.get("Content-Type", "")
+
+ def test_returns_yaml_for_selected_pks(self):
+ """Response body contains YAML from selected objects."""
+ from netbox_librenms_plugin.views.mapping_views import DeviceTypeMappingBulkExportYAMLView
+
+ view = DeviceTypeMappingBulkExportYAMLView.__new__(DeviceTypeMappingBulkExportYAMLView)
+ request = self._make_request(["1"])
+
+ mock_mapping = MagicMock()
+ mock_mapping.to_yaml.return_value = "librenms_hardware: Cisco 4321\n"
+
+ mock_qs = MagicMock()
+ mock_qs.filter.return_value.order_by.return_value = [mock_mapping]
+ view.queryset = mock_qs
+
+ with patch.object(view, "require_object_permissions", return_value=None):
+ response = view.post(request)
+
+ content = response.content.decode()
+ assert "Cisco 4321" in content
+
+ def test_filters_by_selected_pks(self):
+ """View filters queryset by the selected PKs from POST data."""
+ from netbox_librenms_plugin.views.mapping_views import DeviceTypeMappingBulkExportYAMLView
+
+ view = DeviceTypeMappingBulkExportYAMLView.__new__(DeviceTypeMappingBulkExportYAMLView)
+ request = self._make_request(["3", "7"])
+
+ mock_qs = MagicMock()
+ view.queryset = mock_qs
+
+ with patch.object(view, "require_object_permissions", return_value=None):
+ view.post(request)
+
+ mock_qs.filter.assert_called_once_with(pk__in=[3, 7])
+ mock_qs.filter.return_value.order_by.assert_called_once_with("pk")
+
+ def test_returns_200_with_empty_selection(self):
+ """Response is 400 when no PKs are selected."""
+ from netbox_librenms_plugin.views.mapping_views import DeviceTypeMappingBulkExportYAMLView
+
+ view = DeviceTypeMappingBulkExportYAMLView.__new__(DeviceTypeMappingBulkExportYAMLView)
+ request = self._make_request([])
+
+ mock_qs = MagicMock()
+ mock_qs.filter.return_value.order_by.return_value = []
+ view.queryset = mock_qs
+
+ with patch.object(view, "require_object_permissions", return_value=None):
+ response = view.post(request)
+
+ assert response.status_code == 400
+
+ def test_all_mapping_bulk_export_yaml_views_exist(self):
+ """All mapping model BulkExportYAML views exist."""
+ from netbox_librenms_plugin.views.mapping_views import (
+ DeviceTypeMappingBulkExportYAMLView,
+ InterfaceTypeMappingBulkExportYAMLView,
+ InventoryIgnoreRuleBulkExportYAMLView,
+ ModuleBayMappingBulkExportYAMLView,
+ ModuleTypeMappingBulkExportYAMLView,
+ NormalizationRuleBulkExportYAMLView,
+ PlatformMappingBulkExportYAMLView,
+ )
+
+ for cls in [
+ DeviceTypeMappingBulkExportYAMLView,
+ InterfaceTypeMappingBulkExportYAMLView,
+ InventoryIgnoreRuleBulkExportYAMLView,
+ ModuleBayMappingBulkExportYAMLView,
+ ModuleTypeMappingBulkExportYAMLView,
+ NormalizationRuleBulkExportYAMLView,
+ PlatformMappingBulkExportYAMLView,
+ ]:
+ assert cls is not None
+
+
+# =============================================================================
+# TestPlatformMappingViewsExist
+# =============================================================================
+
+
+class TestPlatformMappingViewsExist:
+ """All PlatformMapping CRUD views must exist in mapping_views."""
+
+ def test_list_view_exists(self):
+ from netbox_librenms_plugin.views.mapping_views import PlatformMappingListView
+
+ assert PlatformMappingListView is not None
+
+ def test_create_view_exists(self):
+ from netbox_librenms_plugin.views.mapping_views import PlatformMappingCreateView
+
+ assert PlatformMappingCreateView is not None
+
+ def test_edit_view_exists(self):
+ from netbox_librenms_plugin.views.mapping_views import PlatformMappingEditView
+
+ assert PlatformMappingEditView is not None
+
+ def test_delete_view_exists(self):
+ from netbox_librenms_plugin.views.mapping_views import PlatformMappingDeleteView
+
+ assert PlatformMappingDeleteView is not None
+
+ def test_bulk_delete_view_exists(self):
+ from netbox_librenms_plugin.views.mapping_views import PlatformMappingBulkDeleteView
+
+ assert PlatformMappingBulkDeleteView is not None
+
+ def test_bulk_import_view_exists(self):
+ from netbox_librenms_plugin.views.mapping_views import PlatformMappingBulkImportView
+
+ assert PlatformMappingBulkImportView is not None
+
+ def test_detail_view_exists(self):
+ from netbox_librenms_plugin.views.mapping_views import PlatformMappingView
+
+ assert PlatformMappingView is not None
+
+ def test_changelog_view_exists(self):
+ from netbox_librenms_plugin.views.mapping_views import PlatformMappingChangeLogView
+
+ assert PlatformMappingChangeLogView is not None
+
+
+# =============================================================================
+# TestPlatformMappingFormsExist
+# =============================================================================
+
+
+class TestPlatformMappingFormsExist:
+ """PlatformMapping form classes must exist."""
+
+ def test_form_exists(self):
+ from netbox_librenms_plugin.forms import PlatformMappingForm
+
+ assert PlatformMappingForm is not None
+
+ def test_filter_form_exists(self):
+ from netbox_librenms_plugin.forms import PlatformMappingFilterForm
+
+ assert PlatformMappingFilterForm is not None
+
+ def test_import_form_exists(self):
+ from netbox_librenms_plugin.forms import PlatformMappingImportForm
+
+ assert PlatformMappingImportForm is not None
+
+ def test_filter_form_has_librenms_os_field(self):
+ """PlatformMappingFilterForm has librenms_os as a filter field."""
+ from netbox_librenms_plugin.forms import PlatformMappingFilterForm
+
+ assert "librenms_os" in PlatformMappingFilterForm.base_fields
+
+ def test_import_form_fields_cover_required_columns(self):
+ """PlatformMappingImportForm covers librenms_os and netbox_platform."""
+ from netbox_librenms_plugin.forms import PlatformMappingImportForm
+
+ assert "librenms_os" in PlatformMappingImportForm._meta.fields
+ assert "netbox_platform" in PlatformMappingImportForm._meta.fields
+
+
+# =============================================================================
+# TestReplacementTemplateValidation (Issue #64)
+# =============================================================================
+
+
+class TestReplacementTemplateValidation:
+ """Replacement template is validated against a guaranteed-match synthetic pattern."""
+
+ # --- ModuleBayMapping ---
+
+ def test_module_bay_mapping_rejects_out_of_range_backref(self):
+ """Referencing group \\2 when pattern has only one group should raise ValidationError."""
+ import pytest
+ from django.core.exceptions import ValidationError
+
+ from netbox_librenms_plugin.models import ModuleBayMapping
+
+ mapping = ModuleBayMapping.__new__(ModuleBayMapping)
+ mapping.librenms_name = r"^(\d+)$"
+ mapping.librenms_class = ""
+ mapping.netbox_bay_name = r"Slot \2" # only 1 group
+ mapping.is_regex = True
+ mapping.description = ""
+
+ with patch("netbox.models.NetBoxModel.clean"):
+ with pytest.raises(ValidationError) as exc_info:
+ mapping.clean()
+ assert "netbox_bay_name" in exc_info.value.message_dict
+
+ def test_module_bay_mapping_accepts_valid_backref(self):
+ """Valid \\1 back-reference on a single-group pattern is accepted."""
+ from netbox_librenms_plugin.models import ModuleBayMapping
+
+ mapping = ModuleBayMapping.__new__(ModuleBayMapping)
+ mapping.librenms_name = r"^(\d+)$"
+ mapping.librenms_class = ""
+ mapping.netbox_bay_name = r"Slot \1"
+ mapping.is_regex = True
+ mapping.description = ""
+
+ with patch("netbox.models.NetBoxModel.clean"):
+ mapping.clean() # Should not raise
+
+ def test_module_bay_mapping_accepts_named_backref(self):
+ """Valid \\g back-reference on a named-group pattern is accepted."""
+ from netbox_librenms_plugin.models import ModuleBayMapping
+
+ mapping = ModuleBayMapping.__new__(ModuleBayMapping)
+ mapping.librenms_name = r"^(?P\d+)$"
+ mapping.librenms_class = ""
+ mapping.netbox_bay_name = r"Slot \g"
+ mapping.is_regex = True
+ mapping.description = ""
+
+ with patch("netbox.models.NetBoxModel.clean"):
+ mapping.clean() # Should not raise
+
+ def test_module_bay_mapping_rejects_invalid_named_backref(self):
+ """Referencing a named group that does not exist raises ValidationError."""
+ import pytest
+ from django.core.exceptions import ValidationError
+
+ from netbox_librenms_plugin.models import ModuleBayMapping
+
+ mapping = ModuleBayMapping.__new__(ModuleBayMapping)
+ mapping.librenms_name = r"^(\d+)$"
+ mapping.librenms_class = ""
+ mapping.netbox_bay_name = r"Slot \g"
+ mapping.is_regex = True
+ mapping.description = ""
+
+ with patch("netbox.models.NetBoxModel.clean"):
+ with pytest.raises(ValidationError) as exc_info:
+ mapping.clean()
+ assert "netbox_bay_name" in exc_info.value.message_dict
+
+ # --- NormalizationRule ---
+
+ def test_normalization_rule_rejects_out_of_range_backref(self):
+ """Replacement referencing group \\2 when pattern has only 1 group raises ValidationError."""
+ import pytest
+ from django.core.exceptions import ValidationError
+
+ from netbox_librenms_plugin.models import NormalizationRule
+
+ rule = NormalizationRule.__new__(NormalizationRule)
+ rule.match_pattern = r"^(\w+)$"
+ rule.replacement = r"\2" # only 1 group
+ rule.scope = "device_type"
+ rule.description = ""
+ _set_fk_cache(rule, "manufacturer", None)
+
+ with patch("netbox.models.NetBoxModel.clean"):
+ with pytest.raises(ValidationError) as exc_info:
+ rule.clean()
+ assert "replacement" in exc_info.value.message_dict
+
+ def test_normalization_rule_accepts_valid_backref(self):
+ """Replacement \\1 on single-group pattern is accepted."""
+ from netbox_librenms_plugin.models import NormalizationRule
+
+ rule = NormalizationRule.__new__(NormalizationRule)
+ rule.match_pattern = r"^(\w+)$"
+ rule.replacement = r"\1"
+ rule.scope = "device_type"
+ rule.description = ""
+ _set_fk_cache(rule, "manufacturer", None)
+
+ with patch("netbox.models.NetBoxModel.clean"):
+ rule.clean() # Should not raise
+
+ def test_normalization_rule_accepts_named_backref(self):
+ """Replacement \\g on named-group pattern is accepted."""
+ from netbox_librenms_plugin.models import NormalizationRule
+
+ rule = NormalizationRule.__new__(NormalizationRule)
+ rule.match_pattern = r"^(?P\w+)$"
+ rule.replacement = r"\g"
+ rule.scope = "device_type"
+ rule.description = ""
+ _set_fk_cache(rule, "manufacturer", None)
+
+ with patch("netbox.models.NetBoxModel.clean"):
+ rule.clean() # Should not raise
+
+ def test_normalization_rule_empty_replacement_no_backref(self):
+ """Empty replacement string is valid for a pattern with capture groups."""
+ from netbox_librenms_plugin.models import NormalizationRule
+
+ rule = NormalizationRule.__new__(NormalizationRule)
+ rule.match_pattern = r"^(\d+)$"
+ rule.replacement = ""
+ rule.scope = "device_type"
+ rule.description = ""
+ _set_fk_cache(rule, "manufacturer", None)
+
+ with patch("netbox.models.NetBoxModel.clean"):
+ rule.clean() # Should not raise
diff --git a/netbox_librenms_plugin/tests/test_sync_devices.py b/netbox_librenms_plugin/tests/test_sync_devices.py
index fb2e21228a..154b4158c0 100644
--- a/netbox_librenms_plugin/tests/test_sync_devices.py
+++ b/netbox_librenms_plugin/tests/test_sync_devices.py
@@ -121,8 +121,7 @@ class TestUpdateDeviceLocationView:
"""UpdateDeviceLocationView.post calls update_device_field with site name."""
def test_calls_update_device_field_with_site(self):
- """
- post() resolves the NetBox site name and passes the exact API payload
+ """post() resolves the NetBox site name and passes the exact API payload
expected by LibreNMS's PATCH /api/v0/devices/{id}/field endpoint:
``{"field": ["location", "override_sysLocation"], "data": [name, "1"]}``.
"""
@@ -171,6 +170,23 @@ def test_warning_when_no_site(self):
mock_msg.warning.assert_called_once()
+class TestAddDeviceObjectResolution:
+ """Regression tests for AddDeviceToLibreNMSView.get_object()."""
+
+ def test_get_object_uses_get_object_or_404_for_virtualmachine(self):
+ from netbox_librenms_plugin.views.sync.devices import AddDeviceToLibreNMSView
+ from virtualization.models import VirtualMachine
+
+ view = object.__new__(AddDeviceToLibreNMSView)
+ vm_obj = MagicMock()
+
+ with patch("netbox_librenms_plugin.views.sync.devices.get_object_or_404", return_value=vm_obj) as mock_get_obj:
+ result = view.get_object(123, object_type="virtualmachine")
+
+ assert result is vm_obj
+ mock_get_obj.assert_called_once_with(VirtualMachine, pk=123)
+
+
class TestUpdateDeviceNameViewWiring:
def test_has_all_required_mixins(self):
from netbox_librenms_plugin.views.sync.device_fields import UpdateDeviceNameView
diff --git a/netbox_librenms_plugin/tests/test_sync_modules.py b/netbox_librenms_plugin/tests/test_sync_modules.py
new file mode 100644
index 0000000000..47aae35df9
--- /dev/null
+++ b/netbox_librenms_plugin/tests/test_sync_modules.py
@@ -0,0 +1,3301 @@
+"""
+Tests for module sync views and BaseModuleTableView bay matching logic.
+
+Covers: InstallModuleView/InstallBranchView wiring, branch collection, cycle guards,
+bay matching by name/mapping/position, serial comparison, status determination,
+and depth tracking. inventory-rebased branch only.
+"""
+
+import re
+from contextlib import contextmanager
+from unittest.mock import MagicMock, patch
+
+
+@contextmanager
+def _patch_build_row_deps(view, match_bay_return=None):
+ """Patch all utility imports used by _build_row to isolate bay/type matching tests."""
+ _utils = "netbox_librenms_plugin.utils"
+ with (
+ patch.object(view, "_match_module_bay", return_value=match_bay_return),
+ patch(f"{_utils}.resolve_module_type", side_effect=lambda m, t, **kw: t.get(m)),
+ patch(f"{_utils}.has_nested_name_conflict", return_value=False),
+ ):
+ yield
+
+
+def _make_install_branch_view():
+ from netbox_librenms_plugin.views.sync.modules import InstallBranchView
+
+ view = object.__new__(InstallBranchView)
+ view._librenms_api = None
+ return view
+
+
+class TestInstallBranchViewCollectBranch:
+ """_collect_branch correctly collects parent + children depth-first."""
+
+ def _make_inventory(self, items):
+ """Helper to build a list of inventory dicts."""
+ return items
+
+ def test_collect_parent_with_model(self):
+ view = _make_install_branch_view()
+ inventory = [
+ {"entPhysicalIndex": 1, "entPhysicalModelName": "WS-C4500X", "entPhysicalContainedIn": 0},
+ ]
+ result = view._collect_branch(1, inventory)
+ assert len(result) == 1
+ assert result[0]["entPhysicalIndex"] == 1
+
+ def test_collect_parent_without_model_excluded(self):
+ view = _make_install_branch_view()
+ inventory = [
+ {"entPhysicalIndex": 1, "entPhysicalModelName": "", "entPhysicalContainedIn": 0},
+ ]
+ result = view._collect_branch(1, inventory)
+ assert result == []
+
+ def test_collect_children_included_with_models(self):
+ view = _make_install_branch_view()
+ inventory = [
+ {"entPhysicalIndex": 1, "entPhysicalModelName": "PARENT", "entPhysicalContainedIn": 0},
+ {"entPhysicalIndex": 2, "entPhysicalModelName": "CHILD-A", "entPhysicalContainedIn": 1},
+ {"entPhysicalIndex": 3, "entPhysicalModelName": "CHILD-B", "entPhysicalContainedIn": 1},
+ ]
+ result = view._collect_branch(1, inventory)
+ indices = [item["entPhysicalIndex"] for item in result]
+ assert 1 in indices
+ assert 2 in indices
+ assert 3 in indices
+
+ def test_parent_comes_before_children(self):
+ view = _make_install_branch_view()
+ inventory = [
+ {"entPhysicalIndex": 1, "entPhysicalModelName": "PARENT", "entPhysicalContainedIn": 0},
+ {"entPhysicalIndex": 2, "entPhysicalModelName": "CHILD", "entPhysicalContainedIn": 1},
+ ]
+ result = view._collect_branch(1, inventory)
+ indices = [item["entPhysicalIndex"] for item in result]
+ assert indices.index(1) < indices.index(2)
+
+ def test_deep_nesting_collected(self):
+ view = _make_install_branch_view()
+ inventory = [
+ {"entPhysicalIndex": 1, "entPhysicalModelName": "ROOT", "entPhysicalContainedIn": 0},
+ {"entPhysicalIndex": 2, "entPhysicalModelName": "MID", "entPhysicalContainedIn": 1},
+ {"entPhysicalIndex": 3, "entPhysicalModelName": "LEAF", "entPhysicalContainedIn": 2},
+ ]
+ result = view._collect_branch(1, inventory)
+ assert len(result) == 3
+
+ def test_unknown_parent_returns_empty(self):
+ view = _make_install_branch_view()
+ inventory = [
+ {"entPhysicalIndex": 1, "entPhysicalModelName": "ITEM", "entPhysicalContainedIn": 0},
+ ]
+ result = view._collect_branch(999, inventory)
+ assert result == []
+
+
+class TestInstallBranchViewCollectChildrenCycleGuard:
+ """_collect_children must not loop on cyclic entPhysicalContainedIn links."""
+
+ def test_cycle_does_not_cause_infinite_recursion(self):
+ view = _make_install_branch_view()
+ # A β B cycle (A contains B, B contains A)
+ inventory = [
+ {"entPhysicalIndex": 1, "entPhysicalModelName": "A", "entPhysicalContainedIn": 2},
+ {"entPhysicalIndex": 2, "entPhysicalModelName": "B", "entPhysicalContainedIn": 1},
+ ]
+ items = []
+ # Should terminate without RecursionError
+ view._collect_children(1, inventory, items, visited={1})
+
+ def test_self_reference_does_not_loop(self):
+ view = _make_install_branch_view()
+ inventory = [
+ {"entPhysicalIndex": 5, "entPhysicalModelName": "SELF", "entPhysicalContainedIn": 5},
+ ]
+ items = []
+ view._collect_children(5, inventory, items, visited={5})
+ # No infinite recursion β length may be 0 (self is excluded by visited)
+ assert len(items) == 0
+
+
+class TestGetModuleTypesIndexed:
+ """get_module_types_indexed builds a dict keyed by model name, part number, and mappings."""
+
+ def test_indexes_by_model_and_part_number(self):
+ from netbox_librenms_plugin.utils import get_module_types_indexed
+
+ mt1 = MagicMock()
+ mt1.model = "WS-X4748"
+ mt1.part_number = "ALT-PART-4748"
+
+ mt2 = MagicMock()
+ mt2.model = "WS-X4516"
+ mt2.part_number = "WS-X4516" # same as model β no extra key
+
+ mock_mapping = MagicMock()
+ mock_mapping.librenms_model = "libre-model-a"
+ mock_mapping.netbox_module_type = mt1
+ mock_mapping.manufacturer_id = None
+
+ mock_mt_cls = MagicMock()
+ mock_mt_cls.objects.all.return_value.select_related.return_value.prefetch_related.return_value = [mt1, mt2]
+
+ mock_map_cls = MagicMock()
+ mock_map_cls.objects.select_related.return_value.prefetch_related.return_value = [mock_mapping]
+
+ with patch.dict(
+ "sys.modules",
+ {
+ "dcim.models": type("m", (), {"ModuleType": mock_mt_cls})(),
+ },
+ ):
+ with patch("netbox_librenms_plugin.models.ModuleTypeMapping", mock_map_cls):
+ result = get_module_types_indexed()
+
+ assert result["WS-X4748"] is mt1
+ assert result["ALT-PART-4748"] is mt1
+ assert result["WS-X4516"] is mt2
+ assert result["libre-model-a"] is mt1
+
+ def test_mapping_overrides_ambiguous_base_key(self):
+ """A unique ModuleTypeMapping entry overrides a base key that became ambiguous."""
+ from netbox_librenms_plugin.utils import get_module_types_indexed
+
+ # Two ModuleTypes share the same model name β base key becomes ambiguous
+ mt1 = MagicMock()
+ mt1.model = "SFP-1G-LX"
+ mt1.part_number = ""
+
+ mt2 = MagicMock()
+ mt2.model = "SFP-1G-LX" # same β ambiguous in base pass
+ mt2.part_number = ""
+
+ # Explicit mapping for a distinct key β should be present despite base ambiguity
+ mock_mapping = MagicMock()
+ mock_mapping.librenms_model = "SFP-1G-LX-EXPLICIT"
+ mock_mapping.netbox_module_type = mt1
+ mock_mapping.manufacturer_id = None
+
+ mock_mt_cls = MagicMock()
+ mock_mt_cls.objects.all.return_value.select_related.return_value.prefetch_related.return_value = [mt1, mt2]
+
+ mock_map_cls = MagicMock()
+ mock_map_cls.objects.select_related.return_value.prefetch_related.return_value = [mock_mapping]
+
+ with patch.dict(
+ "sys.modules",
+ {
+ "dcim.models": type("m", (), {"ModuleType": mock_mt_cls})(),
+ },
+ ):
+ with patch("netbox_librenms_plugin.models.ModuleTypeMapping", mock_map_cls):
+ result = get_module_types_indexed()
+
+ # Base key was ambiguous and must be absent; explicit mapping key must be present
+ assert "SFP-1G-LX" not in result
+ assert result["SFP-1G-LX-EXPLICIT"] is mt1
+
+ def test_manufacturer_scoped_mapping_kept_separate_from_base_index(self):
+ """A manufacturer-scoped ModuleTypeMapping must not pollute the global key space."""
+ from netbox_librenms_plugin.utils import get_module_types_indexed
+
+ mt_juniper = MagicMock()
+ mt_juniper.model = "QSFP-100G-LR4-JUNIPER"
+ mt_juniper.part_number = ""
+
+ mock_mapping = MagicMock()
+ mock_mapping.librenms_model = "1F3QAA"
+ mock_mapping.netbox_module_type = mt_juniper
+ mock_mapping.manufacturer_id = 42 # scoped β must NOT enter the global dict
+
+ mock_mt_cls = MagicMock()
+ mock_mt_cls.objects.all.return_value.select_related.return_value.prefetch_related.return_value = [mt_juniper]
+
+ mock_map_cls = MagicMock()
+ mock_map_cls.objects.select_related.return_value.prefetch_related.return_value = [mock_mapping]
+
+ with patch.dict("sys.modules", {"dcim.models": type("m", (), {"ModuleType": mock_mt_cls})()}):
+ with patch("netbox_librenms_plugin.models.ModuleTypeMapping", mock_map_cls):
+ result = get_module_types_indexed()
+
+ # The vendor-scoped librenms_model must NOT leak into the global lookup
+ assert "1F3QAA" not in result
+ # β¦but it must be reachable via the per-manufacturer side index
+ assert result.mfr_mappings[(42, "1F3QAA")] is mt_juniper
+
+
+class TestResolveModuleTypeManufacturerScope:
+ """resolve_module_type must prefer manufacturer-scoped mappings when available."""
+
+ def _index(self, base=None, mfr=None):
+ from netbox_librenms_plugin.utils import _ModuleTypeIndex
+
+ return _ModuleTypeIndex(base or {}, mfr_mappings=mfr or {})
+
+ def test_manufacturer_scoped_wins_over_global(self):
+ from netbox_librenms_plugin.utils import resolve_module_type
+
+ global_mt = MagicMock(name="global_mt")
+ scoped_mt = MagicMock(name="scoped_mt")
+ idx = self._index(base={"X": global_mt}, mfr={(7, "X"): scoped_mt})
+ manufacturer = MagicMock(pk=7)
+
+ assert resolve_module_type("X", idx, manufacturer=manufacturer) is scoped_mt
+
+ def test_falls_back_to_global_when_no_scoped_match(self):
+ from netbox_librenms_plugin.utils import resolve_module_type
+
+ global_mt = MagicMock(name="global_mt")
+ idx = self._index(base={"X": global_mt}, mfr={(7, "OTHER"): MagicMock()})
+ manufacturer = MagicMock(pk=7)
+
+ assert resolve_module_type("X", idx, manufacturer=manufacturer) is global_mt
+
+ def test_other_vendor_does_not_see_scoped_mapping(self):
+ from netbox_librenms_plugin.utils import resolve_module_type
+
+ scoped_mt = MagicMock(name="scoped_mt")
+ idx = self._index(base={}, mfr={(7, "X"): scoped_mt})
+ other_mfr = MagicMock(pk=99)
+
+ with patch("netbox_librenms_plugin.utils.apply_normalization_rules", side_effect=lambda v, *a, **k: v):
+ assert resolve_module_type("X", idx, manufacturer=other_mfr) is None
+
+ def test_no_manufacturer_falls_back_to_global_only(self):
+ from netbox_librenms_plugin.utils import resolve_module_type
+
+ scoped_mt = MagicMock(name="scoped_mt")
+ idx = self._index(base={}, mfr={(7, "X"): scoped_mt})
+
+ with patch("netbox_librenms_plugin.utils.apply_normalization_rules", side_effect=lambda v, *a, **k: v):
+ assert resolve_module_type("X", idx, manufacturer=None) is None
+
+
+class TestInstallModuleViewWiring:
+ """InstallModuleView must have correct mixins and attributes."""
+
+ def test_has_librenms_permission_mixin(self):
+ from netbox_librenms_plugin.views.sync.modules import InstallModuleView
+ from netbox_librenms_plugin.views.mixins import LibreNMSPermissionMixin
+
+ assert LibreNMSPermissionMixin in InstallModuleView.__mro__
+
+ def test_has_netbox_object_permission_mixin(self):
+ from netbox_librenms_plugin.views.sync.modules import InstallModuleView
+ from netbox_librenms_plugin.views.mixins import NetBoxObjectPermissionMixin
+
+ assert NetBoxObjectPermissionMixin in InstallModuleView.__mro__
+
+ def test_install_module_view_not_in_base(self):
+ """InstallModuleView is importable from the public sync module, not views/base."""
+ from netbox_librenms_plugin.views.sync.modules import InstallModuleView
+
+ assert callable(InstallModuleView), "InstallModuleView must be a callable class"
+ assert InstallModuleView.__module__ == "netbox_librenms_plugin.views.sync.modules", (
+ "InstallModuleView must be defined in views/sync/modules.py, not views/base/"
+ )
+
+
+class TestInstallBranchViewWiring:
+ """InstallBranchView must have CacheMixin for cache key generation."""
+
+ def test_has_cache_mixin(self):
+ from netbox_librenms_plugin.views.sync.modules import InstallBranchView
+ from netbox_librenms_plugin.views.mixins import CacheMixin
+
+ assert CacheMixin in InstallBranchView.__mro__
+
+ def test_has_netbox_object_permission_mixin(self):
+ from netbox_librenms_plugin.views.sync.modules import InstallBranchView
+ from netbox_librenms_plugin.views.mixins import NetBoxObjectPermissionMixin
+
+ assert NetBoxObjectPermissionMixin in InstallBranchView.__mro__
+
+
+# ---------------------------------------------------------------------------
+# Helper: build a BaseModuleTableView instance without __init__
+# ---------------------------------------------------------------------------
+
+
+def _make_base_view():
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ view = object.__new__(BaseModuleTableView)
+ view._device_manufacturer = None
+ return view
+
+
+_bay_counter = 0
+
+
+def _bay(name, installed_module=None, pk=None):
+ """Quick MagicMock module bay."""
+ global _bay_counter
+ _bay_counter += 1
+ bay = MagicMock()
+ bay.name = name
+ bay.pk = pk or _bay_counter
+ bay.installed_module = installed_module
+ bay.get_absolute_url.return_value = f"/dcim/module-bays/{bay.pk}/"
+ return bay
+
+
+def _module(serial="SN001", module_type_id=1):
+ mod = MagicMock()
+ mod.serial = serial
+ mod.module_type_id = module_type_id
+ mod.get_absolute_url.return_value = "/dcim/modules/1/"
+ return mod
+
+
+# ---------------------------------------------------------------------------
+# _determine_status
+# ---------------------------------------------------------------------------
+
+
+# ---------------------------------------------------------------------------
+# Serial comparison inside _build_row
+# ---------------------------------------------------------------------------
+
+
+class TestBuildRowSerialComparison:
+ """_build_row sets 'Installed' or 'Serial Mismatch' based on installed module serial."""
+
+ def _make_item(self, model_name, serial):
+ return {
+ "entPhysicalModelName": model_name,
+ "entPhysicalSerialNum": serial,
+ "entPhysicalName": model_name,
+ "entPhysicalDescr": "",
+ "entPhysicalClass": "module",
+ "entPhysicalIndex": 10,
+ "entPhysicalContainedIn": 0,
+ }
+
+ def _make_matched_type(self, model="WS-X4748"):
+ mt = MagicMock()
+ mt.model = model
+ mt.pk = 1
+ mt.get_absolute_url.return_value = "/dcim/module-types/1/"
+ # Make uses-module-path/token checks return False so badges don't appear
+ mt.interfacetemplates = MagicMock()
+ mt.interfacetemplates.all.return_value = []
+ return mt
+
+ def test_matching_serial_gives_installed_status(self):
+ view = _make_base_view()
+ item = self._make_item("WS-X4748", "SN-ABC-123")
+ mt = self._make_matched_type()
+ installed = _module(serial="SN-ABC-123")
+ bay = _bay("Slot 1", installed_module=installed)
+
+ with _patch_build_row_deps(view, match_bay_return=bay):
+ row = view._build_row(item, {10: item}, {"Slot 1": bay}, {"WS-X4748": mt}, depth=0)
+
+ assert row["status"] == "Installed"
+ assert "row_class" not in row
+
+ def test_serial_mismatch_gives_danger_status(self):
+ view = _make_base_view()
+ item = self._make_item("WS-X4748", "SN-NEW-999")
+ mt = self._make_matched_type()
+ installed = _module(serial="SN-OLD-111")
+ bay = _bay("Slot 1", installed_module=installed)
+
+ with _patch_build_row_deps(view, match_bay_return=bay):
+ row = view._build_row(item, {10: item}, {"Slot 1": bay}, {"WS-X4748": mt}, depth=0)
+
+ assert row["status"] == "Serial Mismatch"
+ assert "row_class" not in row
+
+ def test_no_bay_gives_no_bay_status(self):
+ view = _make_base_view()
+ item = self._make_item("WS-X4748", "SN1")
+ mt = self._make_matched_type()
+
+ with _patch_build_row_deps(view, match_bay_return=None):
+ row = view._build_row(item, {10: item}, {}, {"WS-X4748": mt}, depth=0)
+
+ assert row["status"] == "No Bay"
+
+ def test_no_type_gives_no_type_status(self):
+ view = _make_base_view()
+ item = self._make_item("UNKNOWN-MODEL", "SN1")
+ bay = _bay("Slot 1")
+
+ with _patch_build_row_deps(view, match_bay_return=bay):
+ row = view._build_row(item, {10: item}, {"Slot 1": bay}, {}, depth=0)
+
+ assert row["status"] == "No Type"
+
+ def test_can_install_set_when_bay_free_and_type_matched(self):
+ """can_install=True only when bay exists, type matched, and bay is empty."""
+ view = _make_base_view()
+ item = self._make_item("WS-X4748", "SN1")
+ mt = self._make_matched_type()
+ bay = _bay("Slot 1", installed_module=None)
+ bay.installed_module = None
+
+ with _patch_build_row_deps(view, match_bay_return=bay):
+ row = view._build_row(item, {10: item}, {"Slot 1": bay}, {"WS-X4748": mt}, depth=0)
+
+ assert row["can_install"] is True
+
+ def test_can_install_false_when_bay_occupied(self):
+ view = _make_base_view()
+ item = self._make_item("WS-X4748", "SN1")
+ mt = self._make_matched_type()
+ installed = _module(serial="SN1")
+ bay = _bay("Slot 1", installed_module=installed)
+
+ with _patch_build_row_deps(view, match_bay_return=bay):
+ row = view._build_row(item, {10: item}, {"Slot 1": bay}, {"WS-X4748": mt}, depth=0)
+
+ assert row["can_install"] is False
+
+ def test_librenms_dash_serial_with_empty_installed_gives_installed(self):
+ """LibreNMS serial '-' normalizes to empty; both empty -> Installed, not mismatch."""
+ view = _make_base_view()
+ item = self._make_item("WS-X4748", "-")
+ mt = self._make_matched_type()
+ installed = _module(serial="")
+ bay = _bay("Slot 1", installed_module=installed)
+
+ with _patch_build_row_deps(view, match_bay_return=bay):
+ row = view._build_row(item, {10: item}, {"Slot 1": bay}, {"WS-X4748": mt}, depth=0)
+
+ assert row["status"] == "Installed"
+ assert "row_class" not in row
+
+ def test_librenms_dash_serial_with_real_installed_gives_installed(self):
+ """LibreNMS serial '-' normalizes to empty; only NetBox has serial -> no mismatch."""
+ view = _make_base_view()
+ item = self._make_item("WS-X4748", "-")
+ mt = self._make_matched_type()
+ installed = _module(serial="REAL123")
+ bay = _bay("Slot 1", installed_module=installed)
+
+ with _patch_build_row_deps(view, match_bay_return=bay):
+ row = view._build_row(item, {10: item}, {"Slot 1": bay}, {"WS-X4748": mt}, depth=0)
+
+ assert row["status"] == "Installed"
+ assert "row_class" not in row
+
+
+# ---------------------------------------------------------------------------
+# Depth tracking in render_name
+# ---------------------------------------------------------------------------
+
+
+class TestRenderNameDepth:
+ """render_name applies tree indentation based on depth."""
+
+ def test_depth_zero_returns_plain_value(self):
+ from netbox_librenms_plugin.tables.modules import LibreNMSModuleTable
+
+ table = LibreNMSModuleTable([])
+ result = table.render_name("Supervisor", {"depth": 0})
+ assert "padding-left" not in str(result)
+ assert "Supervisor" in str(result)
+
+ def test_depth_one_adds_padding(self):
+ from netbox_librenms_plugin.tables.modules import LibreNMSModuleTable
+
+ table = LibreNMSModuleTable([])
+ result = str(table.render_name("Line Card", {"depth": 1}))
+ assert "padding-left" in result
+ assert "20px" in result
+
+ def test_depth_two_doubles_padding(self):
+ from netbox_librenms_plugin.tables.modules import LibreNMSModuleTable
+
+ table = LibreNMSModuleTable([])
+ result = str(table.render_name("SFP", {"depth": 2}))
+ assert "40px" in result
+
+ def test_depth_renders_tree_prefix(self):
+ from netbox_librenms_plugin.tables.modules import LibreNMSModuleTable
+
+ table = LibreNMSModuleTable([])
+ result = str(table.render_name("Port 1", {"depth": 1}))
+ assert "ββ" in result
+
+
+# ---------------------------------------------------------------------------
+# _match_bay_by_position
+# ---------------------------------------------------------------------------
+
+
+class TestMatchBayByPosition:
+ """_match_bay_by_position resolves position-based bay names for SFPs in converters."""
+
+ def test_matches_sfp_slot_by_sibling_order(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ # Build an inventory: parent (model) β container1 β item1, container2 β item2
+ parent_item = {
+ "entPhysicalIndex": 1,
+ "entPhysicalModelName": "CONVERTER",
+ "entPhysicalClass": "module",
+ "entPhysicalContainedIn": 0,
+ "entPhysicalParentRelPos": 0,
+ }
+ container1 = {
+ "entPhysicalIndex": 2,
+ "entPhysicalModelName": "",
+ "entPhysicalClass": "container",
+ "entPhysicalContainedIn": 1,
+ "entPhysicalParentRelPos": 1,
+ }
+ container2 = {
+ "entPhysicalIndex": 3,
+ "entPhysicalModelName": "",
+ "entPhysicalClass": "container",
+ "entPhysicalContainedIn": 1,
+ "entPhysicalParentRelPos": 2,
+ }
+ sfp1 = {
+ "entPhysicalIndex": 4,
+ "entPhysicalModelName": "SFP-10G-LR",
+ "entPhysicalClass": "module",
+ "entPhysicalContainedIn": 2,
+ "entPhysicalParentRelPos": 1,
+ }
+ sfp2 = {
+ "entPhysicalIndex": 5,
+ "entPhysicalModelName": "SFP-10G-SR",
+ "entPhysicalClass": "module",
+ "entPhysicalContainedIn": 3,
+ "entPhysicalParentRelPos": 1,
+ }
+
+ index_map = {1: parent_item, 2: container1, 3: container2, 4: sfp1, 5: sfp2}
+ bays = {"SFP 1": _bay("SFP 1"), "SFP 2": _bay("SFP 2")}
+
+ result1 = BaseModuleTableView._match_bay_by_position(sfp1, index_map, bays)
+ result2 = BaseModuleTableView._match_bay_by_position(sfp2, index_map, bays)
+
+ assert result1 is bays["SFP 1"]
+ assert result2 is bays["SFP 2"]
+
+ def test_returns_none_when_no_modelless_container(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ # Item directly under parent with model (no modelless container)
+ parent = {"entPhysicalIndex": 1, "entPhysicalModelName": "PARENT", "entPhysicalContainedIn": 0}
+ item = {"entPhysicalIndex": 2, "entPhysicalModelName": "CHILD", "entPhysicalContainedIn": 1}
+ index_map = {1: parent, 2: item}
+ bays = {"Slot 1": _bay("Slot 1")}
+
+ result = BaseModuleTableView._match_bay_by_position(item, index_map, bays)
+ assert result is None
+
+ def test_returns_none_when_no_bays_match_pattern(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ parent = {
+ "entPhysicalIndex": 1,
+ "entPhysicalModelName": "M",
+ "entPhysicalClass": "module",
+ "entPhysicalContainedIn": 0,
+ "entPhysicalParentRelPos": 0,
+ }
+ container = {
+ "entPhysicalIndex": 2,
+ "entPhysicalModelName": "",
+ "entPhysicalClass": "container",
+ "entPhysicalContainedIn": 1,
+ "entPhysicalParentRelPos": 1,
+ }
+ item = {
+ "entPhysicalIndex": 3,
+ "entPhysicalModelName": "X",
+ "entPhysicalClass": "module",
+ "entPhysicalContainedIn": 2,
+ "entPhysicalParentRelPos": 1,
+ }
+ index_map = {1: parent, 2: container, 3: item}
+ bays = {"InterfaceA": _bay("InterfaceA")} # no "SFP 1"/"Slot 1"/etc.
+
+ result = BaseModuleTableView._match_bay_by_position(item, index_map, bays)
+ assert result is None
+
+
+# ---------------------------------------------------------------------------
+# _match_module_bay β exact name fallback
+# ---------------------------------------------------------------------------
+
+
+class TestMatchModuleBayExactFallback:
+ """When no ModuleBayMapping exists, exact parent/item/descr name is tried."""
+
+ def test_exact_parent_name_match(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ view = _make_base_view()
+ parent = {
+ "entPhysicalIndex": 1,
+ "entPhysicalModelName": "PARENT",
+ "entPhysicalContainedIn": 0,
+ "entPhysicalName": "Slot 1",
+ }
+ item = {
+ "entPhysicalIndex": 2,
+ "entPhysicalName": "Linecard A",
+ "entPhysicalDescr": "",
+ "entPhysicalClass": "module",
+ "entPhysicalContainedIn": 1,
+ }
+ index_map = {1: parent, 2: item}
+ bay = _bay("Slot 1")
+ bays = {"Slot 1": bay}
+
+ with patch(
+ "netbox_librenms_plugin.utils.apply_normalization_rules", side_effect=lambda name, scope, **kw: name
+ ):
+ with patch("netbox_librenms_plugin.models.ModuleBayMapping") as mock_mbm:
+ mock_mbm.objects.filter.return_value.first.return_value = None
+
+ # Also patch _lookup_regex_bay_mapping to return None
+ with patch.object(BaseModuleTableView, "_lookup_regex_bay_mapping", return_value=None):
+ with patch.object(BaseModuleTableView, "_match_bay_by_position", return_value=None):
+ result = view._match_module_bay(item, index_map, bays)
+
+ assert result is bay
+
+ def test_item_name_used_when_no_parent_name(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ view = _make_base_view()
+ item = {
+ "entPhysicalIndex": 1,
+ "entPhysicalName": "Module Bay 3",
+ "entPhysicalDescr": "",
+ "entPhysicalClass": "module",
+ "entPhysicalContainedIn": 0,
+ }
+ index_map = {1: item}
+ bay = _bay("Module Bay 3")
+ bays = {"Module Bay 3": bay}
+
+ with patch(
+ "netbox_librenms_plugin.utils.apply_normalization_rules", side_effect=lambda name, scope, **kw: name
+ ):
+ with patch("netbox_librenms_plugin.models.ModuleBayMapping") as mock_mbm:
+ mock_mbm.objects.filter.return_value.first.return_value = None
+ with patch.object(BaseModuleTableView, "_lookup_regex_bay_mapping", return_value=None):
+ with patch.object(BaseModuleTableView, "_match_bay_by_position", return_value=None):
+ result = view._match_module_bay(item, index_map, bays)
+
+ assert result is bay
+
+ def test_returns_none_when_no_match(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ view = _make_base_view()
+ item = {
+ "entPhysicalIndex": 1,
+ "entPhysicalName": "Unknown-X",
+ "entPhysicalDescr": "",
+ "entPhysicalClass": "module",
+ "entPhysicalContainedIn": 0,
+ }
+ index_map = {1: item}
+ bays = {"Slot 1": _bay("Slot 1")}
+
+ with patch(
+ "netbox_librenms_plugin.utils.apply_normalization_rules", side_effect=lambda name, scope, **kw: name
+ ):
+ with patch("netbox_librenms_plugin.models.ModuleBayMapping") as mock_mbm:
+ mock_mbm.objects.filter.return_value.first.return_value = None
+ with patch.object(BaseModuleTableView, "_lookup_regex_bay_mapping", return_value=None):
+ with patch.object(BaseModuleTableView, "_match_bay_by_position", return_value=None):
+ result = view._match_module_bay(item, index_map, bays)
+
+ assert result is None
+
+
+# ---------------------------------------------------------------------------
+# _install_single β status codes
+# ---------------------------------------------------------------------------
+
+
+class TestInstallSingleStatus:
+ """_install_single returns the correct status dict in each path."""
+
+ def _make_args(self):
+ """Return (device, item, index_map, module_types, ModuleBay, ModuleType, Module)."""
+ device = MagicMock()
+ device.device_type.manufacturer = None
+
+ item = {
+ "entPhysicalIndex": 10,
+ "entPhysicalModelName": "WS-X4748",
+ "entPhysicalSerialNum": "SN123",
+ "entPhysicalName": "Line Card",
+ "entPhysicalContainedIn": 0,
+ }
+
+ mt = MagicMock()
+ mt.model = "WS-X4748"
+ mt.pk = 1
+
+ bay = _bay("Slot 1")
+ bay.installed_module = None
+
+ index_map = {10: item}
+ module_types = {"WS-X4748": mt}
+
+ ModuleBay = MagicMock()
+ ModuleBay.objects.filter.return_value.select_related.return_value = [bay]
+ # Support select_for_update chain used in _install_single
+ locked_bay = _bay("Slot 1")
+ locked_bay.installed_module = None
+ locked_bay.pk = bay.pk
+ ModuleBay.objects.select_for_update.return_value.select_related.return_value.get.return_value = locked_bay
+ ModuleType = MagicMock()
+ Module = MagicMock()
+
+ return device, item, index_map, module_types, ModuleBay, ModuleType, Module, bay, mt
+
+ def test_returns_installed_on_success(self):
+ from contextlib import contextmanager
+
+ from netbox_librenms_plugin.views.sync.modules import InstallBranchView
+
+ view = _make_install_branch_view()
+ device, item, index_map, module_types, ModuleBay, ModuleType, Module, bay, mt = self._make_args()
+ module_instance = MagicMock()
+ Module.return_value = module_instance
+
+ @contextmanager
+ def noop_atomic():
+ yield
+
+ with patch("netbox_librenms_plugin.views.sync.modules.transaction.atomic", noop_atomic):
+ with patch("netbox_librenms_plugin.utils.resolve_module_type", side_effect=lambda m, t, **kw: t.get(m)):
+ with patch("netbox_librenms_plugin.utils.load_bay_mappings", return_value=([], [])):
+ with patch.object(InstallBranchView, "_find_parent_module_id", return_value=None):
+ with patch.object(InstallBranchView, "_match_bay", return_value=bay):
+ result = view._install_single(
+ device, item, index_map, module_types, ModuleBay, ModuleType, Module
+ )
+
+ assert result["status"] == "installed"
+ assert "WS-X4748" in result["name"]
+
+ def test_returns_skipped_when_no_type(self):
+ view = _make_install_branch_view()
+ device, item, index_map, module_types, ModuleBay, ModuleType, Module, bay, mt = self._make_args()
+
+ with patch("netbox_librenms_plugin.utils.resolve_module_type", return_value=None):
+ result = view._install_single(
+ device,
+ item,
+ index_map,
+ {}, # empty module_types β no match
+ ModuleBay,
+ ModuleType,
+ Module,
+ )
+
+ assert result["status"] == "skipped"
+ assert "no matching type" in result["reason"]
+
+ def test_returns_skipped_when_no_bay(self):
+ from netbox_librenms_plugin.views.sync.modules import InstallBranchView
+
+ view = _make_install_branch_view()
+ device, item, index_map, module_types, ModuleBay, ModuleType, Module, bay, mt = self._make_args()
+
+ with patch("netbox_librenms_plugin.utils.resolve_module_type", side_effect=lambda m, t, **kw: t.get(m)):
+ with patch("netbox_librenms_plugin.utils.load_bay_mappings", return_value=([], [])):
+ with patch.object(InstallBranchView, "_find_parent_module_id", return_value=None):
+ with patch.object(InstallBranchView, "_match_bay", return_value=None):
+ result = view._install_single(
+ device, item, index_map, module_types, ModuleBay, ModuleType, Module
+ )
+
+ assert result["status"] == "skipped"
+ assert "no matching bay" in result["reason"]
+
+ def test_returns_skipped_when_bay_already_occupied(self):
+ from contextlib import contextmanager
+
+ from netbox_librenms_plugin.views.sync.modules import InstallBranchView
+
+ view = _make_install_branch_view()
+ device, item, index_map, module_types, ModuleBay, ModuleType, Module, bay, mt = self._make_args()
+ occupied_module = _module()
+ bay.installed_module = occupied_module
+ # Update the locked bay to also appear occupied
+ locked_bay = MagicMock()
+ locked_bay.installed_module = occupied_module
+ locked_bay.pk = bay.pk
+ ModuleBay.objects.select_for_update.return_value.select_related.return_value.get.return_value = locked_bay
+
+ @contextmanager
+ def noop_atomic():
+ yield
+
+ with patch("netbox_librenms_plugin.views.sync.modules.transaction.atomic", noop_atomic):
+ with patch("netbox_librenms_plugin.utils.resolve_module_type", side_effect=lambda m, t, **kw: t.get(m)):
+ with patch("netbox_librenms_plugin.utils.load_bay_mappings", return_value=([], [])):
+ with patch.object(InstallBranchView, "_find_parent_module_id", return_value=None):
+ with patch.object(InstallBranchView, "_match_bay", return_value=bay):
+ result = view._install_single(
+ device, item, index_map, module_types, ModuleBay, ModuleType, Module
+ )
+
+ assert result["status"] == "skipped"
+ assert "already occupied" in result["reason"]
+
+ def test_returns_failed_on_exception(self):
+ from contextlib import contextmanager
+
+ from django.db import IntegrityError
+
+ from netbox_librenms_plugin.views.sync.modules import InstallBranchView
+
+ view = _make_install_branch_view()
+ device, item, index_map, module_types, ModuleBay, ModuleType, Module, bay, mt = self._make_args()
+ Module.side_effect = IntegrityError("DB error")
+
+ @contextmanager
+ def noop_atomic():
+ yield
+
+ with patch("netbox_librenms_plugin.views.sync.modules.transaction.atomic", noop_atomic):
+ with patch("netbox_librenms_plugin.utils.resolve_module_type", side_effect=lambda m, t, **kw: t.get(m)):
+ with patch("netbox_librenms_plugin.utils.load_bay_mappings", return_value=([], [])):
+ with patch.object(InstallBranchView, "_find_parent_module_id", return_value=None):
+ with patch.object(InstallBranchView, "_match_bay", return_value=bay):
+ result = view._install_single(
+ device, item, index_map, module_types, ModuleBay, ModuleType, Module
+ )
+
+ assert result["status"] == "failed"
+
+ def test_dash_serial_normalized_to_empty_on_install(self):
+ """When LibreNMS reports serial '-', _install_single normalizes it to '' before Module()."""
+ from contextlib import contextmanager
+
+ from netbox_librenms_plugin.views.sync.modules import InstallBranchView
+
+ view = _make_install_branch_view()
+ device, item, index_map, module_types, ModuleBay, ModuleType, Module, bay, mt = self._make_args()
+ # Override the serial to "-"
+ item["entPhysicalSerialNum"] = "-"
+ module_instance = MagicMock()
+ Module.return_value = module_instance
+
+ @contextmanager
+ def noop_atomic():
+ yield
+
+ with patch("netbox_librenms_plugin.views.sync.modules.transaction.atomic", noop_atomic):
+ with patch("netbox_librenms_plugin.utils.resolve_module_type", side_effect=lambda m, t, **kw: t.get(m)):
+ with patch("netbox_librenms_plugin.utils.load_bay_mappings", return_value=([], [])):
+ with patch.object(InstallBranchView, "_find_parent_module_id", return_value=None):
+ with patch.object(InstallBranchView, "_match_bay", return_value=bay):
+ result = view._install_single(
+ device, item, index_map, module_types, ModuleBay, ModuleType, Module
+ )
+
+ assert result["status"] == "installed"
+ # Verify Module was constructed with serial="" (not "-")
+ Module.assert_called_once()
+ assert Module.call_args.kwargs["serial"] == "", (
+ f"Expected serial='' but Module was called with serial={Module.call_args.kwargs['serial']!r}"
+ )
+
+
+# ---------------------------------------------------------------------------
+# Regression: ToggleColumn accessor for per-row checkboxes
+# ---------------------------------------------------------------------------
+
+
+class TestToggleColumnAccessor:
+ """ToggleColumn must have accessor='ent_physical_index' so per-row checkboxes render."""
+
+ def test_selection_column_has_correct_accessor(self):
+ """Regression: without accessor='ent_physical_index' checkboxes are empty."""
+ from netbox_librenms_plugin.tables.modules import LibreNMSModuleTable
+
+ col = LibreNMSModuleTable.base_columns["selection"]
+ assert col.accessor == "ent_physical_index", (
+ "ToggleColumn must use accessor='ent_physical_index'; "
+ "otherwise the column value resolves to '' and render() is never called"
+ )
+
+ def test_selection_column_renders_checkbox_for_record_with_index(self):
+ """Per-row checkbox renders when ent_physical_index is present in record."""
+ from netbox_librenms_plugin.tables.modules import LibreNMSModuleTable
+
+ record = {
+ "ent_physical_index": 42,
+ "name": "Slot 1",
+ "model": "WS-X4748",
+ "depth": 0,
+ }
+ table = LibreNMSModuleTable([record])
+ rows = list(table.rows)
+ assert len(rows) == 1
+ # The cell value should render a checkbox HTML input element
+ cell_val = rows[0].get_cell("selection")
+ assert "> any table_data list length
+ CHILD_IDX = 8_000_001
+
+ inventory = [
+ {
+ "entPhysicalIndex": LARGE_IDX,
+ "entPhysicalClass": "module",
+ "entPhysicalModelName": "BIG-MODULE",
+ "entPhysicalContainedIn": 0,
+ "entPhysicalSerialNum": "SN1",
+ "entPhysicalName": "Big Module",
+ },
+ {
+ "entPhysicalIndex": CHILD_IDX,
+ "entPhysicalClass": "port",
+ "entPhysicalModelName": "SFP-X",
+ "entPhysicalContainedIn": LARGE_IDX,
+ "entPhysicalSerialNum": "SN2",
+ "entPhysicalName": "Port 1",
+ },
+ ]
+
+ view = object.__new__(BaseModuleTableView)
+ view._device_manufacturer = None
+ view._librenms_api = MagicMock(server_key="test-server")
+
+ captured_table_data = []
+
+ def fake_build_row(
+ item,
+ index_map,
+ bays,
+ module_types,
+ depth=0,
+ manufacturer=None,
+ sibling_counts=None,
+ scope_uninstalled=False,
+ scope_preserved=False,
+ scope_empty_installed_bays=False,
+ ):
+ if item.get("entPhysicalIndex") == LARGE_IDX:
+ return {"ent_physical_index": LARGE_IDX, "can_install": False, "depth": 0}
+ # child returns can_install=True to trigger the has_installable_children path
+ return {"ent_physical_index": CHILD_IDX, "can_install": True, "depth": 1}
+
+ def fake_get_table(table_data, obj):
+ captured_table_data.extend(table_data)
+ return MagicMock()
+
+ request = MagicMock()
+ obj = MagicMock()
+ obj.device_type.manufacturer = None
+
+ with patch("netbox_librenms_plugin.models.ModuleBayMapping") as mock_mapping:
+ mock_mapping.objects.all.return_value = []
+ with patch("netbox_librenms_plugin.models.InventoryIgnoreRule") as mock_ignore:
+ mock_ignore.objects.filter.return_value.order_by.return_value = []
+ with patch("netbox_librenms_plugin.utils.preload_normalization_rules", return_value={}):
+ with patch.object(view, "_get_module_bays", return_value=({}, {})):
+ with patch.object(view, "_get_module_types", return_value={}):
+ with patch.object(view, "_get_generic_module_types", return_value={}):
+ with patch.object(view, "_get_module_type_ambiguities", return_value={}):
+ with patch.object(view, "_get_carrier_install_rules", return_value=[]):
+ with patch.object(view, "_build_row", side_effect=fake_build_row):
+ with patch.object(view, "get_table", side_effect=fake_get_table):
+ with patch.object(
+ view, "_sort_with_hierarchy", side_effect=lambda x: x
+ ):
+ with patch(
+ "netbox_librenms_plugin.views.base.modules_view.cache"
+ ) as mock_cache:
+ mock_cache.ttl = lambda k: None
+ # Old bug: IndexError when large entity index used as list index
+ view._build_context(request, obj, inventory)
+
+ assert len(captured_table_data) >= 1, "table_data must contain the parent row"
+ assert captured_table_data[0].get("has_installable_children") is True, (
+ "has_installable_children must be set on table row 0 (parent_row_idx), "
+ "not at entity index 8_000_000 which would cause IndexError"
+ )
+
+
+# ---------------------------------------------------------------------------
+# Regression: install views must NOT delete the LibreNMS inventory cache
+# ---------------------------------------------------------------------------
+
+
+class TestInstallViewsDoNotDeleteCache:
+ """
+ Install views must not call cache.delete after a successful install.
+
+ The LibreNMS inventory cache stores what LibreNMS reports (hardware list).
+ It is unaffected by NetBox module installs; _get_module_bays() is a live DB
+ query so the next render correctly shows the "Installed" state without any
+ cache invalidation. Deleting the cache after install caused an empty modules
+ tab (regression).
+
+ Each test exercises the view's success path and asserts that cache.delete
+ was never called.
+ """
+
+ def test_install_module_view_no_cache_delete(self):
+ """InstallModuleView.post success path must not call cache.delete."""
+ from contextlib import contextmanager
+
+ from dcim.models import ModuleBay
+
+ from netbox_librenms_plugin.views.sync.modules import InstallModuleView
+
+ view = object.__new__(InstallModuleView)
+ view.required_object_permissions = {}
+ device = _make_device()
+
+ module_bay = MagicMock()
+ module_bay.name = "Slot 1"
+ module_bay.installed_module = None
+
+ module_type = MagicMock()
+ module_type.pk = 5
+ module_type.model = "XCM-7s"
+
+ new_module = MagicMock()
+ request = _make_request("POST", data={"module_bay_id": "10", "module_type_id": "5", "serial": "SN1"})
+
+ @contextmanager
+ def noop_atomic():
+ yield
+
+ mock_qs = MagicMock()
+ mock_qs.get.return_value = module_bay
+
+ with (
+ patch.object(view, "require_all_permissions", return_value=None),
+ patch(
+ "netbox_librenms_plugin.views.sync.modules.get_object_or_404",
+ side_effect=[device, module_bay, module_type],
+ ),
+ patch("netbox_librenms_plugin.views.sync.modules.reverse", return_value="/sync/"),
+ patch("netbox_librenms_plugin.views.sync.modules.transaction") as mock_tx,
+ patch("netbox_librenms_plugin.views.sync.modules.messages") as mock_messages,
+ patch("netbox_librenms_plugin.views.sync.modules.redirect"),
+ patch("dcim.models.Module") as mock_module_cls,
+ patch.object(ModuleBay, "objects") as mock_objects,
+ patch("netbox_librenms_plugin.views.sync.modules.cache") as mock_cache,
+ ):
+ mock_tx.atomic = noop_atomic
+ mock_module_cls.return_value = new_module
+ mock_objects.select_for_update.return_value = mock_qs
+ view.post(request, pk=24)
+
+ mock_messages.success.assert_called_once()
+ mock_cache.delete.assert_not_called()
+
+ def test_install_branch_view_no_cache_delete(self):
+ """InstallBranchView.post success path must not call cache.delete."""
+ from netbox_librenms_plugin.views.sync.modules import InstallBranchView
+
+ view = object.__new__(InstallBranchView)
+ view.required_object_permissions = {}
+ device = _make_device()
+
+ request = _make_request("POST", data={"parent_index": "100", "server_key": "default"})
+
+ cached_inventory = [
+ {
+ "entPhysicalIndex": 100,
+ "entPhysicalClass": "module",
+ "entPhysicalModelName": "MOD-A",
+ "entPhysicalContainedIn": 0,
+ "entPhysicalName": "Slot 0",
+ },
+ ]
+
+ install_result = {"status": "installed", "name": "Slot 0"}
+
+ with (
+ patch.object(view, "require_all_permissions", return_value=None),
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", return_value=device),
+ patch("netbox_librenms_plugin.views.sync.modules.reverse", return_value="/sync/"),
+ patch("netbox_librenms_plugin.views.sync.modules.cache") as mock_cache,
+ patch.object(view, "get_cache_key", return_value="test-key"),
+ patch.object(InstallBranchView, "_collect_branch", return_value=cached_inventory),
+ patch.object(InstallBranchView, "_install_single", return_value=install_result),
+ patch("netbox_librenms_plugin.views.sync.modules.get_module_types_indexed", return_value={}),
+ patch("netbox_librenms_plugin.utils.load_bay_mappings", return_value=([], [])),
+ patch("netbox_librenms_plugin.utils.get_enabled_ignore_rules", return_value=[]),
+ patch("netbox_librenms_plugin.views.sync.modules.transaction") as mock_tx,
+ patch("netbox_librenms_plugin.views.sync.modules.messages") as mock_messages,
+ patch("netbox_librenms_plugin.views.sync.modules.redirect"),
+ ):
+ mock_cache.get.return_value = {"inventory": cached_inventory, "librenms_id": "test"}
+ mock_tx.atomic = lambda *a, **kw: MagicMock(__enter__=MagicMock(), __exit__=MagicMock(return_value=False))
+ view.post(request, pk=24)
+
+ mock_messages.success.assert_called_once()
+ mock_cache.delete.assert_not_called()
+
+ def test_install_selected_view_no_cache_delete(self):
+ """InstallSelectedView.post success path must not call cache.delete."""
+ from netbox_librenms_plugin.views.sync.modules import InstallBranchView, InstallSelectedView
+
+ view = object.__new__(InstallSelectedView)
+ view.required_object_permissions = {}
+ device = _make_device()
+
+ request = _make_request("POST", data={"server_key": "default"})
+ post_mock = MagicMock()
+ post_mock.get = MagicMock(side_effect=lambda k, d=None: {"server_key": "default"}.get(k, d))
+ post_mock.getlist = MagicMock(return_value=["100"])
+ request.POST = post_mock
+
+ cached_inventory = [
+ {
+ "entPhysicalIndex": 100,
+ "entPhysicalClass": "module",
+ "entPhysicalModelName": "MOD-A",
+ "entPhysicalContainedIn": 0,
+ "entPhysicalName": "Slot 0",
+ },
+ ]
+
+ install_result = {"status": "installed", "name": "Slot 0"}
+
+ with (
+ patch.object(view, "require_all_permissions", return_value=None),
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", return_value=device),
+ patch("netbox_librenms_plugin.views.sync.modules.reverse", return_value="/sync/"),
+ patch("netbox_librenms_plugin.views.sync.modules.cache") as mock_cache,
+ patch.object(view, "get_cache_key", return_value="test-key"),
+ patch.object(InstallBranchView, "_install_single", return_value=install_result),
+ patch("netbox_librenms_plugin.views.sync.modules.get_module_types_indexed", return_value={}),
+ patch("netbox_librenms_plugin.utils.get_enabled_ignore_rules", return_value=[]),
+ patch("netbox_librenms_plugin.utils.load_bay_mappings", return_value=([], [])),
+ patch("netbox_librenms_plugin.views.sync.modules.transaction") as mock_tx,
+ patch("netbox_librenms_plugin.views.sync.modules.messages") as mock_messages,
+ patch("netbox_librenms_plugin.views.sync.modules.redirect"),
+ ):
+ mock_cache.get.return_value = {"inventory": cached_inventory, "librenms_id": "test"}
+ mock_tx.atomic = lambda *a, **kw: MagicMock(__enter__=MagicMock(), __exit__=MagicMock(return_value=False))
+ view.post(request, pk=24)
+
+ mock_messages.success.assert_called_once()
+ mock_cache.delete.assert_not_called()
+
+
+# ---------------------------------------------------------------------------
+# _collect_children with ignore rules (Item 4)
+# ---------------------------------------------------------------------------
+
+
+def _make_rule(pattern="IDPROM", action="skip"):
+ """Create a lightweight InventoryIgnoreRule-like object for testing."""
+ from netbox_librenms_plugin.models import InventoryIgnoreRule
+
+ rule = InventoryIgnoreRule.__new__(InventoryIgnoreRule)
+ rule.match_type = "ends_with"
+ rule.pattern = pattern
+ rule.action = action
+ rule.require_serial_match_parent = False
+ rule.enabled = True
+ return rule
+
+
+class TestCollectChildrenIgnoreRules:
+ """_collect_children respects ignore rules when provided."""
+
+ def test_skip_rule_excludes_item_and_subtree(self):
+ """Child matching a 'skip' rule is excluded along with its descendants."""
+ view = _make_install_branch_view()
+ inventory = [
+ {"entPhysicalIndex": 1, "entPhysicalModelName": "PARENT", "entPhysicalContainedIn": 0},
+ {
+ "entPhysicalIndex": 2,
+ "entPhysicalModelName": "SKIP-ME",
+ "entPhysicalName": "FT-IDPROM",
+ "entPhysicalContainedIn": 1,
+ },
+ {
+ "entPhysicalIndex": 3,
+ "entPhysicalModelName": "DEEP-SKIP",
+ "entPhysicalName": "DEEP",
+ "entPhysicalContainedIn": 2,
+ },
+ {
+ "entPhysicalIndex": 4,
+ "entPhysicalModelName": "KEEP-ME",
+ "entPhysicalName": "NormalChild",
+ "entPhysicalContainedIn": 1,
+ },
+ ]
+ index_map = {i["entPhysicalIndex"]: i for i in inventory}
+ rule = _make_rule(pattern="IDPROM", action="skip")
+ items = []
+ view._collect_children(
+ 1, inventory, items, visited={1}, ignore_rules=[rule], device_serial="", index_map=index_map
+ )
+ indices = [i["entPhysicalIndex"] for i in items]
+ assert 2 not in indices # skip rule matched
+ assert 3 not in indices # descendant of skip-matched
+ assert 4 in indices # not matched
+
+ def test_transparent_rule_collects_children_not_item(self):
+ """Child matching a 'transparent' rule is excluded but its children are collected."""
+ view = _make_install_branch_view()
+ inventory = [
+ {"entPhysicalIndex": 1, "entPhysicalModelName": "PARENT", "entPhysicalContainedIn": 0},
+ {
+ "entPhysicalIndex": 2,
+ "entPhysicalModelName": "TRANSPARENT",
+ "entPhysicalName": "T-IDPROM",
+ "entPhysicalContainedIn": 1,
+ },
+ {
+ "entPhysicalIndex": 3,
+ "entPhysicalModelName": "GRANDCHILD",
+ "entPhysicalName": "GrandChild",
+ "entPhysicalContainedIn": 2,
+ },
+ ]
+ index_map = {i["entPhysicalIndex"]: i for i in inventory}
+ rule = _make_rule(pattern="IDPROM", action="transparent")
+ items = []
+ view._collect_children(
+ 1, inventory, items, visited={1}, ignore_rules=[rule], device_serial="", index_map=index_map
+ )
+ indices = [i["entPhysicalIndex"] for i in items]
+ assert 2 not in indices # transparent item excluded
+ assert 3 in indices # grandchild promoted
+
+ def test_no_ignore_rules_includes_all(self):
+ """Passing ignore_rules=None preserves existing behaviour (all items collected)."""
+ view = _make_install_branch_view()
+ inventory = [
+ {"entPhysicalIndex": 1, "entPhysicalModelName": "PARENT", "entPhysicalContainedIn": 0},
+ {
+ "entPhysicalIndex": 2,
+ "entPhysicalModelName": "CHILD-IDPROM",
+ "entPhysicalName": "X-IDPROM",
+ "entPhysicalContainedIn": 1,
+ },
+ ]
+ items = []
+ view._collect_children(1, inventory, items, visited={1})
+ assert any(i["entPhysicalIndex"] == 2 for i in items)
+
+
+# ---------------------------------------------------------------------------
+# _find_parent_module_id with regex mappings (Item 6)
+# ---------------------------------------------------------------------------
+
+
+class TestFindParentModuleIdRegex:
+ """_find_parent_module_id applies regex ModuleBayMappings in ancestor walk."""
+
+ def _make_bay(self, name, installed_module_id=None):
+ bay = MagicMock()
+ bay.name = name
+ if installed_module_id is not None:
+ bay.installed_module = MagicMock()
+ bay.installed_module.pk = installed_module_id
+ else:
+ bay.installed_module = None
+ return bay
+
+ def _make_regex_mapping(self, pattern, netbox_bay_name):
+ m = MagicMock()
+ m.is_regex = True
+ m.librenms_name = pattern
+ m.netbox_bay_name = netbox_bay_name
+ m.librenms_class = ""
+ m._compiled_pattern = re.compile(pattern)
+ return m
+
+ def _make_exact_mapping(self, librenms_name, netbox_bay_name):
+ m = MagicMock()
+ m.is_regex = False
+ m.librenms_name = librenms_name
+ m.netbox_bay_name = netbox_bay_name
+ m.librenms_class = ""
+ return m
+
+ def test_regex_mapping_matches_ancestor_name(self):
+ """A regex mapping on an ancestor name resolves to the installed module id."""
+ from netbox_librenms_plugin.views.sync.modules import InstallBranchView
+
+ parent = {
+ "entPhysicalIndex": 10,
+ "entPhysicalName": "Slot 3/0",
+ "entPhysicalDescr": "",
+ "entPhysicalContainedIn": 0,
+ }
+ child = {"entPhysicalIndex": 20, "entPhysicalModelName": "SFP-X", "entPhysicalContainedIn": 10}
+ index_map = {10: parent, 20: child}
+
+ bay = self._make_bay("Slot3", installed_module_id=77)
+ regex_mapping = self._make_regex_mapping(r"Slot \d+/\d+", "Slot3")
+ device_bays = [bay]
+
+ result = InstallBranchView._find_parent_module_id(child, index_map, device_bays, [], [regex_mapping])
+ assert result == 77
+
+ def test_exact_mapping_still_works(self):
+ """Exact mappings continue to work alongside regex mappings."""
+ from netbox_librenms_plugin.views.sync.modules import InstallBranchView
+
+ parent = {
+ "entPhysicalIndex": 10,
+ "entPhysicalName": "ExactSlot",
+ "entPhysicalDescr": "",
+ "entPhysicalContainedIn": 0,
+ }
+ child = {"entPhysicalIndex": 20, "entPhysicalModelName": "MOD-A", "entPhysicalContainedIn": 10}
+ index_map = {10: parent, 20: child}
+
+ bay = self._make_bay("Bay-1", installed_module_id=42)
+ exact_mapping = self._make_exact_mapping("ExactSlot", "Bay-1")
+ device_bays = [bay]
+
+ result = InstallBranchView._find_parent_module_id(child, index_map, device_bays, [exact_mapping], [])
+ assert result == 42
+
+ def test_no_match_returns_none(self):
+ """Returns None when no exact or regex mapping matches the ancestor."""
+ from netbox_librenms_plugin.views.sync.modules import InstallBranchView
+
+ parent = {
+ "entPhysicalIndex": 10,
+ "entPhysicalName": "UnknownSlot",
+ "entPhysicalDescr": "",
+ "entPhysicalContainedIn": 0,
+ }
+ child = {"entPhysicalIndex": 20, "entPhysicalModelName": "MOD-B", "entPhysicalContainedIn": 10}
+ index_map = {10: parent, 20: child}
+
+ bay = self._make_bay("Bay-2", installed_module_id=99)
+ regex_mapping = self._make_regex_mapping(r"Slot \d+", "Bay-2")
+ device_bays = [bay]
+
+ # "UnknownSlot" does not match pattern "Slot \d+"
+ result = InstallBranchView._find_parent_module_id(child, index_map, device_bays, [], [regex_mapping])
+ assert result is None
+
+
+# ---------------------------------------------------------------------------
+# _find_parent_module_id β cycle detection and ancestor walk (Item 16)
+# ---------------------------------------------------------------------------
+
+
+class TestFindParentModuleIdAncestorWalk:
+ """_find_parent_module_id walks up the hierarchy and handles edge cases."""
+
+ def _make_bay(self, name, installed_module_id=None):
+ bay = MagicMock()
+ bay.name = name
+ if installed_module_id is not None:
+ bay.installed_module = MagicMock()
+ bay.installed_module.pk = installed_module_id
+ else:
+ bay.installed_module = None
+ return bay
+
+ def test_direct_parent_matches_bay_name(self):
+ """Parent whose entPhysicalName matches a bay with an installed module."""
+ from netbox_librenms_plugin.views.sync.modules import InstallBranchView
+
+ parent = {
+ "entPhysicalIndex": 10,
+ "entPhysicalName": "Slot 1",
+ "entPhysicalDescr": "",
+ "entPhysicalContainedIn": 0,
+ }
+ child = {"entPhysicalIndex": 20, "entPhysicalContainedIn": 10}
+ index_map = {10: parent, 20: child}
+ bay = self._make_bay("Slot 1", installed_module_id=55)
+
+ result = InstallBranchView._find_parent_module_id(child, index_map, [bay], [], [])
+ assert result == 55
+
+ def test_parent_matched_by_descr_field(self):
+ """Parent matched via entPhysicalDescr when entPhysicalName doesn't match."""
+ from netbox_librenms_plugin.views.sync.modules import InstallBranchView
+
+ parent = {
+ "entPhysicalIndex": 10,
+ "entPhysicalName": "SomethingElse",
+ "entPhysicalDescr": "Slot 1",
+ "entPhysicalContainedIn": 0,
+ }
+ child = {"entPhysicalIndex": 20, "entPhysicalContainedIn": 10}
+ index_map = {10: parent, 20: child}
+ bay = self._make_bay("Slot 1", installed_module_id=66)
+
+ result = InstallBranchView._find_parent_module_id(child, index_map, [bay], [], [])
+ assert result == 66
+
+ def test_grandparent_walk(self):
+ """Walk two levels up to find an installed ancestor."""
+ from netbox_librenms_plugin.views.sync.modules import InstallBranchView
+
+ grandparent = {
+ "entPhysicalIndex": 1,
+ "entPhysicalName": "FPC 0",
+ "entPhysicalDescr": "",
+ "entPhysicalContainedIn": 0,
+ }
+ parent = {
+ "entPhysicalIndex": 10,
+ "entPhysicalName": "Container",
+ "entPhysicalDescr": "",
+ "entPhysicalContainedIn": 1,
+ }
+ child = {"entPhysicalIndex": 20, "entPhysicalContainedIn": 10}
+ index_map = {1: grandparent, 10: parent, 20: child}
+ bay = self._make_bay("FPC 0", installed_module_id=33)
+
+ result = InstallBranchView._find_parent_module_id(child, index_map, [bay], [], [])
+ assert result == 33
+
+ def test_cycle_returns_none(self):
+ """Cycle in the hierarchy terminates without infinite loop."""
+ from netbox_librenms_plugin.views.sync.modules import InstallBranchView
+
+ a = {"entPhysicalIndex": 1, "entPhysicalName": "A", "entPhysicalDescr": "", "entPhysicalContainedIn": 2}
+ b = {"entPhysicalIndex": 2, "entPhysicalName": "B", "entPhysicalDescr": "", "entPhysicalContainedIn": 1}
+ child = {"entPhysicalIndex": 3, "entPhysicalContainedIn": 1}
+ index_map = {1: a, 2: b, 3: child}
+
+ result = InstallBranchView._find_parent_module_id(child, index_map, [], [], [])
+ assert result is None
+
+ def test_missing_parent_index_returns_none(self):
+ """ContainedIn references a non-existent index."""
+ from netbox_librenms_plugin.views.sync.modules import InstallBranchView
+
+ child = {"entPhysicalIndex": 20, "entPhysicalContainedIn": 999}
+ index_map = {20: child}
+
+ result = InstallBranchView._find_parent_module_id(child, index_map, [], [], [])
+ assert result is None
+
+ def test_root_item_returns_none(self):
+ """Item at root (containedIn=0) has no parent."""
+ from netbox_librenms_plugin.views.sync.modules import InstallBranchView
+
+ root = {"entPhysicalIndex": 1, "entPhysicalContainedIn": 0}
+ index_map = {1: root}
+
+ result = InstallBranchView._find_parent_module_id(root, index_map, [], [], [])
+ assert result is None
+
+ def test_uninstalled_bay_is_skipped(self):
+ """Bay matches parent name but has no installed module β walk continues to grandparent."""
+ from netbox_librenms_plugin.views.sync.modules import InstallBranchView
+
+ grandparent = {
+ "entPhysicalIndex": 5,
+ "entPhysicalName": "Chassis",
+ "entPhysicalDescr": "",
+ "entPhysicalContainedIn": 0,
+ }
+ parent = {
+ "entPhysicalIndex": 10,
+ "entPhysicalName": "Slot 1",
+ "entPhysicalDescr": "",
+ "entPhysicalContainedIn": 5,
+ }
+ child = {"entPhysicalIndex": 20, "entPhysicalContainedIn": 10}
+ index_map = {5: grandparent, 10: parent, 20: child}
+ empty_bay = self._make_bay("Slot 1", installed_module_id=None)
+ grandparent_bay = self._make_bay("Chassis", installed_module_id=99)
+
+ result = InstallBranchView._find_parent_module_id(child, index_map, [empty_bay, grandparent_bay], [], [])
+ assert result == 99
+
+
+# ---------------------------------------------------------------------------
+# _match_bay β exact mapping, regex mapping, and fallbacks (Item 16)
+# ---------------------------------------------------------------------------
+
+
+class TestMatchBayLogic:
+ """InstallBranchView._match_bay matches items via mappings or name fallback."""
+
+ def _make_exact_mapping(self, librenms_name, netbox_bay_name, librenms_class=""):
+ m = MagicMock()
+ m.is_regex = False
+ m.librenms_name = librenms_name
+ m.netbox_bay_name = netbox_bay_name
+ m.librenms_class = librenms_class
+ m.manufacturer_id = None
+ return m
+
+ def _make_regex_mapping(self, pattern, netbox_bay_name, librenms_class=""):
+ import re
+
+ m = MagicMock()
+ m.is_regex = True
+ m.librenms_name = pattern
+ m.netbox_bay_name = netbox_bay_name
+ m.librenms_class = librenms_class
+ m._compiled_pattern = re.compile(pattern)
+ m.manufacturer_id = None
+ return m
+
+ def test_exact_mapping_matches_parent_name(self):
+ """Exact mapping on the parent container name."""
+ from netbox_librenms_plugin.views.sync.modules import InstallBranchView
+
+ parent = {"entPhysicalIndex": 1, "entPhysicalName": "Rack 0-Slot 3", "entPhysicalContainedIn": 0}
+ child = {
+ "entPhysicalIndex": 2,
+ "entPhysicalName": "SFP-1",
+ "entPhysicalDescr": "",
+ "entPhysicalClass": "module",
+ "entPhysicalContainedIn": 1,
+ }
+ index_map = {1: parent, 2: child}
+
+ bay = MagicMock()
+ bay.name = "Slot 3"
+ module_bays = {"Slot 3": bay}
+ exact = [self._make_exact_mapping("Rack 0-Slot 3", "Slot 3")]
+
+ result = InstallBranchView._match_bay(child, index_map, module_bays, exact, [])
+ assert result is bay
+
+ def test_exact_mapping_matches_item_name(self):
+ """Exact mapping on the item's own name (when parent has no name)."""
+ from netbox_librenms_plugin.views.sync.modules import InstallBranchView
+
+ parent = {"entPhysicalIndex": 1, "entPhysicalName": "", "entPhysicalContainedIn": 0}
+ child = {
+ "entPhysicalIndex": 2,
+ "entPhysicalName": "PSU 0",
+ "entPhysicalDescr": "",
+ "entPhysicalClass": "powerSupply",
+ "entPhysicalContainedIn": 1,
+ }
+ index_map = {1: parent, 2: child}
+
+ bay = MagicMock()
+ bay.name = "PSU-Slot-0"
+ module_bays = {"PSU-Slot-0": bay}
+ exact = [self._make_exact_mapping("PSU 0", "PSU-Slot-0")]
+
+ result = InstallBranchView._match_bay(child, index_map, module_bays, exact, [])
+ assert result is bay
+
+ def test_class_scoped_mapping_preferred(self):
+ """Mapping with matching librenms_class preferred over classless mapping."""
+ from netbox_librenms_plugin.views.sync.modules import InstallBranchView
+
+ child = {
+ "entPhysicalIndex": 2,
+ "entPhysicalName": "Fan Tray 1",
+ "entPhysicalDescr": "",
+ "entPhysicalClass": "fan",
+ "entPhysicalContainedIn": 0,
+ }
+ index_map = {2: child}
+
+ bay_generic = MagicMock()
+ bay_generic.name = "FanGeneric"
+ bay_fan = MagicMock()
+ bay_fan.name = "Fan-1"
+ module_bays = {"FanGeneric": bay_generic, "Fan-1": bay_fan}
+ exact = [
+ self._make_exact_mapping("Fan Tray 1", "FanGeneric", librenms_class=""),
+ self._make_exact_mapping("Fan Tray 1", "Fan-1", librenms_class="fan"),
+ ]
+
+ result = InstallBranchView._match_bay(child, index_map, module_bays, exact, [])
+ assert result is bay_fan
+
+ # Order-independent: class-scoped mapping wins regardless of list order
+ result_reversed = InstallBranchView._match_bay(child, index_map, module_bays, list(reversed(exact)), [])
+ assert result_reversed is bay_fan
+
+ def test_regex_mapping_with_backreference(self):
+ """Regex mapping with capture group + backreference in netbox_bay_name."""
+ from netbox_librenms_plugin.views.sync.modules import InstallBranchView
+
+ child = {
+ "entPhysicalIndex": 2,
+ "entPhysicalName": "Optics 0/0/0/5",
+ "entPhysicalDescr": "",
+ "entPhysicalClass": "module",
+ "entPhysicalContainedIn": 0,
+ }
+ index_map = {2: child}
+
+ bay = MagicMock()
+ bay.name = "Optics0/0/0/5"
+ bay.module = None
+ module_bays = {"Optics0/0/0/5": bay}
+ regex = [self._make_regex_mapping(r"Optics (\d+/\d+/\d+/\d+)", r"Optics\1")]
+
+ with patch(
+ "netbox_librenms_plugin.views.base.modules_view.BaseModuleTableView._fpc_slot_matches", return_value=True
+ ):
+ result = InstallBranchView._match_bay(child, index_map, module_bays, [], regex)
+
+ assert result is bay
+
+ def test_vendor_two_segment_regex_does_not_grab_three_segment_path(self):
+ """Regression for #59: a narrow 2-segment vendor regex must NOT swallow a 3-segment
+ transceiver name; the more-specific 3-segment generic mapping must win.
+
+ ``_lookup_regex_bay_mapping`` uses ``fullmatch``, so a pattern with only two
+ slash-segments cannot consume a name with three. Both mappings are passed in
+ together (mirroring real callers that have already merged scoped + global
+ regex mappings via ``_filter_mappings_by_manufacturer``).
+ """
+ from netbox_librenms_plugin.views.sync.modules import InstallBranchView
+
+ child = {
+ "entPhysicalIndex": 2,
+ "entPhysicalName": "Optics 0/0/5",
+ "entPhysicalDescr": "",
+ "entPhysicalClass": "module",
+ "entPhysicalContainedIn": 0,
+ }
+ index_map = {2: child}
+
+ # The two-segment bay must NOT be selected for a three-segment LibreNMS name
+ narrow_bay = MagicMock()
+ narrow_bay.name = "Optics0/0"
+ narrow_bay.module = None
+ wide_bay = MagicMock()
+ wide_bay.name = "Optics0/0/5"
+ wide_bay.module = None
+ module_bays = {"Optics0/0": narrow_bay, "Optics0/0/5": wide_bay}
+
+ # Vendor-scoped narrow regex first (would mis-fire if iteration order
+ # alone decided the winner) + generic wider regex second.
+ narrow = self._make_regex_mapping(r"Optics (\d+/\d+)", r"Optics\1")
+ narrow.manufacturer_id = 7 # manufacturer-scoped
+ wide = self._make_regex_mapping(r"Optics (\d+/\d+/\d+)", r"Optics\1")
+ wide.manufacturer_id = None # global
+
+ with patch(
+ "netbox_librenms_plugin.views.base.modules_view.BaseModuleTableView._fpc_slot_matches", return_value=True
+ ):
+ result = InstallBranchView._match_bay(child, index_map, module_bays, [], [narrow, wide])
+
+ assert result is wide_bay, "narrow 2-segment vendor regex must not grab a 3-segment transceiver path"
+
+ def test_fallback_exact_name_match(self):
+ """Falls back to direct name-in-bays-dict when no mappings match."""
+ from netbox_librenms_plugin.views.sync.modules import InstallBranchView
+
+ child = {
+ "entPhysicalIndex": 2,
+ "entPhysicalName": "0/FT0",
+ "entPhysicalDescr": "",
+ "entPhysicalClass": "fan",
+ "entPhysicalContainedIn": 0,
+ }
+ index_map = {2: child}
+
+ bay = MagicMock()
+ bay.name = "0/FT0"
+ module_bays = {"0/FT0": bay}
+
+ with patch(
+ "netbox_librenms_plugin.views.base.modules_view.BaseModuleTableView._match_bay_by_position",
+ return_value=None,
+ ):
+ result = InstallBranchView._match_bay(child, index_map, module_bays, [], [])
+
+ assert result is bay
+
+ def test_no_match_returns_none(self):
+ """Returns None when nothing matches."""
+ from netbox_librenms_plugin.views.sync.modules import InstallBranchView
+
+ child = {
+ "entPhysicalIndex": 2,
+ "entPhysicalName": "Unknown",
+ "entPhysicalDescr": "",
+ "entPhysicalClass": "module",
+ "entPhysicalContainedIn": 0,
+ }
+ index_map = {2: child}
+
+ with patch(
+ "netbox_librenms_plugin.views.base.modules_view.BaseModuleTableView._match_bay_by_position",
+ return_value=None,
+ ):
+ result = InstallBranchView._match_bay(child, index_map, {}, [], [])
+
+ assert result is None
+
+
+# ---------------------------------------------------------------------------
+# _lookup_regex_bay_mapping β stale resolved_bay regression (Item 1)
+# ---------------------------------------------------------------------------
+
+
+class TestLookupRegexBayMappingStaleResolvedBay:
+ """Regression: a failed expand() must not use resolved_bay from a prior iteration."""
+
+ def _make_mapping(self, pattern, netbox_bay_name):
+ import re
+
+ m = MagicMock()
+ m._compiled_pattern = re.compile(pattern)
+ m.netbox_bay_name = netbox_bay_name
+ m.librenms_class = ""
+ m.manufacturer_id = None
+ return m
+
+ def test_failed_expand_does_not_match_stale_bay(self):
+ """If expand() raises, the stale resolved_bay from a prior mapping must not be used."""
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ # Mapping A: matches, expand succeeds, but bay name not in module_bays.
+ # Defined for documentation but replaced by mapping_a_no_bay below.
+ # Mapping B: matches, but expand raises IndexError (bad backreference)
+ mapping_b = self._make_mapping(r"Port-\d+", r"Bay-\2") # \2 doesn't exist
+
+ # Wrap mapping_b's compiled pattern so we can confirm the loop actually
+ # reached mapping_b (and it wasn't short-circuited by a stale match from A).
+ original_fullmatch = mapping_b._compiled_pattern.fullmatch
+ mapping_b._compiled_pattern = MagicMock()
+ mapping_b._compiled_pattern.fullmatch.side_effect = original_fullmatch
+
+ stale_bay = MagicMock()
+ stale_bay.name = "Bay-5"
+ module_bays = {"Bay-5": stale_bay}
+
+ # Before the fix, mapping_a sets resolved_bay="Bay-5" (no match in bays? let's say it does),
+ # then mapping_b fails expand but the outer `if match:` used stale resolved_bay="Bay-5".
+ # To properly trigger the bug: mapping_a's expand result is NOT in module_bays,
+ # then mapping_b's expand fails, and the stale value from A should NOT be used.
+ mapping_a_no_bay = self._make_mapping(r"Port-(\d+)", r"NoSuchBay-\1")
+
+ with patch.object(BaseModuleTableView, "_fpc_slot_matches", return_value=True):
+ result = BaseModuleTableView._lookup_regex_bay_mapping(
+ "Port-5", "", module_bays, [mapping_a_no_bay, mapping_b]
+ )
+
+ assert result is None, "Failed expand() must not fall through to stale resolved_bay"
+ # Confirm the loop actually iterated to mapping_b β otherwise the regression
+ # test would silently pass even if the bug were re-introduced via short-circuit.
+ mapping_b._compiled_pattern.fullmatch.assert_called_once_with("Port-5")
+
+ def test_successful_expand_matches_bay(self):
+ """Happy path: expand succeeds and bay exists."""
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ mapping = self._make_mapping(r"Optics(\d+/\d+/\d+/\d+)", r"Optics\1")
+ bay = MagicMock()
+ bay.name = "Optics0/0/0/3"
+ module_bays = {"Optics0/0/0/3": bay}
+
+ with patch.object(BaseModuleTableView, "_fpc_slot_matches", return_value=True):
+ result = BaseModuleTableView._lookup_regex_bay_mapping("Optics0/0/0/3", "", module_bays, [mapping])
+
+ assert result is bay
+
+ def test_no_match_returns_none(self):
+ """No mapping matches the name."""
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ mapping = self._make_mapping(r"Slot-\d+", r"Bay-\1")
+ result = BaseModuleTableView._lookup_regex_bay_mapping("Port-5", "", {}, [mapping])
+ assert result is None
+
+ def test_class_scoped_mapping_preferred(self):
+ """Mappings with matching class are tried before classless fallback."""
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ # Class-scoped mapping (matches)
+ m_class = self._make_mapping(r"Fan-(\d+)", r"FanBay-\1")
+ m_class.librenms_class = "fan"
+ # Classless mapping (would also match but lower priority)
+ m_generic = self._make_mapping(r"Fan-(\d+)", r"GenericBay-\1")
+ m_generic.librenms_class = ""
+
+ fan_bay = MagicMock()
+ fan_bay.name = "FanBay-3"
+ module_bays = {"FanBay-3": fan_bay, "GenericBay-3": MagicMock()}
+
+ with patch.object(BaseModuleTableView, "_fpc_slot_matches", return_value=True):
+ result = BaseModuleTableView._lookup_regex_bay_mapping("Fan-3", "fan", module_bays, [m_generic, m_class])
+
+ assert result is fan_bay
+
+
+class TestFilterMappingsByManufacturer:
+ """_filter_mappings_by_manufacturer scopes ModuleBayMapping entries by vendor."""
+
+ @staticmethod
+ def _mk(manufacturer_id):
+ m = MagicMock()
+ m.manufacturer_id = manufacturer_id
+ return m
+
+ def test_global_mapping_used_when_device_has_no_manufacturer(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ glob = self._mk(None)
+ scoped = self._mk(7)
+ result = BaseModuleTableView._filter_mappings_by_manufacturer([glob, scoped], None)
+ assert result == [glob]
+
+ def test_scoped_mapping_preferred_over_global_for_matching_vendor(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ glob = self._mk(None)
+ scoped = self._mk(7)
+ result = BaseModuleTableView._filter_mappings_by_manufacturer([glob, scoped], 7)
+ assert result == [scoped, glob]
+
+ def test_other_vendor_scoped_mapping_skipped(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ glob = self._mk(None)
+ other = self._mk(99)
+ result = BaseModuleTableView._filter_mappings_by_manufacturer([glob, other], 7)
+ assert result == [glob]
+
+
+# ---------------------------------------------------------------------------
+# PK validation error paths (finding 14)
+# ---------------------------------------------------------------------------
+
+
+def _make_request(method="GET", data=None):
+ req = MagicMock()
+ req.method = method
+ if method == "GET":
+ req.GET = data or {}
+ else:
+ req.POST = data or {}
+ return req
+
+
+def _make_device(pk=24, name="test-device"):
+ d = MagicMock()
+ d.pk = pk
+ d.name = name
+ d.device_type = MagicMock()
+ d.device_type.manufacturer = None
+ return d
+
+
+class TestPKValidationErrorPaths:
+ """Views must reject non-numeric PK values with an error message and redirect."""
+
+ # -- InstallModuleView.post: non-numeric module_bay_id -----------------
+
+ def test_install_module_non_numeric_bay_id(self):
+ from netbox_librenms_plugin.views.sync.modules import InstallModuleView
+
+ view = object.__new__(InstallModuleView)
+ view.required_object_permissions = {}
+ device = _make_device()
+ request = _make_request(
+ "POST",
+ data={
+ "module_bay_id": "not-a-number",
+ "module_type_id": "5",
+ "serial": "SN1",
+ },
+ )
+
+ with (
+ patch.object(view, "require_all_permissions", return_value=None),
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", return_value=device),
+ patch("netbox_librenms_plugin.views.sync.modules.reverse", return_value="/sync/"),
+ patch("netbox_librenms_plugin.views.sync.modules.messages") as mock_msg,
+ patch("netbox_librenms_plugin.views.sync.modules.redirect") as mock_redirect,
+ ):
+ view.post(request, pk=24)
+
+ mock_msg.error.assert_called_once()
+ assert "invalid" in mock_msg.error.call_args[0][1].lower()
+ mock_redirect.assert_called_once()
+
+ # -- InstallBranchView.post: non-numeric parent_index ------------------
+
+ def test_install_branch_non_numeric_parent_index(self):
+ from netbox_librenms_plugin.views.sync.modules import InstallBranchView
+
+ view = object.__new__(InstallBranchView)
+ view.required_object_permissions = {}
+ view._librenms_api = MagicMock()
+ view._librenms_api.server_key = "default"
+ device = _make_device()
+ request = _make_request(
+ "POST",
+ data={
+ "parent_index": "abc",
+ },
+ )
+
+ with (
+ patch.object(view, "require_all_permissions", return_value=None),
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", return_value=device),
+ patch("netbox_librenms_plugin.views.sync.modules.reverse", return_value="/sync/"),
+ patch("netbox_librenms_plugin.views.sync.modules.messages") as mock_msg,
+ patch("netbox_librenms_plugin.views.sync.modules.redirect") as mock_redirect,
+ ):
+ view.post(request, pk=24)
+
+ mock_msg.error.assert_called_once()
+ assert "invalid" in mock_msg.error.call_args[0][1].lower()
+ mock_redirect.assert_called_once()
+
+ # -- UpdateModuleSerialView.post: non-numeric module_id ----------------
+
+ def test_update_serial_non_numeric_module_id(self):
+ from netbox_librenms_plugin.views.sync.modules import UpdateModuleSerialView
+
+ view = object.__new__(UpdateModuleSerialView)
+ view.required_object_permissions = {}
+ device = _make_device()
+ request = _make_request(
+ "POST",
+ data={
+ "module_id": "xyz",
+ "serial": "NEW-SN",
+ },
+ )
+
+ with (
+ patch.object(view, "require_all_permissions", return_value=None),
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", return_value=device),
+ patch("netbox_librenms_plugin.views.sync.modules.reverse", return_value="/sync/"),
+ patch("netbox_librenms_plugin.views.sync.modules.messages") as mock_msg,
+ patch("netbox_librenms_plugin.views.sync.modules.redirect") as mock_redirect,
+ ):
+ view.post(request, pk=24)
+
+ mock_msg.error.assert_called_once()
+ assert "invalid" in mock_msg.error.call_args[0][1].lower()
+ mock_redirect.assert_called_once()
+
+ # -- InstallSelectedView.post: non-numeric select values ---------------
+
+ def test_install_selected_non_numeric_select(self):
+ from netbox_librenms_plugin.views.sync.modules import InstallSelectedView
+
+ view = object.__new__(InstallSelectedView)
+ view.required_object_permissions = {}
+ view._librenms_api = MagicMock()
+ view._librenms_api.server_key = "default"
+ device = _make_device()
+ # POST.getlist must return a list with non-numeric values
+ request = _make_request("POST", data={})
+ post_data = {}
+ post_mock = MagicMock()
+ post_mock.get = MagicMock(side_effect=lambda k, d=None: post_data.get(k, d))
+ post_mock.getlist = MagicMock(return_value=["a", "b"])
+ request.POST = post_mock
+
+ cached = [{"entPhysicalIndex": 1, "entPhysicalModelName": "M1"}]
+
+ with (
+ patch.object(view, "require_all_permissions", return_value=None),
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", return_value=device),
+ patch("netbox_librenms_plugin.views.sync.modules.reverse", return_value="/sync/"),
+ patch.object(view, "get_cache_key", return_value="ck"),
+ patch("netbox_librenms_plugin.views.sync.modules.cache") as mock_cache,
+ patch("netbox_librenms_plugin.views.sync.modules.messages") as mock_msg,
+ patch("netbox_librenms_plugin.views.sync.modules.redirect") as mock_redirect,
+ ):
+ mock_cache.get.return_value = {"inventory": cached, "librenms_id": "test"}
+ view.post(request, pk=24)
+
+ mock_msg.error.assert_called_once()
+ assert "invalid" in mock_msg.error.call_args[0][1].lower()
+ mock_redirect.assert_called_once()
+
+
+# ---------------------------------------------------------------------------
+# Basic behavioral tests β InstallModuleView (finding 15)
+# ---------------------------------------------------------------------------
+
+
+class TestInstallModuleViewBehavior:
+ """Behavioral tests for InstallModuleView.post happy and occupied paths."""
+
+ def _view(self):
+ from netbox_librenms_plugin.views.sync.modules import InstallModuleView
+
+ v = object.__new__(InstallModuleView)
+ v.required_object_permissions = {}
+ return v
+
+ def test_bay_already_occupied_warns(self):
+ """POST where module_bay has installed_module produces a warning and redirects."""
+ from contextlib import contextmanager
+
+ from dcim.models import ModuleBay
+
+ view = self._view()
+ device = _make_device()
+
+ module_bay = MagicMock()
+ module_bay.name = "Slot 1"
+ module_bay.installed_module = MagicMock() # occupied
+
+ module_type = MagicMock()
+ module_type.pk = 5
+
+ request = _make_request(
+ "POST",
+ data={
+ "module_bay_id": "10",
+ "module_type_id": "5",
+ "serial": "SN1",
+ },
+ )
+
+ @contextmanager
+ def noop_atomic():
+ yield
+
+ mock_qs = MagicMock()
+ mock_qs.get.return_value = module_bay # locked re-fetch returns same occupied bay
+
+ with (
+ patch.object(view, "require_all_permissions", return_value=None),
+ patch(
+ "netbox_librenms_plugin.views.sync.modules.get_object_or_404",
+ side_effect=[device, module_bay, module_type],
+ ),
+ patch("netbox_librenms_plugin.views.sync.modules.reverse", return_value="/sync/"),
+ patch("netbox_librenms_plugin.views.sync.modules.transaction") as mock_tx,
+ patch("netbox_librenms_plugin.views.sync.modules.messages") as mock_msg,
+ patch("netbox_librenms_plugin.views.sync.modules.redirect") as mock_redirect,
+ patch.object(ModuleBay, "objects") as mock_objects,
+ ):
+ mock_tx.atomic = noop_atomic
+ mock_objects.select_for_update.return_value = mock_qs
+ view.post(request, pk=24)
+
+ mock_msg.warning.assert_called_once()
+ assert "already has a module" in mock_msg.warning.call_args[0][1]
+ mock_redirect.assert_called_once()
+
+ def test_successful_install(self):
+ """POST happy path: module is created and success message is shown."""
+ from contextlib import contextmanager
+
+ from dcim.models import ModuleBay
+
+ view = self._view()
+ device = _make_device()
+
+ module_bay = MagicMock()
+ module_bay.name = "Slot 1"
+ module_bay.installed_module = None # not occupied
+
+ module_type = MagicMock()
+ module_type.pk = 5
+ module_type.model = "XCM-7s"
+
+ new_module = MagicMock()
+
+ request = _make_request(
+ "POST",
+ data={
+ "module_bay_id": "10",
+ "module_type_id": "5",
+ "serial": "SN123",
+ },
+ )
+
+ @contextmanager
+ def noop_atomic():
+ yield
+
+ mock_qs = MagicMock()
+ mock_qs.get.return_value = module_bay # locked re-fetch returns same bay
+
+ with (
+ patch.object(view, "require_all_permissions", return_value=None),
+ patch(
+ "netbox_librenms_plugin.views.sync.modules.get_object_or_404",
+ side_effect=[device, module_bay, module_type],
+ ),
+ patch("netbox_librenms_plugin.views.sync.modules.reverse", return_value="/sync/"),
+ patch("netbox_librenms_plugin.views.sync.modules.transaction") as mock_tx,
+ patch("netbox_librenms_plugin.views.sync.modules.messages") as mock_msg,
+ patch("netbox_librenms_plugin.views.sync.modules.redirect") as mock_redirect,
+ patch("dcim.models.Module") as mock_module_cls,
+ patch.object(ModuleBay, "objects") as mock_objects,
+ ):
+ mock_tx.atomic = noop_atomic
+ mock_module_cls.return_value = new_module
+ mock_objects.select_for_update.return_value = mock_qs
+ view.post(request, pk=24)
+
+ new_module.full_clean.assert_called_once()
+ new_module.save.assert_called_once()
+ mock_msg.success.assert_called_once()
+ assert "XCM-7s" in mock_msg.success.call_args[0][1]
+ mock_redirect.assert_called_once()
+
+
+# ---------------------------------------------------------------------------
+# Basic behavioral tests β UpdateModuleSerialView (finding 15)
+# ---------------------------------------------------------------------------
+
+
+class TestUpdateModuleSerialViewBehavior:
+ """Behavioral tests for UpdateModuleSerialView.post happy path."""
+
+ def _view(self):
+ from netbox_librenms_plugin.views.sync.modules import UpdateModuleSerialView
+
+ v = object.__new__(UpdateModuleSerialView)
+ v.required_object_permissions = {}
+ return v
+
+ def test_updates_serial_successfully(self):
+ """POST with valid module_id and new serial updates the module and shows success."""
+ from contextlib import contextmanager
+
+ from dcim.models import Module
+
+ view = self._view()
+ device = _make_device()
+
+ module = MagicMock()
+ module.pk = 42
+ module.serial = "OLD-SN"
+ module.module_type = MagicMock()
+ module.module_type.model = "XCM-7s"
+ module.module_bay = MagicMock()
+ module.module_bay.name = "Slot 1"
+
+ request = _make_request(
+ "POST",
+ data={
+ "module_id": "42",
+ "serial": "NEW-SN",
+ },
+ )
+
+ @contextmanager
+ def noop_atomic():
+ yield
+
+ mock_qs = MagicMock()
+ mock_qs.select_related.return_value.filter.return_value.first.return_value = module
+
+ with (
+ patch.object(view, "require_all_permissions", return_value=None),
+ patch(
+ "netbox_librenms_plugin.views.sync.modules.get_object_or_404",
+ return_value=device,
+ ),
+ patch("netbox_librenms_plugin.views.sync.modules.reverse", return_value="/sync/"),
+ patch("netbox_librenms_plugin.views.sync.modules.transaction") as mock_tx,
+ patch("netbox_librenms_plugin.views.sync.modules.messages") as mock_msg,
+ patch("netbox_librenms_plugin.views.sync.modules.redirect") as mock_redirect,
+ patch.object(Module, "objects") as mock_objects,
+ ):
+ mock_tx.atomic = noop_atomic
+ mock_objects.select_for_update.return_value = mock_qs
+ view.post(request, pk=24)
+
+ assert module.serial == "NEW-SN"
+ module.full_clean.assert_called_once()
+ module.save.assert_called_once()
+ mock_msg.success.assert_called_once()
+ assert "NEW-SN" in mock_msg.success.call_args[0][1]
+ mock_redirect.assert_called_once()
+
+
+# =============================================================================
+# TestBuildTableRowsBayCollisionDetection (Issue #65)
+# =============================================================================
+
+
+class TestBuildTableRowsBayCollisionDetection:
+ """_build_table_rows merges module-scoped bays into a deterministic flat dict.
+
+ When two modules expose bays with the same name the module with the lower PK
+ wins (first-match-wins with sorted module IDs). Device-level bays always
+ take precedence over module-scoped bays.
+ """
+
+ def _make_bay(self, name, pk):
+ from unittest.mock import MagicMock
+
+ bay = MagicMock()
+ bay.name = name
+ bay.pk = pk
+ return bay
+
+ def test_no_collision_passthrough(self):
+ """When bay names are unique across modules, all bays are in all_bays."""
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ view = BaseModuleTableView.__new__(BaseModuleTableView)
+ bay_a = self._make_bay("Slot 1", 10)
+ bay_b = self._make_bay("Slot 2", 11)
+
+ device_bays = {}
+ module_scoped_bays = {
+ 1: {"Slot 1": bay_a},
+ 2: {"Slot 2": bay_b},
+ }
+
+ all_bays = view._compute_all_bays(device_bays, module_scoped_bays)
+ assert "Slot 1" in all_bays
+ assert "Slot 2" in all_bays
+ assert all_bays["Slot 1"] is bay_a
+ assert all_bays["Slot 2"] is bay_b
+
+ def test_collision_lower_pk_wins(self):
+ """When two modules share a bay name, the one with the lower module PK wins."""
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ view = BaseModuleTableView.__new__(BaseModuleTableView)
+ bay_low = self._make_bay("Slot 1", 5)
+ bay_high = self._make_bay("Slot 1", 99)
+
+ device_bays = {}
+ module_scoped_bays = {
+ 10: {"Slot 1": bay_high}, # lower module PK gets processed first
+ 2: {"Slot 1": bay_low},
+ }
+
+ all_bays = view._compute_all_bays(device_bays, module_scoped_bays)
+ # Module PK 2 < 10 β bay_low wins
+ assert all_bays["Slot 1"] is bay_low
+
+ def test_device_bays_take_precedence_over_module_bays(self):
+ """Device-level bays always override same-named module-scoped bays."""
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ view = BaseModuleTableView.__new__(BaseModuleTableView)
+ device_bay = self._make_bay("Slot 1", 1)
+ module_bay = self._make_bay("Slot 1", 2)
+
+ device_bays = {"Slot 1": device_bay}
+ module_scoped_bays = {1: {"Slot 1": module_bay}}
+
+ all_bays = view._compute_all_bays(device_bays, module_scoped_bays)
+ assert all_bays["Slot 1"] is device_bay
+
+ def test_collision_logs_debug(self, caplog):
+ """Collision names are logged at DEBUG level."""
+ import logging
+
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ view = BaseModuleTableView.__new__(BaseModuleTableView)
+ bay_a = self._make_bay("Slot 1", 1)
+ bay_b = self._make_bay("Slot 1", 2)
+
+ device_bays = {}
+ module_scoped_bays = {1: {"Slot 1": bay_a}, 2: {"Slot 1": bay_b}}
+
+ with caplog.at_level(logging.DEBUG, logger="netbox_librenms_plugin.views.base.modules_view"):
+ view._compute_all_bays(device_bays, module_scoped_bays)
+
+ assert any("Slot 1" in msg for msg in caplog.messages)
+
+
+class TestModulesRedirectResponse:
+ """_modules_redirect_response: HX-Request β HX-Redirect; classic β redirect()."""
+
+ def test_classic_request_uses_redirect(self):
+ from unittest.mock import MagicMock, patch
+
+ from netbox_librenms_plugin.views.sync.modules import _modules_redirect_response
+
+ req = MagicMock()
+ req.headers = {}
+ with patch("netbox_librenms_plugin.views.sync.modules.redirect") as mock_redirect:
+ mock_redirect.return_value = "REDIRECT"
+ result = _modules_redirect_response(req, "/sync/")
+ mock_redirect.assert_called_once_with("/sync/?tab=modules#librenms-module-table")
+ assert result == "REDIRECT"
+
+ def test_htmx_request_returns_hx_redirect_header(self):
+ from unittest.mock import MagicMock
+
+ from netbox_librenms_plugin.views.sync.modules import _modules_redirect_response
+
+ req = MagicMock()
+ req.headers = {"HX-Request": "true"}
+ response = _modules_redirect_response(req, "/sync/")
+ assert response.status_code == 204
+ assert response["HX-Redirect"] == "/sync/?tab=modules#librenms-module-table"
+
+
+class TestAddBayTemplateViewWiring:
+ """AddBayTemplateView must have the right mixins and target kinds."""
+
+ def test_inherits_required_mixins(self):
+ from netbox_librenms_plugin.views.mixins import LibreNMSPermissionMixin, NetBoxObjectPermissionMixin
+ from netbox_librenms_plugin.views.sync.modules import AddBayTemplateView
+
+ assert LibreNMSPermissionMixin in AddBayTemplateView.__mro__
+ assert NetBoxObjectPermissionMixin in AddBayTemplateView.__mro__
+
+ def test_target_kinds_are_device_type_and_module_type(self):
+ from netbox_librenms_plugin.views.sync.modules import AddBayTemplateView
+
+ assert AddBayTemplateView.TARGET_KINDS == ("device_type", "module_type")
+
+
+class TestAddBayTemplateViewPostValidation:
+ """POST input validation: target_kind, target_pk, name."""
+
+ def _make_view(self):
+ from netbox_librenms_plugin.views.sync.modules import AddBayTemplateView
+
+ view = object.__new__(AddBayTemplateView)
+ # Bypass perm checks: require_all_permissions returns None on success.
+ view.require_all_permissions = MagicMock(return_value=None)
+ return view
+
+ def _make_request(self, post_data, htmx=False):
+ req = MagicMock()
+ req.method = "POST"
+ req.POST = post_data
+ req.headers = {"HX-Request": "true"} if htmx else {}
+ return req
+
+ def test_invalid_target_kind_returns_redirect(self):
+ view = self._make_view()
+ req = self._make_request({"target_kind": "bogus", "target_pk": "1", "name": "Slot 1"})
+ with (
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", return_value=MagicMock()),
+ patch("netbox_librenms_plugin.views.sync.modules.reverse", return_value="/sync/"),
+ patch("netbox_librenms_plugin.views.sync.modules.messages") as mock_messages,
+ patch(
+ "netbox_librenms_plugin.views.sync.modules._modules_redirect_response", return_value="REDIR"
+ ) as mock_redir,
+ ):
+ result = view.post(req, pk=1)
+ assert result == "REDIR"
+ assert mock_messages.error.called
+ assert "Invalid target_kind" in mock_messages.error.call_args[0][1]
+ mock_redir.assert_called_once()
+
+ def test_missing_target_pk_returns_redirect(self):
+ view = self._make_view()
+ req = self._make_request({"target_kind": "device_type", "target_pk": "", "name": "Slot 1"})
+ with (
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", return_value=MagicMock()),
+ patch("netbox_librenms_plugin.views.sync.modules.reverse", return_value="/sync/"),
+ patch("netbox_librenms_plugin.views.sync.modules.messages") as mock_messages,
+ patch("netbox_librenms_plugin.views.sync.modules._modules_redirect_response", return_value="REDIR"),
+ ):
+ view.post(req, pk=1)
+ assert "target_pk" in mock_messages.error.call_args[0][1]
+
+ def test_missing_name_returns_redirect(self):
+ view = self._make_view()
+ req = self._make_request({"target_kind": "module_type", "target_pk": "5", "name": " "})
+ with (
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", return_value=MagicMock()),
+ patch("netbox_librenms_plugin.views.sync.modules.reverse", return_value="/sync/"),
+ patch("netbox_librenms_plugin.views.sync.modules.messages") as mock_messages,
+ patch("netbox_librenms_plugin.views.sync.modules._modules_redirect_response", return_value="REDIR"),
+ ):
+ view.post(req, pk=1)
+ assert "name is required" in mock_messages.error.call_args[0][1]
+
+
+class TestAddBayTemplateViewGetValidation:
+ """GET modal renderer validates query-string inputs."""
+
+ def _make_view(self):
+ from netbox_librenms_plugin.views.sync.modules import AddBayTemplateView
+
+ view = object.__new__(AddBayTemplateView)
+ view.require_all_permissions = MagicMock(return_value=None)
+ return view
+
+ def test_invalid_target_kind_returns_400(self):
+ view = self._make_view()
+ req = MagicMock()
+ req.GET = {"target_kind": "nope", "target_pk": "1"}
+ with patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", return_value=MagicMock()):
+ response = view.get(req, pk=1)
+ assert response.status_code == 400
+
+ def test_invalid_target_pk_returns_400(self):
+ view = self._make_view()
+ req = MagicMock()
+ req.GET = {"target_kind": "device_type", "target_pk": "abc"}
+ with patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", return_value=MagicMock()):
+ response = view.get(req, pk=1)
+ assert response.status_code == 400
+
+ def test_valid_request_renders_modal_with_suggestions(self):
+ view = self._make_view()
+ req = MagicMock()
+ req.GET = {
+ "target_kind": "device_type",
+ "target_pk": "7",
+ "suggested_name": "Fan Tray 0",
+ "suggested_position": "0",
+ "suggested_label": "Fan Controller",
+ }
+ with (
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", return_value=MagicMock()),
+ patch("netbox_librenms_plugin.views.sync.modules.render", return_value="RENDERED") as mock_render,
+ ):
+ response = view.get(req, pk=42)
+ assert response == "RENDERED"
+ ctx = mock_render.call_args[0][2]
+ assert ctx["device_pk"] == 42
+ assert ctx["target_kind"] == "device_type"
+ assert ctx["target_pk"] == 7
+ assert ctx["suggested_name"] == "Fan Tray 0"
+ assert ctx["suggested_position"] == "0"
+ assert ctx["suggested_label"] == "Fan Controller"
+ # Without a librenms_name in the GET, the auto-mapping checkbox is
+ # never offered (there's nothing to map from).
+ assert ctx["offer_mapping_checkbox"] is False
+
+
+class TestAddBayTemplateViewMappingCheckbox:
+ """GET threads librenms_name/class into context and decides whether to
+ show the auto-create-mapping checkbox. POST creates the mapping when the
+ user opts in and the NetBox name differs from the LibreNMS one."""
+
+ def _make_view(self):
+ from netbox_librenms_plugin.views.sync.modules import AddBayTemplateView
+
+ view = object.__new__(AddBayTemplateView)
+ view.require_all_permissions = MagicMock(return_value=None)
+ view._instantiate_template_on_existing = MagicMock(return_value=0)
+ return view
+
+ def _device_with_manufacturer(self, manufacturer=None):
+ device = MagicMock()
+ device.device_type.manufacturer = manufacturer
+ return device
+
+ def test_get_offers_checkbox_when_libre_name_present_and_no_existing_mapping(self):
+ view = self._make_view()
+ manufacturer = MagicMock()
+ manufacturer.__str__ = lambda s: "Nokia"
+ device = self._device_with_manufacturer(manufacturer)
+ req = MagicMock()
+ req.GET = {
+ "target_kind": "device_type",
+ "target_pk": "7",
+ "suggested_name": "SFM 1",
+ "librenms_name": "Sfm 1",
+ "librenms_class": "fabricModule",
+ }
+ req.user.has_perm.return_value = True
+ with (
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", return_value=device),
+ patch("netbox_librenms_plugin.views.sync.modules.render", return_value="R") as mock_render,
+ patch("netbox_librenms_plugin.models.ModuleBayMapping") as mock_mapping_cls,
+ ):
+ mock_mapping_cls.objects.filter.return_value.filter.return_value.exists.return_value = False
+ view.get(req, pk=42)
+ ctx = mock_render.call_args[0][2]
+ assert ctx["librenms_name"] == "Sfm 1"
+ assert ctx["librenms_class"] == "fabricModule"
+ assert ctx["manufacturer_label"] == "Nokia"
+ assert ctx["offer_mapping_checkbox"] is True
+ assert ctx["mapping_exists"] is False
+
+ def test_get_suppresses_checkbox_when_existing_mapping(self):
+ view = self._make_view()
+ device = self._device_with_manufacturer(MagicMock())
+ req = MagicMock()
+ req.GET = {
+ "target_kind": "device_type",
+ "target_pk": "7",
+ "librenms_name": "Sfm 1",
+ "librenms_class": "fabricModule",
+ }
+ req.user.has_perm.return_value = True
+ with (
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", return_value=device),
+ patch("netbox_librenms_plugin.views.sync.modules.render", return_value="R") as mock_render,
+ patch("netbox_librenms_plugin.models.ModuleBayMapping") as mock_mapping_cls,
+ ):
+ mock_mapping_cls.objects.filter.return_value.filter.return_value.exists.return_value = True
+ view.get(req, pk=42)
+ ctx = mock_render.call_args[0][2]
+ assert ctx["mapping_exists"] is True
+ assert ctx["offer_mapping_checkbox"] is False
+
+ def test_get_suppresses_checkbox_when_user_lacks_add_mapping_perm(self):
+ view = self._make_view()
+ device = self._device_with_manufacturer(MagicMock())
+ req = MagicMock()
+ req.GET = {
+ "target_kind": "device_type",
+ "target_pk": "7",
+ "librenms_name": "Sfm 1",
+ }
+ req.user.has_perm.return_value = False # lacks add_modulebaymapping
+ with (
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", return_value=device),
+ patch("netbox_librenms_plugin.views.sync.modules.render", return_value="R") as mock_render,
+ patch("netbox_librenms_plugin.models.ModuleBayMapping") as mock_mapping_cls,
+ ):
+ mock_mapping_cls.objects.filter.return_value.filter.return_value.exists.return_value = False
+ view.get(req, pk=42)
+ ctx = mock_render.call_args[0][2]
+ assert ctx["offer_mapping_checkbox"] is False
+
+ def test_post_creates_mapping_when_checkbox_set_and_names_differ(self):
+ view = self._make_view()
+ manufacturer = MagicMock()
+ device = self._device_with_manufacturer(manufacturer)
+ req = MagicMock()
+ req.method = "POST"
+ req.POST = {
+ "target_kind": "device_type",
+ "target_pk": "7",
+ "name": "SFM 1",
+ "librenms_name": "Sfm 1",
+ "librenms_class": "fabricModule",
+ "also_create_mapping": "1",
+ }
+ req.user.has_perm.return_value = True
+ target = MagicMock()
+ with (
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", side_effect=[device, target]),
+ patch("netbox_librenms_plugin.views.sync.modules.reverse", return_value="/sync/"),
+ patch("netbox_librenms_plugin.views.sync.modules.transaction") as mock_tx,
+ patch("netbox_librenms_plugin.views.sync.modules.messages") as mock_msg,
+ patch("netbox_librenms_plugin.views.sync.modules._modules_redirect_response", return_value="REDIR"),
+ patch("dcim.models.ModuleBayTemplate") as mock_bt_cls,
+ patch("netbox_librenms_plugin.models.ModuleBayMapping") as mock_mapping_cls,
+ ):
+ mock_tx.atomic.return_value.__enter__ = lambda s: s
+ mock_tx.atomic.return_value.__exit__ = MagicMock(return_value=False)
+ mock_bt_cls.return_value = MagicMock()
+ # No existing mapping
+ mock_mapping_cls.objects.filter.return_value.filter.return_value.exists.return_value = False
+ mapping_instance = MagicMock()
+ mock_mapping_cls.return_value = mapping_instance
+ view.post(req, pk=1)
+ # ModuleBayMapping was constructed with the right field values
+ call_kwargs = mock_mapping_cls.call_args.kwargs
+ assert call_kwargs["librenms_name"] == "Sfm 1"
+ assert call_kwargs["netbox_bay_name"] == "SFM 1"
+ assert call_kwargs["librenms_class"] == "fabricModule"
+ assert call_kwargs["is_regex"] is False
+ assert call_kwargs["manufacturer"] is manufacturer
+ mapping_instance.full_clean.assert_called_once()
+ mapping_instance.save.assert_called_once()
+ # Success message mentions both bay and mapping
+ assert any("ModuleBayMapping" in c.args[1] for c in mock_msg.success.call_args_list)
+
+ def test_post_skips_mapping_when_names_match(self):
+ view = self._make_view()
+ device = self._device_with_manufacturer(MagicMock())
+ req = MagicMock()
+ req.method = "POST"
+ req.POST = {
+ "target_kind": "device_type",
+ "target_pk": "7",
+ "name": "Sfm 1", # same as LibreNMS β no mapping needed
+ "librenms_name": "Sfm 1",
+ "also_create_mapping": "1",
+ }
+ req.user.has_perm.return_value = True
+ with (
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", side_effect=[device, MagicMock()]),
+ patch("netbox_librenms_plugin.views.sync.modules.reverse", return_value="/sync/"),
+ patch("netbox_librenms_plugin.views.sync.modules.transaction") as mock_tx,
+ patch("netbox_librenms_plugin.views.sync.modules.messages"),
+ patch("netbox_librenms_plugin.views.sync.modules._modules_redirect_response", return_value="REDIR"),
+ patch("dcim.models.ModuleBayTemplate") as mock_bt_cls,
+ patch("netbox_librenms_plugin.models.ModuleBayMapping") as mock_mapping_cls,
+ ):
+ mock_tx.atomic.return_value.__enter__ = lambda s: s
+ mock_tx.atomic.return_value.__exit__ = MagicMock(return_value=False)
+ mock_bt_cls.return_value = MagicMock()
+ view.post(req, pk=1)
+ # Mapping must not be instantiated when names match
+ mock_mapping_cls.assert_not_called()
+
+ def test_post_does_not_create_mapping_without_checkbox(self):
+ view = self._make_view()
+ device = self._device_with_manufacturer(MagicMock())
+ req = MagicMock()
+ req.method = "POST"
+ req.POST = {
+ "target_kind": "device_type",
+ "target_pk": "7",
+ "name": "SFM 1",
+ "librenms_name": "Sfm 1",
+ # also_create_mapping omitted
+ }
+ req.user.has_perm.return_value = True
+ with (
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", side_effect=[device, MagicMock()]),
+ patch("netbox_librenms_plugin.views.sync.modules.reverse", return_value="/sync/"),
+ patch("netbox_librenms_plugin.views.sync.modules.transaction") as mock_tx,
+ patch("netbox_librenms_plugin.views.sync.modules.messages"),
+ patch("netbox_librenms_plugin.views.sync.modules._modules_redirect_response", return_value="REDIR"),
+ patch("dcim.models.ModuleBayTemplate") as mock_bt_cls,
+ patch("netbox_librenms_plugin.models.ModuleBayMapping") as mock_mapping_cls,
+ ):
+ mock_tx.atomic.return_value.__enter__ = lambda s: s
+ mock_tx.atomic.return_value.__exit__ = MagicMock(return_value=False)
+ mock_bt_cls.return_value = MagicMock()
+ view.post(req, pk=1)
+ mock_mapping_cls.assert_not_called()
+
+
+class TestAddBayTemplateViewInstantiation:
+ """After saving a ModuleBayTemplate, the view materialises it onto every
+ existing Device/Module of the target so the resolver can match the new bay
+ immediately (NetBox only auto-creates bays from templates at first-create
+ time)."""
+
+ def test_instantiate_on_existing_device_type_creates_missing_bays(self):
+ from netbox_librenms_plugin.views.sync.modules import AddBayTemplateView
+
+ device_type = MagicMock()
+ bay_template = MagicMock()
+ bay_template.instantiate.side_effect = lambda device: MagicMock(name=f"bay-for-{id(device)}")
+ dev_a, dev_b = MagicMock(), MagicMock()
+ with (
+ patch("dcim.models.Device") as mock_device_cls,
+ patch("dcim.models.Module") as mock_module_cls,
+ patch("dcim.models.ModuleBay") as mock_bay_cls,
+ ):
+ mock_device_cls.objects.filter.return_value = [dev_a, dev_b]
+ mock_bay_cls.objects.filter.return_value.exists.return_value = False
+ count = AddBayTemplateView._instantiate_template_on_existing(bay_template, "device_type", device_type)
+ assert count == 2
+ mock_device_cls.objects.filter.assert_called_once_with(device_type=device_type)
+ mock_module_cls.objects.filter.assert_not_called()
+ assert bay_template.instantiate.call_count == 2
+
+ def test_instantiate_skips_devices_that_already_have_the_bay(self):
+ from netbox_librenms_plugin.views.sync.modules import AddBayTemplateView
+
+ device_type = MagicMock()
+ bay_template = MagicMock()
+ existing_bay = MagicMock()
+ existing_bay.name = "Fan Tray 0"
+ existing_bay.full_clean = MagicMock()
+ existing_bay.save = MagicMock()
+ bay_template.instantiate.return_value = existing_bay
+ with (
+ patch("dcim.models.Device") as mock_device_cls,
+ patch("dcim.models.Module"),
+ patch("dcim.models.ModuleBay") as mock_bay_cls,
+ ):
+ mock_device_cls.objects.filter.return_value = [MagicMock()]
+ # Bay already exists on the device
+ mock_bay_cls.objects.filter.return_value.exists.return_value = True
+ count = AddBayTemplateView._instantiate_template_on_existing(bay_template, "device_type", device_type)
+ assert count == 0
+ existing_bay.save.assert_not_called()
+
+ def test_instantiate_on_existing_module_type_uses_module_queryset(self):
+ from netbox_librenms_plugin.views.sync.modules import AddBayTemplateView
+
+ module_type = MagicMock()
+ module_a = MagicMock()
+ bay_template = MagicMock()
+ bay_template.instantiate.return_value = MagicMock(name="bay")
+ with (
+ patch("dcim.models.Device") as mock_device_cls,
+ patch("dcim.models.Module") as mock_module_cls,
+ patch("dcim.models.ModuleBay") as mock_bay_cls,
+ ):
+ mock_module_cls.objects.filter.return_value.select_related.return_value = [module_a]
+ mock_bay_cls.objects.filter.return_value.exists.return_value = False
+ count = AddBayTemplateView._instantiate_template_on_existing(bay_template, "module_type", module_type)
+ assert count == 1
+ mock_module_cls.objects.filter.assert_called_once_with(module_type=module_type)
+ mock_device_cls.objects.filter.assert_not_called()
+ bay_template.instantiate.assert_called_once_with(device=module_a.device, module=module_a)
+
+ def test_instantiate_unknown_target_kind_is_noop(self):
+ from netbox_librenms_plugin.views.sync.modules import AddBayTemplateView
+
+ bay_template = MagicMock()
+ with (
+ patch("dcim.models.Device") as mock_device_cls,
+ patch("dcim.models.Module") as mock_module_cls,
+ patch("dcim.models.ModuleBay"),
+ ):
+ count = AddBayTemplateView._instantiate_template_on_existing(bay_template, "bogus", MagicMock())
+ assert count == 0
+ mock_device_cls.objects.filter.assert_not_called()
+ mock_module_cls.objects.filter.assert_not_called()
+ bay_template.instantiate.assert_not_called()
+
+ """_derive_bay_template_suggestion infers sane defaults from item dicts."""
+
+ def _helper(self):
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ return BaseModuleTableView._derive_bay_template_suggestion
+
+ def test_extracts_trailing_digit_position(self):
+ result = self._helper()({"entPhysicalName": "Slot 3", "entPhysicalDescr": "Line Card"})
+ assert result["name"] == "Slot 3"
+ assert result["position"] == "3"
+ assert result["label"] == "Line Card"
+
+ def test_extracts_trailing_letter_position(self):
+ result = self._helper()({"entPhysicalName": "CMA-A"})
+ assert result["name"] == "CMA-A"
+ assert result["position"] == "A"
+
+ def test_falls_back_to_class_placeholder_for_fan(self):
+ result = self._helper()({"entPhysicalName": "", "entPhysicalClass": "fan"})
+ assert "Fan Tray" in result["name"]
+ assert result["position"] == "1"
+
+ def test_falls_back_to_class_placeholder_for_powersupply(self):
+ result = self._helper()({"entPhysicalName": "", "entPhysicalClass": "powerSupply"})
+ assert "Power Supply" in result["name"]
+
+ def test_falls_back_to_slot_for_unknown_class(self):
+ result = self._helper()({"entPhysicalName": "", "entPhysicalClass": "module"})
+ assert result["name"] == "Slot 1"
+
+
+class TestDeriveMappingPattern:
+ """_derive_mapping_pattern maps each distinct LibreNMS digit value to a
+ capture group; the NetBox replacement may use any literals as long as
+ every NetBox digit value is present on the LibreNMS side and the
+ pattern round-trips."""
+
+ def _fn(self):
+ from netbox_librenms_plugin.views.sync.modules import AddBayTemplateView
+
+ return AddBayTemplateView._derive_mapping_pattern
+
+ def test_case_only_difference_with_one_digit(self):
+ result = self._fn()("Sfm 1", "SFM 1")
+ assert result is not None
+ assert result["librenms_pattern"] == r"^Sfm\ (\d+)$"
+ assert result["netbox_replacement"] == r"SFM \1"
+ assert result["digit_count"] == 1
+
+ def test_identical_names_with_digit(self):
+ result = self._fn()("Slot 0", "Slot 0")
+ assert result is not None
+ assert result["digit_count"] == 1
+
+ def test_multi_digit_skeleton_collapses_repeat_to_backref(self):
+ # All four digits have the same value '0', so they collapse to a
+ # single group with back-references rather than four groups.
+ result = self._fn()("TenGigE0/0/0/0", "TenGigE0/0/0/0")
+ assert result is not None
+ assert result["digit_count"] == 1
+ assert result["librenms_pattern"] == r"^TenGigE(\d+)/\1/\1/\1$"
+ assert result["netbox_replacement"] == r"TenGigE\1/\1/\1/\1"
+
+ def test_libre_and_nb_have_different_skeletons(self):
+ # 0/FT0 β Fan Tray 0: both libre digits are '0' so they collapse to
+ # one group, and NetBox '0' references that group.
+ result = self._fn()("0/FT0", "Fan Tray 0")
+ assert result is not None
+ assert result["librenms_pattern"] == r"^(\d+)/FT\1$"
+ assert result["netbox_replacement"] == r"Fan Tray \1"
+
+ def test_literal_difference_with_shared_digit(self):
+ # Literals on libre and NetBox are unrelated β that's fine, they
+ # don't need to match. Digit '1' is shared.
+ result = self._fn()("Sfm 1", "Card 1")
+ assert result is not None
+ assert result["netbox_replacement"] == r"Card \1"
+
+ def test_nb_digit_absent_from_libre_returns_none(self):
+ # NetBox uses digit '2' which is nowhere on the libre side.
+ assert self._fn()("Slot 1", "Slot 2") is None
+
+ def test_no_digit_run_returns_none(self):
+ assert self._fn()("Slot A", "Slot A") is None
+
+ def test_extra_nb_digit_absent_from_libre_returns_none(self):
+ # NetBox has an extra digit '0' that libre never produces.
+ assert self._fn()("Slot 1", "Slot 1/0") is None
+
+ def test_empty_input_returns_none(self):
+ assert self._fn()("", "Slot 1") is None
+ assert self._fn()("Slot 1", "") is None
+
+
+class TestAddBayTemplateViewRegexMapping:
+ """GET surfaces a derived regex pattern; POST stores it as is_regex=True."""
+
+ def _make_view(self):
+ from netbox_librenms_plugin.views.sync.modules import AddBayTemplateView
+
+ view = object.__new__(AddBayTemplateView)
+ view.require_all_permissions = MagicMock(return_value=None)
+ view._instantiate_template_on_existing = MagicMock(return_value=0)
+ return view
+
+ def _device(self, manufacturer=None):
+ device = MagicMock()
+ device.device_type.manufacturer = manufacturer
+ return device
+
+ def test_get_includes_mapping_pattern_when_skeleton_matches(self):
+ view = self._make_view()
+ manufacturer = MagicMock()
+ manufacturer.__str__ = lambda s: "Nokia"
+ device = self._device(manufacturer)
+ req = MagicMock()
+ req.GET = {
+ "target_kind": "device_type",
+ "target_pk": "7",
+ "suggested_name": "SFM 1",
+ "librenms_name": "Sfm 1",
+ "librenms_class": "fabricModule",
+ }
+ req.user.has_perm.return_value = True
+ with (
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", return_value=device),
+ patch("netbox_librenms_plugin.views.sync.modules.render", return_value="R") as mock_render,
+ patch("netbox_librenms_plugin.models.ModuleBayMapping") as mock_mapping_cls,
+ ):
+ mock_mapping_cls.objects.filter.return_value.filter.return_value.exists.return_value = False
+ mock_mapping_cls.objects.filter.return_value.filter.return_value.only.return_value = []
+ view.get(req, pk=42)
+ ctx = mock_render.call_args[0][2]
+ assert ctx["mapping_pattern"] is not None
+ assert ctx["mapping_default_kind"] == "regex"
+ assert ctx["mapping_pattern"]["librenms_pattern"].startswith("^Sfm")
+
+ def test_get_omits_mapping_pattern_when_no_digit(self):
+ view = self._make_view()
+ device = self._device(MagicMock())
+ req = MagicMock()
+ req.GET = {
+ "target_kind": "device_type",
+ "target_pk": "7",
+ "suggested_name": "Card A",
+ "librenms_name": "card a",
+ "librenms_class": "module",
+ }
+ req.user.has_perm.return_value = True
+ with (
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", return_value=device),
+ patch("netbox_librenms_plugin.views.sync.modules.render", return_value="R") as mock_render,
+ patch("netbox_librenms_plugin.models.ModuleBayMapping") as mock_mapping_cls,
+ ):
+ mock_mapping_cls.objects.filter.return_value.filter.return_value.exists.return_value = False
+ mock_mapping_cls.objects.filter.return_value.filter.return_value.only.return_value = []
+ view.get(req, pk=42)
+ ctx = mock_render.call_args[0][2]
+ assert ctx["mapping_pattern"] is None
+ assert ctx["mapping_default_kind"] == "exact"
+
+ def test_get_skips_checkbox_when_existing_regex_covers_name(self):
+ view = self._make_view()
+ device = self._device(MagicMock())
+ existing = MagicMock()
+ existing.librenms_name = r"^Sfm (\d+)$"
+ req = MagicMock()
+ req.GET = {
+ "target_kind": "device_type",
+ "target_pk": "7",
+ "suggested_name": "SFM 1",
+ "librenms_name": "Sfm 1",
+ "librenms_class": "fabricModule",
+ }
+ req.user.has_perm.return_value = True
+ with (
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", return_value=device),
+ patch("netbox_librenms_plugin.views.sync.modules.render", return_value="R") as mock_render,
+ patch("netbox_librenms_plugin.models.ModuleBayMapping") as mock_mapping_cls,
+ ):
+ # No exact mapping, but a covering regex row exists.
+ mock_mapping_cls.objects.filter.return_value.filter.return_value.exists.return_value = False
+ mock_mapping_cls.objects.filter.return_value.filter.return_value.only.return_value = [existing]
+ view.get(req, pk=42)
+ ctx = mock_render.call_args[0][2]
+ assert ctx["mapping_exists"] is True
+ assert ctx["offer_mapping_checkbox"] is False
+
+ def _post_helper(self, post_data):
+ view = self._make_view()
+ manufacturer = MagicMock()
+ device = self._device(manufacturer)
+ req = MagicMock()
+ req.method = "POST"
+ req.POST = post_data
+ req.user.has_perm.return_value = True
+ target = MagicMock()
+ return view, req, device, target, manufacturer
+
+ def test_post_creates_regex_mapping_when_kind_regex_and_pattern_derives(self):
+ view, req, device, target, manufacturer = self._post_helper(
+ {
+ "target_kind": "device_type",
+ "target_pk": "7",
+ "name": "SFM 1",
+ "librenms_name": "Sfm 1",
+ "librenms_class": "fabricModule",
+ "also_create_mapping": "1",
+ "mapping_kind": "regex",
+ }
+ )
+ with (
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", side_effect=[device, target]),
+ patch("netbox_librenms_plugin.views.sync.modules.reverse", return_value="/sync/"),
+ patch("netbox_librenms_plugin.views.sync.modules.transaction") as mock_tx,
+ patch("netbox_librenms_plugin.views.sync.modules.messages"),
+ patch("netbox_librenms_plugin.views.sync.modules._modules_redirect_response", return_value="R"),
+ patch("dcim.models.ModuleBayTemplate") as mock_bt_cls,
+ patch("netbox_librenms_plugin.models.ModuleBayMapping") as mock_mapping_cls,
+ ):
+ mock_tx.atomic.return_value.__enter__ = lambda s: s
+ mock_tx.atomic.return_value.__exit__ = MagicMock(return_value=False)
+ mock_bt_cls.return_value = MagicMock()
+ # No existing exact or regex coverage.
+ mock_mapping_cls.objects.filter.return_value.filter.return_value.exists.return_value = False
+ mock_mapping_cls.objects.filter.return_value.filter.return_value.only.return_value = []
+ mock_mapping_cls.return_value = MagicMock()
+ view.post(req, pk=1)
+ kwargs = mock_mapping_cls.call_args.kwargs
+ assert kwargs["is_regex"] is True
+ assert kwargs["librenms_name"] == r"^Sfm\ (\d+)$"
+ assert kwargs["netbox_bay_name"] == r"SFM \1"
+ assert kwargs["manufacturer"] is manufacturer
+
+ def test_post_falls_back_to_exact_when_pattern_does_not_derive(self):
+ # mapping_kind=regex requested but server-side rule says no.
+ view, req, device, target, _m = self._post_helper(
+ {
+ "target_kind": "device_type",
+ "target_pk": "7",
+ "name": "Card B",
+ "librenms_name": "card a", # No digit run β no pattern.
+ "librenms_class": "module",
+ "also_create_mapping": "1",
+ "mapping_kind": "regex",
+ }
+ )
+ with (
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", side_effect=[device, target]),
+ patch("netbox_librenms_plugin.views.sync.modules.reverse", return_value="/sync/"),
+ patch("netbox_librenms_plugin.views.sync.modules.transaction") as mock_tx,
+ patch("netbox_librenms_plugin.views.sync.modules.messages"),
+ patch("netbox_librenms_plugin.views.sync.modules._modules_redirect_response", return_value="R"),
+ patch("dcim.models.ModuleBayTemplate") as mock_bt_cls,
+ patch("netbox_librenms_plugin.models.ModuleBayMapping") as mock_mapping_cls,
+ ):
+ mock_tx.atomic.return_value.__enter__ = lambda s: s
+ mock_tx.atomic.return_value.__exit__ = MagicMock(return_value=False)
+ mock_bt_cls.return_value = MagicMock()
+ mock_mapping_cls.objects.filter.return_value.filter.return_value.exists.return_value = False
+ mock_mapping_cls.objects.filter.return_value.filter.return_value.only.return_value = []
+ mock_mapping_cls.return_value = MagicMock()
+ view.post(req, pk=1)
+ kwargs = mock_mapping_cls.call_args.kwargs
+ assert kwargs["is_regex"] is False
+ assert kwargs["librenms_name"] == "card a"
+ assert kwargs["netbox_bay_name"] == "Card B"
+
+ def test_post_kind_exact_overrides_derivable_pattern(self):
+ # Pattern would derive, but user explicitly chose exact.
+ view, req, device, target, _m = self._post_helper(
+ {
+ "target_kind": "device_type",
+ "target_pk": "7",
+ "name": "SFM 1",
+ "librenms_name": "Sfm 1",
+ "librenms_class": "fabricModule",
+ "also_create_mapping": "1",
+ "mapping_kind": "exact",
+ }
+ )
+ with (
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", side_effect=[device, target]),
+ patch("netbox_librenms_plugin.views.sync.modules.reverse", return_value="/sync/"),
+ patch("netbox_librenms_plugin.views.sync.modules.transaction") as mock_tx,
+ patch("netbox_librenms_plugin.views.sync.modules.messages"),
+ patch("netbox_librenms_plugin.views.sync.modules._modules_redirect_response", return_value="R"),
+ patch("dcim.models.ModuleBayTemplate") as mock_bt_cls,
+ patch("netbox_librenms_plugin.models.ModuleBayMapping") as mock_mapping_cls,
+ ):
+ mock_tx.atomic.return_value.__enter__ = lambda s: s
+ mock_tx.atomic.return_value.__exit__ = MagicMock(return_value=False)
+ mock_bt_cls.return_value = MagicMock()
+ mock_mapping_cls.objects.filter.return_value.filter.return_value.exists.return_value = False
+ mock_mapping_cls.objects.filter.return_value.filter.return_value.only.return_value = []
+ mock_mapping_cls.return_value = MagicMock()
+ view.post(req, pk=1)
+ kwargs = mock_mapping_cls.call_args.kwargs
+ assert kwargs["is_regex"] is False
+ assert kwargs["librenms_name"] == "Sfm 1"
+
+ def test_post_skips_when_existing_regex_covers(self):
+ view, req, device, target, _m = self._post_helper(
+ {
+ "target_kind": "device_type",
+ "target_pk": "7",
+ "name": "SFM 1",
+ "librenms_name": "Sfm 1",
+ "librenms_class": "fabricModule",
+ "also_create_mapping": "1",
+ "mapping_kind": "regex",
+ }
+ )
+ existing = MagicMock()
+ existing.librenms_name = r"^Sfm (\d+)$"
+ with (
+ patch("netbox_librenms_plugin.views.sync.modules.get_object_or_404", side_effect=[device, target]),
+ patch("netbox_librenms_plugin.views.sync.modules.reverse", return_value="/sync/"),
+ patch("netbox_librenms_plugin.views.sync.modules.transaction") as mock_tx,
+ patch("netbox_librenms_plugin.views.sync.modules.messages"),
+ patch("netbox_librenms_plugin.views.sync.modules._modules_redirect_response", return_value="R"),
+ patch("dcim.models.ModuleBayTemplate") as mock_bt_cls,
+ patch("netbox_librenms_plugin.models.ModuleBayMapping") as mock_mapping_cls,
+ ):
+ mock_tx.atomic.return_value.__enter__ = lambda s: s
+ mock_tx.atomic.return_value.__exit__ = MagicMock(return_value=False)
+ mock_bt_cls.return_value = MagicMock()
+ mock_mapping_cls.objects.filter.return_value.filter.return_value.exists.return_value = False
+ mock_mapping_cls.objects.filter.return_value.filter.return_value.only.return_value = [existing]
+ view.post(req, pk=1)
+ # Coverage already exists β no new ModuleBayMapping instantiated.
+ mock_mapping_cls.assert_not_called()
+
+ """_render_fix_bay_template_badge emits an HTMX modal trigger when device + target_pk known."""
+
+ def _table_with_device(self, device_pk=99, can_add_module_bay_template=True):
+ from netbox_librenms_plugin.tables.modules import LibreNMSModuleTable
+
+ table = object.__new__(LibreNMSModuleTable)
+ table.device = MagicMock(pk=device_pk)
+ table.can_add_module_bay_template = can_add_module_bay_template
+ return table
+
+ def _table_without_device(self):
+ from netbox_librenms_plugin.tables.modules import LibreNMSModuleTable
+
+ table = object.__new__(LibreNMSModuleTable)
+ # Intentionally unset device β _render_fix_bay_template_badge handles via getattr.
+ return table
+
+ def test_renders_htmx_button_when_device_and_target_pk_present(self):
+ table = self._table_with_device(device_pk=42)
+ with patch(
+ "netbox_librenms_plugin.tables.modules.reverse",
+ return_value="/plugins/librenms_plugin/devices/42/add-bay-template/",
+ ):
+ html = str(
+ table._render_fix_bay_template_badge(
+ title="some title",
+ target_kind="module_type",
+ target_pk=5,
+ target_label="A9K",
+ suggestion={"name": "Slot 1", "position": "1", "label": "Line"},
+ fallback_url="/dcim/module-types/5/",
+ label="Fix Model",
+ )
+ )
+ assert "hx-get=" in html
+ assert "target_kind=module_type" in html
+ assert "target_pk=5" in html
+ assert "suggested_name=Slot+1" in html or "suggested_name=Slot%201" in html
+ assert "Fix Model" in html
+
+ def test_falls_back_to_link_when_device_missing(self):
+ table = self._table_without_device()
+ html = str(
+ table._render_fix_bay_template_badge(
+ title="t",
+ target_kind="device_type",
+ target_pk=7,
+ target_label="ASR",
+ suggestion={},
+ fallback_url="/dcim/device-types/7/",
+ label="Fix Device Type",
+ )
+ )
+ assert "hx-get" not in html
+ assert ' no "Add Mapping" button."""
+ device = MagicMock()
+ device.pk = 54
+ table = self._make_table(device=device)
+ table.server_key = "production"
+ record = {"status": "No Bay"}
+ with patch("netbox_librenms_plugin.tables.modules.reverse", return_value="/x/"):
+ result = str(table.render_actions("", record))
+ assert "Add Mapping" not in result
+
+ def test_render_actions_matched_row_does_not_render_add_mapping(self):
+ """`Matched` rows must not render the Add Mapping button even with a suggestion key."""
+ device = MagicMock()
+ device.pk = 54
+ table = self._make_table(device=device)
+ table.server_key = "production"
+ record = {
+ "status": "Matched",
+ "model_suggestion": {
+ "librenms_name": r"^0/(\d+)$",
+ "librenms_class": "module",
+ "netbox_bay_name": r"Slot \1",
+ "is_regex": True,
+ "example_item": "0/0",
+ "example_bay": "Slot 0",
+ },
+ }
+ with patch("netbox_librenms_plugin.tables.modules.reverse", return_value="/x/"):
+ result = str(table.render_actions("", record))
+ assert "Add Mapping" not in result
+
+ def test_render_actions_no_type_with_suggestion_renders_add_mapping_button(self):
+ """A No Type row with a type_suggestion gets an "Add Mapping" link to moduletypemapping_add."""
+ device = MagicMock()
+ device.pk = 55
+ table = self._make_table(device=device)
+ table.server_key = "production"
+ table.return_url = "/dcim/devices/55/librenms-sync/?tab=modules"
+ record = {
+ "status": "No Type",
+ "type_suggestion": {
+ "librenms_model": "SFP-10G-SR",
+ "description": "Auto-suggested: maps LibreNMS model 'SFP-10G-SR' to a NetBox ModuleType.",
+ },
+ }
+ with patch(
+ "netbox_librenms_plugin.tables.modules.reverse",
+ return_value="/plugins/librenms/module-type-mappings/add/",
+ ):
+ result = str(table.render_actions("", record))
+ assert "Add Mapping" in result
+ assert "librenms_model=" in result
+ assert "return_url=" in result
+
+ def test_render_actions_no_type_without_suggestion_omits_add_mapping_button(self):
+ """No type_suggestion on a No Type row β no "Add Mapping" button."""
+ device = MagicMock()
+ device.pk = 56
+ table = self._make_table(device=device)
+ record = {"status": "No Type"}
+ with patch("netbox_librenms_plugin.tables.modules.reverse", return_value="/x/"):
+ result = str(table.render_actions("", record))
+ assert "Add Mapping" not in result
+
+ def test_render_actions_no_type_add_mapping_not_shown_for_other_statuses(self):
+ """type_suggestion on a non-No-Type row must not render the Add Mapping button."""
+ device = MagicMock()
+ device.pk = 57
+ table = self._make_table(device=device)
+ record = {
+ "status": "Matched",
+ "type_suggestion": {
+ "librenms_model": "SFP-10G-SR",
+ "description": "should be ignored",
+ },
+ }
+ with patch("netbox_librenms_plugin.tables.modules.reverse", return_value="/x/"):
+ result = str(table.render_actions("", record))
+ assert "Add Mapping" not in result
+
+ def test_render_actions_no_type_with_module_type_create_renders_add_module_type_button(self):
+ """A No Type row with a `module_type_create` prefill gets an "Add Module Type" link to dcim:moduletype_add."""
+ device = MagicMock()
+ device.pk = 58
+ table = self._make_table(device=device)
+ table.return_url = "/dcim/devices/58/librenms-sync/?tab=modules"
+ record = {
+ "status": "No Type",
+ "module_type_create": {
+ "manufacturer": 7,
+ "model": "X2-10GB-LR",
+ "part_number": "X2-10GB-LR",
+ "description": "10Gbase-LR",
+ },
+ }
+
+ def _reverse(name):
+ return {
+ "plugins:netbox_librenms_plugin:moduletypemapping_add": "/plugins/librenms/module-type-mappings/add/",
+ "dcim:moduletype_add": "/dcim/module-types/add/",
+ }[name]
+
+ with patch("netbox_librenms_plugin.tables.modules.reverse", side_effect=_reverse):
+ result = str(table.render_actions("", record))
+ assert "Add Module Type" in result
+ assert "/dcim/module-types/add/" in result
+ assert "manufacturer=7" in result
+ assert "model=X2-10GB-LR" in result
+ assert "part_number=X2-10GB-LR" in result
+ assert "description=10Gbase-LR" in result
+ assert "return_url=" in result
+
+ def test_render_actions_no_type_omits_module_type_button_when_no_prefill(self):
+ """Without a `module_type_create` prefill, the Add Module Type button must not render."""
+ device = MagicMock()
+ device.pk = 59
+ table = self._make_table(device=device)
+ record = {"status": "No Type"}
+ with patch("netbox_librenms_plugin.tables.modules.reverse", return_value="/x/"):
+ result = str(table.render_actions("", record))
+ assert "Add Module Type" not in result
+
+ def test_render_actions_module_type_button_skipped_for_other_statuses(self):
+ """`module_type_create` on a non-No-Type row must not produce the button."""
+ device = MagicMock()
+ device.pk = 60
+ table = self._make_table(device=device)
+ record = {
+ "status": "Matched",
+ "module_type_create": {"model": "X", "part_number": "X"},
+ }
+ with patch("netbox_librenms_plugin.tables.modules.reverse", return_value="/x/"):
+ result = str(table.render_actions("", record))
+ assert "Add Module Type" not in result
+
+ def test_render_actions_module_type_button_skips_blank_prefill_values(self):
+ """Empty prefill values must be dropped from the querystring (no `=&` artefacts)."""
+ device = MagicMock()
+ device.pk = 61
+ table = self._make_table(device=device)
+ record = {
+ "status": "No Type",
+ "module_type_create": {
+ "model": "GLC-T",
+ "part_number": "GLC-T",
+ "description": "",
+ "manufacturer": None,
+ },
+ }
+ with patch("netbox_librenms_plugin.tables.modules.reverse", return_value="/dcim/module-types/add/"):
+ result = str(table.render_actions("", record))
+ assert "Add Module Type" in result
+ assert "description=" not in result
+ assert "manufacturer=" not in result
+ assert "model=GLC-T" in result
+
+ def test_render_actions_module_type_button_skipped_when_user_lacks_add_moduletype_perm(self):
+ """Without `dcim.add_moduletype`, the Add Module Type CTA must be hidden β clicking
+ it would surface only a permission error from NetBox's native form."""
+ device = MagicMock()
+ device.pk = 62
+ table = self._make_table(device=device, can_add_module_type=False)
+ record = {
+ "status": "No Type",
+ "module_type_create": {"model": "X", "part_number": "X"},
+ }
+ with patch("netbox_librenms_plugin.tables.modules.reverse", return_value="/dcim/module-types/add/"):
+ result = str(table.render_actions("", record))
+ assert "Add Module Type" not in result
+
+
+# ---------------------------------------------------------------------------
+# Integrated badge + action gating
+# ---------------------------------------------------------------------------
+
+
+class TestRenderIntegrated(TestLibreNMSModuleTable):
+ def test_render_status_integrated_uses_muted_badge_with_parent_name(self):
+ table = self._make_table()
+ record = {
+ "status": "Integrated",
+ "integrated_in_name": "XIOM 2/x1",
+ }
+ html = str(table.render_status("Integrated", record))
+ assert "Integrated in XIOM 2/x1" in html
+ # muted styling
+ assert "text-muted" in html or "bg-light" in html
+ # tooltip explains the dedupe
+ assert "Duplicate SNMP entry" in html
+
+ def test_render_actions_integrated_returns_empty(self):
+ device = MagicMock()
+ device.pk = 99
+ table = self._make_table(device=device)
+ record = {
+ "status": "Integrated",
+ "integrated_in_name": "XIOM 2/x1",
+ # Even if a stale type_suggestion / module_type_create slipped in,
+ # actions must still be empty for Integrated rows.
+ "type_suggestion": {"librenms_model": "X", "description": "y"},
+ "module_type_create": {"model": "X", "part_number": "X"},
+ }
+ with patch("netbox_librenms_plugin.tables.modules.reverse", return_value="/x/"):
+ assert table.render_actions("", record) == ""
diff --git a/netbox_librenms_plugin/tests/test_unique_constraints.py b/netbox_librenms_plugin/tests/test_unique_constraints.py
new file mode 100644
index 0000000000..aa6c42bec9
--- /dev/null
+++ b/netbox_librenms_plugin/tests/test_unique_constraints.py
@@ -0,0 +1,78 @@
+"""
+Regression tests for nullable-manufacturer UniqueConstraint splits (issue #71).
+
+PostgreSQL treats NULL β NULL, so a single UniqueConstraint that includes a
+nullable FK does not actually enforce uniqueness for "global" rows where the
+FK is NULL. NetBox 4.2 still supports PostgreSQL 12-14, so we cannot use
+``UniqueConstraint(..., nulls_distinct=False)`` (PG 15+ / Django 5.2+) and
+must split into a pair of conditional constraints instead.
+
+These tests pin the structure so a future refactor cannot silently revert
+to the unsafe single-constraint form.
+"""
+
+from django.db.models import Q, UniqueConstraint
+
+
+def _condition_keys(constraint):
+ """Return the dict of (field__lookup -> value) tuples used in the Q tree."""
+ if not isinstance(constraint, UniqueConstraint):
+ return None
+ cond = constraint.condition
+ if not isinstance(cond, Q):
+ return None
+ return dict(cond.children)
+
+
+class TestModuleBayMappingUniqueConstraints:
+ def test_split_into_two_conditional_constraints(self):
+ from netbox_librenms_plugin.models import ModuleBayMapping
+
+ constraints = [c for c in ModuleBayMapping._meta.constraints if isinstance(c, UniqueConstraint)]
+ assert len(constraints) == 2
+
+ conditions = [_condition_keys(c) for c in constraints]
+ assert {"manufacturer__isnull": True} in conditions
+ assert {"manufacturer__isnull": False} in conditions
+
+ def test_global_constraint_excludes_manufacturer_field(self):
+ from netbox_librenms_plugin.models import ModuleBayMapping
+
+ found = False
+ for c in ModuleBayMapping._meta.constraints:
+ if not isinstance(c, UniqueConstraint):
+ continue
+ if _condition_keys(c) == {"manufacturer__isnull": True}:
+ found = True
+ assert "manufacturer" not in c.fields
+ assert "librenms_name" in c.fields
+ assert "librenms_class" in c.fields
+ break
+ assert found, "Expected manufacturer__isnull=True constraint was not found"
+
+
+class TestCarrierAutoInstallRuleUniqueConstraints:
+ def test_split_into_two_conditional_constraints(self):
+ from netbox_librenms_plugin.models import CarrierAutoInstallRule
+
+ constraints = [c for c in CarrierAutoInstallRule._meta.constraints if isinstance(c, UniqueConstraint)]
+ assert len(constraints) == 2
+
+ conditions = [_condition_keys(c) for c in constraints]
+ assert {"manufacturer__isnull": True} in conditions
+ assert {"manufacturer__isnull": False} in conditions
+
+ def test_global_constraint_excludes_manufacturer_field(self):
+ from netbox_librenms_plugin.models import CarrierAutoInstallRule
+
+ found = False
+ for c in CarrierAutoInstallRule._meta.constraints:
+ if not isinstance(c, UniqueConstraint):
+ continue
+ if _condition_keys(c) == {"manufacturer__isnull": True}:
+ found = True
+ assert "manufacturer" not in c.fields
+ assert "librenms_child_class" in c.fields
+ assert "netbox_bay_name_pattern" in c.fields
+ break
+ assert found, "Expected manufacturer__isnull=True constraint was not found"
diff --git a/netbox_librenms_plugin/tests/test_utils.py b/netbox_librenms_plugin/tests/test_utils.py
index 79268ab752..1feac25036 100644
--- a/netbox_librenms_plugin/tests/test_utils.py
+++ b/netbox_librenms_plugin/tests/test_utils.py
@@ -72,6 +72,23 @@ def test_match_device_type_not_found(self, mock_device_type, mock_dtm):
assert result["device_type"] is None
assert result["match_type"] is None
+ @patch("netbox_librenms_plugin.models.DeviceTypeMapping", create=True)
+ def test_match_device_type_mapping_match(self, mock_dtm):
+ """DeviceTypeMapping entry should be used before part_number/model fallback."""
+ mock_dt = MagicMock(id=1, model="MX480")
+ mock_mapping_obj = MagicMock(netbox_device_type=mock_dt)
+ mock_dtm.DoesNotExist = Exception
+ mock_dtm.objects.get.return_value = mock_mapping_obj
+
+ from netbox_librenms_plugin.utils import match_librenms_hardware_to_device_type
+
+ result = match_librenms_hardware_to_device_type("Juniper MX480 Internet Backbone Router")
+
+ assert result["matched"] is True
+ assert result["device_type"] == mock_dt
+ assert result["match_type"] == "mapping"
+ mock_dtm.objects.get.assert_called_once_with(librenms_hardware__iexact="Juniper MX480 Internet Backbone Router")
+
def test_match_device_type_empty_hardware(self):
"""Empty string returns None."""
from netbox_librenms_plugin.utils import match_librenms_hardware_to_device_type
@@ -197,11 +214,14 @@ def test_find_site_for_location_dash(self):
class TestPlatformMatching:
"""Test platform matching logic."""
+ @patch("netbox_librenms_plugin.models.PlatformMapping")
@patch("dcim.models.Platform")
- def test_find_platform_for_os_exact_match(self, mock_platform_model):
+ def test_find_platform_for_os_exact_match(self, mock_platform_model, mock_platform_mapping):
"""OS string matched to platform."""
mock_platform = MagicMock(id=1, name="ios")
mock_platform_model.objects.get.return_value = mock_platform
+ mock_platform_mapping.DoesNotExist = Exception
+ mock_platform_mapping.objects.get.side_effect = mock_platform_mapping.DoesNotExist
from netbox_librenms_plugin.utils import find_matching_platform
@@ -210,10 +230,16 @@ def test_find_platform_for_os_exact_match(self, mock_platform_model):
assert result["found"] is True
assert result["platform"] == mock_platform
assert result["match_type"] == "exact"
+ # Exact name matched β PlatformMapping is never consulted
+ mock_platform_mapping.objects.get.assert_not_called()
+ mock_platform_model.objects.get.assert_called_once_with(name__iexact="ios")
+ @patch("netbox_librenms_plugin.models.PlatformMapping")
@patch("dcim.models.Platform")
- def test_find_platform_for_os_not_found(self, mock_platform_model):
+ def test_find_platform_for_os_not_found(self, mock_platform_model, mock_platform_mapping):
"""Returns None when no match."""
+ mock_platform_mapping.DoesNotExist = Exception
+ mock_platform_mapping.objects.get.side_effect = mock_platform_mapping.DoesNotExist
mock_platform_model.DoesNotExist = Exception
mock_platform_model.objects.get.side_effect = mock_platform_model.DoesNotExist
@@ -223,6 +249,8 @@ def test_find_platform_for_os_not_found(self, mock_platform_model):
assert result["found"] is False
assert result["platform"] is None
+ mock_platform_mapping.objects.get.assert_called_once_with(librenms_os__iexact="unknown_os")
+ mock_platform_model.objects.get.assert_called_once_with(name__iexact="unknown_os")
def test_find_platform_for_os_empty(self):
"""Empty OS returns None."""
@@ -458,6 +486,58 @@ def test_get_librenms_sync_device_dict_for_different_server_falls_through(self):
assert result == member_a
+ def test_get_librenms_sync_device_fallback_to_member_with_ip(self):
+ """Priority 3: no dict member, master has no IP, another member has primary IP β that member."""
+ from netbox_librenms_plugin.utils import get_librenms_sync_device
+
+ vc = MagicMock()
+ master = MagicMock()
+ master.vc_position = 1
+ master.virtual_chassis = vc
+ master.cf = {}
+ master.primary_ip = None # master has no IP
+
+ member_with_ip = MagicMock()
+ member_with_ip.vc_position = 2
+ member_with_ip.cf = {}
+ member_with_ip.primary_ip = MagicMock() # this member has IP
+
+ vc.master = master # designated master exists but has no primary_ip
+ vc.members.all.return_value = [master, member_with_ip]
+
+ result = get_librenms_sync_device(master, server_key="prod")
+
+ assert result == member_with_ip
+
+ def test_get_librenms_sync_device_fallback_lowest_vc_position(self):
+ """Priority 4: no IPs anywhere β return member with lowest vc_position."""
+ from netbox_librenms_plugin.utils import get_librenms_sync_device
+
+ vc = MagicMock()
+ member_pos3 = MagicMock()
+ member_pos3.vc_position = 3
+ member_pos3.cf = {}
+ member_pos3.primary_ip = None
+
+ member_pos1 = MagicMock()
+ member_pos1.vc_position = 1
+ member_pos1.cf = {}
+ member_pos1.primary_ip = None
+
+ member_pos2 = MagicMock()
+ member_pos2.vc_position = 2
+ member_pos2.cf = {}
+ member_pos2.primary_ip = None
+
+ vc.master = None
+ vc.members.all.return_value = [member_pos3, member_pos1, member_pos2] # unordered
+
+ member_pos2.virtual_chassis = vc
+
+ result = get_librenms_sync_device(member_pos2, server_key="prod")
+
+ assert result == member_pos1 # lowest vc_position wins
+
def test_zero_id_is_not_a_valid_librenms_id(self):
"""LibreNMS uses MySQL auto-increment IDs starting at 1; device_id=0 cannot exist.
A member whose resolved ID is 0 must be skipped so a real ID is preferred."""
diff --git a/netbox_librenms_plugin/tests/test_view_wiring.py b/netbox_librenms_plugin/tests/test_view_wiring.py
index baa7b0d1a6..9591741fdd 100644
--- a/netbox_librenms_plugin/tests/test_view_wiring.py
+++ b/netbox_librenms_plugin/tests/test_view_wiring.py
@@ -65,6 +65,11 @@ def test_assign_vc_serial_has_librenms_api_mixin(self):
self._assert_has_api_mixin(AssignVCSerialView)
+ def test_convert_legacy_id_has_librenms_api_mixin(self):
+ from netbox_librenms_plugin.views.sync.device_fields import ConvertLegacyLibreNMSIdView
+
+ self._assert_has_api_mixin(ConvertLegacyLibreNMSIdView)
+
class TestCacheMixinWiring:
"""Views that cache LibreNMS data must have CacheMixin and expose get_cache_key."""
@@ -196,6 +201,18 @@ def test_update_device_serial_has_required_object_permissions(self):
self._assert_has_mixins(UpdateDeviceSerialView)
assert "POST" in UpdateDeviceSerialView.required_object_permissions
+ def test_remove_server_mapping_has_required_object_permissions(self):
+ from netbox_librenms_plugin.views.sync.device_fields import RemoveServerMappingView
+
+ self._assert_has_mixins(RemoveServerMappingView)
+ assert "POST" in RemoveServerMappingView.required_object_permissions
+
+ def test_convert_legacy_id_has_required_object_permissions(self):
+ from netbox_librenms_plugin.views.sync.device_fields import ConvertLegacyLibreNMSIdView
+
+ self._assert_has_mixins(ConvertLegacyLibreNMSIdView)
+ assert "POST" in ConvertLegacyLibreNMSIdView.required_object_permissions
+
def test_delete_interfaces_has_required_object_permissions(self):
from dcim.models import Interface
from virtualization.models import VMInterface
@@ -235,10 +252,15 @@ class DummyView(LibreNMSAPIMixin):
assert dummy._librenms_api is None
def test_sync_interfaces_has_librenms_api_property_via_class(self):
- """SyncInterfacesView must expose librenms_api through its MRO."""
- from netbox_librenms_plugin.views.sync.interfaces import SyncInterfacesView
+ """BaseLibreNMSSyncView must expose librenms_api through its MRO.
+
+ SyncInterfacesView gains LibreNMSAPIMixin in the view-fixes PR; on the
+ current upstream/develop baseline we verify the property via
+ BaseLibreNMSSyncView, which inherits the mixin unconditionally.
+ """
+ from netbox_librenms_plugin.views.base.librenms_sync_view import BaseLibreNMSSyncView
- assert any("librenms_api" in vars(cls) for cls in SyncInterfacesView.__mro__)
+ assert any("librenms_api" in vars(cls) for cls in BaseLibreNMSSyncView.__mro__)
# ββ Template syntax smoke tests ββββββββββββββββββββββββββββββββββββββββββββββ
diff --git a/netbox_librenms_plugin/tests/test_vm_operations.py b/netbox_librenms_plugin/tests/test_vm_operations.py
index 6a64950e89..6fe449ed1c 100644
--- a/netbox_librenms_plugin/tests/test_vm_operations.py
+++ b/netbox_librenms_plugin/tests/test_vm_operations.py
@@ -1,5 +1,4 @@
-"""
-Tests for netbox_librenms_plugin.import_utils.vm_operations module.
+"""Tests for netbox_librenms_plugin.import_utils.vm_operations module.
Covers create_vm_from_librenms and bulk_import_vms.
All DB interactions are mocked β no @pytest.mark.django_db used.
@@ -12,6 +11,18 @@
class TestCreateVmFromLibrenms:
"""Tests for create_vm_from_librenms function."""
+ @pytest.fixture(autouse=True)
+ def _patch_atomic(self):
+ """transaction.atomic() is a no-op; tests mock all DB interactions."""
+ from contextlib import contextmanager
+
+ @contextmanager
+ def noop_atomic(*args, **kwargs):
+ yield
+
+ with patch("netbox_librenms_plugin.import_utils.vm_operations.transaction.atomic", noop_atomic):
+ yield
+
def test_success_with_computed_name(self):
"""VM is created using pre-computed _computed_name when present."""
from netbox_librenms_plugin.import_utils.vm_operations import create_vm_from_librenms
@@ -32,10 +43,7 @@ def test_success_with_computed_name(self):
mock_vm.name = "vm01-computed"
mock_vm.pk = 10
- with (
- patch("django.db.transaction.atomic"),
- patch("virtualization.models.VirtualMachine") as mock_vm_class,
- ):
+ with patch("virtualization.models.VirtualMachine") as mock_vm_class:
mock_vm_class.objects.create.return_value = mock_vm
result = create_vm_from_librenms(libre_device, validation)
@@ -64,7 +72,6 @@ def test_fallback_to_determine_device_name_when_no_computed_name(self):
"netbox_librenms_plugin.import_utils.vm_operations._determine_device_name",
return_value="vm02-determined",
) as mock_det,
- patch("django.db.transaction.atomic"),
patch("virtualization.models.VirtualMachine") as mock_vm_class,
):
mock_vm_class.objects.create.return_value = mock_vm
@@ -106,16 +113,15 @@ def test_server_key_stored_in_custom_field(self):
mock_vm.custom_field_data = {}
with patch("virtualization.models.VirtualMachine") as mock_vm_class:
- with patch("django.db.transaction.atomic"):
- with patch("netbox_librenms_plugin.utils.set_librenms_device_id") as mock_setter:
- mock_vm_class.objects.create.return_value = mock_vm
- create_vm_from_librenms(libre_device, validation, server_key="secondary")
+ with patch("netbox_librenms_plugin.utils.set_librenms_device_id") as mock_setter:
+ mock_vm_class.objects.create.return_value = mock_vm
+ create_vm_from_librenms(libre_device, validation, server_key="secondary")
mock_setter.assert_called_once_with(mock_vm, 5, "secondary")
mock_vm.save.assert_called_once()
- def test_role_is_passed_to_create(self):
- """Optional role parameter is forwarded to VirtualMachine.objects.create."""
+ def test_role_is_read_from_validation(self):
+ """Role is read from validation[device_role] and forwarded to VirtualMachine.objects.create."""
from netbox_librenms_plugin.import_utils.vm_operations import create_vm_from_librenms
libre_device = {"device_id": 6, "hostname": "vm06", "_computed_name": "vm06"}
@@ -124,17 +130,15 @@ def test_role_is_passed_to_create(self):
"can_import": True,
"cluster": {"cluster": MagicMock()},
"platform": {"platform": None},
+ "device_role": {"role": mock_role},
}
mock_vm = MagicMock()
mock_vm.name = "vm06"
mock_vm.pk = 60
- with (
- patch("django.db.transaction.atomic"),
- patch("virtualization.models.VirtualMachine") as mock_vm_class,
- ):
+ with patch("virtualization.models.VirtualMachine") as mock_vm_class:
mock_vm_class.objects.create.return_value = mock_vm
- create_vm_from_librenms(libre_device, validation, role=mock_role)
+ create_vm_from_librenms(libre_device, validation)
call_kwargs = mock_vm_class.objects.create.call_args[1]
assert call_kwargs["role"] == mock_role
@@ -153,10 +157,7 @@ def test_platform_none_when_not_in_validation(self):
mock_vm.name = "vm07"
mock_vm.pk = 70
- with (
- patch("django.db.transaction.atomic"),
- patch("virtualization.models.VirtualMachine") as mock_vm_class,
- ):
+ with patch("virtualization.models.VirtualMachine") as mock_vm_class:
mock_vm_class.objects.create.return_value = mock_vm
create_vm_from_librenms(libre_device, validation)
@@ -164,7 +165,7 @@ def test_platform_none_when_not_in_validation(self):
assert call_kwargs["platform"] is None
def test_import_comment_contains_device_id(self):
- """The comments field contains a reference to LibreNMS and device_id."""
+ """The comments field contains a reference to LibreNMS."""
from netbox_librenms_plugin.import_utils.vm_operations import create_vm_from_librenms
libre_device = {"device_id": 8, "hostname": "vm08", "_computed_name": "vm08"}
@@ -177,15 +178,13 @@ def test_import_comment_contains_device_id(self):
mock_vm.name = "vm08"
mock_vm.pk = 80
- with (
- patch("django.db.transaction.atomic"),
- patch("virtualization.models.VirtualMachine") as mock_vm_class,
- ):
+ with patch("virtualization.models.VirtualMachine") as mock_vm_class:
mock_vm_class.objects.create.return_value = mock_vm
create_vm_from_librenms(libre_device, validation)
call_kwargs = mock_vm_class.objects.create.call_args[1]
assert "LibreNMS" in call_kwargs["comments"]
+ assert "netbox-librenms-plugin" in call_kwargs["comments"]
assert str(libre_device["device_id"]) in call_kwargs["comments"]
@@ -291,6 +290,8 @@ def test_success_path_vm_created(self):
mock_vm = MagicMock()
mock_vm.name = "new-vm"
+ mock_create_vm = MagicMock(return_value=mock_vm)
+
with (
patch("netbox_librenms_plugin.import_utils.vm_operations.require_permissions"),
patch(
@@ -307,7 +308,7 @@ def test_success_path_vm_created(self):
),
patch(
"netbox_librenms_plugin.import_utils.vm_operations.create_vm_from_librenms",
- return_value=mock_vm,
+ mock_create_vm,
),
patch("netbox_librenms_plugin.import_utils.vm_operations.Cluster"),
patch("netbox_librenms_plugin.import_utils.vm_operations.DeviceRole"),
@@ -321,6 +322,9 @@ def test_success_path_vm_created(self):
assert result["success"][0]["device"] == mock_vm
assert len(result["failed"]) == 0
assert len(result["skipped"]) == 0
+ # Verify api.server_key is forwarded to create_vm_from_librenms
+ call_kwargs = mock_create_vm.call_args[1]
+ assert call_kwargs.get("server_key") == mock_api.server_key
def test_cluster_assignment_applied(self):
"""apply_cluster_to_validation is called when cluster_id is provided and found."""
@@ -468,36 +472,6 @@ def _cancelled(job):
# VMs 1-4 added to failed; 5th cancelled before processing
assert len(result["failed"]) == 4
- def test_job_cancellation_with_errored_status(self):
- """Loop also exits when _is_job_cancelled returns True (rq_job.is_failed)."""
- from netbox_librenms_plugin.import_utils.vm_operations import bulk_import_vms
-
- mock_api = MagicMock()
- mock_api.server_key = "default"
-
- mock_job = MagicMock()
- mock_job.logger = MagicMock()
-
- cancel_calls = [0]
-
- def _cancelled(job):
- cancel_calls[0] += 1
- return cancel_calls[0] >= 2
-
- vm_imports = {i: {} for i in range(1, 6)}
-
- with (
- patch("netbox_librenms_plugin.import_utils.vm_operations.require_permissions"),
- patch("netbox_librenms_plugin.import_utils.vm_operations._is_job_cancelled", side_effect=_cancelled),
- patch(
- "netbox_librenms_plugin.import_utils.vm_operations.fetch_device_with_cache",
- return_value=None,
- ),
- ):
- result = bulk_import_vms(vm_imports, mock_api, job=mock_job)
-
- assert len(result["failed"]) == 4
-
def test_user_extracted_from_job_when_not_provided(self):
"""User is extracted from job.job.user when the user param is None."""
from netbox_librenms_plugin.import_utils.vm_operations import bulk_import_vms
@@ -552,6 +526,7 @@ def test_sync_options_use_sysname_and_strip_domain_forwarded(self):
call_kwargs = mock_validate.call_args[1]
assert call_kwargs["use_sysname"] is False
assert call_kwargs["strip_domain"] is True
+ assert call_kwargs["server_key"] == mock_api.server_key
def test_no_cluster_id_skips_cluster_lookup(self):
"""Cluster lookup is skipped when cluster_id is absent from vm_mappings."""
@@ -639,21 +614,10 @@ def test_job_log_info_when_not_cancelled_at_checkpoint(self):
mock_api = MagicMock()
mock_api.server_key = "default"
- # Status is "running" at first checkpoint (idx=5), "failed" at second (idx=10)
- statuses = iter(["running", "running", "failed"])
mock_job = MagicMock()
mock_job.logger = MagicMock()
- mock_job.job.status = "running"
-
- def _refresh():
- try:
- mock_job.job.status = next(statuses)
- except StopIteration:
- mock_job.job.status = "failed"
-
- mock_job.job.refresh_from_db.side_effect = _refresh
- # 10 VMs: checkpoint at idx=5 (running β log.info) and idx=10 (failed β break)
+ # 10 VMs: not cancelled at idx=1 and idx=5 checkpoints, cancelled at idx=10
vm_imports = {i: {} for i in range(1, 11)}
with (
@@ -662,8 +626,107 @@ def _refresh():
"netbox_librenms_plugin.import_utils.vm_operations.fetch_device_with_cache",
return_value=None,
),
+ patch(
+ "netbox_librenms_plugin.import_utils.vm_operations._is_job_cancelled",
+ side_effect=[False, False, True],
+ ),
):
bulk_import_vms(vm_imports, mock_api, job=mock_job)
- # log.info called at idx=5 checkpoint
- mock_job.logger.info.assert_called()
+ # log.info called for non-cancelled checkpoint iterations
+ mock_job.logger.info.assert_any_call("Processing VM 1 of 10")
+ mock_job.logger.info.assert_any_call("Processing VM 5 of 10")
+
+
+# ===========================================================================
+# Issue #34 β warnings when cluster/role FK lookup fails
+# ===========================================================================
+
+
+class TestMissingFKWarnings:
+ """#34: bulk_import_vms must fail device when a selected cluster or role no longer exists."""
+
+ def _run_bulk_with_mappings(self, vm_mappings, mock_cluster_result, mock_role_result):
+ """Helper: run bulk_import_vms with one VM and given mapping FK results. Returns (job, result)."""
+ from netbox_librenms_plugin.import_utils.vm_operations import bulk_import_vms
+
+ mock_api = MagicMock()
+ mock_api.server_key = "default"
+ mock_api.cache_timeout = 300
+
+ mock_job = MagicMock()
+ mock_job.logger = MagicMock()
+
+ libre_device = {
+ "device_id": 1,
+ "hostname": "vm01",
+ "_computed_name": "vm01",
+ "sysName": "vm01",
+ "type": "",
+ "os": "",
+ "version": "",
+ }
+
+ with (
+ patch("netbox_librenms_plugin.import_utils.vm_operations.require_permissions"),
+ patch("netbox_librenms_plugin.import_utils.vm_operations._is_job_cancelled", return_value=False),
+ patch(
+ "netbox_librenms_plugin.import_utils.vm_operations.fetch_device_with_cache",
+ return_value=libre_device,
+ ),
+ patch(
+ "netbox_librenms_plugin.import_utils.vm_operations.validate_device_for_import",
+ return_value={
+ "can_import": True,
+ "is_ready": True,
+ "existing_device": None,
+ "cluster": {"cluster": MagicMock()},
+ "platform": {"platform": None},
+ "device_role": {"role": None},
+ "issues": [],
+ },
+ ),
+ patch("netbox_librenms_plugin.import_utils.vm_operations.Cluster") as mock_Cluster,
+ patch("netbox_librenms_plugin.import_utils.vm_operations.DeviceRole") as mock_DeviceRole,
+ patch(
+ "netbox_librenms_plugin.import_utils.vm_operations.create_vm_from_librenms",
+ return_value=MagicMock(),
+ ),
+ ):
+ mock_Cluster.objects.filter.return_value.first.return_value = mock_cluster_result
+ mock_DeviceRole.objects.filter.return_value.first.return_value = mock_role_result
+ result = bulk_import_vms({1: vm_mappings}, mock_api, job=mock_job)
+ return mock_job, result
+
+ def test_warning_logged_when_cluster_deleted(self):
+ """Device fails when cluster_id is set but cluster no longer exists."""
+ _mock_job, result = self._run_bulk_with_mappings(
+ vm_mappings={"cluster_id": 99, "device_role_id": None},
+ mock_cluster_result=None,
+ mock_role_result=None,
+ )
+ assert len(result["failed"]) == 1, f"Expected 1 failed entry but got: {result['failed']}"
+ error_msg = result["failed"][0]["error"].lower()
+ assert "cluster" in error_msg, f"Expected 'cluster' in error message but got: {error_msg}"
+
+ def test_warning_logged_when_role_deleted(self):
+ """Device fails when role_id is set but role no longer exists."""
+ _mock_job, result = self._run_bulk_with_mappings(
+ vm_mappings={"cluster_id": None, "device_role_id": 55},
+ mock_cluster_result=None,
+ mock_role_result=None,
+ )
+ assert len(result["failed"]) == 1, f"Expected 1 failed entry but got: {result['failed']}"
+ error_msg = result["failed"][0]["error"].lower()
+ assert "role" in error_msg, f"Expected 'role' in error message but got: {error_msg}"
+
+ def test_no_warning_when_cluster_found(self):
+ """No failure when cluster exists and VM creation is attempted."""
+ mock_cluster = MagicMock()
+ _mock_job, result = self._run_bulk_with_mappings(
+ vm_mappings={"cluster_id": 99, "device_role_id": None},
+ mock_cluster_result=mock_cluster,
+ mock_role_result=None,
+ )
+ assert result["failed"] == [], f"Expected no failures but got: {result['failed']}"
+ assert len(result["success"]) == 1, f"Expected 1 success entry but got: {result['success']}"
diff --git a/netbox_librenms_plugin/urls.py b/netbox_librenms_plugin/urls.py
index 7634e130b8..0cd63903e3 100644
--- a/netbox_librenms_plugin/urls.py
+++ b/netbox_librenms_plugin/urls.py
@@ -1,12 +1,39 @@
from django.urls import include, path
-from .models import InterfaceTypeMapping
+from .models import (
+ CarrierAutoInstallRule,
+ DeviceTypeMapping,
+ InterfaceTypeMapping,
+ InventoryIgnoreRule,
+ ModuleBayMapping,
+ ModuleTypeMapping,
+ NormalizationRule,
+ PlatformMapping,
+)
from .views import (
AddDeviceToLibreNMSView,
+ AddAsOOBView,
+ AddDeviceTypeMappingView,
+ AddPlatformMappingView,
+ PromoteToHostView,
+ MergeNetBoxDevicesView,
+ MoveInterfaceToWinnerView,
+ MoveIPAddressToWinnerView,
+ TransferDeviceIPView,
AssignVCSerialView,
BulkImportConfirmView,
BulkImportDevicesView,
+ CarrierAutoInstallRuleBulkDeleteView,
+ CarrierAutoInstallRuleBulkExportYAMLView,
+ CarrierAutoInstallRuleBulkImportView,
+ CarrierAutoInstallRuleChangeLogView,
+ CarrierAutoInstallRuleCreateView,
+ CarrierAutoInstallRuleDeleteView,
+ CarrierAutoInstallRuleEditView,
+ CarrierAutoInstallRuleListView,
+ CarrierAutoInstallRuleView,
CreateAndAssignPlatformView,
+ CreatePlatformFromImportView,
DeleteNetBoxInterfacesView,
DeviceCableTableView,
DeviceClusterUpdateView,
@@ -14,12 +41,29 @@
DeviceInterfaceTableView,
DeviceIPAddressTableView,
DeviceLibreNMSSyncView,
+ DeviceModuleTableView,
DeviceRackUpdateView,
DeviceRoleUpdateView,
DeviceStatusListView,
+ DeviceTypeMappingBulkDeleteView,
+ DeviceTypeMappingBulkImportView,
+ DeviceTypeMappingChangeLogView,
+ DeviceTypeMappingCreateView,
+ DeviceTypeMappingDeleteView,
+ DeviceTypeMappingEditView,
+ DeviceTypeMappingListView,
+ DeviceTypeMappingView,
DeviceValidationDetailsView,
DeviceVCDetailsView,
DeviceVLANTableView,
+ InstallBranchView,
+ InstallModuleView,
+ InstallSelectedView,
+ ModuleMismatchPreviewView,
+ MoveModuleView,
+ ReplaceModuleView,
+ UpdateModuleSerialView,
+ AddBayTemplateView,
InterfaceTypeMappingBulkDeleteView,
InterfaceTypeMappingBulkImportView,
InterfaceTypeMappingChangeLogView,
@@ -30,10 +74,58 @@
InterfaceTypeMappingView,
LibreNMSImportView,
LibreNMSSettingsView,
+ ModuleBayMappingBulkDeleteView,
+ ModuleBayMappingBulkImportView,
+ ModuleBayMappingChangeLogView,
+ ModuleBayMappingCreateView,
+ ModuleBayMappingDeleteView,
+ ModuleBayMappingEditView,
+ ModuleBayMappingListView,
+ ModuleBayMappingView,
+ ModuleTypeMappingBulkDeleteView,
+ ModuleTypeMappingBulkImportView,
+ ModuleTypeMappingChangeLogView,
+ ModuleTypeMappingCreateView,
+ ModuleTypeMappingDeleteView,
+ ModuleTypeMappingEditView,
+ ModuleTypeMappingListView,
+ ModuleTypeMappingView,
+ NormalizationRuleBulkDeleteView,
+ NormalizationRuleBulkImportView,
+ NormalizationRuleChangeLogView,
+ NormalizationRuleCreateView,
+ NormalizationRuleDeleteView,
+ NormalizationRuleEditView,
+ NormalizationRuleListView,
+ NormalizationRuleView,
+ InventoryIgnoreRuleBulkDeleteView,
+ InventoryIgnoreRuleBulkImportView,
+ InventoryIgnoreRuleChangeLogView,
+ InventoryIgnoreRuleCreateView,
+ InventoryIgnoreRuleDeleteView,
+ InventoryIgnoreRuleEditView,
+ InventoryIgnoreRuleListView,
+ InventoryIgnoreRuleView,
+ DeviceTypeMappingBulkExportYAMLView,
+ InterfaceTypeMappingBulkExportYAMLView,
+ ModuleBayMappingBulkExportYAMLView,
+ ModuleTypeMappingBulkExportYAMLView,
+ NormalizationRuleBulkExportYAMLView,
+ InventoryIgnoreRuleBulkExportYAMLView,
+ PlatformMappingBulkDeleteView,
+ PlatformMappingBulkExportYAMLView,
+ PlatformMappingBulkImportView,
+ PlatformMappingChangeLogView,
+ PlatformMappingCreateView,
+ PlatformMappingDeleteView,
+ PlatformMappingEditView,
+ PlatformMappingListView,
+ PlatformMappingView,
RemoveServerMappingView,
SaveUserPrefView,
SingleCableVerifyView,
SingleInterfaceVerifyView,
+ SingleModuleVerifyView,
SingleIPAddressVerifyView,
SaveVlanGroupOverridesView,
SingleVlanGroupVerifyView,
@@ -73,6 +165,51 @@
DeviceCableTableView.as_view(),
name="device_cable_sync",
),
+ path(
+ "devices//module-sync/",
+ DeviceModuleTableView.as_view(),
+ name="device_module_sync",
+ ),
+ path(
+ "devices//install-module/",
+ InstallModuleView.as_view(),
+ name="install_module",
+ ),
+ path(
+ "devices//install-branch/",
+ InstallBranchView.as_view(),
+ name="install_branch",
+ ),
+ path(
+ "devices//install-selected/",
+ InstallSelectedView.as_view(),
+ name="install_selected",
+ ),
+ path(
+ "devices//update-module-serial/",
+ UpdateModuleSerialView.as_view(),
+ name="update_module_serial",
+ ),
+ path(
+ "devices//module-mismatch-preview/",
+ ModuleMismatchPreviewView.as_view(),
+ name="module_mismatch_preview",
+ ),
+ path(
+ "devices//replace-module/",
+ ReplaceModuleView.as_view(),
+ name="replace_module",
+ ),
+ path(
+ "devices//move-module/",
+ MoveModuleView.as_view(),
+ name="move_module",
+ ),
+ path(
+ "devices//add-bay-template/",
+ AddBayTemplateView.as_view(),
+ name="add_bay_template",
+ ),
path(
"devices//ipaddress-sync/",
DeviceIPAddressTableView.as_view(),
@@ -89,6 +226,11 @@
SingleCableVerifyView.as_view(),
name="verify_cable",
),
+ path(
+ "verify-module/",
+ SingleModuleVerifyView.as_view(),
+ name="verify_module",
+ ),
# Path for single IP address verify javascript call
path(
"verify-ipaddress/",
@@ -254,35 +396,80 @@
name="bulk_import_confirm",
),
path(
- "device-import/validation//",
+ "device-import/validation//",
DeviceValidationDetailsView.as_view(),
name="device_validation_details",
),
path(
- "device-import/vc-details//",
+ "device-import/vc-details//",
DeviceVCDetailsView.as_view(),
name="device_vc_details",
),
path(
- "device-import/role-update//",
+ "device-import/role-update//",
DeviceRoleUpdateView.as_view(),
name="device_role_update",
),
path(
- "device-import/cluster-update//",
+ "device-import/cluster-update//",
DeviceClusterUpdateView.as_view(),
name="device_cluster_update",
),
path(
- "device-import/rack-update//",
+ "device-import/rack-update//",
DeviceRackUpdateView.as_view(),
name="device_rack_update",
),
path(
- "device-import/conflict-action//",
+ "device-import/conflict-action//",
DeviceConflictActionView.as_view(),
name="device_conflict_action",
),
+ path(
+ "device-import/add-as-oob//",
+ AddAsOOBView.as_view(),
+ name="device_add_as_oob",
+ ),
+ path(
+ "device-import/promote-to-host//",
+ PromoteToHostView.as_view(),
+ name="device_promote_to_host",
+ ),
+ path(
+ "device-import/merge-netbox-devices//",
+ MergeNetBoxDevicesView.as_view(),
+ name="device_merge_netbox_devices",
+ ),
+ path(
+ "interface//move-to-winner/",
+ MoveInterfaceToWinnerView.as_view(),
+ name="interface_move_to_winner",
+ ),
+ path(
+ "ipaddress//move-to-winner/",
+ MoveIPAddressToWinnerView.as_view(),
+ name="ipaddress_move_to_winner",
+ ),
+ path(
+ "device//transfer-ip//",
+ TransferDeviceIPView.as_view(),
+ name="device_transfer_ip",
+ ),
+ path(
+ "device-import/add-device-type-mapping//",
+ AddDeviceTypeMappingView.as_view(),
+ name="add_device_type_mapping",
+ ),
+ path(
+ "device-import/create-platform//",
+ CreatePlatformFromImportView.as_view(),
+ name="create_platform_from_import",
+ ),
+ path(
+ "device-import/add-platform-mapping//",
+ AddPlatformMappingView.as_view(),
+ name="add_platform_mapping",
+ ),
path(
"save-user-pref/",
SaveUserPrefView.as_view(),
@@ -347,5 +534,340 @@
InterfaceTypeMappingBulkDeleteView.as_view(),
name="interfacetypemapping_bulk_delete",
),
+ # Device type mapping URLs
+ path(
+ "device-type-mappings/",
+ DeviceTypeMappingListView.as_view(),
+ name="devicetypemapping_list",
+ ),
+ path(
+ "device-type-mappings//",
+ DeviceTypeMappingView.as_view(),
+ name="devicetypemapping_detail",
+ ),
+ path(
+ "device-type-mappings/add/",
+ DeviceTypeMappingCreateView.as_view(),
+ name="devicetypemapping_add",
+ ),
+ path(
+ "device-type-mappings/import/",
+ DeviceTypeMappingBulkImportView.as_view(),
+ name="devicetypemapping_bulk_import",
+ ),
+ path(
+ "device-type-mappings//delete/",
+ DeviceTypeMappingDeleteView.as_view(),
+ name="devicetypemapping_delete",
+ ),
+ path(
+ "device-type-mappings//edit/",
+ DeviceTypeMappingEditView.as_view(),
+ name="devicetypemapping_edit",
+ ),
+ path(
+ "device-type-mappings//changelog/",
+ DeviceTypeMappingChangeLogView.as_view(),
+ name="devicetypemapping_changelog",
+ kwargs={"model": DeviceTypeMapping},
+ ),
+ path(
+ "device-type-mappings/delete/",
+ DeviceTypeMappingBulkDeleteView.as_view(),
+ name="devicetypemapping_bulk_delete",
+ ),
+ # Module type mapping URLs
+ path(
+ "module-type-mappings/",
+ ModuleTypeMappingListView.as_view(),
+ name="moduletypemapping_list",
+ ),
+ path(
+ "module-type-mappings//",
+ ModuleTypeMappingView.as_view(),
+ name="moduletypemapping_detail",
+ ),
+ path(
+ "module-type-mappings/add/",
+ ModuleTypeMappingCreateView.as_view(),
+ name="moduletypemapping_add",
+ ),
+ path(
+ "module-type-mappings/import/",
+ ModuleTypeMappingBulkImportView.as_view(),
+ name="moduletypemapping_bulk_import",
+ ),
+ path(
+ "module-type-mappings//delete/",
+ ModuleTypeMappingDeleteView.as_view(),
+ name="moduletypemapping_delete",
+ ),
+ path(
+ "module-type-mappings//edit/",
+ ModuleTypeMappingEditView.as_view(),
+ name="moduletypemapping_edit",
+ ),
+ path(
+ "module-type-mappings//changelog/",
+ ModuleTypeMappingChangeLogView.as_view(),
+ name="moduletypemapping_changelog",
+ kwargs={"model": ModuleTypeMapping},
+ ),
+ path(
+ "module-type-mappings/delete/",
+ ModuleTypeMappingBulkDeleteView.as_view(),
+ name="moduletypemapping_bulk_delete",
+ ),
+ # Module Bay Mapping URLs
+ path(
+ "module-bay-mappings/",
+ ModuleBayMappingListView.as_view(),
+ name="modulebaymapping_list",
+ ),
+ path(
+ "module-bay-mappings//",
+ ModuleBayMappingView.as_view(),
+ name="modulebaymapping_detail",
+ ),
+ path(
+ "module-bay-mappings/add/",
+ ModuleBayMappingCreateView.as_view(),
+ name="modulebaymapping_add",
+ ),
+ path(
+ "module-bay-mappings/import/",
+ ModuleBayMappingBulkImportView.as_view(),
+ name="modulebaymapping_bulk_import",
+ ),
+ path(
+ "module-bay-mappings//delete/",
+ ModuleBayMappingDeleteView.as_view(),
+ name="modulebaymapping_delete",
+ ),
+ path(
+ "module-bay-mappings//edit/",
+ ModuleBayMappingEditView.as_view(),
+ name="modulebaymapping_edit",
+ ),
+ path(
+ "module-bay-mappings//changelog/",
+ ModuleBayMappingChangeLogView.as_view(),
+ name="modulebaymapping_changelog",
+ kwargs={"model": ModuleBayMapping},
+ ),
+ path(
+ "module-bay-mappings/delete/",
+ ModuleBayMappingBulkDeleteView.as_view(),
+ name="modulebaymapping_bulk_delete",
+ ),
+ # Normalization Rule URLs
+ path(
+ "normalization-rules/",
+ NormalizationRuleListView.as_view(),
+ name="normalizationrule_list",
+ ),
+ path(
+ "normalization-rules//",
+ NormalizationRuleView.as_view(),
+ name="normalizationrule_detail",
+ ),
+ path(
+ "normalization-rules/add/",
+ NormalizationRuleCreateView.as_view(),
+ name="normalizationrule_add",
+ ),
+ path(
+ "normalization-rules/import/",
+ NormalizationRuleBulkImportView.as_view(),
+ name="normalizationrule_bulk_import",
+ ),
+ path(
+ "normalization-rules//delete/",
+ NormalizationRuleDeleteView.as_view(),
+ name="normalizationrule_delete",
+ ),
+ path(
+ "normalization-rules//edit/",
+ NormalizationRuleEditView.as_view(),
+ name="normalizationrule_edit",
+ ),
+ path(
+ "normalization-rules//changelog/",
+ NormalizationRuleChangeLogView.as_view(),
+ name="normalizationrule_changelog",
+ kwargs={"model": NormalizationRule},
+ ),
+ path(
+ "normalization-rules/delete/",
+ NormalizationRuleBulkDeleteView.as_view(),
+ name="normalizationrule_bulk_delete",
+ ),
+ # Inventory Ignore Rule URLs
+ path(
+ "inventory-ignore-rules/",
+ InventoryIgnoreRuleListView.as_view(),
+ name="inventoryignorerule_list",
+ ),
+ path(
+ "inventory-ignore-rules//",
+ InventoryIgnoreRuleView.as_view(),
+ name="inventoryignorerule_detail",
+ ),
+ path(
+ "inventory-ignore-rules/add/",
+ InventoryIgnoreRuleCreateView.as_view(),
+ name="inventoryignorerule_add",
+ ),
+ path(
+ "inventory-ignore-rules/import/",
+ InventoryIgnoreRuleBulkImportView.as_view(),
+ name="inventoryignorerule_bulk_import",
+ ),
+ path(
+ "inventory-ignore-rules//delete/",
+ InventoryIgnoreRuleDeleteView.as_view(),
+ name="inventoryignorerule_delete",
+ ),
+ path(
+ "inventory-ignore-rules//edit/",
+ InventoryIgnoreRuleEditView.as_view(),
+ name="inventoryignorerule_edit",
+ ),
+ path(
+ "inventory-ignore-rules//changelog/",
+ InventoryIgnoreRuleChangeLogView.as_view(),
+ name="inventoryignorerule_changelog",
+ kwargs={"model": InventoryIgnoreRule},
+ ),
+ path(
+ "inventory-ignore-rules/delete/",
+ InventoryIgnoreRuleBulkDeleteView.as_view(),
+ name="inventoryignorerule_bulk_delete",
+ ),
+ # Bulk YAML export URLs for all mapping models
+ path(
+ "interface-type-mappings/export-yaml/",
+ InterfaceTypeMappingBulkExportYAMLView.as_view(),
+ name="interfacetypemapping_bulk_export_yaml",
+ ),
+ path(
+ "device-type-mappings/export-yaml/",
+ DeviceTypeMappingBulkExportYAMLView.as_view(),
+ name="devicetypemapping_bulk_export_yaml",
+ ),
+ path(
+ "module-type-mappings/export-yaml/",
+ ModuleTypeMappingBulkExportYAMLView.as_view(),
+ name="moduletypemapping_bulk_export_yaml",
+ ),
+ path(
+ "module-bay-mappings/export-yaml/",
+ ModuleBayMappingBulkExportYAMLView.as_view(),
+ name="modulebaymapping_bulk_export_yaml",
+ ),
+ path(
+ "normalization-rules/export-yaml/",
+ NormalizationRuleBulkExportYAMLView.as_view(),
+ name="normalizationrule_bulk_export_yaml",
+ ),
+ path(
+ "inventory-ignore-rules/export-yaml/",
+ InventoryIgnoreRuleBulkExportYAMLView.as_view(),
+ name="inventoryignorerule_bulk_export_yaml",
+ ),
+ # Platform Mapping URLs
+ path(
+ "platform-mappings/",
+ PlatformMappingListView.as_view(),
+ name="platformmapping_list",
+ ),
+ path(
+ "platform-mappings//",
+ PlatformMappingView.as_view(),
+ name="platformmapping_detail",
+ ),
+ path(
+ "platform-mappings/add/",
+ PlatformMappingCreateView.as_view(),
+ name="platformmapping_add",
+ ),
+ path(
+ "platform-mappings/import/",
+ PlatformMappingBulkImportView.as_view(),
+ name="platformmapping_bulk_import",
+ ),
+ path(
+ "platform-mappings//delete/",
+ PlatformMappingDeleteView.as_view(),
+ name="platformmapping_delete",
+ ),
+ path(
+ "platform-mappings//edit/",
+ PlatformMappingEditView.as_view(),
+ name="platformmapping_edit",
+ ),
+ path(
+ "platform-mappings//changelog/",
+ PlatformMappingChangeLogView.as_view(),
+ name="platformmapping_changelog",
+ kwargs={"model": PlatformMapping},
+ ),
+ path(
+ "platform-mappings/delete/",
+ PlatformMappingBulkDeleteView.as_view(),
+ name="platformmapping_bulk_delete",
+ ),
+ path(
+ "platform-mappings/export-yaml/",
+ PlatformMappingBulkExportYAMLView.as_view(),
+ name="platformmapping_bulk_export_yaml",
+ ),
+ # Carrier Auto-Install Rule URLs
+ path(
+ "carrier-auto-install-rules/",
+ CarrierAutoInstallRuleListView.as_view(),
+ name="carrierautoinstallrule_list",
+ ),
+ path(
+ "carrier-auto-install-rules//",
+ CarrierAutoInstallRuleView.as_view(),
+ name="carrierautoinstallrule_detail",
+ ),
+ path(
+ "carrier-auto-install-rules/add/",
+ CarrierAutoInstallRuleCreateView.as_view(),
+ name="carrierautoinstallrule_add",
+ ),
+ path(
+ "carrier-auto-install-rules/import/",
+ CarrierAutoInstallRuleBulkImportView.as_view(),
+ name="carrierautoinstallrule_bulk_import",
+ ),
+ path(
+ "carrier-auto-install-rules//delete/",
+ CarrierAutoInstallRuleDeleteView.as_view(),
+ name="carrierautoinstallrule_delete",
+ ),
+ path(
+ "carrier-auto-install-rules//edit/",
+ CarrierAutoInstallRuleEditView.as_view(),
+ name="carrierautoinstallrule_edit",
+ ),
+ path(
+ "carrier-auto-install-rules//changelog/",
+ CarrierAutoInstallRuleChangeLogView.as_view(),
+ name="carrierautoinstallrule_changelog",
+ kwargs={"model": CarrierAutoInstallRule},
+ ),
+ path(
+ "carrier-auto-install-rules/delete/",
+ CarrierAutoInstallRuleBulkDeleteView.as_view(),
+ name="carrierautoinstallrule_bulk_delete",
+ ),
+ path(
+ "carrier-auto-install-rules/export-yaml/",
+ CarrierAutoInstallRuleBulkExportYAMLView.as_view(),
+ name="carrierautoinstallrule_bulk_export_yaml",
+ ),
path("api/", include("netbox_librenms_plugin.api.urls")),
]
diff --git a/netbox_librenms_plugin/utils.py b/netbox_librenms_plugin/utils.py
index db704afc39..4319000fc4 100644
--- a/netbox_librenms_plugin/utils.py
+++ b/netbox_librenms_plugin/utils.py
@@ -13,15 +13,15 @@
logger = logging.getLogger(__name__)
-def convert_speed_to_kbps(speed_bps: int) -> int:
+def convert_speed_to_kbps(speed_bps: int | None) -> int | None:
"""
Convert speed from bits per second to kilobits per second.
Args:
- speed_bps (int): Speed in bits per second.
+ speed_bps (int | None): Speed in bits per second, or None.
Returns:
- int: Speed in kilobits per second.
+ int | None: Speed in kilobits per second, or None if input is None.
"""
if speed_bps is None:
return None
@@ -107,14 +107,22 @@ def get_librenms_sync_device(device: Device, server_key: str = None) -> Optional
vc = device.virtual_chassis
all_members = vc.members.all()
+ def _is_valid_librenms_id(val):
+ # Reject None, booleans, and anything that doesn't coerce to a positive int.
+ if val is None or isinstance(val, bool):
+ return False
+ try:
+ return int(val) > 0
+ except (TypeError, ValueError):
+ return False
+
if server_key is not None:
# Priority 1: Prefer member with an explicit per-server dict mapping for server_key.
# This ensures a migrated device is preferred over one with a legacy bare-int ID.
for member in all_members:
raw_cf = member.cf.get("librenms_id")
if isinstance(raw_cf, dict):
- val = raw_cf.get(server_key)
- if val is not None and not isinstance(val, bool):
+ if _is_valid_librenms_id(raw_cf.get(server_key)):
return member
# Priority 2 (legacy fallback): Any member whose librenms_id resolves for this server
@@ -129,9 +137,9 @@ def get_librenms_sync_device(device: Device, server_key: str = None) -> Optional
for member in all_members:
raw_cf = member.cf.get("librenms_id")
if isinstance(raw_cf, dict):
- if any(v is not None and not isinstance(v, bool) for v in raw_cf.values()):
+ if any(_is_valid_librenms_id(v) for v in raw_cf.values()):
return member
- elif raw_cf:
+ elif _is_valid_librenms_id(raw_cf):
return member
# Priority 2: Use master device if it has primary IP
@@ -242,6 +250,57 @@ def _is_truthy(val):
return use_sysname, strip_domain
+def resolve_auto_create_ipam(request) -> bool:
+ """Resolve the IPAM auto-create flag for an import-time request.
+
+ Mirrors the cascade used by :func:`resolve_naming_preferences`:
+
+ 1. POST/GET ``auto-create-ipam-toggle`` (or ``auto_create_ipam``) wins
+ β set by the import page toggle and propagated via ``hx-include``.
+ 2. Otherwise the user's saved preference
+ ``plugins.netbox_librenms_plugin.auto_create_ipam`` is used.
+ 3. Otherwise the plugin-wide ``LibreNMSSettings.auto_create_ipam_default``
+ (which itself defaults to ``False``) is used.
+
+ Use this from request-handling code (HTMX views, sync action POST
+ handlers). Background paths without a request should keep using
+ :func:`netbox_librenms_plugin.import_utils.ip_helpers.auto_create_ipam_enabled`,
+ which is the settings-only fallback.
+ """
+ from netbox_librenms_plugin.models import LibreNMSSettings
+
+ _TRUTHY = frozenset({"on", "true", "1"})
+ _KEYS = ("auto-create-ipam-toggle", "auto_create_ipam-toggle", "auto_create_ipam")
+
+ def _is_truthy(val):
+ return val.lower() in _TRUTHY if val is not None else False
+
+ if request is None:
+ try:
+ settings = LibreNMSSettings.objects.first()
+ return bool(getattr(settings, "auto_create_ipam_default", False)) if settings else False
+ except Exception:
+ return False
+
+ post_val = next((request.POST.get(k) for k in _KEYS if k in request.POST), None)
+ get_val = next((request.GET.get(k) for k in _KEYS if k in request.GET), None)
+
+ if post_val is not None:
+ return _is_truthy(post_val)
+ if get_val is not None:
+ return _is_truthy(get_val)
+
+ pref = get_user_pref(request, "plugins.netbox_librenms_plugin.auto_create_ipam")
+ if pref is not None:
+ return bool(pref)
+
+ try:
+ settings = LibreNMSSettings.objects.first()
+ return bool(getattr(settings, "auto_create_ipam_default", False)) if settings else False
+ except Exception:
+ return False
+
+
def get_interface_name_field(request: Optional[HttpRequest] = None) -> str:
"""
Get interface name field with request override support.
@@ -277,16 +336,22 @@ def match_librenms_hardware_to_device_type(hardware_name: str) -> dict | None:
"""
Match LibreNMS hardware string to a NetBox DeviceType.
- Only performs exact matching on part_number and model fields (case-insensitive).
+ Checks DeviceTypeMapping table first, then falls back to exact matching
+ on part_number and model fields (case-insensitive).
Args:
hardware_name (str): Hardware string from LibreNMS API (e.g., 'C9200L-48P-4X')
Returns:
- dict: Dictionary containing:
+ dict | None: Dictionary containing:
- matched (bool): Whether a match was found
- device_type (DeviceType|None): The matched DeviceType object
- - match_type (str|None): Always 'exact' if found, None otherwise
+ - match_type (str|None): 'mapping' if via DeviceTypeMapping, 'exact' if via
+ part_number/model, None otherwise
+ Returns ``None`` when ``MultipleObjectsReturned`` is raised on any lookup
+ (DeviceTypeMapping, part_number, or model) β i.e., the function fails closed
+ on all ambiguity cases. Callers must guard with ``if result is None:``
+ before inspecting the dict.
"""
from dcim.models import DeviceType
@@ -390,9 +455,10 @@ def find_matching_site(librenms_location: str) -> dict:
def find_matching_platform(librenms_os: str) -> dict:
"""
- Find exact matching NetBox platform for a LibreNMS OS.
+ Find matching NetBox platform for a LibreNMS OS.
- Only performs exact name matching (case-insensitive).
+ Tries exact case-insensitive name match first, then falls back to
+ PlatformMapping for when the platform name differs from the LibreNMS OS string.
Args:
librenms_os (str): OS string from LibreNMS (e.g., 'ios', 'linux', 'junos')
@@ -401,22 +467,48 @@ def find_matching_platform(librenms_os: str) -> dict:
dict: Dictionary containing:
- found (bool): Whether a match was found
- platform (Platform|None): The matched Platform object
- - match_type (str|None): Always 'exact' if found, None otherwise
+ - match_type (str|None): 'mapping', 'exact', 'ambiguous', or None.
+ 'ambiguous' means multiple PlatformMapping entries matched, or
+ multiple Platform objects share the same name, and a single
+ Platform could not be determined.
"""
from dcim.models import Platform
if not librenms_os or librenms_os == "-":
return {"found": False, "platform": None, "match_type": None}
- # Try case-insensitive exact name match
+ # Try case-insensitive exact name match first. We defer the "ambiguous"
+ # short-circuit so that an explicit PlatformMapping can still disambiguate
+ # the LibreNMS OS in exactly the case where multiple Platform rows share
+ # the name and the user added a mapping to break the tie.
+ platform_ambiguous = False
try:
platform = Platform.objects.get(name__iexact=librenms_os)
return {"found": True, "platform": platform, "match_type": "exact"}
except Platform.DoesNotExist:
pass
except Platform.MultipleObjectsReturned:
- platform = Platform.objects.filter(name__iexact=librenms_os).first()
- return {"found": True, "platform": platform, "match_type": "exact"}
+ platform_ambiguous = True
+
+ # Fall back to PlatformMapping for when the platform name differs from the LibreNMS OS string
+ try:
+ from netbox_librenms_plugin.models import PlatformMapping as _PlatformMapping
+
+ _has_platform_mapping = True
+ except ImportError:
+ _has_platform_mapping = False
+
+ if _has_platform_mapping:
+ try:
+ mapping = _PlatformMapping.objects.get(librenms_os__iexact=librenms_os)
+ return {"found": True, "platform": mapping.netbox_platform, "match_type": "mapping"}
+ except _PlatformMapping.DoesNotExist:
+ pass
+ except _PlatformMapping.MultipleObjectsReturned:
+ return {"found": False, "platform": None, "match_type": "ambiguous", "ambiguity_source": "mapping"}
+
+ if platform_ambiguous:
+ return {"found": False, "platform": None, "match_type": "ambiguous", "ambiguity_source": "platform"}
return {"found": False, "platform": None, "match_type": None}
@@ -563,14 +655,34 @@ def check_vlan_group_matches(
return True
+def coerce_librenms_id(value) -> int | None:
+ """Coerce a raw LibreNMS ID value (int or string-digit) to int, or None.
+
+ Accepts only ``int`` and ``str`` β other types (None, dicts, MagicMocks,
+ etc.) return None. Booleans are rejected because ``bool`` is a subclass
+ of ``int`` in Python, so ``int(True)`` silently becomes ``1`` β a
+ valid-looking device ID.
+ """
+ if isinstance(value, bool):
+ return None
+ if isinstance(value, int):
+ return value
+ if isinstance(value, str):
+ try:
+ return int(value)
+ except ValueError:
+ return None
+ return None
+
+
def get_librenms_device_id(obj, server_key: str = "default", *, auto_save: bool = True):
"""
Get the LibreNMS device/port ID for a specific server from the JSON custom field.
Supports both the legacy integer format and the new multi-server JSON format::
- Legacy: librenms_id = 42 β returned as universal fallback for any server_key
- New: librenms_id = {"primary": 42} β returns 42 only for server_key="primary"
+ Legacy: librenms_id = 42 β returns 42 for any server_key (universal fallback)
+ New: librenms_id = {"primary": 42} β returns 42 only for server_key="primary"
If the stored value (or the dict entry for server_key) is a string it is
normalised to ``int``. When *auto_save* is ``True`` (the default) the
@@ -596,7 +708,7 @@ def get_librenms_device_id(obj, server_key: str = "default", *, auto_save: bool
return cf_value if cf_value > 0 else None
if isinstance(cf_value, str):
# Someone stored a bare string (e.g., via NetBox UI/API) β normalise to int.
- # Treated as a legacy universal fallback for any server.
+ # Treat as a legacy universal fallback.
try:
int_id = int(cf_value)
except (ValueError, TypeError):
@@ -611,12 +723,34 @@ def get_librenms_device_id(obj, server_key: str = "default", *, auto_save: bool
value = cf_value.get(server_key)
if isinstance(value, bool):
return None
+ if isinstance(value, dict):
+ # New form: {"id": 42, "oob": {...}} β extract the main device id.
+ inner = value.get("id")
+ if isinstance(inner, bool):
+ return None
+ if isinstance(inner, int):
+ return inner if inner > 0 else None
+ if isinstance(inner, str):
+ try:
+ int_id = int(inner)
+ except (ValueError, TypeError):
+ return None
+ if int_id <= 0:
+ return None
+ if auto_save:
+ value["id"] = int_id
+ obj.custom_field_data["librenms_id"] = cf_value
+ obj.save(update_fields=["custom_field_data"])
+ return int_id
+ return None
if isinstance(value, str):
# Normalise string-stored ID inside JSON dict and write back.
try:
value = int(value)
except (ValueError, TypeError):
return None
+ if value <= 0:
+ return None
if auto_save:
cf_value[server_key] = value
obj.custom_field_data["librenms_id"] = cf_value
@@ -682,7 +816,7 @@ def set_librenms_device_id(obj, device_id, server_key: str = "default"):
)
cf_value = {}
try:
- cf_value[server_key] = int(device_id)
+ int_id = int(device_id)
except (TypeError, ValueError):
logger.warning(
"librenms_id device_id %r is not a valid integer on %r; not storing.",
@@ -690,6 +824,12 @@ def set_librenms_device_id(obj, device_id, server_key: str = "default"):
obj,
)
return # Don't persist an invalid entry
+ # Preserve any existing OOB sub-object when rewriting the main device id.
+ existing_entry = cf_value.get(server_key)
+ if isinstance(existing_entry, dict) and "oob" in existing_entry:
+ cf_value[server_key] = {"id": int_id, "oob": existing_entry["oob"]}
+ else:
+ cf_value[server_key] = int_id
obj.custom_field_data["librenms_id"] = cf_value
@@ -714,21 +854,166 @@ def find_by_librenms_id(model, librenms_id, server_key: str = "default"):
return None
if isinstance(librenms_id, bool):
return None
- try:
- librenms_id = int(librenms_id)
- except (ValueError, TypeError):
- pass # keep original; string queries will still match string-stored IDs
+ if isinstance(librenms_id, (int, float)) and librenms_id <= 0:
+ return None
+ if isinstance(librenms_id, str):
+ cleaned = librenms_id.strip()
+ if cleaned == "":
+ return None
+ try:
+ if int(cleaned) <= 0:
+ return None
+ except ValueError:
+ return None
q = Q(**{f"custom_field_data__librenms_id__{server_key}": librenms_id})
# Also match when the namespaced value was stored as a string (e.g. {"production": "42"}).
q |= Q(**{f"custom_field_data__librenms_id__{server_key}": str(librenms_id)})
+ # Match when value stored as {"id": librenms_id, "oob": {...}} β new dict-with-id form.
+ q |= Q(**{f"custom_field_data__librenms_id__{server_key}__id": librenms_id})
+ q |= Q(**{f"custom_field_data__librenms_id__{server_key}__id": str(librenms_id)})
+ # Match when librenms_id is the OOB device id β so re-import recognises merged device.
+ q |= Q(**{f"custom_field_data__librenms_id__{server_key}__oob__id": librenms_id})
+ q |= Q(**{f"custom_field_data__librenms_id__{server_key}__oob__id": str(librenms_id)})
# Always include legacy bare-integer and bare-string IDs as a universal fallback.
# Legacy records were created before multi-server support; they should be visible
# regardless of which server is currently active.
q |= Q(custom_field_data__librenms_id=librenms_id)
q |= Q(custom_field_data__librenms_id=str(librenms_id))
+ # When a string ID looks like an integer, also match the numeric JSON form so
+ # "42" matches records that store the value as the JSON number 42.
+ # Strip whitespace and canonicalize leading-zero forms ("042", "42 ") β "42".
+ if isinstance(librenms_id, str):
+ cleaned = librenms_id.strip()
+ try:
+ int_value = int(cleaned)
+ if int_value > 0:
+ canonical_str = str(int_value)
+ q |= Q(**{f"custom_field_data__librenms_id__{server_key}": canonical_str})
+ q |= Q(**{f"custom_field_data__librenms_id__{server_key}": int_value})
+ q |= Q(**{f"custom_field_data__librenms_id__{server_key}__id": canonical_str})
+ q |= Q(**{f"custom_field_data__librenms_id__{server_key}__id": int_value})
+ q |= Q(**{f"custom_field_data__librenms_id__{server_key}__oob__id": canonical_str})
+ q |= Q(**{f"custom_field_data__librenms_id__{server_key}__oob__id": int_value})
+ q |= Q(custom_field_data__librenms_id=canonical_str)
+ q |= Q(custom_field_data__librenms_id=int_value)
+ except ValueError:
+ pass
return model.objects.filter(q).first()
+def get_librenms_oob(obj, server_key: str = "default") -> dict | None:
+ """
+ Return the OOB sub-object from the ``librenms_id`` JSON custom field, or ``None``.
+
+ Read-only β never triggers a DB write. Returns the raw ``oob`` dict verbatim so
+ callers can inspect ``id``, ``type``, ``version``, and ``ip`` without additional helpers.
+
+ Returns ``None`` when:
+ - the field is absent, a legacy bare integer, or not a dict;
+ - the server-key entry is a bare integer (no OOB attached);
+ - the ``oob`` key is missing or not a dict.
+
+ Args:
+ obj: NetBox object with a ``librenms_id`` custom field.
+ server_key: LibreNMS server key (from plugin ``servers`` config).
+
+ Returns:
+ dict or None
+ """
+ cf_value = obj.cf.get("librenms_id")
+ if not isinstance(cf_value, dict):
+ return None
+ entry = cf_value.get(server_key)
+ if not isinstance(entry, dict):
+ return None
+ oob = entry.get("oob")
+ return oob if isinstance(oob, dict) else None
+
+
+def set_librenms_oob(
+ obj,
+ oob_device_id: int,
+ server_key: str = "default",
+ *,
+ oob_type: str,
+ version: str | None = None,
+ ip: str | None = None,
+) -> None:
+ """
+ Attach an OOB management controller to a device under *server_key*.
+
+ Promotes the server-key value to the ``{"id": N, "oob": {...}}`` dict form if it is
+ currently a bare integer. Validates *oob_type* against ``OOB_TYPE_PATTERN``; raises
+ ``ValueError`` if the type is not recognized.
+
+ Does **not** call ``obj.save()`` β the caller is responsible for persisting the change.
+
+ Args:
+ obj: NetBox object with a ``librenms_id`` custom field.
+ oob_device_id: LibreNMS device ID of the OOB controller.
+ server_key: LibreNMS server key (from plugin ``servers`` config).
+ oob_type: Raw type string (e.g. ``"iDRAC9"``, ``"ilo"``); will be normalized.
+ version: Optional firmware/software version string.
+ ip: Optional IP address string of the OOB controller.
+
+ Raises:
+ ValueError: if *oob_type* does not match any known OOB type.
+ """
+ from netbox_librenms_plugin.constants import OOB_TYPE_PATTERN, OOB_TYPES
+
+ if not (match := OOB_TYPE_PATTERN.search(oob_type)):
+ raise ValueError(f"oob_type {oob_type!r} does not match any known OOB type {OOB_TYPES}")
+ normalized_type = match.group(1).lower()
+
+ cf_value = obj.custom_field_data.get("librenms_id") or {}
+ if not isinstance(cf_value, dict):
+ logger.warning("librenms_id on %r is not a dict; cannot set OOB.", obj)
+ return
+
+ entry = cf_value.get(server_key)
+ if isinstance(entry, int) and not isinstance(entry, bool):
+ # Promote bare int to dict form, preserving the main device id.
+ entry = {"id": entry}
+ elif isinstance(entry, dict):
+ entry = dict(entry) # shallow copy so we don't mutate the stored dict in-place
+ else:
+ entry = {}
+
+ oob: dict = {"id": int(oob_device_id), "type": normalized_type}
+ if version:
+ oob["version"] = version
+ if ip:
+ oob["ip"] = ip
+ entry["oob"] = oob
+ cf_value[server_key] = entry
+ obj.custom_field_data["librenms_id"] = cf_value
+
+
+def clear_librenms_oob(obj, server_key: str = "default") -> None:
+ """
+ Remove the OOB sub-object from the server-key entry of ``librenms_id``.
+
+ The entry is left in ``{"id": N}`` object form β it is NOT demoted back to a bare
+ integer (either form is valid; keeping object form avoids an extra save).
+
+ Does **not** call ``obj.save()`` β the caller is responsible for persisting the change.
+ Is a no-op when the server-key entry has no ``oob`` sub-key.
+
+ Args:
+ obj: NetBox object with a ``librenms_id`` custom field.
+ server_key: LibreNMS server key (from plugin ``servers`` config).
+ """
+ cf_value = obj.custom_field_data.get("librenms_id")
+ if not isinstance(cf_value, dict):
+ return
+ entry = cf_value.get(server_key)
+ if not isinstance(entry, dict):
+ return
+ entry.pop("oob", None)
+ cf_value[server_key] = entry
+ obj.custom_field_data["librenms_id"] = cf_value
+
+
def migrate_legacy_librenms_id(obj, server_key: str = "default") -> bool:
"""
Migrate a legacy bare-integer ``librenms_id`` custom field to the JSON dict format,
@@ -766,3 +1051,602 @@ def migrate_legacy_librenms_id(obj, server_key: str = "default") -> bool:
obj,
)
return True
+
+
+_MODULE_TOKEN_LEAF_FIX_VERSION = (4, 5, 6)
+_NETBOX_VERSION_PREFIX_RE = re.compile(r"^(\d+)\.(\d+)\.(\d+)")
+
+
+def _get_netbox_version_tuple():
+ """Return the running NetBox version as a (major, minor, patch) int tuple,
+ or ``None`` when it cannot be determined.
+
+ Tolerates trailing build metadata (``-dev``, ``-Docker-3.2.0``, ``+local``,
+ ``.dev1``, etc.) by extracting the leading three numeric components and
+ ignoring anything past them.
+ """
+ try:
+ from netbox.settings import RELEASE
+
+ version = getattr(RELEASE, "version", "") or ""
+ except (ImportError, ModuleNotFoundError, AttributeError):
+ return None
+ match = _NETBOX_VERSION_PREFIX_RE.match(version)
+ if not match:
+ return None
+ return tuple(int(part) for part in match.groups())
+
+
+def netbox_resolves_module_token_per_leaf():
+ """Return True when the running NetBox resolves a single ``{module}`` token
+ in a modular component template to the leaf module bay's position.
+
+ NetBox 4.5.6 (issue #20467) changed single-token resolution to use the
+ leaf bay's position instead of the root ancestor's. With that fix in
+ place, sibling bays under the same parent always produce unique
+ interface names, so the plugin's nested-name-conflict check no longer
+ applies.
+
+ When the version cannot be detected we assume the fix is present
+ (permissive default) β the plugin pins NetBox >= 4.4 and we don't want
+ to surface false positives on releases newer than this code knows about.
+ """
+ version = _get_netbox_version_tuple()
+ if version is None:
+ return True
+ return version >= _MODULE_TOKEN_LEAF_FIX_VERSION
+
+
+def merge_librenms_links(winner, donor, server_key: str = "default") -> dict:
+ """
+ Merge donor's ``librenms_id[server_key]`` link state into winner's.
+
+ Used by the Stage-2 "two NetBox devices represent the same physical box"
+ flow. After this call (and a subsequent save), the winner holds the
+ union of both LibreNMS linkages and the donor is left with **no active
+ link** under ``server_key`` β only a ``_migrated_to`` marker pointing at
+ the winner. Callers must persist both objects themselves.
+
+ Conflict policy (winner-wins for already-populated fields):
+
+ * If winner already has ``id`` set, donor's ``id`` is moved into the
+ ``oob`` slot (only when winner has no ``oob`` yet, with type derived
+ from the donor's name when possible).
+ * If winner has no ``id`` and donor does, winner inherits ``id``.
+ * If donor has an ``oob`` sub-block and winner has none, winner
+ inherits it verbatim.
+ * Winner's existing ``oob`` is never overwritten.
+
+ Args:
+ winner: NetBox Device that will hold the merged link state.
+ donor: NetBox Device whose link state will be absorbed.
+ server_key: LibreNMS server key to scope the merge to.
+
+ Returns:
+ A dict describing what was actually merged: keys ``host_id_from_donor``,
+ ``oob_from_donor`` (None or dict), ``donor_id_demoted_to_oob``
+ (None or dict). Useful for audit logging and tests.
+ """
+ from netbox_librenms_plugin.constants import OOB_TYPE_PATTERN
+
+ summary = {
+ "host_id_from_donor": None,
+ "oob_from_donor": None,
+ "donor_id_demoted_to_oob": None,
+ }
+
+ winner_cf = winner.custom_field_data.get("librenms_id") or {}
+ donor_cf = donor.custom_field_data.get("librenms_id") or {}
+ if not isinstance(winner_cf, dict) or not isinstance(donor_cf, dict):
+ # Legacy bare-int forms must be migrated by the caller before merging.
+ raise ValueError("Cannot merge: one or both devices have a legacy bare-integer librenms_id.")
+
+ winner_entry = winner_cf.get(server_key)
+ if isinstance(winner_entry, int) and not isinstance(winner_entry, bool):
+ winner_entry = {"id": winner_entry}
+ elif isinstance(winner_entry, dict):
+ winner_entry = dict(winner_entry)
+ else:
+ winner_entry = {}
+
+ donor_entry = donor_cf.get(server_key)
+ if isinstance(donor_entry, int) and not isinstance(donor_entry, bool):
+ donor_entry = {"id": donor_entry}
+ elif not isinstance(donor_entry, dict):
+ donor_entry = {}
+
+ donor_id = donor_entry.get("id")
+ donor_oob = donor_entry.get("oob") if isinstance(donor_entry.get("oob"), dict) else None
+
+ winner_id = winner_entry.get("id")
+ winner_oob = winner_entry.get("oob") if isinstance(winner_entry.get("oob"), dict) else None
+
+ if winner_id is None and donor_id is not None:
+ winner_entry["id"] = donor_id
+ summary["host_id_from_donor"] = donor_id
+ elif winner_id is not None and donor_id is not None and winner_oob is None:
+ # Demote donor's host id into winner's oob slot. Infer type from donor name.
+ match = OOB_TYPE_PATTERN.search(donor.name or "")
+ if match:
+ inferred_type = match.group(1).lower()
+ demoted = {"id": int(donor_id), "type": inferred_type}
+ winner_entry["oob"] = demoted
+ summary["donor_id_demoted_to_oob"] = demoted
+ winner_oob = demoted
+
+ if donor_oob and winner_oob is None:
+ winner_entry["oob"] = dict(donor_oob)
+ summary["oob_from_donor"] = dict(donor_oob)
+
+ winner_cf[server_key] = winner_entry
+ winner.custom_field_data["librenms_id"] = winner_cf
+ return summary
+
+
+def mark_librenms_migrated(donor, winner_pk: int, server_key: str = "default", at: str | None = None) -> None:
+ """
+ Mark *donor* as migrated to the device with primary key *winner_pk*.
+
+ Removes any active ``id`` / ``oob`` keys from ``donor.custom_field_data
+ ['librenms_id'][server_key]`` (so the device is no longer matched by
+ ``find_by_librenms_id``) and writes a ``_migrated_to`` sub-key with the
+ target device pk, server key, and ISO-8601 UTC timestamp.
+
+ Does **not** call ``donor.save()`` β caller is responsible for persisting.
+
+ Args:
+ donor: NetBox Device being absorbed by the winner.
+ winner_pk: Primary key of the winning device.
+ server_key: LibreNMS server key whose link state is being cleared.
+ at: ISO timestamp string. When None, ``datetime.utcnow().isoformat()``
+ with a ``Z`` suffix is used.
+ """
+ from datetime import datetime, timezone
+
+ cf_value = donor.custom_field_data.get("librenms_id") or {}
+ if not isinstance(cf_value, dict):
+ cf_value = {}
+ entry = cf_value.get(server_key)
+ if isinstance(entry, int) and not isinstance(entry, bool):
+ entry = {"id": entry}
+ elif not isinstance(entry, dict):
+ entry = {}
+ entry.pop("id", None)
+ entry.pop("oob", None)
+ entry["_migrated_to"] = {
+ "device_id": int(winner_pk),
+ "server_key": server_key,
+ "at": at or datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%SZ"),
+ }
+ cf_value[server_key] = entry
+ donor.custom_field_data["librenms_id"] = cf_value
+
+
+def get_migrated_to_marker(device, server_key: str = "default") -> dict | None:
+ """
+ Read the ``_migrated_to`` marker (Stage 2b) from the device's
+ ``librenms_id[server_key]`` sub-block.
+
+ Returns the marker dict ``{device_id, server_key, at}`` when the donor
+ was previously merged into another NetBox device via
+ :func:`mark_librenms_migrated`, or ``None`` when no marker is present
+ (or the cf is malformed).
+
+ Used by the librenms-sync UI to switch a donor device into "migrated
+ mode": disable sync actions and surface per-row "Move to winner"
+ buttons.
+ """
+ if device is None:
+ return None
+ cf_value = device.cf.get("librenms_id") if hasattr(device, "cf") else None
+ if not isinstance(cf_value, dict):
+ return None
+ entry = cf_value.get(server_key)
+ if not isinstance(entry, dict):
+ return None
+ marker = entry.get("_migrated_to")
+ if not isinstance(marker, dict):
+ return None
+ if not isinstance(marker.get("device_id"), int):
+ return None
+ return marker
+
+
+def has_nested_name_conflict(module_type, module_bay, sibling_counts=None):
+ """
+ Check if installing this module type in a nested bay would cause a name conflict.
+
+ Returns a non-empty reason string when ALL of the following are true:
+ - The running NetBox version is older than 4.5.6 (issue #20467 fix)
+ - The module type has interface templates using ``{module}``
+ - The bay is nested (its parent is owned by an installed module)
+ - There is at least one sibling bay under the same parent
+
+ On NetBox < 4.5.6, ``resolve_name()`` replaces a single ``{module}`` token
+ with the root ancestor's bay position, producing the same interface name
+ for every sibling at this nesting level. NetBox 4.5.6+ resolves the token
+ to the leaf bay's position, so siblings get unique names and no conflict
+ can arise β in that case this function always returns an empty string.
+
+ Returns an empty string (falsy) when no conflict is detected.
+
+ Args:
+ module_type: The ModuleType to install.
+ module_bay: The ModuleBay target.
+ sibling_counts: Optional precomputed dict mapping module_id β bay count.
+ When provided, avoids a per-call DB query. Pass
+ ``{mid: len(bays) for mid, bays in module_scoped_bays.items()}`` from
+ the caller that already has the bay maps loaded.
+ """
+ from dcim.constants import MODULE_TOKEN
+
+ if netbox_resolves_module_token_per_leaf():
+ return "" # NetBox 4.5.6+ resolves {module} to the leaf bay's position
+
+ if not module_bay or not module_bay.module_id:
+ return "" # Top-level bay β no conflict
+
+ templates = list(module_type.interfacetemplates.all())
+ if not templates:
+ return "" # No interface templates
+
+ if not any(MODULE_TOKEN in t.name for t in templates):
+ return "" # Template doesn't use {module}
+
+ if sibling_counts is not None:
+ sibling_count = sibling_counts.get(module_bay.module_id, 0)
+ else:
+ from dcim.models import ModuleBay as ModuleBayModel
+
+ sibling_count = ModuleBayModel.objects.filter(
+ device=module_bay.device,
+ module_id=module_bay.module_id,
+ ).count()
+
+ if sibling_count <= 1:
+ return ""
+
+ return (
+ f"Interface templates for '{module_type.model}' use {{module}}, which resolves to "
+ f"the same root bay name for all {sibling_count} sibling bays on this NetBox "
+ "version β installing here would create duplicate interface names. "
+ "Upgrade NetBox to 4.5.6 or later (issue #20467) to resolve this β the "
+ "{module} token will then resolve to each leaf bay's position."
+ )
+
+
+class _ModuleTypeIndex(dict):
+ """Dict mapping LibreNMS keys β ``ModuleType``, plus manufacturer-scoped overrides.
+
+ Behaves exactly like a plain ``dict`` for the global key space (model/part_number
+ plus any global ``ModuleTypeMapping`` rows), but additionally exposes
+ ``mfr_mappings`` β a dict keyed by ``(manufacturer_pk, librenms_model)`` populated
+ from manufacturer-scoped ``ModuleTypeMapping`` rows. ``resolve_module_type`` probes
+ the manufacturer-scoped key first so vendor-specific overrides win for matching
+ devices without leaking into other vendors' lookups.
+ """
+
+ __slots__ = ("mfr_mappings",)
+
+ def __init__(self, *args, mfr_mappings=None, **kwargs):
+ super().__init__(*args, **kwargs)
+ self.mfr_mappings: dict = mfr_mappings or {}
+
+
+def get_module_types_indexed() -> dict:
+ """
+ Return all NetBox module types indexed by model (and part_number), with ModuleTypeMapping applied.
+
+ Global (manufacturer=NULL) ``ModuleTypeMapping`` rows are merged into the
+ main index and take priority over the base model/part_number keys, so that
+ explicit overrides win when the same string appears in both.
+
+ Manufacturer-scoped ``ModuleTypeMapping`` rows are kept out of the main
+ index β they live under ``mfr_mappings`` keyed by ``(manufacturer_pk,
+ librenms_model)`` so they apply only to devices of that vendor.
+ """
+ from dcim.models import ModuleType
+
+ from netbox_librenms_plugin.models import ModuleTypeMapping
+
+ result: dict = {}
+ ambiguous: set = set()
+ for mt in ModuleType.objects.all().select_related("manufacturer").prefetch_related("interfacetemplates"):
+ seen_this_entry: set = set()
+ for key in (mt.model, mt.part_number):
+ if not key or key in seen_this_entry:
+ continue
+ seen_this_entry.add(key)
+ if key in ambiguous:
+ continue
+ if key in result:
+ ambiguous.add(key)
+ del result[key]
+ else:
+ result[key] = mt
+ # Mapping ambiguity is tracked separately so that a unique mapping always
+ # wins over a base ModuleType entry (explicit overrides take priority).
+ #
+ # Precedence: a manufacturer-scoped mapping (mfg_pk, librenms_model) wins
+ # over a global one for matching devices; both win over base ModuleType
+ # entries. Manufacturer-scoped rows live in ``mfr_mappings`` and are
+ # NOT merged into the main dict β keeping them isolated avoids polluting
+ # lookups for other vendors. The DB conditional UniqueConstraint pair
+ # (see ``ModuleTypeMapping.Meta.constraints``) ensures (a) no two global
+ # rows share a librenms_model, and (b) no two rows share the same
+ # (librenms_model, manufacturer) pair, so the ``mapping_ambiguous``
+ # branches below are defensive-only β they cannot fire under the current
+ # schema. ``get_module_type_ambiguities`` therefore has no companion
+ # mapping-collision helper.
+ mapping_seen: set = set()
+ mapping_ambiguous: set = set()
+ mfr_mappings: dict = {}
+ mfr_seen: set = set()
+ for mapping in ModuleTypeMapping.objects.select_related(
+ "netbox_module_type__manufacturer", "manufacturer"
+ ).prefetch_related("netbox_module_type__interfacetemplates"):
+ if mapping.manufacturer_id is not None:
+ mfr_key = (mapping.manufacturer_id, mapping.librenms_model)
+ if mfr_key in mfr_seen:
+ # Defensive: blocked by conditional UniqueConstraint.
+ continue
+ mfr_seen.add(mfr_key)
+ mfr_mappings[mfr_key] = mapping.netbox_module_type
+ continue
+ key = mapping.librenms_model
+ if key in mapping_ambiguous:
+ continue
+ if key in mapping_seen:
+ mapping_ambiguous.add(key)
+ del result[key]
+ else:
+ mapping_seen.add(key)
+ result[key] = mapping.netbox_module_type
+ return _ModuleTypeIndex(result, mfr_mappings=mfr_mappings)
+
+
+def get_module_type_ambiguities() -> dict:
+ """
+ Return part_number/model strings that map to multiple NetBox ModuleTypes.
+
+ Returns a dict mapping ``key`` (a model or part_number string that collides
+ across two or more ModuleType rows) β list of ``ModuleType`` instances that
+ share that key. ``get_module_types_indexed`` deliberately drops these keys
+ from its lookup index (fail-closed safety), so callers wanting to *report*
+ why a LibreNMS string can't be matched to a single NetBox ModuleType use
+ this helper to surface the conflicting candidates to the user.
+
+ Manufacturer is intentionally **not** restricted: a key that collides
+ across vendors is just as ambiguous as one that collides within a vendor,
+ and the underlying index ignores manufacturer too.
+
+ There is no companion ``get_module_type_mapping_ambiguities`` helper: see
+ the note in ``get_module_types_indexed`` β ``ModuleTypeMapping``'s
+ conditional UniqueConstraint pair (``unique_module_type_mapping`` and
+ ``unique_module_type_mapping_global``) makes mapping-vs-mapping
+ collisions structurally impossible.
+ """
+ from dcim.models import ModuleType
+
+ candidates: dict = {}
+ for mt in ModuleType.objects.all().select_related("manufacturer"):
+ seen_this_entry: set = set()
+ for key in (mt.model, mt.part_number):
+ if not key or key in seen_this_entry:
+ continue
+ seen_this_entry.add(key)
+ candidates.setdefault(key, []).append(mt)
+ return {key: mts for key, mts in candidates.items() if len(mts) > 1}
+
+
+def get_generic_module_types_indexed() -> dict:
+ """
+ Return NetBox module types from the 'Generic' manufacturer, indexed by model and part_number.
+
+ Used as a secondary fallback in :func:`resolve_module_type` when the primary look-up
+ (which excludes ambiguous names) fails. This lets common SFP/optic models that exist
+ under both a vendor-specific and a Generic entry still be matched via the Generic type.
+
+ Mirrors the fail-closed behaviour of :func:`get_module_types_indexed`: if two Generic
+ ModuleTypes share the same ``model``/``part_number`` value the key is dropped from the
+ index so callers cannot auto-pick an arbitrary row. The user must disambiguate via an
+ explicit ``ModuleTypeMapping``.
+ """
+ from dcim.models import ModuleType
+
+ result: dict = {}
+ ambiguous: set = set()
+ for mt in (
+ ModuleType.objects.filter(manufacturer__name__iexact="Generic")
+ .select_related("manufacturer")
+ .prefetch_related("interfacetemplates")
+ ):
+ seen_this_entry: set = set()
+ for key in (mt.model, mt.part_number):
+ if not key or key in seen_this_entry or key in ambiguous:
+ continue
+ seen_this_entry.add(key)
+ if key in result:
+ ambiguous.add(key)
+ del result[key]
+ else:
+ result[key] = mt
+ return result
+
+
+def preload_normalization_rules(scope: str, manufacturer=None) -> dict:
+ """
+ Preload NormalizationRule rows for a (scope, manufacturer) combination.
+
+ Returns a dict mapping ``(scope, manufacturer_pk_or_None)`` β list of rules.
+ Pass this dict as ``preloaded_rules`` to :func:`apply_normalization_rules` and
+ :func:`resolve_module_type` to avoid repeated DB queries inside loops.
+ """
+ from netbox_librenms_plugin.models import NormalizationRule
+
+ cache: dict = {}
+ if manufacturer and manufacturer.pk is not None:
+ mfg_pk = manufacturer.pk
+ cache[(scope, mfg_pk)] = list(
+ NormalizationRule.objects.filter(scope=scope, manufacturer=manufacturer).order_by("priority", "pk")
+ )
+ cache[(scope, None)] = list(
+ NormalizationRule.objects.filter(scope=scope, manufacturer__isnull=True).order_by("priority", "pk")
+ )
+ return cache
+
+
+def apply_normalization_rules(value: str, scope: str, manufacturer=None, *, preloaded_rules: dict | None = None) -> str:
+ """
+ Apply NormalizationRule chain to transform a string before matching.
+
+ Rules for the given scope are applied in priority order. Each rule's
+ regex substitution transforms the output of the previous rule, forming
+ a pipeline. If no rules match, the original value is returned unchanged.
+
+ When *manufacturer* is given, manufacturer-scoped rules run first,
+ followed by unscoped (``manufacturer__isnull=True``) rules. When
+ *manufacturer* is ``None``, only unscoped rules are applied.
+
+ Args:
+ value: The raw string to normalize (e.g. '3HE16474AARA01').
+ scope: One of NormalizationRule.SCOPE_* constants.
+ manufacturer: Optional Manufacturer instance to scope rules.
+ preloaded_rules: Optional dict from :func:`preload_normalization_rules`.
+ When provided, DB queries are skipped and preloaded lists are used
+ instead, eliminating repeated queries inside loops.
+
+ Returns:
+ The normalized string after all matching rules have been applied.
+ """
+ from netbox_librenms_plugin.models import NormalizationRule
+
+ if not value:
+ return value
+
+ def _apply_rules(val, rules_qs):
+ for rule in rules_qs:
+ try:
+ val = re.sub(rule.match_pattern, rule.replacement, val)
+ except (re.error, IndexError):
+ logger.error(
+ "Invalid regex in NormalizationRule pk=%s pattern=%r β skipping", rule.pk, rule.match_pattern
+ )
+ return val
+
+ if preloaded_rules is not None:
+ if manufacturer and manufacturer.pk is not None:
+ mfg_pk = manufacturer.pk
+ if (scope, mfg_pk) in preloaded_rules:
+ value = _apply_rules(value, preloaded_rules[(scope, mfg_pk)])
+ else:
+ # Manufacturer key missing from preloaded dict β fall back to DB and cache result
+ rules = list(
+ NormalizationRule.objects.filter(scope=scope, manufacturer=manufacturer).order_by("priority", "pk")
+ )
+ preloaded_rules[(scope, mfg_pk)] = rules
+ value = _apply_rules(value, rules)
+ if (scope, None) in preloaded_rules:
+ value = _apply_rules(value, preloaded_rules[(scope, None)])
+ else:
+ # Unscoped rules not preloaded β fall back to DB and cache result
+ unscoped_rules = list(
+ NormalizationRule.objects.filter(scope=scope, manufacturer__isnull=True).order_by("priority", "pk")
+ )
+ preloaded_rules[(scope, None)] = unscoped_rules
+ value = _apply_rules(value, unscoped_rules)
+ elif manufacturer and manufacturer.pk is not None:
+ # Manufacturer-specific rules first, then unscoped rules
+ for mfg_filter in [{"manufacturer": manufacturer}, {"manufacturer__isnull": True}]:
+ rules = NormalizationRule.objects.filter(scope=scope, **mfg_filter).order_by("priority", "pk")
+ value = _apply_rules(value, rules)
+ else:
+ rules = NormalizationRule.objects.filter(scope=scope, manufacturer__isnull=True).order_by("priority", "pk")
+ value = _apply_rules(value, rules)
+ return value
+
+
+def resolve_module_type(
+ model_name: str,
+ module_types: dict,
+ manufacturer=None,
+ *,
+ norm_rules: dict | None = None,
+ generic_fallback: dict | None = None,
+):
+ """
+ Resolve a LibreNMS model name to a NetBox ModuleType via direct lookup then normalization.
+
+ Pass ``norm_rules`` (from :func:`preload_normalization_rules`) to avoid
+ repeated DB queries when called in a loop.
+
+ Pass ``generic_fallback`` (from :func:`get_generic_module_types_indexed`) to enable
+ a secondary look-up in the 'Generic' manufacturer when the primary index has no match
+ (e.g. because the same model name is used by multiple manufacturers, making it
+ ambiguous in the primary index).
+
+ When *manufacturer* is provided **and** *module_types* is the ``_ModuleTypeIndex``
+ returned by :func:`get_module_types_indexed`, manufacturer-scoped
+ ``ModuleTypeMapping`` rows are probed first (raw and normalized model name)
+ before falling back to the global index. This lets vendor-specific overrides
+ win without polluting lookups for other vendors.
+
+ Returns the matched ModuleType or None.
+ """
+ if not model_name:
+ return None
+
+ mfr_mappings = getattr(module_types, "mfr_mappings", None)
+ mfr_pk = getattr(manufacturer, "pk", None)
+
+ def _lookup_mfr(name):
+ if mfr_mappings and mfr_pk is not None and name:
+ return mfr_mappings.get((mfr_pk, name))
+ return None
+
+ matched = _lookup_mfr(model_name)
+ if not matched:
+ matched = module_types.get(model_name)
+ normalized = None
+ if not matched:
+ normalized = apply_normalization_rules(
+ model_name, "module_type", manufacturer=manufacturer, preloaded_rules=norm_rules
+ )
+ if normalized != model_name:
+ matched = _lookup_mfr(normalized) or module_types.get(normalized)
+ if not matched and generic_fallback:
+ matched = generic_fallback.get(model_name)
+ if not matched:
+ if normalized is None:
+ normalized = apply_normalization_rules(
+ model_name, "module_type", manufacturer=manufacturer, preloaded_rules=norm_rules
+ )
+ if normalized != model_name:
+ matched = generic_fallback.get(normalized)
+ return matched
+
+
+def get_enabled_ignore_rules() -> list:
+ """Return all enabled InventoryIgnoreRule instances as a list."""
+ from netbox_librenms_plugin.models import InventoryIgnoreRule
+
+ return list(InventoryIgnoreRule.objects.filter(enabled=True).order_by("pk"))
+
+
+def load_bay_mappings() -> tuple:
+ """
+ Load all ModuleBayMapping rows, split into exact and regex lists.
+
+ Returns:
+ (exact_mappings, regex_mappings) tuple of lists.
+ """
+ from netbox_librenms_plugin.models import ModuleBayMapping
+
+ # Regex precedence is first-match-wins, so it must NOT depend on the
+ # lexicographic sort of the pattern text β that would let a pattern edit
+ # silently reorder vendor-specific vs fallback regexes. Preserve insertion
+ # order within each (exact, regex) bucket by ordering on the PK only.
+ all_mappings = list(ModuleBayMapping.objects.order_by("is_regex", "id"))
+ exact = [m for m in all_mappings if not m.is_regex]
+ regex = [m for m in all_mappings if m.is_regex]
+ return exact, regex
diff --git a/netbox_librenms_plugin/views/__init__.py b/netbox_librenms_plugin/views/__init__.py
index 103900c6c0..a78e093af5 100644
--- a/netbox_librenms_plugin/views/__init__.py
+++ b/netbox_librenms_plugin/views/__init__.py
@@ -10,10 +10,21 @@
from .base.interfaces_view import BaseInterfaceTableView # noqa: F401
from .base.ip_addresses_view import BaseIPAddressTableView, SingleIPAddressVerifyView # noqa: F401
from .base.librenms_sync_view import BaseLibreNMSSyncView # noqa: F401
+from .sync.modules import ( # noqa: F401
+ AddBayTemplateView,
+ InstallBranchView,
+ InstallModuleView,
+ InstallSelectedView,
+ MoveModuleView,
+ ModuleMismatchPreviewView,
+ ReplaceModuleView,
+ UpdateModuleSerialView,
+)
from .base.vlan_table_view import BaseVLANTableView # noqa: F401
from .imports import ( # noqa: F401
BulkImportConfirmView,
BulkImportDevicesView,
+ CreatePlatformFromImportView,
DeviceClusterUpdateView,
DeviceConflictActionView,
DeviceRackUpdateView,
@@ -24,6 +35,23 @@
SaveUserPrefView,
)
from .mapping_views import ( # noqa: F401
+ CarrierAutoInstallRuleBulkDeleteView,
+ CarrierAutoInstallRuleBulkExportYAMLView,
+ CarrierAutoInstallRuleBulkImportView,
+ CarrierAutoInstallRuleChangeLogView,
+ CarrierAutoInstallRuleCreateView,
+ CarrierAutoInstallRuleDeleteView,
+ CarrierAutoInstallRuleEditView,
+ CarrierAutoInstallRuleListView,
+ CarrierAutoInstallRuleView,
+ DeviceTypeMappingBulkDeleteView,
+ DeviceTypeMappingBulkImportView,
+ DeviceTypeMappingChangeLogView,
+ DeviceTypeMappingCreateView,
+ DeviceTypeMappingDeleteView,
+ DeviceTypeMappingEditView,
+ DeviceTypeMappingListView,
+ DeviceTypeMappingView,
InterfaceTypeMappingBulkDeleteView,
InterfaceTypeMappingBulkImportView,
InterfaceTypeMappingChangeLogView,
@@ -32,15 +60,71 @@
InterfaceTypeMappingEditView,
InterfaceTypeMappingListView,
InterfaceTypeMappingView,
+ ModuleBayMappingBulkDeleteView,
+ ModuleBayMappingBulkImportView,
+ ModuleBayMappingChangeLogView,
+ ModuleBayMappingCreateView,
+ ModuleBayMappingDeleteView,
+ ModuleBayMappingEditView,
+ ModuleBayMappingListView,
+ ModuleBayMappingView,
+ ModuleTypeMappingBulkDeleteView,
+ ModuleTypeMappingBulkImportView,
+ ModuleTypeMappingChangeLogView,
+ ModuleTypeMappingCreateView,
+ ModuleTypeMappingDeleteView,
+ ModuleTypeMappingEditView,
+ ModuleTypeMappingListView,
+ ModuleTypeMappingView,
+ NormalizationRuleBulkDeleteView,
+ NormalizationRuleBulkImportView,
+ NormalizationRuleChangeLogView,
+ NormalizationRuleCreateView,
+ NormalizationRuleDeleteView,
+ NormalizationRuleEditView,
+ NormalizationRuleListView,
+ NormalizationRuleView,
+ InventoryIgnoreRuleBulkDeleteView,
+ InventoryIgnoreRuleBulkImportView,
+ InventoryIgnoreRuleChangeLogView,
+ InventoryIgnoreRuleCreateView,
+ InventoryIgnoreRuleDeleteView,
+ InventoryIgnoreRuleEditView,
+ InventoryIgnoreRuleListView,
+ InventoryIgnoreRuleView,
+ DeviceTypeMappingBulkExportYAMLView,
+ InterfaceTypeMappingBulkExportYAMLView,
+ ModuleBayMappingBulkExportYAMLView,
+ ModuleTypeMappingBulkExportYAMLView,
+ NormalizationRuleBulkExportYAMLView,
+ InventoryIgnoreRuleBulkExportYAMLView,
+ PlatformMappingBulkDeleteView,
+ PlatformMappingBulkExportYAMLView,
+ PlatformMappingBulkImportView,
+ PlatformMappingChangeLogView,
+ PlatformMappingCreateView,
+ PlatformMappingDeleteView,
+ PlatformMappingEditView,
+ PlatformMappingListView,
+ PlatformMappingView,
)
+from .imports.actions import (
+ AddAsOOBView,
+ AddDeviceTypeMappingView,
+ AddPlatformMappingView,
+ MergeNetBoxDevicesView,
+ PromoteToHostView,
+) # noqa: F401
from .object_sync import ( # noqa: F401
DeviceCableTableView,
DeviceInterfaceTableView,
DeviceIPAddressTableView,
DeviceLibreNMSSyncView,
+ DeviceModuleTableView,
DeviceVLANTableView,
SaveVlanGroupOverridesView,
SingleInterfaceVerifyView,
+ SingleModuleVerifyView,
SingleVlanGroupVerifyView,
VerifyVlanSyncGroupView,
VMInterfaceTableView,
@@ -64,4 +148,9 @@
from .sync.interfaces import DeleteNetBoxInterfacesView, SyncInterfacesView # noqa: F401
from .sync.ip_addresses import SyncIPAddressesView # noqa: F401
from .sync.locations import SyncSiteLocationView # noqa: F401
+from .sync.migrate import ( # noqa: F401
+ MoveInterfaceToWinnerView,
+ MoveIPAddressToWinnerView,
+ TransferDeviceIPView,
+)
from .sync.vlans import SyncVLANsView # noqa: F401
diff --git a/netbox_librenms_plugin/views/base/cables_view.py b/netbox_librenms_plugin/views/base/cables_view.py
index a599022b80..36a3f36965 100644
--- a/netbox_librenms_plugin/views/base/cables_view.py
+++ b/netbox_librenms_plugin/views/base/cables_view.py
@@ -1,5 +1,3 @@
-import json
-
from dcim.models import Device, Interface
from django.contrib import messages
from django.core.cache import cache
@@ -15,10 +13,16 @@
from netbox_librenms_plugin.utils import (
get_interface_name_field,
+ get_librenms_oob,
get_librenms_sync_device,
get_virtual_chassis_member,
)
-from netbox_librenms_plugin.views.mixins import CacheMixin, LibreNMSAPIMixin, LibreNMSPermissionMixin
+from netbox_librenms_plugin.views.mixins import (
+ CacheMixin,
+ LibreNMSAPIMixin,
+ LibreNMSPermissionMixin,
+ parse_request_json,
+)
def _librenms_id_q(server_key: str, value) -> Q:
@@ -106,8 +110,28 @@ def get_links_data(self, obj):
"remote_device": link.get("remote_hostname"),
"remote_port_id": link.get("remote_port_id"),
"remote_device_id": link.get("remote_device_id"),
+ "_source": "main",
}
)
+
+ # If an OOB controller is linked, fetch its LLDP links and merge.
+ oob = get_librenms_oob(obj, server_key=self.librenms_api.server_key)
+ if oob and oob.get("id"):
+ oob_success, oob_data = self.librenms_api.get_device_links(oob["id"])
+ if oob_success and "error" not in oob_data:
+ for link in oob_data.get("links", []):
+ links_data.append(
+ {
+ "local_port": link.get("local_port"),
+ "local_port_id": link.get("local_port_id"),
+ "remote_port": link.get("remote_port"),
+ "remote_device": link.get("remote_hostname"),
+ "remote_port_id": link.get("remote_port_id"),
+ "remote_device_id": link.get("remote_device_id"),
+ "_source": "oob",
+ }
+ )
+
return links_data
def get_device_by_id_or_name(self, remote_device_id, hostname, server_key=None):
@@ -416,7 +440,9 @@ class SingleCableVerifyView(BaseCableTableView):
"""
def post(self, request):
- data = json.loads(request.body)
+ data, err = parse_request_json(request)
+ if err:
+ return err
selected_device_id = data.get("device_id")
local_port_id = data.get("local_port_id")
# Read server_key from POST so we use the exact server the user was viewing
diff --git a/netbox_librenms_plugin/views/base/interfaces_view.py b/netbox_librenms_plugin/views/base/interfaces_view.py
index 995e698c87..468fbd7f85 100644
--- a/netbox_librenms_plugin/views/base/interfaces_view.py
+++ b/netbox_librenms_plugin/views/base/interfaces_view.py
@@ -6,6 +6,7 @@
from netbox_librenms_plugin.utils import (
get_interface_name_field,
+ get_librenms_oob,
get_virtual_chassis_member,
)
from netbox_librenms_plugin.views.mixins import (
@@ -91,9 +92,35 @@ def post(self, request, pk):
# Enrich ports with VLAN data for trunk ports
ports = librenms_data.get("ports", [])
enriched_ports = self._enrich_ports_with_vlan_data(ports, interface_name_field)
+ for port in enriched_ports:
+ port["_source"] = "main"
librenms_data["ports"] = enriched_ports
+ # If an OOB controller is linked, fetch its ports and merge them in.
_server_key = self.librenms_api.server_key
+ oob = get_librenms_oob(obj, server_key=_server_key)
+ if oob and oob.get("id"):
+ oob_success, oob_raw = self.librenms_api.get_ports(oob["id"])
+ if oob_success:
+ oob_ports = oob_raw.get("ports", [])
+ oob_enriched = self._enrich_ports_with_vlan_data(oob_ports, interface_name_field)
+ for port in oob_enriched:
+ port["_source"] = "oob"
+ # Detect shared-LOM: same MAC seen on both main and OOB sides
+ mac_index = {}
+ for port in enriched_ports:
+ mac = (port.get("ifPhysAddress") or "").lower().strip()
+ if mac:
+ mac_index.setdefault(mac, []).append(port)
+ for port in oob_enriched:
+ mac = (port.get("ifPhysAddress") or "").lower().strip()
+ if mac:
+ mac_index.setdefault(mac, []).append(port)
+ for mac, rows in mac_index.items():
+ if len(rows) > 1:
+ for row in rows:
+ row["_dedup_conflict"] = True
+ librenms_data["ports"] = enriched_ports + oob_enriched
# Store data in cache (keyed by server to avoid cross-server collisions)
cache.set(
self.get_cache_key(obj, "ports", _server_key),
diff --git a/netbox_librenms_plugin/views/base/ip_addresses_view.py b/netbox_librenms_plugin/views/base/ip_addresses_view.py
index 60859a3279..a11edc82fa 100644
--- a/netbox_librenms_plugin/views/base/ip_addresses_view.py
+++ b/netbox_librenms_plugin/views/base/ip_addresses_view.py
@@ -1,4 +1,5 @@
import json
+import logging
from dcim.models import Device
from django.contrib import messages
@@ -14,6 +15,8 @@
from netbox_librenms_plugin.utils import get_interface_name_field, get_librenms_device_id
from netbox_librenms_plugin.views.mixins import CacheMixin, LibreNMSAPIMixin, LibreNMSPermissionMixin
+logger = logging.getLogger(__name__)
+
class BaseIPAddressTableView(LibreNMSPermissionMixin, LibreNMSAPIMixin, CacheMixin, View):
"""
@@ -494,5 +497,8 @@ def post(self, request):
}
)
- except Exception as e:
- return JsonResponse({"status": "error", "message": str(e)}, status=500)
+ except Exception:
+ logger.exception("Unexpected error in IP address sync")
+ return JsonResponse(
+ {"status": "error", "message": "An internal error occurred. Please check server logs."}, status=500
+ )
diff --git a/netbox_librenms_plugin/views/base/librenms_sync_view.py b/netbox_librenms_plugin/views/base/librenms_sync_view.py
index dfc7cbfc80..f74187c65f 100644
--- a/netbox_librenms_plugin/views/base/librenms_sync_view.py
+++ b/netbox_librenms_plugin/views/base/librenms_sync_view.py
@@ -8,9 +8,11 @@
from netbox_librenms_plugin.import_utils import _determine_device_name
from netbox_librenms_plugin.import_utils.virtual_chassis import _generate_vc_member_name
from netbox_librenms_plugin.utils import (
+ find_matching_platform,
get_interface_name_field,
get_librenms_device_id,
get_librenms_sync_device,
+ get_migrated_to_marker,
match_librenms_hardware_to_device_type,
resolve_naming_preferences,
)
@@ -131,6 +133,7 @@ def get_context_data(self, request, obj):
"ip_sync": ip_context,
"vlan_sync": vlan_context,
"module_sync": module_context,
+ "has_write_permission": self.has_write_permission(),
"v1v2form": AddToLIbreSNMPV1V2(prefix="v1v2"),
"v3form": AddToLIbreSNMPV3(prefix="v3"),
"librenms_device_id": self.librenms_id,
@@ -152,11 +155,37 @@ def get_context_data(self, request, obj):
_lookup_device._meta.model_name if _lookup_device else obj._meta.model_name
),
"object_model_name": obj._meta.model_name,
+ **self._build_migrated_context(_lookup_device, self.librenms_api.server_key),
}
)
return context
+ @staticmethod
+ def _build_migrated_context(obj, server_key):
+ """
+ Build Stage 2b "donor migrated mode" context.
+
+ Returns a dict with:
+ * ``migrated_to_marker`` β the marker dict (``{device_id, server_key, at}``)
+ when this device was previously merged into another via
+ :func:`mark_librenms_migrated`, else ``None``.
+ * ``migrated_to_winner`` β the winner :class:`Device` instance (or
+ ``None`` if it has been deleted since the marker was written).
+
+ When ``migrated_to_marker`` is set, all sync action buttons should
+ be hidden and per-row "Move to winner" actions should be shown
+ instead.
+ """
+ marker = get_migrated_to_marker(obj, server_key)
+ if not marker:
+ return {"migrated_to_marker": None, "migrated_to_winner": None}
+
+ from dcim.models import Device
+
+ winner = Device.objects.filter(pk=marker["device_id"]).first()
+ return {"migrated_to_marker": marker, "migrated_to_winner": winner}
+
@staticmethod
def _build_all_server_mappings(obj, active_server_key):
"""
@@ -257,12 +286,12 @@ def get_librenms_device_info(self, obj, request=None):
librenms_sysname = device_info.get("sysName")
librenms_ip = device_info.get("ip")
- # Extract new fields
- hardware = device_info.get("hardware", "-")
- serial = device_info.get("serial", "-")
- os_name = device_info.get("os", "-")
- version = device_info.get("version", "-")
- features = device_info.get("features", "-")
+ # Extract new fields; use `or "-"` so null/empty from LibreNMS renders as "-"
+ hardware = device_info.get("hardware") or "-"
+ serial = device_info.get("serial") or "-"
+ os_name = device_info.get("os") or "-"
+ version = device_info.get("version") or "-"
+ features = device_info.get("features") or "-"
# Try to match hardware to NetBox DeviceType
hardware_match = match_librenms_hardware_to_device_type(hardware)
@@ -300,11 +329,11 @@ def get_librenms_device_info(self, obj, request=None):
"librenms_device_os": os_name,
"librenms_device_version": version,
"librenms_device_features": features,
- "librenms_device_location": device_info.get("location", "-"),
+ "librenms_device_location": device_info.get("location") or "-",
"librenms_device_ip": librenms_ip,
"sysName": librenms_sysname,
"resolved_name": resolved_name or librenms_sysname,
- "librenms_device_hostname": device_info.get("hostname", "-"),
+ "librenms_device_hostname": device_info.get("hostname") or "-",
"librenms_device_hardware_match": hardware_match,
}
)
@@ -519,23 +548,20 @@ def _get_platform_info(self, librenms_info, obj):
'matching_platform': Platform object or None
}
"""
- from dcim.models import Platform
-
librenms_os = librenms_info["librenms_device_details"].get("librenms_device_os", "-")
librenms_version = librenms_info["librenms_device_details"].get("librenms_device_version", "-")
# Platform name is just the OS (not OS + version)
platform_name = librenms_os if librenms_os != "-" else None
- # Check if platform exists (match by OS name only)
+ # Try case-insensitive exact name match first, then fall back to PlatformMapping
platform_exists = False
matching_platform = None
if platform_name:
- try:
- matching_platform = Platform.objects.get(name__iexact=platform_name)
+ result = find_matching_platform(platform_name)
+ if result["found"] and result["match_type"] != "ambiguous":
+ matching_platform = result["platform"]
platform_exists = True
- except Platform.DoesNotExist:
- pass
return {
"netbox_platform": obj.platform,
diff --git a/netbox_librenms_plugin/views/base/modules_view.py b/netbox_librenms_plugin/views/base/modules_view.py
new file mode 100644
index 0000000000..e6a7221620
--- /dev/null
+++ b/netbox_librenms_plugin/views/base/modules_view.py
@@ -0,0 +1,2471 @@
+import logging
+import re
+
+from django.contrib import messages
+from django.core.cache import cache
+from django.shortcuts import get_object_or_404, render
+from django.utils import timezone
+from django.views import View
+
+from netbox_librenms_plugin.utils import get_librenms_oob, get_librenms_sync_device
+from netbox_librenms_plugin.views.mixins import (
+ CacheMixin,
+ LibreNMSAPIMixin,
+ LibreNMSPermissionMixin,
+)
+
+logger = logging.getLogger(__name__)
+
+
+# entPhysicalClass values relevant for module sync
+# Includes vendor-specific classes (Nokia TIMETRA-CHASSIS-MIB uses ioModule, cpmModule, etc.)
+INVENTORY_CLASSES = {
+ "module",
+ "powerSupply",
+ "fan",
+ "port",
+ "container",
+ "ioModule",
+ "cpmModule",
+ "mdaModule",
+ "fabricModule",
+ "xioModule",
+}
+
+# Model name values that indicate a generic/empty container (not real hardware)
+_GENERIC_CONTAINER_MODELS = {"", "builtin", "default", "n/a"}
+
+# Lowercase placeholder values that LibreNMS returns for absent model/serial fields.
+# Used during transceiver backfill to decide whether existing ENTITY-MIB data should
+# be replaced by richer transceiver API data.
+_PLACEHOLDER_VALUES = {"", "n/a", "na", "default", "-", "unknown"}
+
+# Transceiver entry types that are containers, not real modules.
+_SKIP_TRANSCEIVER_TYPES = {"Port Container", "Port", ""}
+
+# Physical classes filtered out when counting hardware siblings under a parent bay.
+_NON_HARDWARE_CLASSES = {"sensor", "backplane", "stack"}
+
+
+def _check_ignore_rules(
+ item: dict,
+ parent_item: dict | None,
+ rules: list,
+ index_map: dict | None = None,
+ device_serial: str = "",
+) -> str | None:
+ """
+ Return the matched rule action or ``None`` if no rule matches.
+
+ Return values:
+ ``None`` β no rule matched; process the item normally.
+ ``"skip"`` β drop the item from the sync table.
+ ``"transparent"`` β hide the item's row but promote its ENTITY-MIB
+ children to device-level bay matching (used for
+ embedded RPs on fixed-chassis routers).
+
+ Match logic per rule type:
+
+ **serial_matches_device**
+ Matches when the item's ``entPhysicalSerialNum`` equals *device_serial*
+ (the NetBox ``Device.serial`` value) **and** the item sits at chassis
+ level β i.e. has no parent (top-level entity) or its direct parent has
+ ``entPhysicalClass="chassis"``. No name pattern is used.
+ ``require_serial_match_parent`` is ignored for this type.
+
+ The chassis-level requirement prevents the rule from misfiring on
+ chassis-based devices whose line cards happen to share a serial with
+ the device record (e.g. Cisco ASR-9904 with ``Device.serial`` set to
+ the linecard's serial β without the guard, the linecard becomes
+ transparent and its sub-ports collapse to chassis-level bay matching).
+
+ **Name-based types** (ends_with / starts_with / contains / regex):
+ Matches on ``entPhysicalName``. When ``require_serial_match_parent``
+ is True the item is only matched if its serial number is non-empty and
+ equals **any ancestor's** serial in the ENTITY-MIB hierarchy (walking
+ up from the direct parent).
+
+ Ancestor walking handles cases like Cisco IOS-XR where an IDPROM entry
+ is not a direct child of the module it represents β e.g.
+ ``0/RP0/CPU0-Base Board IDPROM`` is a child of ``0/RP0/CPU0-Mother Board``
+ (empty serial), but its serial matches the grandparent ``0/RP0/CPU0``.
+ Traversal stops at the first non-empty serial encountered to avoid false
+ positives deeper in the tree.
+ """
+ item_serial = (item.get("entPhysicalSerialNum") or "").strip()
+ if item_serial.lower() in _PLACEHOLDER_VALUES:
+ item_serial = ""
+ if device_serial.lower() in _PLACEHOLDER_VALUES:
+ device_serial = ""
+ name = (item.get("entPhysicalName") or "").strip()
+
+ for rule in rules:
+ # --- serial_matches_device: no name match, just compare serials ---
+ if rule.match_type == "serial_matches_device":
+ if not (item_serial and device_serial and item_serial == device_serial):
+ continue
+ # Restrict to chassis-level entries. The rule targets fixed-form
+ # routers' system board (top-level or direct child of the chassis
+ # entity); on chassis devices a linecard sharing the device serial
+ # is *not* a system board, and marking it transparent silently
+ # promotes its sub-ports to chassis bay-matching.
+ if parent_item is not None and parent_item.get("entPhysicalClass") != "chassis":
+ continue
+ return rule.action
+
+ # --- name-based rules ---
+ if not rule.matches_name(name):
+ continue
+ if not rule.require_serial_match_parent:
+ return rule.action
+ if parent_item is None:
+ # Can't satisfy serial check without a parent β skip conservatively.
+ continue
+ if not item_serial:
+ continue
+ # Walk up ancestors until a non-empty serial is found.
+ current = parent_item
+ visited: set = set()
+ while current is not None:
+ current_idx = current.get("entPhysicalIndex")
+ if current_idx is not None:
+ if current_idx in visited:
+ break
+ visited.add(current_idx)
+ ancestor_serial = (current.get("entPhysicalSerialNum") or "").strip()
+ if ancestor_serial.lower() in _PLACEHOLDER_VALUES:
+ ancestor_serial = ""
+ if ancestor_serial:
+ if ancestor_serial == item_serial:
+ return rule.action
+ # Non-empty serial that doesn't match β stop looking further up.
+ break
+ if index_map is not None:
+ next_idx = current.get("entPhysicalContainedIn")
+ current = index_map.get(next_idx) if next_idx else None
+ else:
+ break
+ return None
+
+
+class BaseModuleTableView(LibreNMSPermissionMixin, LibreNMSAPIMixin, CacheMixin, View):
+ """
+ Base view for synchronizing module/inventory data from LibreNMS.
+ Fetches inventory, matches against NetBox module bays and module types,
+ and renders a comparison table.
+ """
+
+ model = None
+ partial_template_name = "netbox_librenms_plugin/_module_sync_content.html"
+
+ def get_object(self, pk):
+ """Retrieve the object (Device)."""
+ return get_object_or_404(self.model, pk=pk)
+
+ def get_table(self, data, obj):
+ """Returns the table class. Subclasses should override."""
+ raise NotImplementedError("Subclasses must implement get_table()")
+
+ def _get_sync_device(self, obj):
+ """Resolve the LibreNMS sync device for cache reads/writes in VC contexts."""
+ sync_device = get_librenms_sync_device(obj, server_key=self.librenms_api.server_key)
+ return sync_device or obj
+
+ @staticmethod
+ def _normalize_serial(value):
+ """Normalize serial values for reliable cross-source comparison."""
+ serial = (value or "").strip()
+ if serial.lower() in _PLACEHOLDER_VALUES:
+ return ""
+ return serial
+
+ def _infer_vc_member_for_item(self, obj, item, index_map, vc_members):
+ """
+ Infer VC member ownership for an inventory item using LibreNMS ENTITY data.
+
+ Returns:
+ tuple: (Device, source) where source is a short reason string.
+ """
+ if not vc_members:
+ return obj, "default"
+
+ member_by_serial = {
+ self._normalize_serial(getattr(member, "serial", "")): member
+ for member in vc_members
+ if self._normalize_serial(getattr(member, "serial", ""))
+ }
+
+ item_serial = self._normalize_serial(item.get("entPhysicalSerialNum"))
+ if item_serial and item_serial in member_by_serial:
+ return member_by_serial[item_serial], "serial"
+
+ # Walk ancestors to find a serial tied to a VC member.
+ parent_idx = item.get("entPhysicalContainedIn", 0)
+ visited = set()
+ while parent_idx and parent_idx in index_map and parent_idx not in visited:
+ visited.add(parent_idx)
+ parent = index_map[parent_idx]
+ parent_serial = self._normalize_serial(parent.get("entPhysicalSerialNum"))
+ if parent_serial and parent_serial in member_by_serial:
+ return member_by_serial[parent_serial], "ancestor-serial"
+ parent_idx = parent.get("entPhysicalContainedIn", 0)
+
+ # Position-based fallback from ENTITY parentRelPos.
+ rel_pos = item.get("entPhysicalParentRelPos")
+ try:
+ rel_pos = int(rel_pos)
+ except (TypeError, ValueError):
+ rel_pos = None
+
+ if rel_pos:
+ for member in vc_members:
+ if getattr(member, "vc_position", None) == rel_pos:
+ return member, "position"
+
+ # Name/model hint fallback: common "/..." prefixes.
+ hints = [
+ (item.get("entPhysicalName") or "").strip(),
+ (item.get("entPhysicalDescr") or "").strip(),
+ (item.get("entPhysicalModelName") or "").strip(),
+ ]
+ for hint in hints:
+ if not hint:
+ continue
+ match = re.match(r"^\D*([1-9]\d*)[/:\-].*", hint)
+ if not match:
+ continue
+ try:
+ hinted_pos = int(match.group(1))
+ except (TypeError, ValueError):
+ continue
+ for member in vc_members:
+ if getattr(member, "vc_position", None) == hinted_pos:
+ return member, "name-hint"
+
+ return obj, "default"
+
+ def post(self, request, pk):
+ """Fetch inventory from LibreNMS, cache it, and render the module sync table."""
+ obj = self.get_object(pk)
+ sync_device = self._get_sync_device(obj)
+
+ self.librenms_id = self.librenms_api.get_librenms_id(sync_device)
+ if not self.librenms_id:
+ cache.delete(self.get_cache_key(sync_device, "inventory", server_key=self.librenms_api.server_key))
+ messages.error(request, "Device not found in LibreNMS.")
+ return render(
+ request,
+ self.partial_template_name,
+ {
+ "module_sync": {
+ "object": obj,
+ "table": None,
+ "cache_expiry": None,
+ "server_key": self.librenms_api.server_key,
+ },
+ "has_write_permission": self.has_write_permission(),
+ },
+ )
+
+ success, inventory_data = self.librenms_api.get_device_inventory(self.librenms_id)
+
+ if not success:
+ cache.delete(self.get_cache_key(sync_device, "inventory", server_key=self.librenms_api.server_key))
+ logger.error("Failed to fetch inventory from LibreNMS for device %s: %s", self.librenms_id, inventory_data)
+ messages.error(request, "Failed to fetch inventory from LibreNMS; see server logs for details.")
+ return render(
+ request,
+ self.partial_template_name,
+ {
+ "module_sync": {
+ "object": obj,
+ "table": None,
+ "cache_expiry": None,
+ "server_key": self.librenms_api.server_key,
+ },
+ "has_write_permission": self.has_write_permission(),
+ },
+ )
+
+ for item in inventory_data:
+ item["_source"] = "main"
+
+ # If an OOB controller is linked, fetch its inventory and merge.
+ # Offset OOB entPhysicalIndex values by 1_000_000 to prevent collisions.
+ _server_key = self.librenms_api.server_key
+ oob = get_librenms_oob(obj, server_key=_server_key)
+ if oob and oob.get("id"):
+ oob_success, oob_inventory = self.librenms_api.get_device_inventory(oob["id"])
+ if oob_success:
+ _OOB_OFFSET = 1_000_000
+ for item in oob_inventory:
+ item["_source"] = "oob"
+ if (idx := item.get("entPhysicalIndex")) is not None:
+ item["entPhysicalIndex"] = idx + _OOB_OFFSET
+ if (parent := item.get("entPhysicalContainedIn")) is not None and parent != 0:
+ item["entPhysicalContainedIn"] = parent + _OOB_OFFSET
+ inventory_data = inventory_data + oob_inventory
+
+ # Fetch transceiver data and merge with inventory
+ inventory_data, txr_error = self._merge_transceiver_data(inventory_data)
+
+ # Cache the merged inventory data, namespaced by server and librenms_id to detect remapping
+ cache.set(
+ self.get_cache_key(sync_device, "inventory", server_key=self.librenms_api.server_key),
+ {"inventory": inventory_data, "librenms_id": self.librenms_id},
+ timeout=self.librenms_api.cache_timeout,
+ )
+
+ context = self._build_context(request, obj, inventory_data)
+ if txr_error:
+ logger.warning("Transceiver fetch failed for device %s: %s", self.librenms_id, txr_error)
+ messages.warning(request, "Inventory refreshed, but transceiver fetch failed; see server logs for details.")
+ else:
+ messages.success(request, "Inventory data refreshed successfully.")
+ return render(
+ request,
+ self.partial_template_name,
+ {"module_sync": context, "has_write_permission": self.has_write_permission()},
+ )
+
+ def get_context_data(self, request, obj):
+ """Get context from cache (used by the main sync view on initial page load)."""
+ sync_device = self._get_sync_device(obj)
+ cache_key = self.get_cache_key(sync_device, "inventory", server_key=self.librenms_api.server_key)
+ cached_payload = cache.get(cache_key)
+ if not isinstance(cached_payload, dict) or "inventory" not in cached_payload:
+ cache.delete(cache_key)
+ return {"table": None, "object": obj, "cache_expiry": None, "server_key": self.librenms_api.server_key}
+ # Validate that the cached inventory was built for the same LibreNMS device.
+ # If the object has been remapped to a different device, discard stale inventory.
+ current_librenms_id = self.librenms_api.get_librenms_id(sync_device)
+ if cached_payload.get("librenms_id") != current_librenms_id:
+ cache.delete(cache_key)
+ return {"table": None, "object": obj, "cache_expiry": None, "server_key": self.librenms_api.server_key}
+ return self._build_context(request, obj, cached_payload["inventory"])
+
+ def _build_context(self, request, obj, inventory_data):
+ """Build context with matched inventory items and table."""
+ # Build a lookup of all inventory items by index for parent resolution
+ # Skip items with missing entPhysicalIndex to avoid KeyError on malformed data.
+ index_map = {idx: item for item in inventory_data if (idx := item.get("entPhysicalIndex")) is not None}
+
+ # Precompute parentβchildren map once so _get_sub_components runs in O(n) total.
+ children_by_parent: dict = {}
+ for item in inventory_data:
+ p = item.get("entPhysicalContainedIn")
+ if p is not None:
+ children_by_parent.setdefault(p, []).append(item)
+
+ # Preload all ModuleBayMapping rows once to avoid N+1 queries in _match_module_bay.
+ from netbox_librenms_plugin.utils import (
+ get_enabled_ignore_rules,
+ load_bay_mappings,
+ preload_normalization_rules,
+ )
+
+ self._exact_bay_mappings, self._regex_bay_mappings = load_bay_mappings()
+
+ # Load enabled ignore rules once; passed to _check_ignore_rules throughout.
+ ignore_rules = get_enabled_ignore_rules()
+
+ # Device serial for serial_matches_device rules (strip whitespace defensively).
+ device_serial = (getattr(obj, "serial", None) or "").strip()
+
+ # Manufacturer for module-type normalization rules β passed explicitly to
+ # _build_table_rows/_build_row instead of stored as an instance attribute.
+ manufacturer = getattr(getattr(obj, "device_type", None), "manufacturer", None)
+
+ # Preload NormalizationRule rows once to avoid N+1 queries inside the
+ # _match_module_bay and resolve_module_type loops.
+ self._norm_rules_bay = preload_normalization_rules("module_bay")
+ self._norm_rules_type = preload_normalization_rules("module_type", manufacturer=manufacturer)
+
+ # Pre-compute ignore rule results once to avoid calling _check_ignore_rules
+ # twice per item (once in _find_transparent_indices, once in _collect_top_items).
+ ignore_cache = {
+ item["entPhysicalIndex"]: _check_ignore_rules(
+ item,
+ index_map.get(item.get("entPhysicalContainedIn")),
+ ignore_rules,
+ index_map,
+ device_serial,
+ )
+ for item in inventory_data
+ if item.get("entPhysicalIndex") is not None
+ }
+
+ module_types = self._get_module_types()
+ self._generic_module_types = self._get_generic_module_types()
+ self._module_type_ambiguities = self._get_module_type_ambiguities()
+ self._carrier_install_rules = self._get_carrier_install_rules(manufacturer)
+
+ transparent_indices = self._find_transparent_indices(inventory_data, ignore_cache)
+ top_items = self._collect_top_items(
+ inventory_data, index_map, ignore_rules, device_serial, transparent_indices, ignore_cache
+ )
+ table_data = self._build_table_rows(
+ obj,
+ top_items,
+ index_map,
+ children_by_parent,
+ ignore_rules,
+ device_serial,
+ module_types,
+ manufacturer=manufacturer,
+ )
+
+ # Sort top-level groups by status, keeping children after their parent
+ table_data = self._sort_with_hierarchy(table_data)
+
+ # Bulk-detect serial conflicts for rows that can be replaced/installed
+ self._detect_serial_conflicts(table_data)
+
+ table = self.get_table(table_data, obj)
+ table.configure(request)
+
+ sync_device = self._get_sync_device(obj)
+ cache_ttl = getattr(cache, "ttl", lambda k: None)(
+ self.get_cache_key(sync_device, "inventory", server_key=self.librenms_api.server_key)
+ )
+ cache_expiry = (
+ timezone.now() + timezone.timedelta(seconds=cache_ttl) if cache_ttl is not None and cache_ttl > 0 else None
+ )
+
+ return {
+ "table": table,
+ "object": obj,
+ "cache_expiry": cache_expiry,
+ "server_key": self.librenms_api.server_key,
+ }
+
+ @staticmethod
+ def _find_transparent_indices(inventory_data, ignore_cache):
+ """Identify ENTITY-MIB items that should be treated as transparent parents."""
+ transparent_indices: set = set()
+ for item in inventory_data:
+ idx = item.get("entPhysicalIndex")
+ if idx is None:
+ continue
+ if ignore_cache.get(idx) == "transparent":
+ transparent_indices.add(idx)
+ return transparent_indices
+
+ @staticmethod
+ def _collect_top_items(inventory_data, index_map, ignore_rules, device_serial, transparent_indices, ignore_cache):
+ """
+ Collect top-level inventory items for the sync table.
+
+ Includes synthetic transceiver items. Excludes items that have any
+ ancestor with an INVENTORY_CLASSES class (they appear as sub-components).
+ """
+ top_items = []
+ for item in inventory_data:
+ if item.get("_from_transceiver_api"):
+ idx = item.get("entPhysicalIndex")
+ action = (
+ ignore_cache.get(idx)
+ if idx is not None
+ else _check_ignore_rules(
+ item,
+ index_map.get(item.get("entPhysicalContainedIn")),
+ ignore_rules,
+ index_map,
+ device_serial,
+ )
+ )
+ if action in ("skip", "transparent"):
+ continue
+ # If a parent in the inventory was identified (e.g. via
+ # ``_nest_synthetic_transceivers``), let normal hierarchy
+ # walking render this item under that parent instead of at
+ # the top level.
+ parent_idx = item.get("entPhysicalContainedIn")
+ if parent_idx and parent_idx in index_map:
+ continue
+ top_items.append(item)
+ continue
+ phys_class = item.get("entPhysicalClass")
+ if phys_class not in INVENTORY_CLASSES:
+ continue
+ idx = item.get("entPhysicalIndex")
+ action = (
+ ignore_cache.get(idx)
+ if idx is not None
+ else _check_ignore_rules(
+ item,
+ index_map.get(item.get("entPhysicalContainedIn")),
+ ignore_rules,
+ index_map,
+ device_serial,
+ )
+ )
+ if action == "skip":
+ continue
+ # Transparent items are hidden from the table but must NOT be added as
+ # top-level items β their children will appear instead.
+ if action == "transparent":
+ continue
+ # Skip items with generic model names (not real hardware), regardless of class.
+ model = (item.get("entPhysicalModelName") or "").strip().lower()
+ if model in _GENERIC_CONTAINER_MODELS:
+ continue
+ # Walk up ancestor chain; skip if any ancestor is an inventory-class item.
+ # Transparent ancestors are treated as generic containers.
+ is_descendant = False
+ current_idx = item.get("entPhysicalContainedIn", 0)
+ visited_ancestors = set()
+ while current_idx and current_idx in index_map and current_idx not in visited_ancestors:
+ visited_ancestors.add(current_idx)
+ ancestor = index_map[current_idx]
+ if current_idx in transparent_indices:
+ current_idx = ancestor.get("entPhysicalContainedIn", 0)
+ continue
+ anc_class = ancestor.get("entPhysicalClass")
+ if anc_class in INVENTORY_CLASSES:
+ anc_model = (ancestor.get("entPhysicalModelName") or "").strip().lower()
+ if anc_model in _GENERIC_CONTAINER_MODELS:
+ current_idx = ancestor.get("entPhysicalContainedIn", 0)
+ continue
+ is_descendant = True
+ break
+ current_idx = ancestor.get("entPhysicalContainedIn", 0)
+ if is_descendant:
+ continue
+ top_items.append(item)
+ return top_items
+
+ @staticmethod
+ def _compute_all_bays(device_bays: dict, module_scoped_bays: dict) -> dict:
+ """Build a deterministic flat bay lookup from module-scoped and device bays.
+
+ Module IDs are sorted so the first-match-wins behaviour is stable across
+ runs (lower PK wins on collision). Device-level bays are merged last so
+ they always take precedence over module-scoped bays.
+
+ Logs a DEBUG message when the same bay name appears in more than one
+ module scope.
+ """
+ module_bay_flat: dict = {}
+ collision_names: set = set()
+ for mid in sorted(module_scoped_bays):
+ for name, bay in module_scoped_bays[mid].items():
+ if name in module_bay_flat:
+ collision_names.add(name)
+ else:
+ module_bay_flat[name] = bay
+ all_bays = {**module_bay_flat, **device_bays}
+ if collision_names:
+ logger.debug(
+ "Module-scoped bay name collisions (first-match by module PK kept): %s",
+ sorted(collision_names),
+ )
+ return all_bays
+
+ def _build_table_rows(
+ self,
+ obj,
+ top_items,
+ index_map,
+ children_by_parent,
+ ignore_rules,
+ device_serial,
+ module_types,
+ manufacturer=None,
+ ):
+ """Build table rows from top-level items and their sub-components."""
+ vc_members = list(obj.virtual_chassis.members.all()) if getattr(obj, "virtual_chassis", None) else []
+
+ member_contexts = self._build_member_contexts(obj, vc_members)
+
+ table_data = []
+
+ for item in top_items:
+ target_device, resolution_source = self._infer_vc_member_for_item(obj, item, index_map, vc_members)
+ target_context = member_contexts.get(target_device.id) or member_contexts.get(obj.id)
+ if target_context is None:
+ continue
+ self._append_rows_for_item_context(
+ table_data,
+ item,
+ target_context,
+ index_map,
+ children_by_parent,
+ ignore_rules,
+ device_serial,
+ module_types,
+ manufacturer=manufacturer,
+ selected_device=target_device,
+ resolution_source=resolution_source,
+ )
+
+ return table_data
+
+ def _build_table_rows_for_member(
+ self,
+ member,
+ top_items,
+ index_map,
+ children_by_parent,
+ ignore_rules,
+ device_serial,
+ module_types,
+ manufacturer=None,
+ ):
+ """Build rows using a fixed target member for every inventory item."""
+ member_contexts = self._build_member_contexts(member, vc_members=[])
+ target_context = member_contexts.get(member.id)
+ if target_context is None:
+ return []
+
+ table_data = []
+ for item in top_items:
+ self._append_rows_for_item_context(
+ table_data,
+ item,
+ target_context,
+ index_map,
+ children_by_parent,
+ ignore_rules,
+ device_serial,
+ module_types,
+ manufacturer=manufacturer,
+ selected_device=member,
+ resolution_source="manual",
+ )
+
+ return table_data
+
+ def _build_member_contexts(self, obj, vc_members):
+ """Build per-member bay context data used for row resolution."""
+ member_contexts = {}
+ context_members = vc_members if vc_members else [obj]
+ for member in context_members:
+ device_bays, module_scoped_bays = self._get_module_bays(member)
+ member_contexts[member.id] = {
+ "device": member,
+ "device_bays": device_bays,
+ "module_scoped_bays": module_scoped_bays,
+ "all_bays": self._compute_all_bays(device_bays, module_scoped_bays),
+ "sibling_counts": {mid: len(bays) for mid, bays in module_scoped_bays.items()},
+ }
+ return member_contexts
+
+ def _append_rows_for_item_context(
+ self,
+ table_data,
+ item,
+ target_context,
+ index_map,
+ children_by_parent,
+ ignore_rules,
+ device_serial,
+ module_types,
+ manufacturer,
+ selected_device,
+ resolution_source,
+ ):
+ """Append one top-level item and descendants using one target device context."""
+ # Stash full device-level bay set for the holder-install hint in
+ # _build_no_bay_warning. Set per-item-context so virtual-chassis members
+ # see the right device's bays.
+ self._current_device_bays = target_context.get("device_bays") or {}
+ # Manufacturer for ModuleBayMapping vendor-scoping: prefer mappings
+ # whose manufacturer matches this device's manufacturer; fall back to
+ # vendor-agnostic (NULL) mappings; skip mappings scoped to a different
+ # manufacturer. Set per-item-context so VC members resolve correctly.
+ sel_dt = getattr(selected_device, "device_type", None)
+ sel_mfr = getattr(sel_dt, "manufacturer", None)
+ self._current_manufacturer_id = getattr(sel_mfr, "id", None)
+ self._current_manufacturer_name = getattr(sel_mfr, "name", None)
+ # Top-level items match against the full bay set: device-level bays plus
+ # bays exposed by already-installed carriers/modules. This lets a
+ # cpmModule reported by SNMP at the chassis level (e.g. Nokia 'Slot A')
+ # resolve into a carrier-installed child bay (e.g. CMA's 'CPM A') via a
+ # ModuleBayMapping. device_bays takes precedence on key collisions
+ # because all_bays is built as {**module_bay_flat, **device_bays}.
+ item_bays = target_context["all_bays"]
+ row = self._build_row(
+ item,
+ index_map,
+ item_bays,
+ module_types,
+ depth=0,
+ manufacturer=manufacturer,
+ sibling_counts=target_context["sibling_counts"],
+ )
+ row["selected_device_id"] = selected_device.id
+ row["selected_device_name"] = selected_device.name
+ row["member_resolution_source"] = resolution_source
+ self._apply_carrier_install_rules(row, item, selected_device)
+ parent_row_idx = len(table_data)
+ table_data.append(row)
+
+ # Flag device type as incomplete when a top-level item has no bay and
+ # no mapping suggestion β the device type is likely missing bay templates
+ # for that class of component (fan tray, PSU, etc.).
+ if row.get("status") == "No Bay" and "model_suggestion" not in row:
+ # Before flagging device-type as incomplete, check whether any
+ # bay among the carriers already installed at device level (i.e.
+ # module-scoped child bays) would yield a mapping suggestion.
+ # This handles the common "user installed a carrier card whose
+ # children are letter-named (Slot A β CPM A) and now needs a
+ # ModuleBayMapping" follow-up flow.
+ fallback_suggestion = self._suggest_bay_mapping(item, target_context["all_bays"], scope_preserved=False)
+ if fallback_suggestion:
+ # Pre-fill the suggestion with this device's manufacturer so
+ # the new ModuleBayMapping is auto-scoped to the vendor β the
+ # user can clear it in the form to make it global.
+ if self._current_manufacturer_id:
+ fallback_suggestion.setdefault("manufacturer", self._current_manufacturer_id)
+ if self._current_manufacturer_name:
+ fallback_suggestion.setdefault("manufacturer_name", self._current_manufacturer_name)
+ row["model_suggestion"] = fallback_suggestion
+ # Refresh the warning so the tooltip text reflects the new
+ # suggestion instead of the previous "no candidate" message.
+ row["model_warning"] = self._build_no_bay_warning(item, target_context["all_bays"], fallback_suggestion)
+ # Drop the carrier-install hint badge: a concrete mapping
+ # suggestion is more actionable than "Possible Carrier?".
+ row.pop("holder_hint_present", None)
+ else:
+ device_type = getattr(selected_device, "device_type", None)
+ if device_type:
+ row["device_type_incomplete"] = True
+ row["device_type_incomplete_url"] = device_type.get_absolute_url()
+ row["device_type_incomplete_name"] = str(device_type)
+ row["device_type_incomplete_target_pk"] = device_type.pk
+ row["device_type_incomplete_suggestion"] = self._derive_bay_template_suggestion(item)
+
+ # Determine child bay scope based on parent match state
+ parent_module_id = None
+ parent_bay_matched_but_uninstalled = False
+ parent_installed_module = None
+ if row.get("module_bay_id"):
+ matched_bay = item_bays.get(row["module_bay"])
+ if matched_bay and hasattr(matched_bay, "installed_module") and matched_bay.installed_module:
+ parent_module_id = matched_bay.installed_module.pk
+ parent_installed_module = matched_bay.installed_module
+ else:
+ parent_bay_matched_but_uninstalled = True
+
+ if parent_bay_matched_but_uninstalled:
+ child_bays = {}
+ elif parent_module_id:
+ child_bays = target_context["module_scoped_bays"].get(parent_module_id, {})
+ else:
+ child_bays = target_context["device_bays"]
+
+ # Process sub-components with depth-tracked bay scoping
+ bays_by_depth = {0: child_bays}
+ # Parallel state: at each depth, is the (empty) scope a result of an
+ # uninstalled ancestor bay match? Used to drive the "install parent
+ # first" hint on No Bay rows.
+ scope_uninstalled_init = parent_bay_matched_but_uninstalled
+ scope_uninstalled_by_depth = {0: scope_uninstalled_init}
+ # Parallel state: was the scope inherited from an unmatched ancestor?
+ # Used to suppress mapping suggestions whose target bays would be at
+ # the wrong physical level.
+ scope_preserved_init = not (parent_module_id or parent_bay_matched_but_uninstalled)
+ scope_preserved_by_depth = {0: scope_preserved_init}
+ # Parallel state: is the empty scope specifically because an installed
+ # module's type has no bay templates defined? Distinct from
+ # scope_preserved (unmatched ancestor) and scope_uninstalled (bay
+ # matched but no module installed). Propagates through intermediate
+ # unmatched containers so deeply-nested items still show the right hint.
+ scope_empty_installed_bays_init = bool(parent_module_id) and not child_bays
+ scope_empty_installed_bays_by_depth = {0: scope_empty_installed_bays_init}
+ parent_ent_idx = item.get("entPhysicalIndex")
+ if parent_ent_idx is None:
+ return
+
+ sub_items = self._get_sub_components(
+ parent_ent_idx,
+ children_by_parent,
+ index_map,
+ ignore_rules,
+ device_serial,
+ )
+ for depth, sub_item in sub_items:
+ # Fallbacks return the top-level state so the first iteration
+ # (typically depth=1) inherits the right scope semantics rather
+ # than silently defaulting to False.
+ scope_bays = bays_by_depth.get(depth, child_bays)
+ scope_uninstalled = scope_uninstalled_by_depth.get(depth, scope_uninstalled_init)
+ scope_preserved = scope_preserved_by_depth.get(depth, scope_preserved_init)
+ scope_empty_installed_bays = scope_empty_installed_bays_by_depth.get(depth, scope_empty_installed_bays_init)
+ sub_row = self._build_row(
+ sub_item,
+ index_map,
+ scope_bays,
+ module_types,
+ depth=depth,
+ manufacturer=manufacturer,
+ sibling_counts=target_context["sibling_counts"],
+ scope_uninstalled=scope_uninstalled,
+ scope_preserved=scope_preserved,
+ scope_empty_installed_bays=scope_empty_installed_bays,
+ )
+ sub_row["selected_device_id"] = selected_device.id
+ sub_row["selected_device_name"] = selected_device.name
+ sub_row["member_resolution_source"] = resolution_source
+ self._apply_carrier_install_rules(sub_row, sub_item, selected_device)
+ table_data.append(sub_row)
+
+ # Update bay scope for children of this sub-item.
+ if sub_row.get("module_bay_id"):
+ matched_sub_bay = scope_bays.get(sub_row["module_bay"])
+ if (
+ matched_sub_bay
+ and hasattr(matched_sub_bay, "installed_module")
+ and matched_sub_bay.installed_module
+ ):
+ sub_module_id = matched_sub_bay.installed_module.pk
+ sub_bays = target_context["module_scoped_bays"].get(sub_module_id, {})
+ bays_by_depth[depth + 1] = sub_bays
+ scope_uninstalled_by_depth[depth + 1] = False
+ scope_preserved_by_depth[depth + 1] = False
+ scope_empty_installed_bays_by_depth[depth + 1] = not sub_bays
+ else:
+ bays_by_depth[depth + 1] = {}
+ scope_uninstalled_by_depth[depth + 1] = True
+ scope_preserved_by_depth[depth + 1] = False
+ scope_empty_installed_bays_by_depth[depth + 1] = False
+ else:
+ # Preserve parent scope for unmatched intermediate containers
+ bays_by_depth[depth + 1] = scope_bays
+ scope_uninstalled_by_depth[depth + 1] = scope_uninstalled
+ # Integrated children (e.g. Nokia MDA fused into a XIOM) share
+ # the integrating ancestor's bay scope at the correct hierarchical
+ # level, so propagate the parent's scope_preserved flag rather
+ # than forcing True (which would suppress bay-mapping suggestions
+ # for their grandchildren).
+ if sub_row.get("integrated_in_index"):
+ scope_preserved_by_depth[depth + 1] = scope_preserved
+ else:
+ scope_preserved_by_depth[depth + 1] = True
+ scope_empty_installed_bays_by_depth[depth + 1] = scope_empty_installed_bays
+
+ if sub_row.get("can_install"):
+ table_data[parent_row_idx]["has_installable_children"] = True
+ # When parent bay is uninstalled, sub-rows have empty bays so
+ # can_install is False, but module_type_id is still resolved.
+ # Use it to enable "Install Branch" without a second resolve pass.
+ elif parent_bay_matched_but_uninstalled and sub_row.get("module_type_id"):
+ table_data[parent_row_idx]["has_installable_children"] = True
+
+ # If the installed module's type has no bay templates but has LibreNMS
+ # sub-items, flag the parent row so the table can render a "Fix Model"
+ # badge linking directly to the module type for quick editing.
+ if parent_installed_module and not child_bays:
+ first_no_bay_child_idx = None
+ for i in range(parent_row_idx + 1, len(table_data)):
+ if table_data[i].get("no_bay_reason") == "empty_parent_bays":
+ first_no_bay_child_idx = i
+ break
+ if first_no_bay_child_idx is not None:
+ mt = parent_installed_module.module_type
+ table_data[parent_row_idx]["model_incomplete"] = True
+ table_data[parent_row_idx]["model_incomplete_url"] = mt.get_absolute_url()
+ table_data[parent_row_idx]["model_incomplete_name"] = str(mt)
+ table_data[parent_row_idx]["model_incomplete_target_pk"] = mt.pk
+ child_row = table_data[first_no_bay_child_idx]
+ # Reconstruct a minimal item dict from the row so the helper
+ # can extract a sensible bay name suggestion.
+ child_item = {
+ "entPhysicalName": child_row.get("name") or "",
+ "entPhysicalClass": child_row.get("item_class") or "",
+ "entPhysicalDescr": child_row.get("description") or "",
+ }
+ table_data[parent_row_idx]["model_incomplete_suggestion"] = self._derive_bay_template_suggestion(
+ child_item
+ )
+
+ def _merge_transceiver_data(self, inventory_data):
+ """
+ Merge transceiver API data with entity inventory.
+
+ For vendors like Nokia that don't expose SFPs in ENTITY-MIB,
+ the transceiver API provides SFP model, serial, and type info.
+
+ Strategy:
+ - For transceivers matching existing inventory items by entity_physical_index:
+ supplement entPhysicalModelName if empty
+ - For transceivers NOT in inventory: create synthetic inventory items
+ so they appear in the modules table
+
+ Returns:
+ (inventory_data, error_message) β error_message is None on success
+ or a string when the transceiver API call failed.
+ """
+ success, transceivers = self.librenms_api.get_device_transceivers(self.librenms_id)
+ if not success:
+ return inventory_data, str(transceivers) if transceivers else "unknown error"
+ if not transceivers:
+ return inventory_data, None
+
+ # Build lookup of existing inventory items by index and serial
+ inv_by_index = {idx: item for item in inventory_data if (idx := item.get("entPhysicalIndex")) is not None}
+ inv_serials = {
+ s
+ for item in inventory_data
+ if (s := (item.get("entPhysicalSerialNum") or "").strip()) and s.lower() not in _PLACEHOLDER_VALUES
+ }
+
+ # Build port_id β ifName lookup for better synthetic item naming
+ port_name_map = self._build_port_name_map(transceivers)
+
+ # Types that are containers, not real transceiver modules
+
+ for txr in transceivers:
+ ent_idx = txr.get("entity_physical_index")
+ if not ent_idx:
+ continue
+
+ model = (txr.get("model") or "").strip()
+ if model.lower() in _PLACEHOLDER_VALUES:
+ model = ""
+ serial = (txr.get("serial") or "").strip()
+ if serial.lower() in _PLACEHOLDER_VALUES:
+ serial = ""
+ txr_type = (txr.get("type") or "").strip()
+ if txr_type.lower() in _PLACEHOLDER_VALUES:
+ txr_type = ""
+
+ # Skip containers and entries with no useful data
+ if txr_type in _SKIP_TRANSCEIVER_TYPES and not model and not serial:
+ continue
+
+ # Use transceiver type as model fallback (e.g., "CFP2/QSFP28")
+ display_model = model or (txr_type if txr_type not in _SKIP_TRANSCEIVER_TYPES else "")
+
+ if ent_idx in inv_by_index:
+ # Supplement existing inventory item if model/serial is missing or a placeholder
+ existing = inv_by_index[ent_idx]
+ existing_model = (existing.get("entPhysicalModelName") or "").strip()
+ if (
+ existing_model.lower() in _PLACEHOLDER_VALUES or existing_model.lower() == "builtin"
+ ) and display_model:
+ existing["entPhysicalModelName"] = display_model
+ existing_serial = (existing.get("entPhysicalSerialNum") or "").strip()
+ if (existing_serial.lower() in _PLACEHOLDER_VALUES or existing_serial.lower() == "builtin") and serial:
+ existing["entPhysicalSerialNum"] = serial
+ inv_serials.add(serial)
+ else:
+ # Skip if serial already exists in ENTITY-MIB data (avoid duplicates)
+ if serial and serial in inv_serials:
+ continue
+ # Create synthetic inventory item for SFPs not in entity inventory
+ port_id = txr.get("port_id", 0)
+ ifname = port_name_map.get(port_id)
+ if ifname:
+ name = ifname
+ elif port_id:
+ name = f"Transceiver (port {port_id})"
+ else:
+ name = f"Transceiver {ent_idx}"
+
+ synthetic = {
+ "entPhysicalIndex": ent_idx,
+ "entPhysicalName": name,
+ "entPhysicalClass": "port",
+ "entPhysicalModelName": display_model,
+ "entPhysicalSerialNum": serial,
+ "entPhysicalDescr": txr_type,
+ "entPhysicalContainedIn": 0,
+ "_from_transceiver_api": True,
+ }
+ inventory_data.append(synthetic)
+ # Update dedupe maps so subsequent iterations skip this entry
+ inv_by_index[ent_idx] = synthetic
+ if serial:
+ inv_serials.add(serial)
+
+ # Nest synthetic transceivers under their parent inventory item by
+ # matching the leading slash-separated path components of the synthetic
+ # name (e.g. ``1/1/c1`` or ``2/x1/1/c2``) against existing item
+ # entPhysicalName values. Vendors that name slot/MDA items with the
+ # same path (Nokia: ``MDA 1/1`` / ``MDA 2/x1/1``; Juniper FPC ports;
+ # etc.) get correctly hierarchical rendering instead of a flat list of
+ # orphan transceivers at the top of the modules table.
+ self._nest_synthetic_transceivers(inventory_data)
+
+ return inventory_data, None
+
+ @staticmethod
+ def _nest_synthetic_transceivers(inventory_data):
+ """Set ``entPhysicalContainedIn`` on synthetic transceiver items by
+ matching path-prefix in their name against an existing item's name.
+
+ Generic, vendor-agnostic: only relies on the convention that ports
+ are named like ``a/b/c`` and their parent module is named in a way
+ that ends with the path prefix (e.g. ``MDA 1/1`` for ``1/1/c1``,
+ ``XIOM 2/x1`` for ``2/x1/1/c2`` if the MDA is missing). Items
+ already nested by ENTITY-MIB (``entPhysicalContainedIn != 0``) and
+ non-synthetic items are left untouched.
+ """
+ # Build name β index lookup once
+ name_to_index = {}
+ for it in inventory_data:
+ nm = (it.get("entPhysicalName") or "").strip()
+ if nm:
+ name_to_index.setdefault(nm, it.get("entPhysicalIndex"))
+
+ for it in inventory_data:
+ if not it.get("_from_transceiver_api"):
+ continue
+ if it.get("entPhysicalContainedIn"):
+ continue
+ name = (it.get("entPhysicalName") or "").strip()
+ if not name or "/" not in name:
+ continue
+ parts = name.split("/")
+ # Try the longest prefix first, shortening one component at a time
+ for i in range(len(parts) - 1, 0, -1):
+ prefix = "/".join(parts[:i])
+ parent_idx = None
+ for cand_name, cand_idx in name_to_index.items():
+ if cand_name == prefix or cand_name.endswith(" " + prefix) or cand_name.endswith("/" + prefix):
+ parent_idx = cand_idx
+ break
+ if parent_idx and parent_idx != it.get("entPhysicalIndex"):
+ it["entPhysicalContainedIn"] = parent_idx
+ break
+
+ def _build_port_name_map(self, transceivers):
+ """
+ Build port_id β ifName mapping for transceiver ports.
+
+ Fetches port data from LibreNMS to resolve port IDs to interface names,
+ enabling better bay matching for synthetic transceiver items (e.g.,
+ Nokia 1/1/c1 instead of opaque port IDs).
+ """
+ port_ids = {txr.get("port_id") for txr in transceivers if txr.get("port_id")}
+ if not port_ids:
+ return {}
+
+ success, ports_data = self.librenms_api.get_ports(self.librenms_id)
+ if not success or not isinstance(ports_data, dict):
+ return {}
+
+ ports = ports_data.get("ports")
+ if not isinstance(ports, list):
+ return {}
+
+ return {
+ p["port_id"]: p["ifName"]
+ for p in ports
+ if isinstance(p, dict) and p.get("port_id") in port_ids and p.get("ifName")
+ }
+
+ def _get_sub_components(self, parent_idx, children_by_parent, index_map, ignore_rules, device_serial=""):
+ """
+ Find descendant items with a model name (real hardware, not empty containers).
+
+ Returns list of (depth, item) tuples.
+ """
+ results = []
+ self._collect_descendants(
+ parent_idx,
+ children_by_parent,
+ index_map,
+ ignore_rules,
+ device_serial=device_serial,
+ depth=1,
+ results=results,
+ visited={parent_idx},
+ )
+ return results
+
+ def _collect_descendants(
+ self,
+ parent_idx,
+ children_by_parent,
+ index_map,
+ ignore_rules,
+ depth,
+ results,
+ visited=None,
+ device_serial="",
+ ):
+ """Recursively collect descendant items that have a model name."""
+ if visited is None:
+ visited = set()
+ for child in children_by_parent.get(parent_idx, []):
+ child_idx = child.get("entPhysicalIndex")
+ if child_idx is None:
+ continue
+ if child_idx in visited:
+ continue
+ visited.add(child_idx)
+ # Apply ignore rules: skip drops the item and its subtree; transparent
+ # hides the item but promotes its children to the current depth level.
+ parent_item = index_map.get(parent_idx)
+ action = _check_ignore_rules(child, parent_item, ignore_rules, index_map, device_serial)
+ if action == "skip":
+ continue
+ if action == "transparent":
+ # Don't add this item, but recurse at the same depth so its children
+ # are promoted (appear at the same level as the transparent item would).
+ self._collect_descendants(
+ child_idx,
+ children_by_parent,
+ index_map,
+ ignore_rules,
+ depth=depth,
+ results=results,
+ visited=visited,
+ device_serial=device_serial,
+ )
+ continue
+ model = (child.get("entPhysicalModelName") or "").strip().lower()
+ if model and model not in _GENERIC_CONTAINER_MODELS:
+ results.append((depth, child))
+ # Continue looking for deeper components (e.g., SFPs inside converters)
+ self._collect_descendants(
+ child_idx,
+ children_by_parent,
+ index_map,
+ ignore_rules,
+ depth=depth + 1,
+ results=results,
+ visited=visited,
+ device_serial=device_serial,
+ )
+ else:
+ # Skip generic/empty items, but check their children
+ self._collect_descendants(
+ child_idx,
+ children_by_parent,
+ index_map,
+ ignore_rules,
+ depth=depth,
+ results=results,
+ visited=visited,
+ device_serial=device_serial,
+ )
+
+ def _sort_with_hierarchy(self, table_data):
+ """Sort table keeping children grouped under their parent."""
+ status_order = {
+ "Installed": 0,
+ "Serial Mismatch": 1,
+ "Type Mismatch": 2,
+ "Matched": 3,
+ "No Type": 4,
+ "No Bay": 5,
+ "Unmatched": 6,
+ }
+
+ # Group into top-level items with their children
+ groups = []
+ current_group = None
+ for row in table_data:
+ if row.get("depth", 0) == 0:
+ current_group = {"parent": row, "children": []}
+ groups.append(current_group)
+ elif current_group is not None:
+ current_group["children"].append(row)
+
+ # Sort groups by parent status
+ groups.sort(key=lambda g: status_order.get(g["parent"]["status"], 99))
+
+ # Flatten back
+ result = []
+ for group in groups:
+ result.append(group["parent"])
+ result.extend(group["children"])
+ return result
+
+ def _get_module_bays(self, obj):
+ """
+ Get module bays for the device, organized by scope.
+
+ Returns:
+ tuple: (device_bays, module_bays) where:
+ - device_bays: {name: bay} for device-level bays (module=None)
+ - module_bays: {module_id: {name: bay}} for bays created by installed modules
+ """
+ from dcim.models import ModuleBay
+
+ bays = ModuleBay.objects.filter(device=obj).select_related(
+ "installed_module__module_type",
+ "module__module_bay",
+ )
+ device_bays = {}
+ module_scoped_bays = {}
+ for bay in bays:
+ if bay.module_id:
+ module_scoped_bays.setdefault(bay.module_id, {})[bay.name] = bay
+ else:
+ device_bays[bay.name] = bay
+ return device_bays, module_scoped_bays
+
+ def _get_module_types(self):
+ """Get all module types indexed by model/part_number, with ModuleTypeMapping applied."""
+ from netbox_librenms_plugin.utils import get_module_types_indexed
+
+ return get_module_types_indexed()
+
+ def _get_generic_module_types(self):
+ """Get module types from the 'Generic' manufacturer for secondary fallback matching."""
+ from netbox_librenms_plugin.utils import get_generic_module_types_indexed
+
+ return get_generic_module_types_indexed()
+
+ def _get_module_type_ambiguities(self):
+ """Return part_number/model strings that map to multiple NetBox ModuleTypes."""
+ from netbox_librenms_plugin.utils import get_module_type_ambiguities
+
+ return get_module_type_ambiguities()
+
+ def _get_carrier_install_rules(self, manufacturer):
+ """Return CarrierAutoInstallRule rows applicable to this device."""
+ from django.db.models import Q
+ from dcim.models import Manufacturer as _Manufacturer
+
+ from netbox_librenms_plugin.models import CarrierAutoInstallRule
+
+ qs = CarrierAutoInstallRule.objects.select_related("manufacturer", "carrier_module_type")
+ if isinstance(manufacturer, _Manufacturer):
+ qs = qs.filter(Q(manufacturer__isnull=True) | Q(manufacturer=manufacturer))
+ else:
+ qs = qs.filter(manufacturer__isnull=True)
+ return list(qs)
+
+ def _apply_carrier_install_rules(self, row, item, selected_device):
+ """Attach carrier_install_options to a No Bay row when configured rules match.
+
+ Rules match when:
+ * device_type_pattern (if set) fullmatches the selected device's
+ device_type model;
+ * librenms_child_class equals (case-insensitive) the item's
+ entPhysicalClass;
+ * librenms_child_name_pattern fullmatches the item's entPhysicalName;
+ * at least one EMPTY device-level bay's name fullmatches
+ netbox_bay_name_pattern.
+
+ Each matching (rule, empty bay) pair becomes one suggestion. Also
+ attaches ``device_empty_bay_names`` on No Bay rows so the table can
+ pre-fill an "Add Carrier Rule" link.
+ """
+ if row.get("status") != "No Bay":
+ return
+ device_bays = getattr(self, "_current_device_bays", None) or {}
+ if not device_bays:
+ return
+ empty_bays = [(name, bay) for name, bay in device_bays.items() if not getattr(bay, "installed_module", None)]
+ if not empty_bays:
+ return
+ # Always expose empty bay names on No Bay rows so the table can
+ # pre-fill an "Add Carrier Rule" form even when no rule matches.
+ row["device_empty_bay_names"] = [name for name, _ in empty_bays]
+
+ rules = getattr(self, "_carrier_install_rules", None) or []
+ if not rules:
+ return
+ device_type = getattr(selected_device, "device_type", None)
+ device_type_model = getattr(device_type, "model", "") or ""
+ item_class = (item.get("entPhysicalClass") or "").strip().lower() if item else ""
+ item_name = (item.get("entPhysicalName") or "").strip() if item else ""
+
+ options = []
+ for rule in rules:
+ if rule.librenms_child_class.strip().lower() != item_class:
+ continue
+ dt_re = rule._compiled_device_type_pattern
+ if dt_re is not None and not dt_re.fullmatch(device_type_model):
+ continue
+ child_re = rule._compiled_child_name_pattern
+ if child_re is None or not child_re.fullmatch(item_name):
+ continue
+ bay_re = rule._compiled_bay_name_pattern
+ if bay_re is None:
+ continue
+ mt = rule.carrier_module_type
+ for bay_name, bay in empty_bays:
+ if not bay_re.fullmatch(bay_name):
+ continue
+ options.append(
+ {
+ "rule_id": rule.pk,
+ "module_type_id": mt.pk,
+ "module_type_name": str(mt),
+ "bay_id": bay.pk,
+ "bay_name": bay_name,
+ }
+ )
+ if options:
+ row["carrier_install_options"] = options
+
+ def _find_parent_container_name(self, item, index_map):
+ """
+ Resolve the nearest ancestor container name by walking up the containment chain.
+
+ Skips ancestors with an empty entPhysicalName and continues upward until a
+ non-empty name is found or the chain is exhausted.
+ """
+ contained_in = item.get("entPhysicalContainedIn", 0)
+ visited: set = set()
+ while contained_in and contained_in in index_map and contained_in not in visited:
+ visited.add(contained_in)
+ parent = index_map[contained_in]
+ name = (parent.get("entPhysicalName") or "").strip()
+ if name:
+ return name
+ contained_in = parent.get("entPhysicalContainedIn", 0)
+ return None
+
+ def _match_module_bay(self, item, index_map, module_bays):
+ """
+ Try to match an inventory item to a NetBox ModuleBay.
+ Checks ModuleBayMapping table first (exact then regex), then falls back
+ to exact parent name match, then positional matching.
+ """
+ parent_name = self._find_parent_container_name(item, index_map)
+ item_name = (item.get("entPhysicalName") or "").strip()
+ item_descr = (item.get("entPhysicalDescr") or "").strip()
+ phys_class = (item.get("entPhysicalClass") or "").strip()
+ manufacturer_id = getattr(self, "_current_manufacturer_id", None)
+
+ # Build candidate names: parent, item name, item description
+ candidate_names = [n for n in [parent_name, item_name, item_descr] if n]
+
+ from netbox_librenms_plugin.utils import apply_normalization_rules
+
+ norm_rules_bay = getattr(self, "_norm_rules_bay", None)
+ normalized_extras = []
+ for name in candidate_names:
+ normalized = apply_normalization_rules(name, "module_bay", preloaded_rules=norm_rules_bay)
+ if normalized != name and normalized not in candidate_names and normalized not in normalized_extras:
+ normalized_extras.append(normalized)
+ all_candidates = candidate_names + normalized_extras
+
+ # Use preloaded exact mappings (set in _build_context to avoid N+1 queries).
+ exact_mappings = getattr(self, "_exact_bay_mappings", None)
+ if exact_mappings is None:
+ from netbox_librenms_plugin.models import ModuleBayMapping
+
+ exact_mappings = list(ModuleBayMapping.objects.filter(is_regex=False))
+
+ # Check ModuleBayMapping table for each candidate (exact match)
+ for name in all_candidates:
+ bay = self._lookup_exact_bay_mapping(name, phys_class, module_bays, exact_mappings, manufacturer_id)
+ if bay:
+ return bay
+
+ # Use preloaded regex mappings.
+ regex_mappings = getattr(self, "_regex_bay_mappings", None)
+ if regex_mappings is None:
+ from netbox_librenms_plugin.models import ModuleBayMapping
+
+ regex_mappings = list(ModuleBayMapping.objects.filter(is_regex=True))
+
+ # Regex pattern matching on all candidate names
+ for name in all_candidates:
+ bay = self._lookup_regex_bay_mapping(name, phys_class, module_bays, regex_mappings, manufacturer_id)
+ if bay:
+ return bay
+
+ # Fallback: exact match on candidate names against bay dict, with FPC-scope check
+ for name in all_candidates:
+ if name in module_bays:
+ maps = module_bays.maps if hasattr(module_bays, "maps") else [module_bays]
+ for scope_map in maps:
+ if name in scope_map:
+ bay = scope_map[name]
+ if BaseModuleTableView._fpc_slot_matches(name, bay):
+ return bay
+
+ # Positional fallback: determine slot number from container sibling order
+ # Handles SFPs inside converters where containers are unnamed
+ bay = self._match_bay_by_position(item, index_map, module_bays)
+ if bay:
+ return bay
+
+ return None
+
+ @staticmethod
+ def _fpc_slot_matches(candidate_name, bay):
+ """
+ Validate that a regex-matched bay's parent slot position is consistent with
+ a positional descriptor like 'Model @ FPC/pic/port'.
+
+ Returns True if the descriptor has no FPC reference, or if the bay's parent
+ module slot position matches the FPC number in the descriptor. Prevents
+ orphaned top-level items (e.g. QSFP @ 1/1/1 when FPC1 is not installed)
+ from incorrectly matching bays belonging to a different FPC's module.
+ """
+ match = re.search(r"@\s+(\d+)/", candidate_name)
+ if not match:
+ return True
+ try:
+ expected_fpc = int(match.group(1))
+ except (ValueError, IndexError):
+ return True
+ module = getattr(bay, "module", None)
+ if not module:
+ return True
+ parent_bay = getattr(module, "module_bay", None)
+ if not parent_bay:
+ return True
+ try:
+ return int(parent_bay.position) == expected_fpc
+ except (TypeError, ValueError):
+ return False
+
+ @staticmethod
+ def _filter_mappings_by_manufacturer(mappings, manufacturer_id):
+ """
+ Order mappings by manufacturer scoping priority:
+ device-manufacturer match first, then vendor-agnostic (NULL), skip
+ mappings scoped to a different manufacturer.
+ """
+ scoped = []
+ global_ = []
+ for m in mappings:
+ mfr = getattr(m, "manufacturer_id", None)
+ if mfr is None:
+ global_.append(m)
+ elif manufacturer_id and mfr == manufacturer_id:
+ scoped.append(m)
+ return scoped + global_
+
+ @staticmethod
+ def _lookup_exact_bay_mapping(name, phys_class, module_bays, exact_mappings, manufacturer_id=None):
+ """
+ Try exact ModuleBayMapping entries against a candidate name.
+
+ Checks class-scoped mappings first, then falls back to classless mappings.
+ Within each scope, prefers manufacturer-matched mappings over global ones
+ and skips mappings scoped to a different manufacturer.
+ Iterates the underlying dict scopes (supports both plain dicts and legacy
+ ChainMap instances) so the returned bay is validated via _fpc_slot_matches.
+ Returns the matched module bay or None.
+ """
+ maps = module_bays.maps if hasattr(module_bays, "maps") else [module_bays]
+ scoped_mappings = BaseModuleTableView._filter_mappings_by_manufacturer(exact_mappings, manufacturer_id)
+ if phys_class:
+ mapping = next(
+ (m for m in scoped_mappings if m.librenms_name == name and m.librenms_class == phys_class), None
+ )
+ if mapping and mapping.netbox_bay_name in module_bays:
+ for scope_map in maps:
+ if mapping.netbox_bay_name in scope_map:
+ bay = scope_map[mapping.netbox_bay_name]
+ if BaseModuleTableView._fpc_slot_matches(name, bay):
+ return bay
+ mapping = next((m for m in scoped_mappings if m.librenms_name == name and m.librenms_class == ""), None)
+ if mapping and mapping.netbox_bay_name in module_bays:
+ for scope_map in maps:
+ if mapping.netbox_bay_name in scope_map:
+ bay = scope_map[mapping.netbox_bay_name]
+ if BaseModuleTableView._fpc_slot_matches(name, bay):
+ return bay
+ return None
+
+ @staticmethod
+ def _lookup_regex_bay_mapping(name, phys_class, module_bays, regex_mappings, manufacturer_id=None):
+ """
+ Try regex ModuleBayMapping patterns against a name.
+
+ ``regex_mappings`` is a pre-filtered list of is_regex=True ModuleBayMapping
+ objects (passed in from the caller to avoid per-item DB queries).
+ Manufacturer-scoped mappings (matching the device's manufacturer) take
+ precedence over vendor-agnostic ones; mappings scoped to a different
+ manufacturer are skipped.
+
+ Returns matched module bay or None.
+ """
+ scoped_mappings = BaseModuleTableView._filter_mappings_by_manufacturer(regex_mappings, manufacturer_id)
+ # Filter preloaded list by class (exact class match, then empty-class fallback)
+ if phys_class:
+ exact = [m for m in scoped_mappings if m.librenms_class == phys_class]
+ fallback = [m for m in scoped_mappings if m.librenms_class == ""]
+ candidates = exact + fallback
+ else:
+ candidates = [m for m in scoped_mappings if m.librenms_class == ""]
+
+ for mapping in candidates:
+ compiled = mapping._compiled_pattern
+ if compiled is None:
+ continue
+ try:
+ match = compiled.fullmatch(name)
+ except re.error:
+ continue
+ if not match:
+ continue
+ try:
+ resolved_bay = match.expand(mapping.netbox_bay_name)
+ except (re.error, IndexError):
+ continue
+ if resolved_bay in module_bays:
+ maps = module_bays.maps if hasattr(module_bays, "maps") else [module_bays]
+ for scope_map in maps:
+ if resolved_bay in scope_map:
+ bay = scope_map[resolved_bay]
+ if BaseModuleTableView._fpc_slot_matches(name, bay):
+ return bay
+ return None
+
+ @staticmethod
+ def _match_bay_by_position(item, index_map, module_bays):
+ """
+ Match bay by item's positional order among container siblings.
+
+ When an item is inside a container (no model), walk up to find the
+ nearest ancestor with a real hardware model, count which container slot
+ the item occupies, and match to the bay by number (e.g., SFP 1, SFP 2).
+ """
+ # Walk up through containers with placeholder/empty models to find the
+ # parent with a real hardware model. Use a visited set to detect cycles.
+ #
+ # Only walk through ENTITY-MIB containers (entPhysicalClass="container").
+ # A modelless ancestor of any other class (e.g. class="module" with
+ # model="N/A" β Cisco IOS-XR uses these for motherboard/slice/EZChip
+ # scaffolding under a linecard) is hierarchical scaffolding, not a bay
+ # position; walking past it would silently align all deeply nested
+ # siblings to the same bay slot on the parent module. Bail in that case.
+ current_idx = item.get("entPhysicalContainedIn", 0)
+ container_idx = None
+ visited = set()
+ while current_idx and current_idx in index_map and current_idx not in visited:
+ visited.add(current_idx)
+ ancestor = index_map[current_idx]
+ model = (ancestor.get("entPhysicalModelName") or "").strip().lower()
+ if model and model not in _GENERIC_CONTAINER_MODELS:
+ # Found the parent with a real model; container_idx is the intermediate container
+ break
+ cls = ancestor.get("entPhysicalClass") or ""
+ if cls != "container":
+ return None
+ container_idx = current_idx
+ current_idx = ancestor.get("entPhysicalContainedIn", 0)
+ else:
+ return None
+
+ if not container_idx:
+ return None
+
+ # Determine position: count siblings under the parent, filtering out
+ # non-hardware items (sensors, LEDs) that would shift the bay index.
+ parent_with_model_idx = current_idx
+ siblings = sorted(
+ [
+ i
+ for i in index_map.values()
+ if i.get("entPhysicalContainedIn") == parent_with_model_idx
+ and i.get("entPhysicalClass") not in _NON_HARDWARE_CLASSES
+ ],
+ key=lambda x: (
+ int(x.get("entPhysicalParentRelPos") or 0)
+ if str(x.get("entPhysicalParentRelPos", "0")).lstrip("-").isdigit()
+ else 0
+ ),
+ )
+ slot_num = None
+ for i, sib in enumerate(siblings):
+ if sib["entPhysicalIndex"] == container_idx:
+ slot_num = i + 1
+ break
+
+ if slot_num is None:
+ return None
+
+ # Pick patterns appropriate for the item's hardware class. Without this,
+ # a fan or power-supply lands in a module/line-card "Slot N" bay because
+ # `Slot N` is in every chassis device β silently mis-installing the wrong
+ # hardware class. When NetBox lacks bays named for the item's class
+ # (e.g. no "Fan Tray N" / "PSU N" defined on the device type), we
+ # surface "No Bay" and let the user fix the model rather than guess.
+ phys_class = (item.get("entPhysicalClass") or "").strip().lower()
+ if phys_class == "fan":
+ patterns = [f"Fan Tray {slot_num}", f"Fan {slot_num}", f"FT {slot_num}", f"FT{slot_num}"]
+ elif phys_class == "powersupply":
+ patterns = [
+ f"Power Supply {slot_num}",
+ f"PSU {slot_num}",
+ f"PSU{slot_num}",
+ f"PS{slot_num}",
+ f"PEM {slot_num}",
+ f"PM {slot_num}",
+ f"PM{slot_num}",
+ ]
+ elif phys_class in {"module", "port", "iomodule", "cpmmodule", "mdamodule", "fabricmodule", "xiomodule"}:
+ patterns = [f"SFP {slot_num}", f"Slot {slot_num}", f"Bay {slot_num}", f"Port {slot_num}"]
+ else:
+ return None
+
+ for pattern in patterns:
+ if pattern in module_bays:
+ return module_bays[pattern]
+
+ return None
+
+ def _build_row(
+ self,
+ item,
+ index_map,
+ module_bays,
+ module_types,
+ depth=0,
+ manufacturer=None,
+ sibling_counts=None,
+ scope_uninstalled=False,
+ scope_preserved=False,
+ scope_empty_installed_bays=False,
+ ):
+ """Build a single table row from a LibreNMS inventory item.
+
+ ``scope_uninstalled`` (caller-provided) indicates the empty bay scope
+ is empty because some ancestor's bay matched but has no installed
+ module β the user can fix the row by installing the ancestor first
+ (which materialises the bay templates) rather than by editing the
+ device/module-type templates.
+
+ ``scope_preserved`` indicates the scope was inherited from an
+ ancestor that didn't match a bay (so the bays in scope don't
+ accurately reflect the item's nesting level). Used to suppress
+ misleading mapping suggestions that would land deeply-nested
+ items in chassis-level bays.
+
+ ``scope_empty_installed_bays`` indicates the empty scope is because
+ the nearest installed module ancestor's type has no bay templates
+ defined. Propagates through intermediate unmatched containers so
+ deeply-nested items (e.g. SFPs nested under a transceiver carrier)
+ still show "No Bay on Parent" rather than plain "No Bay"."""
+ from netbox_librenms_plugin.utils import (
+ has_nested_name_conflict,
+ resolve_module_type,
+ )
+
+ model_name = (item.get("entPhysicalModelName", "") or "").strip()
+ serial = (item.get("entPhysicalSerialNum", "") or "").strip()
+ phys_class = item.get("entPhysicalClass", "")
+ name = item.get("entPhysicalName", "") or "-"
+ description = item.get("entPhysicalDescr", "") or ""
+
+ # Detect "integrated child" SNMP duplicates (e.g. Nokia XIOM with a
+ # fixed integrated MDA exposed as two ENTITY-MIB rows sharing the
+ # same serial+model). The child row is informational only β it has
+ # no separate bay/type to match β so render it muted with no
+ # actions and no warnings.
+ integrating_ancestor = self._find_integrating_ancestor(item, index_map)
+ if integrating_ancestor is not None:
+ ancestor_name = (integrating_ancestor.get("entPhysicalName") or "").strip() or "parent module"
+ return {
+ "name": name,
+ "model": model_name or "-",
+ "serial": serial or "-",
+ "description": description,
+ "item_class": phys_class,
+ "module_bay": "-",
+ "module_type": "-",
+ "status": "Integrated",
+ "can_install": False,
+ "module_bay_id": None,
+ "module_type_id": None,
+ "depth": depth,
+ "ent_physical_index": item.get("entPhysicalIndex"),
+ "has_installable_children": False,
+ "integrated_in_name": ancestor_name,
+ "integrated_in_index": integrating_ancestor.get("entPhysicalIndex"),
+ }
+
+ # Match to NetBox module bay
+ matched_bay = self._match_module_bay(item, index_map, module_bays)
+
+ # Match to NetBox module type (direct lookup, normalization fallback, then Generic fallback)
+ norm_rules_type = getattr(self, "_norm_rules_type", None)
+ generic_module_types = getattr(self, "_generic_module_types", None)
+ matched_type = resolve_module_type(
+ model_name,
+ module_types,
+ manufacturer=manufacturer,
+ norm_rules=norm_rules_type,
+ generic_fallback=generic_module_types,
+ )
+
+ # Determine status; override to "Name Conflict" when the matched module
+ # type uses {module} in interface templates and has sibling bays (which
+ # would produce duplicate interface names on install).
+ status = self._determine_status(matched_bay, matched_type, serial)
+ name_conflict_reason = ""
+ if matched_type and matched_bay:
+ name_conflict_reason = has_nested_name_conflict(matched_type, matched_bay, sibling_counts)
+ if name_conflict_reason:
+ status = "Name Conflict"
+
+ row = {
+ "name": name,
+ "model": model_name or "-",
+ "serial": serial or "-",
+ "description": description,
+ "item_class": phys_class,
+ "module_bay": matched_bay.name if matched_bay else "-",
+ "module_type": matched_type.model if matched_type else "-",
+ "status": status,
+ "can_install": False,
+ "module_bay_id": matched_bay.pk if matched_bay else None,
+ "module_type_id": matched_type.pk if matched_type else None,
+ "depth": depth,
+ "ent_physical_index": item.get("entPhysicalIndex"),
+ "has_installable_children": False,
+ "_source": item.get("_source", "main"),
+ }
+ if name_conflict_reason:
+ row["name_conflict_reason"] = name_conflict_reason
+
+ # Surface NetBox-model gaps that produced No Bay / No Type so the user
+ # can fix the model rather than wonder why nothing matched.
+ if status == "No Bay":
+ suggestion = self._suggest_bay_mapping(item, module_bays, scope_preserved=scope_preserved)
+ holder_hint = None
+ if suggestion is None:
+ holder_hint = self._build_holder_install_hint(
+ item,
+ phys_class,
+ getattr(self, "_current_device_bays", None),
+ scope_uninstalled=scope_uninstalled,
+ scope_empty_installed_bays=scope_empty_installed_bays,
+ )
+ row["model_warning"] = self._build_no_bay_warning(
+ item, module_bays, suggestion, scope_uninstalled=scope_uninstalled, holder_hint=holder_hint
+ )
+ if suggestion:
+ # Pre-fill manufacturer from current device so the new mapping
+ # is auto-scoped to the vendor (the user can clear it in the
+ # form to make it global).
+ mfr_id = getattr(self, "_current_manufacturer_id", None)
+ mfr_name = getattr(self, "_current_manufacturer_name", None)
+ if mfr_id:
+ suggestion.setdefault("manufacturer", mfr_id)
+ if mfr_name:
+ suggestion.setdefault("manufacturer_name", mfr_name)
+ row["model_suggestion"] = suggestion
+ if holder_hint:
+ row["holder_hint_present"] = True
+ # Tag the root cause so the table can render a more specific status
+ # badge: installed parent module has no bay templates at all.
+ if scope_empty_installed_bays and not scope_uninstalled:
+ row["no_bay_reason"] = "empty_parent_bays"
+ elif status == "No Type":
+ ambiguities = getattr(self, "_module_type_ambiguities", None)
+ ambiguity_candidates = self._find_ambiguity_candidates(
+ model_name, ambiguities, manufacturer=manufacturer, norm_rules=norm_rules_type
+ )
+ row["model_warning"] = self._build_no_type_warning(item, ambiguity_candidates=ambiguity_candidates)
+ if ambiguity_candidates:
+ row["module_type_ambiguity"] = [
+ {
+ "pk": mt.pk,
+ "model": mt.model,
+ "manufacturer": mt.manufacturer.name if getattr(mt, "manufacturer", None) else "",
+ "url": mt.get_absolute_url() if hasattr(mt, "get_absolute_url") else "",
+ }
+ for mt in ambiguity_candidates
+ ]
+ # Don't offer "Add Module Type" or auto-mapping when the user
+ # already has too many β they need to disambiguate first.
+ else:
+ type_suggestion = self._suggest_type_mapping(item, matched_bay)
+ if type_suggestion:
+ # Pre-fill manufacturer from current device so the new
+ # mapping is auto-scoped to the vendor (the user can clear
+ # it in the form to make it global).
+ mfr_id = getattr(self, "_current_manufacturer_id", None)
+ mfr_name = getattr(self, "_current_manufacturer_name", None)
+ if mfr_id:
+ type_suggestion.setdefault("manufacturer", mfr_id)
+ if mfr_name:
+ type_suggestion.setdefault("manufacturer_name", mfr_name)
+ row["type_suggestion"] = type_suggestion
+ module_type_create = self._suggest_module_type_create(item, manufacturer)
+ if module_type_create:
+ row["module_type_create"] = module_type_create
+
+ # Add URLs for matched objects
+ if matched_bay:
+ row["module_bay_url"] = matched_bay.get_absolute_url()
+ # Check if a module is already installed in this bay
+ if hasattr(matched_bay, "installed_module") and matched_bay.installed_module:
+ installed = matched_bay.installed_module
+ row["installed_module"] = installed
+ row["module_url"] = installed.get_absolute_url()
+ row["installed_module_id"] = installed.pk
+ self._apply_installed_status(row, installed, matched_type, serial)
+ elif matched_type:
+ # Bay exists, type matched, no module installed β can install
+ row["can_install"] = True
+
+ if matched_type:
+ row["module_type_url"] = matched_type.get_absolute_url()
+
+ # Re-apply "Name Conflict" last β _apply_installed_status may have
+ # overwritten it with "Installed" / "Serial Mismatch" / "Type Mismatch".
+ if name_conflict_reason:
+ row["status"] = "Name Conflict"
+
+ return row
+
+ @staticmethod
+ def _apply_installed_status(row, installed, matched_type, serial):
+ """Set status and action flags when a module is already installed."""
+ if matched_type is not None and installed.module_type_id != matched_type.pk:
+ row["status"] = "Type Mismatch"
+ row["can_replace"] = True
+ elif matched_type is not None:
+ # Normalize both serials: treat None, empty, whitespace, and placeholder values as absent
+ nb_serial = (installed.serial or "").strip()
+ if nb_serial.lower() in _PLACEHOLDER_VALUES:
+ nb_serial = ""
+ lnms_serial = serial if serial.lower() not in _PLACEHOLDER_VALUES else ""
+ if lnms_serial and lnms_serial != nb_serial:
+ row["status"] = "Serial Mismatch"
+ row["can_update_serial"] = True
+ row["can_replace"] = True
+ else:
+ row["status"] = "Installed"
+ else:
+ row["status"] = "No Type"
+
+ def _determine_status(self, matched_bay, matched_type, serial):
+ """Determine the sync status for an inventory item."""
+ if matched_bay and matched_type:
+ return "Matched"
+ if not matched_bay:
+ return "No Bay"
+ if not matched_type:
+ return "No Type"
+ return "Unmatched"
+
+ @staticmethod
+ def _derive_bay_template_suggestion(item):
+ """
+ Derive a sensible pre-fill for the Add Bay Template modal from a
+ LibreNMS inventory item dict.
+
+ Returns a dict with keys ``name``, ``position`` and ``label``.
+
+ - ``name``: the LibreNMS item name as-is (the user can edit before
+ submit). Falls back to a class-derived placeholder when the name
+ is empty.
+ - ``position``: the trailing digit/letter token of the name when
+ present (e.g. "Slot 1" -> "1", "CMA-A" -> "A").
+ - ``label``: the LibreNMS description (entPhysicalDescr) trimmed,
+ which is usually a richer human-readable label than the bay name.
+ """
+ raw_name = (item.get("entPhysicalName") or "").strip()
+ descr = (item.get("entPhysicalDescr") or "").strip()
+ phys_class = (item.get("entPhysicalClass") or "").strip().lower()
+
+ position = ""
+ if raw_name:
+ m = re.search(r"(\d+|[A-Za-z]+)$", raw_name)
+ if m:
+ position = m.group(0)
+
+ if not raw_name:
+ class_placeholders = {
+ "fan": "Fan Tray 1",
+ "powersupply": "Power Supply 1",
+ "port": "Port 1",
+ }
+ raw_name = class_placeholders.get(phys_class, "Slot 1")
+ position = re.search(r"\d+$", raw_name).group(0)
+
+ return {
+ "name": raw_name,
+ "position": position,
+ "label": descr,
+ # Original LibreNMS values β passed through to the Add Bay Template
+ # modal so it can offer to also create a matching ModuleBayMapping
+ # when the user picks a NetBox bay name that differs from the
+ # LibreNMS one (case differences, vendor naming, etc.). Bay
+ # matching is exact + case-sensitive dict lookup, so without a
+ # mapping the row would still show "No Bay" after the bay is added.
+ "librenms_name": (item.get("entPhysicalName") or "").strip(),
+ "librenms_class": (item.get("entPhysicalClass") or "").strip(),
+ }
+
+ @staticmethod
+ def _build_no_bay_warning(item, module_bays, suggestion=None, scope_uninstalled=False, holder_hint=None):
+ """
+ Hint the user toward the missing piece of the NetBox model when bay
+ matching produces "No Bay".
+
+ Distinguishes:
+ - empty scope due to an uninstalled ancestor -> install the ancestor
+ module first (its bay templates will then be available)
+ - empty scope due to no bay templates -> add bay templates to the
+ parent module/device type
+ - non-empty scope, hardware-class mismatch (fan / powerSupply) ->
+ add the appropriate class bay templates
+ - non-empty scope, generic module/port -> add Slot/SFP/Bay/Port
+ templates or a ModuleBayMapping
+
+ When a `suggestion` dict is provided (from `_suggest_bay_mapping`),
+ appends the proposed regex/target so the user sees a concrete fix
+ alongside the diagnosis.
+ """
+ phys_class = (item.get("entPhysicalClass") or "").strip().lower()
+ class_hints = {
+ "fan": "Fan Tray N or Fan N",
+ "powersupply": "Power Supply N, PSU N, or PEM N",
+ }
+ module_classes = {"module", "port", "iomodule", "cpmmodule", "mdamodule", "fabricmodule", "xiomodule"}
+
+ if phys_class in class_hints:
+ class_part = f"No bay defined for class={phys_class}; add {class_hints[phys_class]} bay templates"
+ elif phys_class in module_classes:
+ class_part = "No matching bay; add Slot N / SFP N / Bay N / Port N bay templates"
+ else:
+ class_part = "No matching bay; verify NetBox bay templates"
+
+ if not module_bays:
+ if scope_uninstalled:
+ base = (
+ "An ancestor module bay matched but has no module installed in NetBox; "
+ "install the parent module first so its bay templates become available, "
+ "then refresh this tab."
+ )
+ else:
+ base = (
+ f"Parent module type has no bay templates defined in NetBox. {class_part} "
+ "to the parent module/device type, or add a ModuleBayMapping."
+ )
+ else:
+ base = f"{class_part} on the NetBox device or parent module type, or add a ModuleBayMapping."
+
+ if suggestion:
+ base += (
+ f" Suggested mapping: librenms_name='{suggestion['librenms_name']}' "
+ f"(regex), librenms_class='{suggestion.get('librenms_class') or ''}', "
+ f"netbox_bay_name='{suggestion['netbox_bay_name']}' "
+ f"β would map '{suggestion['example_item']}' to '{suggestion['example_bay']}' "
+ "and any sibling with the same trailing-number pattern."
+ )
+ if holder_hint:
+ base += f" {holder_hint}"
+ return base
+
+ @staticmethod
+ def _build_holder_install_hint(
+ item, phys_class, device_bays, scope_uninstalled=False, scope_empty_installed_bays=False
+ ):
+ """
+ Vendor-agnostic hint that surfaces the "missing holder/carrier module" pattern.
+
+ Some chassis (e.g. Nokia 7750 SR-s with CMA controller carriers, mezzanine
+ carriers, line-card cassettes) expose a holder module bay at the chassis
+ level. Until the holder ModuleType is installed in that bay, NetBox does
+ not expose the holder's nested child bays β so LibreNMS-reported children
+ (CPMs, MDAs, mezzanines) appear with no matching bay.
+
+ Triggers only when:
+ * the unmatched item is a module-class component (not fan/PSU);
+ * we are not already showing a more specific hint
+ (scope_uninstalled / scope_empty_installed_bays);
+ * the device has at least one EMPTY device-level bay.
+
+ The hint is informational only β it lists the empty bay names so the
+ user can recognise the pattern and install the appropriate holder
+ ModuleType themselves. Doing so will expose nested child bays which
+ will then match LibreNMS-reported children automatically.
+ """
+ if scope_uninstalled or scope_empty_installed_bays:
+ return None
+ # Only items that could plausibly be a "card inside a carrier" β i.e.
+ # named module-class items at the top of the SNMP tree. Excludes plain
+ # 'port' (transceivers, where the right fix is line-card bay templates,
+ # not a chassis-level carrier) and items whose name encodes a path
+ # like '1/1/c1' (clearly nested, not a top-level holder child).
+ holder_child_classes = {
+ "module",
+ "iomodule",
+ "cpmmodule",
+ "mdamodule",
+ "fabricmodule",
+ "xiomodule",
+ "container",
+ }
+ if (phys_class or "").strip().lower() not in holder_child_classes:
+ return None
+ item_name = (item.get("entPhysicalName") or "").strip() if item else ""
+ if "/" in item_name:
+ return None
+ if not device_bays:
+ return None
+ empty_names = sorted(name for name, bay in device_bays.items() if not getattr(bay, "installed_module", None))
+ if not empty_names:
+ return None
+ # Cap the listed names to keep the message readable on wide chassis.
+ shown = empty_names[:5]
+ more = "" if len(empty_names) <= 5 else f" (+{len(empty_names) - 5} more)"
+ names_text = ", ".join(f"'{n}'" for n in shown) + more
+ return (
+ f"Tip: device has empty bay(s) [{names_text}]. "
+ "Some chassis require a holder/carrier module (e.g. controller-card "
+ "carrier, mezzanine carrier, line-card cassette) to be installed in "
+ "such a bay before nested child bays become available β install the "
+ "appropriate ModuleType if applicable, then refresh."
+ )
+
+ @staticmethod
+ def _suggest_bay_mapping(item, module_bays, scope_preserved=False):
+ """
+ Suggest a ModuleBayMapping that would resolve a No Bay row.
+
+ Heuristic: when the item's name ends with a number and a bay in scope
+ ends with the same number, propose a regex that captures the trailing
+ number and maps it to the corresponding bay. Example: item "0/0" with
+ bay "Slot 0" in scope yields ``^0/(\\d+)$`` -> ``Slot \\1``, which
+ generalises to all sibling slots without needing one mapping per slot.
+
+ Suppressed in two cases to avoid wrong suggestions:
+
+ * **scope_preserved=True**: the bay scope was inherited from a
+ higher ancestor that didn't match a bay, so the item is at a
+ deeper hierarchical level than ``module_bays`` represents.
+ Suggesting "0/0/0 -> Slot 0" when "Slot 0" is actually a chassis
+ line-card bay would invite installing a transceiver into a
+ line-card slot.
+
+ * **Class-bay mismatch**: the item's hardware class disagrees with
+ every bay in scope. A fan only proposes mappings to Fan/Fan
+ Tray/FT named bays; a power supply only to Power Supply / PSU /
+ PEM / PM bays. Module/port classes accept Slot/SFP/Bay/Port.
+
+ Returns a dict with the suggested mapping fields, or None when no
+ plausible mapping can be derived.
+ """
+ if scope_preserved:
+ return None
+ item_name = (item.get("entPhysicalName") or "").strip()
+ if not item_name or not module_bays:
+ return None
+
+ # Match either trailing digits (e.g. "Slot 1", "0/0") or a trailing
+ # alphabetic token (e.g. "Slot A", "CMA-A") so chassis that label
+ # carrier-card slots with letters get a mapping suggestion too.
+ m = re.search(r"(\d+|[A-Za-z]+)$", item_name)
+ if not m:
+ return None
+ item_trail = m.group(0)
+ item_prefix = item_name[: m.start()]
+ trail_is_digits = item_trail.isdigit()
+ item_class = (item.get("entPhysicalClass") or "").strip()
+ # Description-based fallback: when the item description encodes a
+ # class+slot hint like "MIC: ... @ 0/0/*" (Juniper), try mapping to a
+ # bay named " " even when the LibreNMS name is just a
+ # model number with no positional info. Runs before the class filter
+ # so 'container' MICs/PICs/etc. still get a suggestion.
+ descr_suggestion = BaseModuleTableView._suggest_bay_mapping_from_descr(item, module_bays, item_name, item_class)
+
+ # Filter bays by hardware class so transceivers don't propose chassis
+ # line-card bays as targets, fans don't propose Slot N, etc.
+ class_keywords = {
+ "fan": ("fan", "ft"),
+ "powersupply": ("psu", "power supply", "pem", "pm"),
+ }
+ module_classes = {"module", "port", "iomodule", "cpmmodule", "mdamodule", "fabricmodule", "xiomodule"}
+ phys_class = item_class.lower()
+ if phys_class in class_keywords:
+ keywords = class_keywords[phys_class]
+ candidate_names = [n for n in module_bays if any(k in n.lower() for k in keywords)]
+ elif phys_class in module_classes:
+ candidate_names = list(module_bays)
+ else:
+ return descr_suggestion
+
+ # Tighten matching for module-class items with an alphabetic prefix
+ # (e.g. "Sfm 1", "Card 1"): require the candidate bay's alphabetic
+ # prefix tokens to share at least one token with the item's prefix,
+ # otherwise we end up suggesting "Sfm 1" -> "Card 1" just because both
+ # end in "1". Items with no alphabetic prefix (e.g. "0/0", "1/1/1")
+ # keep the previous numeric-only behaviour. Skipped for fan/powerSupply
+ # because class_keywords already curates the candidate set for those.
+ # Also skipped for trailing-letter items where the trail itself ("A",
+ # "B") is the discriminator and prefix tokens (e.g. "Slot" vs "CPM")
+ # frequently disagree across vendor naming conventions.
+ require_token_overlap = phys_class in module_classes and trail_is_digits
+ item_alpha_tokens = {t.lower() for t in re.findall(r"[A-Za-z]+", item_prefix)}
+
+ candidate_bay = None
+ bay_prefix = None
+
+ def _bay_compatible(bay_name: str) -> bool:
+ if not require_token_overlap or not item_alpha_tokens:
+ return True
+ bay_alpha_tokens = {t.lower() for t in re.findall(r"[A-Za-z]+", bay_name)}
+ return bool(item_alpha_tokens & bay_alpha_tokens)
+
+ trail_pattern = r"\d+$" if trail_is_digits else r"[A-Za-z]+$"
+ for bay_name in candidate_names:
+ bm = re.search(trail_pattern, bay_name)
+ if bm and bm.group(0) == item_trail and _bay_compatible(bay_name):
+ candidate_bay = bay_name
+ bay_prefix = bay_name[: bm.start()]
+ break
+
+ if candidate_bay is None:
+ if descr_suggestion is not None:
+ return descr_suggestion
+ # Final fallback: same trail-heuristic but anchored on the
+ # description. Handles entries whose entPhysicalName is the model
+ # string (no positional info) while entPhysicalDescr carries the
+ # human-readable position β e.g. Juniper fan trays where
+ # name='JNP10008-FTC2' and descr='Fan Tray Controller 0' should
+ # map to bay 'Fan Tray 0'. Mapping evaluation already considers
+ # entPhysicalDescr (see _match_module_bay candidate_names), so a
+ # descr-anchored regex resolves at lookup time.
+ return BaseModuleTableView._suggest_bay_mapping_from_descr_trail(
+ item, candidate_names, item_name, item_class
+ )
+
+ capture_group = r"(\d+)" if trail_is_digits else r"([A-Za-z]+)"
+ librenms_pattern = "^" + re.escape(item_prefix) + capture_group + "$"
+ netbox_target = bay_prefix + r"\1"
+
+ return {
+ "librenms_name": librenms_pattern,
+ "netbox_bay_name": netbox_target,
+ "is_regex": True,
+ "librenms_class": item_class,
+ "description": (
+ f"Auto-suggested from device modules tab: maps LibreNMS '{item_name}' "
+ f"and similar names sharing the same prefix to NetBox bay '{candidate_bay}'."
+ ),
+ "example_item": item_name,
+ "example_bay": candidate_bay,
+ }
+
+ @staticmethod
+ def _suggest_bay_mapping_from_descr(item, module_bays, item_name, item_class):
+ """
+ Derive a ModuleBayMapping suggestion from the item's description when
+ the description encodes a class+slot hint like ``"MIC: ... @ 0/0/*"``
+ (Juniper) β useful when the LibreNMS name is just a model number with
+ no positional info that the name-based heuristic could latch onto.
+
+ Returns the suggestion dict (with a regex matching the description and
+ a target bay name like ``"MIC \\1"``) or None when the description
+ doesn't fit the pattern or the implied bay isn't present in scope.
+ """
+ descr = (item.get("entPhysicalDescr") or "").strip()
+ if not descr or not module_bays:
+ return None
+ dm = re.match(r"^([A-Z][A-Za-z0-9_]{0,15}):\s+.*@\s*(\d+)(?:/|\s|$)", descr)
+ if not dm:
+ return None
+ descr_class = dm.group(1)
+ descr_slot = dm.group(2)
+ expected_bay = f"{descr_class} {descr_slot}"
+ if expected_bay not in module_bays:
+ return None
+ librenms_pattern = "^" + re.escape(descr_class) + r":\s+.*@\s*(\d+)(?:/.*)?$"
+ return {
+ "librenms_name": librenms_pattern,
+ "netbox_bay_name": f"{descr_class} \\1",
+ "is_regex": True,
+ "librenms_class": item_class,
+ "description": (
+ f"Auto-suggested from device modules tab: maps LibreNMS items "
+ f"whose description starts with '{descr_class}:' and includes "
+ f"'@ /...' to NetBox bay '{descr_class} ' "
+ f"(e.g. '{descr}' β '{expected_bay}')."
+ ),
+ "example_item": item_name,
+ "example_bay": expected_bay,
+ }
+
+ @staticmethod
+ def _suggest_bay_mapping_from_descr_trail(item, candidate_names, item_name, item_class):
+ """
+ Last-chance heuristic: derive a ModuleBayMapping suggestion by applying
+ the trailing-number/letter pattern to ``entPhysicalDescr`` instead of
+ ``entPhysicalName``.
+
+ Useful for vendors that report the model string in entPhysicalName
+ and the human-readable position in entPhysicalDescr (e.g. Juniper
+ fan trays: name='JNP10008-FTC2', descr='Fan Tray Controller 0').
+ Mapping lookup already considers entPhysicalDescr (see
+ ``_match_module_bay`` candidate_names), so a descr-anchored regex
+ such as ``^Fan Tray Controller (\\d+)$`` will resolve correctly at
+ match time.
+
+ ``candidate_names`` should be the bay-name list already filtered by
+ hardware class (the same list ``_suggest_bay_mapping`` built for the
+ name-based pass) so transceivers don't propose chassis line-card
+ bays as targets, fans don't propose Slot N, etc.
+
+ Returns the suggestion dict, or None when no plausible mapping
+ can be derived (no descr, no trailing token, descr same as name,
+ or no bay shares the trailing token).
+ """
+ descr = (item.get("entPhysicalDescr") or "").strip()
+ if not descr or not candidate_names:
+ return None
+ # Skip when descr is identical to the name we already tried β the
+ # name-based heuristic was authoritative for that string.
+ if descr == item_name:
+ return None
+ m = re.search(r"(\d+|[A-Za-z]+)$", descr)
+ if not m:
+ return None
+ descr_trail = m.group(0)
+ descr_prefix = descr[: m.start()]
+ trail_is_digits = descr_trail.isdigit()
+ trail_pattern = r"\d+$" if trail_is_digits else r"[A-Za-z]+$"
+ candidate_bay = None
+ bay_prefix = None
+ for bay_name in candidate_names:
+ bm = re.search(trail_pattern, bay_name)
+ if bm and bm.group(0) == descr_trail:
+ candidate_bay = bay_name
+ bay_prefix = bay_name[: bm.start()]
+ break
+ if candidate_bay is None:
+ return None
+ capture_group = r"(\d+)" if trail_is_digits else r"([A-Za-z]+)"
+ librenms_pattern = "^" + re.escape(descr_prefix) + capture_group + "$"
+ netbox_target = bay_prefix + r"\1"
+ return {
+ "librenms_name": librenms_pattern,
+ "netbox_bay_name": netbox_target,
+ "is_regex": True,
+ "librenms_class": item_class,
+ "description": (
+ f"Auto-suggested from device modules tab: maps LibreNMS items "
+ f"whose description matches '{descr_prefix}' to NetBox bay "
+ f"'{bay_prefix}' (e.g. '{descr}' β '{candidate_bay}'). "
+ f"Triggered because entPhysicalName ('{item_name}') carries "
+ f"no positional token but entPhysicalDescr does."
+ ),
+ "example_item": descr,
+ "example_bay": candidate_bay,
+ }
+
+ @staticmethod
+ def _suggest_type_mapping(item, matched_bay):
+ """
+ Suggest a ModuleTypeMapping that would resolve a No Type row.
+
+ Uses the LibreNMS model name as ``librenms_model`` and builds a helpful
+ ``description`` from the physical description and bay context so the
+ create form arrives pre-filled for the user. The user still needs to
+ select or create the matching NetBox ModuleType.
+
+ Returns None when the model name is blank β no meaningful mapping can
+ be created without at least a model name to key on.
+ """
+ model = (item.get("entPhysicalModelName") or "").strip()
+ if not model:
+ return None
+
+ parts = [f"Auto-suggested: maps LibreNMS model '{model}'"]
+ phys_descr = (item.get("entPhysicalDescr") or "").strip()
+ if phys_descr:
+ parts.append(f"described as '{phys_descr}'")
+ if matched_bay:
+ parts.append(f"fitted in bay '{matched_bay.name}'")
+ parts.append("to a NetBox ModuleType.")
+ description = " ".join(parts)
+
+ return {
+ "librenms_model": model,
+ "description": description,
+ }
+
+ @staticmethod
+ def _suggest_module_type_create(item, manufacturer):
+ """
+ Suggest pre-fill values for NetBox's native ModuleType create form.
+
+ Returns a dict suitable for building a querystring against
+ ``/dcim/module-types/add/`` so the user can create the missing
+ ModuleType in one click instead of opening the form blank.
+
+ Pre-filled fields (all derived from the LibreNMS ENTITY-MIB row):
+ * ``manufacturer`` β PK of the device's manufacturer (when known)
+ * ``model`` β entPhysicalModelName (truncated to 100 chars)
+ * ``part_number`` β entPhysicalModelName (truncated to 50 chars)
+ * ``description`` β entPhysicalDescr (truncated to 200 chars)
+ * ``comments`` β full entPhysicalDescr when it had to be
+ truncated for ``description``
+
+ Returns None when no model name was reported β without a model name
+ there's nothing meaningful to pre-fill and the row can't be made
+ installable by adding a type either.
+ """
+ model = (item.get("entPhysicalModelName") or "").strip()
+ if not model:
+ return None
+
+ suggestion = {
+ "model": model[:100],
+ "part_number": model[:50],
+ }
+ if manufacturer is not None:
+ suggestion["manufacturer"] = manufacturer.pk
+
+ phys_descr = (item.get("entPhysicalDescr") or "").strip()
+ if phys_descr:
+ suggestion["description"] = phys_descr[:200]
+ if len(phys_descr) > 200:
+ suggestion["comments"] = phys_descr
+
+ return suggestion
+
+ @staticmethod
+ def _build_no_type_warning(item, ambiguity_candidates=None):
+ """Hint when LibreNMS reports a model that NetBox doesn't define.
+
+ When ``ambiguity_candidates`` is a non-empty list of ModuleType
+ instances, the warning explains that NetBox has *multiple* types
+ sharing the same model/part_number string, so the plugin refuses to
+ guess. The message names each conflicting ``manufacturer / model``
+ pair so the user can resolve the data issue in NetBox itself.
+ """
+ model = (item.get("entPhysicalModelName") or "").strip()
+ if not model:
+ return "LibreNMS did not report a model name for this item; cannot match to a NetBox ModuleType."
+ if ambiguity_candidates:
+ names = ", ".join(
+ f"{(mt.manufacturer.name if getattr(mt, 'manufacturer', None) else '?')} / {mt.model}"
+ for mt in ambiguity_candidates
+ )
+ return (
+ f"Cannot match LibreNMS model '{model}': NetBox has "
+ f"{len(ambiguity_candidates)} ModuleTypes sharing this model or part_number "
+ f"({names}). Resolve the duplicate in NetBox (delete one, "
+ "rename, or set distinct part_numbers) so the lookup becomes unambiguous."
+ )
+ return (
+ f"No NetBox ModuleType matches '{model}'. Create a ModuleType for this "
+ "model (or add a ModuleTypeMapping) so the row becomes installable."
+ )
+
+ @staticmethod
+ def _find_ambiguity_candidates(model_name, ambiguities, manufacturer=None, norm_rules=None):
+ """
+ Return the list of ModuleType candidates that collide for *model_name*.
+
+ Checks both the raw LibreNMS string and the normalized form (so a
+ Nokia ``3HE18883AARB01`` whose normalized key ``3HE18883AA`` is
+ ambiguous is still detected). Returns an empty list when there is
+ no collision (or when *ambiguities* is falsy).
+ """
+ from netbox_librenms_plugin.utils import apply_normalization_rules
+
+ if not (model_name and ambiguities):
+ return []
+ if model_name in ambiguities:
+ return list(ambiguities[model_name])
+ normalized = apply_normalization_rules(
+ model_name, "module_type", manufacturer=manufacturer, preloaded_rules=norm_rules
+ )
+ if normalized != model_name and normalized in ambiguities:
+ return list(ambiguities[normalized])
+ return []
+
+ @staticmethod
+ def _find_integrating_ancestor(item, index_map):
+ """
+ Detect the "integrated child" SNMP pattern (e.g. Nokia XIOM hosting a
+ single fixed MDA).
+
+ Some vendors expose the same physical card as two ENTITY-MIB rows β
+ a parent module and a child module β that share both
+ ``entPhysicalSerialNum`` and ``entPhysicalModelName``. Returns the
+ ancestor item that matches *item*'s serial+model (so the caller can
+ present the row as ``Integrated in `` instead of trying to
+ find a bay/type for a card that does not physically exist as a
+ separate entity).
+
+ Returns None when no such ancestor exists, when serial/model are
+ empty/placeholder values, or when *item* is not itself a
+ module-class entry (we don't dedupe chassis / PSU / fan rows
+ because shared serials there usually indicate a real vendor data
+ bug we want to surface).
+ """
+ item_class = (item.get("entPhysicalClass") or "").strip()
+ if item_class not in INVENTORY_CLASSES or item_class in {"container", "powerSupply", "fan"}:
+ return None
+ item_serial = (item.get("entPhysicalSerialNum") or "").strip()
+ if not item_serial or item_serial.lower() in _PLACEHOLDER_VALUES:
+ return None
+ item_model = (item.get("entPhysicalModelName") or "").strip().lower()
+ if not item_model or item_model in _PLACEHOLDER_VALUES:
+ return None
+
+ visited: set = set()
+ current_idx = item.get("entPhysicalContainedIn", 0)
+ while current_idx and current_idx not in visited:
+ visited.add(current_idx)
+ ancestor = index_map.get(current_idx)
+ if ancestor is None:
+ return None
+ anc_class = (ancestor.get("entPhysicalClass") or "").strip()
+ # Stop at chassis β never dedupe against the chassis itself.
+ if anc_class == "chassis":
+ return None
+ if anc_class in INVENTORY_CLASSES and anc_class not in {"container", "powerSupply", "fan"}:
+ anc_serial = (ancestor.get("entPhysicalSerialNum") or "").strip()
+ anc_model = (ancestor.get("entPhysicalModelName") or "").strip().lower()
+ if (
+ anc_serial
+ and anc_serial.lower() not in _PLACEHOLDER_VALUES
+ and anc_serial == item_serial
+ and anc_model
+ and anc_model == item_model
+ ):
+ return ancestor
+ current_idx = ancestor.get("entPhysicalContainedIn", 0)
+ return None
+
+ def _detect_serial_conflicts(self, table_data):
+ """
+ Bulk-check whether LibreNMS serials for replaceable or installable rows already exist elsewhere in NetBox.
+
+ For each row with can_replace or can_install, checks whether the LibreNMS serial (the value we want to
+ write) is already assigned to a *different* module. When a conflict is found the row
+ gets two extra keys:
+
+ serial_conflict_module β the conflicting Module object (with device/module_bay loaded)
+ can_move_from β True (convenience flag for templates/tests)
+ """
+ from dcim.models import Module
+
+ # Map serial β list of rows that may be affected
+ serial_rows: dict = {}
+ for row in table_data:
+ if not row.get("can_replace") and not row.get("can_install"):
+ continue
+ serial = row.get("serial", "")
+ if serial and serial.lower() not in _PLACEHOLDER_VALUES:
+ serial_rows.setdefault(serial, []).append(row)
+
+ if not serial_rows:
+ return
+
+ conflicts = Module.objects.filter(serial__in=serial_rows.keys()).select_related(
+ "module_type", "module_bay", "device"
+ )
+
+ # Group conflict modules by serial
+ conflicts_by_serial: dict = {}
+ for conflict in conflicts:
+ conflicts_by_serial.setdefault(conflict.serial, []).append(conflict)
+
+ for serial, rows in serial_rows.items():
+ modules = conflicts_by_serial.get(serial, [])
+ for row in rows:
+ installed_id = row.get("installed_module_id")
+ # Exclude the module already in the current bay
+ candidates = [m for m in modules if not (installed_id and m.pk == installed_id)]
+ if len(candidates) == 1:
+ row["serial_conflict_module"] = candidates[0]
+ row["can_move_from"] = True
+ elif len(candidates) > 1:
+ row["serial_conflict_ambiguous"] = True
diff --git a/netbox_librenms_plugin/views/imports/__init__.py b/netbox_librenms_plugin/views/imports/__init__.py
index 3a46ab3625..4205e25662 100644
--- a/netbox_librenms_plugin/views/imports/__init__.py
+++ b/netbox_librenms_plugin/views/imports/__init__.py
@@ -3,6 +3,7 @@
from .actions import ( # noqa: F401
BulkImportConfirmView,
BulkImportDevicesView,
+ CreatePlatformFromImportView,
DeviceClusterUpdateView,
DeviceConflictActionView,
DeviceRackUpdateView,
@@ -16,6 +17,7 @@
__all__ = [
"BulkImportConfirmView",
"BulkImportDevicesView",
+ "CreatePlatformFromImportView",
"DeviceClusterUpdateView",
"DeviceConflictActionView",
"DeviceRackUpdateView",
diff --git a/netbox_librenms_plugin/views/imports/actions.py b/netbox_librenms_plugin/views/imports/actions.py
index 9db29a33c1..0e7b910b9f 100644
--- a/netbox_librenms_plugin/views/imports/actions.py
+++ b/netbox_librenms_plugin/views/imports/actions.py
@@ -2,25 +2,31 @@
import json
import logging
+from ipaddress import ip_address as _ipaddr_parse
from urllib.parse import parse_qs, urlparse
from django.contrib import messages
from django.core.cache import cache
from django.core.exceptions import PermissionDenied, ValidationError
-from django.db import transaction
+from django.db import IntegrityError, transaction
from django.http import HttpResponse, JsonResponse
from django.shortcuts import redirect, render
-from django.utils.html import escape
+from django.template.loader import render_to_string
+from django.utils.html import escape, format_html
+from django.utils.safestring import mark_safe
+from django.utils.text import slugify
from django.views import View
from netbox_librenms_plugin.import_utils import (
_determine_device_name,
bulk_import_devices,
bulk_import_vms,
+ detect_bulk_collisions,
fetch_device_with_cache,
get_import_device_cache_key,
get_librenms_device_by_id,
+ get_or_create_global_ip,
get_virtual_chassis_data,
update_vc_member_suggested_names,
validate_device_for_import,
@@ -33,11 +39,44 @@
fetch_model_by_id,
)
from netbox_librenms_plugin.tables.device_status import DeviceImportTable
-from netbox_librenms_plugin.utils import resolve_naming_preferences, save_user_pref, set_librenms_device_id
+from netbox_librenms_plugin.utils import (
+ resolve_auto_create_ipam,
+ resolve_naming_preferences,
+ save_user_pref,
+ set_librenms_device_id,
+)
from netbox_librenms_plugin.views.mixins import LibreNMSAPIMixin, LibreNMSPermissionMixin, NetBoxObjectPermissionMixin
logger = logging.getLogger(__name__)
+
+def _attach_messages_oob(response, request):
+ """
+ Append a single OOB-swap toast container to an HTMX response.
+
+ NetBox's standard ``inc/messages.html`` renders a
+ ```` with one Bootstrap toast
+ per pending Django message. Including this snippet inside per-row partials
+ causes problems on multi-row OOB responses because each render emits a
+ matching ``id="django-messages"`` div and the LAST swap (typically empty
+ once messages have been consumed by an earlier render) wipes the toasts.
+
+ Centralising the include here guarantees a single render per HTMX response
+ so toasts always make it to NetBox's afterSettle ``initMessages()`` hook.
+ """
+ if response is None or not hasattr(response, "content"):
+ return response
+ if not isinstance(response.content, (bytes, bytearray)):
+ return response
+ try:
+ rendered = render_to_string("inc/messages.html", request=request)
+ except Exception: # pragma: no cover - defensive: don't break HTMX response on render error
+ logger.debug("Failed to render inc/messages.html for OOB toast attach", exc_info=True)
+ return response
+ response.content = response.content + rendered.encode("utf-8")
+ return response
+
+
# Actions that require the force checkbox when a device-type mismatch is detected.
_FORCE_REQUIRED_ACTIONS = frozenset({"link", "update", "update_serial", "update_type"})
@@ -97,19 +136,75 @@ def _resolve_vc_detection_enabled(request) -> bool:
return False
-def _save_device(device) -> HttpResponse | None:
- """Call full_clean() then save(). Return an HttpResponse on failure, None on success."""
+def _htmx_error_response(message: str) -> HttpResponse:
+ """
+ Return an HTMX-friendly error response that surfaces ``message`` as a toast.
+
+ Uses an out-of-band swap of NetBox's ``#django-messages`` container so the
+ toast renders through the same Bootstrap pipeline NetBox uses for the
+ standard ``messages`` framework β no dependency on ``window.bootstrap``.
+
+ Returns ``200`` (with ``HX-Reswap: none``) so the primary swap target is
+ left untouched *and* so ``django-htmx``'s DEBUG-mode handler does not
+ replace the page body with the response payload (it only does so for
+ 4xx/5xx responses).
+ """
+ toast_html = format_html(
+ '
",
+ message,
+ )
+ resp = HttpResponse(toast_html, content_type="text/html")
+ # Prevent the triggering element's hx-swap from clobbering its target with
+ # our OOB-only payload; OOB still applies regardless of HX-Reswap.
+ resp["HX-Reswap"] = "none"
+ return resp
+
+
+def _save_device(device, update_fields: list[str] | None = None) -> HttpResponse | None:
+ """Persist a Device row, returning an HttpResponse on failure or None on success.
+
+ When ``update_fields`` is provided, the call uses ``save(update_fields=...)``
+ which (a) issues a narrower UPDATE that only writes those columns and
+ (b) bypasses ``full_clean()``. This is the correct mode when the
+ caller mutates only a known small set of fields and the device row
+ may carry pre-existing inconsistencies on *other* fields (e.g. a
+ legacy ``face`` value left behind after a rack was cleared).
+ Validating those untouched fields would block legitimate updates.
+
+ When ``update_fields`` is ``None`` (the default), the legacy behaviour
+ is preserved: ``full_clean()`` runs against the entire row before
+ ``save()`` writes every column.
+ """
from django.db import IntegrityError
+ if update_fields is None:
+ try:
+ device.full_clean()
+ except ValidationError as exc:
+ error_msg = exc.message_dict if hasattr(exc, "message_dict") else str(exc)
+ return HttpResponse(f"Validation error: {escape(str(error_msg))}", status=400)
+ try:
+ device.save()
+ except IntegrityError as exc:
+ return HttpResponse(f"Integrity error: {escape(str(exc))}", status=409)
+ return None
+
try:
- device.full_clean()
+ device.save(update_fields=update_fields)
+ except IntegrityError as exc:
+ return HttpResponse(f"Integrity error: {escape(str(exc))}", status=409)
except ValidationError as exc:
error_msg = exc.message_dict if hasattr(exc, "message_dict") else str(exc)
return HttpResponse(f"Validation error: {escape(str(error_msg))}", status=400)
- try:
- device.save()
- except IntegrityError as exc:
- return HttpResponse(f"Integrity error: {escape(str(exc))}", status=409)
return None
@@ -251,10 +346,13 @@ def render_device_row(self, request, libre_device: dict, validation: dict, selec
"rack_id": selections["rack_id"],
}
- return render(
+ return _attach_messages_oob(
+ render(
+ request,
+ "netbox_librenms_plugin/htmx/device_import_row.html",
+ context,
+ ),
request,
- "netbox_librenms_plugin/htmx/device_import_row.html",
- context,
)
@@ -455,7 +553,7 @@ def post(self, request):
return HttpResponse(
'
'
"No valid devices selected. "
- f"{len(errors)} error(s) occurred: {' '.join(errors) if errors else 'Please check device validation status.'}"
+ f"{len(errors)} error(s) occurred: {' '.join(escape(e) for e in errors) if errors else 'Please check device validation status.'}"
"
",
status=400,
)
@@ -470,6 +568,15 @@ def post(self, request):
"vc_detection_enabled": vc_detection_enabled,
}
+ collisions = detect_bulk_collisions(devices)
+ if collisions:
+ return render(
+ request,
+ "netbox_librenms_plugin/htmx/bulk_import_collision.html",
+ {"collisions": collisions, "device_count": len(devices)},
+ status=409,
+ )
+
return render(
request,
"netbox_librenms_plugin/htmx/bulk_import_confirm.html",
@@ -525,6 +632,7 @@ def post(self, request): # noqa: PLR0912 - branching keeps responses explicit
return HttpResponse("Invalid device identifier", status=400)
use_sysname, strip_domain = resolve_naming_preferences(request)
+ auto_create_ipam = resolve_auto_create_ipam(request)
vc_detection_enabled = _resolve_vc_detection_enabled(request)
sync_options = {
"sync_interfaces": request.POST.get("sync_interfaces") == "on",
@@ -533,6 +641,7 @@ def post(self, request): # noqa: PLR0912 - branching keeps responses explicit
"vc_detection_enabled": vc_detection_enabled,
"use_sysname": use_sysname,
"strip_domain": strip_domain,
+ "auto_create_ipam": auto_create_ipam,
}
manual_mappings_per_device: dict[int, dict[str, int]] = {}
@@ -698,11 +807,11 @@ def post(self, request): # noqa: PLR0912 - branching keeps responses explicit
)
return redirect("plugins:netbox_librenms_plugin:librenms_import")
- except Exception as exc: # pragma: no cover - defensive guard
+ except Exception: # pragma: no cover - defensive guard
logger.exception("Error during bulk import")
if request.headers.get("HX-Request"):
- return HttpResponse(str(exc), status=500)
- messages.error(request, f"Bulk import failed: {exc}")
+ return HttpResponse("Import failed. Please check server logs.", status=500)
+ messages.error(request, "Bulk import failed. Please check server logs.")
return redirect("plugins:netbox_librenms_plugin:librenms_import")
# Combine results
@@ -715,6 +824,24 @@ def post(self, request): # noqa: PLR0912 - branching keeps responses explicit
request,
f"Successfully imported {success_count} LibreNMS device{'s' if success_count != 1 else ''}",
)
+ # Aggregate auto-created IPAM entries across the batch and surface a
+ # single info toast so the user knows a side-effect happened on import.
+ created_ips_all = []
+ for item in device_result.get("success", []):
+ created_ips_all.extend(item.get("created_ips") or [])
+ for item in vm_result.get("success", []):
+ vm_obj = item.get("device") or item.get("vm")
+ ips = getattr(vm_obj, "_librenms_created_ips", None) if vm_obj is not None else None
+ if ips:
+ created_ips_all.extend(ips)
+ if created_ips_all:
+ unique_ips = sorted(set(created_ips_all))
+ preview = ", ".join(unique_ips[:5]) + (f" (+{len(unique_ips) - 5} more)" if len(unique_ips) > 5 else "")
+ messages.info(
+ request,
+ f"Auto-created {len(unique_ips)} IPAM entr{'y' if len(unique_ips) == 1 else 'ies'} "
+ f"in the global scope (unassigned): {preview}.",
+ )
if failed_count:
messages.error(
request,
@@ -786,10 +913,11 @@ def post(self, request): # noqa: PLR0912 - branching keeps responses explicit
updated_rows_html.append(row_html)
# Return concatenated row HTML with closeModal trigger
- return HttpResponse(
+ response = HttpResponse(
"\n".join(updated_rows_html),
headers={"HX-Trigger": '{"closeModal": null}'},
)
+ return _attach_messages_oob(response, request)
return redirect("plugins:netbox_librenms_plugin:librenms_import")
@@ -969,7 +1097,7 @@ def post(self, request, device_id):
libre_device, validation, selections = self.get_validated_device_with_selections(device_id, request)
if not libre_device:
- return HttpResponse("Device not found", status=404)
+ return _htmx_error_response("Device not found")
return self.render_device_row(request, libre_device, validation, selections)
@@ -982,7 +1110,7 @@ def post(self, request, device_id):
libre_device, validation, selections = self.get_validated_device_with_selections(device_id, request)
if not libre_device:
- return HttpResponse("Device not found", status=404)
+ return _htmx_error_response("Device not found")
return self.render_device_row(request, libre_device, validation, selections)
@@ -995,7 +1123,7 @@ def post(self, request, device_id):
libre_device, validation, selections = self.get_validated_device_with_selections(device_id, request)
if not libre_device:
- return HttpResponse("Device not found", status=404)
+ return _htmx_error_response("Device not found")
return self.render_device_row(request, libre_device, validation, selections)
@@ -1024,16 +1152,13 @@ def post(self, request, device_id):
self._librenms_api = LibreNMSAPI(server_key=post_server_key)
if not action or not existing_device_id:
- return HttpResponse("Missing action or existing_device_id", status=400)
+ return _htmx_error_response("Missing action or existing_device_id")
# VirtualMachine supports migrate_librenms_id, sync_name, and sync_platform.
# Device-only actions (serial, device_type, legacy link/update) are rejected.
if existing_device_type == "virtualmachine":
if action in _DEVICE_ONLY_ACTIONS:
- return HttpResponse(
- f"Action '{escape(action)}' is not supported for virtual machines",
- status=400,
- )
+ return _htmx_error_response(f"Action '{action}' is not supported for virtual machines")
from virtualization.models import VirtualMachine as NetBoxVM
existing_model: type = NetBoxVM
@@ -1043,7 +1168,7 @@ def post(self, request, device_id):
try:
existing_device = existing_model.objects.get(pk=int(existing_device_id))
except (existing_model.DoesNotExist, ValueError):
- return HttpResponse("Existing device not found", status=404)
+ return _htmx_error_response("Existing device not found")
# Object-level change permission for the specific model being mutated.
self.required_object_permissions = {"POST": [("change", existing_model)]}
@@ -1052,24 +1177,21 @@ def post(self, request, device_id):
libre_device, validation, selections = self.get_validated_device_with_selections(device_id, request)
if not libre_device:
- return HttpResponse("LibreNMS device not found", status=404)
+ return _htmx_error_response("LibreNMS device not found")
# Verify the POSTed existing_device_id matches the validated conflict target.
# Require a confirmed conflict target: if validation has no existing_device, the
# LibreNMS device was not validated against this NetBox device, so mutations are unsafe.
validated_existing = validation.get("existing_device") if validation else None
if validated_existing is None:
- return HttpResponse("Missing validated conflict target", status=400)
+ return _htmx_error_response("Missing validated conflict target")
if validated_existing.pk != existing_device.pk or type(validated_existing) is not type(existing_device):
- return HttpResponse("Device ID mismatch: existing_device_id does not match validated device", status=400)
+ return _htmx_error_response("Device ID mismatch: existing_device_id does not match validated device")
# Require force flag when device type mismatches, but only for actions that use it
force = request.POST.get("force") == "on"
if validation.get("device_type_mismatch") and action in _FORCE_REQUIRED_ACTIONS and not force:
- return HttpResponse(
- "Device type mismatch detected. Check the force checkbox to proceed.",
- status=400,
- )
+ return _htmx_error_response("Device type mismatch detected. Check the force checkbox to proceed.")
# When force is used with device_type_mismatch, update device type to LibreNMS value
librenms_device_type = None
@@ -1078,13 +1200,13 @@ def post(self, request, device_id):
librenms_id = libre_device.get("device_id")
if isinstance(librenms_id, bool):
- return HttpResponse("Invalid or missing LibreNMS device_id in payload", status=400)
+ return _htmx_error_response("Invalid or missing LibreNMS device_id in payload")
try:
librenms_id = int(librenms_id)
except (TypeError, ValueError):
- return HttpResponse("Invalid or missing LibreNMS device_id in payload", status=400)
+ return _htmx_error_response("Invalid or missing LibreNMS device_id in payload")
if librenms_id <= 0:
- return HttpResponse("Invalid or missing LibreNMS device_id in payload", status=400)
+ return _htmx_error_response("Invalid or missing LibreNMS device_id in payload")
# Wrap the LibreNMS-ID collision check and subsequent write in a single
# transaction so the read-then-write is atomic for link/update/update_serial.
@@ -1106,16 +1228,12 @@ def post(self, request, device_id):
try:
existing_device = Device.objects.select_for_update().get(pk=existing_device.pk)
except Device.DoesNotExist:
- return HttpResponse(
- "Device no longer exists; it may have been deleted concurrently.",
- status=409,
- )
+ return _htmx_error_response("Device no longer exists; it may have been deleted concurrently.")
id_conflict = find_by_librenms_id(Device, int(librenms_id), server_key)
if id_conflict and id_conflict.pk != existing_device.pk:
- return HttpResponse(
- f"LibreNMS ID conflict: ID {escape(str(librenms_id))} is already assigned to device "
- f"'{escape(id_conflict.name)}' (ID: {id_conflict.pk})",
- status=409,
+ return _htmx_error_response(
+ f"LibreNMS ID conflict: ID {librenms_id} is already assigned to device "
+ f"'{id_conflict.name}' (ID: {id_conflict.pk})"
)
# Reject legacy bare-int/string librenms_id: set_librenms_device_id
@@ -1130,10 +1248,9 @@ def post(self, request, device_id):
except (ValueError, TypeError):
pass
if _is_legacy:
- return HttpResponse(
+ return _htmx_error_response(
"Device has a legacy bare-integer librenms_id; use 'Convert mapping' "
- "to migrate to the multi-server format before linking.",
- status=409,
+ "to migrate to the multi-server format before linking."
)
if action == "link":
@@ -1141,9 +1258,11 @@ def post(self, request, device_id):
hostname = _get_hostname_for_action(request, validation, libre_device)
set_librenms_device_id(existing_device, librenms_id, self.librenms_api.server_key)
existing_device.name = hostname
+ fields = ["custom_field_data", "name"]
if librenms_device_type:
existing_device.device_type = librenms_device_type
- if err := _save_device(existing_device):
+ fields.append("device_type")
+ if err := _save_device(existing_device, update_fields=fields):
return err
logger.info(f"Linked device '{existing_device.name}' to LibreNMS ID {librenms_id}")
@@ -1151,6 +1270,7 @@ def post(self, request, device_id):
# Update hostname, serial, and link to LibreNMS
hostname = _get_hostname_for_action(request, validation, libre_device)
incoming_serial = libre_device.get("serial") or ""
+ fields = ["custom_field_data", "name"]
if incoming_serial and incoming_serial != "-":
# Lock any conflicting device under the same transaction to reduce
# the serial-assignment race window (best-effort; a DB unique
@@ -1162,17 +1282,18 @@ def post(self, request, device_id):
.first()
)
if conflict_device:
- return HttpResponse(
- f"Serial conflict: '{escape(incoming_serial)}' is already assigned to device "
- f"'{escape(conflict_device.name)}' (ID: {conflict_device.pk})",
- status=409,
+ return _htmx_error_response(
+ f"Serial conflict: '{incoming_serial}' is already assigned to device "
+ f"'{conflict_device.name}' (ID: {conflict_device.pk})"
)
existing_device.serial = incoming_serial
+ fields.append("serial")
existing_device.name = hostname
if librenms_device_type:
existing_device.device_type = librenms_device_type
+ fields.append("device_type")
set_librenms_device_id(existing_device, librenms_id, self.librenms_api.server_key)
- if err := _save_device(existing_device):
+ if err := _save_device(existing_device, update_fields=fields):
return err
logger.info(
f"Updated device '{existing_device.name}': serial={incoming_serial}, "
@@ -1182,6 +1303,7 @@ def post(self, request, device_id):
elif action == "update_serial":
# Update only the serial and link to LibreNMS
incoming_serial = libre_device.get("serial") or ""
+ fields = ["custom_field_data"]
if incoming_serial and incoming_serial != "-":
# Lock any conflicting device under the same transaction to reduce
# the serial-assignment race window (best-effort; a DB unique
@@ -1193,16 +1315,17 @@ def post(self, request, device_id):
.first()
)
if conflict_device:
- return HttpResponse(
- f"Serial conflict: '{escape(incoming_serial)}' is already assigned to device "
- f"'{escape(conflict_device.name)}' (ID: {conflict_device.pk})",
- status=409,
+ return _htmx_error_response(
+ f"Serial conflict: '{incoming_serial}' is already assigned to device "
+ f"'{conflict_device.name}' (ID: {conflict_device.pk})"
)
existing_device.serial = incoming_serial
+ fields.append("serial")
if librenms_device_type:
existing_device.device_type = librenms_device_type
+ fields.append("device_type")
set_librenms_device_id(existing_device, librenms_id, self.librenms_api.server_key)
- if err := _save_device(existing_device):
+ if err := _save_device(existing_device, update_fields=fields):
return err
logger.info(
f"Updated serial on device '{existing_device.name}' to {incoming_serial}, "
@@ -1213,7 +1336,7 @@ def post(self, request, device_id):
# Sync device name from LibreNMS (e.g., IP β sysName)
hostname = _get_hostname_for_action(request, validation, libre_device)
existing_device.name = hostname
- if err := _save_device(existing_device):
+ if err := _save_device(existing_device, update_fields=["name"]):
return err
logger.info(f"Synced name on device '{existing_device.name}' from LibreNMS")
@@ -1221,11 +1344,11 @@ def post(self, request, device_id):
# Update device type from LibreNMS (requires force for mismatch)
if librenms_device_type:
existing_device.device_type = librenms_device_type
- if err := _save_device(existing_device):
+ if err := _save_device(existing_device, update_fields=["device_type"]):
return err
logger.info(f"Updated device type on '{existing_device.name}' to {librenms_device_type}")
else:
- return HttpResponse("No LibreNMS device type available to update", status=400)
+ return _htmx_error_response("No LibreNMS device type available to update")
elif action == "sync_serial":
# Sync serial number from LibreNMS.
@@ -1237,10 +1360,7 @@ def post(self, request, device_id):
try:
locked_device = Device.objects.select_for_update().get(pk=existing_device.pk)
except Device.DoesNotExist:
- return HttpResponse(
- "Device no longer exists; it may have been deleted concurrently.",
- status=409,
- )
+ return _htmx_error_response("Device no longer exists; it may have been deleted concurrently.")
# Re-check for serial ownership conflict under lock.
# Note: We intentionally do NOT enforce a DB-level uniqueness constraint on
# Device.serial. During device moves/replacements, multiple devices may
@@ -1254,17 +1374,16 @@ def post(self, request, device_id):
f"Serial sync blocked: '{incoming_serial}' already assigned to "
f"'{conflict_device.name}' (pk={conflict_device.pk})"
)
- return HttpResponse(
- f"Serial conflict: '{escape(incoming_serial)}' is already assigned to device "
- f"'{escape(conflict_device.name)}' (ID: {conflict_device.pk})",
- status=409,
+ return _htmx_error_response(
+ f"Serial conflict: '{incoming_serial}' is already assigned to device "
+ f"'{conflict_device.name}' (ID: {conflict_device.pk})"
)
locked_device.serial = incoming_serial
- if err := _save_device(locked_device):
+ if err := _save_device(locked_device, update_fields=["serial"]):
return err
logger.info(f"Synced serial on '{locked_device.name}' to {incoming_serial}")
else:
- return HttpResponse("No valid serial from LibreNMS", status=400)
+ return _htmx_error_response("No valid serial from LibreNMS")
elif action == "sync_platform":
# Sync platform from LibreNMS OS
@@ -1275,13 +1394,22 @@ def post(self, request, device_id):
match_result = find_matching_platform(librenms_os)
if match_result["found"]:
existing_device.platform = match_result["platform"]
- if err := _save_device(existing_device):
+ if err := _save_device(existing_device, update_fields=["platform"]):
return err
logger.info(f"Synced platform on '{existing_device.name}' to {match_result['platform']}")
+ elif match_result.get("match_type") == "ambiguous":
+ ambiguity_source = match_result.get("ambiguity_source", "mapping")
+ if ambiguity_source == "platform":
+ target = "Platforms"
+ else:
+ target = "Platform Mappings"
+ return _htmx_error_response(
+ f"Multiple {target} match OS '{librenms_os}' β resolve the conflict in {target}"
+ )
else:
- return HttpResponse(f"Platform '{escape(librenms_os)}' not found in NetBox", status=400)
+ return _htmx_error_response(f"Platform '{librenms_os}' not found in NetBox")
else:
- return HttpResponse("No OS info from LibreNMS", status=400)
+ return _htmx_error_response("No OS info from LibreNMS")
elif action == "sync_device_type":
# Sync device type from LibreNMS hardware (non-mismatch case)
@@ -1291,11 +1419,11 @@ def post(self, request, device_id):
hw_match = match_librenms_hardware_to_device_type(hardware)
if hw_match and hw_match.get("matched"):
existing_device.device_type = hw_match["device_type"]
- if err := _save_device(existing_device):
+ if err := _save_device(existing_device, update_fields=["device_type"]):
return err
logger.info(f"Synced device type on '{existing_device.name}' to {hw_match['device_type']}")
else:
- return HttpResponse(f"No matching device type for '{escape(hardware)}'", status=400)
+ return _htmx_error_response(f"No matching device type for '{hardware}'")
elif action == "migrate_librenms_id":
# Migrate legacy bare-integer librenms_id to the JSON dict format.
@@ -1310,47 +1438,35 @@ def post(self, request, device_id):
if isinstance(cf_value, bool) or not (
isinstance(cf_value, int) or (isinstance(cf_value, str) and cf_value.isdigit())
):
- return HttpResponse(
- "Device librenms_id is already in JSON format; no migration needed.",
- status=400,
- )
+ return _htmx_error_response("Device librenms_id is already in JSON format; no migration needed.")
# Normalise string-digit to int for consistent comparison
cf_int = int(cf_value) if isinstance(cf_value, str) else cf_value
# Verify the stored legacy ID matches the active LibreNMS device_id so we don't
# migrate a stale/incorrect association to the wrong server mapping.
if cf_int != librenms_id:
- return HttpResponse(
+ return _htmx_error_response(
f"Legacy librenms_id ({cf_int}) does not match the active device ID "
- f"({librenms_id}); cannot migrate safely.",
- status=400,
+ f"({librenms_id}); cannot migrate safely."
)
if not validation.get("serial_confirmed") and not force:
- return HttpResponse(
- "Serial number not confirmed. Check the force checkbox to migrate without serial verification.",
- status=400,
+ return _htmx_error_response(
+ "Serial number not confirmed. Check the force checkbox to migrate without serial verification."
)
with transaction.atomic():
try:
locked_device = existing_model.objects.select_for_update().get(pk=existing_device.pk)
except existing_model.DoesNotExist:
- return HttpResponse(
- "Object no longer exists; it may have been deleted concurrently.",
- status=409,
- )
+ return _htmx_error_response("Object no longer exists; it may have been deleted concurrently.")
# Re-check under lock β another request may have already migrated it
cf_locked = locked_device.custom_field_data.get("librenms_id")
if isinstance(cf_locked, bool) or not (
isinstance(cf_locked, int) or (isinstance(cf_locked, str) and cf_locked.isdigit())
):
- return HttpResponse(
- "Device librenms_id is already in JSON format; no migration needed.",
- status=400,
- )
+ return _htmx_error_response("Device librenms_id is already in JSON format; no migration needed.")
cf_locked_int = int(cf_locked) if isinstance(cf_locked, str) else cf_locked
if cf_locked_int != librenms_id:
- return HttpResponse(
- f"Legacy librenms_id changed under lock ({cf_locked_int} != {librenms_id}); cannot migrate safely.",
- status=400,
+ return _htmx_error_response(
+ f"Legacy librenms_id changed under lock ({cf_locked_int} != {librenms_id}); cannot migrate safely."
)
# Check that no other object already owns this ID (server-scoped or legacy)
server_key = self.librenms_api.server_key
@@ -1359,34 +1475,1066 @@ def post(self, request, device_id):
match = find_by_librenms_id(existing_model, cf_locked_int, server_key)
conflict = match is not None and match.pk != locked_device.pk
if conflict:
- return HttpResponse(
- f"Another device already has librenms_id {cf_locked_int} for server '{server_key}'; cannot migrate.",
- status=409,
+ return _htmx_error_response(
+ f"Another device already has librenms_id {cf_locked_int} for server '{server_key}'; cannot migrate."
)
if not migrate_legacy_librenms_id(locked_device, self.librenms_api.server_key):
- return HttpResponse(
- "Migration failed: librenms_id could not be converted.",
- status=400,
+ return _htmx_error_response("Migration failed: librenms_id could not be converted.")
+ # Save only the field we actually mutated. Running full_clean() on the
+ # whole object would reject the migration over unrelated pre-existing
+ # validation issues (e.g. legacy rack face/position without a rack),
+ # which is too strict for an ID-only migration: the point of "Convert
+ # mapping" is to clean up the librenms_id custom field, not to gate
+ # on every other field being valid.
+ try:
+ locked_device.save(update_fields=["custom_field_data"])
+ except IntegrityError:
+ logger.exception(
+ "Failed to persist migrated LibreNMS mapping for %s pk=%s",
+ type(locked_device).__name__,
+ locked_device.pk,
)
- if err := _save_device(locked_device):
- return err
+ return _htmx_error_response("Unable to migrate the LibreNMS mapping. Please try again.")
logger.info(
f"Migrated legacy librenms_id on '{locked_device.name}' "
f"to {{{self.librenms_api.server_key!r}: {cf_locked_int}}}"
)
else:
- return HttpResponse(f"Unknown action: {escape(action)}", status=400)
+ return _htmx_error_response(f"Unknown action: {action}")
# Clear cached validation so re-validation picks up the changes
cache_key = get_import_device_cache_key(device_id, self.librenms_api.server_key)
cache.delete(cache_key)
# Re-validate and render updated row
+ libre_device, validation, selections = self.get_validated_device_with_selections(device_id, request)
+ if not libre_device:
+ return _htmx_error_response("Device not found after action")
+
+ response = self.render_device_row(request, libre_device, validation, selections)
+ response["HX-Trigger"] = "closeModal"
+ return response
+
+
+class AddDeviceTypeMappingView(
+ LibreNMSPermissionMixin, NetBoxObjectPermissionMixin, LibreNMSAPIMixin, DeviceImportHelperMixin, View
+):
+ """HTMX view to create a DeviceTypeMapping from the import validation modal."""
+
+ def post(self, request, device_id):
+ """Create a DeviceTypeMapping linking the LibreNMS hardware string to a NetBox DeviceType."""
+ from netbox_librenms_plugin.models import DeviceTypeMapping
+
+ # Check plugin write permission early (cheap, no API call needed).
+ if error := self.require_write_permission():
+ return error
+
+ post_server_key = (request.POST.get("server_key") or "").strip()
+ if post_server_key:
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ self._librenms_api = LibreNMSAPI(server_key=post_server_key)
+
+ from dcim.models import DeviceType
+
+ libre_device = fetch_device_with_cache(device_id, self.librenms_api)
+ if not libre_device:
+ return _htmx_error_response("Device not found in LibreNMS.")
+
+ hardware = (libre_device.get("hardware") or "").strip()
+ if not hardware or hardware == "-":
+ return _htmx_error_response("Device has no hardware string β cannot create mapping.")
+
+ device_type_id = request.POST.get("device_type_id", "").strip()
+ if not device_type_id:
+ return _htmx_error_response("Please select a device type before submitting.")
+
+ try:
+ device_type_id = int(device_type_id)
+ except (ValueError, TypeError):
+ return _htmx_error_response("Invalid device type selection.")
+
+ try:
+ device_type = DeviceType.objects.get(pk=device_type_id)
+ except DeviceType.DoesNotExist:
+ return _htmx_error_response("Selected device type not found.")
+
+ # Resolve the existing mapping first so we only require the permission
+ # actually needed: "add" for a new mapping, "change" for an update.
+ existing_mapping = DeviceTypeMapping.objects.filter(librenms_hardware__iexact=hardware).first()
+ if existing_mapping:
+ self.required_object_permissions = {"POST": [("change", DeviceTypeMapping)]}
+ else:
+ self.required_object_permissions = {"POST": [("add", DeviceTypeMapping)]}
+ if error := self.require_object_permissions("POST"):
+ return error
+
+ try:
+ with transaction.atomic():
+ # Lock the row to close the window between the upfront permission
+ # check and the actual write (select_for_update prevents a concurrent
+ # INSERT from slipping through undetected).
+ locked = (
+ DeviceTypeMapping.objects.select_for_update().filter(librenms_hardware__iexact=hardware).first()
+ )
+ if locked and not existing_mapping:
+ # A concurrent request created the mapping after our upfront read.
+ # Only escalate to change permission if we would actually mutate the row;
+ # if the locked row already maps to the same device type this is a no-op
+ # and the caller needs only the add permission they already passed above.
+ if locked.netbox_device_type_id != device_type_id:
+ self.required_object_permissions = {"POST": [("change", DeviceTypeMapping)]}
+ if error := self.require_object_permissions("POST"):
+ return error
+ if existing_mapping and not locked:
+ # The mapping was deleted between our upfront read and the lock.
+ # We are about to CREATE a new row, so require add permission.
+ self.required_object_permissions = {"POST": [("add", DeviceTypeMapping)]}
+ if error := self.require_object_permissions("POST"):
+ return error
+ if locked:
+ if locked.netbox_device_type_id != device_type_id:
+ locked.netbox_device_type = device_type
+ locked.full_clean()
+ locked.save()
+ else:
+ try:
+ DeviceTypeMapping.objects.create(
+ librenms_hardware=hardware.lower(),
+ netbox_device_type=device_type,
+ )
+ except IntegrityError:
+ # Two concurrent requests both saw no existing mapping and
+ # both attempted create(); select_for_update() cannot lock
+ # absent rows. Surface a toast asking the user to retry
+ # (the second attempt will find the row and take the update path).
+ return _htmx_error_response("Mapping was created concurrently. Please try again.")
+ except Exception as exc:
+ logger.exception("AddDeviceTypeMappingView: failed to save mapping: %s", exc)
+ return _htmx_error_response("Error saving mapping. Please try again.")
+
+ # Clear cached LibreNMS device data so re-validation picks up the new mapping
+ cache_key = get_import_device_cache_key(device_id, self.librenms_api.server_key)
+ cache.delete(cache_key)
+
+ # Re-render the modal content as an OOB swap so it updates in place.
+ # The inner views render via Django templates (auto-escaped), so the
+ # decoded content is already safe HTML; wrap with format_html + mark_safe
+ # to compose the OOB envelope without introducing new escape boundaries
+ # (CodeQL trust-assertion pattern, see plugin docs).
+ detail_view = DeviceValidationDetailsView()
+ detail_view._librenms_api = self._librenms_api
+ modal_html = detail_view.get(request, device_id).content.decode("utf-8")
+ oob_modal = format_html(
+ '
{}
',
+ mark_safe(modal_html),
+ )
+
+ # Re-validate and include the background table row as a second OOB swap so the
+ # row reflects the new mapping immediately without a secondary JS-triggered request.
+ libre_device, validation, selections = self.get_validated_device_with_selections(device_id, request)
+ if libre_device is not None and validation is not None:
+ row_response = self.render_device_row(request, libre_device, validation, selections)
+ row_html = row_response.content.decode("utf-8")
+ # The row template already includes hx-swap-oob="true" on the
, so HTMX
+ # will perform an outerHTML swap targeted by the row's id. No further
+ # attribute injection is needed (and adding one would create a duplicate
+ # hx-swap-oob attribute that breaks HTMX OOB parsing).
+ # A
following a is invalid HTML and gets silently dropped by the browser
+ # parser when HTMX wraps the combined response in a
for parsing. Wrapping
+ # in keeps the in a valid table context so HTMX finds and applies
+ # the OOB swap. The inside is foster-parented outside the
+ # table by the parser, so both OOB elements are preserved.
+ row_html = format_html("
", mark_safe(row_html))
+ else:
+ row_html = mark_safe("")
+
+ return HttpResponse(oob_modal + row_html, content_type="text/html")
+
+
+class CreatePlatformFromImportView(
+ LibreNMSPermissionMixin, NetBoxObjectPermissionMixin, LibreNMSAPIMixin, DeviceImportHelperMixin, View
+):
+ """HTMX view to create a Platform (and optionally a mapping and device assignment) from the import page."""
+
+ def get(self, request, device_id):
+ """Render the shared create-platform form fragment for the import HTMX modal."""
+ from dcim.models import Manufacturer
+
+ post_server_key = (request.GET.get("server_key") or "").strip()
+ if post_server_key:
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ self._librenms_api = LibreNMSAPI(server_key=post_server_key)
+
+ libre_device = fetch_device_with_cache(device_id, self.librenms_api)
+ if not libre_device:
+ return HttpResponse(
+ '
Device not found in LibreNMS.
',
+ status=404,
+ )
+
+ librenms_os = (libre_device.get("os") or "").strip().lower()
+ manufacturers = list(Manufacturer.objects.all().order_by("name"))
+
+ _, validation, _ = self.get_validated_device_with_selections(device_id, request)
+ device_pk = None
+ selected_manufacturer_pk = None
+ if validation:
+ existing = validation.get("existing_device")
+ if existing:
+ device_pk = existing.pk
+ device_type = getattr(existing, "device_type", None)
+ if device_type:
+ selected_manufacturer_pk = device_type.manufacturer_id
+
+ htmx_include = (
+ f"[name=role_{device_id}], [name=rack_{device_id}], "
+ f"[name=cluster_{device_id}], #use-sysname-toggle, #strip-domain-toggle"
+ )
+
+ return render(
+ request,
+ "netbox_librenms_plugin/htmx/create_platform_modal.html",
+ {
+ "librenms_os": librenms_os,
+ "platform_name": librenms_os,
+ "manufacturers": manufacturers,
+ "form_action": request.path,
+ "device_pk": device_pk,
+ "selected_manufacturer_pk": selected_manufacturer_pk,
+ "server_key": self.librenms_api.server_key,
+ "use_htmx": True,
+ "htmx_include": htmx_include,
+ },
+ )
+
+ def post(self, request, device_id):
+ """Create platform + optional mapping + optional device assignment, then return OOB swaps."""
+ from dcim.models import Manufacturer, Platform
+
+ from netbox_librenms_plugin.models import PlatformMapping
+
+ if error := self.require_write_permission():
+ return error
+
+ post_server_key = (request.POST.get("server_key") or "").strip()
+ if post_server_key:
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ self._librenms_api = LibreNMSAPI(server_key=post_server_key)
+
+ create_mapping = _parse_boolish(request.POST.get("create_mapping")) is True
+ device_pk_str = (request.POST.get("device_pk") or "").strip()
+ device_pk = None
+ if device_pk_str:
+ try:
+ device_pk = int(device_pk_str)
+ except (ValueError, TypeError):
+ device_pk = None
+
+ # Re-resolve the matched NetBox object via current validation. This
+ # tells us which model (Device vs VirtualMachine) to assign to and
+ # protects against a stale/spoofed hidden device_pk: we only mutate an
+ # existing object when current validation unambiguously resolves it
+ # (and the supplied device_pk, if any, agrees with that resolution).
+ try:
+ _, _validation, _ = self.get_validated_device_with_selections(device_id, request)
+ except Exception:
+ logger.exception(
+ "CreatePlatformFromImportView: failed to resolve assignment target for device_id=%s",
+ device_id,
+ )
+ return _htmx_error_response("Unable to confirm the target object for platform assignment.")
+ existing_obj = _validation.get("existing_device") if _validation else None
+
+ if existing_obj is not None and (device_pk is None or device_pk == existing_obj.pk):
+ target_model = type(existing_obj)
+ target_pk = existing_obj.pk
+ else:
+ # Either validation could not confirm a target, or the hidden
+ # device_pk disagreed with the validated object. Don't guess a
+ # model β create the platform but skip assignment so we never
+ # mutate the wrong record.
+ target_model = None
+ target_pk = None
+
+ perms = [("add", Platform)]
+ if create_mapping:
+ perms.append(("add", PlatformMapping))
+ if target_model is not None:
+ perms.append(("change", target_model))
+ self.required_object_permissions = {"POST": perms}
+
+ if error := self.require_object_permissions("POST"):
+ return error
+
+ platform_name = (request.POST.get("platform_name") or "").strip()
+ manufacturer_id = (request.POST.get("manufacturer") or "").strip()
+ librenms_os = (request.POST.get("librenms_os") or "").strip().lower()
+
+ if not platform_name:
+ return _htmx_error_response("Platform name is required.")
+
+ if Platform.objects.filter(name__iexact=platform_name).exists():
+ return _htmx_error_response(f'Platform "{platform_name}" already exists.')
+
+ manufacturer = None
+ if manufacturer_id:
+ try:
+ manufacturer = Manufacturer.objects.get(pk=int(manufacturer_id))
+ except (Manufacturer.DoesNotExist, ValueError, TypeError):
+ pass
+
+ try:
+ with transaction.atomic():
+ platform = Platform(
+ name=platform_name,
+ slug=slugify(platform_name),
+ manufacturer=manufacturer,
+ )
+ platform.full_clean()
+ platform.save()
+
+ if target_model is not None and target_pk is not None:
+ try:
+ target = target_model.objects.select_for_update().get(pk=target_pk)
+ target.platform = platform
+ target.full_clean()
+ target.save()
+ logger.info(
+ "CreatePlatformFromImportView: assigned platform '%s' to %s pk=%s",
+ platform.name,
+ target_model.__name__,
+ target_pk,
+ )
+ except target_model.DoesNotExist:
+ logger.warning(
+ "CreatePlatformFromImportView: %s pk=%s not found; platform "
+ "'%s' created but not assigned to any object",
+ target_model.__name__,
+ target_pk,
+ platform.name,
+ )
+ else:
+ logger.info(
+ "CreatePlatformFromImportView: no existing NetBox object matched "
+ "for LibreNMS device_id=%s; platform '%s' created without assignment",
+ device_id,
+ platform.name,
+ )
+
+ if create_mapping and librenms_os:
+ if not PlatformMapping.objects.filter(librenms_os__iexact=librenms_os).exists():
+ try:
+ with transaction.atomic():
+ PlatformMapping.objects.create(
+ librenms_os=librenms_os.lower(),
+ netbox_platform=platform,
+ )
+ except IntegrityError:
+ # Concurrent request created the mapping; safe to ignore.
+ pass
+ except (ValidationError, IntegrityError) as exc:
+ logger.exception("CreatePlatformFromImportView: failed to create platform: %s", exc)
+ return _htmx_error_response("Error creating platform. Please try again.")
+
+ cache_key = get_import_device_cache_key(device_id, self.librenms_api.server_key)
+ cache.delete(cache_key)
+
+ # Re-render the modal content as an OOB swap so it updates in place.
+ # The inner views render via Django templates (auto-escaped), so the
+ # decoded content is already safe HTML; wrap with format_html + mark_safe
+ # to compose the OOB envelope without introducing new escape boundaries.
+ detail_view = DeviceValidationDetailsView()
+ detail_view._librenms_api = self._librenms_api
+ modal_html = detail_view.get(request, device_id).content.decode("utf-8")
+ oob_modal = format_html(
+ '
{}
',
+ mark_safe(modal_html),
+ )
+
+ # Re-validate and include the background table row as a second OOB swap so the
+ # row reflects the new platform/mapping immediately without a secondary request.
+ libre_device, validation, selections = self.get_validated_device_with_selections(device_id, request)
+ if libre_device is not None and validation is not None:
+ row_response = self.render_device_row(request, libre_device, validation, selections)
+ row_html = row_response.content.decode("utf-8")
+ row_html = format_html("
", mark_safe(row_html))
+ else:
+ row_html = mark_safe("")
+
+ return HttpResponse(oob_modal + row_html, content_type="text/html")
+
+
+class AddPlatformMappingView(
+ LibreNMSPermissionMixin, NetBoxObjectPermissionMixin, LibreNMSAPIMixin, DeviceImportHelperMixin, View
+):
+ """HTMX view to create a PlatformMapping from the import validation modal."""
+
+ def post(self, request, device_id):
+ """Create a PlatformMapping linking the LibreNMS OS string to a NetBox Platform."""
+ if error := self.require_write_permission():
+ return error
+
+ from dcim.models import Platform
+ from netbox_librenms_plugin.models import PlatformMapping
+
+ libre_device = fetch_device_with_cache(device_id, self.librenms_api)
+ if not libre_device:
+ return HttpResponse(
+ '
Device not found in LibreNMS.',
+ status=404,
+ )
+
+ librenms_os = (libre_device.get("os") or "").strip()
+ if not librenms_os:
+ return HttpResponse(
+ '
Device has no OS string β cannot create mapping.',
+ status=400,
+ )
+
+ platform_id = request.POST.get("platform_id", "").strip()
+ if not platform_id:
+ return HttpResponse(
+ '
Please select a platform before submitting.',
+ status=400,
+ )
+
+ try:
+ platform_id = int(platform_id)
+ except (ValueError, TypeError):
+ return HttpResponse(
+ '
Invalid platform selection.',
+ status=400,
+ )
+
+ try:
+ platform = Platform.objects.get(pk=platform_id)
+ except Platform.DoesNotExist:
+ return HttpResponse(
+ '
Selected platform not found.',
+ status=404,
+ )
+
+ existing_mapping = PlatformMapping.objects.filter(librenms_os__iexact=librenms_os).first()
+ self.required_object_permissions = {
+ "POST": [("change", PlatformMapping) if existing_mapping else ("add", PlatformMapping)]
+ }
+ if error := self.require_object_permissions("POST"):
+ return error
+
+ try:
+ with transaction.atomic():
+ mapping, created = PlatformMapping.objects.get_or_create(
+ librenms_os=librenms_os.lower(),
+ defaults={"netbox_platform": platform},
+ )
+ if not created and mapping.netbox_platform_id != platform_id:
+ mapping.netbox_platform = platform
+ mapping.save()
+ except Exception as exc:
+ logger.warning("AddPlatformMappingView: failed to save mapping: %s", exc)
+ return HttpResponse(
+ f'
Error saving mapping: {escape(str(exc))}',
+ status=500,
+ )
+
+ cache_key = get_import_device_cache_key(device_id, self.librenms_api.server_key)
+ cache.delete(cache_key)
+
+ # Re-render the modal as an OOB swap and the background row so both update in place.
+ # Use format_html + mark_safe per CodeQL trust-assertion pattern (see plugin docs).
+ detail_view = DeviceValidationDetailsView()
+ detail_view._librenms_api = self._librenms_api
+ modal_html = detail_view.get(request, device_id).content.decode("utf-8")
+ oob_modal = format_html(
+ '
{}
',
+ mark_safe(modal_html),
+ )
+
+ # Re-validate and include the background table row as a second OOB swap so the
+ # row reflects the new platform/mapping immediately without a secondary request.
+ libre_device, validation, selections = self.get_validated_device_with_selections(device_id, request)
+ if libre_device is not None and validation is not None:
+ row_response = self.render_device_row(request, libre_device, validation, selections)
+ row_html = row_response.content.decode("utf-8")
+ row_html = format_html("
", mark_safe(row_html))
+ else:
+ row_html = mark_safe("")
+
+ return HttpResponse(oob_modal + row_html, content_type="text/html")
+
+
+class AddAsOOBView(
+ LibreNMSPermissionMixin, NetBoxObjectPermissionMixin, LibreNMSAPIMixin, DeviceImportHelperMixin, View
+):
+ """HTMX view to link a LibreNMS OOB controller device to an existing NetBox Device."""
+
+ def post(self, request, device_id):
+ """Attach a LibreNMS OOB identity to the matched NetBox device."""
+ if error := self.require_write_permission():
+ return error
+
+ from dcim.models import Device
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ existing_device_id = request.POST.get("existing_device_id")
+ if not existing_device_id:
+ return HttpResponse("Missing existing_device_id", status=400)
+
+ post_server_key = (request.POST.get("server_key") or "").strip()
+ if post_server_key:
+ self._librenms_api = LibreNMSAPI(server_key=post_server_key)
+
+ try:
+ existing_device = Device.objects.get(pk=int(existing_device_id))
+ except (Device.DoesNotExist, ValueError):
+ return HttpResponse("Existing device not found", status=404)
+
+ self.required_object_permissions = {"POST": [("change", Device)]}
+ if error := self.require_object_permissions("POST"):
+ return error
+
+ libre_device, validation, selections = self.get_validated_device_with_selections(device_id, request)
+ if not libre_device:
+ return HttpResponse("LibreNMS device not found", status=404)
+
+ oob_candidate = validation.get("oob_candidate") if validation else None
+ if not oob_candidate:
+ return HttpResponse("No OOB candidate found in validation data", status=400)
+ if oob_candidate["device"].pk != existing_device.pk:
+ return HttpResponse(
+ "Device ID mismatch: existing_device_id does not match OOB candidate",
+ status=400,
+ )
+
+ librenms_id = libre_device.get("device_id")
+ if isinstance(librenms_id, bool):
+ return HttpResponse("Invalid or missing LibreNMS device_id", status=400)
+ try:
+ librenms_id = int(librenms_id)
+ except (TypeError, ValueError):
+ return HttpResponse("Invalid or missing LibreNMS device_id", status=400)
+ if librenms_id <= 0:
+ return HttpResponse("Invalid LibreNMS device_id", status=400)
+
+ # Reject legacy bare-int librenms_id (same guard as DeviceConflictActionView).
+ stored_id = existing_device.custom_field_data.get("librenms_id")
+ _is_legacy = isinstance(stored_id, int) and not isinstance(stored_id, bool)
+ if not _is_legacy and isinstance(stored_id, str):
+ try:
+ int(stored_id)
+ _is_legacy = True
+ except (ValueError, TypeError):
+ pass
+ if _is_legacy:
+ return HttpResponse(
+ "Device has a legacy bare-integer librenms_id; use 'Convert mapping' to migrate first.",
+ status=409,
+ )
+
+ from netbox_librenms_plugin.utils import set_librenms_oob
+
+ oob_type = oob_candidate.get("type") or ""
+ oob_version = oob_candidate.get("version") or None
+ oob_ip_str = oob_candidate.get("ip") or None
+ server_key = self.librenms_api.server_key
+
+ with transaction.atomic():
+ try:
+ existing_device = Device.objects.select_for_update().get(pk=existing_device.pk)
+ except Device.DoesNotExist:
+ return HttpResponse(
+ "Device no longer exists; it may have been deleted concurrently.",
+ status=409,
+ )
+
+ try:
+ set_librenms_oob(
+ existing_device,
+ librenms_id,
+ server_key,
+ oob_type=oob_type,
+ version=oob_version,
+ ip=oob_ip_str,
+ )
+ except ValueError as exc:
+ return HttpResponse(f"Invalid OOB data: {escape(str(exc))}", status=400)
+
+ update_fields = ["custom_field_data"]
+ # Assign device.oob_ip if not already set; auto-create the IPAM
+ # record if it doesn't exist yet so the user has something to
+ # later attach to an interface and re-home if needed.
+ if oob_ip_str and existing_device.oob_ip_id is None:
+ oob_ip, oob_ip_created = get_or_create_global_ip(
+ oob_ip_str, auto_create=resolve_auto_create_ipam(request)
+ )
+ if oob_ip is not None:
+ existing_device.oob_ip = oob_ip
+ update_fields.append("oob_ip")
+ if oob_ip_created:
+ messages.info(
+ request,
+ f"Auto-created OOB IP {oob_ip_str} in IPAM (unassigned, global scope).",
+ )
+
+ if err := _save_device(existing_device, update_fields=update_fields):
+ return err
+
+ logger.info(
+ "Linked OOB device (LibreNMS ID %d, type %s) to '%s' (server: %s)",
+ librenms_id,
+ oob_type,
+ existing_device.name,
+ server_key,
+ )
+
+ cache_key = get_import_device_cache_key(device_id, server_key)
+ cache.delete(cache_key)
+
+ libre_device, validation, selections = self.get_validated_device_with_selections(device_id, request)
+ if not libre_device:
+ return HttpResponse("Device not found after action", status=404)
+
+ response = self.render_device_row(request, libre_device, validation, selections)
+ # Keep the validation modal open and refresh its contents in place so
+ # the user can confirm the new OOB attachment without losing context.
+ response["HX-Trigger"] = json.dumps({"validationRefresh": {"deviceId": device_id}})
+ return response
+
+
+class PromoteToHostView(
+ LibreNMSPermissionMixin, NetBoxObjectPermissionMixin, LibreNMSAPIMixin, DeviceImportHelperMixin, View
+):
+ """
+ Promote an incoming LibreNMS host device to be the *primary* link of an existing
+ NetBox device whose current LibreNMS link is the OOB controller.
+
+ The existing NetBox device's current ``librenms_id.{server_key}.id`` is moved into
+ the ``oob`` slot (preserving its bare-int β dict-form transition), and the incoming
+ LibreNMS device id becomes the new host id. No new NetBox device is created β this
+ is a reassignment, not an import.
+ """
+
+ def post(self, request, device_id):
+ if error := self.require_write_permission():
+ return error
+
+ from dcim.models import Device
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+
+ existing_device_id = request.POST.get("existing_device_id")
+ if not existing_device_id:
+ return HttpResponse("Missing existing_device_id", status=400)
+
+ post_server_key = (request.POST.get("server_key") or "").strip()
+ if post_server_key:
+ self._librenms_api = LibreNMSAPI(server_key=post_server_key)
+
+ try:
+ existing_device = Device.objects.get(pk=int(existing_device_id))
+ except (Device.DoesNotExist, ValueError):
+ return HttpResponse("Existing device not found", status=404)
+
+ self.required_object_permissions = {"POST": [("change", Device)]}
+ if error := self.require_object_permissions("POST"):
+ return error
+
+ # Optional per-field overrides from the pre-promote pick modal.
+ # All three default to "keep current"; only applied when the POST
+ # carries an explicit non-empty value.
+ override_name = (request.POST.get("override_name") or "").strip() or None
+ override_dt_id = (request.POST.get("override_device_type_id") or "").strip() or None
+ override_platform_id = (request.POST.get("override_platform_id") or "").strip() or None
+
+ override_device_type = None
+ if override_dt_id:
+ from dcim.models import DeviceType
+
+ try:
+ override_device_type = DeviceType.objects.get(pk=int(override_dt_id))
+ except (DeviceType.DoesNotExist, ValueError, TypeError):
+ return HttpResponse("Invalid override_device_type_id", status=400)
+
+ override_platform = None
+ if override_platform_id:
+ from dcim.models import Platform
+
+ try:
+ override_platform = Platform.objects.get(pk=int(override_platform_id))
+ except (Platform.DoesNotExist, ValueError, TypeError):
+ return HttpResponse("Invalid override_platform_id", status=400)
+
+ libre_device, validation, selections = self.get_validated_device_with_selections(device_id, request)
+ if not libre_device:
+ return HttpResponse("LibreNMS device not found", status=404)
+
+ promote = validation.get("promote_to_host") if validation else None
+ if not promote:
+ return HttpResponse("Promotion is not applicable for this device", status=400)
+ if (validation.get("existing_device") or existing_device).pk != existing_device.pk:
+ return HttpResponse(
+ "Device ID mismatch: existing_device_id does not match validation result",
+ status=400,
+ )
+
+ new_host_id = libre_device.get("device_id")
+ if isinstance(new_host_id, bool):
+ return HttpResponse("Invalid or missing LibreNMS device_id", status=400)
+ try:
+ new_host_id = int(new_host_id)
+ except (TypeError, ValueError):
+ return HttpResponse("Invalid or missing LibreNMS device_id", status=400)
+ if new_host_id <= 0:
+ return HttpResponse("Invalid LibreNMS device_id", status=400)
+
+ existing_libre_id = promote.get("existing_libre_id")
+ try:
+ existing_libre_id = int(existing_libre_id)
+ except (TypeError, ValueError):
+ return HttpResponse("Invalid existing LibreNMS id in promotion data", status=400)
+ if existing_libre_id == new_host_id:
+ return HttpResponse("Existing link already points at this LibreNMS device", status=409)
+
+ oob_type = promote.get("existing_oob_type") or ""
+ if not oob_type:
+ return HttpResponse("Cannot determine OOB type for promotion", status=400)
+
+ from netbox_librenms_plugin.utils import set_librenms_device_id, set_librenms_oob
+
+ server_key = self.librenms_api.server_key
+
+ # Pull stored OOB metadata (ip/version) from existing librenms link if possible,
+ # then ensure the incoming device's IP populates oob_ip on the existing device
+ # only if oob_ip isn't already set.
+ existing_oob_ip = None
+ oob_ip_str = None
+ cf_value = existing_device.custom_field_data.get("librenms_id")
+ if isinstance(cf_value, dict):
+ entry = cf_value.get(server_key)
+ if isinstance(entry, dict):
+ existing_oob_dict = entry.get("oob") if isinstance(entry.get("oob"), dict) else {}
+ existing_oob_ip = existing_oob_dict.get("ip") if isinstance(existing_oob_dict, dict) else None
+ # Prefer existing OOB ip if it was already known; otherwise use existing device's
+ # current oob_ip relationship; otherwise leave unset (do NOT inherit incoming
+ # device's IP β that IP belongs to the host, not the OOB controller).
+ if not existing_oob_ip and existing_device.oob_ip_id:
+ try:
+ from ipam.models import IPAddress # noqa
+
+ existing_oob_ip = str(existing_device.oob_ip).split("/")[0] if existing_device.oob_ip else None
+ except Exception: # pragma: no cover - defensive
+ existing_oob_ip = None
+ oob_ip_str = existing_oob_ip or None
+
+ # Reject legacy bare-int librenms_id form (caller should migrate first).
+ stored_id = existing_device.custom_field_data.get("librenms_id")
+ _is_legacy = isinstance(stored_id, int) and not isinstance(stored_id, bool)
+ if not _is_legacy and isinstance(stored_id, str):
+ try:
+ int(stored_id)
+ _is_legacy = True
+ except (ValueError, TypeError):
+ pass
+ if _is_legacy:
+ return HttpResponse(
+ "Device has a legacy bare-integer librenms_id; use 'Convert mapping' to migrate first.",
+ status=409,
+ )
+
+ with transaction.atomic():
+ try:
+ existing_device = Device.objects.select_for_update().get(pk=existing_device.pk)
+ except Device.DoesNotExist:
+ return HttpResponse(
+ "Device no longer exists; it may have been deleted concurrently.",
+ status=409,
+ )
+
+ try:
+ # First, swap the host id to the incoming LibreNMS device id.
+ # set_librenms_device_id preserves any existing OOB sub-object.
+ set_librenms_device_id(
+ existing_device,
+ new_host_id,
+ server_key=server_key,
+ )
+ # Then attach the previously-linked LibreNMS id as the OOB controller.
+ set_librenms_oob(
+ existing_device,
+ existing_libre_id,
+ server_key,
+ oob_type=oob_type,
+ ip=oob_ip_str,
+ )
+ except ValueError as exc:
+ return HttpResponse(f"Invalid promotion data: {escape(str(exc))}", status=400)
+
+ # After promotion, populate IP relationships on the existing device:
+ # - primary_ip4 / primary_ip6 from the incoming LibreNMS host's IP
+ # (the device that's now linked as the host)
+ # - oob_ip from the previously-linked LibreNMS device's IP
+ # (the device that's now demoted into the OOB slot)
+ # If the IP does not yet exist in NetBox we create a global /32 (or
+ # /128) entry so the device row looks complete after promotion;
+ # the user can re-home / mask it later via the IP-sync flow.
+ # Both writes are best-effort and never overwrite an already-set
+ # primary_ip4 / primary_ip6 / oob_ip relationship.
+ update_fields = ["custom_field_data"]
+
+ host_ip_str = (libre_device.get("ip") or "").strip() or None
+ if host_ip_str:
+ _auto_create = resolve_auto_create_ipam(request)
+ host_ip, host_ip_created = get_or_create_global_ip(host_ip_str, auto_create=_auto_create)
+ if host_ip is not None:
+ try:
+ is_v6 = _ipaddr_parse(host_ip_str).version == 6
+ except ValueError:
+ is_v6 = False
+ assigned = False
+ if is_v6 and existing_device.primary_ip6_id is None:
+ existing_device.primary_ip6 = host_ip
+ update_fields.append("primary_ip6")
+ assigned = True
+ elif not is_v6 and existing_device.primary_ip4_id is None:
+ existing_device.primary_ip4 = host_ip
+ update_fields.append("primary_ip4")
+ assigned = True
+ if host_ip_created and assigned:
+ messages.info(
+ request,
+ f"Auto-created primary IP {host_ip_str} in IPAM (unassigned, global scope).",
+ )
+
+ # Fetch OOB device's IP from LibreNMS if we don't already have one
+ # cached in CFD / the relationship.
+ if not oob_ip_str and existing_device.oob_ip_id is None:
+ try:
+ ok, oob_info = self.librenms_api.get_device_info(existing_libre_id)
+ except Exception: # pragma: no cover - defensive
+ ok, oob_info = False, None
+ if ok and isinstance(oob_info, dict):
+ fetched_oob_ip = (oob_info.get("ip") or "").strip() or None
+ if fetched_oob_ip:
+ oob_ip_str = fetched_oob_ip
+ # Re-write the OOB sub-object so the IP is also cached in CFD.
+ try:
+ set_librenms_oob(
+ existing_device,
+ existing_libre_id,
+ server_key,
+ oob_type=oob_type,
+ ip=oob_ip_str,
+ )
+ except ValueError: # pragma: no cover - defensive
+ pass
+
+ if oob_ip_str and existing_device.oob_ip_id is None:
+ oob_ip, oob_ip_created = get_or_create_global_ip(
+ oob_ip_str, auto_create=resolve_auto_create_ipam(request)
+ )
+ if oob_ip is not None:
+ existing_device.oob_ip = oob_ip
+ update_fields.append("oob_ip")
+ if oob_ip_created:
+ messages.info(
+ request,
+ f"Auto-created OOB IP {oob_ip_str} in IPAM (unassigned, global scope).",
+ )
+
+ # Apply any explicit per-field overrides chosen in the pre-promote modal.
+ # Default behaviour (no overrides) keeps the existing device's name, type
+ # and platform β matching the original promote semantics.
+ if override_name and override_name != existing_device.name:
+ existing_device.name = override_name
+ update_fields.append("name")
+ if override_device_type and existing_device.device_type_id != override_device_type.pk:
+ existing_device.device_type = override_device_type
+ update_fields.append("device_type")
+ if override_platform and existing_device.platform_id != override_platform.pk:
+ existing_device.platform = override_platform
+ update_fields.append("platform")
+
+ if err := _save_device(existing_device, update_fields=update_fields):
+ return err
+
+ logger.info(
+ "Promoted LibreNMS host (id %d) to '%s' on server %s; demoted previous link (id %d, type %s) to OOB slot",
+ new_host_id,
+ existing_device.name,
+ server_key,
+ existing_libre_id,
+ oob_type,
+ )
+
+ cache_key = get_import_device_cache_key(device_id, server_key)
+ cache.delete(cache_key)
+
libre_device, validation, selections = self.get_validated_device_with_selections(device_id, request)
if not libre_device:
return HttpResponse("Device not found after action", status=404)
+ response = self.render_device_row(request, libre_device, validation, selections)
+ # Keep the underlying validation modal open and re-fetch its content so
+ # the user can see the device's new link state (host id + OOB slot)
+ # without losing context. The JS handler in librenms_import.js fires a
+ # fresh GET to the validation URL using the row's existing details
+ # button.
+ response["HX-Trigger"] = json.dumps({"validationRefresh": {"deviceId": device_id}})
+ return response
+
+
+class MergeNetBoxDevicesView(
+ LibreNMSPermissionMixin, NetBoxObjectPermissionMixin, LibreNMSAPIMixin, DeviceImportHelperMixin, View
+):
+ """
+ Merge two existing NetBox devices that represent the same physical box.
+
+ The user (via radio buttons in the validation modal) picks which device is
+ the **winner** (kept) and which is the **donor** (absorbed). The donor's
+ LibreNMS link state under the active ``server_key`` is merged into the
+ winner; the donor's active link is then cleared and a ``_migrated_to``
+ marker is written. Interfaces, cables and primary IPs are NOT moved β
+ those stay on the donor for the user to re-home incrementally via the
+ Stage-2b "Migrated to X" tab.
+ """
+
+ def post(self, request, device_id):
+ if error := self.require_write_permission():
+ return error
+
+ from dcim.models import Device
+ from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+ from netbox_librenms_plugin.utils import (
+ mark_librenms_migrated,
+ merge_librenms_links,
+ )
+
+ post_server_key = (request.POST.get("server_key") or "").strip()
+ if post_server_key:
+ self._librenms_api = LibreNMSAPI(server_key=post_server_key)
+
+ winner_pk_raw = request.POST.get("winner_pk")
+ donor_pk_raw = request.POST.get("donor_pk")
+ if not winner_pk_raw or not donor_pk_raw:
+ return HttpResponse("Missing winner_pk or donor_pk", status=400)
+ try:
+ winner_pk = int(winner_pk_raw)
+ donor_pk = int(donor_pk_raw)
+ except (TypeError, ValueError):
+ return HttpResponse("Invalid winner_pk or donor_pk", status=400)
+ if winner_pk == donor_pk:
+ return HttpResponse("Winner and donor must be different devices", status=400)
+
+ try:
+ winner = Device.objects.get(pk=winner_pk)
+ donor = Device.objects.get(pk=donor_pk)
+ except Device.DoesNotExist:
+ return HttpResponse("Winner or donor device not found", status=404)
+
+ # Permission gate: user must be able to change BOTH devices.
+ self.required_object_permissions = {"POST": [("change", Device)]}
+ if error := self.require_object_permissions("POST"):
+ return error
+
+ libre_device, validation, selections = self.get_validated_device_with_selections(device_id, request)
+ if not libre_device:
+ return HttpResponse("LibreNMS device not found", status=404)
+
+ merge_candidates = (validation or {}).get("merge_candidates") or {}
+ candidate_pks = {
+ (merge_candidates.get("host_named") or {}).get("pk"),
+ (merge_candidates.get("oob_named") or {}).get("pk"),
+ }
+ candidate_pks.discard(None)
+ if {winner_pk, donor_pk} != candidate_pks:
+ return HttpResponse(
+ "winner_pk/donor_pk do not match the validation result's merge candidates",
+ status=400,
+ )
+
+ # Reject legacy bare-int librenms_id form on either side. The merge
+ # helpers refuse to operate on legacy data to prevent silent migration.
+ for label, obj in (("winner", winner), ("donor", donor)):
+ stored = obj.custom_field_data.get("librenms_id")
+ is_legacy = isinstance(stored, int) and not isinstance(stored, bool)
+ if not is_legacy and isinstance(stored, str):
+ try:
+ int(stored)
+ is_legacy = True
+ except (ValueError, TypeError):
+ pass
+ if is_legacy:
+ return HttpResponse(
+ f"{label.capitalize()} device has a legacy bare-integer librenms_id; "
+ "use 'Convert mapping' to migrate before merging.",
+ status=409,
+ )
+
+ server_key = self.librenms_api.server_key
+
+ with transaction.atomic():
+ # Lock both rows in deterministic pk order to avoid deadlocks.
+ locked = list(Device.objects.select_for_update().filter(pk__in=[winner_pk, donor_pk]).order_by("pk"))
+ if len(locked) != 2:
+ return HttpResponse(
+ "One of the devices no longer exists; it may have been deleted concurrently.",
+ status=409,
+ )
+ locked_by_pk = {d.pk: d for d in locked}
+ winner = locked_by_pk[winner_pk]
+ donor = locked_by_pk[donor_pk]
+
+ try:
+ summary = merge_librenms_links(winner, donor, server_key=server_key)
+ except ValueError as exc:
+ return HttpResponse(f"Cannot merge: {escape(str(exc))}", status=400)
+
+ # Transfer OOB IP relationship if winner has none and donor has one.
+ oob_ip_transferred = False
+ if donor.oob_ip_id and not winner.oob_ip_id:
+ winner.oob_ip = donor.oob_ip
+ donor.oob_ip = None
+ oob_ip_transferred = True
+
+ # Clear donor's active link and stamp migration marker.
+ mark_librenms_migrated(donor, winner.pk, server_key=server_key)
+
+ # Persist only the fields we actually touched. Calling
+ # ``full_clean()`` here (or relying on it via ``_save_device``)
+ # would re-validate every field on the device β which is
+ # undesirable when the rows hold pre-existing inconsistencies
+ # (e.g. ``face`` set without ``rack``) that are unrelated to
+ # this merge. See issue surfaced during eve-ng-02 merge.
+ update_fields = ["custom_field_data"]
+ if oob_ip_transferred:
+ update_fields.append("oob_ip")
+ try:
+ winner.save(update_fields=update_fields)
+ donor.save(update_fields=update_fields)
+ except Exception as exc: # pragma: no cover - defensive
+ return HttpResponse(f"Save failed: {escape(str(exc))}", status=500)
+
+ logger.info(
+ "Merged NetBox device '%s' (pk=%d) into '%s' (pk=%d) on server %s. Summary: %s; oob_ip_transferred=%s",
+ donor.name,
+ donor.pk,
+ winner.name,
+ winner.pk,
+ server_key,
+ summary,
+ oob_ip_transferred,
+ )
+
+ cache_key = get_import_device_cache_key(device_id, server_key)
+ cache.delete(cache_key)
+
+ libre_device, validation, selections = self.get_validated_device_with_selections(device_id, request)
+ if not libre_device:
+ return HttpResponse("Device not found after merge", status=404)
+
response = self.render_device_row(request, libre_device, validation, selections)
response["HX-Trigger"] = "closeModal"
return response
diff --git a/netbox_librenms_plugin/views/imports/list.py b/netbox_librenms_plugin/views/imports/list.py
index d2459a439a..dba23697c6 100644
--- a/netbox_librenms_plugin/views/imports/list.py
+++ b/netbox_librenms_plugin/views/imports/list.py
@@ -62,7 +62,7 @@ def should_use_background_job(self):
return False
return self._filter_form_data.get("use_background_job", True)
- def _load_job_results(self, job_id):
+ def _load_job_results(self, job_id, request=None):
"""
Load cached results from a completed background job.
@@ -128,6 +128,22 @@ def _load_job_results(self, job_id):
# Mirror the job's naming settings so toggle state matches the cached results
self._use_sysname = use_sysname
self._strip_domain = strip_domain
+ # IPAM auto-create toggle isn't part of the cached fetch β read
+ # the live setting/pref so the per-action toggle remains accurate.
+ try:
+ from netbox_librenms_plugin.models import LibreNMSSettings as _S
+
+ _settings = _S.objects.first()
+ except Exception:
+ _settings = None
+ _ipam = (
+ get_user_pref(request, "plugins.netbox_librenms_plugin.auto_create_ipam")
+ if request is not None
+ else None
+ )
+ if _ipam is None:
+ _ipam = getattr(_settings, "auto_create_ipam_default", False) if _settings else False
+ self._auto_create_ipam = _ipam
return validated_devices
@@ -158,13 +174,17 @@ def get(self, request, *args, **kwargs): # noqa: D401 - inherited doc
_use_sysname = get_user_pref(request, "plugins.netbox_librenms_plugin.use_sysname")
_strip_domain = get_user_pref(request, "plugins.netbox_librenms_plugin.strip_domain")
+ _auto_create_ipam = get_user_pref(request, "plugins.netbox_librenms_plugin.auto_create_ipam")
if _use_sysname is None:
_use_sysname = getattr(settings_obj, "use_sysname_default", True) if settings_obj else True
if _strip_domain is None:
_strip_domain = getattr(settings_obj, "strip_domain_default", False) if settings_obj else False
+ if _auto_create_ipam is None:
+ _auto_create_ipam = getattr(settings_obj, "auto_create_ipam_default", False) if settings_obj else False
self._use_sysname = _use_sysname
self._strip_domain = _strip_domain
+ self._auto_create_ipam = _auto_create_ipam
self._settings = settings_obj
# Determine if new filters are being submitted
@@ -186,7 +206,7 @@ def get(self, request, *args, **kwargs): # noqa: D401 - inherited doc
try:
job_id = int(job_id)
logger.info(f"Loading results from job {job_id}")
- validated_devices = self._load_job_results(job_id)
+ validated_devices = self._load_job_results(job_id, request=request)
if validated_devices:
self._import_data = validated_devices
self._job_results_loaded = True
@@ -350,6 +370,7 @@ def get(self, request, *args, **kwargs): # noqa: D401 - inherited doc
"settings": self._settings,
"use_sysname": self._use_sysname,
"strip_domain": self._strip_domain,
+ "auto_create_ipam": self._auto_create_ipam,
"vc_detection_enabled": getattr(self, "_vc_detection_enabled", False),
"cache_cleared": getattr(self, "_cache_cleared", False),
"from_cache": getattr(self, "_from_cache", False),
diff --git a/netbox_librenms_plugin/views/mapping_views.py b/netbox_librenms_plugin/views/mapping_views.py
index b1fcec9c77..60f792360e 100644
--- a/netbox_librenms_plugin/views/mapping_views.py
+++ b/netbox_librenms_plugin/views/mapping_views.py
@@ -1,15 +1,69 @@
+from django.http import HttpResponse, HttpResponseBadRequest
+from django.views import View
from netbox.views import generic
from utilities.views import register_model_view
-from netbox_librenms_plugin.filters import InterfaceTypeMappingFilterSet
+from netbox_librenms_plugin.filters import (
+ CarrierAutoInstallRuleFilterSet,
+ DeviceTypeMappingFilterSet,
+ InterfaceTypeMappingFilterSet,
+ InventoryIgnoreRuleFilterSet,
+ ModuleBayMappingFilterSet,
+ ModuleTypeMappingFilterSet,
+ NormalizationRuleFilterSet,
+ PlatformMappingFilterSet,
+)
from netbox_librenms_plugin.forms import (
+ CarrierAutoInstallRuleFilterForm,
+ CarrierAutoInstallRuleForm,
+ CarrierAutoInstallRuleImportForm,
+ DeviceTypeMappingFilterForm,
+ DeviceTypeMappingForm,
+ DeviceTypeMappingImportForm,
InterfaceTypeMappingFilterForm,
InterfaceTypeMappingForm,
InterfaceTypeMappingImportForm,
+ InventoryIgnoreRuleFilterForm,
+ InventoryIgnoreRuleForm,
+ InventoryIgnoreRuleImportForm,
+ ModuleBayMappingFilterForm,
+ ModuleBayMappingForm,
+ ModuleBayMappingImportForm,
+ ModuleTypeMappingFilterForm,
+ ModuleTypeMappingForm,
+ ModuleTypeMappingImportForm,
+ NormalizationRuleFilterForm,
+ NormalizationRuleForm,
+ NormalizationRuleImportForm,
+ PlatformMappingFilterForm,
+ PlatformMappingForm,
+ PlatformMappingImportForm,
+)
+from netbox_librenms_plugin.models import (
+ CarrierAutoInstallRule,
+ DeviceTypeMapping,
+ InterfaceTypeMapping,
+ InventoryIgnoreRule,
+ ModuleBayMapping,
+ ModuleTypeMapping,
+ NormalizationRule,
+ PlatformMapping,
+)
+from netbox_librenms_plugin.tables.mappings import (
+ CarrierAutoInstallRuleTable,
+ DeviceTypeMappingTable,
+ InterfaceTypeMappingTable,
+ InventoryIgnoreRuleTable,
+ ModuleBayMappingTable,
+ ModuleTypeMappingTable,
+ NormalizationRuleTable,
+ PlatformMappingTable,
+)
+from netbox_librenms_plugin.views.mixins import (
+ LibreNMSPermissionMixin,
+ LibreNMSWritePermissionMixin,
+ NetBoxObjectPermissionMixin,
)
-from netbox_librenms_plugin.models import InterfaceTypeMapping
-from netbox_librenms_plugin.tables.mappings import InterfaceTypeMappingTable
-from netbox_librenms_plugin.views.mixins import LibreNMSPermissionMixin
class InterfaceTypeMappingListView(LibreNMSPermissionMixin, generic.ObjectListView):
@@ -24,7 +78,7 @@ class InterfaceTypeMappingListView(LibreNMSPermissionMixin, generic.ObjectListVi
template_name = "netbox_librenms_plugin/interfacetypemapping_list.html"
-class InterfaceTypeMappingCreateView(LibreNMSPermissionMixin, generic.ObjectEditView):
+class InterfaceTypeMappingCreateView(LibreNMSWritePermissionMixin, generic.ObjectEditView):
"""
Provides a view for creating a new `InterfaceTypeMapping` object.
"""
@@ -34,7 +88,7 @@ class InterfaceTypeMappingCreateView(LibreNMSPermissionMixin, generic.ObjectEdit
@register_model_view(InterfaceTypeMapping, "bulk_import", path="import", detail=False)
-class InterfaceTypeMappingBulkImportView(LibreNMSPermissionMixin, generic.BulkImportView):
+class InterfaceTypeMappingBulkImportView(LibreNMSWritePermissionMixin, generic.BulkImportView):
"""
Provides a view for bulk importing `InterfaceTypeMapping` objects from CSV, JSON, or YAML.
Supports three import methods: direct import, file upload, and data file.
@@ -52,7 +106,7 @@ class InterfaceTypeMappingView(LibreNMSPermissionMixin, generic.ObjectView):
queryset = InterfaceTypeMapping.objects.all()
-class InterfaceTypeMappingEditView(LibreNMSPermissionMixin, generic.ObjectEditView):
+class InterfaceTypeMappingEditView(LibreNMSWritePermissionMixin, generic.ObjectEditView):
"""
Provides a view for editing a specific `InterfaceTypeMapping` object.
"""
@@ -61,7 +115,7 @@ class InterfaceTypeMappingEditView(LibreNMSPermissionMixin, generic.ObjectEditVi
form = InterfaceTypeMappingForm
-class InterfaceTypeMappingDeleteView(LibreNMSPermissionMixin, generic.ObjectDeleteView):
+class InterfaceTypeMappingDeleteView(LibreNMSWritePermissionMixin, generic.ObjectDeleteView):
"""
Provides a view for deleting a specific `InterfaceTypeMapping` object.
"""
@@ -69,7 +123,7 @@ class InterfaceTypeMappingDeleteView(LibreNMSPermissionMixin, generic.ObjectDele
queryset = InterfaceTypeMapping.objects.all()
-class InterfaceTypeMappingBulkDeleteView(LibreNMSPermissionMixin, generic.BulkDeleteView):
+class InterfaceTypeMappingBulkDeleteView(LibreNMSWritePermissionMixin, generic.BulkDeleteView):
"""
Provides a view for deleting multiple `InterfaceTypeMapping` objects.
"""
@@ -84,3 +138,487 @@ class InterfaceTypeMappingChangeLogView(LibreNMSPermissionMixin, generic.ObjectC
"""
queryset = InterfaceTypeMapping.objects.all()
+
+
+# --- DeviceTypeMapping views ---
+
+
+class DeviceTypeMappingListView(LibreNMSPermissionMixin, generic.ObjectListView):
+ """Provides a view for listing all DeviceTypeMapping objects."""
+
+ queryset = DeviceTypeMapping.objects.select_related("netbox_device_type")
+ table = DeviceTypeMappingTable
+ filterset = DeviceTypeMappingFilterSet
+ filterset_form = DeviceTypeMappingFilterForm
+ template_name = "netbox_librenms_plugin/devicetypemapping_list.html"
+
+
+class DeviceTypeMappingCreateView(LibreNMSWritePermissionMixin, generic.ObjectEditView):
+ """Provides a view for creating a new DeviceTypeMapping object."""
+
+ queryset = DeviceTypeMapping.objects.all()
+ form = DeviceTypeMappingForm
+
+
+@register_model_view(DeviceTypeMapping, "bulk_import", path="import", detail=False)
+class DeviceTypeMappingBulkImportView(LibreNMSWritePermissionMixin, generic.BulkImportView):
+ """Provides a view for bulk importing DeviceTypeMapping objects."""
+
+ queryset = DeviceTypeMapping.objects.all()
+ model_form = DeviceTypeMappingImportForm
+
+
+class DeviceTypeMappingView(LibreNMSPermissionMixin, generic.ObjectView):
+ """Provides a view for displaying details of a specific DeviceTypeMapping object."""
+
+ queryset = DeviceTypeMapping.objects.all()
+
+
+class DeviceTypeMappingEditView(LibreNMSWritePermissionMixin, generic.ObjectEditView):
+ """Provides a view for editing a specific DeviceTypeMapping object."""
+
+ queryset = DeviceTypeMapping.objects.all()
+ form = DeviceTypeMappingForm
+
+
+class DeviceTypeMappingDeleteView(LibreNMSWritePermissionMixin, generic.ObjectDeleteView):
+ """Provides a view for deleting a specific DeviceTypeMapping object."""
+
+ queryset = DeviceTypeMapping.objects.all()
+
+
+class DeviceTypeMappingBulkDeleteView(LibreNMSWritePermissionMixin, generic.BulkDeleteView):
+ """Provides a view for deleting multiple DeviceTypeMapping objects."""
+
+ queryset = DeviceTypeMapping.objects.all()
+ table = DeviceTypeMappingTable
+
+
+class DeviceTypeMappingChangeLogView(LibreNMSPermissionMixin, generic.ObjectChangeLogView):
+ """Provides a view for displaying the change log of a specific DeviceTypeMapping object."""
+
+ queryset = DeviceTypeMapping.objects.all()
+
+
+# --- ModuleTypeMapping views ---
+
+
+class ModuleTypeMappingListView(LibreNMSPermissionMixin, generic.ObjectListView):
+ """Provides a view for listing all ModuleTypeMapping objects."""
+
+ queryset = ModuleTypeMapping.objects.select_related("netbox_module_type")
+ table = ModuleTypeMappingTable
+ filterset = ModuleTypeMappingFilterSet
+ filterset_form = ModuleTypeMappingFilterForm
+ template_name = "netbox_librenms_plugin/moduletypemapping_list.html"
+
+
+class ModuleTypeMappingCreateView(LibreNMSWritePermissionMixin, generic.ObjectEditView):
+ """Provides a view for creating a new ModuleTypeMapping object."""
+
+ queryset = ModuleTypeMapping.objects.all()
+ form = ModuleTypeMappingForm
+
+
+@register_model_view(ModuleTypeMapping, "bulk_import", path="import", detail=False)
+class ModuleTypeMappingBulkImportView(LibreNMSWritePermissionMixin, generic.BulkImportView):
+ """Provides a view for bulk importing ModuleTypeMapping objects."""
+
+ queryset = ModuleTypeMapping.objects.all()
+ model_form = ModuleTypeMappingImportForm
+
+
+class ModuleTypeMappingView(LibreNMSPermissionMixin, generic.ObjectView):
+ """Provides a view for displaying details of a specific ModuleTypeMapping object."""
+
+ queryset = ModuleTypeMapping.objects.all()
+
+
+class ModuleTypeMappingEditView(LibreNMSWritePermissionMixin, generic.ObjectEditView):
+ """Provides a view for editing a specific ModuleTypeMapping object."""
+
+ queryset = ModuleTypeMapping.objects.all()
+ form = ModuleTypeMappingForm
+
+
+class ModuleTypeMappingDeleteView(LibreNMSWritePermissionMixin, generic.ObjectDeleteView):
+ """Provides a view for deleting a specific ModuleTypeMapping object."""
+
+ queryset = ModuleTypeMapping.objects.all()
+
+
+class ModuleTypeMappingBulkDeleteView(LibreNMSWritePermissionMixin, generic.BulkDeleteView):
+ """Provides a view for deleting multiple ModuleTypeMapping objects."""
+
+ queryset = ModuleTypeMapping.objects.all()
+ table = ModuleTypeMappingTable
+
+
+class ModuleTypeMappingChangeLogView(LibreNMSPermissionMixin, generic.ObjectChangeLogView):
+ """Provides a view for displaying the change log of a specific ModuleTypeMapping object."""
+
+ queryset = ModuleTypeMapping.objects.all()
+
+
+# --- ModuleBayMapping views ---
+
+
+class ModuleBayMappingListView(LibreNMSPermissionMixin, generic.ObjectListView):
+ """Provides a view for listing all ModuleBayMapping objects."""
+
+ queryset = ModuleBayMapping.objects.all()
+ table = ModuleBayMappingTable
+ filterset = ModuleBayMappingFilterSet
+ filterset_form = ModuleBayMappingFilterForm
+ template_name = "netbox_librenms_plugin/modulebaymapping_list.html"
+
+
+class ModuleBayMappingCreateView(LibreNMSWritePermissionMixin, generic.ObjectEditView):
+ """Provides a view for creating a new ModuleBayMapping object."""
+
+ queryset = ModuleBayMapping.objects.all()
+ form = ModuleBayMappingForm
+
+
+@register_model_view(ModuleBayMapping, "bulk_import", path="import", detail=False)
+class ModuleBayMappingBulkImportView(LibreNMSWritePermissionMixin, generic.BulkImportView):
+ """Provides a view for bulk importing ModuleBayMapping objects."""
+
+ queryset = ModuleBayMapping.objects.all()
+ model_form = ModuleBayMappingImportForm
+
+
+class ModuleBayMappingView(LibreNMSPermissionMixin, generic.ObjectView):
+ """Provides a view for displaying details of a specific ModuleBayMapping object."""
+
+ queryset = ModuleBayMapping.objects.all()
+
+
+class ModuleBayMappingEditView(LibreNMSWritePermissionMixin, generic.ObjectEditView):
+ """Provides a view for editing a specific ModuleBayMapping object."""
+
+ queryset = ModuleBayMapping.objects.all()
+ form = ModuleBayMappingForm
+
+
+class ModuleBayMappingDeleteView(LibreNMSWritePermissionMixin, generic.ObjectDeleteView):
+ """Provides a view for deleting a specific ModuleBayMapping object."""
+
+ queryset = ModuleBayMapping.objects.all()
+
+
+class ModuleBayMappingBulkDeleteView(LibreNMSWritePermissionMixin, generic.BulkDeleteView):
+ """Provides a view for deleting multiple ModuleBayMapping objects."""
+
+ queryset = ModuleBayMapping.objects.all()
+ table = ModuleBayMappingTable
+
+
+class ModuleBayMappingChangeLogView(LibreNMSPermissionMixin, generic.ObjectChangeLogView):
+ """Provides a view for displaying the change log of a specific ModuleBayMapping object."""
+
+ queryset = ModuleBayMapping.objects.all()
+
+
+# --- NormalizationRule views ---
+
+
+class NormalizationRuleListView(LibreNMSPermissionMixin, generic.ObjectListView):
+ """Provides a view for listing all NormalizationRule objects."""
+
+ queryset = NormalizationRule.objects.select_related("manufacturer")
+ table = NormalizationRuleTable
+ filterset = NormalizationRuleFilterSet
+ filterset_form = NormalizationRuleFilterForm
+ template_name = "netbox_librenms_plugin/normalizationrule_list.html"
+
+
+class NormalizationRuleCreateView(LibreNMSWritePermissionMixin, generic.ObjectEditView):
+ """Provides a view for creating a new NormalizationRule object."""
+
+ queryset = NormalizationRule.objects.all()
+ form = NormalizationRuleForm
+
+
+@register_model_view(NormalizationRule, "bulk_import", path="import", detail=False)
+class NormalizationRuleBulkImportView(LibreNMSWritePermissionMixin, generic.BulkImportView):
+ """Provides a view for bulk importing NormalizationRule objects."""
+
+ queryset = NormalizationRule.objects.all()
+ model_form = NormalizationRuleImportForm
+
+
+class NormalizationRuleView(LibreNMSPermissionMixin, generic.ObjectView):
+ """Provides a view for displaying details of a specific NormalizationRule object."""
+
+ queryset = NormalizationRule.objects.all()
+
+
+class NormalizationRuleEditView(LibreNMSWritePermissionMixin, generic.ObjectEditView):
+ """Provides a view for editing a specific NormalizationRule object."""
+
+ queryset = NormalizationRule.objects.all()
+ form = NormalizationRuleForm
+
+
+class NormalizationRuleDeleteView(LibreNMSWritePermissionMixin, generic.ObjectDeleteView):
+ """Provides a view for deleting a specific NormalizationRule object."""
+
+ queryset = NormalizationRule.objects.all()
+
+
+class NormalizationRuleBulkDeleteView(LibreNMSWritePermissionMixin, generic.BulkDeleteView):
+ """Provides a view for deleting multiple NormalizationRule objects."""
+
+ queryset = NormalizationRule.objects.all()
+ table = NormalizationRuleTable
+
+
+class NormalizationRuleChangeLogView(LibreNMSPermissionMixin, generic.ObjectChangeLogView):
+ """Provides a view for displaying the change log of a specific NormalizationRule object."""
+
+ queryset = NormalizationRule.objects.all()
+
+
+# --- InventoryIgnoreRule views ---
+
+
+class InventoryIgnoreRuleListView(LibreNMSPermissionMixin, generic.ObjectListView):
+ """Provides a view for listing all InventoryIgnoreRule objects."""
+
+ queryset = InventoryIgnoreRule.objects.all()
+ table = InventoryIgnoreRuleTable
+ filterset = InventoryIgnoreRuleFilterSet
+ filterset_form = InventoryIgnoreRuleFilterForm
+ template_name = "netbox_librenms_plugin/inventoryignorerule_list.html"
+
+
+class InventoryIgnoreRuleCreateView(LibreNMSWritePermissionMixin, generic.ObjectEditView):
+ """Provides a view for creating a new InventoryIgnoreRule object."""
+
+ queryset = InventoryIgnoreRule.objects.all()
+ form = InventoryIgnoreRuleForm
+
+
+@register_model_view(InventoryIgnoreRule, "bulk_import", path="import", detail=False)
+class InventoryIgnoreRuleBulkImportView(LibreNMSWritePermissionMixin, generic.BulkImportView):
+ """Provides a view for bulk importing InventoryIgnoreRule objects."""
+
+ queryset = InventoryIgnoreRule.objects.all()
+ model_form = InventoryIgnoreRuleImportForm
+
+
+class InventoryIgnoreRuleView(LibreNMSPermissionMixin, generic.ObjectView):
+ """Provides a view for displaying details of a specific InventoryIgnoreRule object."""
+
+ queryset = InventoryIgnoreRule.objects.all()
+
+
+class InventoryIgnoreRuleEditView(LibreNMSWritePermissionMixin, generic.ObjectEditView):
+ """Provides a view for editing a specific InventoryIgnoreRule object."""
+
+ queryset = InventoryIgnoreRule.objects.all()
+ form = InventoryIgnoreRuleForm
+
+
+class InventoryIgnoreRuleDeleteView(LibreNMSWritePermissionMixin, generic.ObjectDeleteView):
+ """Provides a view for deleting a specific InventoryIgnoreRule object."""
+
+ queryset = InventoryIgnoreRule.objects.all()
+
+
+class InventoryIgnoreRuleBulkDeleteView(LibreNMSWritePermissionMixin, generic.BulkDeleteView):
+ """Provides a view for deleting multiple InventoryIgnoreRule objects."""
+
+ queryset = InventoryIgnoreRule.objects.all()
+ table = InventoryIgnoreRuleTable
+
+
+class InventoryIgnoreRuleChangeLogView(LibreNMSPermissionMixin, generic.ObjectChangeLogView):
+ """Provides a view for displaying the change log of a specific InventoryIgnoreRule object."""
+
+ queryset = InventoryIgnoreRule.objects.all()
+
+
+# --- BulkExportYAML views ---
+
+
+class BulkExportYAMLView(LibreNMSPermissionMixin, NetBoxObjectPermissionMixin, View):
+ """Base view that exports selected mapping objects as YAML."""
+
+ queryset = None
+
+ @property
+ def required_object_permissions(self):
+ return {"POST": [("view", self.queryset.model)]}
+
+ def post(self, request):
+ if error := self.require_object_permissions("POST"):
+ return error
+ pks = request.POST.getlist("pk")
+ if not pks:
+ return HttpResponseBadRequest("No objects selected.")
+ try:
+ int_pks = [int(pk) for pk in pks]
+ except (ValueError, TypeError):
+ return HttpResponseBadRequest("Invalid pk value.")
+ objects = self.queryset.filter(pk__in=int_pks).order_by("pk")
+ if not objects:
+ return HttpResponseBadRequest("No matching objects found.")
+ yaml_parts = [obj.to_yaml() for obj in objects]
+ content = "---\n".join(yaml_parts)
+ response = HttpResponse(content, content_type="text/yaml; charset=utf-8")
+ response["Content-Disposition"] = 'attachment; filename="export.yaml"'
+ return response
+
+
+class InterfaceTypeMappingBulkExportYAMLView(BulkExportYAMLView):
+ queryset = InterfaceTypeMapping.objects.all()
+
+
+class DeviceTypeMappingBulkExportYAMLView(BulkExportYAMLView):
+ queryset = DeviceTypeMapping.objects.select_related("netbox_device_type")
+
+
+class ModuleTypeMappingBulkExportYAMLView(BulkExportYAMLView):
+ queryset = ModuleTypeMapping.objects.select_related("netbox_module_type")
+
+
+class ModuleBayMappingBulkExportYAMLView(BulkExportYAMLView):
+ queryset = ModuleBayMapping.objects.all()
+
+
+class NormalizationRuleBulkExportYAMLView(BulkExportYAMLView):
+ queryset = NormalizationRule.objects.select_related("manufacturer")
+
+
+class InventoryIgnoreRuleBulkExportYAMLView(BulkExportYAMLView):
+ queryset = InventoryIgnoreRule.objects.all()
+
+
+class PlatformMappingBulkExportYAMLView(BulkExportYAMLView):
+ queryset = PlatformMapping.objects.select_related("netbox_platform")
+
+
+# --- PlatformMapping views ---
+
+
+class PlatformMappingListView(LibreNMSPermissionMixin, generic.ObjectListView):
+ """Provides a view for listing all PlatformMapping objects."""
+
+ queryset = PlatformMapping.objects.select_related("netbox_platform")
+ table = PlatformMappingTable
+ filterset = PlatformMappingFilterSet
+ filterset_form = PlatformMappingFilterForm
+ template_name = "netbox_librenms_plugin/platformmapping_list.html"
+
+
+class PlatformMappingCreateView(LibreNMSWritePermissionMixin, generic.ObjectEditView):
+ """Provides a view for creating a new PlatformMapping object."""
+
+ queryset = PlatformMapping.objects.all()
+ form = PlatformMappingForm
+
+
+@register_model_view(PlatformMapping, "bulk_import", path="import", detail=False)
+class PlatformMappingBulkImportView(LibreNMSWritePermissionMixin, generic.BulkImportView):
+ """Provides a view for bulk importing PlatformMapping objects."""
+
+ queryset = PlatformMapping.objects.all()
+ model_form = PlatformMappingImportForm
+
+
+class PlatformMappingView(LibreNMSPermissionMixin, generic.ObjectView):
+ """Provides a view for displaying details of a specific PlatformMapping object."""
+
+ queryset = PlatformMapping.objects.all()
+
+
+class PlatformMappingEditView(LibreNMSWritePermissionMixin, generic.ObjectEditView):
+ """Provides a view for editing a specific PlatformMapping object."""
+
+ queryset = PlatformMapping.objects.all()
+ form = PlatformMappingForm
+
+
+class PlatformMappingDeleteView(LibreNMSWritePermissionMixin, generic.ObjectDeleteView):
+ """Provides a view for deleting a specific PlatformMapping object."""
+
+ queryset = PlatformMapping.objects.all()
+
+
+class PlatformMappingBulkDeleteView(LibreNMSWritePermissionMixin, generic.BulkDeleteView):
+ """Provides a view for deleting multiple PlatformMapping objects."""
+
+ queryset = PlatformMapping.objects.all()
+ table = PlatformMappingTable
+
+
+class PlatformMappingChangeLogView(LibreNMSPermissionMixin, generic.ObjectChangeLogView):
+ """Provides a view for displaying the change log of a specific PlatformMapping object."""
+
+ queryset = PlatformMapping.objects.all()
+
+
+# --- CarrierAutoInstallRule views ---
+
+
+class CarrierAutoInstallRuleListView(LibreNMSPermissionMixin, generic.ObjectListView):
+ """Provides a view for listing all CarrierAutoInstallRule objects."""
+
+ queryset = CarrierAutoInstallRule.objects.select_related("manufacturer", "carrier_module_type")
+ table = CarrierAutoInstallRuleTable
+ filterset = CarrierAutoInstallRuleFilterSet
+ filterset_form = CarrierAutoInstallRuleFilterForm
+ template_name = "netbox_librenms_plugin/carrierautoinstallrule_list.html"
+
+
+class CarrierAutoInstallRuleCreateView(LibreNMSWritePermissionMixin, generic.ObjectEditView):
+ """Provides a view for creating a new CarrierAutoInstallRule object."""
+
+ queryset = CarrierAutoInstallRule.objects.all()
+ form = CarrierAutoInstallRuleForm
+
+
+@register_model_view(CarrierAutoInstallRule, "bulk_import", path="import", detail=False)
+class CarrierAutoInstallRuleBulkImportView(LibreNMSWritePermissionMixin, generic.BulkImportView):
+ """Provides a view for bulk importing CarrierAutoInstallRule objects."""
+
+ queryset = CarrierAutoInstallRule.objects.all()
+ model_form = CarrierAutoInstallRuleImportForm
+
+
+class CarrierAutoInstallRuleView(LibreNMSPermissionMixin, generic.ObjectView):
+ """Provides a view for displaying details of a specific CarrierAutoInstallRule object."""
+
+ queryset = CarrierAutoInstallRule.objects.select_related("manufacturer", "carrier_module_type")
+
+
+class CarrierAutoInstallRuleEditView(LibreNMSWritePermissionMixin, generic.ObjectEditView):
+ """Provides a view for editing a specific CarrierAutoInstallRule object."""
+
+ queryset = CarrierAutoInstallRule.objects.all()
+ form = CarrierAutoInstallRuleForm
+
+
+class CarrierAutoInstallRuleDeleteView(LibreNMSWritePermissionMixin, generic.ObjectDeleteView):
+ """Provides a view for deleting a specific CarrierAutoInstallRule object."""
+
+ queryset = CarrierAutoInstallRule.objects.all()
+
+
+class CarrierAutoInstallRuleBulkDeleteView(LibreNMSWritePermissionMixin, generic.BulkDeleteView):
+ """Provides a view for deleting multiple CarrierAutoInstallRule objects."""
+
+ queryset = CarrierAutoInstallRule.objects.all()
+ table = CarrierAutoInstallRuleTable
+
+
+class CarrierAutoInstallRuleChangeLogView(LibreNMSPermissionMixin, generic.ObjectChangeLogView):
+ """Provides a view for displaying the change log of a specific CarrierAutoInstallRule object."""
+
+ queryset = CarrierAutoInstallRule.objects.all()
+
+
+class CarrierAutoInstallRuleBulkExportYAMLView(BulkExportYAMLView):
+ queryset = CarrierAutoInstallRule.objects.select_related("manufacturer", "carrier_module_type")
diff --git a/netbox_librenms_plugin/views/mixins.py b/netbox_librenms_plugin/views/mixins.py
index 62136017a1..f327183223 100644
--- a/netbox_librenms_plugin/views/mixins.py
+++ b/netbox_librenms_plugin/views/mixins.py
@@ -1,6 +1,8 @@
+import json
+
from django.contrib import messages
from django.contrib.auth.mixins import PermissionRequiredMixin
-from django.http import HttpResponse
+from django.http import HttpResponse, JsonResponse
from django.shortcuts import redirect
from django.utils.http import url_has_allowed_host_and_scheme
from utilities.permissions import get_permission_for_model
@@ -9,6 +11,17 @@
from netbox_librenms_plugin.librenms_api import LibreNMSAPI
+def parse_request_json(request):
+ """Parse JSON from request.body, returning (data, error_response).
+
+ On success returns (dict, None). On malformed input returns (None, JsonResponse 400).
+ """
+ try:
+ return json.loads(request.body), None
+ except (TypeError, ValueError):
+ return None, JsonResponse({"status": "error", "message": "Invalid JSON payload"}, status=400)
+
+
def _get_safe_redirect_url(request):
"""
Return a validated redirect URL from the HTTP Referer header.
@@ -62,6 +75,7 @@ def require_write_permission(self, error_message=None):
if self.request.headers.get("HX-Request"):
return HttpResponse("", headers={"HX-Redirect": referrer})
+ # referrer is safe: validated by _get_safe_redirect_url via url_has_allowed_host_and_scheme
return redirect(referrer)
return None
@@ -83,6 +97,18 @@ def require_write_permission_json(self, error_message=None):
return None
+class LibreNMSWritePermissionMixin(LibreNMSPermissionMixin):
+ """
+ Mixin for mutation views requiring LibreNMS plugin write permission.
+
+ Sets permission_required to 'change_librenmssettings' so that only users
+ with write access can access Create, Edit, Delete, BulkImport, and
+ BulkDelete views.
+ """
+
+ permission_required = PERM_CHANGE_PLUGIN
+
+
class NetBoxObjectPermissionMixin:
"""
Mixin for views requiring specific NetBox object permissions.
@@ -144,6 +170,7 @@ def require_object_permissions(self, method):
if self.request.headers.get("HX-Request"):
return HttpResponse("", headers={"HX-Redirect": referrer})
+ # referrer is safe: validated by _get_safe_redirect_url via url_has_allowed_host_and_scheme
return redirect(referrer)
return None
diff --git a/netbox_librenms_plugin/views/object_sync/__init__.py b/netbox_librenms_plugin/views/object_sync/__init__.py
index e9893cf7d8..118b2ff944 100644
--- a/netbox_librenms_plugin/views/object_sync/__init__.py
+++ b/netbox_librenms_plugin/views/object_sync/__init__.py
@@ -5,9 +5,11 @@
DeviceInterfaceTableView,
DeviceIPAddressTableView,
DeviceLibreNMSSyncView,
+ DeviceModuleTableView,
DeviceVLANTableView,
SaveVlanGroupOverridesView,
SingleInterfaceVerifyView,
+ SingleModuleVerifyView,
SingleVlanGroupVerifyView,
VerifyVlanSyncGroupView,
)
diff --git a/netbox_librenms_plugin/views/object_sync/devices.py b/netbox_librenms_plugin/views/object_sync/devices.py
index b3777e4cfd..05606058f7 100644
--- a/netbox_librenms_plugin/views/object_sync/devices.py
+++ b/netbox_librenms_plugin/views/object_sync/devices.py
@@ -1,4 +1,4 @@
-import json
+import copy
from dcim.models import Device
from django.core.cache import cache
@@ -17,6 +17,7 @@
LibreNMSInterfaceTable,
VCInterfaceTable,
)
+from netbox_librenms_plugin.tables.modules import LibreNMSModuleTable, VCModuleTable
from netbox_librenms_plugin.utils import (
get_interface_name_field,
get_librenms_sync_device,
@@ -30,8 +31,15 @@
from ..base.interfaces_view import BaseInterfaceTableView
from ..base.ip_addresses_view import BaseIPAddressTableView
from ..base.librenms_sync_view import BaseLibreNMSSyncView
+from ..base.modules_view import BaseModuleTableView, _check_ignore_rules
from ..base.vlan_table_view import BaseVLANTableView
-from ..mixins import CacheMixin, LibreNMSAPIMixin, LibreNMSPermissionMixin
+from ..mixins import (
+ CacheMixin,
+ LibreNMSAPIMixin,
+ LibreNMSPermissionMixin,
+ NetBoxObjectPermissionMixin,
+ parse_request_json,
+)
@register_model_view(Device, name="librenms_sync", path="librenms-sync")
@@ -46,24 +54,32 @@ def get_interface_context(self, request, obj):
"""Return interface sync context for the device."""
interface_name_field = get_interface_name_field(request)
interface_table_view = DeviceInterfaceTableView()
- interface_table_view.request = request
+ interface_table_view.request = copy.copy(request)
return interface_table_view.get_context_data(request, obj, interface_name_field)
def get_cable_context(self, request, obj):
"""Return cable sync context for the device."""
cable_table_view = DeviceCableTableView()
+ cable_table_view.request = copy.copy(request)
return cable_table_view.get_context_data(request, obj)
def get_ip_context(self, request, obj):
"""Return IP address sync context for the device."""
ipaddress_table_view = DeviceIPAddressTableView()
+ ipaddress_table_view.request = copy.copy(request)
return ipaddress_table_view.get_context_data(request, obj)
def get_vlan_context(self, request, obj):
vlan_table_view = DeviceVLANTableView()
- vlan_table_view.request = request
+ vlan_table_view.request = copy.copy(request)
return vlan_table_view.get_vlan_context(request, obj)
+ def get_module_context(self, request, obj):
+ """Return module sync context for the device."""
+ module_table_view = DeviceModuleTableView()
+ module_table_view.request = copy.copy(request)
+ return module_table_view.get_context_data(request, obj)
+
class DeviceInterfaceTableView(BaseInterfaceTableView):
"""Interface synchronization table for Devices."""
@@ -106,14 +122,18 @@ class SingleInterfaceVerifyView(LibreNMSPermissionMixin, LibreNMSAPIMixin, Cache
def post(self, request):
"""Verify interface data against cached LibreNMS ports for a device."""
- data = json.loads(request.body)
+ data, err = parse_request_json(request)
+ if err:
+ return err
selected_device_id = data.get("device_id")
interface_name = data.get("interface_name")
interface_name_field = data.get("interface_name_field") or get_interface_name_field()
- server_key = data.get("server_key") or self.librenms_api.server_key
+ server_key = data.get("server_key")
if not selected_device_id:
return JsonResponse({"status": "error", "message": "No device ID provided"}, status=400)
+ if not server_key:
+ server_key = self.librenms_api.server_key
selected_device = get_object_or_404(Device, pk=selected_device_id)
@@ -149,6 +169,169 @@ def post(self, request):
return JsonResponse({"status": "error", "message": "Interface data not found"}, status=404)
+class SingleModuleVerifyView(
+ LibreNMSPermissionMixin,
+ NetBoxObjectPermissionMixin,
+ LibreNMSAPIMixin,
+ CacheMixin,
+ View,
+):
+ """Verify module row data against cached LibreNMS inventory for a selected VC member."""
+
+ # JSON endpoint that returns the rendered module row β only viewers of the
+ # underlying Device should be able to surface its inventory data.
+ required_object_permissions = {"POST": [("view", Device)]}
+
+ def post(self, request):
+ data, err = parse_request_json(request)
+ if err:
+ return err
+ selected_device_id = data.get("device_id")
+ ent_physical_index = data.get("ent_physical_index")
+ server_key = data.get("server_key") or self.librenms_api.server_key
+ row_depth = data.get("depth", 0)
+
+ if not selected_device_id:
+ return JsonResponse({"status": "error", "message": "No device ID provided"}, status=400)
+ if ent_physical_index in (None, ""):
+ return JsonResponse({"status": "error", "message": "No entPhysicalIndex provided"}, status=400)
+
+ try:
+ ent_physical_index = int(ent_physical_index)
+ except (TypeError, ValueError):
+ return JsonResponse({"status": "error", "message": "Invalid entPhysicalIndex"}, status=400)
+
+ try:
+ row_depth = int(row_depth)
+ except (TypeError, ValueError):
+ row_depth = 0
+
+ selected_device = get_object_or_404(Device, pk=selected_device_id)
+
+ # Read-only verify endpoint: only require object-view permission, not
+ # plugin write (which require_all_permissions_json would enforce).
+ if error := self.require_object_permissions_json("POST"):
+ return error
+
+ if selected_device.virtual_chassis:
+ sync_device = get_librenms_sync_device(selected_device, server_key=server_key)
+ if sync_device is None:
+ return JsonResponse({"status": "error", "message": "No sync device found for VC"}, status=404)
+ else:
+ sync_device = selected_device
+
+ cached_payload = cache.get(self.get_cache_key(sync_device, "inventory", server_key))
+ if not isinstance(cached_payload, dict):
+ return JsonResponse({"status": "error", "message": "No cached inventory data"}, status=404)
+
+ inventory_data = cached_payload.get("inventory") or []
+ index_map = {idx: item for item in inventory_data if (idx := item.get("entPhysicalIndex")) is not None}
+ item = index_map.get(ent_physical_index)
+ if not item:
+ return JsonResponse({"status": "error", "message": "Inventory row not found"}, status=404)
+
+ module_table_view = DeviceModuleTableView()
+ # Shallow-copy the request so the child view can mutate request.GET /
+ # request.POST without affecting this request object.
+ module_table_view.request = copy.copy(request)
+
+ from netbox_librenms_plugin.utils import (
+ get_enabled_ignore_rules,
+ load_bay_mappings,
+ preload_normalization_rules,
+ )
+
+ module_table_view._exact_bay_mappings, module_table_view._regex_bay_mappings = load_bay_mappings()
+ manufacturer = getattr(getattr(selected_device, "device_type", None), "manufacturer", None)
+ module_table_view._norm_rules_bay = preload_normalization_rules("module_bay")
+ module_table_view._norm_rules_type = preload_normalization_rules("module_type", manufacturer=manufacturer)
+
+ children_by_parent = {}
+ for inventory_item in inventory_data:
+ parent_idx = inventory_item.get("entPhysicalContainedIn")
+ if parent_idx is not None:
+ children_by_parent.setdefault(parent_idx, []).append(inventory_item)
+
+ ignore_rules = get_enabled_ignore_rules()
+ device_serial = (getattr(selected_device, "serial", None) or "").strip()
+ ignore_cache = {
+ inventory_item["entPhysicalIndex"]: _check_ignore_rules(
+ inventory_item,
+ index_map.get(inventory_item.get("entPhysicalContainedIn")),
+ ignore_rules,
+ index_map,
+ device_serial,
+ )
+ for inventory_item in inventory_data
+ if inventory_item.get("entPhysicalIndex") is not None
+ }
+
+ module_types = module_table_view._get_module_types()
+ transparent_indices = module_table_view._find_transparent_indices(inventory_data, ignore_cache)
+ top_items = module_table_view._collect_top_items(
+ inventory_data,
+ index_map,
+ ignore_rules,
+ device_serial,
+ transparent_indices,
+ ignore_cache,
+ )
+ table_data = module_table_view._build_table_rows_for_member(
+ selected_device,
+ top_items,
+ index_map,
+ children_by_parent,
+ ignore_rules,
+ device_serial,
+ module_types,
+ manufacturer=manufacturer,
+ )
+ module_table_view._detect_serial_conflicts(table_data)
+
+ # entPhysicalIndex should be unique, depth fallback handles malformed duplicates.
+ row = next(
+ (
+ candidate
+ for candidate in table_data
+ if candidate.get("ent_physical_index") == ent_physical_index and candidate.get("depth", 0) == row_depth
+ ),
+ None,
+ )
+ if row is None:
+ row = next(
+ (candidate for candidate in table_data if candidate.get("ent_physical_index") == ent_physical_index),
+ None,
+ )
+ if row is None:
+ return JsonResponse({"status": "error", "message": "Inventory row not found"}, status=404)
+
+ has_write_permission = self.has_write_permission()
+ table_class = VCModuleTable if selected_device.virtual_chassis else LibreNMSModuleTable
+ table = table_class(
+ [],
+ device=selected_device,
+ server_key=server_key,
+ has_write_permission=has_write_permission,
+ can_add_module=has_write_permission and request.user.has_perm("dcim.add_module"),
+ can_change_module=has_write_permission and request.user.has_perm("dcim.change_module"),
+ can_delete_module=has_write_permission and request.user.has_perm("dcim.delete_module"),
+ can_add_module_bay_template=(has_write_permission and request.user.has_perm("dcim.add_modulebaytemplate")),
+ can_add_module_type=(has_write_permission and request.user.has_perm("dcim.add_moduletype")),
+ can_add_carrier_rule=(
+ has_write_permission and request.user.has_perm("netbox_librenms_plugin.add_carrierautoinstallrule")
+ ),
+ can_add_module_bay_mapping=(
+ has_write_permission and request.user.has_perm("netbox_librenms_plugin.add_modulebaymapping")
+ ),
+ can_add_module_type_mapping=(
+ has_write_permission and request.user.has_perm("netbox_librenms_plugin.add_moduletypemapping")
+ ),
+ )
+ table.configure(request)
+ formatted_row = table.format_module_data(row)
+ return JsonResponse({"status": "success", "formatted_row": formatted_row})
+
+
class SingleVlanGroupVerifyView(LibreNMSPermissionMixin, CacheMixin, View):
"""
Verify VLAN assignments for an interface against a specific VLAN group.
@@ -161,7 +344,9 @@ class SingleVlanGroupVerifyView(LibreNMSPermissionMixin, CacheMixin, View):
def post(self, request):
from ipam.models import VLAN, VLANGroup
- data = json.loads(request.body)
+ data, err = parse_request_json(request)
+ if err:
+ return err
device_id = data.get("device_id")
interface_name = data.get("interface_name")
vlan_group_id = data.get("vlan_group_id")
@@ -287,7 +472,9 @@ class VerifyVlanSyncGroupView(LibreNMSPermissionMixin, View):
def post(self, request):
from ipam.models import VLAN, VLANGroup
- data = json.loads(request.body)
+ data, err = parse_request_json(request)
+ if err:
+ return err
vlan_group_id = data.get("vlan_group_id")
vid_str = data.get("vid", "")
librenms_name = data.get("name", "")
@@ -339,13 +526,17 @@ def post(self, request):
if error := self.require_write_permission_json():
return error
- data = json.loads(request.body)
+ data, err = parse_request_json(request)
+ if err:
+ return err
device_id = data.get("device_id")
vid_group_map = data.get("vid_group_map", {})
- server_key = data.get("server_key") or self.librenms_api.server_key
+ server_key = data.get("server_key")
if not device_id:
return JsonResponse({"status": "error", "message": "No device ID provided"}, status=400)
+ if not server_key:
+ server_key = self.librenms_api.server_key
device = get_object_or_404(Device, pk=device_id)
@@ -393,3 +584,38 @@ class DeviceVLANTableView(BaseVLANTableView):
"""VLAN synchronization table view for Devices."""
model = Device
+
+
+class DeviceModuleTableView(BaseModuleTableView):
+ """Module/inventory synchronization view for Devices."""
+
+ model = Device
+
+ def get_table(self, data, obj):
+ """Return the module sync table."""
+ user = self.request.user
+ has_write_permission = self.has_write_permission()
+ table_class = VCModuleTable if hasattr(obj, "virtual_chassis") and obj.virtual_chassis else LibreNMSModuleTable
+ table = table_class(
+ data,
+ device=obj,
+ server_key=self.librenms_api.server_key,
+ has_write_permission=has_write_permission,
+ can_add_module=has_write_permission and user.has_perm("dcim.add_module"),
+ can_change_module=has_write_permission and user.has_perm("dcim.change_module"),
+ can_delete_module=has_write_permission and user.has_perm("dcim.delete_module"),
+ can_add_module_bay_template=(has_write_permission and user.has_perm("dcim.add_modulebaytemplate")),
+ can_add_module_type=(has_write_permission and user.has_perm("dcim.add_moduletype")),
+ can_add_carrier_rule=(
+ has_write_permission and user.has_perm("netbox_librenms_plugin.add_carrierautoinstallrule")
+ ),
+ can_add_module_bay_mapping=(
+ has_write_permission and user.has_perm("netbox_librenms_plugin.add_modulebaymapping")
+ ),
+ can_add_module_type_mapping=(
+ has_write_permission and user.has_perm("netbox_librenms_plugin.add_moduletypemapping")
+ ),
+ )
+ server_key = self.librenms_api.server_key
+ table.htmx_url = f"{self.request.path}?tab=modules" + (f"&server_key={server_key}" if server_key else "")
+ return table
diff --git a/netbox_librenms_plugin/views/sync/device_fields.py b/netbox_librenms_plugin/views/sync/device_fields.py
index 473c348f0e..68f6e855ad 100644
--- a/netbox_librenms_plugin/views/sync/device_fields.py
+++ b/netbox_librenms_plugin/views/sync/device_fields.py
@@ -4,16 +4,20 @@
from django.contrib import messages
from django.core.exceptions import ValidationError
from django.db import IntegrityError, transaction
+from django.utils.text import slugify
from django.http import HttpResponse
from django.shortcuts import get_object_or_404, redirect
+from django.utils.html import escape
from django.views import View
from virtualization.models import VirtualMachine
from netbox_librenms_plugin.import_utils import _determine_device_name
from netbox_librenms_plugin.import_utils.virtual_chassis import _generate_vc_member_name
+from netbox_librenms_plugin.models import PlatformMapping
from netbox_librenms_plugin.utils import (
find_by_librenms_id,
+ find_matching_platform,
get_librenms_sync_device,
match_librenms_hardware_to_device_type,
migrate_legacy_librenms_id,
@@ -194,7 +198,14 @@ def post(self, request, pk):
match_result = match_librenms_hardware_to_device_type(hardware)
- if not match_result or not match_result["matched"]:
+ if match_result is None:
+ messages.error(
+ request,
+ f"Ambiguous hardware match for '{hardware}': multiple matching mappings/device types found.",
+ )
+ return redirect("plugins:netbox_librenms_plugin:device_librenms_sync", pk=pk)
+
+ if not match_result["matched"]:
messages.error(
request,
f"No matching DeviceType found for hardware '{hardware}'",
@@ -253,19 +264,24 @@ def post(self, request, pk):
messages.warning(request, "No OS information available in LibreNMS")
return redirect("plugins:netbox_librenms_plugin:device_librenms_sync", pk=pk)
- platform_name = os_name
-
- try:
- platform = Platform.objects.get(name__iexact=platform_name)
- except Platform.DoesNotExist:
+ result = find_matching_platform(os_name)
+ if result["match_type"] == "ambiguous":
+ messages.error(
+ request,
+ "Multiple platforms match '{}'. Please resolve the ambiguity via a Platform Mapping.".format(os_name),
+ )
+ return redirect("plugins:netbox_librenms_plugin:device_librenms_sync", pk=pk)
+ if not result["found"] or result["platform"] is None:
messages.error(
request,
"Platform '{}' does not exist in NetBox. Use 'Create & Sync' button to create it first.".format(
- platform_name
+ os_name
),
)
return redirect("plugins:netbox_librenms_plugin:device_librenms_sync", pk=pk)
+ platform = result["platform"]
+
old_platform = device.platform
device.platform = platform
try:
@@ -300,6 +316,17 @@ class CreateAndAssignPlatformView(LibreNMSPermissionMixin, NetBoxObjectPermissio
def post(self, request, pk):
"""Create a new platform and assign it to the device."""
+ # Read create_mapping before permission check so it can be included in the check.
+ create_mapping = bool(request.POST.get("create_mapping"))
+ if create_mapping:
+ self.required_object_permissions = {
+ "POST": [
+ ("change", Device),
+ ("add", Platform),
+ ("add", PlatformMapping),
+ ],
+ }
+
# Check both plugin write and NetBox object permissions
if error := self.require_all_permissions("POST"):
return error
@@ -308,6 +335,7 @@ def post(self, request, pk):
platform_name = request.POST.get("platform_name")
manufacturer_id = request.POST.get("manufacturer")
+ librenms_os = (request.POST.get("librenms_os") or "").strip().lower()
if not platform_name:
messages.error(request, "Platform name is required")
@@ -331,6 +359,7 @@ def post(self, request, pk):
try:
platform = Platform(
name=platform_name,
+ slug=slugify(platform_name),
manufacturer=manufacturer,
)
platform.full_clean()
@@ -396,10 +425,46 @@ def post(self, request, pk):
)
return redirect("plugins:netbox_librenms_plugin:device_librenms_sync", pk=pk)
- messages.success(
- request,
- f"Created platform '{platform}' and assigned to device",
- )
+ mapping_created = False
+ mapping_error = None
+ mapping_existed = False
+ if create_mapping and librenms_os:
+ existing = PlatformMapping.objects.filter(librenms_os__iexact=librenms_os).first()
+ if existing is not None:
+ mapping_existed = True
+ else:
+ try:
+ with transaction.atomic():
+ mapping = PlatformMapping(librenms_os=librenms_os, netbox_platform=platform)
+ mapping.full_clean()
+ mapping.save()
+ mapping_created = True
+ except ValidationError as e:
+ mapping_error = e.message_dict if hasattr(e, "message_dict") else str(e)
+ logger.exception("Failed to create PlatformMapping '%s' -> '%s'", librenms_os, platform_name)
+ except IntegrityError:
+ # Concurrent insert: mapping was created by another request
+ mapping_existed = True
+ logger.warning(
+ "IntegrityError creating PlatformMapping '%s' -> '%s'; treating as already existing",
+ librenms_os,
+ platform_name,
+ )
+
+ msg = f"Created platform '{platform}' and assigned to device"
+ if mapping_created:
+ msg += f" β platform mapping '{librenms_os}' β '{platform}' added"
+ messages.success(request, msg)
+ if mapping_error:
+ messages.warning(
+ request,
+ f"Platform mapping '{librenms_os}' β '{platform}' could not be created: {mapping_error}",
+ )
+ elif mapping_existed:
+ messages.info(
+ request,
+ f"Platform mapping for '{librenms_os}' already exists; not modified.",
+ )
return redirect("plugins:netbox_librenms_plugin:device_librenms_sync", pk=pk)
@@ -512,7 +577,7 @@ def post(self, request, pk):
if object_type == "virtualmachine":
object_type = "vm"
if object_type not in ("device", "vm"):
- return HttpResponse(f"Invalid object_type: {object_type!r}", status=400)
+ return HttpResponse(f"Invalid object_type: {escape(object_type)}", status=400)
target_model = VirtualMachine if object_type == "vm" else Device
self.required_object_permissions = {"POST": [("change", target_model)]}
@@ -616,7 +681,7 @@ def post(self, request, pk):
if object_type == "virtualmachine":
object_type = "vm"
if object_type not in ("device", "vm"):
- return HttpResponse(f"Invalid object_type: {object_type!r}", status=400)
+ return HttpResponse(f"Invalid object_type: {escape(object_type)}", status=400)
target_model = VirtualMachine if object_type == "vm" else Device
self.required_object_permissions = {"POST": [("change", target_model)]}
diff --git a/netbox_librenms_plugin/views/sync/devices.py b/netbox_librenms_plugin/views/sync/devices.py
index 71add20d48..b42de9220e 100644
--- a/netbox_librenms_plugin/views/sync/devices.py
+++ b/netbox_librenms_plugin/views/sync/devices.py
@@ -1,14 +1,25 @@
from dcim.models import Device
from django.contrib import messages
+from django.http import HttpResponse
from django.shortcuts import get_object_or_404, redirect
+from django.utils.html import escape
from django.views import View
from virtualization.models import VirtualMachine
from netbox_librenms_plugin.forms import AddToLIbreSNMPV1V2, AddToLIbreSNMPV3
-from netbox_librenms_plugin.views.mixins import LibreNMSAPIMixin, LibreNMSPermissionMixin
-
-
-class AddDeviceToLibreNMSView(LibreNMSPermissionMixin, LibreNMSAPIMixin, View):
+from netbox_librenms_plugin.views.mixins import (
+ LibreNMSAPIMixin,
+ LibreNMSPermissionMixin,
+ NetBoxObjectPermissionMixin,
+)
+
+
+class AddDeviceToLibreNMSView(
+ LibreNMSPermissionMixin,
+ NetBoxObjectPermissionMixin,
+ LibreNMSAPIMixin,
+ View,
+):
"""Add a NetBox device or VM to LibreNMS via the API."""
def get_form_class(self):
@@ -25,23 +36,44 @@ def get_object(self, object_id, object_type=None):
"""
Return the Device or VirtualMachine for the given ID.
- Uses object_type hint when provided to avoid PK collision ambiguity
- (Device and VirtualMachine share independent PK sequences).
+ Uses *object_type* to pick the correct model, preventing a false
+ match when a Device and VirtualMachine share the same PK.
+
+ Returns ``None`` for invalid *object_type* β callers must short-circuit
+ with HTTP 400 before using the result (a missing/unknown object_type is
+ a client error, not a missing-resource error).
"""
if object_type == "virtualmachine":
return get_object_or_404(VirtualMachine, pk=object_id)
- try:
- return Device.objects.get(pk=object_id)
- except Device.DoesNotExist:
- return get_object_or_404(VirtualMachine, pk=object_id)
+ if object_type == "device":
+ return get_object_or_404(Device, pk=object_id)
+ return None
def post(self, request, object_id):
"""Add a device to LibreNMS using the submitted SNMP form."""
- # Check write permission before adding device to LibreNMS
- if error := self.require_write_permission():
+ # Resolve the target object first so we can apply object-level perms
+ # against the correct model (Device vs VirtualMachine).
+ object_type = request.POST.get("object_type")
+ self.object = self.get_object(object_id, object_type=object_type)
+ if self.object is None:
+ # Match the convention used in views/sync/device_fields.py β return
+ # 400 (Bad Request) with an escaped echo of the offending value
+ # rather than raising 404, which would mislead clients into
+ # thinking the object itself is missing.
+ return HttpResponse(
+ f"Invalid object_type: {escape(str(object_type))}",
+ status=400,
+ )
+
+ # Plugin write perm + NetBox change perm on the resolved model. The
+ # mapping is set per-request because object_type can be either
+ # device or virtualmachine; static class-level declaration cannot
+ # express that branch.
+ target_model = VirtualMachine if object_type == "virtualmachine" else Device
+ self.required_object_permissions = {"POST": [("change", target_model)]}
+ if error := self.require_all_permissions("POST"):
return error
- self.object = self.get_object(object_id, request.POST.get("object_type"))
form_class = self.get_form_class()
snmp_version = request.POST.get("v1v2-snmp_version") or request.POST.get("v3-snmp_version")
diff --git a/netbox_librenms_plugin/views/sync/interfaces.py b/netbox_librenms_plugin/views/sync/interfaces.py
index 2259ff4892..4a4bee29c1 100644
--- a/netbox_librenms_plugin/views/sync/interfaces.py
+++ b/netbox_librenms_plugin/views/sync/interfaces.py
@@ -1,5 +1,7 @@
from urllib.parse import quote_plus
+import logging
+
from dcim.models import Device, Interface, MACAddress
from django.contrib import messages
from django.core.cache import cache
@@ -26,6 +28,8 @@
VlanAssignmentMixin,
)
+logger = logging.getLogger(__name__)
+
class SyncInterfacesView(
LibreNMSPermissionMixin, NetBoxObjectPermissionMixin, LibreNMSAPIMixin, VlanAssignmentMixin, CacheMixin, View
@@ -382,8 +386,9 @@ def post(self, request, object_type, object_id):
errors.append(f"Error deleting interface {interface_name or interface_id}: {str(exc)}")
continue
- except Exception as exc: # pragma: no cover
- return JsonResponse({"error": f"Transaction failed: {str(exc)}"}, status=500)
+ except Exception: # pragma: no cover
+ logger.exception("DeleteNetBoxInterfacesView transaction failed")
+ return JsonResponse({"error": "Transaction failed. Please check server logs."}, status=500)
response_data = {
"status": "success",
diff --git a/netbox_librenms_plugin/views/sync/migrate.py b/netbox_librenms_plugin/views/sync/migrate.py
new file mode 100644
index 0000000000..08aeaa95ea
--- /dev/null
+++ b/netbox_librenms_plugin/views/sync/migrate.py
@@ -0,0 +1,277 @@
+"""
+Stage 2b: per-row "Move to winner" actions on a donor device whose
+``librenms_id[server_key]`` carries a ``_migrated_to`` marker.
+
+Each view validates the marker, looks up the winner Device, runs an
+atomic move under ``select_for_update`` ordering by primary key (to avoid
+cross-merge deadlocks), and returns either an HTMX-friendly partial
+response or a plain redirect.
+
+Permissions: each view requires plugin write permission AND the
+appropriate NetBox model permission on the object being moved.
+"""
+
+from dcim.models import Device, Interface
+from django.contrib import messages
+from django.db import transaction
+from django.http import HttpResponse, JsonResponse
+from django.shortcuts import get_object_or_404, redirect
+from django.views import View
+from ipam.models import IPAddress
+
+from netbox_librenms_plugin.utils import get_migrated_to_marker
+from netbox_librenms_plugin.views.mixins import (
+ LibreNMSPermissionMixin,
+ NetBoxObjectPermissionMixin,
+)
+
+
+def _resolve_winner_for_donor(donor, server_key="default"):
+ """
+ Return ``(winner, marker)`` for *donor*, or ``(None, None)`` when no
+ valid ``_migrated_to`` marker is present or the winner has been
+ deleted.
+
+ ``marker`` is the dict written by :func:`mark_librenms_migrated`.
+ """
+ marker = get_migrated_to_marker(donor, server_key)
+ if not marker:
+ return None, None
+ winner = Device.objects.filter(pk=marker["device_id"]).first()
+ if winner is None:
+ return None, marker
+ return winner, marker
+
+
+def _server_key_from_request(request, default="default"):
+ """Extract the LibreNMS server key from the POST body (form field)."""
+ sk = request.POST.get("server_key") or default
+ return sk if isinstance(sk, str) and sk else default
+
+
+def _hx_response(request, message, level=messages.SUCCESS, *, status=200):
+ """
+ Common HTMX response: queue a Django messages flash and emit the
+ ``HX-Refresh`` header so the sync page re-renders with the row gone.
+
+ For non-HTMX requests, queue the message and redirect to the donor's
+ librenms-sync URL.
+ """
+ messages.add_message(request, level, message)
+ if request.headers.get("HX-Request"):
+ return HttpResponse(status=status, headers={"HX-Refresh": "true"})
+ return redirect(request.META.get("HTTP_REFERER") or "/")
+
+
+class _BaseMoveToWinnerView(LibreNMSPermissionMixin, NetBoxObjectPermissionMixin, View):
+ """Shared plumbing for the per-resource move endpoints."""
+
+ def _gate(self, request):
+ """
+ Plugin-write + object-perm gate. Returns a response on failure
+ (which the caller must return verbatim) or ``None`` on success.
+ """
+ resp = self.require_all_permissions("POST")
+ if resp is not None:
+ return resp
+ return None
+
+
+class MoveInterfaceToWinnerView(_BaseMoveToWinnerView):
+ """
+ Reassign ``Interface.device`` from donor to winner.
+
+ Cables, IP-address attachments, MAC objects, and VLAN tag config all
+ point at the Interface row by FK, so they follow the move
+ automatically.
+
+ Fails (toast + 409) when the winner already has an interface with the
+ same name β the user must rename or delete the colliding interface
+ on the winner first.
+ """
+
+ required_object_permissions = {"POST": [("change", Interface)]}
+
+ def post(self, request, pk):
+ gate = self._gate(request)
+ if gate is not None:
+ return gate
+
+ interface = get_object_or_404(Interface, pk=pk)
+ donor = interface.device
+ if donor is None:
+ return self._fail(request, "Interface has no device.")
+
+ server_key = _server_key_from_request(request)
+ winner, marker = _resolve_winner_for_donor(donor, server_key)
+ if marker is None:
+ return self._fail(request, "Donor device is not marked as migrated.", status=409)
+ if winner is None:
+ return self._fail(request, "Winner device no longer exists.", status=410)
+
+ if Interface.objects.filter(device=winner, name=interface.name).exists():
+ return self._fail(
+ request,
+ f"Winner device '{winner.name}' already has an interface named '{interface.name}'. "
+ "Rename or remove the existing interface first.",
+ status=409,
+ )
+
+ with transaction.atomic():
+ # Lock both devices in pk order to avoid cross-merge deadlocks.
+ ordered = sorted({donor.pk, winner.pk})
+ list(Device.objects.select_for_update().filter(pk__in=ordered).order_by("pk"))
+ interface.device = winner
+ interface.save()
+
+ return _hx_response(
+ request,
+ f"Moved interface '{interface.name}' to {winner.name}.",
+ )
+
+ def _fail(self, request, msg, *, status=400):
+ if request.headers.get("HX-Request"):
+ return JsonResponse({"error": msg}, status=status)
+ messages.error(request, msg)
+ return redirect(request.META.get("HTTP_REFERER") or "/")
+
+
+class MoveIPAddressToWinnerView(_BaseMoveToWinnerView):
+ """
+ Reassign ``IPAddress.assigned_object`` from a donor-owned target to
+ the winner's equivalent.
+
+ Behaviour by current assignment:
+
+ * Assigned to a donor :class:`Interface` whose name exists on the
+ winner β reassign to the winner's same-name interface.
+ * Assigned to a donor :class:`Interface` whose name does *not* exist
+ on the winner β fail (user must move the interface first).
+ * Unassigned IP picked from the donor's sync page β fail (no donor
+ relationship to migrate).
+ """
+
+ required_object_permissions = {"POST": [("change", IPAddress)]}
+
+ def post(self, request, pk):
+ gate = self._gate(request)
+ if gate is not None:
+ return gate
+
+ ip = get_object_or_404(IPAddress, pk=pk)
+ assigned = ip.assigned_object
+ if not isinstance(assigned, Interface):
+ return self._fail(
+ request,
+ "IP is not assigned to a donor interface; nothing to migrate.",
+ status=409,
+ )
+ donor = assigned.device
+ if donor is None:
+ return self._fail(request, "IP's interface has no device.", status=409)
+
+ server_key = _server_key_from_request(request)
+ winner, marker = _resolve_winner_for_donor(donor, server_key)
+ if marker is None:
+ return self._fail(request, "Donor device is not marked as migrated.", status=409)
+ if winner is None:
+ return self._fail(request, "Winner device no longer exists.", status=410)
+
+ winner_iface = Interface.objects.filter(device=winner, name=assigned.name).first()
+ if winner_iface is None:
+ return self._fail(
+ request,
+ f"Winner '{winner.name}' has no interface named '{assigned.name}'. "
+ "Move the interface first, then retry.",
+ status=409,
+ )
+
+ with transaction.atomic():
+ ordered = sorted({donor.pk, winner.pk})
+ list(Device.objects.select_for_update().filter(pk__in=ordered).order_by("pk"))
+ ip.assigned_object = winner_iface
+ ip.save()
+
+ return _hx_response(
+ request,
+ f"Moved IP {ip.address} to {winner.name} interface '{winner_iface.name}'.",
+ )
+
+ def _fail(self, request, msg, *, status=400):
+ if request.headers.get("HX-Request"):
+ return JsonResponse({"error": msg}, status=status)
+ messages.error(request, msg)
+ return redirect(request.META.get("HTTP_REFERER") or "/")
+
+
+class TransferDeviceIPView(_BaseMoveToWinnerView):
+ """
+ One-shot transfer of a donor's primary IPv4/v6 or OOB IP to the
+ winner.
+
+ Triggered with URL kwarg ``ip_kind`` β ``{"primary4", "primary6",
+ "oob"}``. Refuses to overwrite a value already set on the winner β
+ the user must clear it on the winner first.
+
+ The IPAddress object itself is *not* moved off its current
+ ``assigned_object`` (an interface) β only the ``Device.primary_ip4``
+ / ``primary_ip6`` / ``oob_ip`` foreign key on the winner is set, and
+ the donor's foreign key is cleared.
+ """
+
+ required_object_permissions = {"POST": [("change", Device)]}
+
+ _FIELD_MAP = {
+ "primary4": ("primary_ip4", "primary IPv4"),
+ "primary6": ("primary_ip6", "primary IPv6"),
+ "oob": ("oob_ip", "OOB IP"),
+ }
+
+ def post(self, request, pk, ip_kind):
+ gate = self._gate(request)
+ if gate is not None:
+ return gate
+
+ if ip_kind not in self._FIELD_MAP:
+ return self._fail(request, f"Unknown ip_kind '{ip_kind}'.")
+ field, human = self._FIELD_MAP[ip_kind]
+
+ donor = get_object_or_404(Device, pk=pk)
+ server_key = _server_key_from_request(request)
+ winner, marker = _resolve_winner_for_donor(donor, server_key)
+ if marker is None:
+ return self._fail(request, "Donor device is not marked as migrated.", status=409)
+ if winner is None:
+ return self._fail(request, "Winner device no longer exists.", status=410)
+
+ donor_ip = getattr(donor, field, None)
+ if donor_ip is None:
+ return self._fail(request, f"Donor has no {human} to transfer.", status=409)
+ if getattr(winner, field, None) is not None:
+ return self._fail(
+ request,
+ f"Winner '{winner.name}' already has a {human}. Clear it on the winner first.",
+ status=409,
+ )
+
+ with transaction.atomic():
+ ordered = sorted({donor.pk, winner.pk})
+ list(Device.objects.select_for_update().filter(pk__in=ordered).order_by("pk"))
+ setattr(winner, field, donor_ip)
+ setattr(donor, field, None)
+ # Save only the touched FK column to avoid full_clean() rejecting
+ # the merge over pre-existing inconsistencies on either device
+ # (e.g. ``face`` set without ``rack``).
+ winner.save(update_fields=[field])
+ donor.save(update_fields=[field])
+
+ return _hx_response(
+ request,
+ f"Transferred {human} ({donor_ip}) to {winner.name}.",
+ )
+
+ def _fail(self, request, msg, *, status=400):
+ if request.headers.get("HX-Request"):
+ return JsonResponse({"error": msg}, status=status)
+ messages.error(request, msg)
+ return redirect(request.META.get("HTTP_REFERER") or "/")
diff --git a/netbox_librenms_plugin/views/sync/modules.py b/netbox_librenms_plugin/views/sync/modules.py
new file mode 100644
index 0000000000..342b1b160c
--- /dev/null
+++ b/netbox_librenms_plugin/views/sync/modules.py
@@ -0,0 +1,1440 @@
+"""Sync action views for module/inventory installation from LibreNMS."""
+
+import re
+
+from django.contrib import messages
+from django.core.cache import cache
+from django.core.exceptions import ValidationError
+from django.db import IntegrityError, models, transaction
+from django.http import HttpResponse
+from django.shortcuts import get_object_or_404, redirect, render
+from django.urls import reverse
+from django.views import View
+
+from netbox_librenms_plugin.utils import get_librenms_sync_device, get_module_types_indexed
+from netbox_librenms_plugin.views.base.modules_view import _PLACEHOLDER_VALUES
+from netbox_librenms_plugin.views.mixins import (
+ CacheMixin,
+ LibreNMSAPIMixin,
+ LibreNMSPermissionMixin,
+ NetBoxObjectPermissionMixin,
+)
+
+
+def _modules_redirect_response(request, sync_url):
+ """Return a redirect response that works for both classic and HTMX form posts.
+
+ For HTMX requests (those carrying ``HX-Request: true``) we return an empty
+ 200 response with an ``HX-Redirect`` header so the browser performs a full
+ navigation that picks up Django messages and refreshes the modules table.
+ For non-HTMX requests we return a normal Django redirect.
+ """
+ target = f"{sync_url}?tab=modules#librenms-module-table"
+ if request.headers.get("HX-Request") == "true":
+ response = HttpResponse(status=204)
+ response["HX-Redirect"] = target
+ return response
+ return redirect(target)
+
+
+def _extract_inventory_list(cached_payload):
+ """Extract the inventory row list from a cached payload.
+
+ The cache stores ``{"inventory": [...], "librenms_id": ...}``; anything
+ else is treated as a cache miss to match BaseModuleTableView.get_context_data.
+ """
+ if isinstance(cached_payload, dict):
+ return cached_payload.get("inventory") or []
+ return []
+
+
+def _report_install_results(request, installed, skipped, failed):
+ """Emit Django messages summarising an install run."""
+ if installed:
+ messages.success(request, f"Installed {len(installed)} module(s): {', '.join(installed)}")
+ if skipped:
+ messages.info(request, f"Skipped {len(skipped)}: {'; '.join(skipped)}")
+ if failed:
+ messages.warning(request, f"Failed {len(failed)}: {'; '.join(failed)}")
+
+
+def _resolve_target_device(page_device, selected_device_id):
+ """Resolve and validate a target device from row-level VC selection."""
+ if not selected_device_id:
+ return page_device
+
+ try:
+ selected_device_id = int(selected_device_id)
+ except (TypeError, ValueError):
+ return page_device
+
+ if not getattr(page_device, "virtual_chassis", None):
+ return page_device
+
+ member = page_device.virtual_chassis.members.filter(pk=selected_device_id).first()
+ return member or page_device
+
+
+class _SerialConflictAmbiguous(Exception):
+ """Raised inside ReplaceModuleView's transaction when more than one module
+ holds the incoming serial β used to abort the atomic block and surface a
+ user-friendly error after the rollback."""
+
+ def __init__(self, serial):
+ super().__init__(serial)
+ self.serial = serial
+
+
+def _get_sync_device_for_inventory(device, server_key):
+ """Return the VC sync device used for module inventory cache keys."""
+ return get_librenms_sync_device(device, server_key=server_key) or device
+
+
+class InstallModuleView(LibreNMSPermissionMixin, NetBoxObjectPermissionMixin, CacheMixin, View):
+ """Install a NetBox Module into a ModuleBay from LibreNMS inventory data."""
+
+ def post(self, request, pk):
+ from dcim.models import Device, Module, ModuleBay, ModuleType
+
+ self.required_object_permissions = {"POST": [("add", Module)]}
+ if error := self.require_all_permissions("POST"):
+ return error
+
+ page_device = get_object_or_404(Device, pk=pk)
+ target_device = _resolve_target_device(page_device, request.POST.get("selected_device_id"))
+ serial = request.POST.get("serial", "").strip()
+ if serial.lower() in _PLACEHOLDER_VALUES:
+ serial = ""
+ sync_url = reverse("plugins:netbox_librenms_plugin:device_librenms_sync", kwargs={"pk": pk})
+
+ try:
+ module_bay_id = int(request.POST.get("module_bay_id"))
+ module_type_id = int(request.POST.get("module_type_id"))
+ except (TypeError, ValueError):
+ messages.error(request, "Missing or invalid module bay/module type ID.")
+ return redirect(f"{sync_url}?tab=modules#librenms-module-table")
+
+ get_object_or_404(ModuleBay, pk=module_bay_id, device=target_device) # verify bay belongs to selected device
+ module_type = get_object_or_404(ModuleType, pk=module_type_id)
+
+ try:
+ with transaction.atomic():
+ # Re-fetch bay under lock to prevent TOCTOU race with concurrent installs.
+ locked_bay = ModuleBay.objects.select_for_update().get(pk=module_bay_id)
+ if hasattr(locked_bay, "installed_module") and locked_bay.installed_module:
+ messages.warning(request, f"Module bay '{locked_bay.name}' already has a module installed.")
+ return redirect(f"{sync_url}?tab=modules#librenms-module-table")
+ module = Module(
+ device=target_device,
+ module_bay=locked_bay,
+ module_type=module_type,
+ serial=serial,
+ status="active",
+ )
+ module.full_clean()
+ module.save()
+
+ messages.success(
+ request, f"Installed {module_type.model} in {locked_bay.name} (serial: {serial or 'N/A'})."
+ )
+ except (ValidationError, IntegrityError) as e:
+ messages.error(request, f"Failed to install module: {e}")
+
+ return redirect(f"{sync_url}?tab=modules#librenms-module-table")
+
+
+class InstallBranchView(LibreNMSPermissionMixin, NetBoxObjectPermissionMixin, LibreNMSAPIMixin, CacheMixin, View):
+ """Install a module and all its installable descendants from LibreNMS inventory."""
+
+ def post(self, request, pk):
+ from dcim.models import Device, Module, ModuleBay, ModuleType
+
+ self.required_object_permissions = {"POST": [("add", Module)]}
+ if error := self.require_all_permissions("POST"):
+ return error
+
+ page_device = get_object_or_404(Device, pk=pk)
+ target_device = _resolve_target_device(page_device, request.POST.get("selected_device_id"))
+ parent_index = request.POST.get("parent_index")
+ server_key = request.POST.get("server_key") or self.librenms_api.server_key
+ sync_url = reverse("plugins:netbox_librenms_plugin:device_librenms_sync", kwargs={"pk": pk})
+
+ if not parent_index:
+ messages.error(request, "Missing parent inventory index.")
+ return redirect(f"{sync_url}?tab=modules#librenms-module-table")
+
+ try:
+ parent_index = int(parent_index)
+ except ValueError:
+ messages.error(request, "Invalid parent inventory index.")
+ return redirect(f"{sync_url}?tab=modules#librenms-module-table")
+
+ # Get cached inventory data
+ sync_device = _get_sync_device_for_inventory(target_device, server_key)
+ cached_payload = cache.get(self.get_cache_key(sync_device, "inventory", server_key=server_key))
+ cached_data = _extract_inventory_list(cached_payload)
+ if not cached_data:
+ messages.error(request, "No cached inventory data. Please refresh modules first.")
+ return redirect(f"{sync_url}?tab=modules#librenms-module-table")
+
+ # Load ignore rules so the branch respects the same filters shown in the table
+ from netbox_librenms_plugin.utils import get_enabled_ignore_rules
+
+ ignore_rules = get_enabled_ignore_rules()
+ device_serial = (getattr(target_device, "serial", None) or "").strip()
+
+ # Build index map and collect the branch to install
+ index_map = {idx: item for item in cached_data if (idx := item.get("entPhysicalIndex")) is not None}
+ branch_items = self._collect_branch(parent_index, cached_data, ignore_rules, device_serial, index_map)
+
+ if not branch_items:
+ messages.warning(request, "No installable items found in this branch.")
+ return redirect(f"{sync_url}?tab=modules#librenms-module-table")
+
+ # Load module types (with mappings)
+ module_types = get_module_types_indexed()
+
+ # Preload all ModuleBayMappings once to avoid N+1 per-item queries.
+ # Filter by device manufacturer so vendor-scoped mappings only apply to
+ # matching vendors and mismatched ones are skipped.
+ from netbox_librenms_plugin.utils import load_bay_mappings
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ exact_mappings, regex_mappings = load_bay_mappings()
+ mfr_id = getattr(getattr(target_device, "device_type", None), "manufacturer_id", None)
+ exact_mappings = BaseModuleTableView._filter_mappings_by_manufacturer(exact_mappings, mfr_id)
+ regex_mappings = BaseModuleTableView._filter_mappings_by_manufacturer(regex_mappings, mfr_id)
+
+ # Install top-down: each install may create new child bays
+ installed = []
+ skipped = []
+ failed = []
+
+ try:
+ with transaction.atomic():
+ for item in branch_items:
+ result = self._install_single(
+ target_device,
+ item,
+ index_map,
+ module_types,
+ ModuleBay,
+ ModuleType,
+ Module,
+ exact_mappings=exact_mappings,
+ regex_mappings=regex_mappings,
+ )
+ if result["status"] == "installed":
+ installed.append(result["name"])
+ elif result["status"] == "skipped":
+ skipped.append(f"{result['name']}: {result['reason']}")
+ else:
+ failed.append(f"{result['name']}: {result['reason']}")
+ except (ValidationError, IntegrityError) as e:
+ messages.error(request, f"Branch install failed: {e}")
+ return redirect(f"{sync_url}?tab=modules#librenms-module-table")
+
+ _report_install_results(request, installed, skipped, failed)
+ return redirect(f"{sync_url}?tab=modules#librenms-module-table")
+
+ def _collect_branch(self, parent_index, inventory_data, ignore_rules=None, device_serial="", index_map=None):
+ """
+ Collect all items in a branch depth-first, parent first.
+
+ Returns items in install order (parent before children).
+ Optionally filters items matching 'skip' ignore rules; 'transparent' items
+ are excluded from installation but their children are still collected.
+ """
+ items = []
+ parent = next((i for i in inventory_data if i.get("entPhysicalIndex") == parent_index), None)
+ if parent:
+ if ignore_rules:
+ from netbox_librenms_plugin.views.base.modules_view import _check_ignore_rules
+
+ ancestor = index_map.get(parent.get("entPhysicalContainedIn")) if index_map else None
+ action = _check_ignore_rules(parent, ancestor, ignore_rules, index_map, device_serial)
+ if action == "skip":
+ return []
+ if action == "transparent":
+ self._collect_children(
+ parent_index,
+ inventory_data,
+ items,
+ visited={parent_index},
+ ignore_rules=ignore_rules,
+ device_serial=device_serial,
+ index_map=index_map,
+ )
+ return items
+ model = (parent.get("entPhysicalModelName") or "").strip()
+ if model:
+ items.append(parent)
+ self._collect_children(
+ parent_index,
+ inventory_data,
+ items,
+ visited={parent_index},
+ ignore_rules=ignore_rules,
+ device_serial=device_serial,
+ index_map=index_map,
+ )
+ return items
+
+ def _collect_children(
+ self, parent_idx, inventory_data, items, visited=None, ignore_rules=None, device_serial="", index_map=None
+ ):
+ """Recursively collect children with models, depth-first.
+
+ When ignore_rules are provided, items matching a 'skip' rule (and their
+ subtree) are excluded. Items matching 'transparent' are not installed but
+ their children are still collected at the same depth.
+ """
+ if visited is None:
+ visited = set()
+ children = [i for i in inventory_data if i.get("entPhysicalContainedIn") == parent_idx]
+ for child in children:
+ child_idx = child.get("entPhysicalIndex")
+ if child_idx is None:
+ continue
+ if child_idx in visited:
+ continue
+ visited.add(child_idx)
+ # Apply ignore rules when provided
+ if ignore_rules:
+ from netbox_librenms_plugin.views.base.modules_view import _check_ignore_rules
+
+ parent_item = index_map.get(child.get("entPhysicalContainedIn")) if index_map else None
+ action = _check_ignore_rules(child, parent_item, ignore_rules, index_map, device_serial)
+ if action == "skip":
+ continue
+ if action == "transparent":
+ # Don't install this item but still collect its children
+ self._collect_children(
+ child_idx, inventory_data, items, visited, ignore_rules, device_serial, index_map
+ )
+ continue
+ model = (child.get("entPhysicalModelName") or "").strip()
+ if model:
+ items.append(child)
+ # Always recurse to find deeper items (containers may lack models)
+ self._collect_children(child_idx, inventory_data, items, visited, ignore_rules, device_serial, index_map)
+
+ @staticmethod
+ def _install_single(
+ device,
+ item,
+ index_map,
+ module_types,
+ ModuleBay,
+ ModuleType,
+ Module,
+ exact_mappings=None,
+ regex_mappings=None,
+ ):
+ """
+ Try to install a single inventory item.
+
+ Re-fetches module bays each time since parent installs create new ones.
+ Scopes bay lookup to the correct parent module to handle duplicate bay names.
+ """
+ from netbox_librenms_plugin.utils import resolve_module_type
+
+ model_name = (item.get("entPhysicalModelName") or "").strip()
+ serial = (item.get("entPhysicalSerialNum") or "").strip()
+ if serial.lower() in _PLACEHOLDER_VALUES:
+ serial = ""
+ name = item.get("entPhysicalName", "") or model_name
+
+ # Match module type (direct, then normalization fallback)
+ manufacturer = getattr(getattr(device, "device_type", None), "manufacturer", None)
+ matched_type = resolve_module_type(model_name, module_types, manufacturer=manufacturer)
+ if not matched_type:
+ return {"status": "skipped", "name": name, "reason": "no matching type"}
+
+ # Re-fetch module bays (parent install creates new child bays)
+ bays = ModuleBay.objects.filter(device=device).select_related("installed_module__module_type")
+
+ # Use preloaded mappings if provided, otherwise load from DB
+ if exact_mappings is None or regex_mappings is None:
+ from netbox_librenms_plugin.utils import load_bay_mappings
+
+ exact_mappings, regex_mappings = load_bay_mappings()
+
+ # Determine if this item belongs under an installed module
+ # by tracing its LibreNMS parent hierarchy to an installed item
+ parent_module_id = InstallBranchView._find_parent_module_id(
+ item, index_map, bays, exact_mappings, regex_mappings
+ )
+
+ if parent_module_id:
+ bay_dict = {bay.name: bay for bay in bays if bay.module_id == parent_module_id}
+ else:
+ bay_dict = {bay.name: bay for bay in bays if not bay.module_id}
+
+ # Match module bay using preloaded mapping data
+ matched_bay = InstallBranchView._match_bay(item, index_map, bay_dict, exact_mappings, regex_mappings)
+ if not matched_bay:
+ return {"status": "skipped", "name": name, "reason": "no matching bay"}
+
+ # Install (lock bay to prevent concurrent installs)
+ try:
+ with transaction.atomic(): # savepoint: failure here won't abort parent tx
+ locked_bay = (
+ ModuleBay.objects.select_for_update(of=("self",))
+ .select_related("installed_module")
+ .get(pk=matched_bay.pk)
+ )
+ if hasattr(locked_bay, "installed_module") and locked_bay.installed_module:
+ return {"status": "skipped", "name": name, "reason": "bay already occupied"}
+
+ module = Module(
+ device=device,
+ module_bay=locked_bay,
+ module_type=matched_type,
+ serial=serial,
+ status="active",
+ )
+ module.full_clean()
+ module.save()
+ except (ValidationError, IntegrityError) as e:
+ error_msg = str(e)
+ if "dcim_interface_unique_device_name" in error_msg:
+ error_msg = (
+ "duplicate interface name β this module type's interface template "
+ "uses the '{module}' token which resolves to the same name for all siblings. "
+ "An interface naming plugin with a rewrite rule for this module type can fix this."
+ )
+ return {"status": "failed", "name": name, "reason": error_msg}
+
+ return {"status": "installed", "name": f"{matched_type.model} β {matched_bay.name}"}
+
+ @staticmethod
+ def _find_parent_module_id(item, index_map, device_bays, exact_mappings, regex_mappings):
+ """
+ Find the NetBox module ID for the installed parent of this inventory item.
+
+ Walks up the LibreNMS hierarchy to find an ancestor whose name matches
+ an installed module bay on the device.
+
+ Args:
+ item: The inventory item dict.
+ index_map: Dict mapping entPhysicalIndex to inventory item.
+ device_bays: Pre-fetched queryset/list of ModuleBay objects for the device.
+ exact_mappings: Pre-filtered list of exact ModuleBayMapping objects.
+ regex_mappings: Pre-filtered list of regex ModuleBayMapping objects.
+ """
+ current = item
+ # Build bay name β list of bays for duplicate-name disambiguation
+ bay_by_name: dict = {}
+ for bay in device_bays:
+ bay_by_name.setdefault(bay.name, []).append(bay)
+
+ # Build exact_mapping index: prefer class-specific over class-empty
+ exact_mapping_by_key: dict = {}
+ for m in exact_mappings:
+ key = (m.librenms_name, m.librenms_class)
+ if key not in exact_mapping_by_key:
+ exact_mapping_by_key[key] = m
+
+ visited = set()
+ while True:
+ parent_idx = current.get("entPhysicalContainedIn", 0)
+ if not parent_idx or parent_idx not in index_map:
+ return None
+ if parent_idx in visited:
+ return None
+ visited.add(parent_idx)
+ parent = index_map[parent_idx]
+ parent_name = parent.get("entPhysicalName", "")
+ parent_descr = parent.get("entPhysicalDescr", "")
+ parent_class = parent.get("entPhysicalClass", "")
+
+ # Check if this parent matches an installed module bay on the device
+ for bay in device_bays:
+ if hasattr(bay, "installed_module") and bay.installed_module:
+ if bay.name == parent_name or (parent_descr and bay.name == parent_descr):
+ return bay.installed_module.pk
+
+ # Also check ModuleBayMapping for indirect matches (exact then regex)
+ for name in [parent_name, parent_descr]:
+ if not name:
+ continue
+ # Exact-name mapping: prefer class-specific, fall back to class-empty
+ mapping = exact_mapping_by_key.get((name, parent_class))
+ if not mapping:
+ mapping = exact_mapping_by_key.get((name, ""))
+ if mapping:
+ candidates = bay_by_name.get(mapping.netbox_bay_name, [])
+ if len(candidates) == 1:
+ bay = candidates[0]
+ else:
+ occupied = [b for b in candidates if hasattr(b, "installed_module") and b.installed_module]
+ bay = occupied[0] if len(occupied) == 1 else None
+ if bay and hasattr(bay, "installed_module") and bay.installed_module:
+ return bay.installed_module.pk
+ # Regex mapping: class-specific first, then empty-class fallback
+ # (concatenate, don't use ``or``, so fallback is tried even when
+ # class-specific rules exist but none match β mirrors base view)
+ class_matches = [rm for rm in regex_mappings if rm.librenms_class == parent_class]
+ fallback_matches = [rm for rm in regex_mappings if rm.librenms_class == ""]
+ for rm in class_matches + fallback_matches:
+ compiled = rm._compiled_pattern
+ if compiled is None:
+ continue
+ try:
+ match = compiled.fullmatch(name)
+ except re.error:
+ continue
+ if not match:
+ continue
+ try:
+ bay_name = match.expand(rm.netbox_bay_name)
+ except (re.error, IndexError):
+ continue
+ candidates = bay_by_name.get(bay_name, [])
+ if len(candidates) == 1:
+ bay = candidates[0]
+ else:
+ occupied = [b for b in candidates if hasattr(b, "installed_module") and b.installed_module]
+ bay = occupied[0] if len(occupied) == 1 else None
+ if bay and hasattr(bay, "installed_module") and bay.installed_module:
+ return bay.installed_module.pk
+
+ current = parent
+
+ @staticmethod
+ def _match_bay(item, index_map, module_bays, exact_mappings, regex_mappings):
+ """Match an inventory item to a module bay (same logic as BaseModuleTableView)."""
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ # Resolve parent name by walking up the containment hierarchy
+ contained_in = item.get("entPhysicalContainedIn", 0)
+ parent_name = None
+ if contained_in:
+ visited_anc = set()
+ current_idx = contained_in
+ while current_idx and current_idx not in visited_anc:
+ visited_anc.add(current_idx)
+ ancestor = index_map.get(current_idx)
+ if not ancestor:
+ break
+ ancestor_name = ancestor.get("entPhysicalName", "")
+ if ancestor_name:
+ parent_name = ancestor_name
+ break
+ current_idx = ancestor.get("entPhysicalContainedIn", 0)
+
+ item_name = item.get("entPhysicalName", "")
+ item_descr = item.get("entPhysicalDescr", "")
+ phys_class = item.get("entPhysicalClass", "")
+
+ # Build candidate names: parent, item name, item description
+ candidate_names = [n for n in [parent_name, item_name, item_descr] if n]
+
+ # Check mapping for each candidate (exact match)
+ for name in candidate_names:
+ bay = BaseModuleTableView._lookup_exact_bay_mapping(name, phys_class, module_bays, exact_mappings)
+ if bay:
+ return bay
+
+ # Regex pattern matching using preloaded list
+ for name in candidate_names:
+ bay = BaseModuleTableView._lookup_regex_bay_mapping(name, phys_class, module_bays, regex_mappings)
+ if bay:
+ return bay
+
+ # Fallback: exact match on candidate names against bay dict
+ for name in candidate_names:
+ if name in module_bays:
+ return module_bays[name]
+
+ # Positional fallback for items inside converters
+ return BaseModuleTableView._match_bay_by_position(item, index_map, module_bays)
+
+
+class InstallSelectedView(LibreNMSPermissionMixin, NetBoxObjectPermissionMixin, LibreNMSAPIMixin, CacheMixin, View):
+ """
+ Install a user-selected set of inventory items by their entPhysicalIndex values.
+
+ Reuses InstallBranchView._install_single for each selected item so every item
+ goes through the same type/bay/serial resolution pipeline as a branch install.
+ Only items where a matching bay *and* module type are found will be installed;
+ items with no bay or no type are silently skipped (same behaviour as branch).
+ """
+
+ def post(self, request, pk):
+ from dcim.models import Device, Module, ModuleBay, ModuleType
+
+ self.required_object_permissions = {"POST": [("add", Module)]}
+ if error := self.require_all_permissions("POST"):
+ return error
+
+ page_device = get_object_or_404(Device, pk=pk)
+ server_key = request.POST.get("server_key") or self.librenms_api.server_key
+ sync_url = reverse("plugins:netbox_librenms_plugin:device_librenms_sync", kwargs={"pk": pk})
+
+ selected_indices = request.POST.getlist("select")
+ if not selected_indices:
+ messages.warning(request, "No modules selected.")
+ return redirect(f"{sync_url}?tab=modules#librenms-module-table")
+
+ sync_device = _get_sync_device_for_inventory(page_device, server_key)
+ cached_payload = cache.get(self.get_cache_key(sync_device, "inventory", server_key=server_key))
+ cached_data = _extract_inventory_list(cached_payload)
+ if not cached_data:
+ messages.error(request, "No cached inventory data. Please refresh modules first.")
+ return redirect(f"{sync_url}?tab=modules#librenms-module-table")
+
+ try:
+ # Use dict.fromkeys to preserve order while deduplicating
+ selected_list = list(dict.fromkeys(int(i) for i in selected_indices))
+ except ValueError:
+ messages.error(request, "Invalid selection.")
+ return redirect(f"{sync_url}?tab=modules#librenms-module-table")
+
+ index_map = {idx: item for item in cached_data if (idx := item.get("entPhysicalIndex")) is not None}
+ items = [index_map[idx] for idx in selected_list if idx in index_map]
+
+ if not items:
+ messages.warning(request, "None of the selected indices matched cached inventory.")
+ return redirect(f"{sync_url}?tab=modules#librenms-module-table")
+
+ # Load ignore rules once; they're evaluated per-row inside the install
+ # loop using the *resolved* target device serial, since VC rows may
+ # switch to a different member via device_selection_
.
+ from netbox_librenms_plugin.utils import get_enabled_ignore_rules
+ from netbox_librenms_plugin.views.base.modules_view import _check_ignore_rules
+
+ ignore_rules = get_enabled_ignore_rules()
+
+ # Preload all ModuleBayMappings once to avoid N+1 per-item queries.
+ # Manufacturer-scoping happens per-iteration since target_device may
+ # differ across rows (VC members can have different device types).
+ from netbox_librenms_plugin.utils import load_bay_mappings
+ from netbox_librenms_plugin.views.base.modules_view import BaseModuleTableView
+
+ module_types = get_module_types_indexed()
+ all_exact, all_regex = load_bay_mappings()
+
+ installed, skipped, failed = [], [], []
+
+ try:
+ with transaction.atomic():
+ for item in items:
+ ent_index = item.get("entPhysicalIndex")
+ selected_device_id = request.POST.get(f"device_selection_{ent_index}")
+ target_device = _resolve_target_device(page_device, selected_device_id)
+ if ignore_rules:
+ target_serial = (getattr(target_device, "serial", None) or "").strip()
+ rule_action = _check_ignore_rules(
+ item,
+ index_map.get(item.get("entPhysicalContainedIn")),
+ ignore_rules,
+ index_map,
+ target_serial,
+ )
+ if rule_action in {"skip", "transparent"}:
+ skipped.append(f"{item.get('entPhysicalName', '?')}: matched ignore rule")
+ continue
+ mfr_id = getattr(getattr(target_device, "device_type", None), "manufacturer_id", None)
+ exact_mappings = BaseModuleTableView._filter_mappings_by_manufacturer(all_exact, mfr_id)
+ regex_mappings = BaseModuleTableView._filter_mappings_by_manufacturer(all_regex, mfr_id)
+ result = InstallBranchView._install_single(
+ target_device,
+ item,
+ index_map,
+ module_types,
+ ModuleBay,
+ ModuleType,
+ Module,
+ exact_mappings=exact_mappings,
+ regex_mappings=regex_mappings,
+ )
+ if result["status"] == "installed":
+ installed.append(result["name"])
+ elif result["status"] == "skipped":
+ skipped.append(f"{result['name']}: {result['reason']}")
+ else:
+ failed.append(f"{result['name']}: {result['reason']}")
+ except (ValidationError, IntegrityError) as e:
+ messages.error(request, f"Install failed: {e}")
+ return _modules_redirect_response(request, sync_url)
+
+ _report_install_results(request, installed, skipped, failed)
+ return _modules_redirect_response(request, sync_url)
+
+
+class UpdateModuleSerialView(LibreNMSPermissionMixin, NetBoxObjectPermissionMixin, View):
+ """Update the serial number of an already-installed module from LibreNMS inventory data."""
+
+ def post(self, request, pk):
+ from dcim.models import Device, Module
+
+ self.required_object_permissions = {"POST": [("change", Module)]}
+ if error := self.require_all_permissions("POST"):
+ return error
+
+ page_device = get_object_or_404(Device, pk=pk)
+ target_device = _resolve_target_device(page_device, request.POST.get("selected_device_id"))
+ serial = request.POST.get("serial", "").strip()
+ if serial.lower() in _PLACEHOLDER_VALUES:
+ serial = ""
+ sync_url = reverse("plugins:netbox_librenms_plugin:device_librenms_sync", kwargs={"pk": pk})
+
+ try:
+ module_id = int(request.POST.get("module_id"))
+ except (TypeError, ValueError):
+ messages.error(request, "Missing or invalid module ID.")
+ return _modules_redirect_response(request, sync_url)
+
+ try:
+ with transaction.atomic():
+ module = (
+ Module.objects.select_for_update()
+ .select_related("module_type", "module_bay")
+ .filter(pk=module_id, device=target_device)
+ .first()
+ )
+ if not module:
+ messages.error(request, "Module no longer exists.")
+ return _modules_redirect_response(request, sync_url)
+ module.serial = serial
+ module.full_clean()
+ module.save()
+ messages.success(
+ request,
+ f"Updated serial for {module.module_type.model} in {module.module_bay.name} to '{serial}'.",
+ )
+ except (ValidationError, IntegrityError) as e:
+ messages.error(request, f"Failed to update serial: {e}")
+
+ return _modules_redirect_response(request, sync_url)
+
+
+class ModuleMismatchPreviewView(
+ LibreNMSPermissionMixin, NetBoxObjectPermissionMixin, LibreNMSAPIMixin, CacheMixin, View
+):
+ """
+ Return the modal body HTML fragment for the module replace/move dialog.
+
+ Loads the installed module and the corresponding LibreNMS inventory item from
+ cache, detects type/serial mismatch and serial conflicts, then renders the
+ comparison template so the user can choose between Replace, Move, or
+ Update Serial Only.
+ """
+
+ def get(self, request, pk):
+ from dcim.models import Device, Module
+
+ self.required_object_permissions = {"GET": [("view", Device), ("view", Module)]}
+ if error := self.require_object_permissions("GET"):
+ return error
+
+ page_device = get_object_or_404(Device, pk=pk)
+ target_device = _resolve_target_device(page_device, request.GET.get("selected_device_id"))
+ server_key = request.GET.get("server_key") or self.librenms_api.server_key
+
+ try:
+ module_id = int(request.GET.get("module_id"))
+ ent_index_int = int(request.GET.get("ent_index"))
+ except (TypeError, ValueError):
+ return HttpResponse("Missing or invalid module_id/ent_index.", status=400)
+
+ installed_module = get_object_or_404(
+ Module.objects.select_related("module_type", "module_bay", "device"),
+ pk=module_id,
+ device=target_device,
+ )
+
+ sync_device = _get_sync_device_for_inventory(target_device, server_key)
+ cached_payload = cache.get(self.get_cache_key(sync_device, "inventory", server_key=server_key))
+ cached_data = _extract_inventory_list(cached_payload)
+ if not cached_data:
+ return HttpResponse("No cached inventory data. Please refresh modules first.", status=400)
+
+ librenms_item = next(
+ (item for item in cached_data if item.get("entPhysicalIndex") == ent_index_int),
+ None,
+ )
+ if not librenms_item:
+ return HttpResponse("Inventory item not found in cache.", status=400)
+
+ librenms_model = (librenms_item.get("entPhysicalModelName") or "").strip() or "-"
+ librenms_serial = (librenms_item.get("entPhysicalSerialNum") or "").strip()
+ if librenms_serial.lower() in _PLACEHOLDER_VALUES:
+ librenms_serial = ""
+
+ # Detect type mismatch
+ from netbox_librenms_plugin.utils import resolve_module_type
+
+ module_types = get_module_types_indexed()
+ manufacturer = getattr(getattr(target_device, "device_type", None), "manufacturer", None)
+ matched_type = resolve_module_type(
+ librenms_model if librenms_model != "-" else "", module_types, manufacturer=manufacturer
+ )
+
+ type_mismatch = matched_type is not None and installed_module.module_type_id != matched_type.pk
+ installed_serial = (installed_module.serial or "").strip()
+ if installed_serial.lower() in _PLACEHOLDER_VALUES:
+ installed_serial = ""
+ serial_mismatch = bool(
+ not type_mismatch and librenms_serial != installed_serial and (librenms_serial or installed_serial)
+ )
+
+ # Check whether the LibreNMS serial already exists at a different location
+ serial_conflict = None
+ serial_conflict_ambiguous = False
+ if librenms_serial:
+ conflict_qs = (
+ Module.objects.filter(serial=librenms_serial)
+ .exclude(pk=installed_module.pk)
+ .select_related("module_type", "module_bay", "device")
+ )
+ conflict_count = conflict_qs.count()
+ if conflict_count == 1:
+ serial_conflict = conflict_qs.first()
+ elif conflict_count > 1:
+ serial_conflict_ambiguous = True
+
+ return render(
+ request,
+ "netbox_librenms_plugin/htmx/module_mismatch_modal.html",
+ {
+ "device_pk": pk,
+ "installed_module": installed_module,
+ "bay_name": installed_module.module_bay.name,
+ "target_bay_id": installed_module.module_bay_id,
+ "installed_serial": installed_serial,
+ "librenms_model": librenms_model,
+ "librenms_serial": librenms_serial,
+ "type_mismatch": type_mismatch,
+ "serial_mismatch": serial_mismatch,
+ "serial_conflict": serial_conflict,
+ "serial_conflict_ambiguous": serial_conflict_ambiguous,
+ "ent_index": ent_index_int,
+ "server_key": server_key or "",
+ "selected_device_id": target_device.pk,
+ },
+ )
+
+
+class ReplaceModuleView(LibreNMSPermissionMixin, LibreNMSAPIMixin, NetBoxObjectPermissionMixin, CacheMixin, View):
+ """
+ Replace the installed module in a bay with fresh data from LibreNMS inventory.
+
+ Deletes the currently installed module (and optionally removes a conflicting
+ module with the same serial from another location), then installs a new module
+ from cached LibreNMS inventory data.
+ """
+
+ def post(self, request, pk):
+ from dcim.models import Device, Module, ModuleBay, ModuleType # noqa: F401
+
+ self.required_object_permissions = {"POST": [("add", Module), ("change", Module), ("delete", Module)]}
+ if error := self.require_all_permissions("POST"):
+ return error
+
+ page_device = get_object_or_404(Device, pk=pk)
+ target_device = _resolve_target_device(page_device, request.POST.get("selected_device_id"))
+ server_key = request.POST.get("server_key") or self.librenms_api.server_key
+ sync_url = reverse("plugins:netbox_librenms_plugin:device_librenms_sync", kwargs={"pk": pk})
+
+ try:
+ module_id = int(request.POST.get("module_id"))
+ ent_index_int = int(request.POST.get("ent_index"))
+ except (TypeError, ValueError):
+ messages.error(request, "Missing or invalid module_id/ent_index.")
+ return _modules_redirect_response(request, sync_url)
+
+ installed_module = get_object_or_404(
+ Module.objects.select_related("module_type", "module_bay"),
+ pk=module_id,
+ device=target_device,
+ )
+
+ sync_device = _get_sync_device_for_inventory(target_device, server_key)
+ cached_payload = cache.get(self.get_cache_key(sync_device, "inventory", server_key=server_key))
+ cached_data = _extract_inventory_list(cached_payload)
+ if not cached_data:
+ messages.error(request, "No cached inventory data. Please refresh modules first.")
+ return _modules_redirect_response(request, sync_url)
+
+ librenms_item = next(
+ (item for item in cached_data if item.get("entPhysicalIndex") == ent_index_int),
+ None,
+ )
+ if not librenms_item:
+ messages.error(request, "Inventory item not found in cache.")
+ return _modules_redirect_response(request, sync_url)
+
+ model_name = (librenms_item.get("entPhysicalModelName") or "").strip()
+ serial = (librenms_item.get("entPhysicalSerialNum") or "").strip()
+ if serial.lower() in _PLACEHOLDER_VALUES:
+ serial = ""
+
+ module_types = get_module_types_indexed()
+ from netbox_librenms_plugin.utils import resolve_module_type
+
+ manufacturer = getattr(getattr(target_device, "device_type", None), "manufacturer", None)
+ matched_type = resolve_module_type(model_name, module_types, manufacturer=manufacturer)
+
+ if not matched_type:
+ messages.error(request, f"No matching module type found for '{model_name}'.")
+ return _modules_redirect_response(request, sync_url)
+
+ try:
+ conflict_removed_msg = None
+ with transaction.atomic():
+ # Re-fetch with row lock to prevent concurrent modifications
+ installed_module = (
+ Module.objects.select_for_update()
+ .filter(pk=module_id, device=target_device)
+ .select_related("module_type", "module_bay")
+ .first()
+ )
+ if not installed_module:
+ messages.error(request, "Module no longer exists.")
+ return _modules_redirect_response(request, sync_url)
+
+ # Read bay/type from locked row to avoid stale snapshot
+ target_bay = installed_module.module_bay
+ old_type_name = installed_module.module_type.model
+ old_bay_name = target_bay.name
+
+ # Re-derive any serial conflict from the database INSIDE the locked
+ # transaction (and lock those rows too) β checking before the lock
+ # opens a TOCTOU window where a concurrent request could change a
+ # module's serial and we'd then delete a row that no longer
+ # conflicts. Re-querying under select_for_update() guarantees the
+ # set we delete from is the same set we validated.
+ conflict_module = None
+ if serial:
+ conflict_qs = (
+ Module.objects.select_for_update()
+ .filter(serial=serial)
+ .exclude(pk=installed_module.pk)
+ .select_related("module_type", "module_bay", "device")
+ )
+ locked_conflicts = list(conflict_qs)
+ if len(locked_conflicts) > 1:
+ # Roll back and surface a clear error β we don't want to
+ # guess which of N conflicts to remove.
+ raise _SerialConflictAmbiguous(serial)
+ if len(locked_conflicts) == 1:
+ conflict_module = locked_conflicts[0]
+
+ # Remove the serial-conflicting module from its current location.
+ if conflict_module:
+ c_model = conflict_module.module_type.model
+ c_bay = conflict_module.module_bay.name
+ c_device = conflict_module.device.name
+ conflict_module.delete()
+ conflict_removed_msg = f"Removed {c_model} from {c_device}/{c_bay}."
+
+ # Delete the currently installed module in the target bay
+ installed_module.delete()
+
+ # Install fresh module from LibreNMS data
+ new_module = Module(
+ device=target_device,
+ module_bay=target_bay,
+ module_type=matched_type,
+ serial=serial,
+ status="active",
+ )
+ new_module.full_clean()
+ new_module.save()
+
+ if conflict_removed_msg:
+ messages.info(request, conflict_removed_msg)
+ messages.success(
+ request,
+ f"Replaced {old_type_name} with {matched_type.model} in {old_bay_name}"
+ + (f" (serial: {serial})" if serial else "")
+ + ".",
+ )
+ except _SerialConflictAmbiguous as exc:
+ messages.error(
+ request,
+ f"Serial '{exc.serial}' is assigned to multiple modules; cannot determine which to remove. "
+ "Please resolve the conflict manually.",
+ )
+ except (ValidationError, IntegrityError) as e:
+ messages.error(request, f"Replace failed: {e}")
+
+ return _modules_redirect_response(request, sync_url)
+
+
+class MoveModuleView(LibreNMSPermissionMixin, NetBoxObjectPermissionMixin, View):
+ """
+ Move an existing module from its current location to a target bay.
+
+ Handles the case where a module (identified by serial) has been physically
+ moved from one slot to another β possibly on a different device. Updates
+ the module_bay (and device when moving cross-device) rather than deleting
+ and recreating, preserving the module's history.
+ """
+
+ def post(self, request, pk):
+ from dcim.models import Device, Module, ModuleBay
+
+ self.required_object_permissions = {"POST": [("change", Module), ("delete", Module)]}
+ if error := self.require_all_permissions("POST"):
+ return error
+
+ page_device = get_object_or_404(Device, pk=pk)
+ target_device = _resolve_target_device(page_device, request.POST.get("selected_device_id"))
+ sync_url = reverse("plugins:netbox_librenms_plugin:device_librenms_sync", kwargs={"pk": pk})
+
+ try:
+ conflict_module_id = int(request.POST.get("conflict_module_id"))
+ target_bay_id = int(request.POST.get("target_bay_id"))
+ except (TypeError, ValueError):
+ messages.error(request, "Missing or invalid conflict_module_id/target_bay_id.")
+ return _modules_redirect_response(request, sync_url)
+
+ # Optional: current occupant of target bay
+ raw_module_id = request.POST.get("module_id")
+ try:
+ module_id = int(raw_module_id) if raw_module_id else None
+ except (TypeError, ValueError):
+ module_id = None
+
+ get_object_or_404(ModuleBay, pk=target_bay_id, device=target_device)
+
+ try:
+ occupant_removed_msg = None
+ with transaction.atomic():
+ # Lock target bay to prevent concurrent modifications
+ target_bay = ModuleBay.objects.select_for_update().get(pk=target_bay_id, device=target_device)
+
+ # Re-fetch with row lock to prevent concurrent modifications
+ conflict_module = (
+ Module.objects.select_for_update()
+ .filter(pk=conflict_module_id)
+ .select_related("module_type", "module_bay", "device")
+ .first()
+ )
+ if not conflict_module:
+ messages.error(request, "Module no longer exists.")
+ return _modules_redirect_response(request, sync_url)
+
+ # Remove whatever is currently in the target bay (if provided and different)
+ if module_id:
+ occupant = (
+ Module.objects.select_for_update()
+ .filter(pk=module_id, device=target_device, module_bay=target_bay)
+ .first()
+ )
+ if occupant and occupant.pk != conflict_module.pk:
+ occupant_removed_msg = f"Removed {occupant.module_type.model} from {target_bay.name}."
+ occupant.delete()
+
+ # Move the conflict module to the target bay
+ from_bay = conflict_module.module_bay.name
+ from_device = conflict_module.device.name
+ conflict_module.module_bay = target_bay
+ conflict_module.device = target_device
+ conflict_module.full_clean()
+ conflict_module.save()
+
+ if occupant_removed_msg:
+ messages.info(request, occupant_removed_msg)
+ moved_msg = f"Moved {conflict_module.module_type.model}"
+ if from_device != target_device.name:
+ moved_msg += f" from {from_device}"
+ moved_msg += f"/{from_bay} to {target_bay.name}."
+ messages.success(request, moved_msg)
+ except (ValidationError, IntegrityError) as e:
+ messages.error(request, f"Move failed: {e}")
+
+ return _modules_redirect_response(request, sync_url)
+
+
+class AddBayTemplateView(LibreNMSPermissionMixin, NetBoxObjectPermissionMixin, View):
+ """
+ Create a missing ModuleBayTemplate on a Device Type or Module Type so the
+ user can install a sub-component without leaving the modules sync tab.
+
+ GET renders a pre-filled modal fragment that targets ``#htmx-modal-content``;
+ POST creates the bay template and redirects back to the modules tab.
+ """
+
+ TARGET_KINDS = ("device_type", "module_type")
+
+ def _resolve_target(self, target_kind, target_pk):
+ """Load the DeviceType or ModuleType the new bay template will attach to."""
+ from dcim.models import DeviceType, ModuleType
+
+ if target_kind == "device_type":
+ return get_object_or_404(DeviceType, pk=target_pk)
+ if target_kind == "module_type":
+ return get_object_or_404(ModuleType, pk=target_pk)
+ return None
+
+ @staticmethod
+ def _device_manufacturer(device):
+ """Return the device's Manufacturer (or None) for vendor-scoped mapping defaults."""
+ device_type = getattr(device, "device_type", None)
+ return getattr(device_type, "manufacturer", None) if device_type else None
+
+ @staticmethod
+ def _instantiate_template_on_existing(bay_template, target_kind, target):
+ """
+ Materialise the just-saved ``ModuleBayTemplate`` onto every existing
+ device/module of ``target`` so the resolver can match it immediately.
+
+ NetBox auto-creates bays from templates only when a Device/Module is
+ first created β a template added later is invisible to existing
+ instances until manually instantiated. ``target_kind`` selects the
+ scope: device-type templates are instantiated on every Device of that
+ type; module-type templates are instantiated on every installed Module
+ of that type. Pre-existing bays with the resolved name (under the same
+ device/module scope) are skipped so re-adding a template after a
+ partial manual fix is safe.
+ """
+ from dcim.models import Device, Module, ModuleBay
+
+ instantiated = 0
+ if target_kind == "device_type":
+ for device in Device.objects.filter(device_type=target):
+ bay = bay_template.instantiate(device=device)
+ if ModuleBay.objects.filter(device=device, module__isnull=True, name=bay.name).exists():
+ continue
+ bay.full_clean()
+ bay.save()
+ instantiated += 1
+ elif target_kind == "module_type":
+ for module in Module.objects.filter(module_type=target).select_related("device"):
+ bay = bay_template.instantiate(device=module.device, module=module)
+ if ModuleBay.objects.filter(device=module.device, module=module, name=bay.name).exists():
+ continue
+ bay.full_clean()
+ bay.save()
+ instantiated += 1
+ return instantiated
+
+ @staticmethod
+ def _derive_mapping_pattern(librenms_name, netbox_name):
+ """
+ Derive a regex ``ModuleBayMapping`` rule that maps ``librenms_name``
+ to ``netbox_name`` and naturally covers every sibling bay sharing
+ the same LibreNMS-side literal skeleton.
+
+ Both names are tokenised into alternating literal and digit-run
+ segments. Each *distinct* digit value on the LibreNMS side becomes
+ a numbered capture group; subsequent occurrences of the same value
+ emit back-references, so ``"0/FT0"`` produces ``r"^(\\d+)/FT\\1$"``
+ β matching only when both fan-tray digits agree. The NetBox
+ replacement preserves the operator-chosen literals verbatim and
+ back-references the LibreNMS group whose value matches each digit
+ run on the NetBox side.
+
+ Returns ``None`` when:
+ * either name is empty,
+ * the LibreNMS name has no digit run at all,
+ * the NetBox name contains a digit value that does not appear in
+ the LibreNMS name (we'd be inventing a value we can't extract),
+ * the resulting pattern fails to compile or does not round-trip
+ (``compile.fullmatch`` + ``compile.sub`` must reproduce the
+ exact NetBox name).
+
+ Examples::
+
+ ('Sfm 1', 'SFM 1') -> r'^Sfm (\\d+)$' β r'SFM \\1'
+ ('0/FT0', 'Fan Tray 0') -> r'^(\\d+)/FT\\1$' β r'Fan Tray \\1'
+ ('TenGigE0/0/0/0', same) -> r'^TenGigE(\\d+)/\\1/\\1/\\1$'
+ β r'TenGigE\\1/\\1/\\1/\\1'
+ ('0/FT0', 'Fan Tray 1') -> None (libre has no '1')
+ ('Slot A', 'Slot A') -> None (no digit run)
+ """
+ if not librenms_name or not netbox_name:
+ return None
+ token_re = re.compile(r"(\d+|\D+)")
+ libre_tokens = token_re.findall(librenms_name)
+ nb_tokens = token_re.findall(netbox_name)
+
+ digit_groups = {}
+ pattern_parts = ["^"]
+ for tok in libre_tokens:
+ if tok.isdigit():
+ if tok in digit_groups:
+ pattern_parts.append(rf"\{digit_groups[tok]}")
+ else:
+ idx = len(digit_groups) + 1
+ digit_groups[tok] = idx
+ pattern_parts.append(r"(\d+)")
+ else:
+ pattern_parts.append(re.escape(tok))
+ pattern_parts.append("$")
+ if not digit_groups:
+ return None
+
+ replacement_parts = []
+ for tok in nb_tokens:
+ if tok.isdigit():
+ if tok not in digit_groups:
+ return None
+ replacement_parts.append(rf"\{digit_groups[tok]}")
+ else:
+ replacement_parts.append(tok.replace("\\", r"\\"))
+
+ librenms_pattern = "".join(pattern_parts)
+ netbox_replacement = "".join(replacement_parts)
+ try:
+ compiled = re.compile(librenms_pattern)
+ except re.error:
+ return None
+ if not compiled.fullmatch(librenms_name):
+ return None
+ try:
+ if compiled.sub(netbox_replacement, librenms_name) != netbox_name:
+ return None
+ except re.error:
+ return None
+ return {
+ "kind": "regex",
+ "librenms_pattern": librenms_pattern,
+ "netbox_replacement": netbox_replacement,
+ "digit_count": len(digit_groups),
+ }
+
+ @staticmethod
+ def _existing_regex_mapping_covers(librenms_name, librenms_class, manufacturer):
+ """
+ True when an existing regex ModuleBayMapping already matches
+ ``librenms_name`` for the given manufacturer / global scope.
+ Iterates regex rows in Python β the row count is small (one per
+ bay-family) so this is cheap, and Postgres can't compare its
+ re-flavoured patterns server-side anyway.
+ """
+ from netbox_librenms_plugin.models import ModuleBayMapping
+
+ if not librenms_name:
+ return False
+ qs = ModuleBayMapping.objects.filter(
+ librenms_class=librenms_class or "",
+ is_regex=True,
+ )
+ if manufacturer is not None:
+ qs = qs.filter(models.Q(manufacturer=manufacturer) | models.Q(manufacturer__isnull=True))
+ else:
+ qs = qs.filter(manufacturer__isnull=True)
+ for mapping in qs.only("librenms_name"):
+ try:
+ if re.compile(mapping.librenms_name).fullmatch(librenms_name):
+ return True
+ except re.error:
+ continue
+ return False
+
+ @staticmethod
+ def _existing_bay_mapping(librenms_name, librenms_class, manufacturer):
+ """
+ True when a ModuleBayMapping already covers (librenms_name, librenms_class)
+ for the given manufacturer (vendor-scoped) or globally (manufacturer is null).
+
+ Only checks exact mappings β regex mappings are intentionally ignored
+ because the per-row suggestion is for one specific name and we don't
+ want to second-guess broader patterns the operator already wrote.
+ """
+ from netbox_librenms_plugin.models import ModuleBayMapping
+
+ if not librenms_name:
+ return False
+ qs = ModuleBayMapping.objects.filter(
+ librenms_name=librenms_name,
+ librenms_class=librenms_class or "",
+ is_regex=False,
+ )
+ if manufacturer is not None:
+ qs = qs.filter(models.Q(manufacturer=manufacturer) | models.Q(manufacturer__isnull=True))
+ else:
+ qs = qs.filter(manufacturer__isnull=True)
+ return qs.exists()
+
+ def get(self, request, pk):
+ from dcim.models import Device, ModuleBay, ModuleBayTemplate
+
+ # Read-only modal render β only require plugin view permission and
+ # NetBox add-permission on ModuleBayTemplate so users without it never
+ # see a form they cannot submit. POST also instantiates live ModuleBay
+ # rows via _instantiate_template_on_existing(), so require add_modulebay
+ # here too to keep the GET/POST permission contract aligned.
+ self.required_object_permissions = {"GET": [("add", ModuleBayTemplate), ("add", ModuleBay)]}
+ if error := self.require_all_permissions("GET"):
+ return error
+
+ device = get_object_or_404(Device, pk=pk)
+
+ target_kind = request.GET.get("target_kind", "")
+ if target_kind not in self.TARGET_KINDS:
+ return HttpResponse("Invalid target_kind.", status=400)
+ try:
+ target_pk = int(request.GET.get("target_pk", ""))
+ except (TypeError, ValueError):
+ return HttpResponse("Missing or invalid target_pk.", status=400)
+ target = self._resolve_target(target_kind, target_pk)
+
+ librenms_name = request.GET.get("librenms_name", "")
+ librenms_class = request.GET.get("librenms_class", "")
+ suggested_name = request.GET.get("suggested_name", "")
+ manufacturer = self._device_manufacturer(device)
+ mapping_exists = self._existing_bay_mapping(
+ librenms_name, librenms_class, manufacturer
+ ) or self._existing_regex_mapping_covers(librenms_name, librenms_class, manufacturer)
+ # Offer the auto-mapping option only when we have a LibreNMS name to
+ # map *from* and there's no existing mapping covering it. Permission
+ # to add the mapping itself is also required β users without it would
+ # only see the checkbox return a permission error on POST.
+
+ can_add_mapping = request.user.has_perm("netbox_librenms_plugin.add_modulebaymapping")
+ offer_mapping_checkbox = bool(librenms_name) and not mapping_exists and can_add_mapping
+ # Pattern preview against the *current* suggested NetBox name. The
+ # template re-runs this on every keystroke client-side; the
+ # server-side derivation is for the initial render + POST-time check.
+ mapping_pattern = (
+ self._derive_mapping_pattern(librenms_name, suggested_name) if offer_mapping_checkbox else None
+ )
+
+ context = {
+ "device_pk": pk,
+ "target_kind": target_kind,
+ "target_pk": target_pk,
+ "target_label": str(target),
+ "suggested_name": suggested_name,
+ "suggested_position": request.GET.get("suggested_position", ""),
+ "suggested_label": request.GET.get("suggested_label", ""),
+ "librenms_name": librenms_name,
+ "librenms_class": librenms_class,
+ "manufacturer_label": str(manufacturer) if manufacturer else "",
+ "offer_mapping_checkbox": offer_mapping_checkbox,
+ "mapping_exists": mapping_exists,
+ "mapping_pattern": mapping_pattern,
+ "mapping_default_kind": "regex" if mapping_pattern else "exact",
+ }
+ return render(request, "netbox_librenms_plugin/htmx/add_bay_template_modal.html", context)
+
+ def post(self, request, pk):
+ from dcim.models import Device, ModuleBay, ModuleBayTemplate
+
+ from netbox_librenms_plugin.models import ModuleBayMapping
+
+ # POST creates the template AND instantiates live ModuleBay rows on
+ # existing devices/modules via _instantiate_template_on_existing(), so
+ # gate on add_modulebay in addition to add_modulebaytemplate.
+ self.required_object_permissions = {"POST": [("add", ModuleBayTemplate), ("add", ModuleBay)]}
+ if error := self.require_all_permissions("POST"):
+ return error
+
+ device = get_object_or_404(Device, pk=pk)
+ sync_url = reverse("plugins:netbox_librenms_plugin:device_librenms_sync", kwargs={"pk": pk})
+
+ target_kind = request.POST.get("target_kind", "")
+ if target_kind not in self.TARGET_KINDS:
+ messages.error(request, "Invalid target_kind for bay template.")
+ return _modules_redirect_response(request, sync_url)
+ try:
+ target_pk = int(request.POST.get("target_pk", ""))
+ except (TypeError, ValueError):
+ messages.error(request, "Missing or invalid target_pk for bay template.")
+ return _modules_redirect_response(request, sync_url)
+
+ name = (request.POST.get("name") or "").strip()
+ if not name:
+ messages.error(request, "Bay template name is required.")
+ return _modules_redirect_response(request, sync_url)
+ position = (request.POST.get("position") or "").strip()
+ label = (request.POST.get("label") or "").strip()
+ description = (request.POST.get("description") or "").strip()
+
+ # Optional auto-mapping inputs (echoed from the GET-rendered modal).
+ librenms_name = (request.POST.get("librenms_name") or "").strip()
+ librenms_class = (request.POST.get("librenms_class") or "").strip()
+ also_create_mapping = request.POST.get("also_create_mapping") == "1"
+ mapping_kind = request.POST.get("mapping_kind", "exact")
+ if mapping_kind not in ("exact", "regex"):
+ mapping_kind = "exact"
+
+ target = self._resolve_target(target_kind, target_pk)
+ kwargs = {
+ "name": name,
+ "position": position,
+ "label": label,
+ "description": description,
+ }
+ if target_kind == "device_type":
+ kwargs["device_type"] = target
+ else:
+ kwargs["module_type"] = target
+
+ # Only add a mapping when the user actually picked a different
+ # NetBox bay name β if the names match, no mapping is needed.
+ will_add_mapping = (
+ also_create_mapping
+ and librenms_name
+ and librenms_name != name
+ and request.user.has_perm("netbox_librenms_plugin.add_modulebaymapping")
+ )
+ manufacturer = self._device_manufacturer(device) if will_add_mapping else None
+ # Resolve regex pattern + replacement when the user opted in.
+ mapping_libre_value = librenms_name
+ mapping_netbox_value = name
+ mapping_is_regex = False
+ if will_add_mapping and mapping_kind == "regex":
+ pattern = self._derive_mapping_pattern(librenms_name, name)
+ if pattern is None:
+ # Server-side rule didn't fire β fall back to exact rather than
+ # writing an unverified regex from client input.
+ mapping_kind = "exact"
+ else:
+ mapping_libre_value = pattern["librenms_pattern"]
+ mapping_netbox_value = pattern["netbox_replacement"]
+ mapping_is_regex = True
+ if will_add_mapping:
+ if mapping_is_regex:
+ race = self._existing_regex_mapping_covers(librenms_name, librenms_class, manufacturer)
+ else:
+ race = self._existing_bay_mapping(librenms_name, librenms_class, manufacturer)
+ if race:
+ # Race: a mapping was added between modal render and submit.
+ will_add_mapping = False
+
+ try:
+ mapping_created = False
+ instantiated_count = 0
+ with transaction.atomic():
+ bay_template = ModuleBayTemplate(**kwargs)
+ bay_template.full_clean()
+ bay_template.save()
+ instantiated_count = self._instantiate_template_on_existing(bay_template, target_kind, target)
+ if will_add_mapping:
+ mapping = ModuleBayMapping(
+ librenms_name=mapping_libre_value,
+ librenms_class=librenms_class,
+ netbox_bay_name=mapping_netbox_value,
+ is_regex=mapping_is_regex,
+ manufacturer=manufacturer,
+ )
+ mapping.full_clean()
+ mapping.save()
+ mapping_created = True
+ instantiate_note = ""
+ if instantiated_count:
+ noun = "device" if target_kind == "device_type" else "module"
+ plural = "" if instantiated_count == 1 else "s"
+ instantiate_note = f" Bay added to {instantiated_count} existing {noun}{plural}."
+ if mapping_created:
+ vendor_note = f" (scoped to {manufacturer})" if manufacturer else " (global)"
+ kind_note = "regex " if mapping_is_regex else ""
+ messages.success(
+ request,
+ f"Added bay template '{name}' to {target} and {kind_note}ModuleBayMapping "
+ f"'{mapping_libre_value}' β '{mapping_netbox_value}'{vendor_note}.{instantiate_note}",
+ )
+ else:
+ messages.success(request, f"Added bay template '{name}' to {target}.{instantiate_note}")
+ except (ValidationError, IntegrityError) as e:
+ messages.error(request, f"Failed to add bay template: {e}")
+
+ return _modules_redirect_response(request, sync_url)
diff --git a/tests/e2e/__init__.py b/tests/e2e/__init__.py
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/tests/e2e/conftest.py b/tests/e2e/conftest.py
new file mode 100644
index 0000000000..990870ada7
--- /dev/null
+++ b/tests/e2e/conftest.py
@@ -0,0 +1,16 @@
+"""Conftest for end-to-end Playwright tests.
+
+These tests are excluded from the default pytest discovery via ``testpaths``
+in ``pyproject.toml`` and are intended to be invoked explicitly:
+
+ python -m pytest tests/e2e/test_module_install.py -v -s
+
+Note: ``pyproject.toml`` sets ``DJANGO_SETTINGS_MODULE = "netbox.settings"``
+under ``[tool.pytest.ini_options]``, which pytest-django reads directly from
+the config file (not from the environment). Popping the env var here would
+have no effect on pytest-django's initialisation. The e2e tests do not
+import or use Django models β they drive a running NetBox over HTTP β so
+pytest-django's auto-loading is harmless and we leave it alone. If you ever
+need to skip pytest-django entirely for this suite, invoke pytest with
+``-p no:django``.
+"""
diff --git a/tests/e2e/test_device_type_mapping.py b/tests/e2e/test_device_type_mapping.py
new file mode 100644
index 0000000000..75ed89b3d3
--- /dev/null
+++ b/tests/e2e/test_device_type_mapping.py
@@ -0,0 +1,300 @@
+"""
+End-to-end Playwright test for the Device Type mapping workflow in the import modal.
+
+Tests that after adding a DeviceTypeMapping from the validation modal:
+ 1. The modal stays open and no longer shows "No matching type".
+ 2. The background table row updates to enable the Import button β no page refresh needed.
+
+Configuration (env vars):
+ E2E_TESTS_ENABLED=1 Required to run
+ NETBOX_URL (default http://127.0.0.1:8000)
+ NETBOX_USER / NETBOX_PASS (default admin/admin)
+ E2E_IMPORT_URL Full import page URL to use
+ E2E_HEADLESS=0 Set to 0 to watch browser (default 1)
+
+Run:
+ HTTP_PROXY= HTTPS_PROXY= http_proxy= https_proxy= \\
+ no_proxy=localhost,127.0.0.1 \\
+ E2E_TESTS_ENABLED=1 \\
+ E2E_IMPORT_URL="http://127.0.0.1:8000/plugins/librenms_plugin/librenms-import/?apply_filters=1&librenms_location=1" \\
+ /opt/python-venv/bin/python -m pytest tests/e2e/test_device_type_mapping.py -v -s -p no:django
+"""
+
+import os
+import subprocess
+
+import pytest
+
+NETBOX_URL = os.environ.get("NETBOX_URL", "http://127.0.0.1:8000")
+NETBOX_USER = os.environ.get("NETBOX_USER", "admin")
+NETBOX_PASS = os.environ.get("NETBOX_PASS", "admin")
+IMPORT_URL = os.environ.get(
+ "E2E_IMPORT_URL",
+ f"{NETBOX_URL}/plugins/librenms_plugin/librenms-import/",
+)
+HEADLESS = os.environ.get("E2E_HEADLESS", "1") != "0"
+
+E2E_ENABLED = os.environ.get("E2E_TESTS_ENABLED", "0") == "1"
+
+if not E2E_ENABLED:
+ pytest.skip("E2E tests skipped β set E2E_TESTS_ENABLED=1 to run", allow_module_level=True)
+
+
+def _get_container():
+ result = subprocess.run(["docker", "ps", "--format", "{{.Names}}"], capture_output=True, text=True)
+ matches = [n for n in result.stdout.strip().split("\n") if "devcontainer-devcontainer" in n]
+ if len(matches) == 1:
+ return matches[0]
+ pytest.skip("No devcontainer found")
+
+
+def _netbox_shell(code):
+ import shlex
+
+ container = _get_container()
+ result = subprocess.run(
+ [
+ "docker",
+ "exec",
+ container,
+ "bash",
+ "-c",
+ f"cd /opt/netbox/netbox && python3 manage.py shell -c {shlex.quote(code)}",
+ ],
+ capture_output=True,
+ text=True,
+ env={**os.environ, "PATH": "/usr/bin:/bin", "HOME": "/root"},
+ )
+ lines = [
+ line
+ for line in result.stdout.strip().split("\n")
+ if not line.startswith("π§¬") and "objects imported automatically" not in line
+ ]
+ if result.returncode != 0:
+ raise RuntimeError(f"shell failed: {result.stderr}")
+ return "\n".join(lines).strip()
+
+
+def _delete_mapping(pk: int):
+ _netbox_shell(
+ f"from netbox_librenms_plugin.models import DeviceTypeMapping; "
+ f"from django.core.cache import cache; "
+ f"DeviceTypeMapping.objects.filter(pk={pk}).delete(); "
+ f"cache.clear()"
+ )
+
+
+def _restore_mapping(hardware: str, device_type_id: int):
+ # update_or_create β get_or_create would not revert an existing mapping
+ # whose netbox_device_type was mutated by the test.
+ _netbox_shell(
+ f"from netbox_librenms_plugin.models import DeviceTypeMapping; "
+ f"from dcim.models import DeviceType; "
+ f"dt = DeviceType.objects.get(pk={device_type_id}); "
+ f"DeviceTypeMapping.objects.update_or_create("
+ f" librenms_hardware={hardware!r}, defaults={{'netbox_device_type': dt}})"
+ )
+
+
+def _get_existing_mapping():
+ output = _netbox_shell(
+ "from netbox_librenms_plugin.models import DeviceTypeMapping; "
+ "m = DeviceTypeMapping.objects.first(); "
+ "print(f'{m.pk}|{m.librenms_hardware}|{m.netbox_device_type_id}') if m else print('')"
+ )
+ if not output.strip():
+ return None
+ parts = output.strip().split("|")
+ return {"pk": int(parts[0]), "hardware": parts[1], "device_type_id": int(parts[2])} if len(parts) == 3 else None
+
+
+@pytest.fixture(scope="module")
+def browser():
+ from playwright.sync_api import sync_playwright
+
+ pw = sync_playwright().start()
+ b = pw.chromium.launch(headless=HEADLESS)
+ yield b
+ b.close()
+ pw.stop()
+
+
+@pytest.fixture
+def page(browser):
+ ctx = browser.new_context(ignore_https_errors=True)
+ pg = ctx.new_page()
+ pg.goto(f"{NETBOX_URL}/login/", timeout=15000)
+ pg.fill("#id_username", NETBOX_USER)
+ pg.fill("#id_password", NETBOX_PASS)
+ pg.click("button[type=submit]")
+ pg.wait_for_load_state("networkidle")
+ yield pg
+ ctx.close()
+
+
+def _close_modal(page):
+ """Close the HTMX modal if open (use the X btn-close button)."""
+ close_btn = page.locator("#htmx-modal button.btn-close[data-bs-dismiss='modal']").first
+ if close_btn.count() > 0 and close_btn.is_visible():
+ close_btn.click()
+ # Wait for Bootstrap to actually hide the modal rather than guessing
+ # at the animation duration.
+ page.wait_for_selector("#htmx-modal:not(.show)", timeout=4000)
+
+
+def _find_no_match_modal(page):
+ """
+ Open detail buttons one by one until a modal shows 'No matching type'.
+ Returns (modal_locator, row_locator) or (None, None).
+ """
+ btns = page.locator("button.btn-outline-danger, button.btn-warning").all()
+ for btn in btns[:10]: # Try up to 10 buttons
+ if not btn.is_visible():
+ continue
+ row = btn.locator("xpath=ancestor::tr[1]")
+ btn.click()
+ try:
+ page.wait_for_selector("#htmx-modal-content .modal-header", timeout=8000)
+ except Exception:
+ continue
+ page.wait_for_load_state("networkidle")
+ modal = page.locator("#htmx-modal-content")
+ if "No matching type" in modal.inner_text():
+ return modal, row
+ _close_modal(page)
+ return None, None
+
+
+class TestDeviceTypeMappingModal:
+ """Verify DeviceType mapping from import validation modal updates row in-place."""
+
+ def test_mapping_updates_modal_and_row(self, page):
+ """
+ Setup: temporarily remove a DeviceTypeMapping so a device shows 'No matching type'.
+ Assert: after adding the mapping back via the modal form:
+ - Modal stays open and shows the match (no 'No matching type')
+ - Background row updates to show enabled Import button (no page refresh)
+ """
+ mapping = _get_existing_mapping()
+ if not mapping:
+ pytest.skip("No DeviceTypeMapping in DB β cannot set up test scenario")
+
+ _delete_mapping(mapping["pk"])
+ try:
+ self._run_test(page, mapping)
+ finally:
+ _restore_mapping(mapping["hardware"], mapping["device_type_id"])
+
+ def _run_test(self, page, mapping):
+ page.goto(IMPORT_URL, timeout=20000)
+ page.wait_for_load_state("networkidle")
+
+ modal, row = _find_no_match_modal(page)
+ if modal is None:
+ pytest.skip(
+ f"No 'No matching type' device found at {IMPORT_URL} after removing mapping. "
+ "Set E2E_IMPORT_URL to the filtered import page that shows the affected device."
+ )
+
+ # Ensure a role is selected so the device can become importable
+ role_select = row.locator("select[name^='role_']")
+ if role_select.count() > 0 and not role_select.input_value():
+ role_select.select_option(index=1)
+ page.wait_for_load_state("networkidle")
+ # Re-open modal after role change
+ _close_modal(page)
+ modal, row = _find_no_match_modal(page)
+ if modal is None:
+ pytest.skip("No 'No matching type' device after role selection")
+
+ # Locate the search input
+ search = modal.locator("input[placeholder*='Search device types']")
+ assert search.is_visible(), "DeviceType search input not visible in modal"
+
+ # Diagnose: dump the search input's id and the dropdown div's id
+ search_id = search.get_attribute("id")
+ dropdown_div = modal.locator("[id^='dt-dropdown-']")
+ dropdown_id = dropdown_div.get_attribute("id") if dropdown_div.count() > 0 else "(not found)"
+ print(f"\nSearch input id: {search_id!r}, dropdown div id: {dropdown_id!r}")
+
+ # Check whether the JS event listener is attached by inspecting via JS
+ has_listener = (
+ page.evaluate(f"() => {{ var el = document.getElementById({search_id!r}); return !!el; }}")
+ if search_id
+ else False
+ )
+ print(f"searchEl found via getElementById: {has_listener}")
+
+ # Dispatch input event to trigger dropdown fetch; wait for either
+ # results to appear or a brief HTMX network exchange to settle.
+ page.evaluate(
+ f"() => {{"
+ f" var el = document.getElementById({search_id!r});"
+ f" if (el) {{ el.value = 'a'; el.dispatchEvent(new Event('input', {{bubbles:true}})); }}"
+ f"}}"
+ )
+ try:
+ page.wait_for_selector(
+ "#htmx-modal-content [id^='dt-dropdown-'] a",
+ timeout=2000,
+ state="attached",
+ )
+ except Exception:
+ pass
+
+ # If still no dropdown, type via keyboard and wait again
+ search.click()
+ page.keyboard.type("b", delay=100)
+ try:
+ page.wait_for_selector(
+ "#htmx-modal-content [id^='dt-dropdown-'] a",
+ timeout=2000,
+ state="attached",
+ )
+ except Exception:
+ pass
+
+ # Final check
+ dropdown_items = modal.locator("[id^='dt-dropdown-'] a")
+ print(f"Dropdown item count after attempts: {dropdown_items.count()}")
+
+ page.wait_for_selector(
+ "#htmx-modal-content [id^='dt-dropdown-'] a",
+ timeout=8000,
+ state="attached",
+ )
+
+ dropdown = modal.locator("[id^='dt-dropdown-']")
+ first = dropdown.locator("a").first
+ assert first.count() > 0, "No results in DeviceType dropdown"
+ first.click()
+ # Wait for the hidden input to receive the selected value rather than
+ # polling with a fixed timeout.
+ page.wait_for_function(
+ "() => { var el = document.querySelector(\"#htmx-modal-content input[name='device_type_id']\");"
+ " return el && el.value && el.value.length > 0; }",
+ timeout=4000,
+ )
+
+ hidden_val = modal.locator("input[name='device_type_id']").input_value()
+ assert hidden_val, "Hidden device_type_id not filled after clicking a result"
+
+ # Submit
+ modal.locator("button:has-text('Add Mapping')").click()
+
+ # Wait for the OOB row swap + modal refresh to settle via network idle
+ # rather than a fixed 3s timeout.
+ page.wait_for_load_state("networkidle")
+
+ # --- Assert 1: modal stays open and shows match ---
+ assert modal.is_visible(), "Modal closed after adding mapping β expected to stay open"
+ modal_after = modal.inner_text()
+ assert "No matching type" not in modal_after, f"Modal still shows 'No matching type'.\nModal:\n{modal_after}"
+
+ # --- Assert 2: row updated without page refresh ---
+ import_btn = row.locator("button.btn-success.device-import-btn:not([disabled])")
+ assert import_btn.count() > 0, (
+ "No enabled Import button in row after mapping β "
+ "JS deviceMappingAdded handler may not have triggered the row update.\n"
+ f"Row: {row.inner_text()}"
+ )
diff --git a/tests/e2e/test_module_install.py b/tests/e2e/test_module_install.py
new file mode 100644
index 0000000000..f3b0aa90f6
--- /dev/null
+++ b/tests/e2e/test_module_install.py
@@ -0,0 +1,370 @@
+"""
+End-to-end Playwright tests for LibreNMS plugin module sync workflow.
+
+These tests exercise the full import β modules β install flow against a
+live NetBox + LibreNMS instance inside the devcontainer.
+
+Prerequisites:
+ - NetBox running at NETBOX_URL (default http://172.22.0.4:8000)
+ - LibreNMS server configured in plugin settings
+ - A device linked to LibreNMS that has inventory modules
+ - Playwright installed: pip install playwright && playwright install chromium
+
+Configuration (environment variables):
+ E2E_TESTS_ENABLED=1 Required to run these tests
+ E2E_DEVICE_ID= NetBox device PK to test against (auto-detected if omitted)
+ NETBOX_URL= NetBox base URL (default http://172.22.0.4:8000)
+ NETBOX_USER= Login username (default admin)
+ NETBOX_PASS= Login password (default admin)
+ NETBOX_CONTAINER= Docker container name (auto-detected if omitted)
+
+Run:
+ cd /home/mzieba/workspace/netbox-librenms-plugin
+ HTTP_PROXY= HTTPS_PROXY= http_proxy= https_proxy= \
+ no_proxy=localhost,127.0.0.1,172.22.0.4 \
+ E2E_TESTS_ENABLED=1 python -m pytest tests/e2e/test_module_install.py -v -s
+"""
+
+import os
+import subprocess
+
+import pytest
+
+NETBOX_URL = os.environ.get("NETBOX_URL", "http://172.22.0.4:8000")
+NETBOX_USER = os.environ.get("NETBOX_USER", "admin")
+NETBOX_PASS = os.environ.get("NETBOX_PASS", "admin")
+CONTAINER_NAME = None
+
+E2E_ENABLED = os.environ.get("E2E_TESTS_ENABLED", "0") == "1"
+
+if not E2E_ENABLED:
+ pytest.skip(
+ "E2E tests skipped β set E2E_TESTS_ENABLED=1 to run against a live instance",
+ allow_module_level=True,
+ )
+
+
+def _get_container():
+ """Find the devcontainer name."""
+ global CONTAINER_NAME
+ if CONTAINER_NAME:
+ return CONTAINER_NAME
+ override = os.environ.get("NETBOX_CONTAINER")
+ if override:
+ CONTAINER_NAME = override
+ return override
+ result = subprocess.run(
+ ["docker", "ps", "--format", "{{.Names}}"],
+ capture_output=True,
+ text=True,
+ )
+ if result.returncode != 0:
+ raise RuntimeError(f"docker ps failed (rc={result.returncode}): {result.stderr}")
+ matches = [name for name in result.stdout.strip().split("\n") if "devcontainer-devcontainer" in name]
+ if len(matches) == 1:
+ CONTAINER_NAME = matches[0]
+ return CONTAINER_NAME
+ if len(matches) > 1:
+ raise RuntimeError(f"Multiple candidate devcontainers found: {matches}. Set NETBOX_CONTAINER.")
+ pytest.skip("No devcontainer found")
+
+
+def _netbox_shell(code):
+ """Run Python code in NetBox's Django shell."""
+ import shlex
+
+ container = _get_container()
+ escaped = shlex.quote(code)
+ result = subprocess.run(
+ [
+ "docker",
+ "exec",
+ container,
+ "bash",
+ "-c",
+ f"cd /opt/netbox/netbox && python3 manage.py shell -c {escaped}",
+ ],
+ capture_output=True,
+ text=True,
+ env={**os.environ, "PATH": "/usr/bin:/bin", "HOME": "/root"},
+ )
+ lines = [
+ line
+ for line in result.stdout.strip().split("\n")
+ if not line.startswith("π§¬") and "objects imported automatically" not in line
+ ]
+ if result.returncode != 0:
+ raise RuntimeError(f"netbox shell command failed (rc={result.returncode}): {result.stderr}")
+ return "\n".join(lines).strip()
+
+
+def _detect_device_id():
+ """Find a device linked to LibreNMS that has inventory modules.
+
+ Returns the NetBox device PK, or skips the test session if none found.
+ """
+ output = _netbox_shell(
+ "from dcim.models import Device; "
+ "devs = Device.objects.exclude(custom_field_data__librenms_id=None)"
+ ".exclude(custom_field_data__librenms_id={}).order_by('pk'); "
+ "print(devs.first().pk if devs.exists() else '')"
+ )
+ if not output.strip():
+ pytest.skip("No device with librenms_id found in NetBox")
+ return int(output.strip())
+
+
+def _delete_device_modules(device_id):
+ """Remove all modules from a device."""
+ _netbox_shell(
+ f"from dcim.models import Module; "
+ f"deleted = Module.objects.filter(device_id={device_id}).delete(); "
+ f"print(f'Deleted {{deleted}}')"
+ )
+
+
+def _get_interfaces(device_id):
+ """Get interface names for a device."""
+ output = _netbox_shell(
+ f"from dcim.models import Interface; "
+ f'[print(f\'{{i.name}}|{{i.module.module_type.model if i.module else "-"}}|'
+ f'{{i.module.module_bay.name if i.module else "-"}}\')'
+ f" for i in Interface.objects.filter(device_id={device_id}).order_by('name')]"
+ )
+ results = []
+ for line in output.split("\n"):
+ if "|" in line:
+ name, mod_type, bay = line.split("|")
+ results.append({"name": name, "module_type": mod_type, "bay": bay})
+ return results
+
+
+@pytest.fixture(scope="module")
+def device_id():
+ """Resolve the device PK to test against."""
+ env_id = os.environ.get("E2E_DEVICE_ID")
+ if env_id:
+ return int(env_id)
+ return _detect_device_id()
+
+
+@pytest.fixture(scope="module")
+def browser():
+ """Launch browser for the test module."""
+ from playwright.sync_api import sync_playwright
+
+ pw = sync_playwright().start()
+ b = pw.chromium.launch(headless=True)
+ yield b
+ b.close()
+ pw.stop()
+
+
+@pytest.fixture
+def page(browser):
+ """Create a new page and log in to NetBox."""
+ ctx = browser.new_context(ignore_https_errors=True)
+ pg = ctx.new_page()
+
+ pg.goto(f"{NETBOX_URL}/login/", timeout=10000)
+ pg.fill("#id_username", NETBOX_USER)
+ pg.fill("#id_password", NETBOX_PASS)
+ pg.click("button[type=submit]")
+ pg.wait_for_load_state("networkidle")
+ yield pg
+ ctx.close()
+
+
+class TestModuleInstallWorkflow:
+ """Test the full module sync and install workflow."""
+
+ def _goto_modules_tab(self, page, device_id):
+ """Navigate to the modules sync tab and refresh data."""
+ page.goto(f"{NETBOX_URL}/dcim/devices/{device_id}/librenms-sync/?tab=modules")
+ page.wait_for_load_state("networkidle")
+ page.wait_for_selector('button:has-text("Refresh Modules")', timeout=10000)
+
+ btn = page.query_selector('button:has-text("Refresh Modules")')
+ assert btn is not None, "Refresh Modules button not found"
+ btn.click()
+ page.wait_for_selector("#modules table tr", timeout=30000)
+ page.wait_for_load_state("networkidle")
+
+ def _get_table_rows(self, page):
+ """Parse the module sync table into dicts."""
+ pane = page.query_selector("#modules")
+ assert pane is not None, "Modules pane not found"
+
+ def _text(tr, col):
+ el = tr.query_selector(f'td[data-col="{col}"]')
+ return el.inner_text().strip() if el else ""
+
+ rows = []
+ for tr in pane.query_selector_all("table tr"):
+ if tr.query_selector('td[data-col="name"]') is None:
+ continue
+ rows.append(
+ {
+ "name": _text(tr, "name"),
+ "model": _text(tr, "model"),
+ "serial": _text(tr, "serial"),
+ "bay": _text(tr, "module_bay"),
+ "type": _text(tr, "module_type"),
+ "status": _text(tr, "status"),
+ "tr": tr,
+ }
+ )
+ return rows
+
+ def _find_row_with_button(self, rows, button_text):
+ """Find the first top-level row that has a button matching button_text."""
+ for row in rows:
+ if row["name"].startswith("ββ"):
+ continue
+ btn = row["tr"].query_selector(f'button:has-text("{button_text}")')
+ if btn:
+ return row, btn
+ return None, None
+
+ def test_clean_state_shows_matched_rows(self, page, device_id):
+ """After deleting all modules, table shows rows with Matched status."""
+ _delete_device_modules(device_id)
+ self._goto_modules_tab(page, device_id)
+
+ rows = self._get_table_rows(page)
+ assert len(rows) > 0, "No rows in module sync table"
+
+ matched = [r for r in rows if r["status"] == "Matched"]
+ assert len(matched) > 0, f"Expected at least one Matched row, got statuses: {set(r['status'] for r in rows)}"
+
+ def test_single_install(self, page, device_id):
+ """Installing a single top-level module works."""
+ _delete_device_modules(device_id)
+ self._goto_modules_tab(page, device_id)
+
+ rows = self._get_table_rows(page)
+ row, btn = self._find_row_with_button(rows, "Install")
+ if not btn:
+ pytest.skip("No installable module found in table")
+
+ module_name = row["name"]
+ btn.click()
+ page.wait_for_load_state("networkidle")
+
+ module_count = _netbox_shell(
+ f"from dcim.models import Module; print(Module.objects.filter(device_id={device_id}).count())"
+ )
+ assert int(module_count.strip()) > 0, f"No modules in DB after installing '{module_name}'"
+
+ def test_branch_install(self, page, device_id):
+ """Branch install creates parent module + children."""
+ _delete_device_modules(device_id)
+ self._goto_modules_tab(page, device_id)
+
+ rows = self._get_table_rows(page)
+ row, btn = self._find_row_with_button(rows, "Install Branch")
+ if not btn:
+ pytest.skip("No branch-installable module found in table")
+
+ module_name = row["name"]
+ btn.click()
+ page.wait_for_load_state("networkidle", timeout=60000)
+
+ module_count = _netbox_shell(
+ f"from dcim.models import Module; print(Module.objects.filter(device_id={device_id}).count())"
+ )
+ count = int(module_count.strip())
+ assert count > 1, f"Branch install of '{module_name}' created {count} module(s), expected >1"
+
+ interfaces = _get_interfaces(device_id)
+ module_interfaces = [i for i in interfaces if i["module_type"] != "-"]
+ assert len(module_interfaces) > 0, f"No interfaces linked to modules after branch install of '{module_name}'"
+ for iface in module_interfaces:
+ assert not iface["name"].isdigit(), (
+ f"Interface '{iface['name']}' has bare numeric name β naming rule not applied"
+ )
+
+ def test_branch_install_no_duplicate_errors(self, page, device_id):
+ """Branch install handles already-occupied bays gracefully."""
+ self._goto_modules_tab(page, device_id)
+
+ rows = self._get_table_rows(page)
+ row, btn = self._find_row_with_button(rows, "Install Branch")
+ if not btn:
+ pytest.skip("No branch-installable module found in table")
+
+ module_name = row["name"]
+
+ # First install (may already be installed from prior test)
+ btn.click()
+ page.wait_for_load_state("networkidle", timeout=60000)
+
+ # Navigate back and try again β bays should now be occupied
+ self._goto_modules_tab(page, device_id)
+ rows = self._get_table_rows(page)
+ _, btn2 = self._find_row_with_button(rows, "Install Branch")
+ if not btn2:
+ pytest.skip(f"No Install Branch button after first install of '{module_name}'")
+
+ btn2.click()
+ page.wait_for_load_state("networkidle", timeout=30000)
+
+ body_text = page.query_selector("body").inner_text()
+ assert "Branch install failed" not in body_text, (
+ "Branch install crashed instead of handling occupied bays gracefully"
+ )
+
+ def test_child_bays_hidden_when_parent_not_installed(self, page, device_id):
+ """Children show 'No matching bay' when parent module is not installed."""
+ _delete_device_modules(device_id)
+ self._goto_modules_tab(page, device_id)
+
+ rows = self._get_table_rows(page)
+ children = [r for r in rows if r["name"].startswith("ββ")]
+ if not children:
+ pytest.skip("No child module rows found in table")
+
+ no_bay = [c for c in children if "No matching bay" in c["bay"]]
+ assert len(no_bay) > 0, (
+ "Expected some children to show 'No matching bay' when parent not installed, "
+ f"got bays: {set(c['bay'] for c in children)}"
+ )
+
+ def test_full_workflow(self, page, device_id):
+ """Full workflow: clean β install individuals β branch install β verify."""
+ _delete_device_modules(device_id)
+ self._goto_modules_tab(page, device_id)
+
+ # Step 1: Install a few individual modules
+ for _ in range(3):
+ rows = self._get_table_rows(page)
+ row, btn = self._find_row_with_button(rows, "Install")
+ if not btn:
+ break
+ btn.click()
+ page.wait_for_load_state("networkidle")
+
+ # Step 2: Branch install all available branches
+ while True:
+ rows = self._get_table_rows(page)
+ row, btn = self._find_row_with_button(rows, "Install Branch")
+ if not btn:
+ break
+ btn.click()
+ page.wait_for_load_state("networkidle", timeout=60000)
+ self._goto_modules_tab(page, device_id)
+
+ # Verify: no top-level "Matched" items remain uninstalled
+ self._goto_modules_tab(page, device_id)
+ rows = self._get_table_rows(page)
+ top_level_matched = [r for r in rows if r["status"] == "Matched" and not r["name"].startswith("ββ")]
+ assert len(top_level_matched) == 0, (
+ f"Top-level items still Matched after full workflow: {[r['name'] for r in top_level_matched]}"
+ )
+
+ # Verify interface naming β no bare numeric names
+ interfaces = _get_interfaces(device_id)
+ for iface in interfaces:
+ assert not iface["name"].isdigit(), (
+ f"Interface '{iface['name']}' has bare numeric name β naming rule not applied"
+ )