Sort component IDs in exceptions

These component IDs are stored in sets, which don't have a order
guarantee, and looking at component IDs in exceptions with random order
makes it hard to identify if a particular component is in the list or
not.

This also makes it easier to write tests that are not flaky or depend
on the component's order.

To improve the exceptions also `", ".join()` is used to get less noise
in the exception message (like `frozenset({4, 2, 6})` vs `2, 4, 5`).
This makes exceptions easier to read because it is easier to look for
a component ID

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

src/frequenz/sdk/microgrid/_power_managing/_matryoshka.py

@@ -144,8 +144,9 @@ def _validate_component_ids(
 
             for bucket in self._component_buckets:
                 if any(component_id in bucket for component_id in component_ids):
+                    comp_ids = ", ".join(map(str, sorted(component_ids)))
                     raise NotImplementedError(
-                        f"PowerManagingActor: component IDs {component_ids} are already"
+                        f"PowerManagingActor: component IDs {comp_ids} are already"
                         " part of another bucket.  Overlapping buckets are not"
                         " yet supported."
                     )

src/frequenz/sdk/microgrid/component_graph.py

@@ -915,14 +915,14 @@ def _validate_graph(self) -> None:
         # This check doesn't seem to have much sense, it only search for nodes without
         # data associated with them. We leave it here for now, but we should consider
         # removing it in the future.
-        undefined: list[int] = [
+        if undefined := [
             node[0] for node in self._graph.nodes(data=True) if len(node[1]) == 0
-        ]
-
-        if len(undefined) > 0:
+        ]:
+            undefined_str = ", ".join(map(str, sorted(undefined)))
             raise InvalidGraphError(
-                f"Missing definition for graph components: {undefined}"
+                f"Missing definition for graph components: {undefined_str}"
             )
+
         # should be true as a consequence of checks above
         if sum(1 for _ in self.components()) <= 0:
             raise InvalidGraphError("Graph must have a least one component!")

tests/actor/_power_managing/test_matryoshka.py

@@ -435,8 +435,8 @@ async def test_matryoshka_drop_old_proposals() -> None:
     with pytest.raises(
         NotImplementedError,
         match=re.escape(
-            "PowerManagingActor: component IDs frozenset({8, 5}) are already "
-            + "part of another bucket.  Overlapping buckets are not yet supported."
+            "PowerManagingActor: component IDs 5, 8 are already part of "
+            "another bucket.  Overlapping buckets are not yet supported."
         ),
     ):
         tester.tgt_power(
@@ -506,8 +506,8 @@ def ensure_overlapping_bucket_request_fails() -> None:
         with pytest.raises(
             NotImplementedError,
             match=re.escape(
-                "PowerManagingActor: component IDs frozenset({8, 5}) are already "
-                + "part of another bucket.  Overlapping buckets are not yet supported."
+                "PowerManagingActor: component IDs 5, 8 are already part of "
+                "another bucket.  Overlapping buckets are not yet supported."
             ),
         ):
             tester.tgt_power(