mcdev 5.0.1 → 5.0.2

package/test/mockRoot/deploy/testInstance/testBU/mobileKeyword/{testNew_keyword.mobileKeyword-meta.json → 4912312345678.TESTNEW_KEYWORD.mobileKeyword-meta.json}

@@ -1,8 +1,5 @@
 {
-    "code": {
-        "code": "4912312345678"
-    },
-    "keyword": "testNew_keyword",
+    "c__codeKeyword": "4912312345678.TESTNEW_KEYWORD",
     "status": "Active",
     "restriction": "NONE",
     "keywordType": "STOP",

package/test/mockRoot/deploy/testInstance/testBU/mobileKeyword/{testNew_keyword_blocked.mobileKeyword-meta.json → 4912312345678.TESTNEW_KEYWORD_BLOCKED.mobileKeyword-meta.json}

@@ -1,8 +1,5 @@
 {
-    "code": {
-        "code": "4912312345678"
-    },
-    "keyword": "testNew_keyword_blocked",
+    "c__codeKeyword": "4912312345678.TESTNEW_KEYWORD_BLOCKED",
     "status": "Active",
     "restriction": "NONE",
     "keywordType": "NORMAL",

package/test/mockRoot/deploy/testInstance/testBU/transactionalSMS/testExisting_tsms.transactionalSMS-meta.json

@@ -10,6 +10,6 @@
         "countryCode": "",
         "autoAddSubscriber": true,
         "updateSubscriber": true,
-        "keyword": "testExisting_keyword"
+        "keyword": "TESTEXISTING_KEYWORD"
     }
 }

package/test/mockRoot/deploy/testInstance/testBU/transactionalSMS/testNew_tsms.transactionalSMS-meta.json

@@ -10,6 +10,6 @@
         "countryCode": "",
         "autoAddSubscriber": true,
         "updateSubscriber": true,
-        "keyword": "testExisting_keyword"
+        "keyword": "TESTEXISTING_KEYWORD"
     }
 }

package/test/resources/1111111/user/retrieve-expected.md

@@ -0,0 +1,19 @@
+# User Overview - testInstance
+
+## Users (1)
+
+| Name | Last successful Login | Active | Access Locked out | API User | Must change PW | Default BU | BU Access | Roles | Login | ID | Key | E-Mail | Notification E-Mail | Timezone | SFMC Locale | Modified Date | Modified By | Created Date |
+| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
+| user test | 96 days | ✓ | - | - | - | <nobr>_ParentBU_ (1111111)</nobr> | <nobr>_ParentBU_ (1111111)</nobr>,<br> <nobr>testBU (9999999)</nobr> | <nobr>Administrator,</nobr><br> <nobr>Content Creator,</nobr><br> <nobr>Marketing Cloud Administrator</nobr> | user_test@accenture.asgr | 700301950 | testExisting_user | user_test@accenture.com | user_test@accenture.com | GMT+01:00 | en-GB | 2022-06-21 01:43:02.64 | 123456 | 2019-09-06 01:59:07.097 |
+
+
+## Inactivated Users (0)
+
+| Name | Last successful Login | Active | Access Locked out | API User | Must change PW | Default BU | BU Access | Roles | Login | ID | Key | E-Mail | Notification E-Mail | Timezone | SFMC Locale | Modified Date | Modified By | Created Date |
+| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
+
+
+## Installed Packages (0)
+
+| Name | Last successful Login | Active | Access Locked out | API User | Must change PW | Default BU | BU Access | Roles | Login | ID | Key | E-Mail | Notification E-Mail | Timezone | SFMC Locale | Modified Date | Modified By | Created Date |
+| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |

package/test/resources/9999999/dataExtension/retrieve-expected.md

@@ -0,0 +1,18 @@
+## testExisting_dataExtension
+
+**Description:** bla bla
+
+**Folder:** Data Extensions/
+
+**Fields in table:** 4
+
+**Sendable:** Yes (`ContactKey` to `Subscriber Key`)
+
+**Testable:** Yes
+
+| Name | FieldType | MaxLength | IsPrimaryKey | IsNullable | DefaultValue |
+| --- | --- | --- | --- | --- | --- |
+| FirstName | Text | 50 | - | + |  |
+| LastName | Text | 50 | - | + |  |
+| EmailAddress | EmailAddress | 254 | - | - |  |
+| ContactKey | Text | 50 | + | - |  |

package/test/resources/9999999/journey/build-expected.json

@@ -323,7 +323,7 @@
             },
             "configurationArguments": {
                 "c__mobileMessage_id": "NTIzOjc4OjA",
-                "c__mobileKeyword": "testTemplated_keyword",
+                "r__mobileKeyword_codeKeyword": "4912312345678.TESTTEMPLATED_KEYWORD",
                 "isOptIn": false,
                 "honorBlackoutWindowEnum": 0,
                 "mobileBlackoutWindowStartTime": "",

package/test/resources/9999999/journey/get-expected.json

@@ -326,7 +326,7 @@
             },
             "configurationArguments": {
                 "c__mobileMessage_id": "NTIzOjc4OjA",
-                "c__mobileKeyword": "testExisting_keyword",
+                "r__mobileKeyword_codeKeyword": "4912312345678.TESTEXISTING_KEYWORD",
                 "isOptIn": false,
                 "honorBlackoutWindowEnum": 0,
                 "mobileBlackoutWindowStartTime": "",

package/test/resources/9999999/journey/put-expected.json

@@ -326,7 +326,7 @@
             },
             "configurationArguments": {
                 "c__mobileMessage_id": "NTIzOjc4OjA",
-                "c__mobileKeyword": "testExisting_keyword",
+                "r__mobileKeyword_codeKeyword": "4912312345678.TESTEXISTING_KEYWORD",
                 "isOptIn": false,
                 "honorBlackoutWindowEnum": 0,
                 "mobileBlackoutWindowStartTime": "",

package/test/resources/9999999/journey/template-expected.json

@@ -323,7 +323,7 @@
             },
             "configurationArguments": {
                 "c__mobileMessage_id": "NTIzOjc4OjA",
-                "c__mobileKeyword": "{{{prefix}}}keyword",
+                "r__mobileKeyword_codeKeyword": "4912312345678.{{{prefixUpper}}}KEYWORD",
                 "isOptIn": false,
                 "honorBlackoutWindowEnum": 0,
                 "mobileBlackoutWindowStartTime": "",

package/test/resources/9999999/legacy/v1/beta/mobile/keyword/NXV4ZFMwTEFwRVczd3RaLUF5X3p5dzo4Njow/get-response.json

@@ -25,7 +25,7 @@
         "isClientOwned": false,
         "isOwner": false
     },
-    "keyword": "testNew_keyword",
+    "keyword": "TESTNEW_KEYWORD",
     "startDate": "2023-03-30T14:00:11.843Z",
     "endDate": "2043-03-30T14:00:11.843Z",
     "status": "Active",

package/test/resources/9999999/legacy/v1/beta/mobile/keyword/get-response.json

@@ -32,7 +32,7 @@
                 "isClientOwned": false,
                 "isOwner": false
             },
-            "keyword": "testExisting_keyword",
+            "keyword": "TESTEXISTING_KEYWORD",
             "startDate": "2018-03-27T12:37:18.197Z",
             "endDate": "2038-03-27T12:37:18.197Z",
             "status": "Active",

package/test/resources/9999999/legacy/v1/beta/mobile/message/NTIzOjc4OjA/get-response.json

@@ -90,7 +90,7 @@
     "isSentImmediately": true,
     "nextKeyword": {
         "id": "cTVJaG5oSDJPVUNHcUh6Z3pQT2tVdzo4Njow",
-        "keyword": "testExisting_keyword",
+        "keyword": "TESTEXISTING_KEYWORD",
         "restriction": "NONE",
         "isInherited": false
     },

package/test/resources/9999999/legacy/v1/beta/mobile/message/get-response.json

@@ -111,7 +111,7 @@
             "isSentImmediately": true,
             "nextKeyword": {
                 "id": "cTVJaG5oSDJPVUNHcUh6Z3pQT2tVdzo4Njow",
-                "keyword": "testExisting_keyword",
+                "keyword": "TESTEXISTING_KEYWORD",
                 "restriction": "NONE",
                 "isInherited": false
             },

package/test/resources/9999999/messaging/v1/sms/definitions/post-response.json

@@ -12,6 +12,6 @@
         "countryCode": "",
         "autoAddSubscriber": true,
         "updateSubscriber": true,
-        "keyword": "testExisting_keyword"
+        "keyword": "TESTEXISTING_KEYWORD"
     }
 }

package/test/resources/9999999/messaging/v1/sms/definitions/testExisting_tsms/get-response.json

@@ -13,6 +13,6 @@
         "countryCode": "",
         "autoAddSubscriber": true,
         "updateSubscriber": true,
-        "keyword": "testExisting_keyword"
+        "keyword": "TESTEXISTING_KEYWORD"
     }
 }

package/test/resources/9999999/messaging/v1/sms/definitions/testExisting_tsms/patch-response.json

@@ -13,6 +13,6 @@
         "countryCode": "",
         "autoAddSubscriber": true,
         "updateSubscriber": true,
-        "keyword": "testExisting_keyword"
+        "keyword": "TESTEXISTING_KEYWORD"
     }
 }

package/test/resources/9999999/mobileKeyword/build-expected.json

@@ -1,8 +1,5 @@
 {
-    "code": {
-        "code": "4912312345678"
-    },
-    "keyword": "testTemplated_keyword",
+    "c__codeKeyword": "4912312345678.TESTTEMPLATED_KEYWORD",
     "keywordType": "NORMAL",
     "isInherited": false,
     "restriction": "NONE"

package/test/resources/9999999/mobileKeyword/get-expected.json

@@ -1,10 +1,7 @@
 {
     "createdDate": "2018-03-27T12:37:18.12Z",
     "lastUpdated": "2018-03-27T12:37:18.167Z",
-    "code": {
-        "code": "4912312345678"
-    },
-    "keyword": "testExisting_keyword",
+    "c__codeKeyword": "4912312345678.TESTEXISTING_KEYWORD",
     "startDate": "2018-03-27T12:37:18.197Z",
     "endDate": "2038-03-27T12:37:18.197Z",
     "status": "Active",

package/test/resources/9999999/mobileKeyword/post-create-expected.json

@@ -1,14 +1,11 @@
 {
-    "code": {
-        "code": "4912312345678"
-    },
     "createdBy": {
         "name": "API_JornBerkefeld app user"
     },
     "createdDate": "2023-03-30T14:00:11.907Z",
     "endDate": "2043-03-30T14:00:11.843Z",
     "isInherited": false,
-    "keyword": "testNew_keyword",
+    "c__codeKeyword": "4912312345678.TESTNEW_KEYWORD",
     "keywordType": "NORMAL",
     "lastUpdated": "2023-03-30T14:00:12.295Z",
     "restriction": "NONE",

package/test/resources/9999999/mobileKeyword/template-expected.json

@@ -1,8 +1,5 @@
 {
-    "code": {
-        "code": "4912312345678"
-    },
-    "keyword": "{{{prefix}}}keyword",
+    "c__codeKeyword": "4912312345678.{{{prefixUpper}}}KEYWORD",
     "keywordType": "NORMAL",
     "isInherited": false,
     "restriction": "NONE"

package/test/resources/9999999/query/build-expected.sql

@@ -1,5 +1,5 @@
 SELECT
-    SubscriberKey as testField
+    SubscriberKey AS testField
 FROM
     _Subscribers
 WHERE

package/test/resources/9999999/query/get-expected.sql

@@ -1,5 +1,5 @@
 SELECT
-    SubscriberKey as testField
+    SubscriberKey AS testField
 FROM
     _Subscribers
 WHERE

package/test/resources/9999999/query/patch-expected.sql

@@ -1,5 +1,5 @@
 SELECT
-    SubscriberKey as testField
+    SubscriberKey AS testField
 FROM
     _Subscribers
 WHERE

package/test/resources/9999999/query/post-expected.sql

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

package/test/resources/9999999/query/template-expected.sql

@@ -1,5 +1,5 @@
 SELECT
-    SubscriberKey as testField
+    SubscriberKey AS testField
 FROM
     _Subscribers
 WHERE

package/test/resources/9999999/transactionalSMS/build-expected.json

@@ -8,6 +8,6 @@
         "countryCode": "",
         "autoAddSubscriber": true,
         "updateSubscriber": true,
-        "keyword": "testTemplated_keyword"
+        "keyword": "TESTTEMPLATED_KEYWORD"
     }
 }

package/test/resources/9999999/transactionalSMS/get-expected.json

@@ -10,6 +10,6 @@
         "countryCode": "",
         "autoAddSubscriber": true,
         "updateSubscriber": true,
-        "keyword": "testExisting_keyword"
+        "keyword": "TESTEXISTING_KEYWORD"
     }
 }

package/test/resources/9999999/transactionalSMS/patch-expected.json

@@ -10,6 +10,6 @@
         "countryCode": "",
         "autoAddSubscriber": true,
         "updateSubscriber": true,
-        "keyword": "testExisting_keyword"
+        "keyword": "TESTEXISTING_KEYWORD"
     }
 }

package/test/resources/9999999/transactionalSMS/post-expected.json

@@ -10,6 +10,6 @@
         "countryCode": "",
         "autoAddSubscriber": true,
         "updateSubscriber": true,
-        "keyword": "testExisting_keyword"
+        "keyword": "TESTEXISTING_KEYWORD"
     }
 }

package/test/resources/9999999/transactionalSMS/template-expected.json

@@ -8,6 +8,6 @@
         "countryCode": "",
         "autoAddSubscriber": true,
         "updateSubscriber": true,
-        "keyword": "{{{prefix}}}keyword"
+        "keyword": "{{{prefixUpper}}}KEYWORD"
     }
 }

package/test/type.dataExtension.test.js

@@ -1,4 +1,8 @@
-const assert = require('chai').assert;
+const chai = require('chai');
+const chaiFiles = require('chai-files');
+const assert = chai.assert;
+const expect = chai.expect;
+const file = chaiFiles.file;
 const cache = require('../lib/util/cache');
 const testUtils = require('./utils');
 const handler = require('../lib/index');
@@ -29,6 +33,13 @@ describe('type: dataExtension', () => {
 
                 'returned metadata was not equal expected'
             );
+            // check if MD file was created and equals expectations
+            expect(
+                file(testUtils.getActualDoc('testExisting_dataExtension', 'dataExtension'))
+            ).to.equal(
+                file(testUtils.getExpectedFile('9999999', 'dataExtension', 'retrieve', 'md'))
+            );
+
             assert.equal(
                 testUtils.getAPIHistoryLength(),
                 5,
@@ -74,6 +85,7 @@ describe('type: dataExtension', () => {
             return;
         });
         it('Should change the key during update via --changeKeyValue');
+        it('Should rename fields');
     });
     describe('Templating ================', () => {
         it('Should create a dataExtension template via retrieveAsTemplate and build it', async () => {

package/test/type.mobileKeyword.test.js

@@ -30,12 +30,21 @@ describe('type: mobileKeyword', () => {
                 'only 1 mobileKeywords expected'
             );
             assert.deepEqual(
-                await testUtils.getActualJson('testExisting_keyword', 'mobileKeyword'),
+                await testUtils.getActualJson(
+                    '4912312345678.TESTEXISTING_KEYWORD',
+                    'mobileKeyword'
+                ),
                 await testUtils.getExpectedJson('9999999', 'mobileKeyword', 'get'),
                 'saved JSON was not equal expected'
             );
             expect(
-                file(testUtils.getActualFile('testExisting_keyword', 'mobileKeyword', 'amp'))
+                file(
+                    testUtils.getActualFile(
+                        '4912312345678.TESTEXISTING_KEYWORD',
+                        'mobileKeyword',
+                        'amp'
+                    )
+                )
             ).to.equal(file(testUtils.getExpectedFile('9999999', 'mobileKeyword', 'get', 'amp')));
             assert.equal(
                 testUtils.getAPIHistoryLength(),
@@ -51,7 +60,11 @@ describe('type: mobileKeyword', () => {
         });
         it('Should create (but not update) a mobileKeyword', async () => {
             // WHEN
-            await handler.deploy('testInstance/testBU', ['mobileKeyword'], ['testNew_keyword']);
+            await handler.deploy(
+                'testInstance/testBU',
+                ['mobileKeyword'],
+                ['4912312345678.TESTNEW_KEYWORD']
+            );
             // THEN
             assert.equal(process.exitCode, false, 'deploy should not have thrown an error');
             // get results from cache
@@ -63,12 +76,14 @@ describe('type: mobileKeyword', () => {
             );
             // confirm created item
             assert.deepEqual(
-                await testUtils.getActualJson('testNew_keyword', 'mobileKeyword'),
+                await testUtils.getActualJson('4912312345678.TESTNEW_KEYWORD', 'mobileKeyword'),
                 await testUtils.getExpectedJson('9999999', 'mobileKeyword', 'post-create'),
                 'returned JSON was not equal expected for insert mobileKeyword'
             );
             expect(
-                file(testUtils.getActualFile('testNew_keyword', 'mobileKeyword', 'amp'))
+                file(
+                    testUtils.getActualFile('4912312345678.TESTNEW_KEYWORD', 'mobileKeyword', 'amp')
+                )
             ).to.equal(
                 file(testUtils.getExpectedFile('9999999', 'mobileKeyword', 'post-create', 'amp'))
             );
@@ -92,7 +107,7 @@ describe('type: mobileKeyword', () => {
             await handler.deploy(
                 'testInstance/testBU',
                 ['mobileKeyword'],
-                ['testNew_keyword_blocked']
+                ['4912312345678.TESTNEW_KEYWORD_BLOCKED']
             );
             // THEN
             assert.equal(process.exitCode, true, 'deploy should have thrown an error');
@@ -113,7 +128,7 @@ describe('type: mobileKeyword', () => {
             const result = await handler.retrieveAsTemplate(
                 'testInstance/testBU',
                 'mobileKeyword',
-                ['testExisting_keyword'],
+                ['4912312345678.TESTEXISTING_KEYWORD'],
                 'testSourceMarket'
             );
             // WHEN
@@ -128,13 +143,20 @@ describe('type: mobileKeyword', () => {
                 'only one item expected'
             );
             assert.deepEqual(
-                await testUtils.getActualTemplateJson('testExisting_keyword', 'mobileKeyword'),
+                await testUtils.getActualTemplateJson(
+                    '4912312345678.TESTEXISTING_KEYWORD',
+                    'mobileKeyword'
+                ),
                 await testUtils.getExpectedJson('9999999', 'mobileKeyword', 'template'),
                 'returned template JSON was not equal expected'
             );
             expect(
                 file(
-                    testUtils.getActualTemplateFile('testExisting_keyword', 'mobileKeyword', 'amp')
+                    testUtils.getActualTemplateFile(
+                        '4912312345678.TESTEXISTING_KEYWORD',
+                        'mobileKeyword',
+                        'amp'
+                    )
                 )
             ).to.equal(
                 file(testUtils.getExpectedFile('9999999', 'mobileKeyword', 'template', 'amp'))
@@ -153,7 +175,7 @@ describe('type: mobileKeyword', () => {
             const result = await handler.buildTemplate(
                 'testInstance/testBU',
                 'mobileKeyword',
-                ['testExisting_keyword'],
+                ['4912312345678.TESTEXISTING_KEYWORD'],
                 'testSourceMarket'
             );
             assert.equal(process.exitCode, false, 'buildTemplate should not have thrown an error');
@@ -164,13 +186,20 @@ describe('type: mobileKeyword', () => {
                 'only one mobileKeyword expected'
             );
             assert.deepEqual(
-                await testUtils.getActualTemplateJson('testExisting_keyword', 'mobileKeyword'),
+                await testUtils.getActualTemplateJson(
+                    '4912312345678.TESTEXISTING_KEYWORD',
+                    'mobileKeyword'
+                ),
                 await testUtils.getExpectedJson('9999999', 'mobileKeyword', 'template'),
                 'returned template JSON was not equal expected'
             );
             expect(
                 file(
-                    testUtils.getActualTemplateFile('testExisting_keyword', 'mobileKeyword', 'amp')
+                    testUtils.getActualTemplateFile(
+                        '4912312345678.TESTEXISTING_KEYWORD',
+                        'mobileKeyword',
+                        'amp'
+                    )
                 )
             ).to.equal(
                 file(testUtils.getExpectedFile('9999999', 'mobileKeyword', 'template', 'amp'))
@@ -180,7 +209,7 @@ describe('type: mobileKeyword', () => {
             await handler.buildDefinition(
                 'testInstance/testBU',
                 'mobileKeyword',
-                'testExisting_keyword',
+                '4912312345678.TESTEXISTING_KEYWORD',
                 'testTargetMarket'
             );
             assert.equal(
@@ -189,12 +218,21 @@ describe('type: mobileKeyword', () => {
                 'buildDefinition should not have thrown an error'
             );
             assert.deepEqual(
-                await testUtils.getActualDeployJson('testTemplated_keyword', 'mobileKeyword'),
+                await testUtils.getActualDeployJson(
+                    '4912312345678.TESTTEMPLATED_KEYWORD',
+                    'mobileKeyword'
+                ),
                 await testUtils.getExpectedJson('9999999', 'mobileKeyword', 'build'),
                 'returned deployment JSON was not equal expected'
             );
             expect(
-                file(testUtils.getActualDeployFile('testTemplated_keyword', 'mobileKeyword', 'amp'))
+                file(
+                    testUtils.getActualDeployFile(
+                        '4912312345678.TESTTEMPLATED_KEYWORD',
+                        'mobileKeyword',
+                        'amp'
+                    )
+                )
             ).to.equal(file(testUtils.getExpectedFile('9999999', 'mobileKeyword', 'build', 'amp')));
 
             assert.equal(
@@ -209,7 +247,7 @@ describe('type: mobileKeyword', () => {
         it('Should delete the item', async () => {
             // WHEN
             const result = await handler.deleteByKey('testInstance/testBU', 'mobileKeyword', [
-                'testExisting_keyword',
+                '4912312345678.TESTEXISTING_KEYWORD',
             ]);
             // THEN
             assert.equal(process.exitCode, false, 'delete should not have thrown an error');
@@ -224,7 +262,7 @@ describe('type: mobileKeyword', () => {
             const fileList = await handler.getFilesToCommit(
                 'testInstance/testBU',
                 'mobileKeyword',
-                ['testExisting_keyword']
+                ['4912312345678.TESTEXISTING_KEYWORD']
             );
             // THEN
             assert.equal(
@@ -236,12 +274,12 @@ describe('type: mobileKeyword', () => {
 
             assert.equal(
                 fileList[0].split('\\').join('/'),
-                'retrieve/testInstance/testBU/mobileKeyword/testExisting_keyword.mobileKeyword-meta.json',
+                'retrieve/testInstance/testBU/mobileKeyword/4912312345678.TESTEXISTING_KEYWORD.mobileKeyword-meta.json',
                 'wrong JSON path'
             );
             assert.equal(
                 fileList[1].split('\\').join('/'),
-                'retrieve/testInstance/testBU/mobileKeyword/testExisting_keyword.mobileKeyword-meta.amp',
+                'retrieve/testInstance/testBU/mobileKeyword/4912312345678.TESTEXISTING_KEYWORD.mobileKeyword-meta.amp',
                 'wrong AMP path'
             );
             return;

package/test/type.user.test.js

@@ -1,4 +1,9 @@
-const assert = require('chai').assert;
+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');
@@ -29,6 +34,11 @@ describe('type: user', () => {
 
                 'returned metadata was not equal expected'
             );
+            // check if MD file was created and equals expectations
+            expect(file(`./docs/user/testInstance.users.md`)).to.equal(
+                file(testUtils.getExpectedFile('1111111', 'user', 'retrieve', 'md'))
+            );
+
             assert.equal(
                 testUtils.getAPIHistoryLength(),
                 6,
@@ -36,6 +46,22 @@ describe('type: user', () => {
             );
             return;
         });
+        it('Should retrieve a specific user but not run document', async () => {
+            // WHEN
+            await handler.retrieve('testInstance/_ParentBU_', ['user'], ['testExisting_user']);
+            // THEN
+            assert.equal(process.exitCode, false, 'retrieve should not have thrown an error');
+
+            // because user is single-document-type we would not want to find an md file when we retrieve specific keys. only the generic retrieve updates it
+            expect(file(`./docs/user/testInstance.users.md`)).to.not.exist;
+
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                4,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
     });
     describe('Deploy ================', () => {
         beforeEach(() => {
@@ -74,6 +100,9 @@ describe('type: user', () => {
                 await testUtils.getExpectedJson('1111111', 'user', 'update'),
                 'returned metadata was not equal expected for update'
             );
+            // because user is single-document-type we would not want to find an md file getting created by deploy. only retrieve updates it
+            expect(file(`./docs/user/testInstance.users.md`)).to.not.exist;
+
             assert.equal(
                 testUtils.getAPIHistoryLength(),
                 9,

package/test/utils.js

@@ -22,6 +22,16 @@ const resourceFactory = require('./resourceFactory');
  */
 exports.getActualJson = (customerKey, type, buName = 'testBU') =>
     File.readJSON(`./retrieve/testInstance/${buName}/${type}/${customerKey}.${type}-meta.json`);
+/**
+ * gets file from Retrieve folder
+ *
+ * @param {string} customerKey of metadata
+ * @param {string} type of metadata
+ * @param {string} [buName] used when we need to test on ParentBU
+ * @returns {Promise.<string>} file in string form
+ */
+exports.getActualDoc = (customerKey, type, buName = 'testBU') =>
+    `./retrieve/testInstance/${buName}/${type}/${customerKey}.${type}-doc.md`;
 /**
  * gets file from Retrieve folder
  *