Save e-mail contents in easy, machine-readable format #4098
Conversation
There was a problem hiding this comment.
Looks awesome, thanks for adding this enhancement @FlorianSW ! Added a few minor comments - please let me know if anything is unclear.. Thanks!
|
Thanks for the fast response and the awesome comments! I'll update the PR tomorrow, hope that's fine with you as well :) |
|
One slight hint as well: We just added the save of the e-mail to the text e-mail, not to the raw or templated e-mail. Simply because we use text e-mails only :) Is that ok for you, or should we invest some more time to have this functionality on the other send mail methods as well? 🤔 |
When using loclstack for development an even for easier integration/local testing of interaction with AWS services, a feature is missing to check if an e-mail was sent correctly. Issue #2514 was closed with a patch that dumped the e-mail contents to the log output. However, in most cases, this is not reliably useable for testing, as it would require to parse the log-stream of localstack. This commit now adds a feature where a sent e-mail is persisted to the local file system. It re-uses the specified data directory (DATA_DIR) and falls back to the temp directory to save e-mails into an `ses` subdirectory. Each successfully sent message is saved in a JSON file named after the message ID. The contents are the Source, Subject, Body, Destinations (To, CCs, BCCs) as well as the region. Co-Authored-By: Arne Wohlert <arne.wohlert@oss.volkswagen.com>
|
Not sure, if I should ask this question here or create an issue :) Is there a reason why the pipeline (Circle CI) is running the whole test suite once and then running the same test suite while running docker build again? Isn't that a bit duplicated? From what I got from the comment, I think the "run tests before pushing" is fulfilled with the test run outside of docker already? Background: It would greatly improve build times, especially when someone wants to build the image locally from a git branch which is already tested :) |
|
Awesome, thanks for the quick turnaround @FlorianSW ! 🚀 |
|
Thanks for the fast responses and the merge @whummer :) |
if an email was sent correctly but relied upon templated emails which the above PR
did not address.
I have essentially duplicated the work done in the above PR but amended it slightly
for the send_templated_email use case i.e. sending a templated email will dump said
email into the DATA_DIR in an ses subdirectory using the id of the sent email as
filename.
The contents of the JSON file are:
- Source
- Template
- TemplateData
- Destinations
e.g.
{
"Source": "user@example.com",
"Template": ["hello-world"],
"TemplateData": ["{\"A key\": \"A value\"}"],
"Destinations": {
"ToAddresses": ["success@example.com"],
"CcAddresses": [],
"BccAddresses": []
},
"Region": "us-east-1"
}
When using loclstack for development an even for easier integration/local testing
of interaction with AWS services, a feature is missing to check if an e-mail
was sent correctly.
Issue #2514 was closed with a patch that dumped the e-mail contents to the
log output. However, in most cases, this is not reliably useable for testing,
as it would require to parse the log-stream of localstack.
This commit now adds a feature where a sent e-mail is persisted to the local
file system. It re-uses the specified data directory (DATA_DIR) and falls back
to the temp directory to save e-mails into an
sessubdirectory. Eachsuccessfully sent message is saved in a JSON file named after the message ID.
The contents are the Source, Subject, Body, Destinations (To, CCs, BCCs) as
well as the region.
Co-Authored-By: Arne Wohlert arne.wohlert@oss.volkswagen.com