Allow passing ChannelOptions to BaseApiClient

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

Author: llucax

src/frequenz/client/base/client.py

@@ -10,7 +10,7 @@
 
 from grpc.aio import AioRpcError, Channel
 
-from .channel import parse_grpc_uri
+from .channel import ChannelOptions, parse_grpc_uri
 from .exception import ApiClientError, ClientNotConnected
 
 StubT = TypeVar("StubT")
@@ -117,6 +117,7 @@ def __init__(
         create_stub: Callable[[Channel], StubT],
         *,
         connect: bool = True,
+        channel_defaults: ChannelOptions = ChannelOptions(),
     ) -> None:
         """Create an instance and connect to the server.
 
@@ -127,9 +128,12 @@ def __init__(
                 created. If `False`, the client will not connect to the server until
                 [connect()][frequenz.client.base.client.BaseApiClient.connect] is
                 called.
+            channel_defaults: The default options for the gRPC channel to create using
+                the server URL.
         """
         self._server_url: str = server_url
         self._create_stub: Callable[[Channel], StubT] = create_stub
+        self._channel_defaults: ChannelOptions = channel_defaults
         self._channel: Channel | None = None
         self._stub: StubT | None = None
         if connect:
@@ -156,6 +160,11 @@ def channel(self) -> Channel:
             raise ClientNotConnected(server_url=self.server_url, operation="channel")
         return self._channel
 
+    @property
+    def channel_defaults(self) -> ChannelOptions:
+        """The default options for the gRPC channel."""
+        return self._channel_defaults
+
     @property
     def stub(self) -> StubT:
         """The underlying gRPC stub.
@@ -192,7 +201,7 @@ def connect(self, server_url: str | None = None) -> None:
             self._server_url = server_url
         elif self.is_connected:
             return
-        self._channel = parse_grpc_uri(self._server_url)
+        self._channel = parse_grpc_uri(self._server_url, self._channel_defaults)
         self._stub = self._create_stub(self._channel)
 
     async def disconnect(self) -> None:

tests/test_client.py

@@ -11,6 +11,7 @@
 import pytest
 import pytest_mock
 
+from frequenz.client.base.channel import ChannelOptions, SslOptions
 from frequenz.client.base.client import BaseApiClient, StubT, call_stub_method
 from frequenz.client.base.exception import ClientNotConnected, UnknownError
 
@@ -52,6 +53,7 @@ def create_client_with_mocks(
     *,
     auto_connect: bool = True,
     server_url: str = _DEFAULT_SERVER_URL,
+    channel_defaults: ChannelOptions | None = None,
 ) -> tuple[BaseApiClient[mock.MagicMock], _ClientMocks]:
     """Create a BaseApiClient instance with mocks."""
     mock_stub = mock.MagicMock(name="stub")
@@ -60,10 +62,14 @@ def create_client_with_mocks(
     mock_parse_grpc_uri = mocker.patch(
         "frequenz.client.base.client.parse_grpc_uri", return_value=mock_channel
     )
+    kwargs = {}
+    if channel_defaults is not None:
+        kwargs["channel_defaults"] = channel_defaults
     client = BaseApiClient(
         server_url=server_url,
         create_stub=mock_create_stub,
         connect=auto_connect,
+        **kwargs,
     )
     return client, _ClientMocks(
         stub=mock_stub,
@@ -82,7 +88,9 @@ def test_base_api_client_init(
     client, mocks = create_client_with_mocks(mocker, auto_connect=auto_connect)
     assert client.server_url == _DEFAULT_SERVER_URL
     if auto_connect:
-        mocks.parse_grpc_uri.assert_called_once_with(client.server_url)
+        mocks.parse_grpc_uri.assert_called_once_with(
+            client.server_url, ChannelOptions()
+        )
         assert client.channel is mocks.channel
         assert client.stub is mocks.stub
         assert client.is_connected
@@ -93,6 +101,20 @@ def test_base_api_client_init(
         mocks.create_stub.assert_not_called()
 
 
+def test_base_api_client_init_with_channel_defaults(
+    mocker: pytest_mock.MockFixture,
+) -> None:
+    """Test initializing the BaseApiClient with channel defaults."""
+    channel_defaults = ChannelOptions(port=1234, ssl=SslOptions(enabled=False))
+    client, mocks = create_client_with_mocks(mocker, channel_defaults=channel_defaults)
+    assert client.server_url == _DEFAULT_SERVER_URL
+    mocks.parse_grpc_uri.assert_called_once_with(client.server_url, channel_defaults)
+    assert client.channel is mocks.channel
+    assert client.stub is mocks.stub
+    assert client.is_connected
+    mocks.create_stub.assert_called_once_with(mocks.channel)
+
+
 @pytest.mark.parametrize(
     "new_server_url", [None, _DEFAULT_SERVER_URL, "grpc://localhost:50051"]
 )
@@ -128,7 +150,9 @@ def test_base_api_client_connect(
         mocks.parse_grpc_uri.assert_not_called()
         mocks.create_stub.assert_not_called()
     else:
-        mocks.parse_grpc_uri.assert_called_once_with(client.server_url)
+        mocks.parse_grpc_uri.assert_called_once_with(
+            client.server_url, ChannelOptions()
+        )
         mocks.create_stub.assert_called_once_with(mocks.channel)
 
 
@@ -166,7 +190,9 @@ async def test_base_api_client_async_context_manager(
             mocks.parse_grpc_uri.assert_not_called()
             mocks.create_stub.assert_not_called()
         else:
-            mocks.parse_grpc_uri.assert_called_once_with(client.server_url)
+            mocks.parse_grpc_uri.assert_called_once_with(
+                client.server_url, ChannelOptions()
+            )
             mocks.create_stub.assert_called_once_with(mocks.channel)
 
     mocks.channel.__aexit__.assert_called_once_with(None, None, None)