Feature/1301 no owner check for assets + Task/905 test callout payloads

[JoernBerkefeld]

PR details

What changes did you make? (Give an overview)

• closes [FEATURE] no owner check for assets #1301
• closes [FEATURE] automatically add suffix to key #1302
• closes [TASK] allow testing for what we send to axios #905

Further details (optional)

...

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 (Feature/1301 no owner check for assets + Task/905 test callout payloads #1308 (comment))

[github-actions]

Coverage Report

Commit:69f8990
Base: develop@fd951ea

Type	Base	This PR
Total Statements Coverage	65.87%	66.47%  (+0.6%)
Total Branches Coverage	67.03%	66.75%  (-0.28%)
Total Functions Coverage	75.49%	76.8%  (+1.31%)
Total Lines Coverage	65.87%	66.47%  (+0.6%)

Details (changed files):

File	Statements	Branches	Functions	Lines
lib/cli.js	0%	0%	0%	0%
lib/index.js	69.09%	56.75%	67.64%	69.09%
lib/metadataTypes/Asset.js	55.03%	50%	70.27%	55.03%
lib/metadataTypes/MetadataType.js	78.63%	74.68%	71.42%	78.63%
lib/util/auth.js	62%	76.47%	66.66%	62%

[JoernBerkefeld]

• [FEATURE] no owner check for assets #1301 / Feature/1301 no owner check for assets + Task/905 test callout payloads #1308
• [FEATURE] automatically add suffix to key #1302 / Feature/1302 + Bugfix/1298 automatically add suffix to key #1303

https://github.com/Accenture/sfmc-devtools/wiki/06.b-~-Standard-Commands/_edit

deploy

Command: mcdev deploy [business unit] [metadata type] [metadata key] [--fromRetrieve] [--refresh] [--keySuffix] [--noMidSuffix] [--changeKeyValue=yourNewKey] [--changeKeyField=otherFieldInJson] [--execute] [--schedule] [--fixShared]

Alias: mcdev d

deploy and change key:

Because of the special nature of the key field (with its various names across the metadata types) it cannot be simply updated by changing the value in the JSON. A deployment would otherwise trigger creating a new entry instead of updating the existing one. To still allow you to change the key value, like you could in the GUI, you have to use the optional parameters --changeKeyValue or --changeKeyField.

In some scenarios, all you want is to append a suffix (e.g. for assets because they share the key across BUs or for shared DataExtensions). For that, we've added --keySuffix. You can use it stand-alone or together with --changeKeyField. Be aware that if the maximum key-length is exhausted already, --keySuffix will automatically cut of the end of your existing key to add the suffix you specified!

Lastly, there is the option --noMidSuffix which deactivates automatically adding the MID suffix when you try to clone an asset to another BU. If you want to specify your own suffix to prevent the unique-key error during creation, this is your friend. Make sure to use this command together with --keySuffix or after applying a suffix via templating (buildTemplate/buildDefinition).

Examples:

# changeKeyField
mcdev deploy MyProject/DEV dataExtension --changeKeyField=Name
mcdev deploy MyProject/DEV dataExtension key2 --changeKeyField=Name
mcdev deploy MyProject/DEV dataExtension "key2,key3" --changeKeyField=Name

# changeKeyValue
mcdev deploy MyProject/DEV dataExtension key1 --changeKeyValue=key2

# keySuffix
mcdev deploy MyProject/DEV dataExtension --changeKeyField=Name --keySuffix "_DEV"
mcdev deploy MyProject/DEV dataExtension myKey --keySuffix "_DEV"
mcdev deploy MyProject/DEV dataExtension --keySuffix "_DEV"

# noMidSuffix
mcdev deploy MyProject/DEV asset--changeKeyField=name --noMidSuffix --keySuffix "_DEV"
mcdev deploy MyProject/DEV asset myKey --noMidSuffix --keySuffix "_DEV"
mcdev deploy MyProject/DEV asset --noMidSuffix --keySuffix "_DEV"

# noMidSuffix with templating
# - step 1 (create template with market that replaces for "_DEV")
mcdev buildTemplate MyProject/DEV asset myKey_DEV myMarketDEV
# - step 2 (filename stays unchanged after template creation for easier execution of buildDefinition)
mcdev buildDefinition MyProject/PROD asset myKey_DEV myMarketPROD
# - step 3 (key was changed to "myKey_PROD" by buildDefinition applying your prod market)
mcdev deploy MyProject/PROD asset myKey_PROD --noMidSuffix

The first of the 2 commands using --changeKeyField will deploy all dataExtensions in the deploy folder (optionally limited to the keys you specify) and try to overwrite their respective key with their name. Please ensure you check how that other field is spelled including upper-/lower-cased letters.

The second command uses --changeKeyValue can only be used if type AND key are specified. You pass along the exact new key value that we want to end up with. Therefore, in this example, your dataExtension with key "key1" will be updated to have the key "key2".

Note: Not every type allows updating the key. Please check our Metadata Type Support page for a full list.