mcdev 5.0.1 → 5.1.0

package/test/type.query.test.js

@@ -32,16 +32,16 @@ describe('type: query', () => {
             );
             // normal test
             assert.deepEqual(
-                await testUtils.getActualJson('testExistingQuery', 'query'),
+                await testUtils.getActualJson('testExisting_query', 'query'),
                 await testUtils.getExpectedJson('9999999', 'query', 'get'),
                 'returned metadata with correct key was not equal expected'
             );
-            expect(file(testUtils.getActualFile('testExistingQuery', 'query', 'sql'))).to.equal(
+            expect(file(testUtils.getActualFile('testExisting_query', 'query', 'sql'))).to.equal(
                 file(testUtils.getExpectedFile('9999999', 'query', 'get', 'sql'))
             );
             // check if targetKey was overwritten
             assert.deepEqual(
-                await testUtils.getActualJson('testExistingQuery2', 'query'),
+                await testUtils.getActualJson('testExisting_query2', 'query'),
                 await testUtils.getExpectedJson('9999999', 'query', 'get2'),
                 'returned metadata with wrong key was not equal expected'
             );
@@ -55,7 +55,7 @@ describe('type: query', () => {
         });
         it('Should retrieve one specific query', async () => {
             // WHEN
-            await handler.retrieve('testInstance/testBU', ['query'], ['testExistingQuery']);
+            await handler.retrieve('testInstance/testBU', ['query'], ['testExisting_query']);
             // THEN
             assert.equal(process.exitCode, false, 'retrieve should not have thrown an error');
             // get results from cache
@@ -66,11 +66,11 @@ describe('type: query', () => {
                 'only one query expected'
             );
             assert.deepEqual(
-                await testUtils.getActualJson('testExistingQuery', 'query'),
+                await testUtils.getActualJson('testExisting_query', 'query'),
                 await testUtils.getExpectedJson('9999999', 'query', 'get'),
                 'returned metadata was not equal expected'
             );
-            expect(file(testUtils.getActualFile('testExistingQuery', 'query', 'sql'))).to.equal(
+            expect(file(testUtils.getActualFile('testExisting_query', 'query', 'sql'))).to.equal(
                 file(testUtils.getExpectedFile('9999999', 'query', 'get', 'sql'))
             );
             assert.equal(
@@ -99,20 +99,20 @@ describe('type: query', () => {
             );
             // confirm created item
             assert.deepEqual(
-                await testUtils.getActualJson('testNewQuery', 'query'),
+                await testUtils.getActualJson('testNew_query', 'query'),
                 await testUtils.getExpectedJson('9999999', 'query', 'post'),
                 'returned metadata was not equal expected for insert query'
             );
-            expect(file(testUtils.getActualFile('testNewQuery', 'query', 'sql'))).to.equal(
+            expect(file(testUtils.getActualFile('testNew_query', 'query', 'sql'))).to.equal(
                 file(testUtils.getExpectedFile('9999999', 'query', 'post', 'sql'))
             );
             // confirm updated item
             assert.deepEqual(
-                await testUtils.getActualJson('testExistingQuery', 'query'),
+                await testUtils.getActualJson('testExisting_query', 'query'),
                 await testUtils.getExpectedJson('9999999', 'query', 'patch'),
                 'returned metadata was not equal expected for insert query'
             );
-            expect(file(testUtils.getActualFile('testExistingQuery', 'query', 'sql'))).to.equal(
+            expect(file(testUtils.getActualFile('testExisting_query', 'query', 'sql'))).to.equal(
                 file(testUtils.getExpectedFile('9999999', 'query', 'patch', 'sql'))
             );
             // check number of API calls
@@ -131,7 +131,7 @@ describe('type: query', () => {
             const result = await handler.retrieveAsTemplate(
                 'testInstance/testBU',
                 'query',
-                ['testExistingQuery'],
+                ['testExisting_query'],
                 'testSourceMarket'
             );
             // WHEN
@@ -146,18 +146,18 @@ describe('type: query', () => {
                 'only one query expected'
             );
             assert.deepEqual(
-                await testUtils.getActualTemplateJson('testExistingQuery', 'query'),
+                await testUtils.getActualTemplateJson('testExisting_query', 'query'),
                 await testUtils.getExpectedJson('9999999', 'query', 'template'),
                 'returned template JSON of retrieveAsTemplate was not equal expected'
             );
             expect(
-                file(testUtils.getActualTemplateFile('testExistingQuery', 'query', 'sql'))
+                file(testUtils.getActualTemplateFile('testExisting_query', 'query', 'sql'))
             ).to.equal(file(testUtils.getExpectedFile('9999999', 'query', 'template', 'sql')));
             // THEN
             await handler.buildDefinition(
                 'testInstance/testBU',
                 'query',
-                'testExistingQuery',
+                'testExisting_query',
                 'testTargetMarket'
             );
             assert.equal(
@@ -167,13 +167,14 @@ describe('type: query', () => {
             );
 
             assert.deepEqual(
-                await testUtils.getActualDeployJson('testExistingQuery', 'query'),
+                await testUtils.getActualDeployJson('testTemplated_query', 'query'),
                 await testUtils.getExpectedJson('9999999', 'query', 'build'),
                 'returned deployment JSON was not equal expected'
             );
             expect(
-                file(testUtils.getActualDeployFile('testExistingQuery', 'query', 'sql'))
+                file(testUtils.getActualDeployFile('testTemplated_query', 'query', 'sql'))
             ).to.equal(file(testUtils.getExpectedFile('9999999', 'query', 'build', 'sql')));
+
             assert.equal(
                 testUtils.getAPIHistoryLength(),
                 6,
@@ -188,7 +189,7 @@ describe('type: query', () => {
             const result = await handler.buildTemplate(
                 'testInstance/testBU',
                 'query',
-                ['testExistingQuery'],
+                ['testExisting_query'],
                 'testSourceMarket'
             );
             // WHEN
@@ -200,18 +201,18 @@ describe('type: query', () => {
                 'only one query expected'
             );
             assert.deepEqual(
-                await testUtils.getActualTemplateJson('testExistingQuery', 'query'),
+                await testUtils.getActualTemplateJson('testExisting_query', 'query'),
                 await testUtils.getExpectedJson('9999999', 'query', 'template'),
                 'returned template JSON of buildTemplate was not equal expected'
             );
             expect(
-                file(testUtils.getActualTemplateFile('testExistingQuery', 'query', 'sql'))
+                file(testUtils.getActualTemplateFile('testExisting_query', 'query', 'sql'))
             ).to.equal(file(testUtils.getExpectedFile('9999999', 'query', 'template', 'sql')));
             // THEN
             await handler.buildDefinition(
                 'testInstance/testBU',
                 'query',
-                'testExistingQuery',
+                'testExisting_query',
                 'testTargetMarket'
             );
             assert.equal(
@@ -221,12 +222,12 @@ describe('type: query', () => {
             );
 
             assert.deepEqual(
-                await testUtils.getActualDeployJson('testExistingQuery', 'query'),
+                await testUtils.getActualDeployJson('testTemplated_query', 'query'),
                 await testUtils.getExpectedJson('9999999', 'query', 'build'),
                 'returned deployment JSON was not equal expected'
             );
             expect(
-                file(testUtils.getActualDeployFile('testExistingQuery', 'query', 'sql'))
+                file(testUtils.getActualDeployFile('testTemplated_query', 'query', 'sql'))
             ).to.equal(file(testUtils.getExpectedFile('9999999', 'query', 'build', 'sql')));
 
             assert.equal(
@@ -241,7 +242,7 @@ describe('type: query', () => {
         it('Should delete the item', async () => {
             // WHEN
             const result = await handler.deleteByKey('testInstance/testBU', 'query', [
-                'testExistingQuery',
+                'testExisting_query',
             ]);
             // THEN
             assert.equal(process.exitCode, false, 'delete should not have thrown an error');
@@ -254,7 +255,7 @@ describe('type: query', () => {
         it('Should return a list of files based on their type and key', async () => {
             // WHEN
             const fileList = await handler.getFilesToCommit('testInstance/testBU', 'query', [
-                'testExistingQuery',
+                'testExisting_query',
             ]);
             // THEN
             assert.equal(
@@ -266,15 +267,27 @@ describe('type: query', () => {
 
             assert.equal(
                 fileList[0].split('\\').join('/'),
-                'retrieve/testInstance/testBU/query/testExistingQuery.query-meta.json',
+                'retrieve/testInstance/testBU/query/testExisting_query.query-meta.json',
                 'wrong JSON path'
             );
             assert.equal(
                 fileList[1].split('\\').join('/'),
-                'retrieve/testInstance/testBU/query/testExistingQuery.query-meta.sql',
+                'retrieve/testInstance/testBU/query/testExisting_query.query-meta.sql',
                 'wrong JSON path'
             );
             return;
         });
     });
+    describe('Execute ================', () => {
+        it('Should start executing a query', async () => {
+            const execute = await handler.execute(
+                'testInstance/testBU',
+                ['query'],
+                ['testExisting_query']
+            );
+            assert.equal(process.exitCode, false, 'execute should not have thrown an error');
+            assert.equal(execute, true, 'query was supposed to be executed');
+            return;
+        });
+    });
 });

package/test/type.user.test.js

@@ -1,7 +1,13 @@
-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');
+const File = require('../lib/util/file');
 
 describe('type: user', () => {
     beforeEach(() => {
@@ -29,6 +35,24 @@ describe('type: user', () => {
 
                 'returned metadata was not equal expected'
             );
+            // check if MD file was created and equals expectations
+            // ! this test needs to update the lastLoginDate counter because it changes with every passing day
+            const expectedFile = await File.readFile(
+                testUtils.getExpectedFile('1111111', 'user', 'retrieve', 'md'),
+                { encoding: 'utf8' }
+            );
+            const regexFindDaysSinceLogin =
+                /\| (\d*) (seconds|minutes|days|weeks|months|years){1} \|/gm;
+            // fetch expected time since last login
+            const expectedDaysSinceLogin = expectedFile.match(regexFindDaysSinceLogin);
+            // load actual file and replace days since last login with expected value
+            const actualFile = (
+                await File.readFile(`./docs/user/testInstance.users.md`, {
+                    encoding: 'utf8',
+                })
+            ).replaceAll(regexFindDaysSinceLogin, expectedDaysSinceLogin);
+            expect(actualFile).to.equal(expectedFile);
+
             assert.equal(
                 testUtils.getAPIHistoryLength(),
                 6,
@@ -36,6 +60,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 +114,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

@@ -4,6 +4,7 @@ const axios = require('axios');
 const MockAdapter = require('axios-mock-adapter');
 const auth = require('../lib/util/auth');
 const Util = require('../lib/util/util');
+const handler = require('../lib/index');
 
 // for some reason doesnt realize below reference
 // eslint-disable-next-line no-unused-vars
@@ -22,13 +23,23 @@ 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 {string} file path
+ */
+exports.getActualDoc = (customerKey, type, buName = 'testBU') =>
+    `./retrieve/testInstance/${buName}/${type}/${customerKey}.${type}-doc.md`;
 /**
  * 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
+ * @returns {string} file path
  */
 exports.getActualFile = (customerKey, type, ext) =>
     `./retrieve/testInstance/testBU/${type}/${customerKey}.${type}-meta.${ext}`;
@@ -48,7 +59,7 @@ exports.getActualDeployJson = (customerKey, type, buName = 'testBU') =>
  * @param {string} customerKey of metadata
  * @param {string} type of metadata
  * @param {string} ext file extension
- * @returns {Promise.<string>} file in string form
+ * @returns {string} file path
  */
 exports.getActualDeployFile = (customerKey, type, ext) =>
     `./deploy/testInstance/testBU/${type}/${customerKey}.${type}-meta.${ext}`;
@@ -67,7 +78,7 @@ exports.getActualTemplateJson = (customerKey, type) =>
  * @param {string} customerKey of metadata
  * @param {string} type of metadata
  * @param {string} ext file extension
- * @returns {Promise.<string>} file in string form
+ * @returns {string} file path
  */
 exports.getActualTemplateFile = (customerKey, type, ext) =>
     `./template/${type}/${customerKey}.${type}-meta.${ext}`;
@@ -89,7 +100,7 @@ exports.getExpectedJson = (mid, type, action) =>
  * @param {string} type of metadata
  * @param {string} action of SOAP request
  * @param {string} ext file extension
- * @returns {Promise.<string>} file in string form
+ * @returns {string} file path
  */
 exports.getExpectedFile = (mid, type, action, ext) =>
     path.join('test', 'resources', mid, type, action + '-expected.' + ext);
@@ -101,7 +112,7 @@ exports.getExpectedFile = (mid, type, action, ext) =>
  */
 
 exports.mockSetup = (isDeploy) => {
-    Util.setLoggingLevel({ debug: true });
+    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) => {

package/.coverage-comment-template.md

@@ -1,20 +0,0 @@
-## Coverage Report
-
-Commit: [{{short_commit_sha}}]({{commit_link}})
-Base: [{{base_ref}}@{{base_short_commit_sha}}]({{base_commit_link}})
-
-| Type                      | Base                                       | This PR                                                                            |
-| ------------------------- | ------------------------------------------ | ---------------------------------------------------------------------------------- |
-| Total Statements Coverage | {{base_total_statements_coverage_percent}} | {{total_statements_coverage_percent}} ({{total_statements_coverage_percent_diff}}) |
-| Total Branches Coverage   | {{base_total_branches_coverage_percent}}   | {{total_branches_coverage_percent}} ({{total_branches_coverage_percent_diff}})     |
-| Total Functions Coverage  | {{base_total_functions_coverage_percent}}  | {{total_functions_coverage_percent}} ({{total_functions_coverage_percent_diff}})   |
-| Total Lines Coverage      | {{base_total_lines_coverage_percent}}      | {{total_lines_coverage_percent}} ({{total_lines_coverage_percent_diff}})           |
-
-<details>
-<summary>Details (changed files)</summary>
-{{changed_files_coverage_table}}
-</details>
-<details>
-<summary>Details (all files)</summary>
-{{files_coverage_table}}
-</details>