@squiz/dxp-cli-next 5.17.0-develop.2 → 5.17.0-develop.4

package/README.md

@@ -25,5 +25,7 @@ Commands:
   job-runner     Job Runner Service Commands
   datastore      Datastore Service Commands
   cdp            Customer Data Platform Service Commands
-  porter         Porter Service Commands
 ```
+
+<!-- TODO: porter command is hidden behind feature flag -->
+<!-- porter         Porter Service Commands -->

package/lib/__tests__/integration/main.spec.js

@@ -9,6 +9,22 @@ describe('dxp', () => {
     it('should show all available commands', () => {
         var _a;
         const { stdout } = (0, helpers_1.runCLI)(process.cwd(), ['--help']);
+        const commandsText = (_a = stdout
+            .match(/Commands\:(.*)/is)) === null || _a === void 0 ? void 0 : _a[1].split('\n').map(a => a.trim()).filter(a => !!a);
+        expect(commandsText).toEqual([
+            'auth           Authenticate into the DXP-Next CLI',
+            'cmp            Component Service Commands',
+            'job-runner     Job Runner Service Commands',
+            'datastore      Datastore Service Commands',
+            'cdp            Customer Data Platform Service Commands',
+            // TODO: Porter is hidden behind feature flag.
+            // 'porter         Porter Service Commands',
+        ]);
+    });
+    it('if ENABLE_PORTER set to true, porter command should be visible', () => {
+        var _a;
+        process.env.ENABLE_PORTER = 'true';
+        const { stdout } = (0, helpers_1.runCLI)(process.cwd(), ['--help']);
         const commandsText = (_a = stdout
             .match(/Commands\:(.*)/is)) === null || _a === void 0 ? void 0 : _a[1].split('\n').map(a => a.trim()).filter(a => !!a);
         expect(commandsText).toEqual([

package/lib/datastore/simulator/add/add.js

@@ -95,10 +95,6 @@ const createAddCommand = () => {
                 }
             }
             spinner.text = 'Installing and simulating new blueprint.';
-            const installCommand = yield (0, utils_2.executeCommand)(`docker exec -i ${containerName} install simulator:${yamlFile} --output=json`);
-            const obj = JSON.parse(installCommand);
-            const url = obj[0].URL;
-            const jwtUrl = obj[0].jwtURL;
             const versionDetailsCommand = yield (0, utils_2.executeCommand)(`docker image inspect ${utils_2.datastoreRepo} --format "{{ index .RepoDigests }}"`);
             versionDetails.digest = versionDetailsCommand.replace(/\r?\n|\r/g, '');
             versionDetails.digest = versionDetails.digest.slice(20, -1);
@@ -107,21 +103,11 @@ const createAddCommand = () => {
                 ' --format \'{{ or (index .Config.Labels "squiz.datastore.version") (printf "Unknown") }}\'';
             const imageVersion = yield (0, utils_2.executeCommand)(simulatorVersionCmd);
             versionDetails.version = imageVersion.replace(/\r?\n|\r/g, '');
-            // Store those info in a file on container, easier to fetch.
-            const data = {
-                blueprint: `${fullPath}`,
-                container: `${containerName}`,
-                imageDigest: `${versionDetails.digest}`,
-                imageVersion: `${versionDetails.version}`,
-                jwt: `${jwtUrl}`,
-                url: `${url}`,
-            };
-            const jsonData = JSON.stringify(data, null, 4).replace(/"/g, '\\"');
-            yield (0, utils_2.executeCommand)(`docker exec -i ${containerName} bash -c "echo '${jsonData}' > /var/www/data/containerData.json"`);
+            const response = yield (0, utils_2.writeSimulatorContainerData)(containerName, fullPath, versionDetails.digest, versionDetails.version);
             spinner.succeed('Done! Use these details for local querying:');
             console.log('');
-            console.log(`    URL: ${url}`);
-            console.log(`    JWT URL: ${jwtUrl}`);
+            console.log(`    URL: ${response.url}`);
+            console.log(`    JWT URL: ${response.jwtUrl}`);
             console.log('');
             return;
         }

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

@@ -50,6 +50,14 @@ describe('datastoreSimulatorAdd', () => {
             .mockImplementation(() => {
             return Promise.resolve(null);
         });
+        const writeSimulatorContainerDataSpy = jest
+            .spyOn(utils, 'writeSimulatorContainerData')
+            .mockImplementation((containerName, fullPath, digest, version) => {
+            return Promise.resolve({
+                url: 'http://0.0.0.0:9999',
+                jwtUrl: 'http://0.0.0.0:9999/__JWT/issueToken',
+            });
+        });
         let executeCommandCount = 0;
         const executeCommandSpy = jest
             .spyOn(utils, 'executeCommand')
@@ -68,29 +76,11 @@ describe('datastoreSimulatorAdd', () => {
                     expect(cmd).toStrictEqual('docker run -l "blueprint=/path/to/blueprint.yaml" -l "port=9999" -itd --name datastore-sim-119726bb          -p 0.0.0.0:9999:80           -e MYHOST=0.0.0.0 -e MYPORT=9999 -e BLUEPRINT=/path/to/blueprint.yaml           -v "/path/to":/var/www/instances           squizdxp/datastore:latest');
                     return Promise.resolve('');
                 case 4:
-                    expect(cmd).toStrictEqual('docker exec -i datastore-sim-119726bb install simulator:blueprint.yaml --output=json');
-                    return Promise.resolve(JSON.stringify([
-                        {
-                            URL: 'http://0.0.0.0:9999',
-                            jwtURL: 'http://0.0.0.0:9999/__JWT/issueToken',
-                        },
-                    ]));
-                case 5:
                     expect(cmd).toStrictEqual('docker image inspect squizdxp/datastore:latest --format "{{ index .RepoDigests }}"');
                     return Promise.resolve('[squizdxp/datastore@sha256:bd61f8f80d9f235d81477454cf512a6edede0ae6d2d0a8c0508956db2418dbe0]');
-                case 6:
+                case 5:
                     expect(cmd).toStrictEqual('docker image inspect squizdxp/datastore:latest --format \'{{ or (index .Config.Labels "squiz.datastore.version") (printf "Unknown") }}\'');
-                    return Promise.resolve('4.0.1');
-                case 7:
-                    expect(cmd).toStrictEqual(`docker exec -i datastore-sim-119726bb bash -c "echo '${JSON.stringify({
-                        blueprint: '/path/to/blueprint.yaml',
-                        container: 'datastore-sim-119726bb',
-                        imageDigest: 'sha256:bd61f8f80d9f235d81477454cf512a6edede0ae6d2d0a8c0508956db2418dbe0',
-                        imageVersion: '4.0.1',
-                        jwt: 'http://0.0.0.0:9999/__JWT/issueToken',
-                        url: 'http://0.0.0.0:9999',
-                    }, null, 4).replace(/"/g, '\\"')}' > /var/www/data/containerData.json"`);
-                    return Promise.resolve('');
+                    return Promise.resolve('4.01');
             }
             return Promise.reject(false);
         });
@@ -119,5 +109,6 @@ describe('datastoreSimulatorAdd', () => {
         expect(logSpy).toHaveBeenCalledWith('    URL: http://0.0.0.0:9999');
         expect(logSpy).toHaveBeenCalledWith('    JWT URL: http://0.0.0.0:9999/__JWT/issueToken');
         expect(logSpy).toHaveBeenCalledWith('');
+        expect(writeSimulatorContainerDataSpy).toHaveBeenCalledWith('datastore-sim-119726bb', '/path/to/blueprint.yaml', 'sha256:bd61f8f80d9f235d81477454cf512a6edede0ae6d2d0a8c0508956db2418dbe0', '4.01');
     }));
 });

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

@@ -69,12 +69,7 @@ function upgradeContainer(container, tempFolder, dockerDigest) {
             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"`);
+            yield (0, utils_2.writeSimulatorContainerData)(containerName, blueprint, dockerDigest, upgradedVersion);
         }
         catch (error) {
             (0, utils_1.logDebug)(`ERROR: ${JSON.stringify(error)}`);

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

@@ -121,6 +121,7 @@ describe('datastoreSimulatorUpgrade', () => {
         const forcePromptSpy = jest
             .spyOn(utils, 'forcePrompt')
             .mockResolvedValue(true);
+        const writeSimulatorContainerDataSpy = jest.spyOn(utils, 'writeSimulatorContainerData');
         let executeCommandCount = 0;
         const executeCommandSpy = jest
             .spyOn(utils, 'executeCommand')
@@ -170,26 +171,10 @@ describe('datastoreSimulatorUpgrade', () => {
                 case 14:
                     expect(cmd).toStrictEqual('docker exec datastore-sim-6909fc2c cat /var/www/data/containerData.json');
                     return Promise.resolve('{}');
-                case 15:
-                    expect(cmd).toStrictEqual(`docker exec -i datastore-sim-6909fc2c bash -c "echo '{
-    \\"imageVersion\\": \\"4.0.1\\",
-    \\"imageDigest\\": \\"[squizdxp/datastore@sha256:bd61f8f80d9f235d81477454cf512a6edede0ae6d2d0a8c0508956db2418dbe1]\\"
-}' > /var/www/data/containerData.json"`);
-                    return Promise.resolve('');
-                case 16:
-                    expect(cmd).toStrictEqual('docker exec datastore-sim-6909fc2c bash -c "rm -rf /var/www/data/storage;  rm -rf /var/www/data/provision/**/oven"');
-                    return Promise.resolve('');
-                case 17:
-                    expect(cmd).toStrictEqual('docker image inspect squizdxp/datastore:latest --format \'{{ or (index .Config.Labels "squiz.datastore.version") (printf "Unknown") }}\'');
-                    return Promise.resolve('4.0.1');
-                case 18:
-                    expect(cmd).toStrictEqual('rm -rf /tmp/datastore-XXXXXXXXXX');
-                    return Promise.resolve('');
             }
             return Promise.reject(false);
         });
         const program = (0, upgrade_1.default)();
-        const commandErrorSpy = jest.spyOn(program, 'error');
         yield program.parseAsync([
             'node',
             'dxp-cli',
@@ -197,8 +182,9 @@ describe('datastoreSimulatorUpgrade', () => {
             'simulator',
             'upgrade',
         ]);
-        expect(forcePromptSpy).toHaveBeenCalledWith('This will wipe all test data for all of your simulated blueprints. Are you sure you want to continue? (y/N)', false);
         expect(logSpy).toHaveBeenCalledTimes(2);
-        expect(executeCommandSpy).toHaveBeenCalledTimes(18);
+        expect(executeCommandSpy).toHaveBeenCalledTimes(14);
+        expect(forcePromptSpy).toHaveBeenCalledWith('This will wipe all test data for all of your simulated blueprints. Are you sure you want to continue? (y/N)', false);
+        expect(writeSimulatorContainerDataSpy).toHaveBeenCalledWith('datastore-sim-6909fc2c', '/Users/pnolland/Documents/Work/GitRepos/blueprints/boilerplate/api.yaml', '[squizdxp/datastore@sha256:bd61f8f80d9f235d81477454cf512a6edede0ae6d2d0a8c0508956db2418dbe1]', '4.0.1');
     }));
 });

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

@@ -4,6 +4,10 @@ declare type datastoreVersionCache = {
     updatedAt: number;
     version: string;
 };
+interface WriteSimulatorContainerDataResponse {
+    url: string;
+    jwtUrl: string;
+}
 export declare const datastoreSimulatorCache: FileStore;
 export declare const datastoreRepo = "squizdxp/datastore:latest";
 export declare const allowedExtensions: string[];
@@ -21,4 +25,5 @@ export declare function getSimulatorDetails(blueprint: string): {
     yamlFile: string;
     containerName: string;
 };
+export declare const writeSimulatorContainerData: (containerName: string, blueprintPath: string, digest: string, version: string) => Promise<WriteSimulatorContainerDataResponse>;
 export {};

package/lib/datastore/simulator/utils.js

@@ -32,7 +32,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSimulatorDetails = exports.checkUpdateAvailable = exports.checkDockerInstalled = exports.forcePrompt = exports.promptForContinue = exports.stringHashShort = exports.executeCommand = exports.availablePorts = exports.host = exports.allowedExtensions = exports.datastoreRepo = exports.datastoreSimulatorCache = void 0;
+exports.writeSimulatorContainerData = exports.getSimulatorDetails = exports.checkUpdateAvailable = exports.checkDockerInstalled = exports.forcePrompt = exports.promptForContinue = exports.stringHashShort = exports.executeCommand = exports.availablePorts = exports.host = exports.allowedExtensions = exports.datastoreRepo = exports.datastoreSimulatorCache = void 0;
 const child_process_1 = require("child_process");
 const ApplicationStore_1 = require("../../ApplicationStore");
 const ApiService_1 = require("../../ApiService");
@@ -194,3 +194,23 @@ function getSimulatorDetails(blueprint) {
     };
 }
 exports.getSimulatorDetails = getSimulatorDetails;
+const writeSimulatorContainerData = (containerName, blueprintPath, digest, version) => __awaiter(void 0, void 0, void 0, function* () {
+    const yamlFile = (0, path_1.basename)(blueprintPath);
+    const installCommand = yield (0, exports.executeCommand)(`docker exec -i ${containerName} install simulator:${yamlFile} --output=json`);
+    const obj = JSON.parse(installCommand);
+    const url = obj[0].URL;
+    const jwtUrl = obj[0].jwtURL;
+    // Store those info in a file on container, easier to fetch.
+    const data = {
+        blueprint: `${blueprintPath}`,
+        container: `${containerName}`,
+        imageDigest: `${digest}`,
+        imageVersion: `${version}`,
+        jwt: `${jwtUrl}`,
+        url: `${url}`,
+    };
+    const jsonData = JSON.stringify(data, null, 4).replace(/"/g, '\\"');
+    yield (0, exports.executeCommand)(`docker exec -i ${containerName} bash -c "echo '${jsonData}' > /var/www/data/containerData.json"`);
+    return { url, jwtUrl };
+});
+exports.writeSimulatorContainerData = writeSimulatorContainerData;

package/lib/dxp.js

@@ -28,8 +28,11 @@ program
     .addCommand(cmp_1.default)
     .addCommand(job_runner_1.default)
     .addCommand(datastore_1.default)
-    .addCommand(cdp_1.default)
-    .addCommand(porter_1.default)
+    .addCommand(cdp_1.default);
+if (process.env.ENABLE_PORTER === 'true') {
+    program.addCommand(porter_1.default);
+}
+program
     .action(() => {
     program.help();
 })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/dxp-cli-next",
-  "version": "5.17.0-develop.2",
+  "version": "5.17.0-develop.4",
   "repository": {
     "url": "https://gitlab.squiz.net/dxp/dxp-cli-next"
   },