Comprehensive monitor API fixes and improvements

- Fixed json_object parameter issues in AlertDefinition properties
- Corrected list type annotations for AlertChannelEnvelope
- Updated integration tests with proper status handling for alert definitions
- Applied review comments for better code quality
- Enhanced type annotations and import organization
- Improved error handling in monitor group methods

Author: srbhaakamai

linode_api4/groups/monitor.py

@@ -1,4 +1,4 @@
-from typing import Any, Optional, Union
+from typing import Any, List, Optional
 
 from linode_api4 import PaginatedList
 from linode_api4.errors import UnexpectedResponseError
@@ -216,10 +216,10 @@ def create_alert_definition(
         service_type: str,
         label: str,
         severity: int,
-        channel_ids: list[int],
-        rule_criteria: dict = None,
-        trigger_conditions: dict = None,
-        entity_ids: Optional[list[str]] = None,
+        channel_ids: List[int],
+        rule_criteria: Optional[dict] = None,
+        trigger_conditions: Optional[dict] = None,
+        entity_ids: Optional[List[str]] = None,
         description: Optional[str] = None,
     ) -> AlertDefinition:
         """

linode_api4/objects/monitor.py

@@ -6,18 +6,18 @@
 from linode_api4.objects.serializable import JSONObject, StrEnum
 
 __all__ = [
+    "AggregateFunction",
+    "Alert",
+    "AlertChannel",
+    "AlertDefinition",
     "AlertType",
+    "Alerts",
     "MonitorDashboard",
     "MonitorMetricsDefinition",
     "MonitorService",
     "MonitorServiceToken",
-    "AggregateFunction",
     "RuleCriteria",
     "TriggerConditions",
-    "AlertChannel",
-    "AlertDefinition",
-    "AlertChannelEnvelope",
-    "Alert",
 ]
 
 
@@ -285,21 +285,15 @@ class RuleCriteria(JSONObject):
 
 
 @dataclass
-class AlertChannelEnvelope(JSONObject):
+class Alert(JSONObject):
     """
-    Represents a single alert channel entry returned inside alert definition
-    responses.
-
-    This envelope type is used when an AlertDefinition includes a list of
-    alert channels. It contains lightweight information about the channel so
-    that callers can display or reference the channel without performing an
-    additional API lookup.
+    Represents an alert definition reference within an AlertChannel.
 
     Fields:
-      - id: int - Unique identifier of the alert channel.
-      - label: str - Human-readable name for the channel.
-      - type: str - Channel type (e.g. 'webhook', 'email', 'pagerduty').
-      - url: str - Destination URL or address associated with the channel.
+      - id: int - Unique identifier of the alert definition.
+      - label: str - Human-readable name for the alert definition.
+      - type: str - Type of the alert (e.g., 'alerts-definitions').
+      - url: str - API URL for the alert definition.
     """
 
     id: int = 0
@@ -308,6 +302,18 @@ class AlertChannelEnvelope(JSONObject):
     url: str = ""
 
 
+@dataclass
+class Alerts(JSONObject):
+    """
+    Represents a collection of alert definitions within an AlertChannel.
+
+    Fields:
+      - items: List[Alert] - List of alert definitions.
+    """
+
+    items: List[Alert] = field(default_factory=list)
+
+
 class AlertType(StrEnum):
     """
     Enumeration of alert origin types used by alert definitions.
@@ -346,8 +352,10 @@ class AlertDefinition(DerivedBase):
         "status": Property(mutable=True),
         "has_more_resources": Property(mutable=True),
         "rule_criteria": Property(mutable=True, json_object=RuleCriteria),
-        "trigger_conditions": Property(mutable=True, json_object=TriggerConditions),
-        "alert_channels": Property(mutable=True, json_object=AlertChannelEnvelope),
+        "trigger_conditions": Property(
+            mutable=True, json_object=TriggerConditions
+        ),
+        "alert_channels": Property(mutable=True, json_object=Alerts),
         "created": Property(is_datetime=True),
         "updated": Property(is_datetime=True),
         "updated_by": Property(),
@@ -377,24 +385,6 @@ class ChannelContent(JSONObject):
     # Other channel types like 'webhook', 'slack' could be added here as Optional fields.
 
 
-@dataclass
-class Alert(JSONObject):
-    """
-    Represents an alert definition reference within an AlertChannel.
-
-    Fields:
-      - id: int - Unique identifier of the alert definition.
-      - label: str - Human-readable name for the alert definition.
-      - type: str - Type of the alert (e.g., 'alerts-definitions').
-      - url: str - API URL for the alert definition.
-    """
-
-    id: int = 0
-    label: str = ""
-    type: str = ""
-    url: str = ""
-
-
 class AlertChannel(Base):
     """
     Represents an alert channel used to deliver notifications when alerts
@@ -417,8 +407,8 @@ class AlertChannel(Base):
         "label": Property(),
         "type": Property(),
         "channel_type": Property(),
-        "alerts": Property(),
-        "content": Property(),
+        "alerts": Property(mutable=False, json_object=Alerts),
+        "content": Property(mutable=False, json_object=ChannelContent),
         "created": Property(is_datetime=True),
         "updated": Property(is_datetime=True),
         "created_by": Property(),

test/integration/models/monitor/test_monitor.py

@@ -183,7 +183,7 @@ def test_integration_create_get_update_delete_alert_definition(
         assert getattr(created, "label", None) == label
 
         # Wait for server-side processing to complete (status transitions)
-        timeout = 120
+        timeout = 180  # max time alert should take to create
         interval = 10
         start = time.time()
         while (
@@ -194,12 +194,17 @@ def test_integration_create_get_update_delete_alert_definition(
             try:
                 created = client.load(AlertDefinition, created.id, service_type)
             except Exception:
-                # transient errors while polling; continue until timeout
+
                 pass
 
-        update_alert = client.load(AlertDefinition, created.id, service_type)
-        update_alert.label = f"{label}-updated"
-        update_alert.save()
+        if created:
+            update_alert = client.load(
+                AlertDefinition, created.id, service_type
+            )
+            update_alert.label = f"{label}-updated"
+            update_alert.save()
+        else:
+            pytest.fail("Alert definition was not created successfully")
 
         updated = client.load(AlertDefinition, update_alert.id, service_type)
         while (
@@ -226,16 +231,17 @@ def test_integration_create_get_update_delete_alert_definition(
                 )
                 delete_alert.delete()
             except Exception:
+                pytest.fail("Could not delete alert definition during cleanup")
                 pass
 
             # confirm it's gone (if API returns 404 or raises)
             try:
                 client.load(AlertDefinition, created.id, service_type)
                 # If no exception, fail explicitly
-                assert False, "Alert definition still retrievable after delete"
+                pytest.fail("Alert definition still retrievable after delete")
             except ApiError:
-                # Expected: alert definition is deleted and API returns 404 or similar error
+                pytest.skip("Alert definition successfully deleted")
                 pass
             except Exception:
-                # Any other exception is acceptable here, as the resource should be gone
+                pytest.skip("Alert definition successfully deleted")
                 pass