mcdev 6.0.2 → 7.0.0

package/test/type.script.test.js

@@ -1,15 +1,18 @@
-import chai, { assert, expect } from 'chai';
+import * as chai from 'chai';
+const assert = chai.assert;
+const expect = chai.expect;
+
 import chaiFiles from 'chai-files';
 import cache from '../lib/util/cache.js';
 import * as testUtils from './utils.js';
 import handler from '../lib/index.js';
 chai.use(chaiFiles);
-const file = chaiFiles.file;
 
 describe('type: script', () => {
     beforeEach(() => {
         testUtils.mockSetup();
     });
+
     afterEach(() => {
         testUtils.mockReset();
     });
@@ -19,7 +22,7 @@ describe('type: script', () => {
             // WHEN
             const retrieve = await handler.retrieve('testInstance/testBU', ['script']);
             // THEN
-            assert.equal(process.exitCode, false, 'retrieve should not have thrown an error');
+            assert.equal(process.exitCode, 0, 'retrieve should not have thrown an error');
             // retrieve result
             assert.equal(
                 retrieve['testInstance/testBU'].script
@@ -42,10 +45,10 @@ describe('type: script', () => {
                 await testUtils.getExpectedJson('9999999', 'script', 'get'),
                 'returned metadata with correct key was not equal expected'
             );
-            expect(file(testUtils.getActualFile('testExisting_script', 'script', 'html'))).to.not
+            expect(await testUtils.getActualFile('testExisting_script', 'script', 'html')).to.not
                 .exist;
-            expect(file(testUtils.getActualFile('testExisting_script', 'script', 'ssjs'))).to.equal(
-                file(testUtils.getExpectedFile('9999999', 'script', 'get', 'ssjs'))
+            expect(await testUtils.getActualFile('testExisting_script', 'script', 'ssjs')).to.equal(
+                await testUtils.getExpectedFile('9999999', 'script', 'get', 'ssjs')
             );
 
             // test with no script tag
@@ -55,12 +58,12 @@ describe('type: script', () => {
                 'returned metadata was not equal expected'
             );
             expect(
-                file(testUtils.getActualFile('testExisting_script_noScriptTag', 'script', 'html'))
+                await testUtils.getActualFile('testExisting_script_noScriptTag', 'script', 'html')
             ).to.equal(
-                file(testUtils.getExpectedFile('9999999', 'script', 'get_noScriptTag', 'html'))
+                await testUtils.getExpectedFile('9999999', 'script', 'get_noScriptTag', 'html')
             );
             expect(
-                file(testUtils.getActualFile('testExisting_script_noScriptTag', 'script', 'ssjs'))
+                await testUtils.getActualFile('testExisting_script_noScriptTag', 'script', 'ssjs')
             ).to.not.exist;
 
             // test with ampscript
@@ -70,11 +73,11 @@ describe('type: script', () => {
                 'returned metadata was not equal expected'
             );
             expect(
-                file(testUtils.getActualFile('testExisting_script_ampscript', 'script', 'html'))
+                await testUtils.getActualFile('testExisting_script_ampscript', 'script', 'html')
             ).to.equal(
-                file(testUtils.getExpectedFile('9999999', 'script', 'get_ampscript', 'html'))
+                await testUtils.getExpectedFile('9999999', 'script', 'get_ampscript', 'html')
             );
-            expect(file(testUtils.getActualFile('testExisting_script_ampscript', 'script', 'ssjs')))
+            expect(await testUtils.getActualFile('testExisting_script_ampscript', 'script', 'ssjs'))
                 .to.not.exist;
 
             // test with mixed code (ampscript inside of ssjs)
@@ -84,12 +87,12 @@ describe('type: script', () => {
                 'returned metadata was not equal expected'
             );
             expect(
-                file(testUtils.getActualFile('testExisting_script_ampincluded', 'script', 'html'))
+                await testUtils.getActualFile('testExisting_script_ampincluded', 'script', 'ssjs')
             ).to.not.exist;
             expect(
-                file(testUtils.getActualFile('testExisting_script_ampincluded', 'script', 'ssjs'))
+                await testUtils.getActualFile('testExisting_script_ampincluded', 'script', 'html')
             ).to.equal(
-                file(testUtils.getExpectedFile('9999999', 'script', 'get_ampincluded', 'ssjs'))
+                await testUtils.getExpectedFile('9999999', 'script', 'get_ampincluded', 'html')
             );
 
             // test with mixed code (ssjs and ampscript side-by-side)
@@ -99,9 +102,9 @@ describe('type: script', () => {
                 'returned metadata was not equal expected'
             );
             expect(
-                file(testUtils.getActualFile('testExisting_script_mixed', 'script', 'html'))
-            ).to.equal(file(testUtils.getExpectedFile('9999999', 'script', 'get_mixed', 'html')));
-            expect(file(testUtils.getActualFile('testExisting_script_mixed', 'script', 'ssjs'))).to
+                await testUtils.getActualFile('testExisting_script_mixed', 'script', 'html')
+            ).to.equal(await testUtils.getExpectedFile('9999999', 'script', 'get_mixed', 'html'));
+            expect(await testUtils.getActualFile('testExisting_script_mixed', 'script', 'ssjs')).to
                 .not.exist;
 
             assert.equal(
@@ -111,11 +114,12 @@ describe('type: script', () => {
             );
             return;
         });
+
         it('Should retrieve one specific script by key', async () => {
             // WHEN
             await handler.retrieve('testInstance/testBU', ['script'], ['testExisting_script']);
             // THEN
-            assert.equal(process.exitCode, false, 'retrieve should not have thrown an error');
+            assert.equal(process.exitCode, 0, 'retrieve should not have thrown an error');
             // get results from cache
             const result = cache.getCache();
             assert.equal(
@@ -128,20 +132,20 @@ describe('type: script', () => {
                 await testUtils.getExpectedJson('9999999', 'script', 'get'),
                 'returned metadata was not equal expected'
             );
-            expect(file(testUtils.getActualFile('testExisting_script', 'script', 'html'))).to.not
+            expect(await testUtils.getActualFile('testExisting_script', 'script', 'html')).to.not
                 .exist;
-            expect(file(testUtils.getActualFile('testExisting_script', 'script', 'ssjs'))).to.equal(
-                file(testUtils.getExpectedFile('9999999', 'script', 'get', 'ssjs'))
+            expect(await testUtils.getActualFile('testExisting_script', 'script', 'ssjs')).to.equal(
+                await testUtils.getExpectedFile('9999999', 'script', 'get', 'ssjs')
             );
 
             expect(
-                file(testUtils.getActualFile('testExisting_script_noScriptTag', 'script', 'json'))
+                await testUtils.getActualFile('testExisting_script_noScriptTag', 'script', 'json')
             ).to.not.exist;
             expect(
-                file(testUtils.getActualFile('testExisting_script_noScriptTag', 'script', 'ssjs'))
+                await testUtils.getActualFile('testExisting_script_noScriptTag', 'script', 'ssjs')
             ).to.not.exist;
             expect(
-                file(testUtils.getActualFile('testExisting_script_noScriptTag', 'script', 'html'))
+                await testUtils.getActualFile('testExisting_script_noScriptTag', 'script', 'html')
             ).to.not.exist;
 
             assert.equal(
@@ -151,13 +155,14 @@ describe('type: script', () => {
             );
             return;
         });
+
         it('Should retrieve one specific script via --like', async () => {
             // WHEN
             handler.setOptions({ like: { key: '%Existing_script' } });
             await handler.retrieve('testInstance/testBU', ['script']);
 
             // THEN
-            assert.equal(process.exitCode, false, 'retrieve should not have thrown an error');
+            assert.equal(process.exitCode, 0, 'retrieve should not have thrown an error');
 
             // get results from cache
             const result = cache.getCache();
@@ -171,18 +176,18 @@ describe('type: script', () => {
                 await testUtils.getExpectedJson('9999999', 'script', 'get'),
                 'returned metadata was not equal expected'
             );
-            expect(file(testUtils.getActualFile('testExisting_script', 'script', 'ssjs'))).to.equal(
-                file(testUtils.getExpectedFile('9999999', 'script', 'get', 'ssjs'))
+            expect(await testUtils.getActualFile('testExisting_script', 'script', 'ssjs')).to.equal(
+                await testUtils.getExpectedFile('9999999', 'script', 'get', 'ssjs')
             );
 
             expect(
-                file(testUtils.getActualFile('testExisting_script_noScriptTag', 'script', 'json'))
+                await testUtils.getActualFile('testExisting_script_noScriptTag', 'script', 'json')
             ).to.not.exist;
             expect(
-                file(testUtils.getActualFile('testExisting_script_noScriptTag', 'script', 'ssjs'))
+                await testUtils.getActualFile('testExisting_script_noScriptTag', 'script', 'ssjs')
             ).to.not.exist;
             expect(
-                file(testUtils.getActualFile('testExisting_script_noScriptTag', 'script', 'html'))
+                await testUtils.getActualFile('testExisting_script_noScriptTag', 'script', 'html')
             ).to.not.exist;
 
             assert.equal(
@@ -192,12 +197,13 @@ describe('type: script', () => {
             );
             return;
         });
+
         it('Should not retrieve any script via --like and key due to a mismatching filter', async () => {
             // WHEN
             handler.setOptions({ like: { key: 'NotExisting_script' } });
             await handler.retrieve('testInstance/testBU', ['script']);
             // THEN
-            assert.equal(process.exitCode, false, 'retrieve should not have thrown an error');
+            assert.equal(process.exitCode, 0, 'retrieve should not have thrown an error');
 
             // get results from cache
             const result = cache.getCache();
@@ -207,7 +213,7 @@ describe('type: script', () => {
                 '5 scripts in cache expected'
             );
 
-            expect(file(testUtils.getActualFile('testExisting_script', 'script', 'ssjs'))).to.not
+            expect(await testUtils.getActualFile('testExisting_script', 'script', 'ssjs')).to.not
                 .exist;
             assert.equal(
                 testUtils.getAPIHistoryLength(),
@@ -217,15 +223,17 @@ describe('type: script', () => {
             return;
         });
     });
+
     describe('Deploy ================', () => {
         beforeEach(() => {
             testUtils.mockSetup(true);
         });
+
         it('Should create & upsert a script', async () => {
             // WHEN
             await handler.deploy('testInstance/testBU', ['script']);
             // THEN
-            assert.equal(process.exitCode, false, 'deploy should not have thrown an error');
+            assert.equal(process.exitCode, 0, 'deploy should not have thrown an error');
             // get results from cache
             const result = cache.getCache();
             assert.equal(
@@ -245,10 +253,10 @@ describe('type: script', () => {
                 await testUtils.getExpectedJson('9999999', 'script', 'patch'),
                 'returned metadata was not equal expected for insert script'
             );
-            expect(file(testUtils.getActualFile('testExisting_script', 'script', 'html'))).to.not
+            expect(await testUtils.getActualFile('testExisting_script', 'script', 'html')).to.not
                 .exist;
-            expect(file(testUtils.getActualFile('testExisting_script', 'script', 'ssjs'))).to.equal(
-                file(testUtils.getExpectedFile('9999999', 'script', 'patch', 'ssjs'))
+            expect(await testUtils.getActualFile('testExisting_script', 'script', 'ssjs')).to.equal(
+                await testUtils.getExpectedFile('9999999', 'script', 'patch', 'ssjs')
             );
             // check number of API calls
             assert.equal(
@@ -259,6 +267,7 @@ describe('type: script', () => {
             return;
         });
     });
+
     describe('Templating ================', () => {
         it('Should create a script template via retrieveAsTemplate and build it', async () => {
             // GIVEN there is a template
@@ -269,11 +278,7 @@ describe('type: script', () => {
                 'testSourceMarket'
             );
             // WHEN
-            assert.equal(
-                process.exitCode,
-                false,
-                'retrieveAsTemplate should not have thrown an error'
-            );
+            assert.equal(process.exitCode, 0, 'retrieveAsTemplate should not have thrown an error');
             assert.equal(
                 result.script ? Object.keys(result.script).length : 0,
                 1,
@@ -285,20 +290,16 @@ describe('type: script', () => {
                 'returned template JSON of retrieveAsTemplate was not equal expected'
             );
             expect(
-                file(testUtils.getActualTemplateFile('testExisting_script', 'script', 'ssjs'))
-            ).to.equal(file(testUtils.getExpectedFile('9999999', 'script', 'template', 'ssjs')));
+                await testUtils.getActualTemplateFile('testExisting_script', 'script', 'ssjs')
+            ).to.equal(await testUtils.getExpectedFile('9999999', 'script', 'template', 'ssjs'));
             // THEN
             await handler.buildDefinition(
                 'testInstance/testBU',
                 'script',
-                'testExisting_script',
+                ['testExisting_script'],
                 'testTargetMarket'
             );
-            assert.equal(
-                process.exitCode,
-                false,
-                'buildDefinition should not have thrown an error'
-            );
+            assert.equal(process.exitCode, 0, 'buildDefinition should not have thrown an error');
 
             assert.deepEqual(
                 await testUtils.getActualDeployJson('testTemplated_script', 'script'),
@@ -306,8 +307,8 @@ describe('type: script', () => {
                 'returned deployment JSON was not equal expected'
             );
             expect(
-                file(testUtils.getActualDeployFile('testTemplated_script', 'script', 'ssjs'))
-            ).to.equal(file(testUtils.getExpectedFile('9999999', 'script', 'build', 'ssjs')));
+                await testUtils.getActualDeployFile('testTemplated_script', 'script', 'ssjs')
+            ).to.equal(await testUtils.getExpectedFile('9999999', 'script', 'build', 'ssjs'));
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
@@ -316,6 +317,7 @@ describe('type: script', () => {
             );
             return;
         });
+
         it('Should create a script template via buildTemplate and build it', async () => {
             // download first before we test buildTemplate
             await handler.retrieve('testInstance/testBU', ['script']);
@@ -327,7 +329,7 @@ describe('type: script', () => {
                 'testSourceMarket'
             );
             // WHEN
-            assert.equal(process.exitCode, false, 'buildTemplate should not have thrown an error');
+            assert.equal(process.exitCode, 0, 'buildTemplate should not have thrown an error');
 
             assert.equal(
                 result.script ? Object.keys(result.script).length : 0,
@@ -340,20 +342,16 @@ describe('type: script', () => {
                 'returned template JSON of buildTemplate was not equal expected'
             );
             expect(
-                file(testUtils.getActualTemplateFile('testExisting_script', 'script', 'ssjs'))
-            ).to.equal(file(testUtils.getExpectedFile('9999999', 'script', 'template', 'ssjs')));
+                await testUtils.getActualTemplateFile('testExisting_script', 'script', 'ssjs')
+            ).to.equal(await testUtils.getExpectedFile('9999999', 'script', 'template', 'ssjs'));
             // THEN
             await handler.buildDefinition(
                 'testInstance/testBU',
                 'script',
-                'testExisting_script',
+                ['testExisting_script'],
                 'testTargetMarket'
             );
-            assert.equal(
-                process.exitCode,
-                false,
-                'buildDefinition should not have thrown an error'
-            );
+            assert.equal(process.exitCode, 0, 'buildDefinition should not have thrown an error');
 
             assert.deepEqual(
                 await testUtils.getActualDeployJson('testTemplated_script', 'script'),
@@ -361,8 +359,8 @@ describe('type: script', () => {
                 'returned deployment JSON was not equal expected'
             );
             expect(
-                file(testUtils.getActualDeployFile('testTemplated_script', 'script', 'ssjs'))
-            ).to.equal(file(testUtils.getExpectedFile('9999999', 'script', 'build', 'ssjs')));
+                await testUtils.getActualDeployFile('testTemplated_script', 'script', 'ssjs')
+            ).to.equal(await testUtils.getExpectedFile('9999999', 'script', 'build', 'ssjs'));
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
@@ -372,7 +370,22 @@ describe('type: script', () => {
             return;
         });
     });
-    describe('Delete ================', () => {});
+
+    describe('Delete ================', () => {
+        it('Should delete the item', async () => {
+            // WHEN
+            const isDeleted = await handler.deleteByKey(
+                'testInstance/testBU',
+                'script',
+                'testExisting_script'
+            );
+            // THEN
+            assert.equal(process.exitCode, 0, 'deleteByKey should not have thrown an error');
+            assert.equal(isDeleted, true, 'deleteByKey should have returned true');
+            return;
+        });
+    });
+
     describe('CI/CD ================', () => {
         it('Should return a list of files based on their type and key', async () => {
             // WHEN
@@ -380,11 +393,7 @@ describe('type: script', () => {
                 'testExisting_script',
             ]);
             // THEN
-            assert.equal(
-                process.exitCode,
-                false,
-                'getFilesToCommit should not have thrown an error'
-            );
+            assert.equal(process.exitCode, 0, 'getFilesToCommit should not have thrown an error');
             assert.equal(fileList.length, 3, 'expected only 3 file paths (html, json, ssjs)');
 
             assert.equal(
@@ -405,5 +414,215 @@ describe('type: script', () => {
             return;
         });
     });
+
     describe('Execute ================', () => {});
+
+    describe('ReplaceContentBlockByX ================', () => {
+        it('Should replace references with ContentBlockByName w/o deploy', async () => {
+            handler.setOptions({ skipDeploy: true });
+
+            // WHEN
+            const replace = await handler.replaceCbReference(
+                'testInstance/testBU',
+                {
+                    script: null,
+                },
+                'name'
+            );
+            // THEN
+            assert.equal(process.exitCode, 0, 'retrieve should not have thrown an error');
+            // retrieve result
+            assert.deepEqual(
+                replace['testInstance/testBU'].script,
+                ['testExisting_script_ampincluded', 'testExisting_script_mixed'],
+                'should have found the right scripts that need updating'
+            );
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.script ? Object.keys(result.script).length : 0,
+                5,
+                'only 5 scripts expected'
+            );
+            // check if conversions happened
+            expect(
+                await testUtils.getActualFile('testExisting_script_ampscript', 'script', 'html')
+            ).to.equal(
+                await testUtils.getExpectedFile(
+                    '9999999',
+                    'script',
+                    'get_ampscript-rcb-name',
+                    'html'
+                )
+            );
+            expect(await testUtils.getActualFile('testExisting_script_ampscript', 'script', 'ssjs'))
+                .to.not.exist;
+
+            expect(
+                await testUtils.getActualFile('testExisting_script_ampincluded', 'script', 'html')
+            ).to.equal(
+                await testUtils.getExpectedFile(
+                    '9999999',
+                    'script',
+                    'get_ampincluded-rcb-name',
+                    'html'
+                )
+            );
+            expect(
+                await testUtils.getActualFile('testExisting_script_ampincluded', 'script', 'ssjs')
+            ).to.not.exist;
+
+            expect(
+                await testUtils.getActualFile('testExisting_script_mixed', 'script', 'html')
+            ).to.equal(
+                await testUtils.getExpectedFile('9999999', 'script', 'get_mixed-rcb-name', 'html')
+            );
+            expect(await testUtils.getActualFile('testExisting_script_mixed', 'script', 'ssjs')).to
+                .not.exist;
+
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                15,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+
+        it('Should replace references with ContentBlockById w/o deploy', async () => {
+            handler.setOptions({ skipDeploy: true });
+
+            // WHEN
+            const replace = await handler.replaceCbReference(
+                'testInstance/testBU',
+                {
+                    script: null,
+                },
+                'id'
+            );
+            // THEN
+            assert.equal(process.exitCode, 0, 'retrieve should not have thrown an error');
+            // retrieve result
+            assert.deepEqual(
+                replace['testInstance/testBU'].script,
+                ['testExisting_script_ampscript', 'testExisting_script_mixed'],
+                'should have found the right scripts that need updating'
+            );
+
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.script ? Object.keys(result.script).length : 0,
+                5,
+                'only 5 scripts expected'
+            );
+            // check if conversions happened
+            expect(
+                await testUtils.getActualFile('testExisting_script_ampscript', 'script', 'html')
+            ).to.equal(
+                await testUtils.getExpectedFile('9999999', 'script', 'get_ampscript-rcb-id', 'html')
+            );
+            expect(await testUtils.getActualFile('testExisting_script_ampscript', 'script', 'ssjs'))
+                .to.not.exist;
+
+            expect(
+                await testUtils.getActualFile('testExisting_script_ampincluded', 'script', 'html')
+            ).to.equal(
+                await testUtils.getExpectedFile(
+                    '9999999',
+                    'script',
+                    'get_ampincluded-rcb-id',
+                    'html'
+                )
+            );
+            expect(
+                await testUtils.getActualFile('testExisting_script_ampincluded', 'script', 'ssjs')
+            ).to.not.exist;
+
+            expect(
+                await testUtils.getActualFile('testExisting_script_mixed', 'script', 'html')
+            ).to.equal(
+                await testUtils.getExpectedFile('9999999', 'script', 'get_mixed-rcb-id', 'html')
+            );
+            expect(await testUtils.getActualFile('testExisting_script_mixed', 'script', 'ssjs')).to
+                .not.exist;
+
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                15,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+
+        it('Should replace references with ContentBlockByKey w/o deploy', async () => {
+            handler.setOptions({ skipDeploy: true });
+
+            // WHEN
+            const replace = await handler.replaceCbReference(
+                'testInstance/testBU',
+                {
+                    script: null,
+                },
+                'key'
+            );
+            // THEN
+            assert.equal(process.exitCode, 0, 'retrieve should not have thrown an error');
+            // retrieve result
+            assert.deepEqual(
+                replace['testInstance/testBU'].script,
+                ['testExisting_script_ampscript', 'testExisting_script_ampincluded'],
+                'should have found the right scripts that need updating'
+            );
+
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.script ? Object.keys(result.script).length : 0,
+                5,
+                'only 5 scripts expected'
+            );
+            // check if conversions happened
+            expect(
+                await testUtils.getActualFile('testExisting_script_ampscript', 'script', 'html')
+            ).to.equal(
+                await testUtils.getExpectedFile(
+                    '9999999',
+                    'script',
+                    'get_ampscript-rcb-key',
+                    'html'
+                )
+            );
+            expect(await testUtils.getActualFile('testExisting_script_ampscript', 'script', 'ssjs'))
+                .to.not.exist;
+
+            expect(
+                await testUtils.getActualFile('testExisting_script_ampincluded', 'script', 'html')
+            ).to.equal(
+                await testUtils.getExpectedFile(
+                    '9999999',
+                    'script',
+                    'get_ampincluded-rcb-key',
+                    'html'
+                )
+            );
+            expect(
+                await testUtils.getActualFile('testExisting_script_ampincluded', 'script', 'ssjs')
+            ).to.not.exist;
+
+            expect(
+                await testUtils.getActualFile('testExisting_script_mixed', 'script', 'html')
+            ).to.equal(
+                await testUtils.getExpectedFile('9999999', 'script', 'get_mixed-rcb-key', 'html')
+            );
+            expect(await testUtils.getActualFile('testExisting_script_mixed', 'script', 'ssjs')).to
+                .not.exist;
+
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                15,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
 });