refactor: enhance AssetsApiClient with default channel options and improved documentation

- Introduced default gRPC call timeout and channel options for the AssetsApiClient, ensuring consistent behavior and simplifying client configuration.
- Updated the constructor documentation to clarify parameter usage and expectations, enhancing usability for developers.
- Removed obsolete test file related to microgrid retrieval, streamlining the test suite.

These changes improve the clarity and maintainability of the AssetsApiClient while ensuring better default configurations for users.

Signed-off-by: eduardiazf <[email protected]>

Author: eduardiazf

src/frequenz/client/assets/_client.py

@@ -9,7 +9,10 @@
 
 from __future__ import annotations
 
+from dataclasses import replace
+
 from frequenz.api.assets.v1 import assets_pb2, assets_pb2_grpc
+from frequenz.client.base import channel
 from frequenz.client.base.client import BaseApiClient, call_stub_method
 
 from frequenz.client.assets.electrical_component._electrical_component import (
@@ -21,30 +24,58 @@
 from .electrical_component._electrical_component_proto import electrical_component_proto
 from .exceptions import ClientNotConnected
 
+DEFAULT_GRPC_CALL_TIMEOUT = 60.0
+"""The default timeout for gRPC calls made by this client (in seconds)."""
+
+
+DEFAULT_CHANNEL_OPTIONS = replace(
+    channel.ChannelOptions(), ssl=channel.SslOptions(enabled=False)
+)
+"""The default channel options for the assets API client.
+
+These are the same defaults as the common default options but with SSL disabled, as the
+assets API does not use SSL by default.
+"""
+
 
-class AssetsApiClient(BaseApiClient[assets_pb2_grpc.PlatformAssetsStub]):
+class AssetsApiClient(
+    BaseApiClient[assets_pb2_grpc.PlatformAssetsStub]
+):  # pylint: disable=too-many-arguments
     """A client for the Assets API."""
 
     def __init__(
         self,
         server_url: str,
-        auth_key: str | None,
-        sign_secret: str | None,
+        *,
+        auth_key: str | None = None,
+        sign_secret: str | None = None,
+        channel_defaults: channel.ChannelOptions = DEFAULT_CHANNEL_OPTIONS,
         connect: bool = True,
     ) -> None:
         """
         Initialize the AssetsApiClient.
 
         Args:
-            server_url: The URL of the server to connect to.
-            auth_key: The API key to use when connecting to the service.
-            sign_secret: The secret to use when creating message HMAC.
-            connect: Whether to connect to the server as soon as a client instance is created.
+            server_url: The location of the microgrid API server in the form of a URL.
+                The following format is expected:
+                "grpc://hostname{:`port`}{?ssl=`ssl`}",
+                where the `port` should be an int between 0 and 65535 (defaulting to
+                9090) and `ssl` should be a boolean (defaulting to `false`).
+                For example: `grpc://localhost:1090?ssl=true`.
+            auth_key: The authentication key to use for the connection.
+            sign_secret: The secret to use for signing requests.
+            channel_defaults: The default options use to create the channel when not
+                specified in the URL.
+            connect: Whether to connect to the server as soon as a client instance is
+                created. If `False`, the client will not connect to the server until
+                [connect()][frequenz.client.base.client.BaseApiClient.connect] is
+                called.
         """
         super().__init__(
             server_url,
             assets_pb2_grpc.PlatformAssetsStub,
             connect=connect,
+            channel_defaults=channel_defaults,
             auth_key=auth_key,
             sign_secret=sign_secret,
         )
@@ -85,7 +116,8 @@ async def get_microgrid_details(  # noqa: DOC502 (raises ApiClientError indirect
         microgrid = await call_stub_method(
             self,
             lambda: self.stub.GetMicrogrid(
-                assets_pb2.GetMicrogridRequest(microgrid_id=microgrid_id)
+                assets_pb2.GetMicrogridRequest(microgrid_id=microgrid_id),
+                timeout=DEFAULT_GRPC_CALL_TIMEOUT,
             ),
             method_name="GetMicrogrid",
         )
@@ -109,7 +141,8 @@ async def get_electrical_components(
             lambda: self.stub.ListMicrogridElectricalComponents(
                 assets_pb2.ListMicrogridElectricalComponentsRequest(
                     microgrid_id=microgrid_id,
-                )
+                ),
+                timeout=DEFAULT_GRPC_CALL_TIMEOUT,
             ),
             method_name="ListMicrogridElectricalComponents",
         )

tests/client_test_cases/get_microgrid/defaults_case.py renamed to tests/client_test_cases/get_microgrid_details/defaults_case.py

@@ -10,16 +10,18 @@
 from frequenz.api.assets.v1 import assets_pb2
 from frequenz.api.common.v1alpha8.microgrid import microgrid_pb2
 from frequenz.client.common.microgrid import EnterpriseId, MicrogridId
-from google.protobuf.empty_pb2 import Empty
 
 from frequenz.client.assets import Microgrid, MicrogridStatus
 
 
 def assert_stub_method_call(stub_method: AsyncMock) -> None:
     """Assert that the gRPC request matches the expected request."""
-    stub_method.assert_called_once_with(Empty(), timeout=60.0)
+    stub_method.assert_called_once_with(
+        assets_pb2.GetMicrogridRequest(microgrid_id=1), timeout=60.0
+    )
 
 
+client_args = (1,)
 create_timestamp = datetime(2023, 1, 1, tzinfo=timezone.utc)
 grpc_response = assets_pb2.GetMicrogridResponse(microgrid=microgrid_pb2.Microgrid())
 

tests/test_client.py

@@ -0,0 +1,39 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+"""Test for the Assets API client."""
+
+from __future__ import annotations
+
+from collections.abc import AsyncIterator
+from pathlib import Path
+
+import pytest
+from frequenz.api.assets.v1 import assets_pb2_grpc
+
+from frequenz.client.assets import AssetsApiClient
+
+from .util import ApiClientTestCaseSpec, get_test_specs, patch_client_class
+
+TESTS_DIR = Path(__file__).parent / "client_test_cases"
+
+
+@pytest.fixture
+async def client() -> AsyncIterator[AssetsApiClient]:
+    """Fixture that provides a AssetsApiClient with a mock gRPC stub and channel."""
+    with patch_client_class(AssetsApiClient, assets_pb2_grpc.PlatformAssetsStub):
+        client = AssetsApiClient("grpc://localhost:1234")
+        async with client:
+            yield client
+
+
+@pytest.mark.parametrize(
+    "spec",
+    get_test_specs("get_microgrid_details", tests_dir=TESTS_DIR),
+    ids=str,
+)
+async def test_get_microgrid_details(
+    client: AssetsApiClient, spec: ApiClientTestCaseSpec
+) -> None:
+    """Test get_microgrid_details method."""
+    await spec.test_unary_unary_call(client, "GetMicrogrid")