mcdev 8.0.2 → 8.2.0

package/test/resources/9999999/dataExtensionField/retrieve-Name=FirstName-response.xml

@@ -0,0 +1,78 @@
+<?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>RetrieveResponse</wsa:Action>
+        <wsa:MessageID>urn:uuid:6d2f81c8-80ab-44d5-8664-206753e7ac8d</wsa:MessageID>
+        <wsa:RelatesTo>urn:uuid:a7354389-079e-4844-93b5-af6b7bf1d535</wsa:RelatesTo>
+        <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>
+        <wsse:Security>
+            <wsu:Timestamp wsu:Id="Timestamp-468a08b7-c8fd-44bf-a2c8-fd6063127ca6">
+                <wsu:Created>2022-04-21T19:21:52Z</wsu:Created>
+                <wsu:Expires>2022-04-21T19:26:52Z</wsu:Expires>
+            </wsu:Timestamp>
+        </wsse:Security>
+    </soap:Header>
+    <soap:Body>
+        <RetrieveResponseMsg xmlns="http://exacttarget.com/wsdl/partnerAPI">
+            <OverallStatus>OK</OverallStatus>
+            <RequestID>cfe51e71-6a2b-4cb4-aecd-3777076d63bc</RequestID>
+            <Results xsi:type="DataExtensionField">
+                <PartnerKey xsi:nil="true" />
+                <ObjectID>42760528-a8c5-44dd-8c1d-ff34e5daee54</ObjectID>
+                <CustomerKey>[testExisting_dataExtension].[FirstName]</CustomerKey>
+                <Name>FirstName</Name>
+                <Scale>0</Scale>
+                <DefaultValue />
+                <MaxLength>50</MaxLength>
+                <IsRequired>false</IsRequired>
+                <Ordinal>0</Ordinal>
+                <IsPrimaryKey>false</IsPrimaryKey>
+                <FieldType>Text</FieldType>
+                <DataExtension>
+                    <PartnerKey xsi:nil="true" />
+                    <ObjectID xsi:nil="true" />
+                    <CustomerKey>testExisting_dataExtension</CustomerKey>
+                </DataExtension>
+            </Results>
+            <Results xsi:type="DataExtensionField">
+                <PartnerKey xsi:nil="true" />
+                <ObjectID>5ccee5f6-f282-4741-899d-400b05c57425</ObjectID>
+                <CustomerKey>[testExisting_event - 2024-07-05T080154625].[FirstName]</CustomerKey>
+                <Name>FirstName</Name>
+                <DefaultValue />
+                <MaxLength>256</MaxLength>
+                <IsRequired>false</IsRequired>
+                <Ordinal>4</Ordinal>
+                <IsPrimaryKey>false</IsPrimaryKey>
+                <FieldType>Text</FieldType>
+                <DataExtension>
+                    <PartnerKey xsi:nil="true" />
+                    <ObjectID xsi:nil="true" />
+                    <CustomerKey>testExisting_event - 2024-07-05T080154625</CustomerKey>
+                </DataExtension>
+            </Results>
+            <Results xsi:type="DataExtensionField">
+                <PartnerKey xsi:nil="true" />
+                <ObjectID>5ccee5f6-f282-4741-899d-400b05c57425</ObjectID>
+                <CustomerKey>[testNew_event_withSchema - 2024-07-08T014814443].[FirstName]</CustomerKey>
+                <Name>FirstName</Name>
+                <DefaultValue />
+                <MaxLength>256</MaxLength>
+                <IsRequired>false</IsRequired>
+                <Ordinal>4</Ordinal>
+                <IsPrimaryKey>false</IsPrimaryKey>
+                <FieldType>Text</FieldType>
+                <DataExtension>
+                    <PartnerKey xsi:nil="true" />
+                    <ObjectID xsi:nil="true" />
+                    <CustomerKey>testNew_event_withSchema - 2024-07-08T014814443</CustomerKey>
+                </DataExtension>
+            </Results>
+        </RetrieveResponseMsg>
+    </soap:Body>
+</soap:Envelope>

package/test/resources/9999999/dataExtensionField/retrieve-Name=LastName-response.xml

@@ -0,0 +1,78 @@
+<?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>RetrieveResponse</wsa:Action>
+        <wsa:MessageID>urn:uuid:6d2f81c8-80ab-44d5-8664-206753e7ac8d</wsa:MessageID>
+        <wsa:RelatesTo>urn:uuid:a7354389-079e-4844-93b5-af6b7bf1d535</wsa:RelatesTo>
+        <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>
+        <wsse:Security>
+            <wsu:Timestamp wsu:Id="Timestamp-468a08b7-c8fd-44bf-a2c8-fd6063127ca6">
+                <wsu:Created>2022-04-21T19:21:52Z</wsu:Created>
+                <wsu:Expires>2022-04-21T19:26:52Z</wsu:Expires>
+            </wsu:Timestamp>
+        </wsse:Security>
+    </soap:Header>
+    <soap:Body>
+        <RetrieveResponseMsg xmlns="http://exacttarget.com/wsdl/partnerAPI">
+            <OverallStatus>OK</OverallStatus>
+            <RequestID>cfe51e71-6a2b-4cb4-aecd-3777076d63bc</RequestID>
+            <Results xsi:type="DataExtensionField">
+                <PartnerKey xsi:nil="true" />
+                <ObjectID>bea0e308-5d45-4181-a673-da9972a7c674</ObjectID>
+                <CustomerKey>[testExisting_dataExtension].[LastName]</CustomerKey>
+                <Name>LastName</Name>
+                <Scale>0</Scale>
+                <DefaultValue />
+                <MaxLength>50</MaxLength>
+                <IsRequired>false</IsRequired>
+                <Ordinal>1</Ordinal>
+                <IsPrimaryKey>false</IsPrimaryKey>
+                <FieldType>Text</FieldType>
+                <DataExtension>
+                    <PartnerKey xsi:nil="true" />
+                    <ObjectID xsi:nil="true" />
+                    <CustomerKey>testExisting_dataExtension</CustomerKey>
+                </DataExtension>
+            </Results>
+            <Results xsi:type="DataExtensionField">
+                <PartnerKey xsi:nil="true" />
+                <ObjectID>95948e52-e8d0-4908-98a9-cc34cd84233e</ObjectID>
+                <CustomerKey>[testExisting_event - 2024-07-05T080154625].[LastName]</CustomerKey>
+                <Name>LastName</Name>
+                <DefaultValue />
+                <MaxLength>256</MaxLength>
+                <IsRequired>false</IsRequired>
+                <Ordinal>5</Ordinal>
+                <IsPrimaryKey>false</IsPrimaryKey>
+                <FieldType>Text</FieldType>
+                <DataExtension>
+                    <PartnerKey xsi:nil="true" />
+                    <ObjectID xsi:nil="true" />
+                    <CustomerKey>testExisting_event - 2024-07-05T080154625</CustomerKey>
+                </DataExtension>
+            </Results>
+            <Results xsi:type="DataExtensionField">
+                <PartnerKey xsi:nil="true" />
+                <ObjectID>95948e52-e8d0-4908-98a9-cc34cd84233e</ObjectID>
+                <CustomerKey>[testNew_event_withSchema - 2024-07-08T014814443].[LastName]</CustomerKey>
+                <Name>LastName</Name>
+                <DefaultValue />
+                <MaxLength>256</MaxLength>
+                <IsRequired>false</IsRequired>
+                <Ordinal>5</Ordinal>
+                <IsPrimaryKey>false</IsPrimaryKey>
+                <FieldType>Text</FieldType>
+                <DataExtension>
+                    <PartnerKey xsi:nil="true" />
+                    <ObjectID xsi:nil="true" />
+                    <CustomerKey>testNew_event_withSchema - 2024-07-08T014814443</CustomerKey>
+                </DataExtension>
+            </Results>
+        </RetrieveResponseMsg>
+    </soap:Body>
+</soap:Envelope>

package/test/resources/9999999/triggeredSendSummary/get-expected.json

@@ -0,0 +1,24 @@
+{
+    "CustomerKey": "testExisting_triggeredSend",
+    "Sent": 10,
+    "NotSentDueToOptOut": 0,
+    "NotSentDueToUndeliverable": 0,
+    "Bounces": 0,
+    "Opens": 0,
+    "Clicks": 0,
+    "UniqueOpens": 0,
+    "UniqueClicks": 0,
+    "OptOuts": 0,
+    "SurveyResponses": 0,
+    "FTAFRequests": 0,
+    "FTAFEmailsSent": 0,
+    "FTAFOptIns": 0,
+    "Conversions": 0,
+    "UniqueConversions": 0,
+    "InProcess": 0,
+    "NotSentDueToError": 0,
+    "Queued": 0,
+    "r__folder_Path": "Triggered Sends",
+    "r__triggeredSend_name": "testExisting_triggeredSend",
+    "r__triggeredSend_key": "testExisting_triggeredSend"
+}

package/test/resources/9999999/triggeredSendSummary/retrieve-response.xml

@@ -0,0 +1,49 @@
+<?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>RetrieveResponse</wsa:Action>
+        <wsa:MessageID>urn:uuid:8fe86c01-56d5-4c56-8ac2-991578c79485</wsa:MessageID>
+        <wsa:RelatesTo>urn:uuid:592f71ac-78a0-45a2-8cfe-37a91fc6cfd5</wsa:RelatesTo>
+        <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>
+        <wsse:Security>
+            <wsu:Timestamp wsu:Id="Timestamp-675af14a-b6a1-44a5-b7e7-4a76c6d18424">
+                <wsu:Created>2023-02-01T10:29:21Z</wsu:Created>
+                <wsu:Expires>2023-02-01T10:34:21Z</wsu:Expires>
+            </wsu:Timestamp>
+        </wsse:Security>
+    </soap:Header>
+    <soap:Body>
+        <RetrieveResponseMsg xmlns="http://exacttarget.com/wsdl/partnerAPI">
+            <OverallStatus>OK</OverallStatus>
+            <RequestID>a90dda5e-aeba-440a-82ce-74fb2abf5eb2</RequestID>
+            <Results xsi:type="TriggeredSendSummary">
+                <PartnerKey xsi:nil="true" />
+                <ObjectID>b3150cf0-6e78-e811-80d4-1402ec721c9d</ObjectID>
+                <CustomerKey>testExisting_triggeredSend</CustomerKey>
+                <Sent>10</Sent>
+                <NotSentDueToOptOut>0</NotSentDueToOptOut>
+                <NotSentDueToUndeliverable>0</NotSentDueToUndeliverable>
+                <Bounces>0</Bounces>
+                <Opens>0</Opens>
+                <Clicks>0</Clicks>
+                <UniqueOpens>0</UniqueOpens>
+                <UniqueClicks>0</UniqueClicks>
+                <OptOuts>0</OptOuts>
+                <SurveyResponses>0</SurveyResponses>
+                <FTAFRequests>0</FTAFRequests>
+                <FTAFEmailsSent>0</FTAFEmailsSent>
+                <FTAFOptIns>0</FTAFOptIns>
+                <Conversions>0</Conversions>
+                <UniqueConversions>0</UniqueConversions>
+                <InProcess>0</InProcess>
+                <NotSentDueToError>0</NotSentDueToError>
+                <Queued>0</Queued>
+            </Results>
+        </RetrieveResponseMsg>
+    </soap:Body>
+</soap:Envelope>

package/test/type.dataExtension.test.js

@@ -91,6 +91,47 @@ describe('type: dataExtension', () => {
             );
             return;
         });
+
+        it('Should not fail if shared dataExtension cannot be retrieved', async () => {
+            // WHEN
+            await handler.retrieve('testInstance/_ParentBU_', ['dataExtension', 'query']);
+            // THEN
+            assert.equal(process.exitCode, 0, 'retrieve should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.dataExtension ? Object.keys(result.dataExtension).length : 0,
+                1,
+                'only one dataExtension expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson(
+                    'testExisting_dataExtensionShared',
+                    'dataExtension',
+                    '_ParentBU_'
+                ),
+                await testUtils.getExpectedJson('1111111', 'dataExtension', 'retrieve'),
+
+                'returned metadata was not equal expected'
+            );
+            // check if MD file was created and equals expectations
+            expect(
+                await testUtils.getActualDoc(
+                    'testExisting_dataExtensionShared',
+                    'dataExtension',
+                    '_ParentBU_'
+                )
+            ).to.equal(
+                await testUtils.getExpectedFile('1111111', 'dataExtension', 'retrieve', 'md')
+            );
+
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                7,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
     });
 
     describe('Deploy ================', () => {
@@ -348,20 +389,6 @@ describe('type: dataExtension', () => {
             assert.equal(isDeleted, true, 'should have deleted the item');
             return;
         });
-
-        it('Should delete the dataExtensionField', async () => {
-            // WHEN
-            const isDeleted = await handler.deleteByKey(
-                'testInstance/testBU',
-                'dataExtensionField',
-                'testExisting_dataExtension.LastName'
-            );
-            // THEN
-            assert.equal(process.exitCode, 0, 'delete should not have thrown an error');
-
-            assert.equal(isDeleted, true, 'should have deleted the item');
-            return;
-        });
     });
 
     describe('CI/CD ================', () => {

package/test/type.dataExtensionField.test.js

@@ -0,0 +1,81 @@
+import * as chai from 'chai';
+const assert = chai.assert;
+
+import chaiFiles from 'chai-files';
+import * as testUtils from './utils.js';
+import handler from '../lib/index.js';
+chai.use(chaiFiles);
+
+describe('type: dataExtensionField', () => {
+    beforeEach(() => {
+        testUtils.mockSetup();
+    });
+
+    afterEach(() => {
+        testUtils.mockReset();
+    });
+
+    describe('Delete ================', () => {
+        it('Should delete the dataExtensionField', async () => {
+            // WHEN
+            const isDeleted = await handler.deleteByKey(
+                'testInstance/testBU',
+                'dataExtensionField',
+                'testExisting_dataExtension.LastName'
+            );
+            // THEN
+            assert.equal(process.exitCode, 0, 'delete should not have thrown an error');
+
+            assert.equal(isDeleted, true, 'should have deleted the item');
+
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                2,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+
+        it('Should mass-delete the dataExtensionField across all dataExtensions', async () => {
+            handler.setOptions({ skipInteraction: true });
+            // WHEN
+            const isDeleted = await handler.deleteByKey(
+                'testInstance/testBU',
+                'dataExtensionField',
+                '*.LastName'
+            );
+            // THEN
+            assert.equal(process.exitCode, 0, 'delete should not have thrown an error');
+
+            assert.equal(isDeleted, true, 'should have deleted the item');
+
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                4,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+
+        it('Should mass-delete multiple dataExtensionFields across all dataExtensions', async () => {
+            handler.setOptions({ skipInteraction: true });
+            // WHEN
+            const isDeleted = await handler.deleteByKey(
+                'testInstance/testBU',
+                'dataExtensionField',
+                ['*.FirstName', '*.LastName']
+            );
+            // THEN
+            assert.equal(process.exitCode, 0, 'delete should not have thrown an error');
+
+            assert.equal(isDeleted, true, 'should have deleted the item');
+
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                8,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
+});

package/test/type.journey.test.js

@@ -1132,13 +1132,19 @@ describe('type: journey', () => {
         it('Should not validate a transactional journey by key', async () => {
             handler.setOptions({ skipStatusCheck: true });
             // WHEN
-            await handler.validate(
+            const validate = await handler.validate(
                 'testInstance/testBU',
                 ['journey'],
                 ['testExisting_temail_notPublished']
             );
             // THEN
-            assert.equal(process.exitCode, 1, 'validate should not have thrown an error');
+            assert.equal(process.exitCode, 0, 'validate should not have thrown an error');
+            // retrieve result
+            assert.deepEqual(
+                validate['testInstance/testBU']?.journey,
+                [],
+                'should not have validated any journey'
+            );
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
@@ -1148,6 +1154,35 @@ describe('type: journey', () => {
             return;
         });
 
+        it('Should validate a multi-step journey but not the transactional journey by key', async () => {
+            await testUtils.copyFile(
+                'interaction/v1/interactions/validateStatus/45f06c0a-3ed2-48b2-a6a8-b5119253f01c/get-response-success.json',
+                'interaction/v1/interactions/validateStatus/45f06c0a-3ed2-48b2-a6a8-b5119253f01c/get-response.json'
+            );
+            handler.setOptions({ skipStatusCheck: true });
+            // WHEN
+            const validate = await handler.validate(
+                'testInstance/testBU',
+                ['journey'],
+                ['testExisting_temail_notPublished', 'testExisting_journey_Multistep']
+            );
+            // THEN
+            assert.equal(process.exitCode, 0, 'validate should not have thrown an error');
+            // retrieve result
+            assert.deepEqual(
+                validate['testInstance/testBU']?.journey,
+                ['testExisting_journey_Multistep'],
+                'should not have validated any journey'
+            );
+
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                3,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+
         it('Should validate a journey by id but w/o version (auto-picks latest version)', async () => {
             await testUtils.copyFile(
                 'interaction/v1/interactions/validateStatus/45f06c0a-3ed2-48b2-a6a8-b5119253f01c/get-response-success.json',

package/test/type.triggeredSendSummary.test.js

@@ -0,0 +1,45 @@
+import * as chai from 'chai';
+const assert = chai.assert;
+
+import chaiFiles from 'chai-files';
+import cache from '../lib/util/cache.js';
+import * as testUtils from './utils.js';
+import handler from '../lib/index.js';
+chai.use(chaiFiles);
+
+describe('type: triggeredSendSummary', () => {
+    beforeEach(() => {
+        testUtils.mockSetup();
+    });
+
+    afterEach(() => {
+        testUtils.mockReset();
+    });
+
+    describe('Retrieve ================', () => {
+        it('Should retrieve a triggeredSendSummary', async () => {
+            // WHEN
+            await handler.retrieve('testInstance/testBU', ['triggeredSendSummary']);
+            // THEN
+            assert.equal(process.exitCode, 0, 'retrieve should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.triggeredSendSummary ? Object.keys(result.triggeredSendSummary).length : 0,
+                1,
+                'only 1 triggeredSendSummary expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_triggeredSend', 'triggeredSendSummary'),
+                await testUtils.getExpectedJson('9999999', 'triggeredSendSummary', 'get'),
+                'returned JSON was not equal expected'
+            );
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                3,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
+});