Skip to content

Commit eeeac64

Browse files
committed
fix(data_classes): return None from CloudWatchAlarmMetric.metric_stat for expression entries
`metric_stat` read `self["metricStat"]` directly, so it raised `KeyError` on the expression entries of a metric math alarm. `expression` and `label` in the same class already use `self.get(...)` for optional keys; this makes `metric_stat` consistent with them. The repository's own `cloudWatchAlarmEventSingleMetric.json` fixture has this shape — its first metric (`e1`, `expression: "m1/m2"`) has no `metricStat` — so the new test reproduces it without any synthetic payload. Signed-off-by: ShussMiao <168898188+ShussMiao@users.noreply.github.com>
1 parent 26deef8 commit eeeac64

2 files changed

Lines changed: 26 additions & 2 deletions

File tree

‎aws_lambda_powertools/utilities/data_classes/cloud_watch_alarm_event.py‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,15 @@ def return_data(self) -> bool:
9090
return self["returnData"]
9191

9292
@property
93-
def metric_stat(self) -> CloudWatchAlarmMetricStat:
94-
return CloudWatchAlarmMetricStat(self["metricStat"])
93+
def metric_stat(self) -> CloudWatchAlarmMetricStat | None:
94+
"""
95+
Optional metric stat of the alarm metric.
96+
97+
Metric math alarms list expression entries alongside metric entries, and an
98+
expression entry has no metricStat.
99+
"""
100+
metric_stat = self.get("metricStat")
101+
return CloudWatchAlarmMetricStat(metric_stat) if metric_stat else None
95102

96103

97104
class CloudWatchAlarmMetricStat(DictWrapper):

‎tests/unit/data_classes/required_dependencies/test_cloud_watch_alarm_event.py‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,23 @@ def test_cloud_watch_alarm_event_single_metric():
5757
assert isinstance(metric_1.metric_stat.metric, dict)
5858

5959

60+
def test_cloud_watch_alarm_metric_stat_is_none_for_expression_entries():
61+
raw_event = load_event("cloudWatchAlarmEventSingleMetric.json")
62+
parsed_event = CloudWatchAlarmEvent(raw_event)
63+
metrics = parsed_event.alarm_data.configuration.metrics
64+
65+
# GIVEN a metric math alarm, whose expression entries carry no metricStat key
66+
expression_metric = metrics[0]
67+
assert expression_metric.expression is not None
68+
assert "metricStat" not in raw_event["alarmData"]["configuration"]["metrics"][0]
69+
70+
# THEN metric_stat must return None like expression and label do, not raise KeyError
71+
assert expression_metric.metric_stat is None
72+
73+
# AND iterating every metric's metric_stat must be safe
74+
assert [metric.metric_stat is not None for metric in metrics] == [False, True, True]
75+
76+
6077
def test_cloud_watch_alarm_event_composite_metric():
6178
raw_event = load_event("cloudWatchAlarmEventCompositeMetric.json")
6279
parsed_event = CloudWatchAlarmEvent(raw_event)

0 commit comments

Comments
 (0)