mcdev 5.1.0 → 5.3.0

package/test/type.verification.test.js

@@ -0,0 +1,173 @@
+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: verification', () => {
+    beforeEach(() => {
+        testUtils.mockSetup();
+    });
+    afterEach(() => {
+        testUtils.mockReset();
+    });
+
+    describe('Retrieve ================', () => {
+        it('Should retrieve a verification', async () => {
+            // WHEN
+            const retrieved = await handler.retrieve('testInstance/testBU', ['verification']);
+            // THEN
+            assert.equal(process.exitCode, false, 'retrieve should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.verification ? Object.keys(result.verification).length : 0,
+                1,
+                'only one verification expected'
+            );
+            assert.equal(
+                retrieved['testInstance/testBU']?.verification
+                    ? Object.keys(retrieved['testInstance/testBU']?.verification).length
+                    : 0,
+                1,
+                'one verifications to be retrieved'
+            );
+
+            assert.deepEqual(
+                await testUtils.getActualJson(
+                    'testExisting_39f6a488-20eb-4ba0-b0b9',
+                    'verification'
+                ),
+                await testUtils.getExpectedJson('9999999', 'verification', 'get'),
+                'returned JSON was not equal expected'
+            );
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                9,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            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');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.verification ? Object.keys(result.verification).length : 0,
+                2,
+                'two verifications expected'
+            );
+            assert.equal(
+                deployed['testInstance/testBU']?.verification
+                    ? Object.keys(deployed['testInstance/testBU']?.verification).length
+                    : 0,
+                2,
+                'two verifications to be deployed'
+            );
+            // confirm created item
+            assert.deepEqual(
+                await testUtils.getActualJson('testNew_RANDOM_NEW_GUID', 'verification'),
+                await testUtils.getExpectedJson('9999999', 'verification', 'post'),
+                'returned new-JSON was not equal expected for insert verification'
+            );
+            // confirm updated item
+            assert.deepEqual(
+                await testUtils.getActualJson(
+                    'testExisting_39f6a488-20eb-4ba0-b0b9',
+                    'verification'
+                ),
+                await testUtils.getExpectedJson('9999999', 'verification', 'patch'),
+                'returned existing-JSON was not equal expected for update verification'
+            );
+            // check number of API calls
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                11,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
+    describe('Templating ================', () => {
+        it('Should create a verification template via buildTemplate and build it', async () => {
+            // download first before we test buildTemplate
+            await handler.retrieve('testInstance/testBU', ['verification']);
+            // buildTemplate
+            const result = await handler.buildTemplate(
+                'testInstance/testBU',
+                'verification',
+                ['testExisting_39f6a488-20eb-4ba0-b0b9'],
+                'testSourceMarket'
+            );
+            assert.equal(process.exitCode, false, 'buildTemplate should not have thrown an error');
+            assert.equal(
+                result.verification ? Object.keys(result.verification).length : 0,
+                1,
+                'only one verification expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualTemplateJson(
+                    'testExisting_39f6a488-20eb-4ba0-b0b9',
+                    'verification'
+                ),
+                await testUtils.getExpectedJson('9999999', 'verification', 'template'),
+                'returned template JSON was not equal expected'
+            );
+            // buildDefinition
+            await handler.buildDefinition(
+                'testInstance/testBU',
+                'verification',
+                'testExisting_39f6a488-20eb-4ba0-b0b9',
+                'testTargetMarket'
+            );
+            assert.equal(
+                process.exitCode,
+                false,
+                'buildDefinition should not have thrown an error'
+            );
+            assert.deepEqual(
+                await testUtils.getActualDeployJson(
+                    'testTemplated_39f6a488-20eb-4ba0-b0b9',
+                    'verification'
+                ),
+                await testUtils.getExpectedJson('9999999', 'verification', 'build'),
+                'returned deployment JSON was not equal expected'
+            );
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                9,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
+    describe('Delete ================', () => {
+        it('Should delete the item', async () => {
+            // WHEN
+            const isDeleted = await handler.deleteByKey(
+                'testInstance/testBU',
+                'verification',
+                'testExisting_39f6a488-20eb-4ba0-b0b9'
+            );
+            // THEN
+            assert.equal(
+                process.exitCode,
+                0,
+                'deleteByKey should have thrown an error due to lack of support'
+            );
+            assert.equal(isDeleted, true, 'deleteByKey should have returned true for success');
+            return;
+        });
+    });
+});

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) => {
@@ -205,7 +208,13 @@ exports.getAPIHistory = () => apimock.history;
 function getAPIHistoryDebug() {
     const historyArr = Object.values(apimock.history)
         .flat()
-        .map((item) => ({ url: item.url, data: item.data }));
+        .map((item) => {
+            const log = { method: item.method, url: item.url };
+            if (item.data) {
+                log.body = item.data;
+            }
+            return log;
+        });
     return historyArr;
 }
 exports.getAPIHistoryDebug = getAPIHistoryDebug;

package/types/mcdev.d.js

@@ -251,6 +251,20 @@ const SDK = require('sfmc-sdk');
  * @property {string} r__folder_Path folder path
  * @property {string} [categoryId] holds folder ID, replaced with r__folder_Path during retrieve
  */
+/**
+ * @typedef {object} VerificationItem
+ * @property {string} dataVerificationDefinitionId ID / Key
+ * @property {'IsEqualTo'|'IsLessThan'|'IsGreaterThan'|'IsOutsideRange'|'IsInsideRange'|'IsNotEqualTo'|'IsNotLessThan'|'IsNotGreaterThan'|'IsNotOutsideRange'|'IsNotInsideRange'} verificationType key
+ * @property {number} value1 used for all verificationTypes; lower value for IsOutsideRange, IsInsideRange, IsNotOutsideRange, IsNotInsideRange
+ * @property {number} value2 only used for IsOutsideRange, IsInsideRange, IsNotOutsideRange, IsNotInsideRange; otherwise set to 0
+ * @property {boolean} shouldStopOnFailure flag to stop automation if verification fails
+ * @property {boolean} shouldEmailOnFailure flag to send email if verification fails
+ * @property {string} notificationEmailAddress email address to send notification to; empty string if shouldEmailOnFailure=false
+ * @property {string} notificationEmailMessage email message to send; empty string if shouldEmailOnFailure=false
+ * @property {number} createdBy user id of creator
+ * @property {string} r__dataExtension_CustomerKey key of target data extension
+ */
+
 /**
  * @typedef {Object.<string, AutomationItem>} AutomationMap
  * @typedef {{metadata:AutomationMap,type:string}} AutomationMapObj

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;