Fix tests after updating base client

Signed-off-by: Mathias L. Baumann <[email protected]>

Author: Marenz

src/frequenz/client/dispatch/test/_service.py

@@ -40,12 +40,6 @@
 from .._internal_types import DispatchCreateRequest
 from ..types import Dispatch, DispatchEvent, DispatchId, Event
 
-ALL_KEY = "all"
-"""Key that has access to all resources in the FakeService."""
-
-NONE_KEY = "none"
-"""Key that has no access to any resources in the FakeService."""
-
 
 class FakeService:
     """Dispatch mock service for testing."""
@@ -82,63 +76,21 @@ def refresh_last_id_for(self, microgrid_id: MicrogridId) -> None:
 
         self._last_id = max(self._last_id, max(dispatch.id for dispatch in dispatches))
 
-    def _check_access(self, metadata: grpc.aio.Metadata) -> None:
-        """Check if the access key is valid.
-
-        Args:
-            metadata: The metadata.
-
-        Raises:
-            grpc.RpcError: If the access key is invalid.
-        """
-        # metadata is a weird tuple of tuples, we don't like it
-        metadata_dict = dict(metadata)
-
-        if "key" not in metadata_dict:
-            raise grpc.RpcError(
-                grpc.StatusCode.UNAUTHENTICATED,
-                "No access key provided",
-            )
-
-        key = metadata_dict["key"]
-
-        if key is None:
-            raise grpc.RpcError(
-                grpc.StatusCode.UNAUTHENTICATED,
-                "No access key provided",
-            )
-
-        if key == NONE_KEY:
-            raise grpc.RpcError(
-                grpc.StatusCode.PERMISSION_DENIED,
-                "Permission denied",
-            )
-
-        if key != ALL_KEY:
-            raise grpc.RpcError(
-                grpc.StatusCode.UNAUTHENTICATED,
-                "Invalid access key",
-            )
-
     # pylint: disable=invalid-name
     async def ListMicrogridDispatches(
         self,
         request: ListMicrogridDispatchesRequest,
-        metadata: grpc.aio.Metadata,
         timeout: int = 5,  # pylint: disable=unused-argument
     ) -> ListMicrogridDispatchesResponse:
         """List microgrid dispatches.
 
         Args:
             request: The request.
-            metadata: The metadata.
             timeout: timeout for the request, ignored in this mock.
 
         Returns:
             The dispatch list.
         """
-        self._check_access(metadata)
-
         grid_dispatches = self.dispatches.get(MicrogridId(request.microgrid_id), [])
 
         return ListMicrogridDispatchesResponse(
@@ -157,14 +109,12 @@ async def ListMicrogridDispatches(
     async def StreamMicrogridDispatches(
         self,
         request: StreamMicrogridDispatchesRequest,
-        metadata: grpc.aio.Metadata,
         timeout: int = 5,  # pylint: disable=unused-argument
     ) -> AsyncIterator[StreamMicrogridDispatchesResponse]:
         """Stream microgrid dispatches changes.
 
         Args:
             request: The request.
-            metadata: The metadata.
             timeout: timeout for the request, ignored in this mock.
 
         Returns:
@@ -173,8 +123,6 @@ async def StreamMicrogridDispatches(
         Yields:
             An event for each dispatch change.
         """
-        self._check_access(metadata)
-
         receiver = self._stream_channel.new_receiver()
 
         async for message in receiver:
@@ -229,11 +177,9 @@ def _filter_dispatch(
     async def CreateMicrogridDispatch(
         self,
         request: PBDispatchCreateRequest,
-        metadata: grpc.aio.Metadata,
         timeout: int = 5,  # pylint: disable=unused-argument
     ) -> CreateMicrogridDispatchResponse:
         """Create a new dispatch."""
-        self._check_access(metadata)
         microgrid_id = MicrogridId(request.microgrid_id)
         self._last_id = DispatchId(int(self._last_id) + 1)
 
@@ -259,12 +205,9 @@ async def CreateMicrogridDispatch(
     async def UpdateMicrogridDispatch(
         self,
         request: UpdateMicrogridDispatchRequest,
-        metadata: grpc.aio.Metadata,
         timeout: int = 5,  # pylint: disable=unused-argument
     ) -> UpdateMicrogridDispatchResponse:
         """Update a dispatch."""
-        self._check_access(metadata)
-
         microgrid_id = MicrogridId(request.microgrid_id)
         grid_dispatches = self.dispatches.get(microgrid_id, [])
         index = next(
@@ -353,11 +296,9 @@ async def UpdateMicrogridDispatch(
     async def GetMicrogridDispatch(
         self,
         request: GetMicrogridDispatchRequest,
-        metadata: grpc.aio.Metadata,
         timeout: int = 5,  # pylint: disable=unused-argument
     ) -> GetMicrogridDispatchResponse:
         """Get a single dispatch."""
-        self._check_access(metadata)
         microgrid_id = MicrogridId(request.microgrid_id)
         grid_dispatches = self.dispatches.get(microgrid_id, [])
         dispatch = next(
@@ -378,11 +319,9 @@ async def GetMicrogridDispatch(
     async def DeleteMicrogridDispatch(
         self,
         request: DeleteMicrogridDispatchRequest,
-        metadata: grpc.aio.Metadata,
         timeout: int = 5,  # pylint: disable=unused-argument
     ) -> Empty:
         """Delete a given dispatch."""
-        self._check_access(metadata)
         microgrid_id = MicrogridId(request.microgrid_id)
         grid_dispatches = self.dispatches.get(microgrid_id, [])
 

src/frequenz/client/dispatch/test/client.py

@@ -9,9 +9,9 @@
 
 from .. import DispatchApiClient
 from ..types import Dispatch
-from ._service import ALL_KEY, NONE_KEY, FakeService
+from ._service import FakeService
 
-__all__ = ["FakeClient", "to_create_params", "ALL_KEY", "NONE_KEY"]
+__all__ = ["FakeClient", "to_create_params"]
 
 
 class FakeClient(DispatchApiClient):
@@ -24,7 +24,7 @@ def __init__(
         self,
     ) -> None:
         """Initialize the mock client."""
-        super().__init__(server_url="mock", auth_key=ALL_KEY, connect=False)
+        super().__init__(server_url="mock", auth_key="what", connect=False)
         self._stuba: FakeService = FakeService()
 
     @property

tests/test_cli.py

@@ -21,7 +21,7 @@
     RecurrenceRule,
     Weekday,
 )
-from frequenz.client.dispatch.test.client import ALL_KEY, FakeClient
+from frequenz.client.dispatch.test.client import FakeClient
 from frequenz.client.dispatch.types import (
     Dispatch,
     DispatchId,
@@ -33,7 +33,7 @@
 TEST_NOW = datetime(2023, 1, 1, 0, 0, 0, tzinfo=timezone.utc)
 """Arbitrary time used as NOW for testing."""
 
-ENVIRONMENT_VARIABLES = {"DISPATCH_API_KEY": ALL_KEY}
+ENVIRONMENT_VARIABLES = {"DISPATCH_API_KEY": "test_key"}
 
 
 @pytest.fixture