mcdev 3.1.3 → 4.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mcdev",
-    "version": "3.1.3",
+    "version": "4.0.0",
     "description": "Accenture Salesforce Marketing Cloud DevTools",
     "author": "joern.berkefeld, douglas.midgley, robert.zimmermann, maciej.barnas",
     "license": "MIT",
@@ -25,53 +25,64 @@
         "node": ">=14.16"
     },
     "scripts": {
-        "start": "node lib/index.js",
-        "mcdev": "node lib/index.js",
-        "build": "run-s lint docs",
-        "debug": "node --nolazy --inspect-brk=9229 lib/index.js",
-        "docs": "jsdoc2md --files lib/**/*.js > docs/dist/documentation.md",
-        "lint": "eslint --fix lib/**/*.js && eslint --fix test/**/*.js && prettier --write lib/**/*.js",
-        "test": "mocha --recursive",
+        "start": "node lib/cli.js",
+        "mcdev": "node lib/cli.js",
+        "build": "run-s lint:fix docs test",
+        "debug": "node --nolazy --inspect-brk=9229 lib/cli.js",
+        "docs": "jsdoc2md --files lib/**/*.js types/**/*.js > docs/dist/documentation.md",
+        "lint:fix": "eslint --fix lib/**/*.js && eslint --fix types/*.js && eslint --fix test/**/*.js",
+        "lint": "run-p -c lint-type lint-lib lint-test",
+        "lint-lib": "eslint lib/**/*.js",
+        "lint-type": "eslint types/*.js",
+        "lint-test": "eslint test/**/*.js",
         "upgrade": "npm-check --update",
-        "prepare": "husky install"
+        "prepare": "husky install",
+        "test": "mocha"
     },
     "dependencies": {
-        "bluebird": "3.7.2",
-        "cli-progress": "3.10.0",
+        "cli-progress": "3.11.2",
         "command-exists": "1.2.9",
+        "conf": "10.1.2",
         "console.table": "0.10.0",
-        "fs-extra": "10.0.0",
-        "inquirer": "8.2.0",
+        "deep-equal": "2.0.5",
+        "fs-extra": "10.1.0",
+        "inquirer": "8.2.2",
         "json-to-table": "4.2.1",
         "mustache": "4.2.0",
-        "prettier": "2.5.1",
-        "semver": "7.3.5",
-        "sfmc-fuelsdk-node": "2.4.0",
-        "simple-git": "2.48.0",
-        "sql-formatter-plus": "1.3.6",
+        "p-limit": "3.1.0",
+        "prettier": "2.7.1",
+        "prettier-plugin-sql": "0.8.3",
+        "semver": "7.3.7",
+        "sfmc-sdk": "0.6.1",
+        "simple-git": "3.10.0",
         "toposort": "2.0.2",
-        "update-notifier-git": "5.0.3",
-        "winston": "3.3.4",
-        "yargs": "17.3.0"
+        "update-notifier": "5.1.0",
+        "winston": "3.8.1",
+        "yargs": "17.5.1"
     },
     "devDependencies": {
-        "chai": "4.3.4",
-        "eslint": "8.4.1",
-        "eslint-config-prettier": "8.3.0",
+        "assert": "2.0.0",
+        "axios-mock-adapter": "1.21.1",
+        "chai": "4.3.6",
+        "eslint": "8.19.0",
+        "eslint-config-prettier": "8.5.0",
         "eslint-config-ssjs": "1.1.11",
-        "eslint-plugin-mocha": "10.0.1",
-        "eslint-plugin-prettier": "4.0.0",
-        "husky": "7.0.4",
-        "jsdoc-to-markdown": "7.1.0",
-        "lint-staged": "12.1.2",
-        "mocha": "9.1.3",
+        "eslint-plugin-jsdoc": "39.3.3",
+        "eslint-plugin-mocha": "10.0.5",
+        "eslint-plugin-prettier": "4.2.1",
+        "eslint-plugin-unicorn": "43.0.0",
+        "husky": "8.0.1",
+        "jsdoc-to-markdown": "7.1.1",
+        "lint-staged": "13.0.3",
+        "mocha": "10.0.0",
+        "mock-fs": "5.1.2",
         "npm-check": "5.9.2",
-        "npm-run-all": "4.1.5"
+        "npm-run-all": "4.1.5",
+        "prettier-eslint": "15.0.1"
     },
     "lint-staged": {
         "*.{js,jsx,ts,tsx}": [
-            "eslint --fix",
-            "prettier --write"
+            "eslint --fix"
         ]
     }
 }

package/test/dataExtension.test.js

@@ -0,0 +1,152 @@
+const assert = require('chai').assert;
+const cache = require('../lib/util/cache');
+const testUtils = require('./utils');
+const handler = require('../lib/index');
+
+describe('dataExtension', () => {
+    beforeEach(() => {
+        testUtils.mockSetup();
+    });
+    afterEach(() => {
+        testUtils.mockReset();
+    });
+    describe('Retrieve ================', () => {
+        it('Should retrieve a data extension', async () => {
+            // WHEN
+            await handler.retrieve('testInstance/testBU', ['dataExtension']);
+            // THEN
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.dataExtension ? Object.keys(result.dataExtension).length : 0,
+                1,
+                'only one dataExtension expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualFile('childBU_dataextension_test', 'dataExtension'),
+                await testUtils.getExpectedFile('9999999', 'dataExtension', 'retrieve'),
+
+                'returned metadata was not equal expected'
+            );
+            assert.equal(
+                Object.values(testUtils.getAPIHistory()).flat().length,
+                6,
+                'Unexpected number of requests made'
+            );
+            return;
+        });
+    });
+    describe('Deploy ================', () => {
+        it('Should create & upsert a data extension', async () => {
+            // WHEN
+            await handler.deploy('testInstance/testBU', ['dataExtension']);
+            // THEN
+
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.dataExtension ? Object.keys(result.dataExtension).length : 0,
+                2,
+                'two data extensions expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualFile('testDataExtension', 'dataExtension'),
+                await testUtils.getExpectedFile('9999999', 'dataExtension', 'create'),
+                'returned metadata was not equal expected for create'
+            );
+            assert.deepEqual(
+                await testUtils.getActualFile('childBU_dataextension_test', 'dataExtension'),
+                await testUtils.getExpectedFile('9999999', 'dataExtension', 'update'),
+                'returned metadata was not equal expected for update'
+            );
+            assert.equal(
+                Object.values(testUtils.getAPIHistory()).flat().length,
+                11,
+                'Unexpected number of requests made'
+            );
+            return;
+        });
+    });
+    describe('Templating ================', () => {
+        it('Should create a dataExtension template via retrieveAsTemplate and build it', async () => {
+            // GIVEN there is a template
+            const result = await handler.retrieveAsTemplate(
+                'testInstance/testBU',
+                'dataExtension',
+                ['childBU_dataextension_test'],
+                'testMarket'
+            );
+
+            // WHEN
+            assert.equal(
+                result.dataExtension ? Object.keys(result.dataExtension).length : 0,
+                1,
+                'only one dataExtension expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualTemplate('childBU_dataextension_test', 'dataExtension'),
+                await testUtils.getExpectedFile('9999999', 'dataExtension', 'template'),
+                'returned template was not equal expected'
+            );
+            // THEN
+            await handler.buildDefinition(
+                'testInstance/testBU',
+                'dataExtension',
+                'childBU_dataextension_test',
+                'testMarket'
+            );
+            assert.deepEqual(
+                await testUtils.getActualDeployFile('childBU_dataextension_test', 'dataExtension'),
+                await testUtils.getExpectedFile('9999999', 'dataExtension', 'build'),
+                'returned deployment file was not equal expected'
+            );
+            assert.equal(
+                Object.values(testUtils.getAPIHistory()).flat().length,
+                5,
+                'Unexpected number of requests made'
+            );
+            return;
+        });
+        it('Should create a dataExtension template via buildTemplate and build it', async () => {
+            // download first before we test buildTemplate
+            await handler.retrieve('testInstance/testBU', ['dataExtension']);
+            // GIVEN there is a template
+            const result = await handler.buildTemplate(
+                'testInstance/testBU',
+                'dataExtension',
+                ['childBU_dataextension_test'],
+                'testMarket'
+            );
+            // WHEN
+            assert.equal(
+                result.dataExtension ? Object.keys(result.dataExtension).length : 0,
+                1,
+                'only one dataExtension expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualTemplate('childBU_dataextension_test', 'dataExtension'),
+                await testUtils.getExpectedFile('9999999', 'dataExtension', 'template'),
+                'returned template was not equal expected'
+            );
+            // THEN
+            await handler.buildDefinition(
+                'testInstance/testBU',
+                'dataExtension',
+                'childBU_dataextension_test',
+                'testMarket'
+            );
+
+            assert.deepEqual(
+                await testUtils.getActualDeployFile('childBU_dataextension_test', 'dataExtension'),
+                await testUtils.getExpectedFile('9999999', 'dataExtension', 'build'),
+                'returned deployment file was not equal expected'
+            );
+            assert.equal(
+                Object.values(testUtils.getAPIHistory()).flat().length,
+                5,
+                'Unexpected number of requests made'
+            );
+            return;
+        });
+    });
+});

package/test/mockRoot/.mcdev-auth.json

@@ -0,0 +1,8 @@
+{
+    "testInstance": {
+        "client_id": "71fzp43cyb1aksgflc159xxx",
+        "client_secret": "oDZE354QsMXzcFqKQlGgDxxx",
+        "auth_url": "https://mct0l7nxfq2r988t1kxfy8sc4xxx.auth.marketingcloudapis.com/",
+        "account_id": 1111111
+    }
+}

package/test/mockRoot/.mcdevrc.json

@@ -0,0 +1,67 @@
+{
+    "credentials": {
+        "testInstance": {
+            "eid": 1111111,
+            "businessUnits": {
+                "_ParentBU_": 1111111,
+                "testBU": 9999999
+            }
+        }
+    },
+    "options": {
+        "deployment": {
+            "commitHistory": 10,
+            "sourceTargetMapping": {
+                "deployment-source": "deployment-target"
+            },
+            "targetBranchBuMapping": {
+                "release/*": "MySandbox/QA-DE",
+                "master": ["MyProduction/PROD-DE", "MyProduction/PROD-NL"]
+            }
+        },
+        "documentType": "md",
+        "exclude": {},
+        "include": {},
+        "serverTimeOffset": -6,
+        "documentStandardRoles": false
+    },
+    "directories": {
+        "businessUnits": "businessUnits/",
+        "deploy": "deploy/",
+        "docs": "docs/",
+        "retrieve": "retrieve/",
+        "template": "template/",
+        "templateBuilds": ["retrieve/", "deploy/"]
+    },
+    "markets": {
+        "testMarket": {
+            "mid": "9999999",
+            "buName": "testBU",
+            "sharedFolder": "/Shared Data Extensions/test",
+            "suffix": "_test",
+            "countryCodeIn": "'test'"
+        }
+    },
+    "marketList": {},
+    "metaDataTypes": {
+        "documentOnRetrieve": ["accountUser", "automation", "dataExtension", "role"],
+        "retrieve": [
+            "asset",
+            "automation",
+            "dataExtension",
+            "dataExtract",
+            "emailSendDefinition",
+            "fileTransfer",
+            "ftpLocation",
+            "importFile",
+            "list",
+            "mobileCode",
+            "mobileKeyword",
+            "query",
+            "role",
+            "script",
+            "triggeredSendDefinition"
+        ]
+    },
+    "version": "4.0.0"
+}

package/test/mockRoot/deploy/testInstance/testBU/dataExtension/childBU_dataextension_test.dataExtension-meta.json

@@ -0,0 +1,39 @@
+{
+    "CustomerKey": "childBU_dataextension_test",
+    "Name": "childBU_dataextension_test",
+    "Description": "",
+    "IsSendable": false,
+    "IsTestable": false,
+    "RowBasedRetention": true,
+    "ResetRetentionPeriodOnImport": false,
+    "DeleteAtEndOfRetentionPeriod": false,
+    "RetainUntil": "",
+    "Fields": [
+        {
+            "Name": "testField",
+            "DefaultValue": "",
+            "MaxLength": 254,
+            "IsRequired": true,
+            "IsPrimaryKey": false,
+            "FieldType": "Text"
+        },
+        {
+            "Name": "LastName",
+            "DefaultValue": "",
+            "MaxLength": 55,
+            "IsRequired": true,
+            "IsPrimaryKey": false,
+            "FieldType": "Text"
+        },
+        {
+            "Name": "ContactKey",
+            "DefaultValue": "",
+            "MaxLength": 40,
+            "IsRequired": true,
+            "IsPrimaryKey": true,
+            "FieldType": "Text"
+        }
+    ],
+    "r__folder_ContentType": "dataextension",
+    "r__folder_Path": "Data Extensions"
+}

package/test/mockRoot/deploy/testInstance/testBU/dataExtension/testDataExtension.dataExtension-meta.json

@@ -0,0 +1,23 @@
+{
+    "CustomerKey": "testDataExtension",
+    "Name": "testDataExtension",
+    "Description": "",
+    "IsSendable": false,
+    "IsTestable": false,
+    "RowBasedRetention": false,
+    "ResetRetentionPeriodOnImport": false,
+    "DeleteAtEndOfRetentionPeriod": false,
+    "RetainUntil": "",
+    "Fields": [
+        {
+            "Name": "testField",
+            "DefaultValue": "",
+            "MaxLength": 254,
+            "IsRequired": true,
+            "IsPrimaryKey": false,
+            "FieldType": "Text"
+        }
+    ],
+    "r__folder_ContentType": "dataextension",
+    "r__folder_Path": "Data Extensions"
+}

package/test/mockRoot/deploy/testInstance/testBU/query/testExistingQuery.query-meta.json

@@ -0,0 +1,11 @@
+{
+    "name": "testExistingQuery",
+    "key": "testExistingQuery",
+    "description": "updated",
+    "targetKey": "childBU_dataextension_test",
+    "createdDate": "2022-04-26T15:21:16.453",
+    "modifiedDate": "2022-04-26T16:04:15.88",
+    "targetUpdateTypeName": "Overwrite",
+    "isFrozen": false,
+    "r__folder_Path": "Query"
+}

package/test/mockRoot/deploy/testInstance/testBU/query/testExistingQuery.query-meta.sql

@@ -0,0 +1,4 @@
+SELECT
+    SubscriberKey as testField
+FROM
+    _Subscribers 

package/test/mockRoot/deploy/testInstance/testBU/query/testQuery.query-meta.json

@@ -0,0 +1,11 @@
+{
+    "name": "testQuery",
+    "key": "testQuery",
+    "description": "",
+    "targetKey": "childBU_dataextension_test",
+    "createdDate": "2022-04-26T15:21:16.453",
+    "modifiedDate": "2022-04-26T16:04:15.88",
+    "targetUpdateTypeName": "Overwrite",
+    "isFrozen": false,
+    "r__folder_Path": "Query"
+}

package/test/mockRoot/deploy/testInstance/testBU/query/testQuery.query-meta.sql

@@ -0,0 +1,4 @@
+SELECT
+    SubscriberKey as testField
+FROM
+    _Subscribers 

package/test/query.test.js

@@ -0,0 +1,149 @@
+const assert = require('chai').assert;
+const cache = require('../lib/util/cache');
+const testUtils = require('./utils');
+const handler = require('../lib/index');
+
+describe('query', () => {
+    beforeEach(() => {
+        testUtils.mockSetup();
+    });
+    afterEach(() => {
+        testUtils.mockReset();
+    });
+
+    describe('Retrieve ================', () => {
+        it('Should retrieve a query', async () => {
+            // WHEN
+            await handler.retrieve('testInstance/testBU', ['query']);
+            // THEN
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.query ? Object.keys(result.query).length : 0,
+                1,
+                'only one query expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualFile('testExistingQuery', 'query'),
+                await testUtils.getExpectedFile('9999999', 'query', 'get'),
+                'returned metadata was not equal expected'
+            );
+            assert.equal(
+                Object.values(testUtils.getAPIHistory()).flat().length,
+                6,
+                'Unexpected number of requests made'
+            );
+            return;
+        });
+    });
+    describe('Deploy ================', () => {
+        it('Should create & upsert a query', async () => {
+            // WHEN
+            await handler.deploy('testInstance/testBU', ['query']);
+            // THEN
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.query ? Object.keys(result.query).length : 0,
+                2,
+                'two querys expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualFile('testQuery', 'query'),
+                await testUtils.getExpectedFile('9999999', 'query', 'post'),
+                'returned metadata was not equal expected for insert query'
+            );
+            assert.deepEqual(
+                await testUtils.getActualFile('testExistingQuery', 'query'),
+                await testUtils.getExpectedFile('9999999', 'query', 'patch'),
+                'returned metadata was not equal expected for insert query'
+            );
+            assert.equal(
+                Object.values(testUtils.getAPIHistory()).flat().length,
+                8,
+                'Unexpected number of requests made'
+            );
+            return;
+        });
+    });
+    describe('Templating ================', () => {
+        it('Should create a query template via retrieveAsTemplate and build it', async () => {
+            // GIVEN there is a template
+            const result = await handler.retrieveAsTemplate(
+                'testInstance/testBU',
+                'query',
+                ['testExistingQuery'],
+                'testMarket'
+            );
+            // WHEN
+            assert.equal(
+                result.query ? Object.keys(result.query).length : 0,
+                1,
+                'only one query expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualTemplate('testExistingQuery', 'query'),
+                await testUtils.getExpectedFile('9999999', 'query', 'template'),
+                'returned template was not equal expected'
+            );
+            // THEN
+            await handler.buildDefinition(
+                'testInstance/testBU',
+                'query',
+                'testExistingQuery',
+                'testMarket'
+            );
+            assert.deepEqual(
+                await testUtils.getActualDeployFile('testExistingQuery', 'query'),
+                await testUtils.getExpectedFile('9999999', 'query', 'build'),
+                'returned deployment file was not equal expected'
+            );
+            assert.equal(
+                Object.values(testUtils.getAPIHistory()).flat().length,
+                6,
+                'Unexpected number of requests made'
+            );
+            return;
+        });
+        it('Should create a query template via buildTemplate and build it', async () => {
+            // download first before we test buildTemplate
+            await handler.retrieve('testInstance/testBU', ['query']);
+            // GIVEN there is a template
+            const result = await handler.buildTemplate(
+                'testInstance/testBU',
+                'query',
+                ['testExistingQuery'],
+                'testMarket'
+            );
+            // WHEN
+            assert.equal(
+                result.query ? Object.keys(result.query).length : 0,
+                1,
+                'only one query expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualTemplate('testExistingQuery', 'query'),
+                await testUtils.getExpectedFile('9999999', 'query', 'template'),
+                'returned template was not equal expected'
+            );
+            // THEN
+            await handler.buildDefinition(
+                'testInstance/testBU',
+                'query',
+                'testExistingQuery',
+                'testMarket'
+            );
+            assert.deepEqual(
+                await testUtils.getActualDeployFile('testExistingQuery', 'query'),
+                await testUtils.getExpectedFile('9999999', 'query', 'build'),
+                'returned deployment file was not equal expected'
+            );
+            assert.equal(
+                Object.values(testUtils.getAPIHistory()).flat().length,
+                6,
+                'Unexpected number of requests made'
+            );
+            return;
+        });
+    });
+});