Add Dispatcher.client property for easy client access

When you want to manipulate dispatches, you will need direct access
to the client.

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

Author: Marenz

RELEASE_NOTES.md

@@ -11,6 +11,7 @@
 ## New Features
 
 * Introduced new class `Dispatch` (based on the client class) that contains useful functions and extended information about the received dispatch.
+* `Dispatcher.client` was added to provide an easy access to the client for updating, deleting and creating dispatches
 
 ## Bug Fixes
 

src/frequenz/dispatch/_dispatcher.py

@@ -8,6 +8,7 @@
 
 import grpc.aio
 from frequenz.channels import Broadcast, Receiver
+from frequenz.client.dispatch import Client
 
 from ._dispatch import Dispatch
 from ._event import DispatchEvent
@@ -123,10 +124,10 @@ def __init__(
         self._lifecycle_events_channel = Broadcast[DispatchEvent](
             name="lifecycle_events"
         )
+        self._client = Client(grpc_channel, svc_addr)
         self._actor = DispatchingActor(
             microgrid_id,
-            grpc_channel,
-            svc_addr,
+            self._client,
             self._lifecycle_events_channel.new_sender(),
             self._running_state_channel.new_sender(),
         )
@@ -135,6 +136,11 @@ async def start(self) -> None:
         """Start the actor."""
         self._actor.start()
 
+    @property
+    def client(self) -> Client:
+        """Return the client."""
+        return self._client
+
     @property
     def lifecycle_events(self) -> ReceiverFetcher[DispatchEvent]:
         """Return new, updated or deleted dispatches receiver fetcher.

src/frequenz/dispatch/actor.py

@@ -47,8 +47,7 @@ class DispatchingActor(Actor):
     def __init__(
         self,
         microgrid_id: int,
-        grpc_channel: grpc.aio.Channel,
-        svc_addr: str,
+        client: Client,
         lifecycle_updates_sender: Sender[DispatchEvent],
         running_state_change_sender: Sender[Dispatch],
         poll_interval: timedelta = _DEFAULT_POLL_INTERVAL,
@@ -57,15 +56,14 @@ def __init__(
 
         Args:
             microgrid_id: The microgrid ID to handle dispatches for.
-            grpc_channel: The gRPC channel to use for communication with the API.
-            svc_addr: Address of the service to connect to.
+            client: The client to use for fetching dispatches.
             lifecycle_updates_sender: A sender for dispatch lifecycle events.
             running_state_change_sender: A sender for dispatch running state changes.
             poll_interval: The interval to poll the API for dispatche changes.
         """
         super().__init__(name="dispatch")
 
-        self._client = Client(grpc_channel, svc_addr)
+        self._client = client
         self._dispatches: dict[int, Dispatch] = {}
         self._scheduled: dict[int, asyncio.Task[None]] = {}
         self._microgrid_id = microgrid_id

tests/test_frequenz_dispatch.py

@@ -8,7 +8,6 @@
 from datetime import datetime, timedelta, timezone
 from random import randint
 from typing import AsyncIterator, Iterator
-from unittest.mock import MagicMock
 
 import async_solipsism
 import time_machine
@@ -66,18 +65,15 @@ async def actor_env() -> AsyncIterator[ActorTestEnv]:
     lifecycle_updates_dispatches = Broadcast[DispatchEvent](name="lifecycle_updates")
     running_state_change_dispatches = Broadcast[Dispatch](name="running_state_change")
     microgrid_id = randint(1, 100)
+    client = FakeClient()
 
     actor = DispatchingActor(
         microgrid_id=microgrid_id,
-        grpc_channel=MagicMock(),
-        svc_addr="localhost",
         lifecycle_updates_sender=lifecycle_updates_dispatches.new_sender(),
         running_state_change_sender=running_state_change_dispatches.new_sender(),
+        client=client,
     )
 
-    client = FakeClient()
-    actor._client = client  # pylint: disable=protected-access
-
     actor.start()
 
     yield ActorTestEnv(