@squiz/dxp-cli-next 5.10.0-develop.1 → 5.10.0-develop.11

package/lib/datastore/simulator/pause/pause.spec.js

@@ -0,0 +1,90 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const pause_1 = __importDefault(require("./pause"));
+const utils = __importStar(require("../utils"));
+const logSpy = jest.spyOn(global.console, 'log');
+const exitSpy = jest.spyOn(process, 'exit').mockImplementation(() => {
+    return undefined;
+}); // prevent process exit on error
+beforeEach(() => {
+    jest.resetAllMocks();
+});
+describe('datastoreSimulatorPause', () => {
+    it('should pause a simulator', () => __awaiter(void 0, void 0, void 0, function* () {
+        const checkUpdateAvailableSpy = jest
+            .spyOn(utils, 'checkUpdateAvailable')
+            .mockImplementation(() => {
+            return Promise.resolve(null);
+        });
+        const forcePromptSpy = jest
+            .spyOn(utils, 'forcePrompt')
+            .mockResolvedValue(true);
+        let executeCommandCount = 0;
+        const executeCommandSpy = jest
+            .spyOn(utils, 'executeCommand')
+            .mockImplementation((cmd, opt) => {
+            executeCommandCount++;
+            switch (executeCommandCount) {
+                case 1:
+                    expect(cmd).toStrictEqual('docker -v');
+                    return Promise.resolve('Docker version 20.10.23, build 7155243');
+                case 2:
+                    expect(cmd).toStrictEqual('docker stop datastore-sim-119726bb');
+                    return Promise.resolve('');
+            }
+            return Promise.reject(false);
+        });
+        const program = (0, pause_1.default)();
+        const commandErrorSpy = jest.spyOn(program, 'error');
+        yield program.parseAsync([
+            'node',
+            'dxp-cli',
+            'datastore',
+            'simulator',
+            'pause',
+            '-b',
+            '/path/to/blueprint.yaml',
+        ]);
+        const opts = program.opts();
+        expect(opts.blueprint).toEqual('/path/to/blueprint.yaml');
+        expect(checkUpdateAvailableSpy).toHaveBeenCalledTimes(1);
+        expect(commandErrorSpy).not.toHaveBeenCalled();
+        expect(logSpy).toHaveBeenCalledTimes(1);
+        expect(executeCommandSpy).toHaveBeenCalledTimes(2);
+    }));
+});

package/lib/datastore/simulator/remove/remove.js

@@ -42,7 +42,7 @@ const createRemoveCommand = () => {
                 }
             }
             spinner.start('Removing simulator blueprint.');
-            const { fullPath, dirPath, yamlFile, containerName } = (0, utils_2.getSimulatorDetails)(options.blueprint);
+            const { containerName } = (0, utils_2.getSimulatorDetails)(options.blueprint);
             const containerCommand = yield (0, utils_2.executeCommand)(`docker ps -a --filter "name=${containerName}" --format "{{.Names}}"`);
             if (containerCommand === '') {
                 throw new Error('Sorry, no simulator container found for that blueprint path. Please try again using a different path.');

package/lib/datastore/simulator/resume/resume.d.ts

@@ -0,0 +1,3 @@
+import { Command } from 'commander';
+declare const createResumeCommand: () => Command;
+export default createResumeCommand;

package/lib/datastore/simulator/resume/resume.js

@@ -0,0 +1,85 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const chalk_1 = __importDefault(require("chalk"));
+const ora_1 = __importDefault(require("ora"));
+const utils_1 = require("../../utils");
+const utils_2 = require("../utils");
+const createResumeCommand = () => {
+    const resumeCommand = new commander_1.Command('resume')
+        .name('resume')
+        .description('Resumes the simulator')
+        .addOption(new commander_1.Option('-b, --blueprint <string>', 'Path to your datastore API yaml file.'))
+        .configureOutput({
+        outputError(str, write) {
+            write(chalk_1.default.red(str));
+        },
+    })
+        .action((options) => __awaiter(void 0, void 0, void 0, function* () {
+        yield (0, utils_1.throwErrorIfNotLoggedIn)(resumeCommand);
+        console.log('');
+        if (options.blueprint !== undefined) {
+            const { fullPath, dirPath, yamlFile, containerName } = (0, utils_2.getSimulatorDetails)(options.blueprint);
+            const command = `docker start ${containerName}`;
+            const spinner = (0, ora_1.default)();
+            try {
+                yield (0, utils_2.checkUpdateAvailable)();
+                spinner.start('Resuming simulator.');
+                yield (0, utils_2.checkDockerInstalled)();
+                yield (0, utils_2.executeCommand)(command);
+                spinner.succeed(`Done! Container ID “${containerName}” resumed.`);
+                return;
+            }
+            catch (error) {
+                const errorMsg = 'Did not resume because of an unexpected error. Ask for help in our support forums.';
+                (0, utils_1.logDebug)(`ERROR: ${JSON.stringify(error)}`);
+                spinner.fail(errorMsg);
+                (0, utils_1.handleCommandError)(resumeCommand, error);
+            }
+        }
+        else {
+            const command = 'docker ps --filter "name=datastore-sim-*" --filter "status=exited" --format "{{.Names}}"';
+            const spinner = (0, ora_1.default)();
+            try {
+                yield (0, utils_2.checkUpdateAvailable)();
+                spinner.start('Resuming all simulators.');
+                yield (0, utils_2.checkDockerInstalled)();
+                const containerCommand = yield (0, utils_2.executeCommand)(command);
+                if (containerCommand === '') {
+                    throw new Error('Sorry, all simulators are already running.');
+                }
+                const containers = containerCommand.split(/\s+/).join(' ');
+                const results = yield (0, utils_2.executeCommand)(`docker start ${containers}`);
+                results.split(/\s+/).forEach((result) => {
+                    if (result !== '') {
+                        spinner.succeed(`Done! Container ID “${result}” paused.`);
+                    }
+                });
+                return;
+            }
+            catch (error) {
+                const errorMsg = 'Did not resume because of an unexpected error. Ask for help in our support forums.';
+                (0, utils_1.logDebug)(`ERROR: ${JSON.stringify(error)}`);
+                spinner.fail(errorMsg);
+                (0, utils_1.handleCommandError)(resumeCommand, error);
+            }
+        }
+    }));
+    if (process.env.ENABLE_OVERRIDE_DATASTORE_URL === 'true') {
+        resumeCommand.addOption(new commander_1.Option('-i, --image <string>', 'Override the docker image'));
+    }
+    return resumeCommand;
+};
+exports.default = createResumeCommand;

package/lib/datastore/simulator/resume/resume.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/datastore/simulator/resume/resume.spec.js

@@ -0,0 +1,90 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const resume_1 = __importDefault(require("./resume"));
+const utils = __importStar(require("../utils"));
+const logSpy = jest.spyOn(global.console, 'log');
+const exitSpy = jest.spyOn(process, 'exit').mockImplementation(() => {
+    return undefined;
+}); // prevent process exit on error
+beforeEach(() => {
+    jest.resetAllMocks();
+});
+describe('datastoreSimulatorResume', () => {
+    it('should resume a simulator', () => __awaiter(void 0, void 0, void 0, function* () {
+        const checkUpdateAvailableSpy = jest
+            .spyOn(utils, 'checkUpdateAvailable')
+            .mockImplementation(() => {
+            return Promise.resolve(null);
+        });
+        const forcePromptSpy = jest
+            .spyOn(utils, 'forcePrompt')
+            .mockResolvedValue(true);
+        let executeCommandCount = 0;
+        const executeCommandSpy = jest
+            .spyOn(utils, 'executeCommand')
+            .mockImplementation((cmd, opt) => {
+            executeCommandCount++;
+            switch (executeCommandCount) {
+                case 1:
+                    expect(cmd).toStrictEqual('docker -v');
+                    return Promise.resolve('Docker version 20.10.23, build 7155243');
+                case 2:
+                    expect(cmd).toStrictEqual('docker start datastore-sim-119726bb');
+                    return Promise.resolve('');
+            }
+            return Promise.reject(false);
+        });
+        const program = (0, resume_1.default)();
+        const commandErrorSpy = jest.spyOn(program, 'error');
+        yield program.parseAsync([
+            'node',
+            'dxp-cli',
+            'datastore',
+            'simulator',
+            'resume',
+            '-b',
+            '/path/to/blueprint.yaml',
+        ]);
+        const opts = program.opts();
+        expect(opts.blueprint).toEqual('/path/to/blueprint.yaml');
+        expect(checkUpdateAvailableSpy).toHaveBeenCalledTimes(1);
+        expect(commandErrorSpy).not.toHaveBeenCalled();
+        expect(logSpy).toHaveBeenCalledTimes(1);
+        expect(executeCommandSpy).toHaveBeenCalledTimes(2);
+    }));
+});

package/lib/datastore/simulator/simulatorCommand.js

@@ -6,12 +6,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const commander_1 = require("commander");
 const add_1 = __importDefault(require("./add/add"));
 const remove_1 = __importDefault(require("./remove/remove"));
+const list_1 = __importDefault(require("./list/list"));
+const clear_1 = __importDefault(require("./clear/clear"));
+const upgrade_1 = __importDefault(require("./upgrade/upgrade"));
+const pause_1 = __importDefault(require("./pause/pause"));
+const resume_1 = __importDefault(require("./resume/resume"));
 const createSimulatorCommand = () => {
     const datastoreSimulatorCommand = new commander_1.Command('simulator');
     datastoreSimulatorCommand
         .description('Datastore Simulator Commands')
         .addCommand((0, add_1.default)())
-        .addCommand((0, remove_1.default)());
+        .addCommand((0, remove_1.default)())
+        .addCommand((0, list_1.default)())
+        .addCommand((0, clear_1.default)())
+        .addCommand((0, upgrade_1.default)())
+        .addCommand((0, pause_1.default)())
+        .addCommand((0, resume_1.default)());
     return datastoreSimulatorCommand;
 };
 exports.default = createSimulatorCommand;

package/lib/datastore/simulator/upgrade/upgrade.d.ts

@@ -0,0 +1,3 @@
+import { Command } from 'commander';
+declare const createUpgradeCommand: () => Command;
+export default createUpgradeCommand;

package/lib/datastore/simulator/upgrade/upgrade.js

@@ -0,0 +1,160 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const chalk_1 = __importDefault(require("chalk"));
+const ora_1 = __importDefault(require("ora"));
+const utils_1 = require("../../utils");
+const utils_2 = require("../utils");
+const path_1 = require("path");
+const ApplicationStore_1 = require("../../../ApplicationStore");
+const ApiService_1 = require("../../../ApiService");
+function getCurrentLatest() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const dockerAPI = 'https://registry.hub.docker.com/v2/repositories/squizdxp/datastore/tags/latest';
+        const apiService = new ApiService_1.ApiService(utils_1.validateAxiosStatus);
+        apiService.client.interceptors.request.clear();
+        apiService.client.interceptors.response.clear();
+        const dockerFetch = yield apiService.client.get(dockerAPI);
+        const dockerResponse = dockerFetch.data;
+        return dockerResponse.images[0].digest || null;
+    });
+}
+function upgradeContainer(container, tempFolder, dockerDigest) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (container === '') {
+            return;
+        }
+        const upgradeSpinner = (0, ora_1.default)();
+        const results = container.split('~');
+        const containerName = results[0] || '';
+        const labels = results[1].split(',');
+        let blueprint = '';
+        let port = '';
+        // Blueprint and port stored in label, extract them.
+        labels.forEach(label => {
+            if (label.startsWith('blueprint=') === true) {
+                blueprint = label.replace('blueprint=', '');
+            }
+            if (label.startsWith('port=') === true) {
+                port = label.replace('port=', '');
+            }
+        });
+        const status = results[2].toLowerCase().split(' ')[0] || '';
+        const host = '0.0.0.0';
+        const dirPath = (0, path_1.dirname)(blueprint);
+        try {
+            console.log('');
+            upgradeSpinner.start(`Upgrading Container ID "${containerName}"`);
+            yield (0, utils_2.executeCommand)(`mkdir ${tempFolder}/${containerName}`);
+            yield (0, utils_2.executeCommand)(`docker start ${containerName} > /dev/null`);
+            // Backup data from container.
+            yield (0, utils_2.executeCommand)(`docker cp ${containerName}:/var/www/data ${tempFolder}/${containerName}/`);
+            // Kill old container.
+            yield (0, utils_2.executeCommand)(`docker rm -f ${containerName} > /dev/null`);
+            // Run a new container.
+            yield (0, utils_2.executeCommand)(`docker run -l "blueprint=${blueprint}" -l "port=${port}" -itd --name ${containerName} -p ${host}:${port}:80 -e MYHOST=${host} -e MYPORT=${port} -e BLUEPRINT=${blueprint} -v "${dirPath}":/var/www/instances ${utils_2.datastoreRepo}`);
+            // Restore data folder.
+            yield (0, utils_2.executeCommand)(`docker cp ${tempFolder}/${containerName}/data ${containerName}:/var/www/`);
+            const simulatorVersion = yield (0, utils_2.executeCommand)(`docker image inspect ${utils_2.datastoreRepo} --format '{{ or (index .Config.Labels "squiz.datastore.version") (printf "Unknown") }}'`);
+            const upgradedVersion = simulatorVersion.replace(/\r?\n|\r/g, '');
+            const containerDataCmd = yield (0, utils_2.executeCommand)(`docker exec ${containerName} cat /var/www/data/containerData.json`);
+            const containerData = JSON.parse(containerDataCmd);
+            containerData.imageVersion = upgradedVersion;
+            containerData.imageDigest = dockerDigest;
+            const jsonData = JSON.stringify(containerData, null, 4).replace(/"/g, '\\"');
+            yield (0, utils_2.executeCommand)(`docker exec -i ${containerName} bash -c "echo '${jsonData}' > /var/www/data/containerData.json"`);
+        }
+        catch (error) {
+            upgradeSpinner.fail(`Unable to upgrade simulator Container ID "${containerName}"`);
+            throw new Error(`Unable to upgrade simulator Container ID "${containerName}"`);
+        }
+        // Wipe simulator data.
+        upgradeSpinner.succeed(`Done! Container ID "${containerName}" upgraded.`);
+        yield (0, utils_2.executeCommand)(`docker exec ${containerName} bash -c "rm -rf /var/www/data/storage;  rm -rf /var/www/data/provision/**/oven"`);
+        if (status.includes('exit') === true) {
+            // If it was paused, stop it again.
+            yield (0, utils_2.executeCommand)(`docker stop ${containerName}`);
+        }
+    });
+}
+const createUpgradeCommand = () => {
+    const upgradeCommand = new commander_1.Command('upgrade')
+        .name('upgrade')
+        .description('Removes a datastore simulator')
+        .addOption(new commander_1.Option('-f, --force', 'Force the removal of the datastore simulator'))
+        .configureOutput({
+        outputError(str, write) {
+            write(chalk_1.default.red(str));
+        },
+    })
+        .action((options) => __awaiter(void 0, void 0, void 0, function* () {
+        console.log('');
+        const spinner = (0, ora_1.default)();
+        try {
+            yield (0, utils_2.checkDockerInstalled)();
+            const forceMessage = 'This will wipe all test data for all of your simulated blueprints. Are you sure you want to continue? (y/N)';
+            if (!options.force) {
+                if ((yield (0, utils_2.forcePrompt)(forceMessage, false)) === false) {
+                    const removeGuide = 'To upgrade run:\n    $ dxp-next datastore simulator upgrade --force\n';
+                    throw new Error(removeGuide);
+                }
+            }
+            spinner.start('Upgrading all simulator containers.');
+            yield (0, ApplicationStore_1.deleteApplicationFile)(utils_2.datastoreSimulatorCache);
+            const currentLatest = yield getCurrentLatest();
+            const currentDigest = yield (0, utils_2.executeCommand)(`docker image inspect ${utils_2.datastoreRepo} --format "{{ index .RepoDigests }}"`);
+            if (currentDigest.slice(20).startsWith(currentLatest) === true) {
+                // Nothing to do here.
+                spinner.succeed('Simulator already up to date');
+                return;
+            }
+            const dockerDigest = currentDigest;
+            let currentVersion = '';
+            let upgradedVersion = '';
+            let simulatorVersion = yield (0, utils_2.executeCommand)(`docker image inspect ${utils_2.datastoreRepo} --format '{{ or (index .Config.Labels "squiz.datastore.version") (printf "Unknown") }}'`);
+            currentVersion = simulatorVersion.replace(/\r?\n|\r/g, '');
+            const containersToUpgrade = yield (0, utils_2.executeCommand)('docker ps -a --filter "name=datastore-sim-*" --format "{{.Names}}~{{.Labels}}~{{.Status}}~{{.Ports}}#"');
+            if (containersToUpgrade === '') {
+                throw new Error('Sorry, could not find any simulators.');
+            }
+            spinner.text = 'Downloading latest simulator image.';
+            try {
+                yield (0, utils_2.executeCommand)(`docker pull ${utils_2.datastoreRepo}`);
+            }
+            catch (error) {
+                throw new Error('Sorry, could not download simulator image. Ask for help in our support forums.');
+            }
+            const mkdirTemp = yield (0, utils_2.executeCommand)('mktemp -d -t datastore-XXXXXXXXXX');
+            const tempFolder = mkdirTemp.replace(/\s+$/, '');
+            spinner.text = 'Restarting containers.';
+            yield Promise.all(containersToUpgrade.split(/#\s+/).map((container) => __awaiter(void 0, void 0, void 0, function* () {
+                return yield upgradeContainer(container, tempFolder, dockerDigest);
+            })));
+            simulatorVersion = yield (0, utils_2.executeCommand)(`docker image inspect ${utils_2.datastoreRepo} --format '{{ or (index .Config.Labels "squiz.datastore.version") (printf "Unknown") }}'`);
+            upgradedVersion = simulatorVersion.replace(/\r?\n|\r/g, '');
+            spinner.succeed(`All simulator containers have successfully been upgraded from ${currentVersion} to ${upgradedVersion}.`);
+            // Remove temp backup folder.
+            (0, utils_2.executeCommand)(`rm -rf ${tempFolder}`);
+            return;
+        }
+        catch (error) {
+            (0, utils_1.logDebug)(`ERROR: ${JSON.stringify(error)}`);
+            spinner.fail();
+            (0, utils_1.handleCommandError)(upgradeCommand, error);
+        }
+    }));
+    return upgradeCommand;
+};
+exports.default = createUpgradeCommand;

package/lib/datastore/simulator/upgrade/upgrade.spec.d.ts

@@ -0,0 +1 @@
+export {};