Refactor Assets API client tests and improve utility functions

This commit includes several updates to the Assets API client tests and utility functions:
- Refactored test structure for better organization and clarity, including renaming test files and updating docstrings.
- Introduced new test cases for retrieving microgrid details and electrical components, enhancing coverage for the Assets API client.
- Added utility functions to streamline test case management and improve readability.
- Updated the JSON encoder logic in the AssetsJSONEncoder class for better handling of container types.

These changes enhance the maintainability and robustness of the testing framework for the Assets API client.

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

Author: eduardiazf

src/frequenz/client/assets/_utils.py

@@ -53,7 +53,7 @@ def _encode_containers_recursively(self, o: Any) -> Any:
                 ): self._encode_containers_recursively(value)
                 for key, value in o.items()
             }
-        elif isinstance(o, (list, tuple, set, frozenset)):
+        if isinstance(o, (list, tuple, set, frozenset)):
             items = [self._encode_containers_recursively(item) for item in o]
             return items if isinstance(o, (list, tuple)) else items
         return o

tests/__init__.py

@@ -1,4 +1,4 @@
 # License: MIT
 # Copyright © 2025 Frequenz Energy-as-a-Service GmbH
 
-"""Tests package."""
+"""Tests for the Assets API Client."""

tests/client_test_cases/get_microgrid/defaults_case.py

@@ -0,0 +1,40 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+"""Test data for successful microgrid retrieval."""
+
+from datetime import datetime, timezone
+from typing import Any
+from unittest.mock import AsyncMock
+
+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 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(
+        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())
+
+
+def assert_client_result(result: Any) -> None:
+    """Assert that the client result matches the expected Microgrid."""
+    assert result == Microgrid(
+        id=MicrogridId(0),
+        enterprise_id=EnterpriseId(0),
+        name=None,
+        status=MicrogridStatus.UNSPECIFIED,
+        location=None,
+        delivery_area=None,
+        create_timestamp=datetime(1970, 1, 1, 0, 0, tzinfo=timezone.utc),
+    )
+    assert result.is_active

tests/client_test_cases/get_microgrid/error_case.py

@@ -0,0 +1,29 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+"""Test data for microgrid info retrieval with error."""
+
+from typing import Any
+
+from frequenz.api.assets.v1 import assets_pb2
+from grpc import StatusCode
+
+from frequenz.client.assets.exceptions import PermissionDenied
+from tests.util import make_grpc_error
+
+
+def assert_stub_method_call(stub_method: Any) -> None:
+    """Assert that the gRPC request matches the expected request."""
+    stub_method.assert_called_once_with(
+        assets_pb2.GetMicrogridRequest(microgrid_id=1), timeout=60.0
+    )
+
+
+client_args = (1,)
+grpc_response = make_grpc_error(StatusCode.PERMISSION_DENIED)
+
+
+def assert_client_exception(exception: Exception) -> None:
+    """Assert that the client exception matches the expected error."""
+    assert isinstance(exception, PermissionDenied)
+    assert exception.grpc_error == grpc_response

tests/client_test_cases/get_microgrid/full_case.py

@@ -0,0 +1,70 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+"""Test data for successful microgrid info retrieval."""
+
+from datetime import datetime, timezone
+from typing import Any
+from unittest.mock import AsyncMock
+
+import pytest
+from frequenz.api.assets.v1 import assets_pb2
+from frequenz.api.common.v1alpha8.grid import delivery_area_pb2
+from frequenz.api.common.v1alpha8.microgrid import microgrid_pb2
+from frequenz.api.common.v1alpha8.types import location_pb2
+from frequenz.client.base.conversion import to_timestamp
+from frequenz.client.common.microgrid import EnterpriseId, MicrogridId
+
+from frequenz.client.assets import (
+    DeliveryArea,
+    EnergyMarketCodeType,
+    Location,
+    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(
+        assets_pb2.GetMicrogridRequest(microgrid_id=1234), timeout=60.0
+    )
+
+
+client_args = (1234,)
+create_timestamp = datetime(2023, 1, 1, tzinfo=timezone.utc)
+grpc_response = assets_pb2.GetMicrogridResponse(
+    microgrid=microgrid_pb2.Microgrid(
+        id=1234,
+        enterprise_id=5678,
+        name="Test Microgrid",
+        delivery_area=delivery_area_pb2.DeliveryArea(
+            code="Test Delivery Area",
+            code_type=delivery_area_pb2.EnergyMarketCodeType.ENERGY_MARKET_CODE_TYPE_EUROPE_EIC,
+        ),
+        location=location_pb2.Location(
+            latitude=37.7749, longitude=-122.4194, country_code="DE"
+        ),
+        status=microgrid_pb2.MICROGRID_STATUS_INACTIVE,
+        create_timestamp=to_timestamp(create_timestamp),
+    )
+)
+
+
+def assert_client_result(result: Any) -> None:
+    """Assert that the client result matches the expected Microgrid."""
+    assert result == Microgrid(
+        id=MicrogridId(1234),
+        enterprise_id=EnterpriseId(5678),
+        name="Test Microgrid",
+        delivery_area=DeliveryArea(
+            code="Test Delivery Area", code_type=EnergyMarketCodeType.EUROPE_EIC
+        ),
+        location=Location(
+            latitude=pytest.approx(37.7749),  # type: ignore[arg-type]
+            longitude=pytest.approx(-122.4194),  # type: ignore[arg-type]
+            country_code="DE",
+        ),
+        status=MicrogridStatus.INACTIVE,
+        create_timestamp=datetime(2023, 1, 1, tzinfo=timezone.utc),
+    )

tests/client_test_cases/list_microgrid_electrical_components/empty_case.py

@@ -0,0 +1,24 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+"""Empty case for list electrical components."""
+
+from typing import Any
+
+from frequenz.api.assets.v1 import assets_pb2
+
+
+def assert_stub_method_call(stub_method: Any) -> None:
+    """Assert that the gRPC request matches the expected request."""
+    stub_method.assert_called_once_with(
+        assets_pb2.ListMicrogridElectricalComponentsRequest(microgrid_id=1234),
+        timeout=60.0,
+    )
+
+
+client_args = (1234,)
+grpc_response = assets_pb2.ListMicrogridElectricalComponentsResponse(components=[])
+
+
+def assert_client_result(result: Any) -> None:  # noqa: D103
+    assert not list(result)

tests/client_test_cases/list_microgrid_electrical_components/error_case.py

@@ -0,0 +1,30 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+"""Test list_electrical_components with error."""
+
+from typing import Any
+
+from frequenz.api.assets.v1 import assets_pb2
+from grpc import StatusCode
+
+from frequenz.client.assets.exceptions import PermissionDenied
+from tests.util import make_grpc_error
+
+
+def assert_stub_method_call(stub_method: Any) -> None:
+    """Assert that the gRPC request matches the expected request."""
+    stub_method.assert_called_once_with(
+        assets_pb2.ListMicrogridElectricalComponentsRequest(microgrid_id=1234),
+        timeout=60.0,
+    )
+
+
+client_args = (1234,)
+grpc_response = make_grpc_error(StatusCode.PERMISSION_DENIED)
+
+
+def assert_client_exception(exception: Exception) -> None:
+    """Assert that the client exception matches the expected error."""
+    assert isinstance(exception, PermissionDenied)
+    assert exception.grpc_error == grpc_response