MITLibraries / dspace-submission-composer / 13245892187

95%

push

github

Build framework for creating reports (#121)

Why these changes are being introduced:
* The app requires a framework for creating reports
that summarize results from DSC workflow runs. This framework
should support creating different reports for the three main
DSC CLI commands: reconcile, submit, and finalize.

How this addresses that need:
* Configure CLI commands to send reports by default
* Add report module for creating email data (i.e., subject heading,
file attachments, message body)
* Add HTML and plain-text templates (rendered by Jinja)
* Update SESClient to render message body in emails and accept multiple
attachments
* Create WorkflowEvents dataclass to capture useful report data
during execution of Workflow methods (replaces 'report_data' attribute)
* Reorganize logic in Workflow.process_sqs_queue, capturing all processed items
and differentiate between 'processing errors' and 'non-ingested items'
* Add test module for reporting framework
* Update tests as needed

Side effects of this change:
* As of this writing, the existing report templates are quite simple,
with the goal of getting to an minimum viable product. It would be good
to include in coming documentation what email recipients can expect
in the emailed report.

Relevant ticket(s):
* https://mitlibraries.atlassian.net/browse/IN-1157

107 of 120 new or added lines in 7 files covered. (89.17%)

560 of 580 relevant lines covered (96.55%)

0.97 hits per line