mcdev 5.3.0 → 6.0.1

package/test/resources/9999999/dataFolder/retrieve-ContentType=asset-sharedORContentType=asset-response.xml

@@ -0,0 +1,70 @@
+<?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:00106553-ac00-4e72-b387-42325fe6f93d</wsa:MessageID>
+        <wsa:RelatesTo>urn:uuid:a1dd2a9d-b696-480e-9a1b-265f262a8997</wsa:RelatesTo>
+        <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>
+        <wsse:Security>
+            <wsu:Timestamp wsu:Id="Timestamp-d82724f8-afc2-4461-8e3e-190aeb6d9625">
+                <wsu:Created>2024-01-08T14:30:39Z</wsu:Created>
+                <wsu:Expires>2024-01-08T14:35:39Z</wsu:Expires>
+            </wsu:Timestamp>
+        </wsse:Security>
+    </soap:Header>
+    <soap:Body>
+        <RetrieveResponseMsg xmlns="http://exacttarget.com/wsdl/partnerAPI">
+            <OverallStatus>OK</OverallStatus>
+            <RequestID>6596087d-d12f-4c9d-9353-783fe01775a3</RequestID>
+            <Results xsi:type="DataFolder">
+                <Client>
+                    <ID>9999999</ID>
+                </Client>
+                <PartnerKey xsi:nil="true" />
+                <CreatedDate>2016-07-22T11:52:35.687</CreatedDate>
+                <ModifiedDate>2016-07-22T11:52:35.687</ModifiedDate>
+                <ID>89397</ID>
+                <ObjectID xsi:nil="true" />
+                <CustomerKey />
+                <ParentFolder>
+                    <PartnerKey xsi:nil="true" />
+                    <ID>0</ID>
+                    <ObjectID xsi:nil="true" />
+                </ParentFolder>
+                <Name>Content Builder</Name>
+                <Description>The root folder for assets</Description>
+                <ContentType>asset</ContentType>
+                <IsActive>true</IsActive>
+                <IsEditable>false</IsEditable>
+                <AllowChildren>true</AllowChildren>
+            </Results>
+            <Results xsi:type="DataFolder">
+                <Client>
+                    <ID>9999999</ID>
+                </Client>
+                <PartnerKey xsi:nil="true" />
+                <CreatedDate>2016-07-29T12:13:07.7</CreatedDate>
+                <ModifiedDate>2021-12-16T02:56:14.68</ModifiedDate>
+                <ID>90888</ID>
+                <ObjectID xsi:nil="true" />
+                <CustomerKey />
+                <ParentFolder>
+                    <PartnerKey xsi:nil="true" />
+                    <ID>89397</ID>
+                    <ObjectID xsi:nil="true" />
+                </ParentFolder>
+                <Name>Test Folder</Name>
+                <Description />
+                <ContentType>asset</ContentType>
+                <IsActive>true</IsActive>
+                <IsEditable>true</IsEditable>
+                <AllowChildren>true</AllowChildren>
+            </Results>
+        </RetrieveResponseMsg>
+    </soap:Body>
+</soap:Envelope>

package/test/type.asset.test.js

@@ -0,0 +1,84 @@
+import File from '../lib/util/file.js';
+
+import chai, { assert, expect } from 'chai';
+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);
+const file = chaiFiles.file;
+
+/**
+ * gets file from Retrieve folder
+ *
+ * @param {string} customerKey of metadata
+ * @param {string} type of metadata
+ * @param {string} subtype of metadata
+ * @param {string} [buName] used when we need to test on ParentBU
+ * @returns {Promise.<string>} file in string form
+ */
+function getActualJson(customerKey, type, subtype, buName = 'testBU') {
+    return File.readJSON(
+        `./retrieve/testInstance/${buName}/${type}/${subtype}/${customerKey}.${type}-${subtype}-meta.json`
+    );
+}
+/**
+ * gets file from Retrieve folder
+ *
+ * @param {string} customerKey of metadata
+ * @param {string} type of metadata
+ * @param {string} subtype of metadata
+ * @param {string} ext file extension
+ * @returns {string} file path
+ */
+function getActualFile(customerKey, type, subtype, ext) {
+    return `./retrieve/testInstance/testBU/${type}/${subtype}/${customerKey}.${type}-${subtype}-meta.${ext}`;
+}
+
+describe('type: asset', () => {
+    beforeEach(() => {
+        testUtils.mockSetup();
+    });
+    afterEach(() => {
+        testUtils.mockReset();
+    });
+    describe('Retrieve ================', () => {
+        it('Should retrieve a asset & ensure non-ssjs code is not removed', async () => {
+            // WHEN
+            const retrieve = await handler.retrieve('testInstance/testBU', ['asset']);
+
+            // THEN
+            assert.equal(process.exitCode, false, 'retrieve should not have thrown an error');
+            assert.equal(
+                retrieve['testInstance/testBU'].asset
+                    ? Object.keys(retrieve['testInstance/testBU'].asset).length
+                    : 0,
+                3,
+                'only 3 assets expected in retrieve response'
+            );
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.asset ? Object.keys(result.asset).length : 0,
+                3,
+                'only 3 assets expected in cache'
+            );
+
+            assert.deepEqual(
+                await getActualJson('mcdev-issue-1157', 'asset', 'block'),
+                await testUtils.getExpectedJson('9999999', 'asset', 'block-1157-retrieve'),
+                'returned metadata was not equal expected'
+            );
+            expect(file(getActualFile('mcdev-issue-1157', 'asset', 'block', 'html'))).to.equal(
+                file(testUtils.getExpectedFile('9999999', 'asset', 'block-1157-retrieve', 'html'))
+            );
+
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                30,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
+});

package/test/type.attributeGroup.test.js

@@ -1,13 +1,10 @@
-const chai = require('chai');
-const chaiFiles = require('chai-files');
-
+import chai, { assert } from 'chai';
+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);
 
-const assert = chai.assert;
-const cache = require('../lib/util/cache');
-const testUtils = require('./utils');
-const handler = require('../lib/index');
-
 describe('type: attributeGroup', () => {
     beforeEach(() => {
         testUtils.mockSetup();

package/test/type.attributeSet.test.js

@@ -1,13 +1,10 @@
-const chai = require('chai');
-const chaiFiles = require('chai-files');
-
+import chai, { assert } from 'chai';
+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);
 
-const assert = chai.assert;
-const cache = require('../lib/util/cache');
-const testUtils = require('./utils');
-const handler = require('../lib/index');
-
 describe('type: attributeSet', () => {
     beforeEach(() => {
         testUtils.mockSetup();

package/test/type.automation.test.js

@@ -1,14 +1,10 @@
-const chai = require('chai');
-const chaiFiles = require('chai-files');
-
+import chai, { assert, expect } from 'chai';
+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);
-
-const assert = chai.assert;
-const expect = chai.expect;
 const file = chaiFiles.file;
-const cache = require('../lib/util/cache');
-const testUtils = require('./utils');
-const handler = require('../lib/index');
 
 describe('type: automation', () => {
     beforeEach(() => {
@@ -292,7 +288,6 @@ describe('type: automation', () => {
                 1,
                 'one automation expected'
             );
-            testUtils.logAPIHistoryDebug();
             // check number of API calls
             assert.equal(
                 testUtils.getAPIHistoryLength(),

package/test/type.dataExtension.test.js

@@ -1,14 +1,10 @@
-const chai = require('chai');
-const chaiFiles = require('chai-files');
-
+import chai, { assert, expect } from 'chai';
+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);
-
-const assert = chai.assert;
-const expect = chai.expect;
 const file = chaiFiles.file;
-const cache = require('../lib/util/cache');
-const testUtils = require('./utils');
-const handler = require('../lib/index');
 
 describe('type: dataExtension', () => {
     beforeEach(() => {

package/test/type.dataExtract.test.js

@@ -1,10 +1,9 @@
-const chai = require('chai');
-const chaiFiles = require('chai-files');
-const assert = chai.assert;
+import chai, { assert } from 'chai';
+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);
-const cache = require('../lib/util/cache');
-const testUtils = require('./utils');
-const handler = require('../lib/index');
 
 describe('type: dataExtract', () => {
     beforeEach(() => {

package/test/type.fileTransfer.test.js

@@ -1,10 +1,9 @@
-const chai = require('chai');
-const chaiFiles = require('chai-files');
-const assert = chai.assert;
+import chai, { assert } from 'chai';
+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);
-const cache = require('../lib/util/cache');
-const testUtils = require('./utils');
-const handler = require('../lib/index');
 
 describe('type: fileTransfer', () => {
     beforeEach(() => {

package/test/type.importFile.test.js

@@ -1,10 +1,9 @@
-const chai = require('chai');
-const chaiFiles = require('chai-files');
-const assert = chai.assert;
+import chai, { assert } from 'chai';
+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);
-const cache = require('../lib/util/cache');
-const testUtils = require('./utils');
-const handler = require('../lib/index');
 
 describe('type: importFile', () => {
     beforeEach(() => {

package/test/type.journey.test.js

@@ -1,10 +1,9 @@
-const chai = require('chai');
-const chaiFiles = require('chai-files');
-const assert = chai.assert;
+import chai, { assert } from 'chai';
+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);
-const cache = require('../lib/util/cache');
-const testUtils = require('./utils');
-const handler = require('../lib/index');
 
 describe('type: journey', () => {
     beforeEach(() => {

package/test/type.mobileKeyword.test.js

@@ -1,12 +1,10 @@
-const chai = require('chai');
-const chaiFiles = require('chai-files');
-const assert = chai.assert;
+import chai, { assert, expect } from 'chai';
+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);
-const expect = chai.expect;
 const file = chaiFiles.file;
-const cache = require('../lib/util/cache');
-const testUtils = require('./utils');
-const handler = require('../lib/index');
 
 describe('type: mobileKeyword', () => {
     beforeEach(() => {

package/test/type.mobileMessage.test.js

@@ -1,12 +1,10 @@
-const chai = require('chai');
-const chaiFiles = require('chai-files');
-const assert = chai.assert;
+import chai, { assert, expect } from 'chai';
+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);
-const expect = chai.expect;
 const file = chaiFiles.file;
-const cache = require('../lib/util/cache');
-const testUtils = require('./utils');
-const handler = require('../lib/index');
 
 describe('type: mobileMessage', () => {
     beforeEach(() => {

package/test/type.query.test.js

@@ -1,13 +1,10 @@
-const chai = require('chai');
-const chaiFiles = require('chai-files');
-const assert = chai.assert;
+import chai, { assert, expect } from 'chai';
+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);
-const expect = chai.expect;
 const file = chaiFiles.file;
-// const dir = chaiFiles.dir;
-const cache = require('../lib/util/cache');
-const testUtils = require('./utils');
-const handler = require('../lib/index');
 
 describe('type: query', () => {
     beforeEach(() => {

package/test/type.script.test.js

@@ -1,13 +1,10 @@
-const chai = require('chai');
-const chaiFiles = require('chai-files');
-const assert = chai.assert;
+import chai, { assert, expect } from 'chai';
+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);
-const expect = chai.expect;
 const file = chaiFiles.file;
-// const dir = chaiFiles.dir;
-const cache = require('../lib/util/cache');
-const testUtils = require('./utils');
-const handler = require('../lib/index');
 
 describe('type: script', () => {
     beforeEach(() => {

package/test/type.transactionalEmail.test.js

@@ -1,10 +1,9 @@
-const chai = require('chai');
-const chaiFiles = require('chai-files');
-const assert = chai.assert;
+import chai, { assert } from 'chai';
+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);
-const cache = require('../lib/util/cache');
-const testUtils = require('./utils');
-const handler = require('../lib/index');
 
 describe('type: transactionalEmail', () => {
     beforeEach(() => {

package/test/type.transactionalPush.test.js

@@ -1,10 +1,9 @@
-const chai = require('chai');
-const chaiFiles = require('chai-files');
-const assert = chai.assert;
+import chai, { assert } from 'chai';
+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);
-const cache = require('../lib/util/cache');
-const testUtils = require('./utils');
-const handler = require('../lib/index');
 
 describe('type: transactionalPush', () => {
     beforeEach(() => {

package/test/type.transactionalSMS.test.js

@@ -1,12 +1,10 @@
-const chai = require('chai');
-const chaiFiles = require('chai-files');
-const assert = chai.assert;
+import chai, { assert, expect } from 'chai';
+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);
-const expect = chai.expect;
 const file = chaiFiles.file;
-const cache = require('../lib/util/cache');
-const testUtils = require('./utils');
-const handler = require('../lib/index');
 
 describe('type: transactionalSMS', () => {
     beforeEach(() => {

package/test/type.triggeredSend.test.js

@@ -1,10 +1,9 @@
-const chai = require('chai');
-const chaiFiles = require('chai-files');
-const assert = chai.assert;
+import chai, { assert } from 'chai';
+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);
-const cache = require('../lib/util/cache');
-const testUtils = require('./utils');
-const handler = require('../lib/index');
 
 describe('type: triggeredSend', () => {
     beforeEach(() => {

package/test/type.user.test.js

@@ -1,13 +1,11 @@
-const chai = require('chai');
-const chaiFiles = require('chai-files');
-const assert = chai.assert;
+import chai, { assert, expect } from 'chai';
+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);
-const expect = chai.expect;
 const file = chaiFiles.file;
-const cache = require('../lib/util/cache');
-const testUtils = require('./utils');
-const handler = require('../lib/index');
-const File = require('../lib/util/file');
+import File from '../lib/util/file.js';
 
 describe('type: user', () => {
     beforeEach(() => {

package/test/type.verification.test.js

@@ -1,10 +1,9 @@
-const chai = require('chai');
-const chaiFiles = require('chai-files');
-const assert = chai.assert;
+import chai, { assert } from 'chai';
+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);
-const cache = require('../lib/util/cache');
-const testUtils = require('./utils');
-const handler = require('../lib/index');
 
 describe('type: verification', () => {
     beforeEach(() => {