fixup! Implement GetMicrogridMetadata

llucax · llucax · commit 21c4c55eb72c · 2025-04-23T10:58:49.000+02:00
Add MicrogridInfo tests
diff --git a/tests/test_microgrid_info.py b/tests/test_microgrid_info.py
@@ -0,0 +1,351 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+"""Tests for MicrogridInfo class."""
+
+from dataclasses import dataclass
+from datetime import datetime, timezone
+from unittest.mock import Mock, patch
+
+import pytest
+from frequenz.api.common.v1.grid import delivery_area_pb2
+from frequenz.api.common.v1.microgrid import microgrid_pb2
+
+from frequenz.client.microgrid import Location, MicrogridInfo, MicrogridStatus
+from frequenz.client.microgrid._delivery_area import DeliveryArea, EnergyMarketCodeType
+from frequenz.client.microgrid._id import EnterpriseId, MicrogridId
+from frequenz.client.microgrid._microgrid_info_proto import microgrid_info_from_proto
+
+
+@dataclass(frozen=True, kw_only=True)
+class ProtoConversionTestCase:
+    """Test case for protobuf conversion."""
+
+    name: str
+    """Description of the test case."""
+
+    has_delivery_area: bool
+    """Whether to include delivery area in the protobuf message."""
+
+    has_location: bool
+    """Whether to include location in the protobuf message."""
+
+    has_name: bool
+    """Whether to include name in the protobuf message."""
+
+    status: MicrogridStatus | int
+    """The status to set in the protobuf message."""
+
+    expect_warning: bool
+    """Whether to expect a warning during conversion."""
+
+
+def test_microgrid_info_construction() -> None:
+    """Test MicrogridInfo construction with all fields."""
+    now = datetime.now(timezone.utc)
+    info = MicrogridInfo(
+        id=MicrogridId(1234),
+        enterprise_id=EnterpriseId(5678),
+        name="Test Microgrid",
+        delivery_area=DeliveryArea(
+            code="DE123",
+            code_type=EnergyMarketCodeType.EUROPE_EIC,
+        ),
+        location=Location(
+            latitude=52.52,
+            longitude=13.405,
+            country_code="DE",
+        ),
+        status=MicrogridStatus.ACTIVE,
+        create_timestamp=now,
+    )
+
+    assert info.id == MicrogridId(1234)
+    assert info.enterprise_id == EnterpriseId(5678)
+    assert info.name == "Test Microgrid"
+    assert info.delivery_area is not None
+    assert info.delivery_area.code == "DE123"
+    assert info.delivery_area.code_type == EnergyMarketCodeType.EUROPE_EIC
+    assert info.location is not None
+    assert info.location.latitude == pytest.approx(52.52)
+    assert info.location.longitude == pytest.approx(13.405)
+    assert info.location.country_code == "DE"
+    assert info.status == MicrogridStatus.ACTIVE
+    assert info.create_timestamp == now
+    assert info.active is True
+
+
+def test_microgrid_info_without_optionals() -> None:
+    """Test MicrogridInfo construction with only required fields."""
+    now = datetime.now(timezone.utc)
+    info = MicrogridInfo(
+        id=MicrogridId(1234),
+        enterprise_id=EnterpriseId(5678),
+        name=None,
+        delivery_area=None,
+        location=None,
+        status=MicrogridStatus.ACTIVE,
+        create_timestamp=now,
+    )
+
+    assert info.id == MicrogridId(1234)
+    assert info.enterprise_id == EnterpriseId(5678)
+    assert info.name is None
+    assert info.delivery_area is None
+    assert info.location is None
+    assert info.status == MicrogridStatus.ACTIVE
+    assert info.create_timestamp == now
+    assert info.active is True
+
+
+def test_active_property() -> None:
+    """Test the active property for different status values."""
+    now = datetime.now(timezone.utc)
+    info_active = MicrogridInfo(
+        id=MicrogridId(1234),
+        enterprise_id=EnterpriseId(5678),
+        name=None,
+        delivery_area=None,
+        location=None,
+        status=MicrogridStatus.ACTIVE,
+        create_timestamp=now,
+    )
+    assert info_active.active is True
+
+    info_inactive = MicrogridInfo(
+        id=MicrogridId(1234),
+        enterprise_id=EnterpriseId(5678),
+        name=None,
+        delivery_area=None,
+        location=None,
+        status=MicrogridStatus.INACTIVE,
+        create_timestamp=now,
+    )
+    assert info_inactive.active is False
+
+    # Test unspecified status (should log warning and return True)
+    info_unspecified = MicrogridInfo(
+        id=MicrogridId(1234),
+        enterprise_id=EnterpriseId(5678),
+        name=None,
+        delivery_area=None,
+        location=None,
+        status=MicrogridStatus.UNSPECIFIED,
+        create_timestamp=now,
+    )
+    assert info_unspecified.active is True
+
+
+def test_string_representation() -> None:
+    """Test string representation of MicrogridInfo."""
+    now = datetime.now(timezone.utc)
+
+    # Test with name
+    info_with_name = MicrogridInfo(
+        id=MicrogridId(1234),
+        enterprise_id=EnterpriseId(5678),
+        name="Test Grid",
+        delivery_area=None,
+        location=None,
+        status=MicrogridStatus.ACTIVE,
+        create_timestamp=now,
+    )
+    assert str(info_with_name) == "MID1234:Test Grid"
+
+    # Test without name
+    info_without_name = MicrogridInfo(
+        id=MicrogridId(1234),
+        enterprise_id=EnterpriseId(5678),
+        name=None,
+        delivery_area=None,
+        location=None,
+        status=MicrogridStatus.ACTIVE,
+        create_timestamp=now,
+    )
+    assert str(info_without_name) == "MID1234"
+
+
+@pytest.mark.parametrize(
+    "case",
+    [
+        ProtoConversionTestCase(
+            name="all fields present",
+            has_delivery_area=True,
+            has_location=True,
+            has_name=True,
+            status=MicrogridStatus.ACTIVE,
+            expect_warning=False,
+        ),
+        ProtoConversionTestCase(
+            name="missing delivery area",
+            has_delivery_area=False,
+            has_location=True,
+            has_name=True,
+            status=MicrogridStatus.ACTIVE,
+            expect_warning=True,
+        ),
+        ProtoConversionTestCase(
+            name="missing location",
+            has_delivery_area=True,
+            has_location=False,
+            has_name=True,
+            status=MicrogridStatus.ACTIVE,
+            expect_warning=True,
+        ),
+        ProtoConversionTestCase(
+            name="empty name",
+            has_delivery_area=True,
+            has_location=True,
+            has_name=False,
+            status=MicrogridStatus.ACTIVE,
+            expect_warning=True,  # This is a minor issue
+        ),
+        ProtoConversionTestCase(
+            name="unspecified status",
+            has_delivery_area=True,
+            has_location=True,
+            has_name=True,
+            status=MicrogridStatus.UNSPECIFIED,
+            expect_warning=True,
+        ),
+        ProtoConversionTestCase(
+            name="unrecognized status",
+            has_delivery_area=True,
+            has_location=True,
+            has_name=True,
+            status=999,  # Unknown status value
+            expect_warning=True,
+        ),
+    ],
+    ids=lambda case: case.name,
+)
+@patch("frequenz.client.microgrid._microgrid_info_proto.delivery_area_from_proto")
+@patch("frequenz.client.microgrid._microgrid_info_proto.location_from_proto")
+@patch("frequenz.client.microgrid._microgrid_info_proto.enum_from_proto")
+@patch("frequenz.client.microgrid._microgrid_info_proto.conversion.to_datetime")
+# pylint: disable-next=too-many-arguments,too-many-positional-arguments,too-many-branches
+def test_microgrid_info_from_proto(
+    mock_to_datetime: Mock,
+    mock_enum_from_proto: Mock,
+    mock_location_from_proto: Mock,
+    mock_delivery_area_from_proto: Mock,
+    caplog: pytest.LogCaptureFixture,
+    case: ProtoConversionTestCase,
+) -> None:
+    """Test conversion from protobuf message to MicrogridInfo.
+
+    Args:
+        mock_to_datetime: Mock for timestamp conversion
+        mock_enum_from_proto: Mock for enum conversion
+        mock_location_from_proto: Mock for location conversion
+        mock_delivery_area_from_proto: Mock for delivery area conversion
+        caplog: Fixture to capture log messages
+        case: Test case parameters
+
+    Raises:
+        AssertionError: If any of the test assertions fail
+    """
+    now = datetime.now(timezone.utc)
+    mock_to_datetime.return_value = now
+
+    if isinstance(case.status, MicrogridStatus):
+        mock_enum_from_proto.return_value = case.status
+    else:
+        mock_enum_from_proto.return_value = case.status
+
+    mock_location = (
+        Location(
+            latitude=52.52,
+            longitude=13.405,
+            country_code="DE",
+        )
+        if case.has_location
+        else None
+    )
+    mock_location_from_proto.return_value = mock_location
+
+    mock_delivery_area = (
+        DeliveryArea(
+            code="DE123",
+            code_type=EnergyMarketCodeType.EUROPE_EIC,
+        )
+        if case.has_delivery_area
+        else None
+    )
+    mock_delivery_area_from_proto.return_value = mock_delivery_area
+
+    proto = microgrid_pb2.Microgrid(
+        id=1234,
+        enterprise_id=5678,
+        name="Test Grid" if case.has_name else "",
+        # We use a ignore because we want to pass an arbitrary int here
+        status=(
+            case.status.value  # type: ignore[arg-type]
+            if isinstance(case.status, MicrogridStatus)
+            else case.status
+        ),
+    )
+
+    # Add optional fields if needed
+    if case.has_delivery_area:
+        proto.delivery_area.code = "DE123"
+        proto.delivery_area.code_type = (
+            delivery_area_pb2.EnergyMarketCodeType.ENERGY_MARKET_CODE_TYPE_EUROPE_EIC
+        )
+
+    if case.has_location:
+        proto.location.latitude = 52.52
+        proto.location.longitude = 13.405
+        proto.location.country_code = "DE"
+
+    # Run the conversion
+    with caplog.at_level("DEBUG"):
+        info = microgrid_info_from_proto(proto)
+
+    # Verify the result
+    assert info.id == MicrogridId(1234)
+    assert info.enterprise_id == EnterpriseId(5678)
+    assert info.create_timestamp == now
+
+    if case.has_name:
+        assert info.name == "Test Grid"
+    else:
+        assert info.name is None
+
+    # Verify mock calls
+    mock_to_datetime.assert_called_once()
+    mock_enum_from_proto.assert_called_once()
+
+    if case.has_delivery_area:
+        mock_delivery_area_from_proto.assert_called_once()
+        assert info.delivery_area == mock_delivery_area
+    else:
+        mock_delivery_area_from_proto.assert_not_called()
+        assert info.delivery_area is None
+
+    if case.has_location:
+        mock_location_from_proto.assert_called_once()
+        assert info.location == mock_location
+    else:
+        mock_location_from_proto.assert_not_called()
+        assert info.location is None
+
+    # Verify logging behavior
+    if case.expect_warning:
+        assert len(caplog.records) > 0
+        if case.name == "empty name":
+            # For empty name case, expect a DEBUG level message about minor issues
+            assert any(
+                "Found minor issues in microgrid:" in record.message
+                for record in caplog.records
+                if record.levelname == "DEBUG"
+            )
+        else:
+            # For other cases, expect a WARNING level message about major issues
+            assert any(
+                "Found issues in microgrid:" in record.message
+                for record in caplog.records
+                if record.levelname == "WARNING"
+            )
+    else:
+        assert len(caplog.records) == 0
