feat: add tenant group filter to map UI

Add a "Tenant Group" filter dropdown to the sidebar filter section.
Locations are resolved to their tenant group via the tenant's
tenant_group field in the Nautobot API.

Changes:
- app.py: add _build_tenant_group_map() helper and tenant_group field
- templates/index.html: add filter-tenant-group select element
- static/js/map.js: populate, apply, and clear tenant group filter
- demo/mock_nautobot.py: add TENANT_GROUPS seed data and endpoint
- tests: add unit and integration tests for tenant_group

Co-authored-by: Jackass4life <94110786+Jackass4life@users.noreply.github.com>
Agent-Logs-Url: https://github.com/Jackass4life/Nautobot-maps/sessions/8a5b4fe1-ccd3-406f-be2a-4124fd563b8e

Author: Copilot

app.py

@@ -122,6 +122,37 @@ def _build_device_type_maps() -> tuple:
         return {}, {}
 
 
+def _build_tenant_group_map() -> dict:
+    """Return ``{tenant_id: tenant_group_name}``.
+
+    Fetches all tenants and resolves each tenant's ``tenant_group`` field so
+    that locations can expose the tenant group without extra per-location API
+    calls.  A fallback name-map for tenant groups is built from the
+    ``tenancy/tenant-groups/`` endpoint for Nautobot builds where the nested
+    object is brief (id + url only).
+    """
+    try:
+        tg_name_map = _build_id_name_map("tenancy/tenant-groups/")
+        tenants = fetch_all_pages("tenancy/tenants/")
+        result: dict = {}
+        for tenant in tenants:
+            tid = tenant.get("id")
+            if not tid:
+                continue
+            tg_obj = tenant.get("tenant_group") or {}
+            tg_id = tg_obj.get("id", "") if isinstance(tg_obj, dict) else ""
+            tg_name = (
+                _nested_str(tg_obj, "name", "display")
+                or tg_name_map.get(tg_id, "")
+            )
+            if tg_name:
+                result[tid] = tg_name
+        return result
+    except Exception as exc:
+        logger.debug("Could not build tenant group map: %s", exc)
+        return {}
+
+
 def _cache_get(key: str):
     entry = _cache.get(key)
     if entry and time.time() - entry["ts"] < CACHE_TTL:
@@ -187,6 +218,7 @@ def get_locations() -> list:
     tenant_map = _build_id_name_map("tenancy/tenants/")
     status_map = _build_id_name_map("extras/statuses/")
     lt_map = _build_id_name_map("dcim/location-types/")
+    tenant_group_map = _build_tenant_group_map()
 
     # Build a location id → name map from the raw data for parent resolution.
     # Parents are locations themselves, and their nested objects may also be
@@ -246,6 +278,8 @@ def get_locations() -> list:
             or loc_name_map.get(parent_id, "")
         )
 
+        tenant_group_name = tenant_group_map.get(tenant_id, "")
+
         locations.append(
             {
                 "id": loc.get("id", ""),
@@ -260,6 +294,7 @@ def get_locations() -> list:
                 "physical_address": loc.get("physical_address", ""),
                 "tenant": tenant_name,
                 "tenant_id": tenant_id,
+                "tenant_group": tenant_group_name,
                 "asn": loc.get("asn"),
                 "time_zone": loc.get("time_zone", ""),
                 "url": loc.get("url", ""),

demo/mock_nautobot.py

@@ -21,11 +21,16 @@
 # Seed data
 # ---------------------------------------------------------------------------
 
+TENANT_GROUPS = {
+    "tg-corp":    {"id": "tg-corp",    "name": "Corporate",   "slug": "corporate"},
+    "tg-infra":   {"id": "tg-infra",   "name": "Infrastructure", "slug": "infrastructure"},
+}
+
 TENANTS = {
-    "ten-acme":    {"id": "ten-acme",    "name": "Acme Corp",       "slug": "acme-corp"},
-    "ten-nordnet": {"id": "ten-nordnet", "name": "Nordic Net",      "slug": "nordic-net"},
-    "ten-euroix":  {"id": "ten-euroix",  "name": "EuroIX",          "slug": "euroix"},
-    "ten-dcgmbh":  {"id": "ten-dcgmbh",  "name": "DataCenter GmbH", "slug": "datacenter-gmbh"},
+    "ten-acme":    {"id": "ten-acme",    "name": "Acme Corp",       "slug": "acme-corp",       "tenant_group": TENANT_GROUPS["tg-corp"]},
+    "ten-nordnet": {"id": "ten-nordnet", "name": "Nordic Net",      "slug": "nordic-net",      "tenant_group": TENANT_GROUPS["tg-infra"]},
+    "ten-euroix":  {"id": "ten-euroix",  "name": "EuroIX",          "slug": "euroix",          "tenant_group": TENANT_GROUPS["tg-infra"]},
+    "ten-dcgmbh":  {"id": "ten-dcgmbh",  "name": "DataCenter GmbH", "slug": "datacenter-gmbh", "tenant_group": None},
 }
 
 LOCATION_TYPES = {
@@ -482,6 +487,12 @@ def tenants():
     return jsonify(_paginate(list(TENANTS.values())))
 
 
+@app.route("/api/tenancy/tenant-groups/")
+def tenant_groups():
+    _check_auth()
+    return jsonify(_paginate(list(TENANT_GROUPS.values())))
+
+
 @app.route("/api/extras/statuses/")
 def statuses():
     _check_auth()

static/js/map.js

@@ -515,12 +515,14 @@ const filterStatus = document.getElementById("filter-status");
 const filterType = document.getElementById("filter-type");
 const filterParent = document.getElementById("filter-parent");
 const filterTenant = document.getElementById("filter-tenant");
+const filterTenantGroup = document.getElementById("filter-tenant-group");
 
 function populateFilters(locations) {
   const statuses = [...new Set(locations.map((l) => l.status).filter(Boolean))].sort();
   const types = [...new Set(locations.map((l) => l.location_type).filter(Boolean))].sort();
   const parents = [...new Set(locations.map((l) => l.parent).filter(Boolean))].sort();
   const tenants = [...new Set(locations.map((l) => l.tenant).filter(Boolean))].sort();
+  const tenantGroups = [...new Set(locations.map((l) => l.tenant_group).filter(Boolean))].sort();
 
   filterStatus.innerHTML = '<option value="">All statuses</option>';
   for (const status of statuses) {
@@ -553,19 +555,29 @@ function populateFilters(locations) {
     opt.textContent = tenant;
     filterTenant.appendChild(opt);
   }
+
+  filterTenantGroup.innerHTML = '<option value="">All tenant groups</option>';
+  for (const group of tenantGroups) {
+    const opt = document.createElement("option");
+    opt.value = group;
+    opt.textContent = group;
+    filterTenantGroup.appendChild(opt);
+  }
 }
 
 function applyFilters() {
   const statusVal = filterStatus.value;
   const typeVal = filterType.value;
   const parentVal = filterParent.value;
   const tenantVal = filterTenant.value;
+  const tenantGroupVal = filterTenantGroup.value;
 
   const filtered = allLocations.filter((loc) => {
     if (statusVal && loc.status !== statusVal) return false;
     if (typeVal && loc.location_type !== typeVal) return false;
     if (parentVal && loc.parent !== parentVal) return false;
     if (tenantVal && loc.tenant !== tenantVal) return false;
+    if (tenantGroupVal && loc.tenant_group !== tenantGroupVal) return false;
     return true;
   });
 
@@ -577,13 +589,15 @@ filterStatus.addEventListener("change", applyFilters);
 filterType.addEventListener("change", applyFilters);
 filterParent.addEventListener("change", applyFilters);
 filterTenant.addEventListener("change", applyFilters);
+filterTenantGroup.addEventListener("change", applyFilters);
 
 // Clear filters button
 document.getElementById("clear-filters").addEventListener("click", () => {
   filterStatus.value = "";
   filterType.value = "";
   filterParent.value = "";
   filterTenant.value = "";
+  filterTenantGroup.value = "";
   applyFilters();
 });
 

templates/index.html

@@ -64,6 +64,9 @@ <h1>
       <select id="filter-tenant" title="Filter by tenant">
         <option value="">All tenants</option>
       </select>
+      <select id="filter-tenant-group" title="Filter by tenant group">
+        <option value="">All tenant groups</option>
+      </select>
       <button id="clear-filters" title="Clear all filters" style="margin-top:8px;padding:6px 12px;background:#6c757d;color:white;border:none;border-radius:4px;cursor:pointer;font-size:0.85rem">
         Clear Filters
       </button>

tests/test_app.py

@@ -33,7 +33,7 @@ def client():
             "longitude": "12.5683",
             "description": "Main DC",
             "physical_address": "Somestreet 1, Copenhagen",
-            "tenant": {"id": "ten-1", "name": "Acme Corp"},
+            "tenant": {"id": "ten-1", "name": "Acme Corp", "tenant_group": {"id": "tg-1", "name": "Corporate"}},
             "asn": 65001,
             "time_zone": "Europe/Copenhagen",
             "url": "https://nautobot.example.com/api/dcim/locations/loc-1/",
@@ -118,6 +118,18 @@ def mock_nautobot_get(endpoint, params=None):
         return SAMPLE_DEVICES_PAGE
     if "ipam/asns" in endpoint:
         return SAMPLE_ASNS_PAGE
+    if "tenancy/tenant-groups" in endpoint:
+        return {
+            "count": 1, "next": None,
+            "results": [{"id": "tg-1", "name": "Corporate"}],
+        }
+    if "tenancy/tenants" in endpoint:
+        return {
+            "count": 1, "next": None,
+            "results": [
+                {"id": "ten-1", "name": "Acme Corp", "tenant_group": {"id": "tg-1", "name": "Corporate"}},
+            ],
+        }
     return {"count": 0, "next": None, "results": []}
 
 
@@ -157,6 +169,19 @@ def test_parent_field_populated(self, client):
         loc = resp.get_json()["locations"][0]
         assert loc["parent"] == "Denmark"
 
+    def test_tenant_group_field_populated(self, client):
+        with patch.object(flask_app, "nautobot_get", side_effect=mock_nautobot_get):
+            resp = client.get("/api/locations")
+        loc = resp.get_json()["locations"][0]
+        assert loc["tenant_group"] == "Corporate"
+
+    def test_tenant_group_empty_when_no_tenant(self, client):
+        with patch.object(flask_app, "nautobot_get", side_effect=mock_nautobot_get):
+            resp = client.get("/api/locations")
+        # loc-2 (Aarhus PoP) has no tenant
+        loc = resp.get_json()["locations"][1]
+        assert loc["tenant_group"] == ""
+
     def test_location_type_fallback_with_brief_nested_object(self, client):
         """When location_type is brief (id+url only), the fallback map resolves the name."""
         brief_locations = {
@@ -455,6 +480,10 @@ def test_index_contains_filter_section(self, client):
         resp = client.get("/")
         assert b'id="filter-section"' in resp.data
 
+    def test_index_contains_filter_tenant_group(self, client):
+        resp = client.get("/")
+        assert b'id="filter-tenant-group"' in resp.data
+
 
 
 # ---------------------------------------------------------------------------

tests/test_integration.py

@@ -133,6 +133,17 @@ def test_tenant_field_populated(self, integration_client):
         cph = next(l for l in data["locations"] if l["name"] == "Copenhagen DC")
         assert cph["tenant"] == "Acme Corp"
 
+    def test_tenant_group_field_populated(self, integration_client):
+        data = integration_client.get("/api/locations").get_json()
+        cph = next(l for l in data["locations"] if l["name"] == "Copenhagen DC")
+        assert cph["tenant_group"] == "Corporate"
+
+    def test_tenant_group_empty_when_no_group(self, integration_client):
+        """Frankfurt DC has tenant DataCenter GmbH which has no tenant group."""
+        data = integration_client.get("/api/locations").get_json()
+        fra = next(l for l in data["locations"] if l["name"] == "Frankfurt DC")
+        assert fra["tenant_group"] == ""
+
     def test_asn_field_populated(self, integration_client):
         data = integration_client.get("/api/locations").get_json()
         cph = next(l for l in data["locations"] if l["name"] == "Copenhagen DC")