mcdev 4.3.3 → 5.0.0

package/test/{query.test.js → type.query.test.js}

@@ -9,7 +9,7 @@ const cache = require('../lib/util/cache');
 const testUtils = require('./utils');
 const handler = require('../lib/index');
 
-describe('query', () => {
+describe('type: query', () => {
     beforeEach(() => {
         testUtils.mockSetup();
     });
@@ -18,10 +18,46 @@ describe('query', () => {
     });
 
     describe('Retrieve ================', () => {
-        it('Should retrieve a query', async () => {
+        it('Should retrieve all queries', async () => {
             // WHEN
             await handler.retrieve('testInstance/testBU', ['query']);
             // THEN
+            assert.equal(process.exitCode, false, 'retrieve should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.query ? Object.keys(result.query).length : 0,
+                2,
+                'only two queries expected'
+            );
+            // normal test
+            assert.deepEqual(
+                await testUtils.getActualJson('testExistingQuery', 'query'),
+                await testUtils.getExpectedJson('9999999', 'query', 'get'),
+                'returned metadata with correct key was not equal expected'
+            );
+            expect(file(testUtils.getActualFile('testExistingQuery', 'query', 'sql'))).to.equal(
+                file(testUtils.getExpectedFile('9999999', 'query', 'get', 'sql'))
+            );
+            // check if targetKey was overwritten
+            assert.deepEqual(
+                await testUtils.getActualJson('testExistingQuery2', 'query'),
+                await testUtils.getExpectedJson('9999999', 'query', 'get2'),
+                'returned metadata with wrong key was not equal expected'
+            );
+
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                6,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+        it('Should retrieve one specific query', async () => {
+            // WHEN
+            await handler.retrieve('testInstance/testBU', ['query'], ['testExistingQuery']);
+            // THEN
+            assert.equal(process.exitCode, false, 'retrieve should not have thrown an error');
             // get results from cache
             const result = cache.getCache();
             assert.equal(
@@ -39,7 +75,7 @@ describe('query', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                6,
+                7,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -53,12 +89,13 @@ describe('query', () => {
             // WHEN
             await handler.deploy('testInstance/testBU', ['query']);
             // THEN
+            assert.equal(process.exitCode, false, 'deploy should not have thrown an error');
             // get results from cache
             const result = cache.getCache();
             assert.equal(
                 result.query ? Object.keys(result.query).length : 0,
-                2,
-                'two querys expected'
+                3,
+                'three queries expected'
             );
             // confirm created item
             assert.deepEqual(
@@ -86,6 +123,7 @@ describe('query', () => {
             );
             return;
         });
+        it('Should change the key during update with --changeKeyValue');
     });
     describe('Templating ================', () => {
         it('Should create a query template via retrieveAsTemplate and build it', async () => {
@@ -97,6 +135,11 @@ describe('query', () => {
                 'testSourceMarket'
             );
             // WHEN
+            assert.equal(
+                process.exitCode,
+                false,
+                'retrieveAsTemplate should not have thrown an error'
+            );
             assert.equal(
                 result.query ? Object.keys(result.query).length : 0,
                 1,
@@ -117,6 +160,12 @@ describe('query', () => {
                 'testExistingQuery',
                 'testTargetMarket'
             );
+            assert.equal(
+                process.exitCode,
+                false,
+                'buildDefinition should not have thrown an error'
+            );
+
             assert.deepEqual(
                 await testUtils.getActualDeployJson('testExistingQuery', 'query'),
                 await testUtils.getExpectedJson('9999999', 'query', 'build'),
@@ -143,6 +192,8 @@ describe('query', () => {
                 'testSourceMarket'
             );
             // WHEN
+            assert.equal(process.exitCode, false, 'buildTemplate should not have thrown an error');
+
             assert.equal(
                 result.query ? Object.keys(result.query).length : 0,
                 1,
@@ -163,6 +214,12 @@ describe('query', () => {
                 'testExistingQuery',
                 'testTargetMarket'
             );
+            assert.equal(
+                process.exitCode,
+                false,
+                'buildDefinition should not have thrown an error'
+            );
+
             assert.deepEqual(
                 await testUtils.getActualDeployJson('testExistingQuery', 'query'),
                 await testUtils.getExpectedJson('9999999', 'query', 'build'),
@@ -180,4 +237,44 @@ describe('query', () => {
             return;
         });
     });
+    describe('Delete ================', () => {
+        it('Should delete the item', async () => {
+            // WHEN
+            const result = await handler.deleteByKey('testInstance/testBU', 'query', [
+                'testExistingQuery',
+            ]);
+            // THEN
+            assert.equal(process.exitCode, false, 'delete should not have thrown an error');
+
+            assert.equal(result, true, 'should have deleted the item');
+            return;
+        });
+    });
+    describe('CI/CD ================', () => {
+        it('Should return a list of files based on their type and key', async () => {
+            // WHEN
+            const fileList = await handler.getFilesToCommit('testInstance/testBU', 'query', [
+                'testExistingQuery',
+            ]);
+            // 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/query/testExistingQuery.query-meta.json',
+                'wrong JSON path'
+            );
+            assert.equal(
+                fileList[1].split('\\').join('/'),
+                'retrieve/testInstance/testBU/query/testExistingQuery.query-meta.sql',
+                'wrong JSON path'
+            );
+            return;
+        });
+    });
 });

package/test/{transactionalEmail.test.js → type.transactionalEmail.test.js}

@@ -6,7 +6,7 @@ const cache = require('../lib/util/cache');
 const testUtils = require('./utils');
 const handler = require('../lib/index');
 
-describe('transactionalEmail', () => {
+describe('type: transactionalEmail', () => {
     beforeEach(() => {
         testUtils.mockSetup();
     });
@@ -19,6 +19,7 @@ describe('transactionalEmail', () => {
             // WHEN
             await handler.retrieve('testInstance/testBU', ['transactionalEmail']);
             // THEN
+            assert.equal(process.exitCode, false, 'retrieve should not have thrown an error');
             // get results from cache
             const result = cache.getCache();
             assert.equal(
@@ -47,6 +48,7 @@ describe('transactionalEmail', () => {
             // WHEN
             await handler.deploy('testInstance/testBU', ['transactionalEmail']);
             // THEN
+            assert.equal(process.exitCode, false, 'deploy should not have thrown an error');
             // get results from cache
             const result = cache.getCache();
             assert.equal(
@@ -74,6 +76,22 @@ describe('transactionalEmail', () => {
             );
             return;
         });
+        it('Should NOT change the key during update with --changeKeyValue and instead fail due to missing support', async () => {
+            // WHEN
+            handler.setOptions({ changeKeyValue: 'updatedKey' });
+            await handler.deploy(
+                'testInstance/testBU',
+                ['transactionalEmail'],
+                ['testExisting_temail']
+            );
+            // THEN
+            assert.equal(
+                process.exitCode,
+                1,
+                'deploy should have thrown an error due to lack of support'
+            );
+            return;
+        });
     });
     describe('Templating ================', () => {
         // it.skip('Should create a transactionalEmail template via retrieveAsTemplate and build it');
@@ -87,6 +105,7 @@ describe('transactionalEmail', () => {
                 ['testExisting_temail'],
                 'testSourceMarket'
             );
+            assert.equal(process.exitCode, false, 'buildTemplate should not have thrown an error');
             assert.equal(
                 result.transactionalEmail ? Object.keys(result.transactionalEmail).length : 0,
                 1,
@@ -104,8 +123,13 @@ describe('transactionalEmail', () => {
                 'testExisting_temail',
                 'testTargetMarket'
             );
+            assert.equal(
+                process.exitCode,
+                false,
+                'buildDefinition should not have thrown an error'
+            );
             assert.deepEqual(
-                await testUtils.getActualDeployJson('testExisting_temail', 'transactionalEmail'),
+                await testUtils.getActualDeployJson('testTemplated_temail', 'transactionalEmail'),
                 await testUtils.getExpectedJson('9999999', 'transactionalEmail', 'build'),
                 'returned deployment JSON was not equal expected'
             );
@@ -117,4 +141,18 @@ describe('transactionalEmail', () => {
             return;
         });
     });
+    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;
+        // });
+    });
 });

package/test/{transactionalPush.test.js → type.transactionalPush.test.js}

@@ -6,7 +6,7 @@ const cache = require('../lib/util/cache');
 const testUtils = require('./utils');
 const handler = require('../lib/index');
 
-describe('transactionalPush', () => {
+describe('type: transactionalPush', () => {
     beforeEach(() => {
         testUtils.mockSetup();
     });
@@ -19,6 +19,7 @@ describe('transactionalPush', () => {
             // WHEN
             await handler.retrieve('testInstance/testBU', ['transactionalPush']);
             // THEN
+            assert.equal(process.exitCode, false, 'retrieve should not have thrown an error');
             // get results from cache
             const result = cache.getCache();
             assert.equal(
@@ -47,6 +48,7 @@ describe('transactionalPush', () => {
             // WHEN
             await handler.deploy('testInstance/testBU', ['transactionalPush']);
             // THEN
+            assert.equal(process.exitCode, false, 'deploy should not have thrown an error');
             // get results from cache
             const result = cache.getCache();
             assert.equal(
@@ -74,6 +76,22 @@ describe('transactionalPush', () => {
             );
             return;
         });
+        it('Should NOT change the key during update with --changeKeyValue and instead fail due to missing support', async () => {
+            // WHEN
+            handler.setOptions({ changeKeyValue: 'updatedKey' });
+            await handler.deploy(
+                'testInstance/testBU',
+                ['transactionalPush'],
+                ['testExisting_tpush']
+            );
+            // THEN
+            assert.equal(
+                process.exitCode,
+                1,
+                'deploy should have thrown an error due to lack of support'
+            );
+            return;
+        });
     });
     describe('Templating ================', () => {
         // it.skip('Should create a transactionalPush template via retrieveAsTemplate and build it');
@@ -87,6 +105,7 @@ describe('transactionalPush', () => {
                 ['testExisting_tpush'],
                 'testSourceMarket'
             );
+            assert.equal(process.exitCode, false, 'buildTemplate should not have thrown an error');
             assert.equal(
                 result.transactionalPush ? Object.keys(result.transactionalPush).length : 0,
                 1,
@@ -104,8 +123,14 @@ describe('transactionalPush', () => {
                 'testExisting_tpush',
                 'testTargetMarket'
             );
+            assert.equal(
+                process.exitCode,
+                false,
+                'buildDefinition should not have thrown an error'
+            );
+
             assert.deepEqual(
-                await testUtils.getActualDeployJson('testExisting_tpush', 'transactionalPush'),
+                await testUtils.getActualDeployJson('testTemplated_tpush', 'transactionalPush'),
                 await testUtils.getExpectedJson('9999999', 'transactionalPush', 'build'),
                 'returned deployment JSON was not equal expected'
             );
@@ -117,4 +142,18 @@ describe('transactionalPush', () => {
             return;
         });
     });
+    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;
+        // });
+    });
 });

package/test/{transactionalSMS.test.js → type.transactionalSMS.test.js}

@@ -8,7 +8,7 @@ const cache = require('../lib/util/cache');
 const testUtils = require('./utils');
 const handler = require('../lib/index');
 
-describe('transactionalSMS', () => {
+describe('type: transactionalSMS', () => {
     beforeEach(() => {
         testUtils.mockSetup();
     });
@@ -21,6 +21,7 @@ describe('transactionalSMS', () => {
             // WHEN
             await handler.retrieve('testInstance/testBU', ['transactionalSMS']);
             // THEN
+            assert.equal(process.exitCode, false, 'retrieve should not have thrown an error');
             // get results from cache
             const result = cache.getCache();
             assert.equal(
@@ -54,6 +55,7 @@ describe('transactionalSMS', () => {
             // WHEN
             await handler.deploy('testInstance/testBU', ['transactionalSMS']);
             // THEN
+            assert.equal(process.exitCode, false, 'deploy should not have thrown an error');
             // get results from cache
             const result = cache.getCache();
             assert.equal(
@@ -91,6 +93,22 @@ describe('transactionalSMS', () => {
             );
             return;
         });
+        it('Should NOT change the key during update with --changeKeyValue and instead fail due to missing support', async () => {
+            // WHEN
+            handler.setOptions({ changeKeyValue: 'updatedKey' });
+            await handler.deploy(
+                'testInstance/testBU',
+                ['transactionalSMS'],
+                ['testExisting_tsms']
+            );
+            // THEN
+            assert.equal(
+                process.exitCode,
+                1,
+                'deploy should have thrown an error due to lack of support'
+            );
+            return;
+        });
     });
     describe('Templating ================', () => {
         // it.skip('Should create a transactionalSMS template via retrieveAsTemplate and build it');
@@ -104,6 +122,8 @@ describe('transactionalSMS', () => {
                 ['testExisting_tsms'],
                 'testSourceMarket'
             );
+            assert.equal(process.exitCode, false, 'buildTemplate should not have thrown an error');
+
             assert.equal(
                 result.transactionalSMS ? Object.keys(result.transactionalSMS).length : 0,
                 1,
@@ -128,13 +148,19 @@ describe('transactionalSMS', () => {
                 'testExisting_tsms',
                 'testTargetMarket'
             );
+            assert.equal(
+                process.exitCode,
+                false,
+                'buildDefinition should not have thrown an error'
+            );
+
             assert.deepEqual(
-                await testUtils.getActualDeployJson('testExisting_tsms', 'transactionalSMS'),
+                await testUtils.getActualDeployJson('testTemplated_tsms', 'transactionalSMS'),
                 await testUtils.getExpectedJson('9999999', 'transactionalSMS', 'build'),
                 'returned deployment JSON was not equal expected'
             );
             expect(
-                file(testUtils.getActualDeployFile('testExisting_tsms', 'transactionalSMS', 'amp'))
+                file(testUtils.getActualDeployFile('testTemplated_tsms', 'transactionalSMS', 'amp'))
             ).to.equal(
                 file(testUtils.getExpectedFile('9999999', 'transactionalSMS', 'build', 'amp'))
             );
@@ -146,4 +172,48 @@ describe('transactionalSMS', () => {
             return;
         });
     });
+    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;
+        // });
+    });
+    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;
+        // });
+    });
 });

package/test/type.user.test.js

@@ -0,0 +1,160 @@
+const assert = require('chai').assert;
+const cache = require('../lib/util/cache');
+const testUtils = require('./utils');
+const handler = require('../lib/index');
+
+describe('type: user', () => {
+    beforeEach(() => {
+        testUtils.mockSetup();
+    });
+    afterEach(() => {
+        testUtils.mockReset();
+    });
+    describe('Retrieve ================', () => {
+        it('Should retrieve a user', async () => {
+            // WHEN
+            await handler.retrieve('testInstance/_ParentBU_', ['user']);
+            // THEN
+            assert.equal(process.exitCode, false, 'retrieve should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.user ? Object.keys(result.user).length : 0,
+                1,
+                'only one user expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_user', 'user', '_ParentBU_'),
+                await testUtils.getExpectedJson('1111111', 'user', 'retrieve'),
+
+                'returned metadata 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 user', async () => {
+            // WHEN
+            const expectedCache = ['testNew_user', 'testExisting_user'];
+            await handler.deploy('testInstance/_ParentBU_', ['user'], expectedCache);
+            // THEN
+            assert.equal(process.exitCode, false, 'deploy should not have thrown an error');
+
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.user ? Object.keys(result.user).length : 0,
+                2,
+                'two users expected'
+            );
+            // confirm if result.user only includes values from expectedCache
+            assert.deepEqual(
+                Object.keys(result.user),
+                expectedCache,
+                'returned user keys were not equal expected'
+            );
+
+            // insert
+            assert.deepEqual(
+                await testUtils.getActualJson('testNew_user', 'user', '_ParentBU_'),
+                await testUtils.getExpectedJson('1111111', 'user', 'create'),
+                'returned metadata was not equal expected for create'
+            );
+            // update
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_user', 'user', '_ParentBU_'),
+                await testUtils.getExpectedJson('1111111', 'user', 'update'),
+                'returned metadata was not equal expected for update'
+            );
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                9,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+        it('Should not deploy user with Marketing Cloud role', async () => {
+            // WHEN
+            const expectedCache = ['testExisting_user'];
+            await handler.deploy('testInstance/_ParentBU_', ['user'], ['testBlocked_user']);
+            // THEN
+            assert.equal(process.exitCode, 1, 'Deployment should have thrown an error');
+
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(result.user ? Object.keys(result.user).length : 0, 1, '1 user expected');
+            // confirm if result.user only includes values from expectedCache
+            assert.deepEqual(
+                Object.keys(result.user),
+                expectedCache,
+                'returned user keys were not equal expected'
+            );
+
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                6,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+        it('Should change the key during update with --changeKeyValue');
+    });
+    describe('Templating ================', () => {
+        // it('Should create a user template via retrieveAsTemplate and build it', async () => {});
+        it('Should create a user template via buildTemplate and build it', async () => {
+            // download first before we test buildTemplate
+            await handler.retrieve('testInstance/_ParentBU_', ['user']);
+            // GIVEN there is a template
+            const result = await handler.buildTemplate(
+                'testInstance/_ParentBU_',
+                'user',
+                ['testExisting_user'],
+                'testSourceMarket'
+            );
+            assert.equal(process.exitCode, false, 'buildTemplate should not have thrown an error');
+            // WHEN
+            assert.equal(
+                result.user ? Object.keys(result.user).length : 0,
+                1,
+                'only one user expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualTemplateJson('testExisting_user', 'user'),
+                await testUtils.getExpectedJson('1111111', 'user', 'template'),
+                'returned template was not equal expected'
+            );
+            // THEN
+            await handler.buildDefinition(
+                'testInstance/_ParentBU_',
+                'user',
+                'testExisting_user',
+                'testTargetMarket'
+            );
+            assert.equal(
+                process.exitCode,
+                false,
+                'buildDefinition should not have thrown an error'
+            );
+
+            assert.deepEqual(
+                await testUtils.getActualDeployJson('testTemplated_user', 'user', '_ParentBU_'),
+                await testUtils.getExpectedJson('1111111', 'user', 'build'),
+                'returned deployment file was not equal expected'
+            );
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                6,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
+});