mcdev 4.1.12 → 4.2.1

package/test/transactionalPush.test.js

@@ -0,0 +1,120 @@
+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('transactionalPush', () => {
+    beforeEach(() => {
+        testUtils.mockSetup();
+    });
+    afterEach(() => {
+        testUtils.mockReset();
+    });
+
+    describe('Retrieve ================', () => {
+        it('Should retrieve a transactionalPush', async () => {
+            // WHEN
+            await handler.retrieve('testInstance/testBU', ['transactionalPush']);
+            // THEN
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.transactionalPush ? Object.keys(result.transactionalPush).length : 0,
+                1,
+                'only one transactionalPush expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_tpush', 'transactionalPush'),
+                await testUtils.getExpectedJson('9999999', 'transactionalPush', 'get'),
+                'returned JSON was not equal expected'
+            );
+            assert.equal(
+                Object.values(testUtils.getAPIHistory()).flat().length,
+                3,
+                'Unexpected number of requests made'
+            );
+            return;
+        });
+    });
+    describe('Deploy ================', () => {
+        beforeEach(() => {
+            testUtils.mockSetup(true);
+        });
+        it('Should create & upsert a transactionalPush', async () => {
+            // WHEN
+            await handler.deploy('testInstance/testBU', ['transactionalPush']);
+            // THEN
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.transactionalPush ? Object.keys(result.transactionalPush).length : 0,
+                2,
+                'two transactionalPushs expected'
+            );
+            // confirm created item
+            assert.deepEqual(
+                await testUtils.getActualJson('testNew_tpush', 'transactionalPush'),
+                await testUtils.getExpectedJson('9999999', 'transactionalPush', 'post'),
+                'returned JSON was not equal expected for insert transactionalPush'
+            );
+            // confirm updated item
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_tpush', 'transactionalPush'),
+                await testUtils.getExpectedJson('9999999', 'transactionalPush', 'patch'),
+                'returned JSON was not equal expected for update transactionalPush'
+            );
+            // check number of API calls
+            assert.equal(
+                Object.values(testUtils.getAPIHistory()).flat().length,
+                4,
+                'Unexpected number of requests made'
+            );
+            return;
+        });
+    });
+    describe('Templating ================', () => {
+        // it.skip('Should create a transactionalPush template via retrieveAsTemplate and build it');
+        it('Should create a transactionalPush template via buildTemplate and build it', async () => {
+            // download first before we test buildTemplate
+            await handler.retrieve('testInstance/testBU', ['transactionalPush']);
+            // buildTemplate
+            const result = await handler.buildTemplate(
+                'testInstance/testBU',
+                'transactionalPush',
+                ['testExisting_tpush'],
+                'testSourceMarket'
+            );
+            assert.equal(
+                result.transactionalPush ? Object.keys(result.transactionalPush).length : 0,
+                1,
+                'only one transactionalPush expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualTemplateJson('testExisting_tpush', 'transactionalPush'),
+                await testUtils.getExpectedJson('9999999', 'transactionalPush', 'template'),
+                'returned template JSON was not equal expected'
+            );
+            // buildDefinition
+            await handler.buildDefinition(
+                'testInstance/testBU',
+                'transactionalPush',
+                'testExisting_tpush',
+                'testTargetMarket'
+            );
+            assert.deepEqual(
+                await testUtils.getActualDeployJson('testExisting_tpush', 'transactionalPush'),
+                await testUtils.getExpectedJson('9999999', 'transactionalPush', 'build'),
+                'returned deployment JSON was not equal expected'
+            );
+            assert.equal(
+                Object.values(testUtils.getAPIHistory()).flat().length,
+                3,
+                'Unexpected number of requests made'
+            );
+            return;
+        });
+    });
+});

package/test/transactionalSMS.test.js

@@ -0,0 +1,149 @@
+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('transactionalSMS', () => {
+    beforeEach(() => {
+        testUtils.mockSetup();
+    });
+    afterEach(() => {
+        testUtils.mockReset();
+    });
+
+    describe('Retrieve ================', () => {
+        it('Should retrieve a transactionalSMS', async () => {
+            // WHEN
+            await handler.retrieve('testInstance/testBU', ['transactionalSMS']);
+            // THEN
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.transactionalSMS ? Object.keys(result.transactionalSMS).length : 0,
+                1,
+                'only one transactionalSMS expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_tsms', 'transactionalSMS'),
+                await testUtils.getExpectedJson('9999999', 'transactionalSMS', 'get'),
+                'returned JSON was not equal expected'
+            );
+            expect(
+                file(testUtils.getActualFile('testExisting_tsms', 'transactionalSMS', 'amp'))
+            ).to.equal(
+                file(testUtils.getExpectedFile('9999999', 'transactionalSMS', 'get', 'amp'))
+            );
+            assert.equal(
+                Object.values(testUtils.getAPIHistory()).flat().length,
+                4,
+                'Unexpected number of requests made'
+            );
+            return;
+        });
+    });
+    describe('Deploy ================', () => {
+        beforeEach(() => {
+            testUtils.mockSetup(true);
+        });
+        it('Should create & upsert a transactionalSMS', async () => {
+            // WHEN
+            await handler.deploy('testInstance/testBU', ['transactionalSMS']);
+            // THEN
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.transactionalSMS ? Object.keys(result.transactionalSMS).length : 0,
+                2,
+                'two transactionalSMSs expected'
+            );
+            // confirm created item
+            assert.deepEqual(
+                await testUtils.getActualJson('testNew_tsms', 'transactionalSMS'),
+                await testUtils.getExpectedJson('9999999', 'transactionalSMS', 'post'),
+                'returned JSON was not equal expected for insert transactionalSMS'
+            );
+            expect(
+                file(testUtils.getActualFile('testNew_tsms', 'transactionalSMS', 'amp'))
+            ).to.equal(
+                file(testUtils.getExpectedFile('9999999', 'transactionalSMS', 'post', 'amp'))
+            );
+            // confirm updated item
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_tsms', 'transactionalSMS'),
+                await testUtils.getExpectedJson('9999999', 'transactionalSMS', 'patch'),
+                'returned JSON was not equal expected for update transactionalSMS'
+            );
+            expect(
+                file(testUtils.getActualFile('testExisting_tsms', 'transactionalSMS', 'amp'))
+            ).to.equal(
+                file(testUtils.getExpectedFile('9999999', 'transactionalSMS', 'patch', 'amp'))
+            );
+            // check number of API calls
+            assert.equal(
+                Object.values(testUtils.getAPIHistory()).flat().length,
+                5,
+                'Unexpected number of requests made'
+            );
+            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 () => {
+            // download first before we test buildTemplate
+            await handler.retrieve('testInstance/testBU', ['transactionalSMS']);
+            // buildTemplate
+            const result = await handler.buildTemplate(
+                'testInstance/testBU',
+                'transactionalSMS',
+                ['testExisting_tsms'],
+                'testSourceMarket'
+            );
+            assert.equal(
+                result.transactionalSMS ? Object.keys(result.transactionalSMS).length : 0,
+                1,
+                'only one transactionalSMS expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualTemplateJson('testExisting_tsms', 'transactionalSMS'),
+                await testUtils.getExpectedJson('9999999', 'transactionalSMS', 'template'),
+                'returned template JSON was not equal expected'
+            );
+            expect(
+                file(
+                    testUtils.getActualTemplateFile('testExisting_tsms', 'transactionalSMS', 'amp')
+                )
+            ).to.equal(
+                file(testUtils.getExpectedFile('9999999', 'transactionalSMS', 'template', 'amp'))
+            );
+            // buildDefinition
+            await handler.buildDefinition(
+                'testInstance/testBU',
+                'transactionalSMS',
+                'testExisting_tsms',
+                'testTargetMarket'
+            );
+            assert.deepEqual(
+                await testUtils.getActualDeployJson('testExisting_tsms', 'transactionalSMS'),
+                await testUtils.getExpectedJson('9999999', 'transactionalSMS', 'build'),
+                'returned deployment JSON was not equal expected'
+            );
+            expect(
+                file(testUtils.getActualDeployFile('testExisting_tsms', 'transactionalSMS', 'amp'))
+            ).to.equal(
+                file(testUtils.getExpectedFile('9999999', 'transactionalSMS', 'build', 'amp'))
+            );
+            assert.equal(
+                Object.values(testUtils.getAPIHistory()).flat().length,
+                4,
+                'Unexpected number of requests made'
+            );
+            return;
+        });
+    });
+});

package/test/utils.js

@@ -19,8 +19,18 @@ const resourceFactory = require('./resourceFactory');
  * @param {string} type of metadata
  * @returns {Promise.<string>} file in string form
  */
-exports.getActualFile = (customerKey, type) =>
+exports.getActualJson = (customerKey, type) =>
     File.readJSON(`./retrieve/testInstance/testBU/${type}/${customerKey}.${type}-meta.json`);
+/**
+ * gets file from Retrieve folder
+ *
+ * @param {string} customerKey of metadata
+ * @param {string} type of metadata
+ * @param {string} ext file extension
+ * @returns {Promise.<string>} file in string form
+ */
+exports.getActualFile = (customerKey, type, ext) =>
+    `./retrieve/testInstance/testBU/${type}/${customerKey}.${type}-meta.${ext}`;
 /**
  * gets file from Deploy folder
  *
@@ -28,8 +38,18 @@ exports.getActualFile = (customerKey, type) =>
  * @param {string} type of metadata
  * @returns {Promise.<string>} file in string form
  */
-exports.getActualDeployFile = (customerKey, type) =>
+exports.getActualDeployJson = (customerKey, type) =>
     File.readJSON(`./deploy/testInstance/testBU/${type}/${customerKey}.${type}-meta.json`);
+/**
+ * gets file from Deploy folder
+ *
+ * @param {string} customerKey of metadata
+ * @param {string} type of metadata
+ * @param {string} ext file extension
+ * @returns {Promise.<string>} file in string form
+ */
+exports.getActualDeployFile = (customerKey, type, ext) =>
+    `./deploy/testInstance/testBU/${type}/${customerKey}.${type}-meta.${ext}`;
 /**
  * gets file from Template folder
  *
@@ -37,8 +57,18 @@ exports.getActualDeployFile = (customerKey, type) =>
  * @param {string} type of metadata
  * @returns {Promise.<string>} file in string form
  */
-exports.getActualTemplate = (customerKey, type) =>
+exports.getActualTemplateJson = (customerKey, type) =>
     File.readJSON(`./template/${type}/${customerKey}.${type}-meta.json`);
+/**
+ * gets file from Template folder
+ *
+ * @param {string} customerKey of metadata
+ * @param {string} type of metadata
+ * @param {string} ext file extension
+ * @returns {Promise.<string>} file in string form
+ */
+exports.getActualTemplateFile = (customerKey, type, ext) =>
+    `./template/${type}/${customerKey}.${type}-meta.${ext}`;
 
 /**
  * gets file from resources folder which should be used for comparison
@@ -48,14 +78,27 @@ exports.getActualTemplate = (customerKey, type) =>
  * @param {string} action of SOAP request
  * @returns {Promise.<string>} file in string form
  */
-exports.getExpectedFile = (mid, type, action) =>
+exports.getExpectedJson = (mid, type, action) =>
     File.readJSON(path.join('test', 'resources', mid, type, action + '-expected.json'));
+/**
+ * gets file from resources folder which should be used for comparison
+ *
+ * @param {number} mid of Business Unit
+ * @param {string} type of metadata
+ * @param {string} action of SOAP request
+ * @param {string} ext file extension
+ * @returns {Promise.<string>} file in string form
+ */
+exports.getExpectedFile = (mid, type, action, ext) =>
+    path.join('test', 'resources', mid, type, action + '-expected.' + ext);
 /**
  * setup mocks for API and FS
  *
+ * @param {boolean} [isDeploy] if true, will mock deploy folder
  * @returns {void}
  */
-exports.mockSetup = () => {
+
+exports.mockSetup = (isDeploy) => {
     Util.setLoggingLevel({ debug: true });
     apimock = new MockAdapter(axios, { onNoMatch: 'throwException' });
     // set access_token to mid to allow for autorouting of mock to correct resources
@@ -69,17 +112,22 @@ exports.mockSetup = () => {
     apimock
         .onAny(new RegExp(`^${escapeRegExp(resourceFactory.restUrl)}`))
         .reply((config) => resourceFactory.handleRESTRequest(config));
-    fsmock({
+    const fsMockConf = {
         '.prettierrc': fsmock.load(path.resolve(__dirname, '../boilerplate/files/.prettierrc')),
         '.mcdevrc.json': fsmock.load(path.resolve(__dirname, 'mockRoot/.mcdevrc.json')),
         '.mcdev-auth.json': fsmock.load(path.resolve(__dirname, 'mockRoot/.mcdev-auth.json')),
         'boilerplate/config.json': fsmock.load(
             path.resolve(__dirname, '../boilerplate/config.json')
         ),
-        deploy: fsmock.load(path.resolve(__dirname, 'mockRoot/deploy')),
         test: fsmock.load(path.resolve(__dirname)),
-    });
+    };
+    if (isDeploy) {
+        // load files we manually prepared for a direct test of `deploy` command
+        fsMockConf.deploy = fsmock.load(path.resolve(__dirname, 'mockRoot/deploy'));
+    }
+    fsmock(fsMockConf);
 };
+
 /**
  * resets mocks for API and FS
  *
@@ -87,6 +135,7 @@ exports.mockSetup = () => {
  */
 exports.mockReset = () => {
     auth.clearSessions();
+    fsmock.restore();
     apimock.restore();
 };
 /**