Merge pull request #54 from Jackass4life/copilot/fix-docker-compose-redis-error

Fix docker-compose usage and resolve Nautobot 3.x brief tag objects in CI

Author: Jackass4life

README.md

@@ -70,9 +70,16 @@ python app.py
 
 ## Docker
 
+> **Important:** Always use `docker compose up` — **not** `docker compose build && docker compose start`.
+> The `start` sub-command only restarts previously created containers and will
+> fail with *"service … has no container to start"* on a fresh checkout.
+> `docker compose up` handles building, creating, and starting in one step.
+
 ```bash
-# Build and run with Docker Compose
-cp .env.example .env   # fill in your values
+# 1. Configure environment variables
+cp .env.example .env   # fill in NAUTOBOT_URL and NAUTOBOT_TOKEN
+
+# 2. Build images and start containers
 docker compose up --build -d
 # → Open http://localhost:5000
 
@@ -83,11 +90,6 @@ docker compose logs -f
 docker compose down
 ```
 
-> **Note:** Always use `docker compose up` (not `docker compose start`) to create
-> and start the containers.  The `start` sub-command only restarts previously
-> created containers and will fail with *"has no container to start"* on a fresh
-> checkout.
-
 ## Demo (Mock Nautobot)
 
 No Nautobot instance? Spin up a fully self-contained demo using the mock

app.py

@@ -223,6 +223,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/")
+    tag_map = _build_id_name_map("extras/tags/")
     tenant_group_map = _build_tenant_group_map()
 
     # Build a location id → name map from the raw data for parent resolution.
@@ -286,10 +287,19 @@ def get_locations() -> list:
         tenant_group_name = tenant_group_map.get(tenant_id, "")
 
         # Tags – each tag is a nested object with at least a name/display key.
+        # In Nautobot 3.x brief tag objects may only contain id+url, so fall
+        # back to the pre-built tag_map.
         raw_tags = loc.get("tags") or []
         tag_names = []
         for t in raw_tags:
-            tag_name = _nested_str(t, "name", "display") if isinstance(t, dict) else ""
+            if isinstance(t, dict):
+                tag_id = t.get("id", "")
+                tag_name = (
+                    _nested_str(t, "name", "display")
+                    or tag_map.get(tag_id, "")
+                )
+            else:
+                tag_name = ""
             if tag_name:
                 tag_names.append(tag_name)
 

development/seed_nautobot.py

@@ -92,17 +92,39 @@ def _post(endpoint: str, data: dict) -> dict:
     return resp.json()
 
 
+def _patch(url: str, data: dict) -> dict:
+    """PATCH helper with error handling."""
+    resp = session.patch(url, json=data, timeout=30)
+    if not resp.ok:
+        try:
+            body = resp.json()
+        except Exception:
+            body = resp.text[:500]
+        print(f"  ERROR {resp.status_code} PATCH {url}: {body}", file=sys.stderr)
+    resp.raise_for_status()
+    return resp.json()
+
+
 def get_or_create(endpoint: str, data: dict, lookup: dict | None = None) -> dict:
     """
     Return an existing object or create a new one.
+    If the object exists, update it with the new data.
 
     *lookup* defaults to ``{"name": data["name"]}`` if not given.
     """
     lookup = lookup or {"name": data.get("name", data.get("model", ""))}
     results = _get(endpoint, params=lookup).get("results", [])
     if results:
-        print(f"  ↳ found  {endpoint}  {lookup}")
-        return results[0]
+        existing = results[0]
+        obj_url = existing.get("url")
+        if obj_url:
+            # Update the existing object with new data
+            obj = _patch(obj_url, data)
+            print(f"  ↳ updated {endpoint}  {lookup}")
+            return obj
+        else:
+            print(f"  ↳ found  {endpoint}  {lookup}")
+            return existing
 
     obj = _post(endpoint, data)
     print(f"  ↳ created {endpoint}  {lookup}")

docker-compose.yml

@@ -1,3 +1,14 @@
+# docker-compose.yml - Nautobot Maps (production / quick-start)
+#
+# Start:   docker compose up --build -d
+# Logs:    docker compose logs -f
+# Stop:    docker compose down
+#
+# NOTE: Do NOT use "docker compose build && docker compose start".
+# "start" only restarts previously created containers and will fail with
+# "has no container to start" on a fresh checkout.  Always use
+# "docker compose up" which both creates and starts containers.
+
 services:
   redis:
     image: redis:7-alpine

tests/test_app.py

@@ -212,6 +212,56 @@ def test_tags_empty_when_none(self, client):
         loc = resp.get_json()["locations"][1]
         assert loc["tags"] == []
 
+    def test_tags_fallback_with_brief_nested_object(self, client):
+        """When tags are brief (id+url only), the fallback map resolves names."""
+        brief_locations = {
+            "count": 1,
+            "next": None,
+            "results": [
+                {
+                    "id": "loc-tags",
+                    "name": "Tagged Location",
+                    "slug": "tagged-loc",
+                    "status": {"label": "Active"},
+                    "location_type": {"name": "Data Center"},
+                    "parent": None,
+                    "latitude": "55.0",
+                    "longitude": "12.0",
+                    "description": "",
+                    "physical_address": "",
+                    "tenant": None,
+                    "asn": None,
+                    "time_zone": "",
+                    "facility": "",
+                    "tags": [
+                        {"id": "tag-1", "url": "http://nautobot/api/extras/tags/tag-1/"},
+                        {"id": "tag-2", "url": "http://nautobot/api/extras/tags/tag-2/"},
+                    ],
+                    "url": "",
+                },
+            ],
+        }
+        tags_page = {
+            "count": 2,
+            "next": None,
+            "results": [
+                {"id": "tag-1", "name": "critical"},
+                {"id": "tag-2", "name": "production"},
+            ],
+        }
+
+        def mock_get(endpoint, params=None):
+            if "extras/tags" in endpoint:
+                return tags_page
+            if "dcim/locations" in endpoint:
+                return brief_locations
+            return {"count": 0, "next": None, "results": []}
+
+        with patch.object(flask_app, "nautobot_get", side_effect=mock_get):
+            resp = client.get("/api/locations")
+        loc = resp.get_json()["locations"][0]
+        assert loc["tags"] == ["critical", "production"]
+
     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 = {