mcdev 6.0.2 → 7.0.0

package/test/type.transactionalSMS.test.js

@@ -1,15 +1,18 @@
-import chai, { assert, expect } from 'chai';
+import * as chai from 'chai';
+const assert = chai.assert;
+const expect = chai.expect;
+
 import chaiFiles from 'chai-files';
 import cache from '../lib/util/cache.js';
 import * as testUtils from './utils.js';
 import handler from '../lib/index.js';
 chai.use(chaiFiles);
-const file = chaiFiles.file;
 
 describe('type: transactionalSMS', () => {
     beforeEach(() => {
         testUtils.mockSetup();
     });
+
     afterEach(() => {
         testUtils.mockReset();
     });
@@ -19,7 +22,7 @@ describe('type: transactionalSMS', () => {
             // WHEN
             await handler.retrieve('testInstance/testBU', ['transactionalSMS']);
             // THEN
-            assert.equal(process.exitCode, false, 'retrieve should not have thrown an error');
+            assert.equal(process.exitCode, 0, 'retrieve should not have thrown an error');
             // get results from cache
             const result = cache.getCache();
             assert.equal(
@@ -33,9 +36,9 @@ describe('type: transactionalSMS', () => {
                 'returned JSON was not equal expected'
             );
             expect(
-                file(testUtils.getActualFile('testExisting_tsms', 'transactionalSMS', 'amp'))
+                await testUtils.getActualFile('testExisting_tsms', 'transactionalSMS', 'amp')
             ).to.equal(
-                file(testUtils.getExpectedFile('9999999', 'transactionalSMS', 'get', 'amp'))
+                await testUtils.getExpectedFile('9999999', 'transactionalSMS', 'get', 'amp')
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
@@ -45,15 +48,17 @@ describe('type: transactionalSMS', () => {
             return;
         });
     });
+
     describe('Deploy ================', () => {
         beforeEach(() => {
             testUtils.mockSetup(true);
         });
+
         it('Should create & upsert a transactionalSMS', async () => {
             // WHEN
             await handler.deploy('testInstance/testBU', ['transactionalSMS']);
             // THEN
-            assert.equal(process.exitCode, false, 'deploy should not have thrown an error');
+            assert.equal(process.exitCode, 0, 'deploy should not have thrown an error');
             // get results from cache
             const result = cache.getCache();
             assert.equal(
@@ -68,9 +73,9 @@ describe('type: transactionalSMS', () => {
                 'returned JSON was not equal expected for insert transactionalSMS'
             );
             expect(
-                file(testUtils.getActualFile('testNew_tsms', 'transactionalSMS', 'amp'))
+                await testUtils.getActualFile('testNew_tsms', 'transactionalSMS', 'amp')
             ).to.equal(
-                file(testUtils.getExpectedFile('9999999', 'transactionalSMS', 'post', 'amp'))
+                await testUtils.getExpectedFile('9999999', 'transactionalSMS', 'post', 'amp')
             );
             // confirm updated item
             assert.deepEqual(
@@ -79,9 +84,9 @@ describe('type: transactionalSMS', () => {
                 'returned JSON was not equal expected for update transactionalSMS'
             );
             expect(
-                file(testUtils.getActualFile('testExisting_tsms', 'transactionalSMS', 'amp'))
+                await testUtils.getActualFile('testExisting_tsms', 'transactionalSMS', 'amp')
             ).to.equal(
-                file(testUtils.getExpectedFile('9999999', 'transactionalSMS', 'patch', 'amp'))
+                await testUtils.getExpectedFile('9999999', 'transactionalSMS', 'patch', 'amp')
             );
             // check number of API calls
             assert.equal(
@@ -91,6 +96,7 @@ describe('type: 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' });
@@ -108,6 +114,7 @@ describe('type: transactionalSMS', () => {
             return;
         });
     });
+
     describe('Templating ================', () => {
         // it.skip('Should create a transactionalSMS template via retrieveAsTemplate and build it');
         it('Should create a transactionalSMS template via buildTemplate and build it', async () => {
@@ -120,7 +127,7 @@ describe('type: transactionalSMS', () => {
                 ['testExisting_tsms'],
                 'testSourceMarket'
             );
-            assert.equal(process.exitCode, false, 'buildTemplate should not have thrown an error');
+            assert.equal(process.exitCode, 0, 'buildTemplate should not have thrown an error');
 
             assert.equal(
                 result.transactionalSMS ? Object.keys(result.transactionalSMS).length : 0,
@@ -133,24 +140,22 @@ describe('type: transactionalSMS', () => {
                 'returned template JSON was not equal expected'
             );
             expect(
-                file(
-                    testUtils.getActualTemplateFile('testExisting_tsms', 'transactionalSMS', 'amp')
+                await testUtils.getActualTemplateFile(
+                    'testExisting_tsms',
+                    'transactionalSMS',
+                    'amp'
                 )
             ).to.equal(
-                file(testUtils.getExpectedFile('9999999', 'transactionalSMS', 'template', 'amp'))
+                await testUtils.getExpectedFile('9999999', 'transactionalSMS', 'template', 'amp')
             );
             // buildDefinition
             await handler.buildDefinition(
                 'testInstance/testBU',
                 'transactionalSMS',
-                'testExisting_tsms',
+                ['testExisting_tsms'],
                 'testTargetMarket'
             );
-            assert.equal(
-                process.exitCode,
-                false,
-                'buildDefinition should not have thrown an error'
-            );
+            assert.equal(process.exitCode, 0, 'buildDefinition should not have thrown an error');
 
             assert.deepEqual(
                 await testUtils.getActualDeployJson('testTemplated_tsms', 'transactionalSMS'),
@@ -158,9 +163,9 @@ describe('type: transactionalSMS', () => {
                 'returned deployment JSON was not equal expected'
             );
             expect(
-                file(testUtils.getActualDeployFile('testTemplated_tsms', 'transactionalSMS', 'amp'))
+                await testUtils.getActualDeployFile('testTemplated_tsms', 'transactionalSMS', 'amp')
             ).to.equal(
-                file(testUtils.getExpectedFile('9999999', 'transactionalSMS', 'build', 'amp'))
+                await testUtils.getExpectedFile('9999999', 'transactionalSMS', 'build', 'amp')
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
@@ -170,18 +175,20 @@ describe('type: transactionalSMS', () => {
             return;
         });
     });
+
     describe('Delete ================', () => {
         // TODO: add this test
         it('Should delete the item'); // , async () => {
         //     // WHEN
         //     const isDeleted = await handler.deleteByKey('testInstance/testBU', 'mobileKeyword', 'testExisting_keyword');
         //     // THEN
-        //     assert.equal(process.exitCode, false, 'delete should not have thrown an error');
+        //     assert.equal(process.exitCode, 0, '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 () => {

package/test/type.triggeredSend.test.js

@@ -1,4 +1,6 @@
-import chai, { assert } from 'chai';
+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';
@@ -9,6 +11,7 @@ describe('type: triggeredSend', () => {
     beforeEach(() => {
         testUtils.mockSetup();
     });
+
     afterEach(() => {
         testUtils.mockReset();
     });
@@ -18,13 +21,13 @@ describe('type: triggeredSend', () => {
             // WHEN
             await handler.retrieve('testInstance/testBU', ['triggeredSend']);
             // THEN
-            assert.equal(process.exitCode, false, 'retrieve should not have thrown an error');
+            assert.equal(process.exitCode, 0, 'retrieve should not have thrown an error');
             // get results from cache
             const result = cache.getCache();
             assert.equal(
                 result.triggeredSend ? Object.keys(result.triggeredSend).length : 0,
-                1,
-                'only one triggeredSend expected'
+                2,
+                'only 2 triggeredSend expected'
             );
             assert.deepEqual(
                 await testUtils.getActualJson('testExisting_triggeredSend', 'triggeredSend'),
@@ -33,26 +36,28 @@ describe('type: triggeredSend', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                10,
+                12,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
         });
     });
+
     describe('Deploy ================', () => {
         beforeEach(() => {
             testUtils.mockSetup(true);
         });
+
         it('Should create & upsert a triggeredSend', async () => {
             // WHEN
             await handler.deploy('testInstance/testBU', ['triggeredSend']);
             // THEN
-            assert.equal(process.exitCode, false, 'deploy should not have thrown an error');
+            assert.equal(process.exitCode, 0, 'deploy should not have thrown an error');
             // get results from cache
             const result = cache.getCache();
             assert.equal(
                 result.triggeredSend ? Object.keys(result.triggeredSend).length : 0,
-                2,
+                3,
                 'two triggeredSends expected'
             );
             // confirm created item
@@ -70,12 +75,13 @@ describe('type: triggeredSend', () => {
             // check number of API calls
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                12,
+                14,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
         });
     });
+
     describe('Templating ================', () => {
         it('Should create a triggeredSend template via buildTemplate and build it', async () => {
             // download first before we test buildTemplate
@@ -87,7 +93,7 @@ describe('type: triggeredSend', () => {
                 ['testExisting_triggeredSend'],
                 'testSourceMarket'
             );
-            assert.equal(process.exitCode, false, 'buildTemplate should not have thrown an error');
+            assert.equal(process.exitCode, 0, 'buildTemplate should not have thrown an error');
             assert.equal(
                 result.triggeredSend ? Object.keys(result.triggeredSend).length : 0,
                 1,
@@ -105,14 +111,10 @@ describe('type: triggeredSend', () => {
             await handler.buildDefinition(
                 'testInstance/testBU',
                 'triggeredSend',
-                'testExisting_triggeredSend',
+                ['testExisting_triggeredSend'],
                 'testTargetMarket'
             );
-            assert.equal(
-                process.exitCode,
-                false,
-                'buildDefinition should not have thrown an error'
-            );
+            assert.equal(process.exitCode, 0, 'buildDefinition should not have thrown an error');
             assert.deepEqual(
                 await testUtils.getActualDeployJson('testTemplated_triggeredSend', 'triggeredSend'),
                 await testUtils.getExpectedJson('9999999', 'triggeredSend', 'build'),
@@ -120,12 +122,13 @@ describe('type: triggeredSend', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                10,
+                12,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
         });
     });
+
     describe('Delete ================', () => {
         it('Should delete the item', async () => {
             // WHEN
@@ -135,19 +138,129 @@ describe('type: triggeredSend', () => {
                 'testExisting_triggeredSend'
             );
             // THEN
-            assert.equal(process.exitCode, false, 'delete should not have thrown an error');
+            assert.equal(process.exitCode, 0, 'delete should not have thrown an error');
 
             assert.equal(isDeleted, true, 'should have deleted the item');
             return;
         });
     });
+
     describe('Refresh ================', () => {
         it('Should refresh a triggeredSend by key');
     });
+
     describe('Start (Execute) ================', () => {
         it('Should start a triggeredSend by key');
     });
+
     describe('Pause ================', () => {
         it('Should pause a triggeredSend by key');
     });
+
+    describe('ReplaceContentBlockByX ================', () => {
+        it('Should replace references with ContentBlockByName w/o deploy', async () => {
+            handler.setOptions({ skipDeploy: true });
+
+            // WHEN
+            const replace = await handler.replaceCbReference(
+                'testInstance/testBU',
+                {
+                    triggeredSend: null,
+                },
+                'name'
+            );
+            // THEN
+            assert.equal(process.exitCode, 0, 'retrieve should not have thrown an error');
+            // retrieve result
+            assert.deepEqual(
+                replace['testInstance/testBU'].triggeredSend,
+                ['testExisting_triggeredSend_rcb'],
+                'should have found the right triggeredSends that need updating'
+            );
+
+            // check if conversions happened
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_triggeredSend_rcb', 'triggeredSend'),
+                await testUtils.getExpectedJson('9999999', 'triggeredSend', 'get-rcb-name'),
+                '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 replace references with ContentBlockById w/o deploy', async () => {
+            handler.setOptions({ skipDeploy: true });
+
+            // WHEN
+            const replace = await handler.replaceCbReference(
+                'testInstance/testBU',
+                {
+                    triggeredSend: null,
+                },
+                'id'
+            );
+            // THEN
+            assert.equal(process.exitCode, 0, 'retrieve should not have thrown an error');
+            // retrieve result
+            assert.deepEqual(
+                replace['testInstance/testBU'].triggeredSend,
+                ['testExisting_triggeredSend_rcb'],
+                'should have found the right triggeredSends that need updating'
+            );
+
+            // check if conversions happened
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_triggeredSend_rcb', 'triggeredSend'),
+                await testUtils.getExpectedJson('9999999', 'triggeredSend', 'get-rcb-id'),
+                '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 replace references with ContentBlockByKey w/o deploy', async () => {
+            handler.setOptions({ skipDeploy: true });
+
+            // WHEN
+            const replace = await handler.replaceCbReference(
+                'testInstance/testBU',
+                {
+                    triggeredSend: null,
+                },
+                'key'
+            );
+            // THEN
+            assert.equal(process.exitCode, 0, 'retrieve should not have thrown an error');
+            // retrieve result
+            assert.deepEqual(
+                replace['testInstance/testBU'].triggeredSend,
+                ['testExisting_triggeredSend_rcb'],
+                'should have found the right assets that need updating'
+            );
+
+            // check if conversions happened
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_triggeredSend_rcb', 'triggeredSend'),
+                await testUtils.getExpectedJson('9999999', 'triggeredSend', 'get-rcb-key'),
+                'returned JSON was not equal expected'
+            );
+
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                24,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
 });

package/test/type.user.test.js

@@ -1,4 +1,7 @@
-import chai, { assert, expect } from 'chai';
+import * as chai from 'chai';
+const assert = chai.assert;
+const expect = chai.expect;
+
 import chaiFiles from 'chai-files';
 import cache from '../lib/util/cache.js';
 import * as testUtils from './utils.js';
@@ -11,15 +14,17 @@ 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');
+            assert.equal(process.exitCode, 0, 'retrieve should not have thrown an error');
             // get results from cache
             const result = cache.getCache();
             assert.equal(
@@ -35,9 +40,11 @@ describe('type: user', () => {
             );
             // check if MD file was created and equals expectations
             // ! this test needs to update the lastLoginDate counter because it changes with every passing day
-            const expectedFile = await File.readFile(
-                testUtils.getExpectedFile('1111111', 'user', 'retrieve', 'md'),
-                { encoding: 'utf8' }
+            const expectedFile = await testUtils.getExpectedFile(
+                '1111111',
+                'user',
+                'retrieve',
+                'md'
             );
             const regexFindDaysSinceLogin =
                 /\| (\d*) (seconds|minutes|days|weeks|months|years){1} \|/g;
@@ -58,11 +65,12 @@ describe('type: user', () => {
             );
             return;
         });
+
         it('Should retrieve a specific user but not run document', async () => {
             // WHEN
             await handler.retrieve('testInstance/_ParentBU_', ['user'], ['testExisting_user']);
             // THEN
-            assert.equal(process.exitCode, false, 'retrieve should not have thrown an error');
+            assert.equal(process.exitCode, 0, 'retrieve should not have thrown an error');
 
             // because user is single-document-type we would not want to find an md file when we retrieve specific keys. only the generic retrieve updates it
             expect(file(`./docs/user/testInstance.users.md`)).to.not.exist;
@@ -75,10 +83,12 @@ describe('type: user', () => {
             return;
         });
     });
+
     describe('Deploy ================', () => {
         beforeEach(() => {
             testUtils.mockSetup(true);
         });
+
         it('Should create & upsert a user', async () => {
             // WHEN
             const expectedCache = [
@@ -89,7 +99,7 @@ describe('type: user', () => {
             ];
             await handler.deploy('testInstance/_ParentBU_', ['user'], expectedCache);
             // THEN
-            assert.equal(process.exitCode, false, 'deploy should not have thrown an error');
+            assert.equal(process.exitCode, 0, 'deploy should not have thrown an error');
 
             // get results from cache
             const result = cache.getCache();
@@ -127,6 +137,7 @@ describe('type: user', () => {
             );
             return;
         });
+
         it('Should not deploy user with Marketing Cloud role', async () => {
             // WHEN
             const expectedCache = [
@@ -160,6 +171,7 @@ describe('type: user', () => {
             return;
         });
     });
+
     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 () => {
@@ -172,7 +184,7 @@ describe('type: user', () => {
                 ['testExisting_user'],
                 'testSourceMarket'
             );
-            assert.equal(process.exitCode, false, 'buildTemplate should not have thrown an error');
+            assert.equal(process.exitCode, 0, 'buildTemplate should not have thrown an error');
             // WHEN
             assert.equal(
                 result.user ? Object.keys(result.user).length : 0,
@@ -188,14 +200,10 @@ describe('type: user', () => {
             await handler.buildDefinition(
                 'testInstance/_ParentBU_',
                 'user',
-                'testExisting_user',
+                ['testExisting_user'],
                 'testTargetMarket'
             );
-            assert.equal(
-                process.exitCode,
-                false,
-                'buildDefinition should not have thrown an error'
-            );
+            assert.equal(process.exitCode, 0, 'buildDefinition should not have thrown an error');
 
             assert.deepEqual(
                 await testUtils.getActualDeployJson('testTemplated_user', 'user', '_ParentBU_'),

package/test/type.verification.test.js

@@ -1,4 +1,6 @@
-import chai, { assert } from 'chai';
+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';
@@ -9,6 +11,7 @@ describe('type: verification', () => {
     beforeEach(() => {
         testUtils.mockSetup();
     });
+
     afterEach(() => {
         testUtils.mockReset();
     });
@@ -18,7 +21,7 @@ describe('type: verification', () => {
             // WHEN
             const retrieved = await handler.retrieve('testInstance/testBU', ['verification']);
             // THEN
-            assert.equal(process.exitCode, false, 'retrieve should not have thrown an error');
+            assert.equal(process.exitCode, 0, 'retrieve should not have thrown an error');
             // get results from cache
             const result = cache.getCache();
             assert.equal(
@@ -50,16 +53,18 @@ describe('type: verification', () => {
             return;
         });
     });
+
     describe('Deploy ================', () => {
         beforeEach(() => {
             testUtils.mockSetup(true);
         });
+
         it('Should create & upsert a verification', async () => {
             // WHEN
 
             const deployed = await handler.deploy('testInstance/testBU', ['verification']);
             // THEN
-            assert.equal(process.exitCode, false, 'deploy should not have thrown an error');
+            assert.equal(process.exitCode, 0, 'deploy should not have thrown an error');
             // get results from cache
             const result = cache.getCache();
             assert.equal(
@@ -98,6 +103,7 @@ describe('type: verification', () => {
             return;
         });
     });
+
     describe('Templating ================', () => {
         it('Should create a verification template via buildTemplate and build it', async () => {
             // download first before we test buildTemplate
@@ -109,7 +115,7 @@ describe('type: verification', () => {
                 ['testExisting_39f6a488-20eb-4ba0-b0b9'],
                 'testSourceMarket'
             );
-            assert.equal(process.exitCode, false, 'buildTemplate should not have thrown an error');
+            assert.equal(process.exitCode, 0, 'buildTemplate should not have thrown an error');
             assert.equal(
                 result.verification ? Object.keys(result.verification).length : 0,
                 1,
@@ -127,14 +133,10 @@ describe('type: verification', () => {
             await handler.buildDefinition(
                 'testInstance/testBU',
                 'verification',
-                'testExisting_39f6a488-20eb-4ba0-b0b9',
+                ['testExisting_39f6a488-20eb-4ba0-b0b9'],
                 'testTargetMarket'
             );
-            assert.equal(
-                process.exitCode,
-                false,
-                'buildDefinition should not have thrown an error'
-            );
+            assert.equal(process.exitCode, 0, 'buildDefinition should not have thrown an error');
             assert.deepEqual(
                 await testUtils.getActualDeployJson(
                     'testTemplated_39f6a488-20eb-4ba0-b0b9',
@@ -151,6 +153,7 @@ describe('type: verification', () => {
             return;
         });
     });
+
     describe('Delete ================', () => {
         it('Should delete the item', async () => {
             // WHEN