Make test keys constants

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

Author: Marenz

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

@@ -35,6 +35,12 @@
 from .._internal_types import DispatchCreateRequest
 from ..types import Dispatch
 
+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."""
+
 
 @dataclass
 class FakeService:
@@ -75,13 +81,13 @@ def _check_access(self, metadata: grpc.aio.Metadata) -> None:
                 "No access key provided",
             )
 
-        if key == "none":
+        if key == NONE_KEY:
             raise grpc.RpcError(
                 grpc.StatusCode.PERMISSION_DENIED,
                 "Permission denied",
             )
 
-        if key != "all":
+        if key != ALL_KEY:
             raise grpc.RpcError(
                 grpc.StatusCode.UNAUTHENTICATED,
                 "Invalid access key",

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

@@ -8,7 +8,9 @@
 
 from .. import Client
 from ..types import Dispatch
-from ._service import FakeService
+from ._service import ALL_KEY, NONE_KEY, FakeService
+
+__all__ = ["FakeClient", "to_create_params", "ALL_KEY", "NONE_KEY"]
 
 
 class FakeClient(Client):
@@ -26,7 +28,7 @@ def __init__(
         Args:
             shuffle_after_create: Whether to shuffle the dispatches after creating them.
         """
-        super().__init__(grpc_channel=MagicMock(), svc_addr="mock", key="all")
+        super().__init__(grpc_channel=MagicMock(), svc_addr="mock", key=ALL_KEY)
         self._stub = FakeService()  # type: ignore
         self._service._shuffle_after_create = shuffle_after_create
 

tests/test_dispatch_cli.py

@@ -14,7 +14,7 @@
 
 from frequenz.client.common.microgrid.components import ComponentCategory
 from frequenz.client.dispatch.__main__ import cli
-from frequenz.client.dispatch.test.client import FakeClient
+from frequenz.client.dispatch.test.client import ALL_KEY, FakeClient
 from frequenz.client.dispatch.types import (
     Dispatch,
     EndCriteria,
@@ -26,7 +26,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"}
+ENVIRONMENT_VARIABLES = {"DISPATCH_API_KEY": ALL_KEY}
 
 
 @pytest.fixture