fixup! Implement GetMicrogridMetadata

Add `DeliveryArea` tests

Author: llucax

tests/test_delivery_area.py

@@ -0,0 +1,179 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+"""Tests for the DeliveryArea class and its protobuf conversion."""
+
+from dataclasses import dataclass
+
+import pytest
+from frequenz.api.common.v1.grid import delivery_area_pb2
+
+from frequenz.client.microgrid import DeliveryArea, EnergyMarketCodeType
+from frequenz.client.microgrid._delivery_area_proto import delivery_area_from_proto
+
+
+@dataclass(frozen=True, kw_only=True)
+class DeliveryAreaTestCase:
+    """Test case for DeliveryArea creation."""
+
+    name: str
+    """Description of the test case."""
+
+    code: str | None
+    """The code to use for the delivery area."""
+
+    code_type: EnergyMarketCodeType | int
+    """The type of code being used."""
+
+    expected_str: str
+    """Expected string representation."""
+
+
+@dataclass(frozen=True, kw_only=True)
+class ProtoConversionTestCase:
+    """Test case for protobuf conversion."""
+
+    name: str
+    """Description of the test case."""
+
+    code: str | None
+    """The code to set in the protobuf message."""
+
+    code_type: int
+    """The code type to set in the protobuf message."""
+
+    expected_code: str | None
+    """Expected code in the resulting DeliveryArea."""
+
+    expected_code_type: EnergyMarketCodeType | int
+    """Expected code type in the resulting DeliveryArea."""
+
+    expect_warning: bool
+    """Whether to expect a warning during conversion."""
+
+
+@pytest.mark.parametrize(
+    "case",
+    [
+        DeliveryAreaTestCase(
+            name="valid EIC code",
+            code="10Y1001A1001A450",
+            code_type=EnergyMarketCodeType.EUROPE_EIC,
+            expected_str="10Y1001A1001A450[EUROPE_EIC]",
+        ),
+        DeliveryAreaTestCase(
+            name="valid NERC code",
+            code="PJM",
+            code_type=EnergyMarketCodeType.US_NERC,
+            expected_str="PJM[US_NERC]",
+        ),
+        DeliveryAreaTestCase(
+            name="unspecified code type",
+            code="TEST",
+            code_type=EnergyMarketCodeType.UNSPECIFIED,
+            expected_str="TEST[UNSPECIFIED]",
+        ),
+        DeliveryAreaTestCase(
+            name="no code",
+            code=None,
+            code_type=EnergyMarketCodeType.EUROPE_EIC,
+            expected_str="<NO CODE>[EUROPE_EIC]",
+        ),
+        DeliveryAreaTestCase(
+            name="unknown code type",
+            code="TEST",
+            code_type=999,
+            expected_str="TEST[type=999]",
+        ),
+    ],
+    ids=lambda case: case.name,
+)
+def test_delivery_area_creation(case: DeliveryAreaTestCase) -> None:
+    """Test creating DeliveryArea instances with various parameters.
+
+    Args:
+        case: Test case parameters
+
+    Raises:
+        AssertionError: If any of the test assertions fail
+    """
+    area = DeliveryArea(code=case.code, code_type=case.code_type)
+    assert area.code == case.code
+    assert area.code_type == case.code_type
+    assert str(area) == case.expected_str
+
+
+@pytest.mark.parametrize(
+    "case",
+    [
+        ProtoConversionTestCase(
+            name="valid EIC code",
+            code="10Y1001A1001A450",
+            code_type=delivery_area_pb2.EnergyMarketCodeType.ENERGY_MARKET_CODE_TYPE_EUROPE_EIC,
+            expected_code="10Y1001A1001A450",
+            expected_code_type=EnergyMarketCodeType.EUROPE_EIC,
+            expect_warning=False,
+        ),
+        ProtoConversionTestCase(
+            name="valid NERC code",
+            code="PJM",
+            code_type=delivery_area_pb2.EnergyMarketCodeType.ENERGY_MARKET_CODE_TYPE_US_NERC,
+            expected_code="PJM",
+            expected_code_type=EnergyMarketCodeType.US_NERC,
+            expect_warning=False,
+        ),
+        ProtoConversionTestCase(
+            name="no code",
+            code=None,
+            code_type=delivery_area_pb2.EnergyMarketCodeType.ENERGY_MARKET_CODE_TYPE_EUROPE_EIC,
+            expected_code=None,
+            expected_code_type=EnergyMarketCodeType.EUROPE_EIC,
+            expect_warning=True,
+        ),
+        ProtoConversionTestCase(
+            name="unspecified type",
+            code="TEST",
+            code_type=delivery_area_pb2.EnergyMarketCodeType.ENERGY_MARKET_CODE_TYPE_UNSPECIFIED,
+            expected_code="TEST",
+            expected_code_type=EnergyMarketCodeType.UNSPECIFIED,
+            expect_warning=True,
+        ),
+        ProtoConversionTestCase(
+            name="unknown code type",
+            code="TEST",
+            code_type=999,
+            expected_code="TEST",
+            expected_code_type=999,
+            expect_warning=True,
+        ),
+    ],
+    ids=lambda case: case.name,
+)
+def test_delivery_area_from_proto(
+    caplog: pytest.LogCaptureFixture, case: ProtoConversionTestCase
+) -> None:
+    """Test conversion from protobuf message to DeliveryArea.
+
+    Args:
+        caplog: Fixture to capture log messages
+        case: Test case parameters
+
+    Raises:
+        AssertionError: If any of the test assertions fail
+    """
+    # We do the type-ignore here because we want to test the case of an
+    # arbitrary int too.
+    proto = delivery_area_pb2.DeliveryArea(
+        code=case.code or "", code_type=case.code_type  # type: ignore[arg-type]
+    )
+    with caplog.at_level("WARNING"):
+        area = delivery_area_from_proto(proto)
+
+    assert area.code == case.expected_code
+    assert area.code_type == case.expected_code_type
+
+    if case.expect_warning:
+        assert len(caplog.records) > 0
+        assert "Found issues in delivery area" in caplog.records[0].message
+    else:
+        assert len(caplog.records) == 0