mcdev 8.3.0 → 8.4.0

package/test/type.fileLocation.test.js

@@ -0,0 +1,279 @@
+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: fileLocation', () => {
+    beforeEach(() => {
+        testUtils.mockSetup();
+    });
+
+    afterEach(() => {
+        testUtils.mockReset();
+    });
+
+    describe('Retrieve ================', () => {
+        it('Should retrieve a fileLocation', async () => {
+            // WHEN
+            await handler.retrieve('testInstance/testBU', ['fileLocation']);
+            // THEN
+            assert.equal(process.exitCode, 0, 'retrieve should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.fileLocation ? Object.keys(result.fileLocation).length : 0,
+                6,
+                'unexpected number of fileLocations'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('Salesforce Objects %26 Reports', 'fileLocation'),
+                await testUtils.getExpectedJson('9999999', 'fileLocation', 'get-sor'),
+                'returned JSON was not equal expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('ExactTarget Enhanced FTP', 'fileLocation'),
+                await testUtils.getExpectedJson('9999999', 'fileLocation', 'get-eftp'),
+                'returned JSON was not equal expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_fileLocation_gcp', 'fileLocation'),
+                await testUtils.getExpectedJson('9999999', 'fileLocation', 'get-gcp'),
+                'returned JSON was not equal expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_fileLocation_azure', 'fileLocation'),
+                await testUtils.getExpectedJson('9999999', 'fileLocation', 'get-azure'),
+                'returned JSON was not equal expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_fileLocation_aws', 'fileLocation'),
+                await testUtils.getExpectedJson('9999999', 'fileLocation', 'get-aws'),
+                'returned JSON was not equal expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_fileLocation_exsftp', 'fileLocation'),
+                await testUtils.getExpectedJson('9999999', 'fileLocation', 'get-exsftp'),
+                'returned JSON was not equal expected'
+            );
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                2,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+
+        it('Should retrieve an old fileLocation by key', async () => {
+            // WHEN
+            await handler.retrieve(
+                'testInstance/testBU',
+                ['fileLocation'],
+                ['Salesforce Objects & Reports']
+            );
+            // THEN
+            assert.equal(process.exitCode, 0, 'retrieve should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.fileLocation ? Object.keys(result.fileLocation).length : 0,
+                1,
+                'unexpected number of fileLocations'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('Salesforce Objects %26 Reports', 'fileLocation'),
+                await testUtils.getExpectedJson('9999999', 'fileLocation', 'get-sor'),
+                'returned JSON was not equal expected'
+            );
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                2,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+
+        it('Should retrieve a new fileLocation by key', async () => {
+            // WHEN
+            await handler.retrieve(
+                'testInstance/testBU',
+                ['fileLocation'],
+                ['testExisting_fileLocation_azure']
+            );
+            // THEN
+            assert.equal(process.exitCode, 0, 'retrieve should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.fileLocation ? Object.keys(result.fileLocation).length : 0,
+                1,
+                'unexpected number of fileLocations'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_fileLocation_azure', 'fileLocation'),
+                await testUtils.getExpectedJson('9999999', 'fileLocation', 'get-azure'),
+                'returned JSON was not equal expected'
+            );
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                2,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
+
+    describe('Deploy ================', () => {
+        beforeEach(() => {
+            testUtils.mockSetup(true);
+        });
+
+        it('Should update fileLocations', async () => {
+            // WHEN
+            const deployed = await handler.deploy(
+                'testInstance/testBU',
+                ['fileLocation'],
+                ['testExisting_fileLocation_exsftp', 'testExisting_fileLocation_aws']
+            );
+            // THEN
+            assert.equal(process.exitCode, 0, 'deploy should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.fileLocation ? Object.keys(result.fileLocation).length : 0,
+                6,
+                'unexpected number of fileLocations in cache'
+            );
+            assert.equal(
+                deployed?.['testInstance/testBU']?.fileLocation
+                    ? Object.keys(deployed['testInstance/testBU'].fileLocation).length
+                    : 0,
+                2,
+                'unexpected number of fileLocations deployed'
+            );
+            // confirm created item
+            // TODO
+
+            // confirm updated item
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_fileLocation_exsftp', 'fileLocation'),
+                await testUtils.getExpectedJson('9999999', 'fileLocation', 'patch-exsftp'),
+                'returned JSON was not equal expected for insert fileLocation'
+            );
+            // confirm updated item
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_fileLocation_aws', 'fileLocation'),
+                await testUtils.getExpectedJson('9999999', 'fileLocation', 'patch-aws'),
+                'returned JSON was not equal expected for update fileLocation'
+            );
+            // check number of API calls
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                4,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+
+        it('Should not update fileLocations', async () => {
+            // WHEN
+            const deployed = await handler.deploy(
+                'testInstance/testBU',
+                ['fileLocation'],
+                ['ExactTarget Enhanced FTP']
+            );
+            // THEN
+            assert.equal(process.exitCode, 1, 'deploy should have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.fileLocation ? Object.keys(result.fileLocation).length : 0,
+                6,
+                'unexpected number of fileLocations in cache'
+            );
+            assert.equal(
+                deployed?.['testInstance/testBU']?.fileLocation
+                    ? Object.keys(deployed['testInstance/testBU'].fileLocation).length
+                    : 0,
+                0,
+                'unexpected number of fileLocations deployed'
+            );
+
+            // check number of API calls
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                2,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
+
+    describe('Templating ================', () => {
+        it('Should create a fileLocation template via buildTemplate and build it', async () => {
+            // download first before we test buildTemplate
+            await handler.retrieve('testInstance/testBU', ['fileLocation']);
+            // buildTemplate
+            const result = await handler.buildTemplate(
+                'testInstance/testBU',
+                'fileLocation',
+                ['testExisting_fileLocation_azure'],
+                ['testSourceMarket']
+            );
+            assert.equal(process.exitCode, 0, 'buildTemplate should not have thrown an error');
+            assert.equal(
+                result.fileLocation ? Object.keys(result.fileLocation).length : 0,
+                1,
+                'only one fileLocation expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualTemplateJson(
+                    'testExisting_fileLocation_azure',
+                    'fileLocation'
+                ),
+                await testUtils.getExpectedJson('9999999', 'fileLocation', 'template'),
+                'returned template JSON was not equal expected'
+            );
+            // buildDefinition
+            await handler.buildDefinition(
+                'testInstance/testBU',
+                'fileLocation',
+                ['testExisting_fileLocation_azure'],
+                ['testTargetMarket']
+            );
+            assert.equal(process.exitCode, 0, 'buildDefinition should not have thrown an error');
+            assert.deepEqual(
+                await testUtils.getActualDeployJson(
+                    'testTemplated_fileLocation_azure',
+                    'fileLocation'
+                ),
+                await testUtils.getExpectedJson('9999999', 'fileLocation', 'build'),
+                'returned deployment JSON was not equal expected'
+            );
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                2,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
+
+    describe('Delete ================', () => {
+        it('Should delete the item', async () => {
+            // WHEN
+            const isDeleted = await handler.deleteByKey(
+                'testInstance/testBU',
+                'fileLocation',
+                'testExisting_fileLocation_azure'
+            );
+            // THEN
+            assert.equal(process.exitCode, 0, 'deleteByKey should not have thrown an error');
+            assert.equal(isDeleted, true, 'deleteByKey should have returned true');
+            return;
+        });
+    });
+});

package/test/type.fileTransfer.test.js

@@ -36,7 +36,7 @@ describe('type: fileTransfer', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                3,
+                4,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -75,7 +75,7 @@ describe('type: fileTransfer', () => {
             // check number of API calls
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                5,
+                6,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -117,7 +117,7 @@ describe('type: fileTransfer', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                3,
+                4,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -159,7 +159,7 @@ describe('type: fileTransfer', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                3,
+                4,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;

package/test/type.filter.test.js

@@ -77,7 +77,7 @@ describe('type: filter', () => {
         it('Should create & upsert a filter', async () => {
             // WHEN
 
-            await handler.deploy('testInstance/testBU', ['filter']);
+            const deployed = await handler.deploy('testInstance/testBU', ['filter']);
             // THEN
             assert.equal(process.exitCode, 0, 'deploy should not have thrown an error');
             // get results from cache
@@ -85,7 +85,14 @@ describe('type: filter', () => {
             assert.equal(
                 result.filter ? Object.keys(result.filter).length : 0,
                 2,
-                'unexptected number of filters in cache'
+                'unexpected number of filters in cache'
+            );
+            assert.equal(
+                deployed?.['testInstance/testBU']?.filter
+                    ? Object.keys(deployed['testInstance/testBU'].filter).length
+                    : 0,
+                2,
+                'unexpected number of filters deployed'
             );
             // confirm created item
             assert.deepEqual(

package/test/type.importFile.test.js

@@ -46,7 +46,7 @@ describe('type: importFile', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                15,
+                16,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -75,7 +75,7 @@ describe('type: importFile', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                13,
+                14,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -115,7 +115,7 @@ describe('type: importFile', () => {
             // check number of API calls
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                17,
+                18,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -157,7 +157,7 @@ describe('type: importFile', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                13,
+                14,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -199,7 +199,7 @@ describe('type: importFile', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                15,
+                16,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;

package/test/type.journey.test.js

@@ -52,6 +52,32 @@ describe('type: journey', () => {
             return;
         });
 
+        it('Should retrieve only published journeys', async () => {
+            handler.setOptions({ onlyPublished: true });
+            // WHEN
+            await handler.retrieve('testInstance/testBU', ['journey']);
+            // THEN
+            assert.equal(process.exitCode, 0, 'retrieve should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.journey ? Object.keys(result.journey).length : 0,
+                1,
+                'unexpected number of journeys'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_temail', 'journey'),
+                await testUtils.getExpectedJson('9999999', 'journey', 'get-transactionalEmail'),
+                'returned JSON was not equal expected'
+            );
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                24,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+
         it('Should retrieve a Quicksend journey with key', async () => {
             // WHEN
             await handler.retrieve(

package/test/type.query.test.js

@@ -648,7 +648,7 @@ describe('type: query', () => {
             // check number of API calls
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                47,
+                48,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -690,7 +690,7 @@ describe('type: query', () => {
             // check number of API calls
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                49,
+                50,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;

package/test/type.script.test.js

@@ -261,7 +261,7 @@ describe('type: script', () => {
             // check number of API calls
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                4,
+                5,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;