Amend tests to reflect microgrid metadata changes

Signed-off-by: Daniel Zullo <[email protected]>

Author: daniel-zullo-frequenz

tests/microgrid/test_microgrid_api.py

@@ -13,6 +13,7 @@
 from frequenz.sdk.microgrid import connection_manager
 from frequenz.sdk.microgrid.client import Connection
 from frequenz.sdk.microgrid.component import Component, ComponentCategory
+from frequenz.sdk.microgrid.metadata import Location, Metadata
 
 
 class TestMicrogridApi:
@@ -82,23 +83,39 @@ def connections(self) -> list[list[Connection]]:
         ]
         return connections
 
+    # ignore mypy: Untyped decorator makes function "components" untyped
+    @pytest.fixture
+    def metadata(self) -> Metadata:
+        """Fetch the microgrid metadata.
+
+        Returns:
+            the microgrid metadata.
+        """
+        return Metadata(
+            microgrid_id=8,
+            location=Location(latitude=52.520008, longitude=13.404954),
+        )
+
     @mock.patch("grpc.aio.insecure_channel")
     async def test_connection_manager(
         self,
         _: MagicMock,
         components: list[list[Component]],
         connections: list[list[Connection]],
+        metadata: Metadata,
     ) -> None:
         """Test microgrid api.
 
         Args:
             _: insecure channel mock from `mock.patch`
             components: components
             connections: connections
+            metadata: the metadata of the microgrid
         """
         microgrid_client = MagicMock()
         microgrid_client.components = AsyncMock(side_effect=components)
         microgrid_client.connections = AsyncMock(side_effect=connections)
+        microgrid_client.metadata = AsyncMock(return_value=metadata)
 
         with mock.patch(
             "frequenz.sdk.microgrid.connection_manager.MicrogridGrpcClient",
@@ -137,6 +154,11 @@ 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.location and api.location.timezone
+            assert api.location.timezone.key == "Europe/Berlin"
+
             # It should not be possible to initialize method once again
             with pytest.raises(AssertionError):
                 await connection_manager.initialize("127.0.0.1", 10001)
@@ -148,25 +170,36 @@ 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
+
     @mock.patch("grpc.aio.insecure_channel")
     async def test_connection_manager_another_method(
         self,
         _: MagicMock,
         components: list[list[Component]],
         connections: list[list[Connection]],
+        metadata: Metadata,
     ) -> None:
         """Test if the api was not deallocated.
 
         Args:
             _: insecure channel mock
             components: components
             connections: connections
+            metadata: the metadata of the microgrid
         """
         microgrid_client = MagicMock()
         microgrid_client.components = AsyncMock(return_value=[])
         microgrid_client.connections = AsyncMock(return_value=[])
+        microgrid_client.get_metadata = AsyncMock(return_value=None)
 
         api = connection_manager.get()
         graph = api.component_graph
         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.location and api.location.timezone
+        assert api.location.timezone.key == "Europe/Berlin"

tests/utils/mock_microgrid_client.py

@@ -23,12 +23,19 @@
     MeterData,
 )
 from frequenz.sdk.microgrid.connection_manager import ConnectionManager
+from frequenz.sdk.microgrid.metadata import Location
 
 
 class MockMicrogridClient:
     """Class that mocks MicrogridClient behavior."""
 
-    def __init__(self, components: set[Component], connections: set[Connection]):
+    def __init__(
+        self,
+        components: set[Component],
+        connections: set[Connection],
+        microgrid_id: int = 8,
+        location: Location = Location(latitude=52.520008, longitude=13.404954),
+    ):
         """Create mock microgrid with given components and connections.
 
         This simulates microgrid.
@@ -40,6 +47,8 @@ def __init__(self, components: set[Component], connections: set[Connection]):
         Args:
             components: List of the microgrid components
             connections: List of the microgrid connections
+            microgrid_id: the ID of the microgrid
+            location: the location of the microgrid
         """
         self._component_graph = _MicrogridComponentGraph(components, connections)
 
@@ -63,6 +72,8 @@ def __init__(self, components: set[Component], connections: set[Connection]):
         kwargs: dict[str, Any] = {
             "api_client": mock_api,
             "component_graph": self._component_graph,
+            "microgrid_id": microgrid_id,
+            "location": location,
         }
 
         self._mock_microgrid = MagicMock(spec=ConnectionManager, **kwargs)