mcdev 5.0.2 → 5.2.0

package/test/mockRoot/deploy/testInstance/testBU/automation/testExisting_automation.automation-meta.json

@@ -0,0 +1,52 @@
+{
+    "description": "updated on deploy",
+    "key": "testExisting_automation",
+    "name": "testExisting_automation",
+    "r__folder_Path": "my automations",
+    "schedule": {
+        "endDate": "2022-07-30T00:00:00",
+        "icalRecur": "FREQ=DAILY;COUNT=1;INTERVAL=1",
+        "startDate": "2022-07-30T00:00:00",
+        "timezoneName": "W. Europe Standard Time"
+    },
+    "status": "PausedSchedule",
+    "steps": [
+        {
+            "activities": [
+                {
+                    "name": "testExisting_dataExtract",
+                    "r__type": "dataExtract"
+                },
+                {
+                    "name": "testExisting_emailSend",
+                    "r__type": "emailSend"
+                },
+                {
+                    "name": "testExisting_fileTransfer",
+                    "r__type": "fileTransfer"
+                },
+                {
+                    "name": "testExisting_importFile",
+                    "r__type": "importFile"
+                },
+                {
+                    "name": "testExisting_query",
+                    "r__type": "query"
+                },
+                {
+                    "name": "testExisting_script",
+                    "r__type": "script"
+                }
+            ],
+            "name": ""
+        }
+    ],
+    "notifications": [
+        {
+            "email": ["error-updated@test.accenture.com"],
+            "message": "test updated",
+            "type": "Error"
+        }
+    ],
+    "type": "scheduled"
+}

package/test/mockRoot/deploy/testInstance/testBU/automation/testNew_automation.automation-meta.json

@@ -0,0 +1,45 @@
+{
+    "description": "created on deploy",
+    "key": "testNew_automation",
+    "name": "testNew_automation",
+    "r__folder_Path": "my automations",
+    "schedule": {
+        "startDate": "2020-05-14T02:30:32.11",
+        "endDate": "2079-06-06T21:00:00",
+        "icalRecur": "FREQ=MINUTELY;UNTIL=20790607T050000;INTERVAL=5",
+        "timezoneName": "W. Europe Standard Time"
+    },
+    "status": "Scheduled",
+    "steps": [
+        {
+            "activities": [
+                {
+                    "name": "testExisting_dataExtract",
+                    "r__type": "dataExtract"
+                },
+                {
+                    "name": "testExisting_emailSend",
+                    "r__type": "emailSend"
+                },
+                {
+                    "name": "testExisting_fileTransfer",
+                    "r__type": "fileTransfer"
+                },
+                {
+                    "name": "testExisting_importFile",
+                    "r__type": "importFile"
+                },
+                {
+                    "name": "testExisting_query",
+                    "r__type": "query"
+                },
+                {
+                    "name": "testExisting_script",
+                    "r__type": "script"
+                }
+            ],
+            "name": ""
+        }
+    ],
+    "type": "scheduled"
+}

package/test/mockRoot/deploy/testInstance/testBU/dataExtract/testExisting_dataExtract.dataExtract-meta.json

@@ -0,0 +1,35 @@
+{
+    "name": "testExisting_dataExtract",
+    "key": "testExisting_dataExtract",
+    "description": "updated on deploy",
+    "r__dataExtractType_name": "Data Extension Extract",
+    "fileSpec": "testExisting-%%Year%%-%%Month%%-%%Day%%",
+    "intervalType": 0,
+    "dataFields": [
+        {
+            "name": "ColumnDelimiter",
+            "type": "string",
+            "value": ","
+        },
+        {
+            "name": "DECustomerKey",
+            "type": "string",
+            "value": "testExisting_dataExtension"
+        },
+        {
+            "name": "HasColumnHeaders",
+            "type": "bool",
+            "value": "False"
+        },
+        {
+            "name": "TextQualified",
+            "type": "bool",
+            "value": "False"
+        },
+        {
+            "name": "UsesLineFeed",
+            "type": "bool",
+            "value": "False"
+        }
+    ]
+}

package/test/mockRoot/deploy/testInstance/testBU/dataExtract/testNew_dataExtract.dataExtract-meta.json

@@ -0,0 +1,35 @@
+{
+    "name": "testNew_dataExtract",
+    "key": "testNew_dataExtract",
+    "description": "created via deploy",
+    "r__dataExtractType_name": "Data Extension Extract",
+    "fileSpec": "testNew-%%Year%%-%%Month%%-%%Day%%",
+    "intervalType": 0,
+    "dataFields": [
+        {
+            "name": "ColumnDelimiter",
+            "type": "string",
+            "value": ","
+        },
+        {
+            "name": "DECustomerKey",
+            "type": "string",
+            "value": "testExisting_dataExtension"
+        },
+        {
+            "name": "HasColumnHeaders",
+            "type": "bool",
+            "value": "False"
+        },
+        {
+            "name": "TextQualified",
+            "type": "bool",
+            "value": "False"
+        },
+        {
+            "name": "UsesLineFeed",
+            "type": "bool",
+            "value": "False"
+        }
+    ]
+}

package/test/mockRoot/deploy/testInstance/testBU/fileTransfer/testExisting_fileTransfer.fileTransfer-meta.json

@@ -0,0 +1,17 @@
+{
+    "createdDate": "2022-11-09T05:31:56.477",
+    "customerKey": "testExisting_fileTransfer",
+    "description": "17.11.2022",
+    "fileSpec": "%%Year%% updated via deploy",
+    "isCompressed": false,
+    "isEncrypted": false,
+    "isFileSpecLocalized": false,
+    "isPgp": false,
+    "isUpload": true,
+    "maxFileAge": 0,
+    "maxFileAgeScheduleOffset": 0,
+    "maxImportFrequency": 0,
+    "modifiedDate": "2022-11-17T07:13:20.05",
+    "name": "testExisting_fileTransfer",
+    "r__fileLocation_name": "ExactTarget Enhanced FTP"
+}

package/test/mockRoot/deploy/testInstance/testBU/fileTransfer/testNew_fileTransfer.fileTransfer-meta.json

@@ -0,0 +1,17 @@
+{
+    "createdDate": "2022-11-09T05:31:56.477",
+    "customerKey": "testNew_fileTransfer",
+    "description": "17.11.2022",
+    "fileSpec": "%%Year%% created on deploy",
+    "isCompressed": false,
+    "isEncrypted": false,
+    "isFileSpecLocalized": false,
+    "isPgp": false,
+    "isUpload": true,
+    "maxFileAge": 0,
+    "maxFileAgeScheduleOffset": 0,
+    "maxImportFrequency": 0,
+    "modifiedDate": "2022-11-17T07:13:20.05",
+    "name": "testNew_fileTransfer",
+    "r__fileLocation_name": "ExactTarget Enhanced FTP"
+}

package/test/mockRoot/deploy/testInstance/testBU/importFile/testExisting_importFile.importFile-meta.json

@@ -0,0 +1,29 @@
+{
+    "allowErrors": true,
+    "createdDate": "2022-11-09T05:32:30.533",
+    "customerKey": "testExisting_importFile",
+    "dateFormatLocale": "en-US",
+    "deleteFile": false,
+    "description": "updated on deploy",
+    "fieldMappingType": "InferFromColumnHeadings",
+    "fieldMappings": [],
+    "fileNamingPattern": "blabla",
+    "fileTransferLocationTypeId": 0,
+    "fileType": "CSV",
+    "filter": "",
+    "hasColumnHeader": true,
+    "isOrderedImport": true,
+    "isSequential": true,
+    "maxFileAgeHours": 0,
+    "maxFileAgeScheduleOffsetHours": 0,
+    "maxImportFrequencyHours": 0,
+    "modifiedDate": "2022-11-17T07:13:03.95",
+    "name": "testExisting_importFile",
+    "sendEmailNotification": false,
+    "standardQuotedStrings": true,
+    "r__fileLocation_name": "ExactTarget Enhanced FTP",
+    "c__destinationType": "DataExtension",
+    "r__dataExtension_CustomerKey": "testExisting_dataExtension",
+    "c__subscriberImportType": "DataExtension",
+    "c__dataAction": "AddUpdate"
+}

package/test/mockRoot/deploy/testInstance/testBU/importFile/testNew_importFile.importFile-meta.json

@@ -0,0 +1,29 @@
+{
+    "allowErrors": true,
+    "createdDate": "2022-11-09T05:32:30.533",
+    "customerKey": "testNew_importFile",
+    "dateFormatLocale": "en-US",
+    "deleteFile": false,
+    "description": "created via deploy",
+    "fieldMappingType": "InferFromColumnHeadings",
+    "fieldMappings": [],
+    "fileNamingPattern": "blabla",
+    "fileTransferLocationTypeId": 0,
+    "fileType": "CSV",
+    "filter": "",
+    "hasColumnHeader": true,
+    "isOrderedImport": true,
+    "isSequential": true,
+    "maxFileAgeHours": 0,
+    "maxFileAgeScheduleOffsetHours": 0,
+    "maxImportFrequencyHours": 0,
+    "modifiedDate": "2022-11-17T07:13:03.95",
+    "name": "testNew_importFile",
+    "sendEmailNotification": false,
+    "standardQuotedStrings": true,
+    "r__fileLocation_name": "ExactTarget Enhanced FTP",
+    "c__destinationType": "DataExtension",
+    "r__dataExtension_CustomerKey": "testExisting_dataExtension",
+    "c__subscriberImportType": "DataExtension",
+    "c__dataAction": "AddUpdate"
+}

package/test/mockRoot/deploy/testInstance/testBU/query/{testExistingQuery.query-meta.json → testExisting_query.query-meta.json}

@@ -1,6 +1,6 @@
 {
-    "name": "testExistingQuery",
-    "key": "testExistingQuery",
+    "name": "testExisting_query",
+    "key": "testExisting_query",
     "description": "updated on deploy",
     "targetKey": "testExisting_dataExtension",
     "createdDate": "2022-04-26T15:21:16.453",

package/test/mockRoot/deploy/testInstance/testBU/query/testExisting_query_fixKeys.query-meta.json

@@ -0,0 +1,11 @@
+{
+    "name": "testExisting_query_fixedKeys",
+    "key": "testExisting_query_fixKeys",
+    "description": "updated on deploy",
+    "targetKey": "testExisting_dataExtension",
+    "createdDate": "2022-04-26T15:21:16.453",
+    "modifiedDate": "2022-04-26T16:04:15.88",
+    "targetUpdateTypeName": "Overwrite",
+    "isFrozen": false,
+    "r__folder_Path": "Query"
+}

package/test/mockRoot/deploy/testInstance/testBU/query/testExisting_query_fixKeys.query-meta.sql

@@ -0,0 +1,6 @@
+SELECT
+    SubscriberKey as testField
+FROM
+    _Subscribers
+WHERE
+    country IN ('test')

package/test/mockRoot/deploy/testInstance/testBU/query/{testNewQuery.query-meta.json → testNew_query.query-meta.json}

@@ -1,6 +1,6 @@
 {
-    "name": "testNewQuery",
-    "key": "testNewQuery",
+    "name": "testNew_query",
+    "key": "testNew_query",
     "description": "created on deploy",
     "targetKey": "testExisting_dataExtension",
     "createdDate": "2022-04-26T15:21:16.453",

package/test/mockRoot/deploy/testInstance/testBU/script/testExisting_script.script-meta.json

@@ -0,0 +1,6 @@
+{
+    "description": "updated on deploy",
+    "key": "testExisting_script",
+    "name": "testExisting_script",
+    "r__folder_Path": "Scripts"
+}

package/test/mockRoot/deploy/testInstance/testBU/script/testExisting_script.script-meta.ssjs

@@ -0,0 +1 @@
+// dummy updated

package/test/mockRoot/deploy/testInstance/testBU/script/testNew_script.script-meta.json

@@ -0,0 +1,6 @@
+{
+    "description": "created on deploy",
+    "key": "testNew_script",
+    "name": "testNew_script",
+    "r__folder_Path": "Scripts"
+}

package/test/mockRoot/deploy/testInstance/testBU/script/testNew_script.script-meta.ssjs

@@ -0,0 +1 @@
+// dummy created

package/test/mockRoot/deploy/testInstance/testBU/triggeredSend/testExisting_triggeredSend.triggeredSend-meta.json

@@ -0,0 +1,29 @@
+{
+    "AllowedSlots": 0,
+    "AutoAddSubscribers": false,
+    "AutoUpdateSubscribers": false,
+    "BatchInterval": 0,
+    "BccEmail": "",
+    "CreatedDate": "2018-06-25T05:58:00",
+    "CustomerKey": "testExisting_triggeredSend",
+    "Description": "updated on deploy",
+    "DynamicEmailSubject": "You are successfully unsubscribed",
+    "EmailSubject": "You are successfully unsubscribed",
+    "FromAddress": "unsubscribe@emails.mcdev.accenture.com",
+    "FromName": "unsubscribe",
+    "IsMultipart": false,
+    "IsWrapped": true,
+    "Keyword": "",
+    "ModifiedDate": "2018-06-25T05:58:00",
+    "Name": "testExisting_triggeredSend",
+    "NewSlotTrigger": 0,
+    "Priority": 4,
+    "SendClassification": {
+        "CustomerKey": "Default Transactional"
+    },
+    "SuppressTracking": false,
+    "TriggeredSendStatus": "New",
+    "TriggeredSendType": "Continuous",
+    "r__email_Name": "Sporting Goods for September",
+    "r__folder_Path": "Triggered Sends"
+}

package/test/mockRoot/deploy/testInstance/testBU/triggeredSend/testNew_triggeredSend.triggeredSend-meta.json

@@ -0,0 +1,29 @@
+{
+    "AllowedSlots": 0,
+    "AutoAddSubscribers": false,
+    "AutoUpdateSubscribers": false,
+    "BatchInterval": 0,
+    "BccEmail": "",
+    "CreatedDate": "2018-06-25T05:58:00",
+    "CustomerKey": "testNew_triggeredSend",
+    "Description": "created on deploy",
+    "DynamicEmailSubject": "You are successfully unsubscribed",
+    "EmailSubject": "You are successfully unsubscribed",
+    "FromAddress": "unsubscribe@emails.mcdev.accenture.com",
+    "FromName": "unsubscribe",
+    "IsMultipart": false,
+    "IsWrapped": true,
+    "Keyword": "",
+    "ModifiedDate": "2018-06-25T05:58:00",
+    "Name": "testNew_triggeredSend",
+    "NewSlotTrigger": 0,
+    "Priority": 4,
+    "SendClassification": {
+        "CustomerKey": "Default Transactional"
+    },
+    "SuppressTracking": false,
+    "TriggeredSendStatus": "New",
+    "TriggeredSendType": "Continuous",
+    "r__email_Name": "Sporting Goods for September",
+    "r__folder_Path": "Triggered Sends"
+}

package/test/resourceFactory.js

@@ -1,42 +1,107 @@
 const fs = require('fs-extra');
 const path = require('node:path');
 const { XMLParser } = require('fast-xml-parser');
-const { color } = require('../lib/util/util');
+const Util = require('../lib/util/util');
 const parser = new XMLParser();
 const attributeParser = new XMLParser({ ignoreAttributes: false });
+let color;
+
+/* eslint-disable unicorn/prefer-ternary */
+if (
+    process.env.VSCODE_AMD_ENTRYPOINT === 'vs/workbench/api/node/extensionHostProcess' ||
+    process.env.VSCODE_CRASH_REPORTER_PROCESS_TYPE === 'extensionHost'
+) {
+    // when we execute the test in a VSCode extension host, we don't want CLI color codes.
+    color = new Proxy(
+        {},
+        {
+            /**
+             * catch-all for color
+             *
+             * @returns {string} empty string
+             */
+            get() {
+                return '';
+            },
+        }
+    );
+} else {
+    // test is executed directly in a command prompt. Use colors.
+    color = Util.color;
+}
+/* eslint-enable unicorn/prefer-ternary */
+
 /**
  * gets mock SOAP metadata for responding
  *
  * @param {string} mcdevAction SOAP action
  * @param {string} type metadata Type
  * @param {string} mid of Business Unit
+ * @param {object|string} filter likely for customer key
  * @returns {string} relevant metadata stringified
  */
-exports.loadSOAPRecords = async (mcdevAction, type, mid) => {
+exports.loadSOAPRecords = async (mcdevAction, type, mid, filter) => {
     type = type[0].toLowerCase() + type.slice(1);
-    const testPath = path.join(
-        'test',
-        'resources',
-        mid.toString(),
-        type,
-        mcdevAction + '-response.xml'
-    );
-    if (await fs.pathExists(testPath)) {
-        return fs.readFile(testPath, {
+    const testPath = path.join('test', 'resources', mid.toString(), type, mcdevAction);
+    const filterPath =
+        typeof filter === 'string' && filter ? '-' + filter : this.filterToPath(filter);
+    if (await fs.pathExists(testPath + filterPath + '-response.xml')) {
+        return fs.readFile(testPath + filterPath + '-response.xml', {
+            encoding: 'utf8',
+        });
+    } else if (await fs.pathExists(testPath + '-response.xml')) {
+        if (filterPath) {
+            /* eslint-disable no-console */
+            console.log(
+                `${color.bgYellow}${color.fgBlack}TEST-WARNING${
+                    color.reset
+                }: You are loading your reponse from ${
+                    testPath + '-response.xml'
+                } instead of the more specific ${
+                    testPath + filterPath + '-response.xml'
+                }. Make sure this is intended`
+            );
+            /* eslint-enable no-console */
+        }
+        return fs.readFile(testPath + '-response.xml', {
             encoding: 'utf8',
         });
     }
     /* eslint-disable no-console */
     console.log(
-        `${color.bgRed}${color.fgBlack}test-error${color.reset}: Please create file ${testPath}`
+        `${color.bgRed}${color.fgBlack}TEST-ERROR${color.reset}: Please create file ${
+            filterPath ? testPath + filterPath + '-response.xml or ' : ''
+        }${testPath + '-response.xml'}`
     );
     /* eslint-enable no-console */
-    process.exitCode = 404;
 
+    // return error
+    process.exitCode = 404;
     return fs.readFile(path.join('test', 'resources', mcdevAction + '-response.xml'), {
         encoding: 'utf8',
     });
 };
+exports.filterToPath = (filter) => {
+    if (filter) {
+        return '-' + this._filterToPath(filter);
+    }
+    return '';
+};
+exports._filterToPath = (filter) => {
+    if (filter.Property && filter.SimpleOperator) {
+        return `${filter.Property}${filter.SimpleOperator.replace('equals', '=')}${
+            filter.Value === undefined ? '' : filter.Value
+        }`;
+    } else if (filter.LeftOperand && filter.LogicalOperator && filter.RightOperand) {
+        return (
+            this._filterToPath(filter.LeftOperand) +
+            filter.LogicalOperator +
+            this._filterToPath(filter.RightOperand)
+        );
+    } else {
+        throw new Error('unknown filter type');
+    }
+};
 /**
  * based on request, respond with different soap data
  *
@@ -53,7 +118,8 @@ exports.handleSOAPRequest = async (config) => {
             responseXML = await this.loadSOAPRecords(
                 config.headers.SOAPAction.toLocaleLowerCase(),
                 jObj.Envelope.Body.RetrieveRequestMsg.RetrieveRequest.ObjectType,
-                jObj.Envelope.Header.fueloauth
+                jObj.Envelope.Header.fueloauth,
+                jObj.Envelope.Body.RetrieveRequestMsg.RetrieveRequest.Filter
             );
 
             break;
@@ -62,7 +128,8 @@ exports.handleSOAPRequest = async (config) => {
             responseXML = await this.loadSOAPRecords(
                 config.headers.SOAPAction.toLocaleLowerCase(),
                 fullObj.Envelope.Body.CreateRequest.Objects['@_xsi:type'],
-                jObj.Envelope.Header.fueloauth
+                jObj.Envelope.Header.fueloauth,
+                null
             );
 
             break;
@@ -71,7 +138,8 @@ exports.handleSOAPRequest = async (config) => {
             responseXML = await this.loadSOAPRecords(
                 config.headers.SOAPAction.toLocaleLowerCase(),
                 fullObj.Envelope.Body.UpdateRequest.Objects['@_xsi:type'],
-                jObj.Envelope.Header.fueloauth
+                jObj.Envelope.Header.fueloauth,
+                null
             );
 
             break;
@@ -82,13 +150,46 @@ exports.handleSOAPRequest = async (config) => {
                 fullObj.Envelope.Body.ConfigureRequestMsg.Configurations.Configuration[0][
                     '@_xsi:type'
                 ],
-                jObj.Envelope.Header.fueloauth
+                jObj.Envelope.Header.fueloauth,
+                null
+            );
+
+            break;
+        }
+        case 'Delete': {
+            responseXML = await this.loadSOAPRecords(
+                config.headers.SOAPAction.toLocaleLowerCase(),
+                fullObj.Envelope.Body.DeleteRequest.Objects['@_xsi:type'],
+                jObj.Envelope.Header.fueloauth,
+                null
+            );
+
+            break;
+        }
+        case 'Schedule': {
+            responseXML = await this.loadSOAPRecords(
+                config.headers.SOAPAction.toLocaleLowerCase(),
+                fullObj.Envelope.Body.ScheduleRequestMsg.Interactions.Interaction['@_xsi:type'],
+                jObj.Envelope.Header.fueloauth,
+                fullObj.Envelope.Body.ScheduleRequestMsg.Interactions.Interaction.ObjectID
+            );
+
+            break;
+        }
+        case 'Perform': {
+            responseXML = await this.loadSOAPRecords(
+                config.headers.SOAPAction.toLocaleLowerCase(),
+                fullObj.Envelope.Body.PerformRequestMsg.Definitions.Definition['@_xsi:type'],
+                jObj.Envelope.Header.fueloauth,
+                fullObj.Envelope.Body.PerformRequestMsg.Definitions.Definition.ObjectID
             );
 
             break;
         }
         default: {
-            throw new Error('This SOAP Action is not supported by test handler');
+            throw new Error(
+                `The SOAP Action ${config.headers.SOAPAction} is not supported by test handler`
+            );
         }
     }
 
@@ -121,15 +222,15 @@ exports.handleRESTRequest = async (config) => {
                 'resources',
                 config.headers.Authorization.replace('Bearer ', ''),
                 urlObj.pathname,
-                config.method + '-response.json'
+                config.method + '-response'
             )
             .replace(':', '_'); // replace : with _ for Windows
 
-        if (await fs.pathExists(testPath)) {
+        if (await fs.pathExists(testPath + '.json')) {
             // build filter logic to ensure templating works
             if (filterName) {
                 const response = JSON.parse(
-                    await fs.readFile(testPath, {
+                    await fs.readFile(testPath + '.json', {
                         encoding: 'utf8',
                     })
                 );
@@ -139,22 +240,29 @@ exports.handleRESTRequest = async (config) => {
             } else {
                 return [
                     200,
-                    await fs.readFile(testPath, {
+                    await fs.readFile(testPath + '.json', {
                         encoding: 'utf8',
                     }),
                 ];
             }
+        } else if (await fs.pathExists(testPath + '.txt')) {
+            return [
+                200,
+                await fs.readFile(testPath + '.txt', {
+                    encoding: 'utf8',
+                }),
+            ];
         } else {
             /* eslint-disable no-console */
             console.log(
-                `${color.bgRed}${color.fgBlack}test-error${color.reset}: Please create file ${testPath}`
+                `${color.bgRed}${color.fgBlack}TEST-ERROR${color.reset}: Please create file ${testPath}.json/.txt`
             );
             /* eslint-enable no-console */
             process.exitCode = 404;
 
             return [
                 404,
-                fs.readFile(path.join('test', 'resources', 'rest404-response.json'), {
+                await fs.readFile(path.join('test', 'resources', 'rest404-response.json'), {
                     encoding: 'utf8',
                 }),
             ];