netbox-pathways 0.2.0__tar.gz → 0.2.2__tar.gz

{netbox_pathways-0.2.0 → netbox_pathways-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: netbox-pathways
-Version: 0.2.0
+Version: 0.2.2
 Summary: NetBox plugin for physical cable plant infrastructure documentation with GIS capabilities
 Author-email: Jonathan Senecal <contact@jonathansenecal.com>
 Project-URL: Homepage, https://github.com/jsenecal/netbox-pathways
@@ -58,9 +58,14 @@ Requires-Dist: zensical; extra == "docs"
 
 ## Compatibility
 
-| Plugin version | NetBox version | Python    | PostgreSQL          |
-|----------------|----------------|-----------|---------------------|
-| 0.1.x          | 4.5.3+         | 3.12-3.14 | 16+ with PostGIS 3.4|
+| Plugin version  | NetBox version       | Python    | PostgreSQL           |
+|-----------------|----------------------|-----------|----------------------|
+| 0.1.x -- 0.2.1  | 4.5.3 -- 4.5.x       | 3.12-3.14 | 16+ with PostGIS 3.4+|
+| 0.2.2+          | 4.5.3+ (incl. 4.6.x) | 3.12-3.14 | 16+ with PostGIS 3.4+|
+
+> NetBox 4.6 ships Django 6.0. Plugin versions 0.2.1 and earlier do not render
+> the geometry map widget on NetBox 4.6 (issue #52); upgrade to 0.2.2 or later
+> for NetBox 4.6 support.
 
 ## Installation
 
@@ -179,6 +184,13 @@ Full documentation: **[jsenecal.github.io/netbox-pathways](https://jsenecal.gith
 - [Architecture](https://jsenecal.github.io/netbox-pathways/developer/architecture/)
 - [GeoJSON API reference](https://jsenecal.github.io/netbox-pathways/reference/geojson-api/)
 
+## Related plugins
+
+netbox-pathways is part of a three-plugin set that models the full optical transport stack:
+
+- **[netbox-fms](https://github.com/jsenecal/netbox-fms)** -- Fiber Management System. Defines fiber cable construction (buffer tubes, ribbons, strands), plans splices in closures, and provisions end-to-end fiber circuits. Pathways tracks *where cables run*; FMS tracks *what is inside them and how strands are spliced*.
+- **[netbox-wdm](https://github.com/jsenecal/netbox-wdm)** -- WDM (Wavelength Division Multiplexing) device management. Models ITU channel plans, ROADM mappings, and wavelength services that ride on top of the fiber circuits FMS provisions, over the cables routed through Pathways.
+
 ## Contributing
 
 PRs welcome. Use conventional-commits PR titles (`feat:`, `fix:`, `chore:`, `docs:`, ...) -- release-drafter assembles release notes from them. Run `make setup` after cloning to install dev dependencies and the pre-commit hooks (including the AI-attribution-rejecting `commit-msg` hook).

{netbox_pathways-0.2.0 → netbox_pathways-0.2.2}/README.md

@@ -28,9 +28,14 @@
 
 ## Compatibility
 
-| Plugin version | NetBox version | Python    | PostgreSQL          |
-|----------------|----------------|-----------|---------------------|
-| 0.1.x          | 4.5.3+         | 3.12-3.14 | 16+ with PostGIS 3.4|
+| Plugin version  | NetBox version       | Python    | PostgreSQL           |
+|-----------------|----------------------|-----------|----------------------|
+| 0.1.x -- 0.2.1  | 4.5.3 -- 4.5.x       | 3.12-3.14 | 16+ with PostGIS 3.4+|
+| 0.2.2+          | 4.5.3+ (incl. 4.6.x) | 3.12-3.14 | 16+ with PostGIS 3.4+|
+
+> NetBox 4.6 ships Django 6.0. Plugin versions 0.2.1 and earlier do not render
+> the geometry map widget on NetBox 4.6 (issue #52); upgrade to 0.2.2 or later
+> for NetBox 4.6 support.
 
 ## Installation
 
@@ -149,6 +154,13 @@ Full documentation: **[jsenecal.github.io/netbox-pathways](https://jsenecal.gith
 - [Architecture](https://jsenecal.github.io/netbox-pathways/developer/architecture/)
 - [GeoJSON API reference](https://jsenecal.github.io/netbox-pathways/reference/geojson-api/)
 
+## Related plugins
+
+netbox-pathways is part of a three-plugin set that models the full optical transport stack:
+
+- **[netbox-fms](https://github.com/jsenecal/netbox-fms)** -- Fiber Management System. Defines fiber cable construction (buffer tubes, ribbons, strands), plans splices in closures, and provisions end-to-end fiber circuits. Pathways tracks *where cables run*; FMS tracks *what is inside them and how strands are spliced*.
+- **[netbox-wdm](https://github.com/jsenecal/netbox-wdm)** -- WDM (Wavelength Division Multiplexing) device management. Models ITU channel plans, ROADM mappings, and wavelength services that ride on top of the fiber circuits FMS provisions, over the cables routed through Pathways.
+
 ## Contributing
 
 PRs welcome. Use conventional-commits PR titles (`feat:`, `fix:`, `chore:`, `docs:`, ...) -- release-drafter assembles release notes from them. Run `make setup` after cloning to install dev dependencies and the pre-commit hooks (including the AI-attribution-rejecting `commit-msg` hook).

{netbox_pathways-0.2.0 → netbox_pathways-0.2.2}/netbox_pathways/__init__.py

@@ -2,7 +2,7 @@ import logging
 
 from netbox.plugins import PluginConfig
 
-__version__ = "0.2.0"
+__version__ = "0.2.2"
 
 logger = logging.getLogger(__name__)
 
@@ -89,8 +89,12 @@ class NetBoxPathwaysConfig(PluginConfig):
 
         super().ready()
 
-        # Register signals
+        from django.core.checks import register
+
         from . import signals  # noqa: F401
+        from .checks import check_geometry_column_srids
+
+        register(check_geometry_column_srids)
 
         logger.info("%s plugin loaded", self.name)
 

netbox_pathways-0.2.2/netbox_pathways/checks.py

@@ -0,0 +1,86 @@
+"""
+System checks for the netbox_pathways plugin.
+
+The storage SRID is baked into PostGIS columns at migrate time, but
+get_srid() is read from PLUGINS_CONFIG at form/serializer save time. If
+the two ever drift apart -- either because a migration shipped with a
+hardcoded SRID, or because an operator edited PLUGINS_CONFIG after
+applying migrations -- inserts fail with a SRID mismatch and crash the
+end user back to the home page (see issue #5).
+
+This module introspects geometry_columns and emits a checks.Error for
+every column whose stored SRID does not match get_srid(), with a hint
+that points at both remediation paths (revert config, or write an
+ST_Transform migration).
+"""
+
+from django.apps import apps
+from django.core.checks import Error
+from django.db import connection
+from django.db.utils import OperationalError, ProgrammingError
+
+from .geo import get_srid
+
+CHECK_ID = "netbox_pathways.E001"
+
+
+def _introspect_column_srids(connection, app_label):
+    """Return {(table, column): srid} for geometry columns in the app's tables."""
+    if connection.vendor != "postgresql":
+        return {}
+    try:
+        with connection.cursor() as cursor:
+            cursor.execute(
+                "SELECT f_table_name, f_geometry_column, srid FROM geometry_columns WHERE f_table_name LIKE %s",
+                [f"{app_label}_%"],
+            )
+            return {(row[0], row[1]): row[2] for row in cursor.fetchall()}
+    except (OperationalError, ProgrammingError):
+        return {}
+
+
+def check_geometry_column_srids(app_configs=None, **kwargs):
+    """Compare introspected column SRIDs to PLUGINS_CONFIG['netbox_pathways']['srid']."""
+    from django.core.exceptions import ImproperlyConfigured
+
+    try:
+        expected_srid = get_srid()
+    except ImproperlyConfigured:
+        return []
+
+    actual = _introspect_column_srids(connection, "netbox_pathways")
+    if not actual:
+        return []
+
+    try:
+        models = apps.get_app_config("netbox_pathways").get_models()
+    except LookupError:
+        return []
+
+    errors = []
+    for model in models:
+        table = model._meta.db_table
+        for field in model._meta.get_fields():
+            if not hasattr(field, "srid") or field.srid is None:
+                continue
+            actual_srid = actual.get((table, field.column))
+            if actual_srid is None or actual_srid == expected_srid:
+                continue
+            errors.append(
+                Error(
+                    f"Geometry column {table}.{field.column} has SRID {actual_srid}, "
+                    f"but PLUGINS_CONFIG['netbox_pathways']['srid'] is {expected_srid}. "
+                    "Form submissions and API writes will fail with 'Geometry SRID does "
+                    "not match column SRID'.",
+                    hint=(
+                        "Storage SRID is immutable after migrations apply. Either "
+                        f"set PLUGINS_CONFIG['netbox_pathways']['srid'] = {actual_srid} "
+                        "to match the existing columns, or write a data migration that "
+                        f"runs ST_Transform(<column>, {expected_srid}) on every affected "
+                        "row before re-typing the column."
+                    ),
+                    id=CHECK_ID,
+                    obj=model,
+                )
+            )
+    return errors

{netbox_pathways-0.2.0 → netbox_pathways-0.2.2}/netbox_pathways/forms.py

@@ -73,6 +73,14 @@ class PathwaysMapWidget(BaseGeometryWidget):
 
     def get_context(self, name, value, attrs):
         context = super().get_context(name, value, attrs)
+        # Django 6.0 stopped exposing id/name/geom_type at the top level of the
+        # widget context (they now live under ``widget``); our template reads
+        # them at the top level, so re-expose them here. setdefault keeps this
+        # backwards compatible with Django <= 5.2, which still sets them. (#52)
+        widget = context["widget"]
+        context.setdefault("id", widget["attrs"].get("id", ""))
+        context.setdefault("name", widget["name"])
+        context.setdefault("geom_type", widget["attrs"].get("geom_name", self.geom_type))
         if self.endpoint_geojson:
             context["endpoint_json"] = mark_safe(json.dumps(self.endpoint_geojson))  # noqa: S308
         return context

{netbox_pathways-0.2.0 → netbox_pathways-0.2.2}/netbox_pathways/migrations/0004_circuit_geometry.py

@@ -7,6 +7,10 @@ import taggit.managers
 import utilities.json
 from django.db import migrations, models
 
+from netbox_pathways.geo import get_srid
+
+_SRID = get_srid()
+
 
 class Migration(migrations.Migration):
 
@@ -24,7 +28,7 @@ class Migration(migrations.Migration):
                 ('created', models.DateTimeField(auto_now_add=True, null=True)),
                 ('last_updated', models.DateTimeField(auto_now=True, null=True)),
                 ('custom_field_data', models.JSONField(blank=True, default=dict, encoder=utilities.json.CustomFieldJSONEncoder)),
-                ('path', django.contrib.gis.db.models.fields.LineStringField(srid=3348)),
+                ('path', django.contrib.gis.db.models.fields.LineStringField(srid=_SRID)),
                 ('provider_reference', models.CharField(blank=True, max_length=200)),
                 ('comments', models.TextField(blank=True)),
                 ('circuit', models.OneToOneField(on_delete=django.db.models.deletion.CASCADE, related_name='pathways_route', to='circuits.circuit')),

{netbox_pathways-0.2.0 → netbox_pathways-0.2.2}/netbox_pathways.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: netbox-pathways
-Version: 0.2.0
+Version: 0.2.2
 Summary: NetBox plugin for physical cable plant infrastructure documentation with GIS capabilities
 Author-email: Jonathan Senecal <contact@jonathansenecal.com>
 Project-URL: Homepage, https://github.com/jsenecal/netbox-pathways
@@ -58,9 +58,14 @@ Requires-Dist: zensical; extra == "docs"
 
 ## Compatibility
 
-| Plugin version | NetBox version | Python    | PostgreSQL          |
-|----------------|----------------|-----------|---------------------|
-| 0.1.x          | 4.5.3+         | 3.12-3.14 | 16+ with PostGIS 3.4|
+| Plugin version  | NetBox version       | Python    | PostgreSQL           |
+|-----------------|----------------------|-----------|----------------------|
+| 0.1.x -- 0.2.1  | 4.5.3 -- 4.5.x       | 3.12-3.14 | 16+ with PostGIS 3.4+|
+| 0.2.2+          | 4.5.3+ (incl. 4.6.x) | 3.12-3.14 | 16+ with PostGIS 3.4+|
+
+> NetBox 4.6 ships Django 6.0. Plugin versions 0.2.1 and earlier do not render
+> the geometry map widget on NetBox 4.6 (issue #52); upgrade to 0.2.2 or later
+> for NetBox 4.6 support.
 
 ## Installation
 
@@ -179,6 +184,13 @@ Full documentation: **[jsenecal.github.io/netbox-pathways](https://jsenecal.gith
 - [Architecture](https://jsenecal.github.io/netbox-pathways/developer/architecture/)
 - [GeoJSON API reference](https://jsenecal.github.io/netbox-pathways/reference/geojson-api/)
 
+## Related plugins
+
+netbox-pathways is part of a three-plugin set that models the full optical transport stack:
+
+- **[netbox-fms](https://github.com/jsenecal/netbox-fms)** -- Fiber Management System. Defines fiber cable construction (buffer tubes, ribbons, strands), plans splices in closures, and provisions end-to-end fiber circuits. Pathways tracks *where cables run*; FMS tracks *what is inside them and how strands are spliced*.
+- **[netbox-wdm](https://github.com/jsenecal/netbox-wdm)** -- WDM (Wavelength Division Multiplexing) device management. Models ITU channel plans, ROADM mappings, and wavelength services that ride on top of the fiber circuits FMS provisions, over the cables routed through Pathways.
+
 ## Contributing
 
 PRs welcome. Use conventional-commits PR titles (`feat:`, `fix:`, `chore:`, `docs:`, ...) -- release-drafter assembles release notes from them. Run `make setup` after cloning to install dev dependencies and the pre-commit hooks (including the AI-attribution-rejecting `commit-msg` hook).

{netbox_pathways-0.2.0 → netbox_pathways-0.2.2}/netbox_pathways.egg-info/SOURCES.txt

@@ -1,6 +1,7 @@
 README.md
 pyproject.toml
 netbox_pathways/__init__.py
+netbox_pathways/checks.py
 netbox_pathways/choices.py
 netbox_pathways/filterforms.py
 netbox_pathways/filters.py
@@ -131,7 +132,9 @@ tests/test_graphql.py
 tests/test_import_geodata.py
 tests/test_lashed_with.py
 tests/test_map_view.py
+tests/test_map_widget.py
 tests/test_planned_route.py
 tests/test_registry.py
 tests/test_route_engine.py
-tests/test_routing.py
+tests/test_routing.py
+tests/test_srid_checks.py

{netbox_pathways-0.2.0 → netbox_pathways-0.2.2}/pyproject.toml

@@ -16,7 +16,7 @@ netbox_pathways = [
 
 [project]
 name = "netbox-pathways"
-version = "0.2.0"
+version = "0.2.2"
 description = "NetBox plugin for physical cable plant infrastructure documentation with GIS capabilities"
 readme = "README.md"
 authors = [
@@ -60,7 +60,7 @@ Tracker = "https://github.com/jsenecal/netbox-pathways/issues"
 Documentation = "https://jsenecal.github.io/netbox-pathways/"
 
 [tool.bumpversion]
-current_version = "0.2.0"
+current_version = "0.2.2"
 commit = true
 tag = true
 tag_name = "v{new_version}"

netbox_pathways-0.2.2/tests/test_map_widget.py

@@ -0,0 +1,35 @@
+"""Regression tests for PathwaysMapWidget rendering.
+
+Django 6.0 changed BaseGeometryWidget.get_context so it no longer exposes the
+top-level ``id``, ``name`` and ``geom_type`` context variables that the widget
+template relies on (they moved under ``widget``). Without compensation the
+hidden input renders with an empty ``name`` (so no geometry is submitted) and
+the map container renders with an empty ``data-field-id`` (so the JS bails and
+no map appears). See issue #52.
+"""
+
+from netbox_pathways.forms import PathwaysMapWidget
+
+
+def _render(widget):
+    return widget.render("location", None, attrs={"id": "id_location"})
+
+
+def test_hidden_input_keeps_field_name():
+    """The hidden geometry input must carry name="location" so the form submits a value."""
+    html = _render(PathwaysMapWidget(geom_type="Geometry"))
+    assert 'name="location"' in html
+    assert 'name=""' not in html
+
+
+def test_map_container_has_field_id():
+    """The map container needs a non-empty data-field-id for the JS to initialize."""
+    html = _render(PathwaysMapWidget(geom_type="Geometry"))
+    assert 'data-field-id="id_location"' in html
+    assert 'data-field-id=""' not in html
+
+
+def test_geom_type_is_exposed():
+    """The configured geometry type must reach the template's data-geom-type."""
+    assert 'data-geom-type="Geometry"' in _render(PathwaysMapWidget(geom_type="Geometry"))
+    assert 'data-geom-type="LineString"' in _render(PathwaysMapWidget(geom_type="LineString"))

netbox_pathways-0.2.2/tests/test_srid_checks.py

@@ -0,0 +1,73 @@
+"""Tests for SRID drift system check and migration consistency."""
+
+import importlib
+from copy import deepcopy
+from unittest.mock import MagicMock, patch
+
+from django.core.checks import Error
+from django.db import connection
+from django.db.utils import ProgrammingError
+
+from netbox_pathways.checks import (
+    _introspect_column_srids,
+    check_geometry_column_srids,
+)
+
+
+class TestMigrationSrid:
+    """Migrations must derive SRID from get_srid(), never from a literal."""
+
+    def test_circuit_geometry_path_srid_follows_config(self, settings):
+        settings.PLUGINS_CONFIG = deepcopy(settings.PLUGINS_CONFIG)
+        settings.PLUGINS_CONFIG.setdefault("netbox_pathways", {})["srid"] = 3857
+
+        mod = importlib.import_module("netbox_pathways.migrations.0004_circuit_geometry")
+        importlib.reload(mod)
+
+        operation = mod.Migration.operations[0]
+        fields_dict = dict(operation.fields)
+        assert fields_dict["path"].srid == 3857
+
+
+class TestIntrospectColumnSrids:
+    def test_returns_empty_for_non_postgres(self):
+        fake_conn = MagicMock()
+        fake_conn.vendor = "sqlite"
+        assert _introspect_column_srids(fake_conn, "netbox_pathways") == {}
+
+    def test_returns_empty_on_db_error(self):
+        fake_conn = MagicMock()
+        fake_conn.vendor = "postgresql"
+        cursor = fake_conn.cursor.return_value.__enter__.return_value
+        cursor.execute.side_effect = ProgrammingError("relation does not exist")
+        assert _introspect_column_srids(fake_conn, "netbox_pathways") == {}
+
+    def test_introspects_real_columns(self, db):
+        result = _introspect_column_srids(connection, "netbox_pathways")
+        assert ("netbox_pathways_structure", "location") in result
+
+
+class TestCheckGeometryColumnSrids:
+    def test_silent_when_srid_unconfigured(self):
+        from django.core.exceptions import ImproperlyConfigured
+
+        with patch("netbox_pathways.checks.get_srid", side_effect=ImproperlyConfigured()):
+            assert check_geometry_column_srids() == []
+
+    def test_silent_when_no_columns_introspected(self):
+        with patch("netbox_pathways.checks._introspect_column_srids", return_value={}):
+            assert check_geometry_column_srids() == []
+
+    def test_no_errors_when_columns_match_config(self, db):
+        assert check_geometry_column_srids() == []
+
+    def test_reports_error_on_mismatch(self, db):
+        with patch("netbox_pathways.checks.get_srid", return_value=999):
+            errors = check_geometry_column_srids()
+        assert errors, "expected at least one mismatch error"
+        assert all(isinstance(e, Error) for e in errors)
+        assert all(e.id == "netbox_pathways.E001" for e in errors)
+        first = errors[0]
+        assert "999" in first.msg
+        assert "PLUGINS_CONFIG" in first.hint
+        assert "ST_Transform" in first.hint