feat: Improved AWS backup notification readability

functions/.flake8

@@ -1,6 +1,7 @@
 [flake8]
 max-complexity = 10
 max-line-length = 120
+extend-ignore = E203,E701
 exclude =
     .pytest_cache
     __pycache__/

functions/messages/backup.json

@@ -0,0 +1,41 @@
+{
+    "Records": [
+      {
+        "EventSource": "aws:sns",
+        "EventVersion": "1.0",
+        "EventSubscriptionArn": "arn:aws:sns:...-a3802aa1ed45",
+        "Sns": {
+          "Type": "Notification",
+          "MessageId": "12345678-abcd-123a-def0-abcd1a234567",
+          "TopicArn": "arn:aws:sns:us-west-1:123456789012:backup-2sqs-sns-topic",
+          "Subject": "Notification from AWS Backup",
+          "Message": "An AWS Backup job was completed successfully. Recovery point ARN: arn:aws:ec2:us-west-1:123456789012:volume/vol-012f345df6789012d. Resource ARN : arn:aws:ec2:us-west-1:123456789012:volume/vol-012f345df6789012e. BackupJob ID : 1b2345b2-f22c-4dab-5eb6-bbc7890ed123",
+          "Timestamp": "2019-08-02T18:46:02.788Z",
+          "MessageAttributes": {
+            "EventType": {
+              "Type": "String",
+              "Value": "BACKUP_JOB"
+            },
+            "State": {
+              "Type": "String",
+              "Value": "COMPLETED"
+            },
+            "AccountId": {
+              "Type": "String",
+              "Value": "123456789012"
+            },
+            "Id": {
+              "Type": "String",
+              "Value": "1b2345b2-f22c-4dab-5eb6-bbc7890ed123"
+            },
+            "StartTime": {
+              "Type": "String",
+              "Value": "2019-09-02T13:48:52.226Z"
+            }
+          }
+        }
+      }
+    ]
+  }
+
+

functions/notify_slack.py

@@ -266,6 +266,86 @@ def format_aws_health(message: Dict[str, Any], region: str) -> Dict[str, Any]:
     }
 
 
+def aws_backup_field_parser(message: str) -> Dict[str, Any]:
+    """
+    Parser for AWS Backup event message. It extracts the fields from the message and returns a dictionary.
+
+    :params message: message containing AWS Backup event
+    :returns: dictionary containing the fields extracted from the message
+    """
+    field_names = [
+        "Recovery point ARN",
+        "Resource ARN",
+        "BackupJob ID",
+        "Backup Job Id",
+        "Backed up Resource ARN",
+        "Status Message",
+    ]
+
+    first = None
+    field_match = ""
+
+    for field in field_names:
+        index = message.find(field)
+        if index != -1 and (first is None or index < first):
+            first = index
+            field_match = field
+
+    if first is not None:
+        next = None
+        for field in field_names:
+            index = message.find(field, first + len(field_match) + 1)
+            if index != -1 and (next is None or index < next):
+                next = index
+
+        if next is None:
+            next = len(message)
+
+        rem_message = message[next:]
+        fields = aws_backup_field_parser(rem_message)
+
+        text = message[first + len(field_match) + 1:next]
+        while text.startswith(" ") or text.startswith(":"):
+            text = text[1:]
+
+        fields[field_match] = text
+        return fields
+    else:
+        return {}
+
+
+def format_aws_backup(message: str) -> Dict[str, Any]:
+    """
+    Format AWS Backup event into Slack message format
+
+    :params message: SNS message body containing AWS Backup event
+    :returns: formatted Slack message payload
+    """
+
+    fields:list[Dict[str, Any]] = []
+    attachments = {}
+
+    title = message.split(".")[0]
+
+    if "failed" in title:
+        title = title + " ⚠️"
+
+    if "completed" in title:
+        title = title + " ✅"
+
+    fields.append({"title": title})
+
+    list_items = aws_backup_field_parser(message)
+
+    for k, v in list_items.items():
+        fields.append({"value": k, "short": False})
+        fields.append({"value": "```\n" + v + "\n```", "short": False})
+
+    attachments["fields"] = fields  # type: ignore
+
+    return attachments
+
+
 def format_default(
     message: Union[str, Dict], subject: Optional[str] = None
 ) -> Dict[str, Any]:
@@ -344,6 +424,10 @@ def get_slack_message_payload(
         notification = format_aws_health(message=message, region=message["region"])
         attachment = notification
 
+    elif subject == "Notification from AWS Backup":
+        notification = format_aws_backup(message=str(message))
+        attachment = notification
+
     elif "attachments" in message or "text" in message:
         payload = {**payload, **message}
 

functions/snapshots/snap_notify_slack_test.py

@@ -4,6 +4,7 @@
 
 from snapshottest import Snapshot
 
+
 snapshots = Snapshot()
 
 snapshots[
@@ -231,6 +232,42 @@
     }
 ]
 
+snapshots["test_sns_get_slack_message_payload_snapshots message_backup.json"] = [
+    {
+        "attachments": [
+            {
+                "fields": [
+                    {"title": "An AWS Backup job was completed successfully ✅"},
+                    {"short": False, "value": "BackupJob ID"},
+                    {
+                        "short": False,
+                        "value": """```
+1b2345b2-f22c-4dab-5eb6-bbc7890ed123
+```""",
+                    },
+                    {"short": False, "value": "Resource ARN"},
+                    {
+                        "short": False,
+                        "value": """```
+arn:aws:ec2:us-west-1:123456789012:volume/vol-012f345df6789012e.
+```""",
+                    },
+                    {"short": False, "value": "Recovery point ARN"},
+                    {
+                        "short": False,
+                        "value": """```
+arn:aws:ec2:us-west-1:123456789012:volume/vol-012f345df6789012d.
+```""",
+                    },
+                ]
+            }
+        ],
+        "channel": "slack_testing_sandbox",
+        "icon_emoji": ":aws:",
+        "username": "notify_slack_test",
+    }
+]
+
 snapshots[
     "test_sns_get_slack_message_payload_snapshots message_cloudwatch_alarm.json"
 ] = [