mcdev 5.1.0 → 5.3.0

package/test/type.dataExtension.test.js

@@ -50,23 +50,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,8 +137,104 @@ describe('type: dataExtension', () => {
             );
             return;
         });
-        it('Should change the key during update via --changeKeyValue');
-        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 () => {
@@ -195,47 +341,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

@@ -0,0 +1,194 @@
+const chai = require('chai');
+const chaiFiles = require('chai-files');
+const assert = chai.assert;
+chai.use(chaiFiles);
+const cache = require('../lib/util/cache');
+const testUtils = require('./utils');
+const handler = require('../lib/index');
+
+describe('type: dataExtract', () => {
+    beforeEach(() => {
+        testUtils.mockSetup();
+    });
+    afterEach(() => {
+        testUtils.mockReset();
+    });
+
+    describe('Retrieve ================', () => {
+        it('Should retrieve a dataExtract', async () => {
+            // WHEN
+            await handler.retrieve('testInstance/testBU', ['dataExtract']);
+            // THEN
+            assert.equal(process.exitCode, false, 'retrieve should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.dataExtract ? Object.keys(result.dataExtract).length : 0,
+                1,
+                'only one dataExtract expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_dataExtract', 'dataExtract'),
+                await testUtils.getExpectedJson('9999999', 'dataExtract', 'get'),
+                'returned JSON was not equal expected'
+            );
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                6,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
+    describe('Deploy ================', () => {
+        beforeEach(() => {
+            testUtils.mockSetup(true);
+        });
+        it('Should create & upsert a dataExtract', async () => {
+            // WHEN
+
+            await handler.deploy('testInstance/testBU', ['dataExtract']);
+            // THEN
+            assert.equal(process.exitCode, false, 'deploy should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.dataExtract ? Object.keys(result.dataExtract).length : 0,
+                2,
+                'two dataExtracts expected'
+            );
+            // confirm created item
+            assert.deepEqual(
+                await testUtils.getActualJson('testNew_dataExtract', 'dataExtract'),
+                await testUtils.getExpectedJson('9999999', 'dataExtract', 'post'),
+                'returned new-JSON was not equal expected for insert dataExtract'
+            );
+            // confirm updated item
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_dataExtract', 'dataExtract'),
+                await testUtils.getExpectedJson('9999999', 'dataExtract', 'patch'),
+                'returned existing-JSON was not equal expected for update dataExtract'
+            );
+            // check number of API calls
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                8,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+        it('Should change the key during update via --changeKeyValue ');
+    });
+    describe('Templating ================', () => {
+        it('Should create a dataExtract template via retrieveAsTemplate and build it', async () => {
+            // buildTemplate
+            const result = await handler.retrieveAsTemplate(
+                'testInstance/testBU',
+                'dataExtract',
+                ['testExisting_dataExtract'],
+                'testSourceMarket'
+            );
+            assert.equal(process.exitCode, false, 'buildTemplate should not have thrown an error');
+            assert.equal(
+                result.dataExtract ? Object.keys(result.dataExtract).length : 0,
+                1,
+                'only one dataExtract expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualTemplateJson('testExisting_dataExtract', 'dataExtract'),
+                await testUtils.getExpectedJson('9999999', 'dataExtract', 'template'),
+                'returned template JSON was not equal expected'
+            );
+            // buildDefinition
+            await handler.buildDefinition(
+                'testInstance/testBU',
+                'dataExtract',
+                'testExisting_dataExtract',
+                'testTargetMarket'
+            );
+            assert.equal(
+                process.exitCode,
+                false,
+                'buildDefinition should not have thrown an error'
+            );
+            assert.deepEqual(
+                await testUtils.getActualDeployJson('testTemplated_dataExtract', 'dataExtract'),
+                await testUtils.getExpectedJson('9999999', 'dataExtract', 'build'),
+                'returned deployment JSON was not equal expected'
+            );
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                6,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+        it('Should create a dataExtract template via buildTemplate and build it', async () => {
+            // download first before we test buildTemplate
+            await handler.retrieve('testInstance/testBU', ['dataExtract']);
+            // buildTemplate
+            const result = await handler.buildTemplate(
+                'testInstance/testBU',
+                'dataExtract',
+                ['testExisting_dataExtract'],
+                'testSourceMarket'
+            );
+            assert.equal(process.exitCode, false, 'buildTemplate should not have thrown an error');
+            assert.equal(
+                result.dataExtract ? Object.keys(result.dataExtract).length : 0,
+                1,
+                'only one dataExtract expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualTemplateJson('testExisting_dataExtract', 'dataExtract'),
+                await testUtils.getExpectedJson('9999999', 'dataExtract', 'template'),
+                'returned template JSON was not equal expected'
+            );
+            // buildDefinition
+            await handler.buildDefinition(
+                'testInstance/testBU',
+                'dataExtract',
+                'testExisting_dataExtract',
+                'testTargetMarket'
+            );
+            assert.equal(
+                process.exitCode,
+                false,
+                'buildDefinition should not have thrown an error'
+            );
+            assert.deepEqual(
+                await testUtils.getActualDeployJson('testTemplated_dataExtract', 'dataExtract'),
+                await testUtils.getExpectedJson('9999999', 'dataExtract', 'build'),
+                'returned deployment JSON was not equal expected'
+            );
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                6,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
+    describe('Delete ================', () => {
+        it('Should NOT delete the item', async () => {
+            // WHEN
+            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

@@ -0,0 +1,192 @@
+const chai = require('chai');
+const chaiFiles = require('chai-files');
+const assert = chai.assert;
+chai.use(chaiFiles);
+const cache = require('../lib/util/cache');
+const testUtils = require('./utils');
+const handler = require('../lib/index');
+
+describe('type: fileTransfer', () => {
+    beforeEach(() => {
+        testUtils.mockSetup();
+    });
+    afterEach(() => {
+        testUtils.mockReset();
+    });
+
+    describe('Retrieve ================', () => {
+        it('Should retrieve a fileTransfer', async () => {
+            // WHEN
+            await handler.retrieve('testInstance/testBU', ['fileTransfer']);
+            // THEN
+            assert.equal(process.exitCode, false, 'retrieve should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.fileTransfer ? Object.keys(result.fileTransfer).length : 0,
+                1,
+                'only one fileTransfer expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_fileTransfer', 'fileTransfer'),
+                await testUtils.getExpectedJson('9999999', 'fileTransfer', '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;
+        });
+    });
+    describe('Deploy ================', () => {
+        beforeEach(() => {
+            testUtils.mockSetup(true);
+        });
+        it('Should create & upsert a fileTransfer', async () => {
+            // WHEN
+            await handler.deploy('testInstance/testBU', ['fileTransfer']);
+            // THEN
+            assert.equal(process.exitCode, false, 'deploy should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.fileTransfer ? Object.keys(result.fileTransfer).length : 0,
+                2,
+                'two fileTransfers expected'
+            );
+            // confirm created item
+            assert.deepEqual(
+                await testUtils.getActualJson('testNew_fileTransfer', 'fileTransfer'),
+                await testUtils.getExpectedJson('9999999', 'fileTransfer', 'post'),
+                'returned JSON was not equal expected for insert fileTransfer'
+            );
+            // confirm updated item
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_fileTransfer', 'fileTransfer'),
+                await testUtils.getExpectedJson('9999999', 'fileTransfer', 'patch'),
+                'returned JSON was not equal expected for update fileTransfer'
+            );
+            // check number of API calls
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                5,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
+    describe('Templating ================', () => {
+        it('Should create a fileTransfer template via retrieveAsTemplate and build it', async () => {
+            // buildTemplate
+            const result = await handler.retrieveAsTemplate(
+                'testInstance/testBU',
+                'fileTransfer',
+                ['testExisting_fileTransfer'],
+                'testSourceMarket'
+            );
+            assert.equal(process.exitCode, false, 'buildTemplate should not have thrown an error');
+            assert.equal(
+                result.fileTransfer ? Object.keys(result.fileTransfer).length : 0,
+                1,
+                'only one fileTransfer expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualTemplateJson('testExisting_fileTransfer', 'fileTransfer'),
+                await testUtils.getExpectedJson('9999999', 'fileTransfer', 'template'),
+                'returned template JSON was not equal expected'
+            );
+            // buildDefinition
+            await handler.buildDefinition(
+                'testInstance/testBU',
+                'fileTransfer',
+                'testExisting_fileTransfer',
+                'testTargetMarket'
+            );
+            assert.equal(
+                process.exitCode,
+                false,
+                'buildDefinition should not have thrown an error'
+            );
+            assert.deepEqual(
+                await testUtils.getActualDeployJson('testTemplated_fileTransfer', 'fileTransfer'),
+                await testUtils.getExpectedJson('9999999', 'fileTransfer', 'build'),
+                'returned deployment JSON was not equal expected'
+            );
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                3,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+        it('Should create a fileTransfer template via buildTemplate and build it', async () => {
+            // download first before we test buildTemplate
+            await handler.retrieve('testInstance/testBU', ['fileTransfer']);
+            // buildTemplate
+            const result = await handler.buildTemplate(
+                'testInstance/testBU',
+                'fileTransfer',
+                ['testExisting_fileTransfer'],
+                'testSourceMarket'
+            );
+            assert.equal(process.exitCode, false, 'buildTemplate should not have thrown an error');
+            assert.equal(
+                result.fileTransfer ? Object.keys(result.fileTransfer).length : 0,
+                1,
+                'only one fileTransfer expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualTemplateJson('testExisting_fileTransfer', 'fileTransfer'),
+                await testUtils.getExpectedJson('9999999', 'fileTransfer', 'template'),
+                'returned template JSON was not equal expected'
+            );
+            // buildDefinition
+            await handler.buildDefinition(
+                'testInstance/testBU',
+                'fileTransfer',
+                'testExisting_fileTransfer',
+                'testTargetMarket'
+            );
+            assert.equal(
+                process.exitCode,
+                false,
+                'buildDefinition should not have thrown an error'
+            );
+            assert.deepEqual(
+                await testUtils.getActualDeployJson('testTemplated_fileTransfer', 'fileTransfer'),
+                await testUtils.getExpectedJson('9999999', 'fileTransfer', 'build'),
+                'returned deployment JSON was not equal expected'
+            );
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                3,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
+    describe('Delete ================', () => {
+        it('Should NOT delete the item', async () => {
+            // WHEN
+            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;
+        });
+    });
+});