mcdev 5.2.0 → 6.0.0

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();
@@ -26,19 +23,19 @@ describe('type: attributeSet', () => {
                 retrieve['testInstance/testBU'].attributeSet
                     ? Object.keys(retrieve['testInstance/testBU'].attributeSet).length
                     : 0,
-                27,
-                'only 27 attributeSets expected in retrieve response'
+                28,
+                'only 28 attributeSets expected in retrieve response'
             );
             // get results from cache
             const result = cache.getCache();
             assert.equal(
                 result.attributeSet ? Object.keys(result.attributeSet).length : 0,
-                27,
-                'only 27 attributeSets expected in cache'
+                28,
+                'only 28 attributeSets expected in cache'
             );
 
             assert.deepEqual(
-                await testUtils.getActualJson('MobileSubscriptions', 'attributeSet'),
+                await testUtils.getActualJson('testExisting_dataExtensionShared', 'attributeSet'),
                 await testUtils.getExpectedJson('9999999', 'attributeSet', 'retrieve'),
 
                 'returned metadata was not equal expected'

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(() => {
@@ -47,10 +43,9 @@ describe('type: automation', () => {
                     )
                 )
             );
-
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                17,
+                18,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -62,7 +57,11 @@ describe('type: automation', () => {
         });
         it('Should create & update a automation', async () => {
             // WHEN
-            const deployResult = await handler.deploy('testInstance/testBU', ['automation']);
+            const deployResult = await handler.deploy(
+                'testInstance/testBU',
+                ['automation', 'verification'],
+                ['testExisting_automation', 'testNew_automation', 'testNew_39f6a488-20eb-4ba0-b0b9']
+            );
             // THEN
             assert.equal(process.exitCode, false, 'deploy should not have thrown an error');
 
@@ -120,7 +119,7 @@ describe('type: automation', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                16,
+                25,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -130,8 +129,8 @@ describe('type: automation', () => {
             handler.setOptions({ schedule: true });
             const deployed = await handler.deploy(
                 'testInstance/testBU',
-                ['automation'],
-                ['testExisting_automation', 'testNew_automation']
+                ['automation', 'verification'],
+                ['testExisting_automation', 'testNew_automation', 'testNew_39f6a488-20eb-4ba0-b0b9']
             );
             // THEN
             assert.equal(
@@ -189,7 +188,7 @@ describe('type: automation', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                24,
+                33,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -199,8 +198,8 @@ describe('type: automation', () => {
             handler.setOptions({ execute: true });
             const deployed = await handler.deploy(
                 'testInstance/testBU',
-                ['automation'],
-                ['testExisting_automation', 'testNew_automation']
+                ['automation', 'verification'],
+                ['testExisting_automation', 'testNew_automation', 'testNew_39f6a488-20eb-4ba0-b0b9']
             );
             // THEN
             assert.equal(
@@ -257,7 +256,7 @@ describe('type: automation', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                20,
+                29,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -289,10 +288,11 @@ describe('type: automation', () => {
                 1,
                 'one automation expected'
             );
+            testUtils.logAPIHistoryDebug();
             // check number of API calls
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                14,
+                18,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -336,7 +336,7 @@ describe('type: automation', () => {
             // check number of API calls
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                29,
+                40,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -380,7 +380,7 @@ describe('type: automation', () => {
             // check number of API calls
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                31,
+                42,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -424,7 +424,7 @@ describe('type: automation', () => {
             // check number of API calls
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                32,
+                43,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -464,7 +464,7 @@ describe('type: automation', () => {
             // check number of API calls
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                26,
+                35,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -505,7 +505,7 @@ describe('type: automation', () => {
             // check number of API calls
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                30,
+                41,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -546,7 +546,7 @@ describe('type: automation', () => {
             // check number of API calls
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                32,
+                43,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -597,7 +597,7 @@ describe('type: automation', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                14,
+                20,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -644,7 +644,7 @@ describe('type: automation', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                17,
+                18,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -653,13 +653,15 @@ describe('type: automation', () => {
     describe('Delete ================', () => {
         it('Should delete the item', async () => {
             // WHEN
-            const result = await handler.deleteByKey('testInstance/testBU', 'automation', [
-                'testExisting_automation',
-            ]);
+            const isDeleted = await handler.deleteByKey(
+                'testInstance/testBU',
+                'automation',
+                'testExisting_automation'
+            );
             // THEN
             assert.equal(process.exitCode, false, 'delete should not have thrown an error');
 
-            assert.equal(result, true, 'should have deleted the item');
+            assert.equal(isDeleted, true, 'should have deleted the item');
             return;
         });
     });

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(() => {
@@ -50,23 +46,73 @@ describe('type: dataExtension', () => {
             );
             return;
         });
+        it('Should retrieve a shared dataExtension', async () => {
+            // WHEN
+            await handler.retrieve('testInstance/_ParentBU_', ['dataExtension']);
+            // THEN
+            assert.equal(process.exitCode, false, '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(
+                file(
+                    testUtils.getActualDoc(
+                        'testExisting_dataExtensionShared',
+                        'dataExtension',
+                        '_ParentBU_'
+                    )
+                )
+            ).to.equal(
+                file(testUtils.getExpectedFile('1111111', 'dataExtension', 'retrieve', 'md'))
+            );
+
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                4,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
     });
     describe('Deploy ================', () => {
         beforeEach(() => {
             testUtils.mockSetup(true);
         });
-        it('Should create & update a dataExtension', async () => {
+        it('Should create & update a dataExtension including a field rename', async () => {
             // WHEN
-            await handler.deploy('testInstance/testBU', ['dataExtension']);
+            const deployResult = await handler.deploy('testInstance/testBU', ['dataExtension']);
             // THEN
             assert.equal(process.exitCode, false, 'deploy should not have thrown an error');
 
+            assert.equal(
+                deployResult['testInstance/testBU']?.dataExtension
+                    ? Object.keys(deployResult['testInstance/testBU']?.dataExtension).length
+                    : 0,
+                2,
+                'two dataExtensions to be deployed'
+            );
+
             // get results from cache
             const result = cache.getCache();
             assert.equal(
                 result.dataExtension ? Object.keys(result.dataExtension).length : 0,
-                2,
-                'two dataExtensions expected'
+                3,
+                'three dataExtensions expected'
             );
             // insert
             assert.deepEqual(
@@ -87,7 +133,104 @@ describe('type: dataExtension', () => {
             );
             return;
         });
-        it('Should rename fields');
+        it('Should create & update a shared dataExtension', async () => {
+            // WHEN
+            const deployResult = await handler.deploy('testInstance/_ParentBU_', ['dataExtension']);
+            // THEN
+            assert.equal(process.exitCode, false, 'deploy should not have thrown an error');
+
+            assert.equal(
+                deployResult['testInstance/_ParentBU_']?.dataExtension
+                    ? Object.keys(deployResult['testInstance/_ParentBU_']?.dataExtension).length
+                    : 0,
+                2,
+                'two dataExtensions to be deployed'
+            );
+
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.dataExtension ? Object.keys(result.dataExtension).length : 0,
+                2,
+                'two dataExtensions expected'
+            );
+            // insert
+            assert.deepEqual(
+                await testUtils.getActualJson(
+                    'testNew_dataExtensionShared',
+                    'dataExtension',
+                    '_ParentBU_'
+                ),
+                await testUtils.getExpectedJson('1111111', 'dataExtension', 'create'),
+                'returned metadata was not equal expected for create'
+            );
+            // update
+            assert.deepEqual(
+                await testUtils.getActualJson(
+                    'testExisting_dataExtensionShared',
+                    'dataExtension',
+                    '_ParentBU_'
+                ),
+                await testUtils.getExpectedJson('1111111', 'dataExtension', 'update'),
+                'returned metadata was not equal expected for update'
+            );
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                8,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+        it('Should create & update a shared dataExtension with --fixShared & --skipInteraction', async () => {
+            // WHEN
+            handler.setOptions({ fixShared: 'testBU', skipInteraction: true, _runningTest: true });
+
+            const deployResult = await handler.deploy('testInstance/_ParentBU_', ['dataExtension']);
+            // THEN
+            assert.equal(process.exitCode, false, 'deploy should not have thrown an error');
+
+            assert.equal(
+                deployResult['testInstance/_ParentBU_']?.dataExtension
+                    ? Object.keys(deployResult['testInstance/_ParentBU_']?.dataExtension).length
+                    : 0,
+                2,
+                'two dataExtensions to be deployed'
+            );
+
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.dataExtension ? Object.keys(result.dataExtension).length : 0,
+                2,
+                'two dataExtensions expected'
+            );
+            // insert
+            assert.deepEqual(
+                await testUtils.getActualJson(
+                    'testNew_dataExtensionShared',
+                    'dataExtension',
+                    '_ParentBU_'
+                ),
+                await testUtils.getExpectedJson('1111111', 'dataExtension', 'create'),
+                'returned metadata was not equal expected for create'
+            );
+            // update
+            assert.deepEqual(
+                await testUtils.getActualJson(
+                    'testExisting_dataExtensionShared',
+                    'dataExtension',
+                    '_ParentBU_'
+                ),
+                await testUtils.getExpectedJson('1111111', 'dataExtension', 'update'),
+                'returned metadata was not equal expected for update'
+            );
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                12,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
     });
     describe('Templating ================', () => {
         it('Should create a dataExtension template via retrieveAsTemplate and build it', async () => {
@@ -194,47 +337,60 @@ describe('type: dataExtension', () => {
         });
     });
     describe('Delete ================', () => {
-        // TODO: add this test
-        it('Should delete the item'); // , async () => {
-        //     // WHEN
-        //     const result = await handler.deleteByKey('testInstance/testBU', 'mobileKeyword', [
-        //         'testExisting_keyword',
-        //     ]);
-        //     // THEN
-        //     assert.equal(process.exitCode, false, 'delete should not have thrown an error');
-
-        //     assert.equal(result, true, 'should have deleted the item');
-        //     return;
-        // });
+        it('Should delete the dataExtension', async () => {
+            // WHEN
+            const isDeleted = await handler.deleteByKey(
+                'testInstance/testBU',
+                'dataExtension',
+                'testExisting_dataExtension'
+            );
+            // THEN
+            assert.equal(process.exitCode, false, 'delete should not have thrown an error');
+
+            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, false, 'delete should not have thrown an error');
+
+            assert.equal(isDeleted, true, 'should have deleted the item');
+            return;
+        });
     });
     describe('CI/CD ================', () => {
-        // TODO: add this test
-        it('Should return a list of files based on their type and key'); // , async () => {
-        //     // WHEN
-        //     const fileList = await handler.getFilesToCommit(
-        //         'testInstance/testBU',
-        //         'mobileKeyword',
-        //         ['testExisting_keyword']
-        //     );
-        //     // THEN
-        //     assert.equal(
-        //         process.exitCode,
-        //         false,
-        //         'getFilesToCommit should not have thrown an error'
-        //     );
-        //     assert.equal(fileList.length, 2, 'expected only 2 file paths');
-
-        //     assert.equal(
-        //         fileList[0].split('\\').join('/'),
-        //         'retrieve/testInstance/testBU/mobileKeyword/testExisting_keyword.mobileKeyword-meta.json',
-        //         'wrong JSON path'
-        //     );
-        //     assert.equal(
-        //         fileList[1].split('\\').join('/'),
-        //         'retrieve/testInstance/testBU/mobileKeyword/testExisting_keyword.mobileKeyword-meta.amp',
-        //         'wrong AMP path'
-        //     );
-        //     return;
-        // });
+        it('Should return a list of files based on their type and key', async () => {
+            // WHEN
+            const fileList = await handler.getFilesToCommit(
+                'testInstance/testBU',
+                'dataExtension',
+                ['testExisting_dataExtension']
+            );
+            // THEN
+            assert.equal(
+                process.exitCode,
+                false,
+                'getFilesToCommit should not have thrown an error'
+            );
+            assert.equal(fileList.length, 2, 'expected only 2 file paths (json, md)');
+
+            assert.equal(
+                fileList[0].split('\\').join('/'),
+                'retrieve/testInstance/testBU/dataExtension/testExisting_dataExtension.dataExtension-meta.json',
+                'wrong JSON path'
+            );
+            assert.equal(
+                fileList[1].split('\\').join('/'),
+                'retrieve/testInstance/testBU/dataExtension/testExisting_dataExtension.dataExtension-doc.md',
+                'wrong MD path'
+            );
+            return;
+        });
     });
 });

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(() => {
@@ -172,15 +171,22 @@ describe('type: dataExtract', () => {
     describe('Delete ================', () => {
         it('Should NOT delete the item', async () => {
             // WHEN
-            await handler.deleteByKey('testInstance/testBU', 'dataExtract', [
-                'testExisting_fileTranfer',
-            ]);
+            const isDeleted = await handler.deleteByKey(
+                'testInstance/testBU',
+                'dataExtract',
+                'testExisting_fileTranfer'
+            );
             // THEN
             assert.equal(
                 process.exitCode,
                 1,
                 'deleteByKey should have thrown an error due to lack of support'
             );
+            assert.equal(
+                isDeleted,
+                false,
+                'deleteByKey should have returned false due to lack of support'
+            );
             return;
         });
     });

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(() => {
@@ -170,15 +169,22 @@ describe('type: fileTransfer', () => {
     describe('Delete ================', () => {
         it('Should NOT delete the item', async () => {
             // WHEN
-            await handler.deleteByKey('testInstance/testBU', 'fileTransfer', [
-                'testExisting_fileTranfer',
-            ]);
+            const isDeleted = await handler.deleteByKey(
+                'testInstance/testBU',
+                'fileTransfer',
+                'testExisting_fileTranfer'
+            );
             // THEN
             assert.equal(
                 process.exitCode,
                 1,
                 'deleteByKey should have thrown an error due to lack of support'
             );
+            assert.equal(
+                isDeleted,
+                false,
+                'deleteByKey should have returned false due to lack of support'
+            );
             return;
         });
     });

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(() => {
@@ -171,15 +170,22 @@ describe('type: importFile', () => {
     describe('Delete ================', () => {
         it('Should NOT delete the item', async () => {
             // WHEN
-            await handler.deleteByKey('testInstance/testBU', 'importFile', [
-                'testExisting_fileTranfer',
-            ]);
+            const isDeleted = await handler.deleteByKey(
+                'testInstance/testBU',
+                'importFile',
+                'testExisting_fileTranfer'
+            );
             // THEN
             assert.equal(
                 process.exitCode,
                 1,
                 'deleteByKey should have thrown an error due to lack of support'
             );
+            assert.equal(
+                isDeleted,
+                false,
+                'deleteByKey should have returned false due to lack of support'
+            );
             return;
         });
     });