Feature/984: bulk update notification email addresses

[phjulia]

PR details

What changes did you make? (Give an overview)

• closes [FEATURE] bulk update notification email addresses  #984

Checklist

• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• test scripts updated
• Wiki updated (if applicable)

[phjulia]

TODO:

• Test method
• function for import file (no endpoint, need to retrieve, update notification email address and re-deploy)
• check if there are any other types apart for automation and import file where notifications can be set
• retrieve and update in retrieve + run document to update the .md with notifications. Remove retrieve in test method - it should no longer be necessary
• some email pre-validation (MC will return "bad payload" if email is not valid)
• some interactive questions, if someone provided a note but there is no email address, ask if they want to add an email address, otherwise skip the note

[JoernBerkefeld]

i know this is still in draft but I wanted to give you a few pointers early on :)

[github-actions]

Coverage Report

Commit:8e2670a
Base: develop@8e008d3

Type	Base	This PR
Total Statements Coverage	63.39%	63.69%  (+0.3%)
Total Branches Coverage	67.01%	68.23%  (+1.22%)
Total Functions Coverage	72.14%	72.25%  (+0.11%)
Total Lines Coverage	63.39%	63.69%  (+0.3%)

Details (changed files):

File	Statements	Branches	Functions	Lines
lib/cli.js	0%	0%	0%	0%
lib/index.js	69.5%	54.19%	68.57%	69.5%
lib/metadataTypes/Automation.js	81.12%	72.03%	95%	81.12%
lib/metadataTypes/ImportFile.js	82.26%	60%	100%	82.26%
lib/metadataTypes/MetadataType.js	77.32%	72.88%	70%	77.32%
lib/util/cli.js	36.22%	76.92%	23.07%	36.22%
lib/util/util.js	79.64%	75.59%	85.29%	79.64%

[phjulia]

TODO:

• email validation in interactive questions and in updateNotifications itself
• a test for importFile updateNotifications, a test for clearNotifications

[JoernBerkefeld]

DataVerification activities also have a notification option... but u need to know their id to update them

[phjulia]

DataVerification activities also have a notification option... but u need to know their id to update them

@JoernBerkefeld mcdev does not have data verification as a type yet. I would need to retrieve, then update and deploy like with importFile activity
Maybe in another PR?

[phjulia]

updateNotifications

Command: mcdev updateNotifications [business unit] [metadata type] [metadata key] [--completionEmail] [--errorEmail] [--completionNote] [--errorNote] [--clear]

Alias: mcdev un

Updates notification email addresses. There are 4 possible options for automations: --completionEmail, --errorEmail,
--completionNote and --errorNote. One or more can be specified. If you want to receive email notifications about failed/successful automation runs to more than one email address – list email addresses separated with a comma. You can also remove notification email addresses and/or notes with a --clear option. There are 4 possible values for --clear option: all completionEmail, errorEmail, notes.

Currently, this command supports automation, importFile and verification types. For import file there are only --clear and --completionEmail options. You can provide any value for --clear option in case of importFile and verification types.

Examples (set notifications):

mcdev updateNotifications MyProject/DEV automation [email protected] --completionNote='test note'
mcdev updateNotifications MyProject/DEV automation --errorEmail='[email protected],[email protected]' 
--completionNote='test note'
mcdev updateNotifications MyProject/DEV importFile [email protected]
mcdev updateNotifications MyProject/DEV verification [email protected]
mcdev updateNotifications MyProject/DEV verification [email protected] --completionNote='test note'

Examples (remove notifications):

mcdev updateNotifications MyProject/DEV automation --clear=all
mcdev updateNotifications MyProject/DEV automation --clear=completionEmail
mcdev updateNotifications MyProject/DEV automation --clear=errorEmail
mcdev updateNotifications MyProject/DEV automation --clear=notes
mcdev updateNotifications MyProject/DEV importFile --clear=true