mcdev 4.1.11 → 4.2.0

package/lib/util/cli.js

@@ -37,10 +37,7 @@ const Cli = {
      */
     async addExtraCredential(properties) {
         const skipInteraction = Util.skipInteraction;
-        if (!(await config.checkProperties(properties))) {
-            // return null here to avoid seeing 2 error messages for the same issue
-            return null;
-        } else {
+        if (await config.checkProperties(properties)) {
             this.logExistingCredentials(properties);
             Util.logger.info('\nPlease enter your new credentials');
             if (skipInteraction && properties.credentials[skipInteraction.credentialName]) {
@@ -50,6 +47,9 @@ const Cli = {
                 return null;
             }
             return this._setCredential(properties, null);
+        } else {
+            // return null here to avoid seeing 2 error messages for the same issue
+            return null;
         }
     },
     /**
@@ -357,11 +357,11 @@ const Cli = {
                 validate: (value) => {
                     if (!value || value.trim().length < 10) {
                         return 'Please enter a valid tenant identifier';
-                    } else if (!tenantRegex.test(value.trim())) {
-                        return `Please copy the URI directly from the installed package's "API Integration" section. It looks like this: https://a1b2b3xy56z.auth.marketingcloudapis.com/`;
-                    } else {
+                    } else if (tenantRegex.test(value.trim())) {
                         // all good
                         return true;
+                    } else {
+                        return `Please copy the URI directly from the installed package's "API Integration" section. It looks like this: https://a1b2b3xy56z.auth.marketingcloudapis.com/`;
                     }
                 },
             },
@@ -393,15 +393,19 @@ const Cli = {
      */
     async selectTypes(properties, setTypesArr) {
         let responses;
-        if (!setTypesArr) {
-            if (Util.logger.level !== 'debug') {
-                Util.logger.info(
-                    'Run mcdev selectTypes --debug if you need to use "disabled" types.'
-                );
-            } else {
+        if (setTypesArr) {
+            responses = {
+                selectedTypes: setTypesArr,
+            };
+        } else {
+            if (Util.logger.level === 'debug') {
                 Util.logger.warn(
                     'Debug mode enabled. Allowing selection of "disabled" types. Please be aware that these might be unstable.'
                 );
+            } else {
+                Util.logger.info(
+                    'Run mcdev selectTypes --debug if you need to use "disabled" types.'
+                );
             }
             const flattenedDefinitions = [];
             for (const el in MetadataDefinitions) {
@@ -436,9 +440,8 @@ const Cli = {
                         ? ' \x1B[1;30;40m(non-default)\u001B[0m'
                         : ''),
                 value: def.type,
-                disabled: !(Util.logger.level === 'debug' || def.typeRetrieveByDefault)
-                    ? 'disabled'
-                    : false,
+                disabled:
+                    Util.logger.level === 'debug' || def.typeRetrieveByDefault ? false : 'disabled',
                 // subtypes can be activated through their main type
                 checked:
                     properties.metaDataTypes.retrieve.includes(def.type) ||
@@ -475,10 +478,6 @@ const Cli = {
                     choices: typeChoices,
                 },
             ]);
-        } else {
-            responses = {
-                selectedTypes: setTypesArr,
-            };
         }
 
         if (responses.selectedTypes) {

package/lib/util/config.js

@@ -128,17 +128,9 @@ const config = {
         const missingFields = [];
         for (const key in defaultProps) {
             if (Object.prototype.hasOwnProperty.call(defaultProps, key)) {
-                if (!Object.prototype.hasOwnProperty.call(properties, key)) {
-                    errorMsgs.push(`${key}{} missing`);
-                    solutionSet.add(
-                        `Run 'mcdev upgrade' to fix missing or changed configuration options`
-                    );
-                    missingFields.push(key);
-                } else {
+                if (Object.prototype.hasOwnProperty.call(properties, key)) {
                     if (!silent && key === 'credentials') {
-                        if (!Object.keys(properties.credentials)) {
-                            errorMsgs.push(`no Credential defined`);
-                        } else {
+                        if (Object.keys(properties.credentials)) {
                             for (const cred in properties.credentials) {
                                 if (cred.includes('/') || cred.includes('\\')) {
                                     errorMsgs.push(
@@ -176,6 +168,8 @@ const config = {
                                     solutionSet.add(`Run 'mcdev reloadBUs ${cred}'`);
                                 }
                             }
+                        } else {
+                            errorMsgs.push(`no Credential defined`);
                         }
                     } else if (['directories', 'metaDataTypes', 'options'].includes(key)) {
                         for (const subkey in defaultProps[key]) {
@@ -222,6 +216,12 @@ const config = {
                             }
                         }
                     }
+                } else {
+                    errorMsgs.push(`${key}{} missing`);
+                    solutionSet.add(
+                        `Run 'mcdev upgrade' to fix missing or changed configuration options`
+                    );
+                    missingFields.push(key);
                 }
             }
         }

package/lib/util/devops.js

@@ -113,13 +113,13 @@ const DevOps = {
             .filter((file) => filterPaths.some((path) => file.file.startsWith(path)))
             // ensure badly named files on unsupported metadata types are not in our subset
             .filter((/** @type {TYPE.DeltaPkgItem} */ file) => {
-                if (!MetadataType[file.type]) {
+                if (MetadataType[file.type]) {
+                    return true;
+                } else {
                     Util.logger.debug(
                         `Unknown metadata-type found for (${file.file}): ` + file.type
                     );
                     return false;
-                } else {
-                    return true;
                 }
             })
             .map((/** @type {TYPE.DeltaPkgItem} */ file) => {
@@ -182,7 +182,7 @@ const DevOps = {
         ) {
             Util.logger.warn(
                 `- ❌  No changes found. Check what branch you are currently on and if the target branch name (${rangeUserInput}${
-                    range !== rangeUserInput ? ' converted to ' + range : ''
+                    range === rangeUserInput ? '' : ' converted to ' + range
                 }) was correct`
             );
             return [];

package/lib/util/init.config.js

@@ -78,10 +78,10 @@ const Init = {
                         break;
                     }
                     case 'metaDataTypes.documentOnRetrieve': {
-                        if (!properties.options.documentOnRetrieve) {
-                            properties.metaDataTypes.documentOnRetrieve = [];
-                        } else {
+                        if (properties.options.documentOnRetrieve) {
                             this._updateLeaf(properties, defaultProps, fieldName);
+                        } else {
+                            properties.metaDataTypes.documentOnRetrieve = [];
                         }
                         delete properties.options.documentOnRetrieve;
                         upgradeMsgs.push(
@@ -217,10 +217,7 @@ const Init = {
             Util.boilerplateDirectory,
             'gitignore-template'
         );
-        if (!(await File.pathExists(gitignoreFileName))) {
-            Util.logger.debug(`Dependency file not found in ${gitignoreFileName}`);
-            return false;
-        } else {
+        if (await File.pathExists(gitignoreFileName)) {
             const fileContent = await File.readFile(gitignoreFileName, 'utf8');
             creationLog.push(
                 await this._createIdeConfigFile(
@@ -229,6 +226,9 @@ const Init = {
                     fileContent
                 )
             );
+        } else {
+            Util.logger.debug(`Dependency file not found in ${gitignoreFileName}`);
+            return false;
         }
 
         // load file list from boilerplate dir and initiate copy process

package/lib/util/init.git.js

@@ -110,7 +110,7 @@ const Init = {
                         },
                     ]);
                 }
-                if (skipInteraction.gitPush === 'true' || responses?.gitPush) {
+                if (skipInteraction?.gitPush === 'true' || responses?.gitPush) {
                     Util.execSync('git', ['push', '-u', 'origin', 'master']);
                 }
             } else if (remoteBranchesExist === true) {
@@ -156,21 +156,22 @@ const Init = {
                                 return 'Please enter a valid remote URL';
                             } else if (!value.startsWith('http') && !value.startsWith('ssh')) {
                                 return `Your Git Remote URL should start with 'http' or 'ssh'`;
-                            } else if (!value.endsWith('.git')) {
-                                return `Your Git Remote URL should end with '.git'`;
-                            } else {
+                            } else if (value.endsWith('.git')) {
                                 // all good
                                 return true;
+                            } else {
+                                return `Your Git Remote URL should end with '.git'`;
                             }
                         },
                     },
                 ]);
             }
             /* eslint-enable unicorn/prefer-ternary */
-
-            responses.gitRemoteUrl = responses.gitRemoteUrl.trim();
-            Util.execSync('git', ['remote', 'add', 'origin', responses.gitRemoteUrl]);
-            return responses.gitRemoteUrl.split('/').pop().split('.')[0];
+            if (typeof responses.gitRemoteUrl === 'string') {
+                responses.gitRemoteUrl = responses.gitRemoteUrl.trim();
+                Util.execSync('git', ['remote', 'add', 'origin', responses.gitRemoteUrl]);
+                return responses.gitRemoteUrl.split('/').pop().split('.')[0];
+            }
         }
     },
     /**
@@ -251,23 +252,10 @@ const Init = {
      * @returns {Promise.<{'user.name': string, 'user.email': string}>} user.name and user.email
      */
     async _getGitConfigUser() {
-        const gitConfigs = await git.listConfig();
-        // remove local config
-        delete gitConfigs.values['.git/config'];
-        const result = {};
+        const names = await git.getConfig('user.name');
+        const emails = await git.getConfig('user.email');
 
-        for (const file of Object.keys(gitConfigs.values)) {
-            if (gitConfigs.values[file]['user.name']) {
-                result['user.name'] = gitConfigs.values[file]['user.name'];
-            }
-            if (gitConfigs.values[file]['user.email']) {
-                result['user.email'] = gitConfigs.values[file]['user.email'];
-            }
-        }
-        if (!result['user.name'] || !result['user.email']) {
-            return null;
-        }
-        return result;
+        return { 'user.name': names.value || '', 'user.email': emails.value || '' };
     },
 };
 

package/lib/util/init.js

@@ -161,6 +161,9 @@ const Init = {
                 return;
             }
 
+            // set up markets and market lists initially
+            await Init._initMarkets();
+
             // create first commit to backup the project configuration
             if (initGit.status === 'init') {
                 Util.logger.info(`Committing initial setup to Git:`);
@@ -182,6 +185,67 @@ const Init = {
             );
         }
     },
+
+    /**
+     * helper for @initProject that optionally creates markets and market lists for all BUs
+     */
+    async _initMarkets() {
+        const skipInteraction = Util.skipInteraction;
+        const properties = await config.getProperties(true);
+
+        // get list of business units
+        const firstCredentialName = Object.keys(properties.credentials)[0];
+        const businessUnits = Object.keys(
+            properties.credentials[firstCredentialName].businessUnits
+        );
+
+        // set up empty markets for them
+        const markets = {};
+        for (const bu of businessUnits) {
+            markets[bu] = { suffix: '_' + bu };
+        }
+        properties.markets = markets;
+
+        let sourceBuName;
+        // set up default deployment market lists
+        if (skipInteraction) {
+            // don't ask, list all BUs in deployment-target and set deployment-source to ???
+            if (!businessUnits.includes(skipInteraction.developmentBu)) {
+                Util.logger.warn(
+                    `Could not find developmentBu=${skipInteraction.developmentBu} in business units. Skipping.`
+                );
+                delete skipInteraction.developmentBu;
+            }
+            sourceBuName = skipInteraction.developmentBu || '???';
+            if (!skipInteraction.developmentBu) {
+                Util.logger.info(
+                    'Market List "deployment-source" will need to be set up manually. Marking all BUs as target BUs in "deployment-target".'
+                );
+            }
+        } else {
+            const responses = await inquirer.prompt([
+                {
+                    type: 'list',
+                    name: 'developmentBu',
+                    message: 'Please select your development business unit:',
+                    choices: businessUnits.map((bu) => ({ name: bu, value: bu })),
+                },
+            ]);
+            sourceBuName = responses.developmentBu;
+        }
+        // set source list
+        properties.marketList['deployment-source'][firstCredentialName + '/' + sourceBuName] =
+            sourceBuName;
+
+        // set target list
+        for (const bu of businessUnits) {
+            // filter out source BU & parent BU to ensure they dont get deployed to automatically
+            if (bu !== sourceBuName && bu !== '_ParentBU_') {
+                properties.marketList['deployment-target'][firstCredentialName + '/' + bu] = bu;
+            }
+        }
+        await File.saveConfigFile(properties);
+    },
     /**
      * helper for {@link Init.initProject}
      *
@@ -202,7 +266,7 @@ const Init = {
                 },
             ]);
         }
-        if (skipInteraction.downloadBUs === 'true' || responses?.initialRetrieveAll) {
+        if (skipInteraction?.downloadBUs === 'true' || responses?.initialRetrieveAll) {
             Util.execSync('mcdev', ['retrieve', bu]);
 
             if (gitStatus === 'init') {

package/lib/util/util.js

@@ -87,10 +87,7 @@ const Util = {
      * @returns {void} throws errors if problems were found
      */
     verifyMarketList(mlName, properties) {
-        if (!properties.marketList[mlName]) {
-            // ML does not exist
-            throw new Error(`Market List ${mlName} is not defined`);
-        } else {
+        if (properties.marketList[mlName]) {
             // ML exists, check if it is properly set up
 
             // check if BUs in marketList are valid
@@ -111,10 +108,10 @@ const Util = {
                         marketArr = [marketArr];
                     }
                     for (const market of marketArr) {
-                        if (!properties.markets[market]) {
-                            throw new Error(`Market '${market}' is not defined.`);
-                        } else {
+                        if (properties.markets[market]) {
                             // * markets can be empty or include variables. Nothing we can test here
+                        } else {
+                            throw new Error(`Market '${market}' is not defined.`);
                         }
                     }
                 }
@@ -122,6 +119,9 @@ const Util = {
             if (!buCounter) {
                 throw new Error(`No BUs defined in marketList ${mlName}`);
             }
+        } else {
+            // ML does not exist
+            throw new Error(`Market List ${mlName} is not defined`);
         }
     },
     /**
@@ -130,6 +130,7 @@ const Util = {
      * @returns {void}
      */
     signalFatalError() {
+        Util.logger.debug('Util.signalFataError() sets process.exitCode = 1');
         process.exitCode = 1;
     },
     /**
@@ -354,16 +355,24 @@ const Util = {
      * @param {string} cmd to be executed command
      * @param {string[]} [args] list of arguments
      * @param {boolean} [hideOutput] if true, output of command will be hidden from CLI
-     * @returns {undefined}
+     * @returns {string} output of command if hideOutput is true
      */
     execSync(cmd, args, hideOutput) {
         args = args || [];
         Util.logger.info('⚡ ' + cmd + ' ' + args.join(' '));
 
-        // the following options ensure the user sees the same output and
-        // interaction options as if the command was manually run
-        const options = hideOutput ? {} : { stdio: [0, 1, 2] };
-        return child_process.execSync(cmd + ' ' + args.join(' '), options);
+        if (hideOutput) {
+            // no output displayed to user but instead returned to parsed elsewhere
+            return child_process
+                .execSync(cmd + ' ' + args.join(' '))
+                .toString()
+                .trim();
+        } else {
+            // the following options ensure the user sees the same output and
+            // interaction options as if the command was manually run
+            child_process.execSync(cmd + ' ' + args.join(' '), { stdio: [0, 1, 2] });
+            return null;
+        }
     },
     /**
      * standardize check to ensure only one result is returned from template search
@@ -497,7 +506,10 @@ function startLogger() {
          */
         errorStack: function (ex, message) {
             if (message) {
-                myWinston.error(message + ': ' + ex.message);
+                // ! this method only sets exitCode=1 if message-param was set
+                // if not, then this method purely outputs debug information and should not change the exitCode
+                winstonError(message + ': ' + ex.message);
+                Util.signalFatalError();
             }
             let stack;
             /* eslint-disable unicorn/prefer-ternary */
@@ -513,7 +525,6 @@ function startLogger() {
             }
             /* eslint-enable unicorn/prefer-ternary */
             myWinston.debug(stack);
-            Util.signalFatalError();
         },
         /**
          * errors should cause surrounding applications to take notice

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mcdev",
-    "version": "4.1.11",
+    "version": "4.2.0",
     "description": "Accenture Salesforce Marketing Cloud DevTools",
     "author": "Accenture: joern.berkefeld, douglas.midgley, robert.zimmermann, maciej.barnas",
     "license": "MIT",
@@ -37,24 +37,29 @@
         "lint-test": "eslint test/**/*.js",
         "upgrade": "npm-check --update",
         "manual-prepare": "husky install",
-        "test": "mocha"
+        "test": "mocha",
+        "coverage": "nyc mocha",
+        "version:major": "npm version --no-commit-hooks major",
+        "version:minor": "npm version --no-commit-hooks minor",
+        "version:patch": "npm version --no-commit-hooks patch"
     },
     "dependencies": {
+        "beauty-amp-core": "0.3.7",
         "cli-progress": "3.11.2",
         "command-exists": "1.2.9",
         "conf": "10.2.0",
         "console.table": "0.10.0",
-        "deep-equal": "2.0.5",
-        "fs-extra": "10.1.0",
+        "deep-equal": "2.1.0",
+        "fs-extra": "11.1.0",
         "inquirer": "8.2.2",
         "json-to-table": "4.2.1",
         "mustache": "4.2.0",
         "p-limit": "3.1.0",
-        "prettier": "2.7.1",
+        "prettier": "2.8.0",
         "prettier-plugin-sql": "0.12.1",
         "semver": "7.3.8",
         "sfmc-sdk": "0.6.1",
-        "simple-git": "3.14.1",
+        "simple-git": "3.15.1",
         "toposort": "2.0.2",
         "update-notifier": "5.1.0",
         "winston": "3.8.2",
@@ -63,21 +68,23 @@
     "devDependencies": {
         "assert": "2.0.0",
         "axios-mock-adapter": "1.21.2",
-        "chai": "4.3.6",
-        "eslint": "8.27.0",
+        "chai": "4.3.7",
+        "chai-files": "1.4.0",
+        "eslint": "8.29.0",
         "eslint-config-prettier": "8.5.0",
         "eslint-config-ssjs": "1.1.11",
-        "eslint-plugin-jsdoc": "39.6.2",
+        "eslint-plugin-jsdoc": "39.6.4",
         "eslint-plugin-mocha": "10.1.0",
         "eslint-plugin-prettier": "4.2.1",
-        "eslint-plugin-unicorn": "44.0.2",
+        "eslint-plugin-unicorn": "45.0.1",
         "husky": "8.0.1",
-        "jsdoc-to-markdown": "7.1.1",
-        "lint-staged": "13.0.3",
+        "jsdoc-to-markdown": "8.0.0",
+        "lint-staged": "13.1.0",
         "mocha": "10.1.0",
         "mock-fs": "5.2.0",
         "npm-check": "6.0.1",
         "npm-run-all": "4.1.5",
+        "nyc": "15.1.0",
         "prettier-eslint": "15.0.1"
     },
     "optionalDependencies": {

package/test/dataExtension.test.js

@@ -23,8 +23,8 @@ describe('dataExtension', () => {
                 'only one dataExtension expected'
             );
             assert.deepEqual(
-                await testUtils.getActualFile('childBU_dataextension_test', 'dataExtension'),
-                await testUtils.getExpectedFile('9999999', 'dataExtension', 'retrieve'),
+                await testUtils.getActualJson('childBU_dataextension_test', 'dataExtension'),
+                await testUtils.getExpectedJson('9999999', 'dataExtension', 'retrieve'),
 
                 'returned metadata was not equal expected'
             );
@@ -37,6 +37,9 @@ describe('dataExtension', () => {
         });
     });
     describe('Deploy ================', () => {
+        beforeEach(() => {
+            testUtils.mockSetup(true);
+        });
         it('Should create & upsert a data extension', async () => {
             // WHEN
             await handler.deploy('testInstance/testBU', ['dataExtension']);
@@ -49,19 +52,21 @@ describe('dataExtension', () => {
                 2,
                 'two data extensions expected'
             );
+            // insert
             assert.deepEqual(
-                await testUtils.getActualFile('testDataExtension', 'dataExtension'),
-                await testUtils.getExpectedFile('9999999', 'dataExtension', 'create'),
+                await testUtils.getActualJson('testDataExtension', 'dataExtension'),
+                await testUtils.getExpectedJson('9999999', 'dataExtension', 'create'),
                 'returned metadata was not equal expected for create'
             );
+            // update
             assert.deepEqual(
-                await testUtils.getActualFile('childBU_dataextension_test', 'dataExtension'),
-                await testUtils.getExpectedFile('9999999', 'dataExtension', 'update'),
+                await testUtils.getActualJson('childBU_dataextension_test', 'dataExtension'),
+                await testUtils.getExpectedJson('9999999', 'dataExtension', 'update'),
                 'returned metadata was not equal expected for update'
             );
             assert.equal(
                 Object.values(testUtils.getAPIHistory()).flat().length,
-                11,
+                12,
                 'Unexpected number of requests made'
             );
             return;
@@ -74,7 +79,7 @@ describe('dataExtension', () => {
                 'testInstance/testBU',
                 'dataExtension',
                 ['childBU_dataextension_test'],
-                'testMarket'
+                'testSourceMarket'
             );
 
             // WHEN
@@ -84,8 +89,11 @@ describe('dataExtension', () => {
                 'only one dataExtension expected'
             );
             assert.deepEqual(
-                await testUtils.getActualTemplate('childBU_dataextension_test', 'dataExtension'),
-                await testUtils.getExpectedFile('9999999', 'dataExtension', 'template'),
+                await testUtils.getActualTemplateJson(
+                    'childBU_dataextension_test',
+                    'dataExtension'
+                ),
+                await testUtils.getExpectedJson('9999999', 'dataExtension', 'template'),
                 'returned template was not equal expected'
             );
             // THEN
@@ -93,11 +101,14 @@ describe('dataExtension', () => {
                 'testInstance/testBU',
                 'dataExtension',
                 'childBU_dataextension_test',
-                'testMarket'
+                'testTargetMarket'
             );
             assert.deepEqual(
-                await testUtils.getActualDeployFile('childBU_dataextension_test', 'dataExtension'),
-                await testUtils.getExpectedFile('9999999', 'dataExtension', 'build'),
+                await testUtils.getActualDeployJson(
+                    'childBU_dataextension_testTarget',
+                    'dataExtension'
+                ),
+                await testUtils.getExpectedJson('9999999', 'dataExtension', 'build'),
                 'returned deployment file was not equal expected'
             );
             assert.equal(
@@ -115,7 +126,7 @@ describe('dataExtension', () => {
                 'testInstance/testBU',
                 'dataExtension',
                 ['childBU_dataextension_test'],
-                'testMarket'
+                'testSourceMarket'
             );
             // WHEN
             assert.equal(
@@ -124,8 +135,11 @@ describe('dataExtension', () => {
                 'only one dataExtension expected'
             );
             assert.deepEqual(
-                await testUtils.getActualTemplate('childBU_dataextension_test', 'dataExtension'),
-                await testUtils.getExpectedFile('9999999', 'dataExtension', 'template'),
+                await testUtils.getActualTemplateJson(
+                    'childBU_dataextension_test',
+                    'dataExtension'
+                ),
+                await testUtils.getExpectedJson('9999999', 'dataExtension', 'template'),
                 'returned template was not equal expected'
             );
             // THEN
@@ -133,12 +147,15 @@ describe('dataExtension', () => {
                 'testInstance/testBU',
                 'dataExtension',
                 'childBU_dataextension_test',
-                'testMarket'
+                'testTargetMarket'
             );
 
             assert.deepEqual(
-                await testUtils.getActualDeployFile('childBU_dataextension_test', 'dataExtension'),
-                await testUtils.getExpectedFile('9999999', 'dataExtension', 'build'),
+                await testUtils.getActualDeployJson(
+                    'childBU_dataextension_testTarget',
+                    'dataExtension'
+                ),
+                await testUtils.getExpectedJson('9999999', 'dataExtension', 'build'),
                 'returned deployment file was not equal expected'
             );
             assert.equal(