Use the new MicrogridInfo object

The name in the microgrid API will be changed again to `Microgrid` in
the near future, so internally we just use `microgrid` instead of
`microgrid_info`.

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

Author: llucax

src/frequenz/sdk/microgrid/connection_manager.py

@@ -12,7 +12,7 @@
 from abc import ABC, abstractmethod
 
 from frequenz.client.common.microgrid import MicrogridId
-from frequenz.client.microgrid import Location, Metadata, MicrogridApiClient
+from frequenz.client.microgrid import Location, MicrogridApiClient, MicrogridInfo
 
 from .component_graph import ComponentGraph, _MicrogridComponentGraph
 
@@ -103,8 +103,8 @@ def __init__(self, server_url: str) -> None:
         # So create empty graph here, and update it in `run` method.
         self._graph = _MicrogridComponentGraph()
 
-        self._metadata: Metadata
-        """The metadata of the microgrid."""
+        self._microgrid: MicrogridInfo
+        """The microgrid information."""
 
     @property
     def api_client(self) -> MicrogridApiClient:
@@ -118,7 +118,7 @@ def microgrid_id(self) -> MicrogridId | None:
         Returns:
             the ID of the microgrid if available, None otherwise.
         """
-        return self._metadata.microgrid_id
+        return self._microgrid.id
 
     @property
     def location(self) -> Location | None:
@@ -127,7 +127,7 @@ def location(self) -> Location | None:
         Returns:
             the location of the microgrid if available, None otherwise.
         """
-        return self._metadata.location
+        return self._microgrid.location
 
     @property
     def component_graph(self) -> ComponentGraph:
@@ -155,7 +155,7 @@ async def _update_client(self, server_url: str) -> None:
         await self._initialize()
 
     async def _initialize(self) -> None:
-        self._metadata = await self._client.get_microgrid_info()
+        self._microgrid = await self._client.get_microgrid_info()
         await self._graph.refresh_from_client(self._client)
 
 

tests/microgrid/test_microgrid_api.py

@@ -17,11 +17,13 @@
     ComponentCategory,
     Connection,
     Location,
-    Metadata,
+    MicrogridInfo,
 )
 
 from frequenz.sdk.microgrid import connection_manager
 
+_MICROGRID_ID = MicrogridId(1)
+
 
 class TestMicrogridApi:
     """Test for MicropgridApi."""
@@ -91,17 +93,25 @@ def connections(self) -> list[list[Connection]]:
         return connections
 
     @pytest.fixture
-    def metadata(self) -> Metadata:
-        """Fetch the microgrid metadata.
+    def microgrid(self) -> MicrogridInfo:
+        """Fetch the microgrid information.
 
         Returns:
-            the microgrid metadata.
+            the information about the microgrid
         """
-        return Metadata(
-            microgrid_id=MicrogridId(8),
+        return MicrogridInfo(
+            id=_MICROGRID_ID,
+            enterprise_id=EnterpriseId(1),
+            name="test",
+            delivery_area=DeliveryArea(
+                code="test", code_type=EnergyMarketCodeType.EUROPE_EIC
+            ),
+            status=MicrogridStatus.ACTIVE,
+            create_timestamp=datetime.now(tz=timezone.utc),
             location=Location(
                 latitude=52.520008,
                 longitude=13.404954,
+                country_code="DE",
             ),
         )
 
@@ -111,15 +121,15 @@ async def test_connection_manager(
         _insecure_channel_mock: MagicMock,
         components: list[list[Component]],
         connections: list[list[Connection]],
-        metadata: Metadata,
+        microgrid: MicrogridInfo,
     ) -> None:
         """Test microgrid api.
 
         Args:
             _insecure_channel_mock: insecure channel mock from `mock.patch`
             components: components
             connections: connections
-            metadata: the metadata of the microgrid
+            microgrid: the information about the microgrid
         """
         microgrid_client = MagicMock()
         microgrid_client.list_components = AsyncMock(side_effect=components)
@@ -167,8 +177,8 @@ async def test_connection_manager(
             assert set(graph.components()) == set(components[0])
             assert set(graph.connections()) == set(connections[0])
 
-            assert api.microgrid_id == metadata.microgrid_id
-            assert api.location == metadata.location
+            assert api.microgrid_id == microgrid.id
+            assert api.location == microgrid.location
 
             # It should not be possible to initialize method once again
             with pytest.raises(AssertionError):
@@ -181,24 +191,24 @@ async def test_connection_manager(
             assert set(graph.components()) == set(components[0])
             assert set(graph.connections()) == set(connections[0])
 
-            assert api.microgrid_id == metadata.microgrid_id
-            assert api.location == metadata.location
+            assert api.microgrid_id == microgrid.id
+            assert api.location == microgrid.location
 
     @mock.patch("grpc.aio.insecure_channel")
     async def test_connection_manager_another_method(
         self,
         _insecure_channel_mock: MagicMock,
         components: list[list[Component]],
         connections: list[list[Connection]],
-        metadata: Metadata,
+        microgrid: MicrogridInfo,
     ) -> None:
         """Test if the api was not deallocated.
 
         Args:
             _insecure_channel_mock: insecure channel mock
             components: components
             connections: connections
-            metadata: the metadata of the microgrid
+            microgrid: the information about the microgrid
         """
         microgrid_client = MagicMock()
         microgrid_client.components = AsyncMock(return_value=[])
@@ -210,5 +220,5 @@ async def test_connection_manager_another_method(
         assert set(graph.components()) == set(components[0])
         assert set(graph.connections()) == set(connections[0])
 
-        assert api.microgrid_id == metadata.microgrid_id
-        assert api.location == metadata.location
+        assert api.microgrid_id == microgrid.id
+        assert api.location == microgrid.location