mcdev 5.0.2 → 5.1.0

package/test/resourceFactory.js

@@ -10,33 +10,55 @@ const attributeParser = new XMLParser({ ignoreAttributes: false });
  * @param {string} mcdevAction SOAP action
  * @param {string} type metadata Type
  * @param {string} mid of Business Unit
+ * @param {object} 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 = 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 ${
+            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 && filter.Property && filter.SimpleOperator && filter.Value) {
+        return `-${filter.Property}${filter.SimpleOperator.replace('equals', '=')}${filter.Value}`;
+    }
+    return '';
+};
 /**
  * based on request, respond with different soap data
  *
@@ -53,7 +75,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 +85,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 +95,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,7 +107,18 @@ 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;
@@ -121,15 +157,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,15 +175,22 @@ 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;

package/test/resources/9999999/automation/build-expected.json

@@ -0,0 +1,58 @@
+{
+    "description": "foobar",
+    "key": "testTemplated_automation",
+    "name": "testTemplated_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",
+        "typeId": 3
+    },
+    "status": "PausedSchedule",
+    "steps": [
+        {
+            "activities": [
+                {
+                    "name": "testTemplated_dataExtract",
+                    "r__type": "dataExtract"
+                },
+                {
+                    "name": "testTemplated_emailSend",
+                    "r__type": "emailSend"
+                },
+                {
+                    "name": "testTemplated_fileTransfer",
+                    "r__type": "fileTransfer"
+                },
+                {
+                    "name": "testTemplated_importFile",
+                    "r__type": "importFile"
+                },
+                {
+                    "name": "testTemplated_query",
+                    "r__type": "query"
+                },
+                {
+                    "name": "testTemplated_script",
+                    "r__type": "script"
+                }
+            ],
+            "name": ""
+        }
+    ],
+    "type": "scheduled",
+    "notifications": [
+        {
+            "email": ["complete@test.accenture.com"],
+            "message": "",
+            "type": "Complete"
+        },
+        {
+            "email": ["error@test.accenture.com"],
+            "message": "test",
+            "type": "Error"
+        }
+    ]
+}

package/test/resources/9999999/automation/create-expected.json

@@ -0,0 +1,46 @@
+{
+    "description": "created on deploy",
+    "key": "testNew_automation",
+    "name": "testNew_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",
+        "typeId": 3
+    },
+    "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": ""
+        }
+    ],
+    "type": "scheduled"
+}

package/test/resources/9999999/automation/create-testNew_automation-expected.md

@@ -0,0 +1,28 @@
+## testNew_automation
+
+**Description:** created on deploy
+
+**Folder:** my automations/
+
+**Started by:** Schedule
+
+**Status:** PausedSchedule
+
+**Schedule:**
+
+* Start: 2022-07-30 00:00:00 +01:00
+* End: 2022-07-30 00:00:00 +01:00
+* Timezone:  W. Europe Standard Time
+* Recurrance: every  day for 1 times
+
+**Notifications:** _none_
+
+
+| Step 1<br>_<small>-</small>_ |
+| --- |
+| _1.1: dataExtract_<br>testExisting_dataExtract |
+| _1.2: emailSend_<br>testExisting_emailSend |
+| _1.3: fileTransfer_<br>testExisting_fileTransfer |
+| _1.4: importFile_<br>testExisting_importFile |
+| _1.5: query_<br>testExisting_query |
+| _1.6: script_<br>testExisting_script |

package/test/resources/9999999/automation/delete-response.xml

@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="utf-8"?>
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+    xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"
+    xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
+    xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
+    <soap:Header>
+        <wsa:Action>DeleteResponse</wsa:Action>
+        <wsa:MessageID>urn:uuid:cc45bb83-15a3-4a82-ba48-47ac4fb13000</wsa:MessageID>
+        <wsa:RelatesTo>urn:uuid:29986848-a0c3-4f3b-bf5a-91151f784449</wsa:RelatesTo>
+        <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>
+        <wsse:Security>
+            <wsu:Timestamp wsu:Id="Timestamp-4e8dad58-7a68-4653-8406-a172d1960c8a">
+                <wsu:Created>2023-06-02T13:41:30Z</wsu:Created>
+                <wsu:Expires>2023-06-02T13:46:30Z</wsu:Expires>
+            </wsu:Timestamp>
+        </wsse:Security>
+    </soap:Header>
+    <soap:Body>
+        <DeleteResponse xmlns="http://exacttarget.com/wsdl/partnerAPI">
+            <Results>
+                <StatusCode>OK</StatusCode>
+                <StatusMessage>Program deleted</StatusMessage>
+                <OrdinalID>0</OrdinalID>
+                <Object xsi:type="Automation">
+                    <PartnerKey xsi:nil="true" />
+                    <ObjectID>08afb0e2-b00a-4c88-ad2e-1f7f8788c560</ObjectID>
+                    <CustomerKey>testExisting_automation</CustomerKey>
+                    <IsPlatformObject>false</IsPlatformObject>
+                    <Name />
+                    <Description />
+                    <IsActive>true</IsActive>
+                </Object>
+            </Results>
+            <RequestID>898702fc-a432-4176-8130-5d6dd5ad9ca6</RequestID>
+            <OverallStatus>OK</OverallStatus>
+        </DeleteResponse>
+    </soap:Body>
+</soap:Envelope>

package/test/resources/9999999/automation/retrieve-expected.json

@@ -0,0 +1,58 @@
+{
+    "description": "bla bla",
+    "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",
+        "typeId": 3
+    },
+    "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": ""
+        }
+    ],
+    "type": "scheduled",
+    "notifications": [
+        {
+            "email": ["complete@test.accenture.com"],
+            "message": "",
+            "type": "Complete"
+        },
+        {
+            "email": ["error@test.accenture.com"],
+            "message": "test",
+            "type": "Error"
+        }
+    ]
+}

package/test/resources/9999999/automation/retrieve-testExisting_automation-expected.md

@@ -0,0 +1,30 @@
+## testExisting_automation
+
+**Description:** bla bla
+
+**Folder:** my automations/
+
+**Started by:** Schedule
+
+**Status:** PausedSchedule
+
+**Schedule:**
+
+* Start: 2022-07-30 00:00:00 +01:00
+* End: 2022-07-30 00:00:00 +01:00
+* Timezone:  W. Europe Standard Time
+* Recurrance: every  day for 1 times
+
+**Notifications:**
+
+* Complete: complete@test.accenture.com
+* Error: error@test.accenture.com ("test")
+
+| Step 1<br>_<small>-</small>_ |
+| --- |
+| _1.1: dataExtract_<br>testExisting_dataExtract |
+| _1.2: emailSend_<br>testExisting_emailSend |
+| _1.3: fileTransfer_<br>testExisting_fileTransfer |
+| _1.4: importFile_<br>testExisting_importFile |
+| _1.5: query_<br>testExisting_query |
+| _1.6: script_<br>testExisting_script |

package/test/resources/9999999/automation/template-expected.json

@@ -0,0 +1,58 @@
+{
+    "description": "{{{description}}}",
+    "key": "{{{prefix}}}automation",
+    "name": "{{{prefix}}}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",
+        "typeId": 3
+    },
+    "status": "PausedSchedule",
+    "steps": [
+        {
+            "activities": [
+                {
+                    "name": "{{{prefix}}}dataExtract",
+                    "r__type": "dataExtract"
+                },
+                {
+                    "name": "{{{prefix}}}emailSend",
+                    "r__type": "emailSend"
+                },
+                {
+                    "name": "{{{prefix}}}fileTransfer",
+                    "r__type": "fileTransfer"
+                },
+                {
+                    "name": "{{{prefix}}}importFile",
+                    "r__type": "importFile"
+                },
+                {
+                    "name": "{{{prefix}}}query",
+                    "r__type": "query"
+                },
+                {
+                    "name": "{{{prefix}}}script",
+                    "r__type": "script"
+                }
+            ],
+            "name": ""
+        }
+    ],
+    "type": "scheduled",
+    "notifications": [
+        {
+            "email": ["complete@test.accenture.com"],
+            "message": "",
+            "type": "Complete"
+        },
+        {
+            "email": ["error@test.accenture.com"],
+            "message": "test",
+            "type": "Error"
+        }
+    ]
+}

package/test/resources/9999999/automation/update-expected.json

@@ -0,0 +1,46 @@
+{
+    "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",
+        "typeId": 3
+    },
+    "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": ""
+        }
+    ],
+    "type": "scheduled"
+}

package/test/resources/9999999/automation/update-testExisting_automation-expected.md

@@ -0,0 +1,28 @@
+## testExisting_automation
+
+**Description:** updated on deploy
+
+**Folder:** my automations/
+
+**Started by:** Schedule
+
+**Status:** PausedSchedule
+
+**Schedule:**
+
+* Start: 2022-07-30 00:00:00 +01:00
+* End: 2022-07-30 00:00:00 +01:00
+* Timezone:  W. Europe Standard Time
+* Recurrance: every  day for 1 times
+
+**Notifications:** _none_
+
+
+| Step 1<br>_<small>-</small>_ |
+| --- |
+| _1.1: dataExtract_<br>testExisting_dataExtract |
+| _1.2: emailSend_<br>testExisting_emailSend |
+| _1.3: fileTransfer_<br>testExisting_fileTransfer |
+| _1.4: importFile_<br>testExisting_importFile |
+| _1.5: query_<br>testExisting_query |
+| _1.6: script_<br>testExisting_script |

package/test/resources/9999999/automation/v1/automations/08afb0e2-b00a-4c88-ad2e-1f7f8788c560/get-response.json

@@ -0,0 +1,85 @@
+{
+    "id": "08afb0e2-b00a-4c88-ad2e-1f7f8788c560",
+    "name": "testExisting_automation",
+    "description": "bla bla",
+    "key": "testExisting_automation",
+    "typeId": 1,
+    "type": "scheduled",
+    "statusId": 4,
+    "status": "PausedSchedule",
+    "categoryId": 290937,
+    "schedule": {
+        "id": "b393aa6c-a4a8-4c0f-a148-9250258a7339",
+        "typeId": 3,
+        "startDate": "2022-07-30T00:00:00",
+        "endDate": "2022-07-30T00:00:00",
+        "scheduledTime": "0001-01-01T07:00:00",
+        "rangeTypeId": 0,
+        "occurrences": 1,
+        "pattern": "<Pattern><PatternType>0</PatternType><DayInterval>1</DayInterval></Pattern>",
+        "icalRecur": "FREQ=DAILY;COUNT=1;INTERVAL=1",
+        "timezoneName": "W. Europe Standard Time",
+        "scheduleStatus": "paused",
+        "timezoneId": 5
+    },
+    "steps": [
+        {
+            "id": "13fda077-0e82-4936-b936-a36b0997fc44",
+            "name": "",
+            "step": 1,
+            "activities": [
+                {
+                    "id": "8081a992-a27d-4a43-984a-d60114ea1025",
+                    "name": "testExisting_dataExtract",
+                    "activityObjectId": "56c5370a-f988-4f36-b0ee-0f876573f6d7",
+                    "objectTypeId": 73,
+                    "displayOrder": 1
+                },
+                {
+                    "id": "d3774dc2-a271-4a44-8cbe-f630a6d6545e",
+                    "name": "testExisting_emailSend",
+                    "activityObjectId": "9b1c7bf9-4964-ed11-b849-48df37d1de8b",
+                    "objectTypeId": 42,
+                    "displayOrder": 2
+                },
+                {
+                    "id": "2c77fc42-85eb-4611-98f9-223d29d89d72",
+                    "name": "testExisting_fileTransfer",
+                    "activityObjectId": "72c328ac-f5b0-4e37-91d3-a775666f15a6",
+                    "objectTypeId": 53,
+                    "displayOrder": 3
+                },
+                {
+                    "id": "298b2794-28cb-4c70-b7ad-58b2c8cf48f7",
+                    "name": "testExisting_importFile",
+                    "activityObjectId": "9d16f42c-2260-ed11-b849-48df37d1de8b",
+                    "objectTypeId": 43,
+                    "displayOrder": 4,
+                    "targetDataExtensions": [
+                        {
+                            "id": "21711373-72c1-ec11-b83b-48df37d1deb7",
+                            "name": "testExisting_dataExtension",
+                            "key": "testExisting_dataExtension",
+                            "description": "bla bla",
+                            "rowCount": 0
+                        }
+                    ]
+                },
+                {
+                    "id": "e3774dc2-a271-4a44-8cbe-f630a6d6545e",
+                    "name": "testExisting_query_WRONG_NAME",
+                    "activityObjectId": "549f0568-607c-4940-afef-437965094dat",
+                    "objectTypeId": 300,
+                    "displayOrder": 5
+                },
+                {
+                    "id": "g3774dc2-a271-4a44-8cbe-f630a6d6545e",
+                    "name": "testExisting_script",
+                    "activityObjectId": "39f6a488-20eb-4ba0-b0b9-023725b574e4",
+                    "objectTypeId": 423,
+                    "displayOrder": 6
+                }
+            ]
+        }
+    ]
+}