Ministack: Free, open-source local AWS emulator - 60+ services, Terraform compatible, real databases. Free forever. MIT licensed.
Python awsaws-emulatoraws-localaws-sdkdevtoolsdockerdynamodbec2emulatorlambdalocalstacklocalstack-alternativeministackmock-awsopen-sourcepythons3sqsterraform
feat(cloudformation): support AWS::CloudWatch::Alarm (#265)
Mohammed Al-Dokimice59ab0c63d8
diff --git a/README.md b/README.mdindex 08bf324e..e4eb790d 100644--- a/README.md+++ b/README.md@@ -419,6 +419,7 @@ subnet = ec2.create_subnet(| `AWS::SES::EmailIdentity` | Identity | EmailIdentity || `AWS::WAFv2::WebACL` | WebACL ID | Arn, Id || `AWS::CloudFront::Distribution` | Distribution ID | Arn, DomainName, Id |+| `AWS::CloudWatch::Alarm` | Alarm name | Arn || `AWS::RDS::DBCluster` | Cluster ID | Arn, Endpoint.Address, Endpoint.Port, ReadEndpoint.Address || `AWS::AutoScaling::AutoScalingGroup` | ASG name | Arn || `AWS::AutoScaling::LaunchConfiguration` | LC name | Arn |diff --git a/ministack/services/cloudformation/provisioners.py b/ministack/services/cloudformation/provisioners.pyindex c86721df..06d855e7 100644--- a/ministack/services/cloudformation/provisioners.py+++ b/ministack/services/cloudformation/provisioners.py@@ -20,6 +20,7 @@ import ministack.services.sns as _snsimport ministack.services.dynamodb as _dynamodbimport ministack.services.lambda_svc as _lambda_svcimport ministack.services.ssm as _ssm+import ministack.services.cloudwatch as _cwimport ministack.services.cloudwatch_logs as _cw_logsimport ministack.services.eventbridge as _ebimport ministack.services.iam_sts as _iam_sts@@ -2142,6 +2143,96 @@ def _r53_record_set_delete(physical_id, props):]+# ---------------------------------------------------------------------------+# CloudWatch Alarm (standard metric alarms)+# ---------------------------------------------------------------------------+++def _cw_metric_alarm_create(logical_id, props, stack_name):+ if props.get("Metrics"):+ raise ValueError(+ "AWS::CloudWatch::Alarm Properties.Metrics (metric math) is not supported; "+ "use MetricName and Namespace."+ )+ name = props.get("AlarmName") or _physical_name(stack_name, logical_id, max_len=255)+ metric_name = props.get("MetricName")+ namespace = props.get("Namespace")+ if not metric_name or not namespace:+ raise ValueError("MetricName and Namespace are required for AWS::CloudWatch::Alarm")+ comparison = props.get("ComparisonOperator")+ if not comparison:+ raise ValueError("ComparisonOperator is required for AWS::CloudWatch::Alarm")+ if props.get("Threshold") is None:+ raise ValueError("Threshold is required for AWS::CloudWatch::Alarm")++ period = int(props.get("Period", 60))+ eval_periods = int(props.get("EvaluationPeriods", 1))+ dta = props.get("DatapointsToAlarm")+ datapoints = int(dta if dta is not None else eval_periods)+ ext_stat = props.get("ExtendedStatistic") or None+ if isinstance(ext_stat, str) and not ext_stat.strip():+ ext_stat = None+ statistic = props.get("Statistic") or "Average"++ dims = props.get("Dimensions") or []+ if not isinstance(dims, list):+ dims = []++ ae = props.get("ActionsEnabled", True)+ if isinstance(ae, str):+ ae = ae.lower() not in ("false", "0", "no")++ def _as_str_list(key):+ v = props.get(key) or []+ if isinstance(v, list):+ return [str(x) for x in v]+ if v in (None, ""):+ return []+ return [str(v)]++ alarm_actions = _as_str_list("AlarmActions")+ ok_actions = _as_str_list("OKActions")+ insuff_actions = _as_str_list("InsufficientDataActions")+ treat = props.get("TreatMissingData", "missing") or "missing"++ alarm = {+ "AlarmName": name,+ "AlarmArn": f"arn:aws:cloudwatch:{REGION}:{get_account_id()}:alarm:{name}",+ "AlarmDescription": props.get("AlarmDescription", "") or "",+ "MetricName": metric_name,+ "Namespace": namespace,+ "Statistic": statistic,+ "ExtendedStatistic": ext_stat,+ "Period": period,+ "EvaluationPeriods": eval_periods,+ "DatapointsToAlarm": datapoints,+ "Threshold": float(props["Threshold"]),+ "ComparisonOperator": comparison,+ "TreatMissingData": treat,+ "StateValue": _cw._alarms[name]["StateValue"]+ if name in _cw._alarms+ else "INSUFFICIENT_DATA",+ "StateReason": _cw._alarms[name]["StateReason"]+ if name in _cw._alarms+ else "Unchecked: Initial alarm creation",+ "StateUpdatedTimestamp": time.time(),+ "ActionsEnabled": ae,+ "AlarmActions": alarm_actions,+ "OKActions": ok_actions,+ "InsufficientDataActions": insuff_actions,+ "Dimensions": dims,+ "Unit": props.get("Unit"),+ "AlarmConfigurationUpdatedTimestamp": time.time(),+ }+ _cw.cloudformation_put_metric_alarm(alarm)+ arn = alarm["AlarmArn"]+ return name, {"Arn": arn}+++def _cw_metric_alarm_delete(physical_id, props):+ _cw.cloudformation_delete_metric_alarm(physical_id)++# ---------------------------------------------------------------------------# ApiGatewayV2 Api# ---------------------------------------------------------------------------@@ -2544,6 +2635,7 @@ _RESOURCE_HANDLERS = {"AWS::SES::EmailIdentity": {"create": _ses_email_identity_create, "delete": _ses_email_identity_delete},"AWS::WAFv2::WebACL": {"create": _waf_web_acl_create, "delete": _waf_web_acl_delete},"AWS::CloudFront::Distribution": {"create": _cf_distribution_create, "delete": _cf_distribution_delete},+ "AWS::CloudWatch::Alarm": {"create": _cw_metric_alarm_create, "delete": _cw_metric_alarm_delete},"AWS::RDS::DBCluster": {"create": _rds_db_cluster_create, "delete": _rds_db_cluster_delete},# CDK metadata — safe to ignore"AWS::CDK::Metadata": {"create": lambda lid, props, sn: (f"CDKMetadata-{lid}", {}), "delete": lambda pid, props: None},diff --git a/ministack/services/cloudwatch.py b/ministack/services/cloudwatch.pyindex 34e67d79..7477e922 100644--- a/ministack/services/cloudwatch.py+++ b/ministack/services/cloudwatch.py@@ -1410,6 +1410,34 @@ def _error(code, message, status, use_json=False):return status, {"Content-Type": "application/xml"}, body+# ---------------------------------------------------------------------------+# CloudFormation integration+# ---------------------------------------------------------------------------+++def cloudformation_put_metric_alarm(alarm: dict) -> None:+ """Store a PutMetricAlarm-shaped alarm dict (CloudFormation create/update)."""+ name = alarm["AlarmName"]+ is_new = name not in _alarms+ _alarms[name] = alarm+ if is_new:+ _record_history(+ name,+ "INSUFFICIENT_DATA",+ "INSUFFICIENT_DATA",+ "Unchecked: Initial alarm creation",+ )+ _evaluate_alarm(alarm)+++def cloudformation_delete_metric_alarm(name: str) -> None:+ """Remove a metric alarm created from a template (not composite alarms)."""+ _alarms.pop(name, None)+ _resource_tags.pop(+ f"arn:aws:cloudwatch:{REGION}:{get_account_id()}:alarm:{name}", None+ )++def reset():_alarms.clear()_composite_alarms.clear()diff --git a/tests/test_cfn.py b/tests/test_cfn.pyindex a3500411..ee7aa48c 100644--- a/tests/test_cfn.py+++ b/tests/test_cfn.py@@ -1172,6 +1172,27 @@ def test_cfn_elbv2_load_balancer_and_listener(cfn, elbv2):assert elbv2.describe_load_balancers(Names=[lb_name])["LoadBalancers"] == []+def test_cfn_cloudwatch_alarm_lifecycle(cfn, cw):+ """CloudFormation creates a metric alarm and removes it on stack delete."""+ uid = _uuid_mod.uuid4().hex[:8]+ stack_name = f"cfn-cwal-{uid}"+ alarm_name = f"cfn-cw-alarm-{uid}"+ template = {+ "AWSTemplateFormatVersion": "2010-09-09",+ "Resources": {+ "CpuAlarm": {+ "Type": "AWS::CloudWatch::Alarm",+ "Properties": {+ "AlarmName": alarm_name,+ "AlarmDescription": "CFN integration test",+ "MetricName": "CPUUtilization",+ "Namespace": f"CfnCwTest/{uid}",+ "Statistic": "Average",+ "Period": 60,+ "EvaluationPeriods": 1,+ "Threshold": 80.0,+ "ComparisonOperator": "GreaterThanThreshold",+ "TreatMissingData": "notBreaching",def test_cfn_route53_hosted_zone_and_record_set(cfn, r53):"""CloudFormation provisions Route53 HostedZone + RecordSet and removes records on delete."""uid = _uuid_mod.uuid4().hex[:8]@@ -1197,6 +1218,8 @@ def test_cfn_route53_hosted_zone_and_record_set(cfn, r53):},},"Outputs": {+ "AlarmNameOut": {"Value": {"Ref": "CpuAlarm"}},+ "AlarmArnOut": {"Value": {"Fn::GetAtt": ["CpuAlarm", "Arn"]}},"RecordFqdn": {"Value": {"Ref": "WebA"}},},}@@ -1205,6 +1228,20 @@ def test_cfn_route53_hosted_zone_and_record_set(cfn, r53):assert stack["StackStatus"] == "CREATE_COMPLETE"outputs = {o["OutputKey"]: o["OutputValue"] for o in stack.get("Outputs", [])}+ assert outputs["AlarmNameOut"] == alarm_name+ assert outputs["AlarmArnOut"].endswith(f":alarm:{alarm_name}")++ resp = cw.describe_alarms(AlarmNames=[alarm_name])+ assert len(resp["MetricAlarms"]) == 1+ a = resp["MetricAlarms"][0]+ assert a["MetricName"] == "CPUUtilization"+ assert a["Namespace"] == f"CfnCwTest/{uid}"+ assert float(a["Threshold"]) == 80.0++ cfn.delete_stack(StackName=stack_name)+ _wait_stack(cfn, stack_name)+ resp2 = cw.describe_alarms(AlarmNames=[alarm_name])+ assert resp2["MetricAlarms"] == []assert outputs["RecordFqdn"].endswith(".")resources = {r["LogicalResourceId"]: r for r in cfn.describe_stack_resources(StackName=stack_name)["StackResources"]}