mcdev 5.1.0 → 5.2.0

package/test/type.script.test.js

@@ -0,0 +1,367 @@
+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 dir = chaiFiles.dir;
+const cache = require('../lib/util/cache');
+const testUtils = require('./utils');
+const handler = require('../lib/index');
+
+describe('type: script', () => {
+    beforeEach(() => {
+        testUtils.mockSetup();
+    });
+    afterEach(() => {
+        testUtils.mockReset();
+    });
+
+    describe('Retrieve ================', () => {
+        it('Should retrieve all scripts', async () => {
+            // WHEN
+            const retrieve = await handler.retrieve('testInstance/testBU', ['script']);
+            // THEN
+            assert.equal(process.exitCode, false, 'retrieve should not have thrown an error');
+
+            // retrieve result
+            assert.equal(
+                retrieve['testInstance/testBU'].script
+                    ? Object.keys(retrieve['testInstance/testBU'].script).length
+                    : 0,
+                2,
+                'only 2 scripts expected in retrieve response'
+            );
+
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.script ? Object.keys(result.script).length : 0,
+                2,
+                'only 2 scripts expected'
+            );
+            // normal test
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_script', 'script'),
+                await testUtils.getExpectedJson('9999999', 'script', 'get'),
+                'returned metadata with correct key was not equal expected'
+            );
+            expect(file(testUtils.getActualFile('testExisting_script', 'script', 'html'))).to.not
+                .exist;
+            expect(file(testUtils.getActualFile('testExisting_script', 'script', 'ssjs'))).to.equal(
+                file(testUtils.getExpectedFile('9999999', 'script', 'get', 'ssjs'))
+            );
+
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_script_noScriptTag', 'script'),
+                await testUtils.getExpectedJson('9999999', 'script', 'get_noScriptTag'),
+                'returned metadata was not equal expected'
+            );
+            expect(
+                file(testUtils.getActualFile('testExisting_script_noScriptTag', 'script', 'html'))
+            ).to.equal(
+                file(testUtils.getExpectedFile('9999999', 'script', 'get_noScriptTag', 'html'))
+            );
+            expect(
+                file(testUtils.getActualFile('testExisting_script_noScriptTag', 'script', 'ssjs'))
+            ).to.not.exist;
+
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                3,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+        it('Should retrieve one specific script by key', async () => {
+            // WHEN
+            await handler.retrieve('testInstance/testBU', ['script'], ['testExisting_script']);
+            // THEN
+            assert.equal(process.exitCode, false, 'retrieve should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.script ? Object.keys(result.script).length : 0,
+                1,
+                'only one script expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_script', 'script'),
+                await testUtils.getExpectedJson('9999999', 'script', 'get'),
+                'returned metadata was not equal expected'
+            );
+            expect(file(testUtils.getActualFile('testExisting_script', 'script', 'html'))).to.not
+                .exist;
+            expect(file(testUtils.getActualFile('testExisting_script', 'script', 'ssjs'))).to.equal(
+                file(testUtils.getExpectedFile('9999999', 'script', 'get', 'ssjs'))
+            );
+
+            expect(
+                file(testUtils.getActualFile('testExisting_script_noScriptTag', 'script', 'json'))
+            ).to.not.exist;
+            expect(
+                file(testUtils.getActualFile('testExisting_script_noScriptTag', 'script', 'ssjs'))
+            ).to.not.exist;
+            expect(
+                file(testUtils.getActualFile('testExisting_script_noScriptTag', 'script', 'html'))
+            ).to.not.exist;
+
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                3,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+        it('Should retrieve one specific script via --like', async () => {
+            // WHEN
+            handler.setOptions({ like: { key: '%Existing_script' } });
+            await handler.retrieve('testInstance/testBU', ['script']);
+
+            // THEN
+            assert.equal(process.exitCode, false, 'retrieve should not have thrown an error');
+
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.script ? Object.keys(result.script).length : 0,
+                2,
+                'two scripts in cache expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_script', 'script'),
+                await testUtils.getExpectedJson('9999999', 'script', 'get'),
+                'returned metadata was not equal expected'
+            );
+            expect(file(testUtils.getActualFile('testExisting_script', 'script', 'ssjs'))).to.equal(
+                file(testUtils.getExpectedFile('9999999', 'script', 'get', 'ssjs'))
+            );
+
+            expect(
+                file(testUtils.getActualFile('testExisting_script_noScriptTag', 'script', 'json'))
+            ).to.not.exist;
+            expect(
+                file(testUtils.getActualFile('testExisting_script_noScriptTag', 'script', 'ssjs'))
+            ).to.not.exist;
+            expect(
+                file(testUtils.getActualFile('testExisting_script_noScriptTag', 'script', 'html'))
+            ).to.not.exist;
+
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                3,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+        it('Should not retrieve any script via --like and key due to a mismatching filter', async () => {
+            // WHEN
+            handler.setOptions({ like: { key: 'NotExisting_script' } });
+            await handler.retrieve('testInstance/testBU', ['script']);
+            // THEN
+            assert.equal(process.exitCode, false, 'retrieve should not have thrown an error');
+
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.script ? Object.keys(result.script).length : 0,
+                2,
+                'two scripts in cache expected'
+            );
+
+            expect(file(testUtils.getActualFile('testExisting_script', 'script', 'ssjs'))).to.not
+                .exist;
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                3,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
+    describe('Deploy ================', () => {
+        beforeEach(() => {
+            testUtils.mockSetup(true);
+        });
+        it('Should create & upsert a script', async () => {
+            // WHEN
+            await handler.deploy('testInstance/testBU', ['script']);
+            // THEN
+            assert.equal(process.exitCode, false, 'deploy should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.script ? Object.keys(result.script).length : 0,
+                3,
+                'three scripts expected'
+            );
+            // confirm created item
+            assert.deepEqual(
+                await testUtils.getActualJson('testNew_script', 'script'),
+                await testUtils.getExpectedJson('9999999', 'script', 'post'),
+                'returned metadata was not equal expected for insert script'
+            );
+            expect(file(testUtils.getActualFile('testNew_script', 'script', 'ssjs'))).to.equal(
+                file(testUtils.getExpectedFile('9999999', 'script', 'post', 'ssjs'))
+            );
+            // confirm updated item
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_script', 'script'),
+                await testUtils.getExpectedJson('9999999', 'script', 'patch'),
+                'returned metadata was not equal expected for insert script'
+            );
+            expect(file(testUtils.getActualFile('testExisting_script', 'script', 'ssjs'))).to.equal(
+                file(testUtils.getExpectedFile('9999999', 'script', 'patch', 'ssjs'))
+            );
+            // check number of API calls
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                5,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
+    describe('Templating ================', () => {
+        it('Should create a script template via retrieveAsTemplate and build it', async () => {
+            // GIVEN there is a template
+            const result = await handler.retrieveAsTemplate(
+                'testInstance/testBU',
+                'script',
+                ['testExisting_script'],
+                'testSourceMarket'
+            );
+            // WHEN
+            assert.equal(
+                process.exitCode,
+                false,
+                'retrieveAsTemplate should not have thrown an error'
+            );
+            assert.equal(
+                result.script ? Object.keys(result.script).length : 0,
+                1,
+                'only one script expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualTemplateJson('testExisting_script', 'script'),
+                await testUtils.getExpectedJson('9999999', 'script', 'template'),
+                'returned template JSON of retrieveAsTemplate was not equal expected'
+            );
+            expect(
+                file(testUtils.getActualTemplateFile('testExisting_script', 'script', 'ssjs'))
+            ).to.equal(file(testUtils.getExpectedFile('9999999', 'script', 'template', 'ssjs')));
+            // THEN
+            await handler.buildDefinition(
+                'testInstance/testBU',
+                'script',
+                'testExisting_script',
+                'testTargetMarket'
+            );
+            assert.equal(
+                process.exitCode,
+                false,
+                'buildDefinition should not have thrown an error'
+            );
+
+            assert.deepEqual(
+                await testUtils.getActualDeployJson('testTemplated_script', 'script'),
+                await testUtils.getExpectedJson('9999999', 'script', 'build'),
+                'returned deployment JSON was not equal expected'
+            );
+            expect(
+                file(testUtils.getActualDeployFile('testTemplated_script', 'script', 'ssjs'))
+            ).to.equal(file(testUtils.getExpectedFile('9999999', 'script', 'build', 'ssjs')));
+
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                3,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+        it('Should create a script template via buildTemplate and build it', async () => {
+            // download first before we test buildTemplate
+            await handler.retrieve('testInstance/testBU', ['script']);
+            // GIVEN there is a template
+            const result = await handler.buildTemplate(
+                'testInstance/testBU',
+                'script',
+                ['testExisting_script'],
+                'testSourceMarket'
+            );
+            // WHEN
+            assert.equal(process.exitCode, false, 'buildTemplate should not have thrown an error');
+
+            assert.equal(
+                result.script ? Object.keys(result.script).length : 0,
+                1,
+                'only one script expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualTemplateJson('testExisting_script', 'script'),
+                await testUtils.getExpectedJson('9999999', 'script', 'template'),
+                'returned template JSON of buildTemplate was not equal expected'
+            );
+            expect(
+                file(testUtils.getActualTemplateFile('testExisting_script', 'script', 'ssjs'))
+            ).to.equal(file(testUtils.getExpectedFile('9999999', 'script', 'template', 'ssjs')));
+            // THEN
+            await handler.buildDefinition(
+                'testInstance/testBU',
+                'script',
+                'testExisting_script',
+                'testTargetMarket'
+            );
+            assert.equal(
+                process.exitCode,
+                false,
+                'buildDefinition should not have thrown an error'
+            );
+
+            assert.deepEqual(
+                await testUtils.getActualDeployJson('testTemplated_script', 'script'),
+                await testUtils.getExpectedJson('9999999', 'script', 'build'),
+                'returned deployment JSON was not equal expected'
+            );
+            expect(
+                file(testUtils.getActualDeployFile('testTemplated_script', 'script', 'ssjs'))
+            ).to.equal(file(testUtils.getExpectedFile('9999999', 'script', 'build', 'ssjs')));
+
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                3,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
+    describe('Delete ================', () => {});
+    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', 'script', [
+                'testExisting_script',
+            ]);
+            // THEN
+            assert.equal(
+                process.exitCode,
+                false,
+                'getFilesToCommit should not have thrown an error'
+            );
+            assert.equal(fileList.length, 3, 'expected only 3 file paths (html, json, ssjs)');
+
+            assert.equal(
+                fileList[0].split('\\').join('/'),
+                'retrieve/testInstance/testBU/script/testExisting_script.script-meta.json',
+                'wrong JSON path'
+            );
+            assert.equal(
+                fileList[1].split('\\').join('/'),
+                'retrieve/testInstance/testBU/script/testExisting_script.script-meta.ssjs',
+                'wrong JSON path'
+            );
+            return;
+        });
+    });
+    describe('Execute ================', () => {});
+});

package/test/type.triggeredSend.test.js

@@ -0,0 +1,152 @@
+const chai = require('chai');
+const chaiFiles = require('chai-files');
+const assert = chai.assert;
+chai.use(chaiFiles);
+const cache = require('../lib/util/cache');
+const testUtils = require('./utils');
+const handler = require('../lib/index');
+
+describe('type: triggeredSend', () => {
+    beforeEach(() => {
+        testUtils.mockSetup();
+    });
+    afterEach(() => {
+        testUtils.mockReset();
+    });
+
+    describe('Retrieve ================', () => {
+        it('Should retrieve a triggeredSend', async () => {
+            // WHEN
+            await handler.retrieve('testInstance/testBU', ['triggeredSend']);
+            // THEN
+            assert.equal(process.exitCode, false, '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'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_triggeredSend', 'triggeredSend'),
+                await testUtils.getExpectedJson('9999999', 'triggeredSend', 'get'),
+                'returned JSON was not equal expected'
+            );
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                10,
+                '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');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.triggeredSend ? Object.keys(result.triggeredSend).length : 0,
+                2,
+                'two triggeredSends expected'
+            );
+            // confirm created item
+            assert.deepEqual(
+                await testUtils.getActualJson('testNew_triggeredSend', 'triggeredSend'),
+                await testUtils.getExpectedJson('9999999', 'triggeredSend', 'post'),
+                'returned JSON was not equal expected for insert triggeredSend'
+            );
+            // confirm updated item
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_triggeredSend', 'triggeredSend'),
+                await testUtils.getExpectedJson('9999999', 'triggeredSend', 'patch'),
+                'returned JSON was not equal expected for update triggeredSend'
+            );
+            // check number of API calls
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                12,
+                '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
+            await handler.retrieve('testInstance/testBU', ['triggeredSend']);
+            // buildTemplate
+            const result = await handler.buildTemplate(
+                'testInstance/testBU',
+                'triggeredSend',
+                ['testExisting_triggeredSend'],
+                'testSourceMarket'
+            );
+            assert.equal(process.exitCode, false, 'buildTemplate should not have thrown an error');
+            assert.equal(
+                result.triggeredSend ? Object.keys(result.triggeredSend).length : 0,
+                1,
+                'only one triggeredSend expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualTemplateJson(
+                    'testExisting_triggeredSend',
+                    'triggeredSend'
+                ),
+                await testUtils.getExpectedJson('9999999', 'triggeredSend', 'template'),
+                'returned template JSON was not equal expected'
+            );
+            // buildDefinition
+            await handler.buildDefinition(
+                'testInstance/testBU',
+                'triggeredSend',
+                'testExisting_triggeredSend',
+                'testTargetMarket'
+            );
+            assert.equal(
+                process.exitCode,
+                false,
+                'buildDefinition should not have thrown an error'
+            );
+            assert.deepEqual(
+                await testUtils.getActualDeployJson('testTemplated_triggeredSend', 'triggeredSend'),
+                await testUtils.getExpectedJson('9999999', 'triggeredSend', 'build'),
+                'returned deployment JSON was not equal expected'
+            );
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                10,
+                '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', 'triggeredSend', [
+                'testExisting_triggeredSend',
+            ]);
+            // THEN
+            assert.equal(process.exitCode, false, 'delete should not have thrown an error');
+
+            assert.equal(result, 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');
+    });
+});

package/test/type.user.test.js

@@ -26,8 +26,8 @@ describe('type: user', () => {
             const result = cache.getCache();
             assert.equal(
                 result.user ? Object.keys(result.user).length : 0,
-                1,
-                'only one user expected'
+                3,
+                'only three users expected'
             );
             assert.deepEqual(
                 await testUtils.getActualJson('testExisting_user', 'user', '_ParentBU_'),
@@ -42,7 +42,7 @@ describe('type: user', () => {
                 { encoding: 'utf8' }
             );
             const regexFindDaysSinceLogin =
-                /\| (\d*) (seconds|minutes|days|weeks|months|years){1} \|/gm;
+                /\| (\d*) (seconds|minutes|days|weeks|months|years){1} \|/g;
             // fetch expected time since last login
             const expectedDaysSinceLogin = expectedFile.match(regexFindDaysSinceLogin);
             // load actual file and replace days since last login with expected value
@@ -50,7 +50,7 @@ describe('type: user', () => {
                 await File.readFile(`./docs/user/testInstance.users.md`, {
                     encoding: 'utf8',
                 })
-            ).replaceAll(regexFindDaysSinceLogin, expectedDaysSinceLogin);
+            ).replaceAll(regexFindDaysSinceLogin, [expectedDaysSinceLogin[0]]);
             expect(actualFile).to.equal(expectedFile);
 
             assert.equal(
@@ -83,7 +83,12 @@ describe('type: user', () => {
         });
         it('Should create & upsert a user', async () => {
             // WHEN
-            const expectedCache = ['testNew_user', 'testExisting_user'];
+            const expectedCache = [
+                'testExisting_user',
+                'testExisting_user_inactive',
+                '45372cbb-06e0-438e-88d8-008981f7a18b',
+                'testNew_user',
+            ];
             await handler.deploy('testInstance/_ParentBU_', ['user'], expectedCache);
             // THEN
             assert.equal(process.exitCode, false, 'deploy should not have thrown an error');
@@ -92,8 +97,8 @@ describe('type: user', () => {
             const result = cache.getCache();
             assert.equal(
                 result.user ? Object.keys(result.user).length : 0,
-                2,
-                'two users expected'
+                4,
+                'four users expected'
             );
             // confirm if result.user only includes values from expectedCache
             assert.deepEqual(
@@ -126,14 +131,22 @@ describe('type: user', () => {
         });
         it('Should not deploy user with Marketing Cloud role', async () => {
             // WHEN
-            const expectedCache = ['testExisting_user'];
+            const expectedCache = [
+                'testExisting_user',
+                'testExisting_user_inactive',
+                '45372cbb-06e0-438e-88d8-008981f7a18b',
+            ];
             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');
+            assert.equal(
+                result.user ? Object.keys(result.user).length : 0,
+                3,
+                'three users expected'
+            );
             // confirm if result.user only includes values from expectedCache
             assert.deepEqual(
                 Object.keys(result.user),
@@ -148,7 +161,6 @@ describe('type: user', () => {
             );
             return;
         });
-        it('Should change the key during update with --changeKeyValue');
     });
     describe('Templating ================', () => {
         // it('Should create a user template via retrieveAsTemplate and build it', async () => {});

package/test/utils.js

@@ -112,7 +112,10 @@ exports.getExpectedFile = (mid, type, action, ext) =>
  */
 
 exports.mockSetup = (isDeploy) => {
-    handler.setOptions({ debug: true, noLogFile: true });
+    if (!isDeploy) {
+        // no need to execute this again - already done in standard setup
+        handler.setOptions({ debug: true, noLogFile: true });
+    }
     apimock = new MockAdapter(axios, { onNoMatch: 'throwException' });
     // set access_token to mid to allow for autorouting of mock to correct resources
     apimock.onPost(authResources.success.url).reply((config) => {

package/lib/metadataTypes/SetDefinition.js

@@ -1,37 +0,0 @@
-'use strict';
-
-const TYPE = require('../../types/mcdev.d');
-const MetadataType = require('./MetadataType');
-
-/**
- * SetDefinition MetadataType
- *
- * @augments MetadataType
- */
-class SetDefinition extends MetadataType {
-    /**
-     * Retrieves Metadata of schema set Definitions.
-     *
-     * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
-     * @param {void} [_] unused parameter
-     * @param {void} [__] unused parameter
-     * @param {string} [key] customer key of single item to retrieve
-     * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise
-     */
-    static retrieve(retrieveDir, _, __, key) {
-        return super.retrieveREST(retrieveDir, '/hub/v1/contacts/schema/setDefinitions', null, key);
-    }
-    /**
-     * Retrieves Metadata of schema set definitions for caching.
-     *
-     * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise
-     */
-    static retrieveForCache() {
-        return super.retrieveREST(null, '/hub/v1/contacts/schema/setDefinitions');
-    }
-}
-
-// Assign definition to static attributes
-SetDefinition.definition = require('../MetadataTypeDefinitions').setDefinition;
-
-module.exports = SetDefinition;