mcdev 4.3.4 → 5.0.0

package/test/{interaction.test.js → type.journey.test.js}

@@ -6,7 +6,7 @@ const cache = require('../lib/util/cache');
 const testUtils = require('./utils');
 const handler = require('../lib/index');
 
-describe('interaction', () => {
+describe('type: journey', () => {
     beforeEach(() => {
         testUtils.mockSetup();
     });
@@ -15,25 +15,26 @@ describe('interaction', () => {
     });
 
     describe('Retrieve ================', () => {
-        it('Should retrieve a interaction', async () => {
+        it('Should retrieve a journey', async () => {
             // WHEN
-            await handler.retrieve('testInstance/testBU', ['interaction']);
+            await handler.retrieve('testInstance/testBU', ['journey']);
             // THEN
+            assert.equal(process.exitCode, false, 'retrieve should not have thrown an error');
             // get results from cache
             const result = cache.getCache();
             assert.equal(
-                result.interaction ? Object.keys(result.interaction).length : 0,
+                result.journey ? Object.keys(result.journey).length : 0,
                 2,
-                'only 2 interactions expected'
+                'only 2 journeys expected'
             );
             assert.deepEqual(
-                await testUtils.getActualJson('testExisting_interaction', 'interaction'),
-                await testUtils.getExpectedJson('9999999', 'interaction', 'get'),
+                await testUtils.getActualJson('testExisting_interaction', 'journey'),
+                await testUtils.getExpectedJson('9999999', 'journey', 'get'),
                 'returned JSON was not equal expected'
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                9,
+                13,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -43,81 +44,114 @@ describe('interaction', () => {
         beforeEach(() => {
             testUtils.mockSetup(true);
         });
-        it('Should create & upsert a interaction', async () => {
+        it('Should create & upsert a journey', async () => {
             // WHEN
-            await handler.deploy('testInstance/testBU', ['interaction']);
+            await handler.deploy('testInstance/testBU', ['journey']);
             // THEN
+            assert.equal(process.exitCode, false, 'deploy should not have thrown an error');
             // get results from cache
             const result = cache.getCache();
             assert.equal(
-                result.interaction ? Object.keys(result.interaction).length : 0,
+                result.journey ? Object.keys(result.journey).length : 0,
                 3,
-                '3 interactions expected'
+                '3 journeys expected'
             );
             // confirm created item
             assert.deepEqual(
-                await testUtils.getActualJson('testNew_interaction', 'interaction'),
-                await testUtils.getExpectedJson('9999999', 'interaction', 'post'),
-                'returned JSON was not equal expected for insert interaction'
+                await testUtils.getActualJson('testNew_interaction', 'journey'),
+                await testUtils.getExpectedJson('9999999', 'journey', 'post'),
+                'returned JSON was not equal expected for insert journey'
             );
 
             // confirm updated item
             assert.deepEqual(
-                await testUtils.getActualJson('testExisting_interaction', 'interaction'),
-                await testUtils.getExpectedJson('9999999', 'interaction', 'put'), // watch out - interaction api wants put instead of patch for updates
-                'returned JSON was not equal expected for update interaction'
+                await testUtils.getActualJson('testExisting_interaction', 'journey'),
+                await testUtils.getExpectedJson('9999999', 'journey', 'put'), // watch out - journey api wants put instead of patch for updates
+                'returned JSON was not equal expected for update journey'
             );
 
             // check number of API calls
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                7,
+                11,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             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', ['journey'], ['testExisting_interaction']);
+            // THEN
+            assert.equal(
+                process.exitCode,
+                1,
+                'deploy should have thrown an error due to lack of support'
+            );
+            return;
+        });
     });
     describe('Templating ================', () => {
-        it('Should create a interaction template via buildTemplate and build it', async () => {
+        it('Should create a journey template via buildTemplate and build it', async () => {
             // download first before we test buildTemplate
-            await handler.retrieve('testInstance/testBU', ['interaction']);
+            await handler.retrieve('testInstance/testBU', ['journey']);
             // buildTemplate
             const result = await handler.buildTemplate(
                 'testInstance/testBU',
-                'interaction',
+                'journey',
                 ['testExisting_interaction'],
                 'testSourceMarket'
             );
+            assert.equal(process.exitCode, false, 'buildTemplate should not have thrown an error');
             assert.equal(
-                result.interaction ? Object.keys(result.interaction).length : 0,
+                result.journey ? Object.keys(result.journey).length : 0,
                 1,
-                'only one interaction expected'
+                'only one journey expected'
             );
             assert.deepEqual(
-                await testUtils.getActualTemplateJson('testExisting_interaction', 'interaction'),
-                await testUtils.getExpectedJson('9999999', 'interaction', 'template'),
+                await testUtils.getActualTemplateJson('testExisting_interaction', 'journey'),
+                await testUtils.getExpectedJson('9999999', 'journey', 'template'),
                 'returned template JSON was not equal expected'
             );
 
             // buildDefinition
             await handler.buildDefinition(
                 'testInstance/testBU',
-                'interaction',
+                'journey',
                 'testExisting_interaction',
                 'testTargetMarket'
             );
+            assert.equal(
+                process.exitCode,
+                false,
+                'buildDefinition should not have thrown an error'
+            );
             assert.deepEqual(
-                await testUtils.getActualDeployJson('testExisting_interaction', 'interaction'),
-                await testUtils.getExpectedJson('9999999', 'interaction', 'build'),
+                await testUtils.getActualDeployJson('testTemplated_interaction', 'journey'),
+                await testUtils.getExpectedJson('9999999', 'journey', 'build'),
                 'returned deployment JSON was not equal expected'
             );
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                9,
+                13,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             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/type.mobileKeyword.test.js

@@ -0,0 +1,250 @@
+const chai = require('chai');
+const chaiFiles = require('chai-files');
+const assert = chai.assert;
+chai.use(chaiFiles);
+const expect = chai.expect;
+const file = chaiFiles.file;
+const cache = require('../lib/util/cache');
+const testUtils = require('./utils');
+const handler = require('../lib/index');
+
+describe('type: mobileKeyword', () => {
+    beforeEach(() => {
+        testUtils.mockSetup();
+    });
+    afterEach(() => {
+        testUtils.mockReset();
+    });
+
+    describe('Retrieve ================', () => {
+        it('Should retrieve a mobileKeyword', async () => {
+            // WHEN
+            await handler.retrieve('testInstance/testBU', ['mobileKeyword']);
+            // THEN
+            assert.equal(process.exitCode, false, 'retrieve should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.mobileKeyword ? Object.keys(result.mobileKeyword).length : 0,
+                1,
+                'only 1 mobileKeywords expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_keyword', 'mobileKeyword'),
+                await testUtils.getExpectedJson('9999999', 'mobileKeyword', 'get'),
+                'saved JSON was not equal expected'
+            );
+            expect(
+                file(testUtils.getActualFile('testExisting_keyword', 'mobileKeyword', 'amp'))
+            ).to.equal(file(testUtils.getExpectedFile('9999999', 'mobileKeyword', 'get', 'amp')));
+            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 create (but not update) a mobileKeyword', async () => {
+            // WHEN
+            await handler.deploy('testInstance/testBU', ['mobileKeyword'], ['testNew_keyword']);
+            // THEN
+            assert.equal(process.exitCode, false, 'deploy should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.mobileKeyword ? Object.keys(result.mobileKeyword).length : 0,
+                2,
+                '2 mobileKeywords expected'
+            );
+            // confirm created item
+            assert.deepEqual(
+                await testUtils.getActualJson('testNew_keyword', 'mobileKeyword'),
+                await testUtils.getExpectedJson('9999999', 'mobileKeyword', 'post-create'),
+                'returned JSON was not equal expected for insert mobileKeyword'
+            );
+            expect(
+                file(testUtils.getActualFile('testNew_keyword', 'mobileKeyword', 'amp'))
+            ).to.equal(
+                file(testUtils.getExpectedFile('9999999', 'mobileKeyword', 'post-create', 'amp'))
+            );
+
+            // confirm updated item
+            // eslint-disable-next-line no-console
+            console.log(
+                'Not testing UPDATE because the API only responds with an empty body unless there are errors in the request body'
+            );
+
+            // 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 create a mobileKeyword with wrong type', async () => {
+            // WHEN
+            await handler.deploy(
+                'testInstance/testBU',
+                ['mobileKeyword'],
+                ['testNew_keyword_blocked']
+            );
+            // THEN
+            assert.equal(process.exitCode, true, 'deploy should have thrown an error');
+
+            // check number of API calls
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                2,
+                '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 mobileKeyword template via retrieveAsTemplate and build it', async () => {
+            // GIVEN there is a template
+            const result = await handler.retrieveAsTemplate(
+                'testInstance/testBU',
+                'mobileKeyword',
+                ['testExisting_keyword'],
+                'testSourceMarket'
+            );
+            // WHEN
+            assert.equal(
+                process.exitCode,
+                false,
+                'retrieveAsTemplate should not have thrown an error'
+            );
+            assert.equal(
+                result.mobileKeyword ? Object.keys(result.mobileKeyword).length : 0,
+                1,
+                'only one item expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualTemplateJson('testExisting_keyword', 'mobileKeyword'),
+                await testUtils.getExpectedJson('9999999', 'mobileKeyword', 'template'),
+                'returned template JSON was not equal expected'
+            );
+            expect(
+                file(
+                    testUtils.getActualTemplateFile('testExisting_keyword', 'mobileKeyword', 'amp')
+                )
+            ).to.equal(
+                file(testUtils.getExpectedFile('9999999', 'mobileKeyword', 'template', 'amp'))
+            );
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                2,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+        it('Should create a mobileKeyword template via buildTemplate and build it', async () => {
+            // download first before we test buildTemplate
+            await handler.retrieve('testInstance/testBU', ['mobileKeyword']);
+            // buildTemplate
+            const result = await handler.buildTemplate(
+                'testInstance/testBU',
+                'mobileKeyword',
+                ['testExisting_keyword'],
+                'testSourceMarket'
+            );
+            assert.equal(process.exitCode, false, 'buildTemplate should not have thrown an error');
+
+            assert.equal(
+                result.mobileKeyword ? Object.keys(result.mobileKeyword).length : 0,
+                1,
+                'only one mobileKeyword expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualTemplateJson('testExisting_keyword', 'mobileKeyword'),
+                await testUtils.getExpectedJson('9999999', 'mobileKeyword', 'template'),
+                'returned template JSON was not equal expected'
+            );
+            expect(
+                file(
+                    testUtils.getActualTemplateFile('testExisting_keyword', 'mobileKeyword', 'amp')
+                )
+            ).to.equal(
+                file(testUtils.getExpectedFile('9999999', 'mobileKeyword', 'template', 'amp'))
+            );
+
+            // buildDefinition
+            await handler.buildDefinition(
+                'testInstance/testBU',
+                'mobileKeyword',
+                'testExisting_keyword',
+                'testTargetMarket'
+            );
+            assert.equal(
+                process.exitCode,
+                false,
+                'buildDefinition should not have thrown an error'
+            );
+            assert.deepEqual(
+                await testUtils.getActualDeployJson('testTemplated_keyword', 'mobileKeyword'),
+                await testUtils.getExpectedJson('9999999', 'mobileKeyword', 'build'),
+                'returned deployment JSON was not equal expected'
+            );
+            expect(
+                file(testUtils.getActualDeployFile('testTemplated_keyword', 'mobileKeyword', 'amp'))
+            ).to.equal(file(testUtils.getExpectedFile('9999999', 'mobileKeyword', 'build', 'amp')));
+
+            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 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 ================', () => {
+        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.mobileMessage.test.js

@@ -0,0 +1,205 @@
+const chai = require('chai');
+const chaiFiles = require('chai-files');
+const assert = chai.assert;
+chai.use(chaiFiles);
+const expect = chai.expect;
+const file = chaiFiles.file;
+const cache = require('../lib/util/cache');
+const testUtils = require('./utils');
+const handler = require('../lib/index');
+
+describe('type: mobileMessage', () => {
+    beforeEach(() => {
+        testUtils.mockSetup();
+    });
+    afterEach(() => {
+        testUtils.mockReset();
+    });
+
+    describe('Retrieve ================', () => {
+        it('Should retrieve a mobileMessage', async () => {
+            // WHEN
+            await handler.retrieve('testInstance/testBU', ['mobileMessage']);
+            // THEN
+            assert.equal(process.exitCode, false, 'retrieve should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.mobileMessage ? Object.keys(result.mobileMessage).length : 0,
+                1,
+                'only 1 mobileMessages expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('NTIzOjc4OjA', 'mobileMessage'),
+                await testUtils.getExpectedJson('9999999', 'mobileMessage', 'get'),
+                'saved JSON was not equal expected'
+            );
+            expect(file(testUtils.getActualFile('NTIzOjc4OjA', 'mobileMessage', 'amp'))).to.equal(
+                file(testUtils.getExpectedFile('9999999', 'mobileMessage', 'get', 'amp'))
+            );
+            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 items', async () => {
+            // WHEN
+            await handler.deploy('testInstance/testBU', ['mobileMessage']);
+            // THEN
+            assert.equal(process.exitCode, false, 'deploy should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.mobileMessage ? Object.keys(result.mobileMessage).length : 0,
+                2,
+                '2 mobileMessages expected'
+            );
+            // confirm created item
+            assert.deepEqual(
+                await testUtils.getActualJson('NTQ3Ojc4OjA', 'mobileMessage'),
+                await testUtils.getExpectedJson('9999999', 'mobileMessage', 'post-create'),
+                'returned JSON was not equal expected for insert mobileMessage'
+            );
+            expect(file(testUtils.getActualFile('NTQ3Ojc4OjA', 'mobileMessage', 'amp'))).to.equal(
+                file(testUtils.getExpectedFile('9999999', 'mobileMessage', 'post-create', 'amp'))
+            );
+
+            // confirm updated item
+            assert.deepEqual(
+                await testUtils.getActualJson('NTIzOjc4OjA', 'mobileMessage'),
+                await testUtils.getExpectedJson('9999999', 'mobileMessage', 'post-update'), // watch out - mobileMessage api wants put instead of patch for updates
+                'returned JSON was not equal expected for update mobileMessage'
+            );
+            expect(file(testUtils.getActualFile('NTIzOjc4OjA', 'mobileMessage', 'amp'))).to.equal(
+                file(testUtils.getExpectedFile('9999999', 'mobileMessage', 'post-update', 'amp'))
+            );
+
+            // 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 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', ['mobileMessage'], ['NTIzOjc4OjA']);
+            // THEN
+            assert.equal(
+                process.exitCode,
+                1,
+                'deploy should have thrown an error due to lack of support'
+            );
+            return;
+        });
+    });
+    describe('Templating ================', () => {
+        it('Should create a mobileMessage template via buildTemplate and build it', async () => {
+            // download first before we test buildTemplate
+            await handler.retrieve('testInstance/testBU', ['mobileMessage']);
+            // buildTemplate
+            const result = await handler.buildTemplate(
+                'testInstance/testBU',
+                'mobileMessage',
+                ['NTIzOjc4OjA'],
+                'testSourceMarket'
+            );
+            assert.equal(process.exitCode, false, 'buildTemplate should not have thrown an error');
+
+            assert.equal(
+                result.mobileMessage ? Object.keys(result.mobileMessage).length : 0,
+                1,
+                'only one mobileMessage expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualTemplateJson('NTIzOjc4OjA', 'mobileMessage'),
+                await testUtils.getExpectedJson('9999999', 'mobileMessage', 'template'),
+                'returned template JSON was not equal expected'
+            );
+            expect(
+                file(testUtils.getActualTemplateFile('NTIzOjc4OjA', 'mobileMessage', 'amp'))
+            ).to.equal(
+                file(testUtils.getExpectedFile('9999999', 'mobileMessage', 'template', 'amp'))
+            );
+
+            // buildDefinition
+            await handler.buildDefinition(
+                'testInstance/testBU',
+                'mobileMessage',
+                'NTIzOjc4OjA',
+                'testTargetMarket'
+            );
+            assert.equal(
+                process.exitCode,
+                false,
+                'buildDefinition should not have thrown an error'
+            );
+            assert.deepEqual(
+                await testUtils.getActualDeployJson('NTIzOjc4OjA', 'mobileMessage'),
+                await testUtils.getExpectedJson('9999999', 'mobileMessage', 'build'),
+                'returned deployment JSON was not equal expected'
+            );
+            expect(
+                file(testUtils.getActualDeployFile('NTIzOjc4OjA', 'mobileMessage', 'amp'))
+            ).to.equal(file(testUtils.getExpectedFile('9999999', 'mobileMessage', 'build', 'amp')));
+
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                4,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
+    describe('Delete ================', () => {
+        it('Should delete the item', async () => {
+            // WHEN
+            const result = await handler.deleteByKey('testInstance/testBU', 'mobileMessage', [
+                'NTIzOjc4OjA',
+            ]);
+            // 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',
+                'mobileMessage',
+                ['NTIzOjc4OjA']
+            );
+            // 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/mobileMessage/NTIzOjc4OjA.mobileMessage-meta.json',
+                'wrong JSON path'
+            );
+            assert.equal(
+                fileList[1].split('\\').join('/'),
+                'retrieve/testInstance/testBU/mobileMessage/NTIzOjc4OjA.mobileMessage-meta.amp',
+                'wrong AMP path'
+            );
+            return;
+        });
+    });
+});