feat: Add Ses lambda event support to Parser utility #213

Author: Ran Isenberg

aws_lambda_powertools/utilities/parser/models/__init__.py

@@ -1,5 +1,6 @@
 from .dynamodb import DynamoDBStreamChangedRecordModel, DynamoDBStreamModel, DynamoDBStreamRecordModel
 from .event_bridge import EventBridgeModel
+from .ses import SesModel, SesRecordModel
 from .sns import SnsModel, SnsNotificationModel, SnsRecordModel
 from .sqs import SqsModel, SqsRecordModel
 
@@ -8,6 +9,8 @@
     "EventBridgeModel",
     "DynamoDBStreamChangedRecordModel",
     "DynamoDBStreamRecordModel",
+    "SesModel",
+    "SesRecordModel",
     "SnsModel",
     "SnsNotificationModel",
     "SnsRecordModel",

aws_lambda_powertools/utilities/parser/models/ses.py

@@ -0,0 +1,71 @@
+from datetime import datetime
+from typing import List, Optional
+
+from pydantic import BaseModel, Field
+from pydantic.networks import EmailStr
+from pydantic.types import PositiveInt
+from typing_extensions import Literal
+
+
+class SesReciptVerdict(BaseModel):
+    status: Literal["PASS", "FAIL", "GRAY", "PROCESSING_FAILED"]
+
+
+class SesReciptAction(BaseModel):
+    type: Literal["Lambda"]  # noqa A003,VNE003
+    invocationType: Literal["Event"]
+    functionArn: str
+
+
+class SesReceipt(BaseModel):
+    timestamp: datetime
+    processingTimeMillis: PositiveInt
+    recipients: List[EmailStr]
+    spamVerdict: SesReciptVerdict
+    virusVerdict: SesReciptVerdict
+    spfVerdict: SesReciptVerdict
+    dmarcVerdict: SesReciptVerdict
+    action: SesReciptAction
+
+
+class SesMailHeaders(BaseModel):
+    name: str
+    value: str
+
+
+class SesMailCommonHeaders(BaseModel):
+    header_from: List[str] = Field(None, alias="from")
+    to: List[str]
+    cc: Optional[List[str]]
+    bcc: Optional[List[str]]
+    sender: Optional[List[str]]
+    reply_to: Optional[List[str]] = Field(None, alias="reply-to")
+    returnPath: EmailStr
+    messageId: str
+    date: str
+    subject: str
+
+
+class SesMail(BaseModel):
+    timestamp: datetime
+    source: EmailStr
+    messageId: str
+    destination: List[EmailStr]
+    headersTruncated: bool
+    headers: List[SesMailHeaders]
+    commonHeaders: SesMailCommonHeaders
+
+
+class SesMessage(BaseModel):
+    mail: SesMail
+    receipt: SesReceipt
+
+
+class SesRecordModel(BaseModel):
+    eventSource: Literal["aws:ses"]
+    eventVersion: str
+    ses: SesMessage
+
+
+class SesModel(BaseModel):
+    Records: List[SesRecordModel]

pyproject.toml

@@ -51,7 +51,7 @@ flake8-bugbear = "^20.1.4"
 
 
 [tool.poetry.extras]
-pydantic = ["pydantic", "typing_extensions"]
+pydantic = ["pydantic", "typing_extensions", "pydantic[email]"]
 
 [tool.coverage.run]
 source = ["aws_lambda_powertools"]

tests/functional/parser/test_ses.py

@@ -0,0 +1,49 @@
+from aws_lambda_powertools.utilities.parser import event_parser
+from aws_lambda_powertools.utilities.parser.models import SesModel, SesRecordModel
+from aws_lambda_powertools.utilities.typing import LambdaContext
+from tests.functional.parser.utils import load_event
+
+
+@event_parser(model=SesModel)
+def handle_ses(event: SesModel, _: LambdaContext):
+    expected_address = "johndoe@example.com"
+    records = event.Records
+    record: SesRecordModel = records[0]
+    assert record.eventSource == "aws:ses"
+    assert record.eventVersion == "1.0"
+    mail = record.ses.mail
+    convert_time = int(round(mail.timestamp.timestamp() * 1000))
+    assert convert_time == 0
+    assert mail.source == "janedoe@example.com"
+    assert mail.messageId == "o3vrnil0e2ic28tr"
+    assert mail.destination == [expected_address]
+    assert mail.headersTruncated is False
+    headers = list(mail.headers)
+    assert len(headers) == 10
+    assert headers[0].name == "Return-Path"
+    assert headers[0].value == "<janedoe@example.com>"
+    common_headers = mail.commonHeaders
+    assert common_headers.returnPath == "janedoe@example.com"
+    assert common_headers.header_from == ["Jane Doe <janedoe@example.com>"]
+    assert common_headers.date == "Wed, 7 Oct 2015 12:34:56 -0700"
+    assert common_headers.to == [expected_address]
+    assert common_headers.messageId == "<0123456789example.com>"
+    assert common_headers.subject == "Test Subject"
+    receipt = record.ses.receipt
+    convert_time = int(round(receipt.timestamp.timestamp() * 1000))
+    assert convert_time == 0
+    assert receipt.processingTimeMillis == 574
+    assert receipt.recipients == [expected_address]
+    assert receipt.spamVerdict.status == "PASS"
+    assert receipt.virusVerdict.status == "PASS"
+    assert receipt.spfVerdict.status == "PASS"
+    assert receipt.dmarcVerdict.status == "PASS"
+    action = receipt.action
+    assert action.type == "Lambda"
+    assert action.functionArn == "arn:aws:lambda:us-west-2:012345678912:function:Example"
+    assert action.invocationType == "Event"
+
+
+def test_ses_trigger_event():
+    event_dict = load_event("sesEvent.json")
+    handle_ses(event_dict, LambdaContext())