cloudmap 1.3.0__tar.gz → 1.3.1__tar.gz

{cloudmap-1.3.0 → cloudmap-1.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: cloudmap
-Version: 1.3.0
+Version: 1.3.1
 Summary: Trace the blast radius of an Azure resource: one name in, a verified dependency graph out.
 Project-URL: Homepage, https://github.com/KatsaounisThanasis/cloudmap
 Project-URL: Repository, https://github.com/KatsaounisThanasis/cloudmap

{cloudmap-1.3.0 → cloudmap-1.3.1}/cloudmap/__init__.py

@@ -1,3 +1,3 @@
 """cloudmap - trace an Azure resource's full dependency graph and export it."""
 
-__version__ = "1.3.0"
+__version__ = "1.3.1"

{cloudmap-1.3.0 → cloudmap-1.3.1}/cloudmap/ask/__init__.py

@@ -67,10 +67,10 @@ def _no_subject(graph, default):
         return default
     groups = sorted({n.name for n in graph.nodes.values()
                      if str(n.id).startswith(HIGH_LEVEL_PREFIXES)})
-    return ("This map is the high-level view: resources are grouped into one box per "
-            "type, so instance names do not exist in it. Ask about a group instead "
-            f"({', '.join(groups[:6])}{', ...' if len(groups) > 6 else ''}), or re-run "
-            "the trace with --level detail to keep instance names.")
+    return ("This map is the high-level view: types with several instances are "
+            "grouped into one box, so that name is not on it. Ask about a group "
+            f"instead ({', '.join(groups[:6])}{', ...' if len(groups) > 6 else ''}), "
+            "or re-run the trace with --level detail to keep every instance name.")
 
 
 def _error(message, query=None):

{cloudmap-1.3.0 → cloudmap-1.3.1}/cloudmap/graph.py

@@ -101,14 +101,25 @@ def collapse_high_level(graph, seed_id):
         if gkey == seed_id:
             new_nodes[gkey] = rep
         else:
-            label = rep.type.split("/", 1)[-1] if rep.external else friendly_type(rep.type)
-            if len(members) > 1:
-                label += f" ×{len(members)}"
+            role = rep.type.split("/", 1)[-1] if rep.external else friendly_type(rep.type)
+            # Grouping exists for readability, not anonymity: when a "group" has
+            # exactly one member, hiding its name buys nothing and costs the one
+            # thing the reader needs - WHICH vault, WHICH workspace this is.
+            if len(members) == 1:
+                label = rep.name or role
+            else:
+                label = f"{role} ×{len(members)}"
             # an external group keeps its members' reasons: "why is this unverified"
             # must not be lost to grouping either
             note = ""
             for m in members:
                 note = _merge_semis(note, graph.nodes[m].note)
+            if len(members) > 1:
+                # the instance names survive collapsing - on hover in the HTML
+                # viewer, in the drawio tooltip and in `ask` answers
+                shown = sorted(graph.nodes[m].name for m in members)[:8]
+                more = "" if len(members) <= 8 else f", +{len(members) - 8} more"
+                note = _merge_semis(note, "instances: " + ", ".join(shown) + more)
             new_nodes[gkey] = Node(id=gkey, name=label, type=rep.type,
                                    external=rep.external, note=note)
         distances[gkey] = dist

{cloudmap-1.3.0 → cloudmap-1.3.1}/tests/test_ask.py

@@ -343,18 +343,45 @@ def test_warnings_stay_quiet_on_a_clean_map():
     assert warnings(graph) == []
 
 
-def test_high_level_map_explains_itself_instead_of_stonewalling():
-    # The default trace writes the collapsed view, so this is the error people
-    # actually hit: the vault IS on their diagram, inside a "Key Vault" box, and
-    # "name a resource from this map" sends them hunting for a typo.
+def test_a_singleton_group_keeps_its_name_so_asking_about_it_just_works():
+    # Grouping is for readability, not anonymity: with one vault in the map,
+    # the box carries its real name and the question answers directly.
     graph, seed = _real()
     collapsed = collapse_high_level(blast_radius(graph, seed), seed)
     res = answer(collapsed, "what breaks if I touch kv-orders-dev")
 
+    assert not res.get("error")
+    assert res["subject_name"] == "kv-orders-dev"
+
+
+def test_high_level_map_explains_itself_instead_of_stonewalling():
+    # With SEVERAL vaults the box really is anonymous ("Key Vault ×2"), so this
+    # is the error people actually hit: the vault IS on their diagram, inside
+    # the group box, and "name a resource" sends them hunting for a typo.
+    S = "/subscriptions/s/resourcegroups/rg/providers"
+    rows = [
+        {"id": f"{S}/microsoft.web/sites/web", "name": "web", "type": "microsoft.web/sites",
+         "properties": {"siteConfig": {"appSettings": [
+             {"name": "A", "value": "https://kv-orders-dev.vault.azure.net/"},
+             {"name": "B", "value": "https://kv-payments-dev.vault.azure.net/"}]}}},
+        {"id": f"{S}/microsoft.keyvault/vaults/kv-orders-dev", "name": "kv-orders-dev",
+         "type": "microsoft.keyvault/vaults",
+         "properties": {"vaultUri": "https://kv-orders-dev.vault.azure.net/"}},
+        {"id": f"{S}/microsoft.keyvault/vaults/kv-payments-dev", "name": "kv-payments-dev",
+         "type": "microsoft.keyvault/vaults",
+         "properties": {"vaultUri": "https://kv-payments-dev.vault.azure.net/"}},
+    ]
+    graph = build_graph(rows)
+    seed = find_seeds(graph, "web")[0]
+    collapsed = collapse_high_level(blast_radius(graph, seed), seed)
+    res = answer(collapsed, "what breaks if I touch kv-orders-dev")
+
     assert res["error"]
     assert "high-level view" in res["error"]
     assert "--level detail" in res["error"]
-    assert "Key Vault" in res["error"]            # names a group they can actually ask about
+    assert "Key Vault ×2" in res["error"]         # names a group they can actually ask about
+    grouped = next(n for n in collapsed.nodes.values() if "×2" in n.name)
+    assert "kv-orders-dev" in grouped.note        # the names survive in the note
 
 
 def test_high_level_map_warns_that_counts_are_per_type():

{cloudmap-1.3.0 → cloudmap-1.3.1}/tests/test_cli_exports.py

@@ -142,7 +142,9 @@ def test_a_live_trace_seeded_by_arm_id_renders_valid_xml(tmp_path, monkeypatch):
     labels = {o.get("label") for o in ET.parse(tmp_path / "map.drawio").getroot().iter("object")}
 
     assert "web (sites)" in labels
-    assert "Key Vault (vaults)" in labels           # default view groups by type
+    # the default view groups by type, but a group of ONE keeps its name -
+    # a box saying just "Key Vault" answers the wrong question (which one?)
+    assert "kv-1 (vaults)" in labels
 
 
 def _capture_stubs(monkeypatch, rows, truncated=False):