|
| 1 | +import json |
| 2 | +from typing import List |
| 3 | +from unittest import SkipTest |
| 4 | +from uuid import uuid4 |
| 5 | + |
| 6 | +import boto3 |
| 7 | +import pytest |
| 8 | + |
| 9 | +from moto import mock_aws, settings |
| 10 | +from moto.core import DEFAULT_ACCOUNT_ID as ACCOUNT_ID |
| 11 | +from moto.s3.models import FakeBucket, FakeKey |
| 12 | +from moto.s3.notifications import ( |
| 13 | + S3NotificationEvent, |
| 14 | + _detail_type, |
| 15 | + _send_event_bridge_message, |
| 16 | +) |
| 17 | + |
| 18 | +REGION_NAME = "us-east-1" |
| 19 | + |
| 20 | + |
| 21 | +@pytest.mark.parametrize( |
| 22 | + "event_names, expected_event_message", |
| 23 | + [ |
| 24 | + ( |
| 25 | + [ |
| 26 | + S3NotificationEvent.OBJECT_CREATED_PUT_EVENT, |
| 27 | + S3NotificationEvent.OBJECT_CREATED_POST_EVENT, |
| 28 | + S3NotificationEvent.OBJECT_CREATED_COPY_EVENT, |
| 29 | + S3NotificationEvent.OBJECT_CREATED_COMPLETE_MULTIPART_UPLOAD_EVENT, |
| 30 | + ], |
| 31 | + "Object Created", |
| 32 | + ), |
| 33 | + ( |
| 34 | + [ |
| 35 | + S3NotificationEvent.OBJECT_REMOVED_DELETE_EVENT, |
| 36 | + S3NotificationEvent.OBJECT_REMOVED_DELETE_MARKER_CREATED_EVENT, |
| 37 | + ], |
| 38 | + "Object Deleted", |
| 39 | + ), |
| 40 | + ([S3NotificationEvent.OBJECT_RESTORE_POST_EVENT], "Object Restore Initiated"), |
| 41 | + ( |
| 42 | + [S3NotificationEvent.OBJECT_RESTORE_COMPLETED_EVENT], |
| 43 | + "Object Restore Completed", |
| 44 | + ), |
| 45 | + ( |
| 46 | + [S3NotificationEvent.OBJECT_RESTORE_DELETE_EVENT], |
| 47 | + "Object Restore Expired", |
| 48 | + ), |
| 49 | + ( |
| 50 | + [S3NotificationEvent.LIFECYCLE_TRANSITION_EVENT], |
| 51 | + "Object Storage Class Changed", |
| 52 | + ), |
| 53 | + ([S3NotificationEvent.INTELLIGENT_TIERING_EVENT], "Object Access Tier Changed"), |
| 54 | + ([S3NotificationEvent.OBJECT_ACL_EVENT], "Object ACL Updated"), |
| 55 | + ([S3NotificationEvent.OBJECT_TAGGING_PUT_EVENT], "Object Tags Added"), |
| 56 | + ([S3NotificationEvent.OBJECT_TAGGING_DELETE_EVENT], "Object Tags Deleted"), |
| 57 | + ], |
| 58 | +) |
| 59 | +def test_detail_type(event_names: List[str], expected_event_message: str): |
| 60 | + for event_name in event_names: |
| 61 | + assert _detail_type(event_name) == expected_event_message |
| 62 | + |
| 63 | + |
| 64 | +def test_detail_type_unknown_event(): |
| 65 | + with pytest.raises(ValueError) as ex: |
| 66 | + _detail_type("unknown event") |
| 67 | + assert ( |
| 68 | + str(ex.value) |
| 69 | + == "unsupported event `unknown event` for s3 eventbridge notification (https://docs.aws.amazon.com/AmazonS3/latest/userguide/EventBridge.html)" |
| 70 | + ) |
| 71 | + |
| 72 | + |
| 73 | +@mock_aws |
| 74 | +def test_send_event_bridge_message(): |
| 75 | + # setup mocks |
| 76 | + events_client = boto3.client("events", region_name=REGION_NAME) |
| 77 | + logs_client = boto3.client("logs", region_name=REGION_NAME) |
| 78 | + rule_name = "test-rule" |
| 79 | + events_client.put_rule( |
| 80 | + Name=rule_name, EventPattern=json.dumps({"account": [ACCOUNT_ID]}) |
| 81 | + ) |
| 82 | + log_group_name = "/test-group" |
| 83 | + logs_client.create_log_group(logGroupName=log_group_name) |
| 84 | + mocked_bucket = FakeBucket(str(uuid4()), ACCOUNT_ID, REGION_NAME) |
| 85 | + mocked_key = FakeKey( |
| 86 | + "test-key", bytes("test content", encoding="utf-8"), ACCOUNT_ID |
| 87 | + ) |
| 88 | + |
| 89 | + # do nothing if event target does not exists. |
| 90 | + _send_event_bridge_message( |
| 91 | + ACCOUNT_ID, |
| 92 | + mocked_bucket, |
| 93 | + S3NotificationEvent.OBJECT_CREATED_PUT_EVENT, |
| 94 | + mocked_key, |
| 95 | + ) |
| 96 | + assert ( |
| 97 | + len(logs_client.filter_log_events(logGroupName=log_group_name)["events"]) == 0 |
| 98 | + ) |
| 99 | + |
| 100 | + # do nothing even if an error is raised while sending events. |
| 101 | + events_client.put_targets( |
| 102 | + Rule=rule_name, |
| 103 | + Targets=[ |
| 104 | + { |
| 105 | + "Id": "test", |
| 106 | + "Arn": f"arn:aws:logs:{REGION_NAME}:{ACCOUNT_ID}:log-group:{log_group_name}", |
| 107 | + } |
| 108 | + ], |
| 109 | + ) |
| 110 | + |
| 111 | + _send_event_bridge_message(ACCOUNT_ID, mocked_bucket, "unknown-event", mocked_key) |
| 112 | + assert ( |
| 113 | + len(logs_client.filter_log_events(logGroupName=log_group_name)["events"]) == 0 |
| 114 | + ) |
| 115 | + |
| 116 | + if not settings.TEST_DECORATOR_MODE: |
| 117 | + raise SkipTest(("Doesn't quite work right with the Proxy or Server")) |
| 118 | + # an event is correctly sent to the log group. |
| 119 | + _send_event_bridge_message( |
| 120 | + ACCOUNT_ID, |
| 121 | + mocked_bucket, |
| 122 | + S3NotificationEvent.OBJECT_CREATED_PUT_EVENT, |
| 123 | + mocked_key, |
| 124 | + ) |
| 125 | + events = logs_client.filter_log_events(logGroupName=log_group_name)["events"] |
| 126 | + assert len(events) == 1 |
| 127 | + event_msg = json.loads(events[0]["message"]) |
| 128 | + assert event_msg["detail-type"] == "Object Created" |
| 129 | + assert event_msg["source"] == "aws.s3" |
| 130 | + assert event_msg["region"] == REGION_NAME |
| 131 | + assert event_msg["resources"] == [f"arn:aws:s3:::{mocked_bucket.name}"] |
| 132 | + event_detail = event_msg["detail"] |
| 133 | + assert event_detail["bucket"] == {"name": mocked_bucket.name} |
| 134 | + assert event_detail["object"]["key"] == mocked_key.name |
| 135 | + assert event_detail["reason"] == "ObjectCreated" |
0 commit comments