@squiz/dxp-cli-next 5.15.0-develop.1 → 5.15.0-develop.3

package/lib/porter/project/remove/remove.spec.js

@@ -31,27 +31,20 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         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 nock_1 = __importDefault(require("nock"));
-const remove_1 = __importDefault(require("./remove"));
 const axios_1 = require("axios");
-const ApiService = __importStar(require("../../../ApiService"));
 const Inquirer = __importStar(require("inquirer"));
-const BuildPorterUrl = __importStar(require("../../utils/BuildPorterUrl/BuildPorterUrl"));
-const ErrorUtils = __importStar(require("../../utils/ErrorUtils/ErrorUtils"));
-const GetProjectConfig = __importStar(require("../../utils/GetProjectConfig/GetProjectConfig"));
+const ApiService = __importStar(require("../../../ApiService"));
+const PorterUtils = __importStar(require("../../utils"));
 jest.mock('inquirer', () => {
     return {
         prompt: jest.fn(),
     };
 });
+jest.mock('../../utils');
 describe('removeProject', () => {
     let baseUrl;
     let projectName;
-    let projectConfig;
     let mockHandleCommandError;
     let mockHandleError;
     let mockBuildPorterUrl;
@@ -60,14 +53,8 @@ describe('removeProject', () => {
     beforeEach(() => {
         jest.resetAllMocks();
         jest.clearAllMocks();
-        nock_1.default.restore();
         projectName = 'porter-project';
         baseUrl = 'mock-url';
-        projectConfig = {
-            service: 'dxp-porter',
-            projectName,
-            version: '0.1.0',
-        };
         mockHandleCommandError = jest.fn(() => Promise.resolve());
         mockHandleError = jest.fn();
         mockBuildPorterUrl = jest.fn(() => Promise.resolve(baseUrl));
@@ -78,14 +65,18 @@ describe('removeProject', () => {
         mockClient = {
             delete: jest.fn().mockImplementationOnce(() => mockResponse),
         };
+        jest.spyOn(PorterUtils, 'throwErrorIfNotLoggedIn').mockImplementation();
         jest
-            .spyOn(BuildPorterUrl, 'buildPorterUrl')
+            .spyOn(PorterUtils, 'getProjectName')
+            .mockImplementationOnce(() => Promise.resolve(projectName));
+        jest
+            .spyOn(PorterUtils, 'buildPorterUrl')
             .mockImplementationOnce(mockBuildPorterUrl);
         jest
-            .spyOn(ErrorUtils, 'handleCommandError')
+            .spyOn(PorterUtils, 'handleCommandError')
             .mockImplementationOnce(mockHandleCommandError);
         jest
-            .spyOn(ErrorUtils, 'handleError')
+            .spyOn(PorterUtils, 'handleError')
             .mockImplementationOnce(mockHandleError);
         jest.spyOn(process, 'exit').mockImplementation();
         jest.spyOn(ApiService, 'ApiService').mockImplementationOnce(() => {
@@ -97,57 +88,32 @@ describe('removeProject', () => {
     it('should throw an error if not logged in', () => __awaiter(void 0, void 0, void 0, function* () {
         const mockError = new Error('Error not logged in');
         jest
-            .spyOn(ErrorUtils, 'throwErrorIfNotLoggedIn')
+            .spyOn(PorterUtils, 'throwErrorIfNotLoggedIn')
             .mockImplementationOnce(() => {
             throw mockError;
         });
-        (0, nock_1.default)('http://localhost:9999')
-            .get('/__dxp/au/porter/SquizRoot-0000/health')
-            .reply(401);
-        const program = (0, remove_1.default)();
+        const { default: createRemoveCommand } = require('./remove');
+        const program = createRemoveCommand();
         yield expect(() => program.parseAsync(['dxp-next', 'porter', 'project', 'removeProject'])).rejects.toThrow(mockError);
         const opts = program.opts();
         expect(opts).toStrictEqual({});
+        expect(PorterUtils.throwErrorIfNotLoggedIn).toHaveBeenCalled();
+        expect(PorterUtils.buildPorterUrl).not.toHaveBeenCalled();
     }));
-    it('should throw an error if not in a project directory', () => __awaiter(void 0, void 0, void 0, function* () {
-        jest.spyOn(ErrorUtils, 'throwErrorIfNotLoggedIn').mockImplementation();
-        jest
-            .spyOn(GetProjectConfig, 'getProjectConfig')
-            .mockImplementationOnce(() => {
-            throw new Error('You must be within a porter project directory to use this command');
+    it('should throw an error if project name could not be found', () => __awaiter(void 0, void 0, void 0, function* () {
+        jest.spyOn(PorterUtils, 'getProjectName').mockImplementationOnce(() => {
+            throw new Error();
         });
         const { default: createRemoveCommand } = require('./remove');
         const program = createRemoveCommand();
-        yield program.parseAsync([
-            'dxp-next',
-            'porter',
-            'project',
-            'removeProject',
-        ]);
-        expect(BuildPorterUrl.buildPorterUrl).toHaveBeenCalled();
-        expect(ErrorUtils.handleCommandError).toHaveBeenCalled();
-    }));
-    it('should throw an error if project name is missing in the config.json file', () => __awaiter(void 0, void 0, void 0, function* () {
-        jest.spyOn(ErrorUtils, 'throwErrorIfNotLoggedIn').mockImplementation();
-        jest
-            .spyOn(GetProjectConfig, 'getProjectConfig')
-            .mockImplementationOnce(() => Promise.resolve(Object.assign(Object.assign({}, projectConfig), { projectName: '' })));
-        const { default: createRemoveCommand } = require('./remove');
-        const program = createRemoveCommand();
-        yield program.parseAsync([
-            'dxp-next',
-            'porter',
-            'project',
-            'removeProject',
-        ]);
-        expect(BuildPorterUrl.buildPorterUrl).toHaveBeenCalled();
-        expect(ErrorUtils.handleCommandError).toHaveBeenCalled();
+        yield program.parseAsync(['dxp-next', 'porter', 'project', 'getProject']);
+        expect(PorterUtils.throwErrorIfNotLoggedIn).toHaveBeenCalled();
+        expect(PorterUtils.buildPorterUrl).toHaveBeenCalled();
+        expect(PorterUtils.getProjectName).toHaveBeenCalled();
+        expect(mockClient.delete).not.toHaveBeenCalled();
+        expect(PorterUtils.handleCommandError).toHaveBeenCalled();
     }));
     it('should end the program if the prompt was input with anything other than "y"', () => __awaiter(void 0, void 0, void 0, function* () {
-        jest.spyOn(ErrorUtils, 'throwErrorIfNotLoggedIn').mockImplementation();
-        jest
-            .spyOn(GetProjectConfig, 'getProjectConfig')
-            .mockImplementationOnce(() => Promise.resolve(projectConfig));
         jest.spyOn(Inquirer, 'prompt').mockImplementationOnce(() => Promise.resolve({
             answer: 'not-y',
         }));
@@ -159,15 +125,13 @@ describe('removeProject', () => {
             'project',
             'removeProject',
         ]);
-        expect(BuildPorterUrl.buildPorterUrl).toHaveBeenCalled();
+        expect(PorterUtils.throwErrorIfNotLoggedIn).toHaveBeenCalled();
+        expect(PorterUtils.buildPorterUrl).toHaveBeenCalled();
+        expect(PorterUtils.getProjectName).toHaveBeenCalled();
         expect(mockClient.delete).not.toHaveBeenCalled();
-        expect(ErrorUtils.handleCommandError).not.toHaveBeenCalled();
+        expect(PorterUtils.handleCommandError).not.toHaveBeenCalled();
     }));
     it('should throw an error if the project does not exist in the cloud', () => __awaiter(void 0, void 0, void 0, function* () {
-        jest.spyOn(ErrorUtils, 'throwErrorIfNotLoggedIn').mockImplementation();
-        jest
-            .spyOn(GetProjectConfig, 'getProjectConfig')
-            .mockImplementationOnce(() => Promise.resolve(projectConfig));
         jest.spyOn(Inquirer, 'prompt').mockImplementationOnce(() => Promise.resolve({
             answer: 'y',
         }));
@@ -184,15 +148,16 @@ describe('removeProject', () => {
             'project',
             'removeProject',
         ]);
-        expect(BuildPorterUrl.buildPorterUrl).toHaveBeenCalled();
+        expect(PorterUtils.throwErrorIfNotLoggedIn).toHaveBeenCalled();
+        expect(PorterUtils.buildPorterUrl).toHaveBeenCalled();
+        expect(PorterUtils.getProjectName).toHaveBeenCalled();
         expect(mockClient.delete).toHaveBeenCalled();
-        expect(ErrorUtils.handleError).toHaveBeenCalled();
+        expect(PorterUtils.handleError).toHaveBeenCalled();
     }));
     it('should successfully delete the project from the cloud', () => __awaiter(void 0, void 0, void 0, function* () {
-        jest.spyOn(ErrorUtils, 'throwErrorIfNotLoggedIn').mockImplementation();
         jest
-            .spyOn(GetProjectConfig, 'getProjectConfig')
-            .mockImplementationOnce(() => Promise.resolve(projectConfig));
+            .spyOn(PorterUtils, 'getProjectName')
+            .mockImplementationOnce(() => Promise.resolve(projectName));
         jest.spyOn(Inquirer, 'prompt').mockImplementationOnce(() => Promise.resolve({
             answer: 'y',
         }));
@@ -204,15 +169,13 @@ describe('removeProject', () => {
             'project',
             'removeProject',
         ]);
-        expect(BuildPorterUrl.buildPorterUrl).toHaveBeenCalled();
+        expect(PorterUtils.throwErrorIfNotLoggedIn).toHaveBeenCalled();
+        expect(PorterUtils.buildPorterUrl).toHaveBeenCalled();
+        expect(PorterUtils.getProjectName).toHaveBeenCalled();
         expect(mockClient.delete).toHaveBeenCalled();
-        expect(ErrorUtils.handleError).not.toHaveBeenCalled();
+        expect(PorterUtils.handleError).not.toHaveBeenCalled();
     }));
     it('should handle unexpected errors', () => __awaiter(void 0, void 0, void 0, function* () {
-        jest.spyOn(ErrorUtils, 'throwErrorIfNotLoggedIn').mockImplementation();
-        jest
-            .spyOn(GetProjectConfig, 'getProjectConfig')
-            .mockImplementationOnce(() => Promise.resolve(projectConfig));
         jest.spyOn(Inquirer, 'prompt').mockImplementationOnce(() => Promise.resolve({
             answer: 'y',
         }));
@@ -229,8 +192,10 @@ describe('removeProject', () => {
             'project',
             'removeProject',
         ]);
-        expect(BuildPorterUrl.buildPorterUrl).toHaveBeenCalled();
+        expect(PorterUtils.throwErrorIfNotLoggedIn).toHaveBeenCalled();
+        expect(PorterUtils.buildPorterUrl).toHaveBeenCalled();
+        expect(PorterUtils.getProjectName).toHaveBeenCalled();
         expect(mockClient.delete).toHaveBeenCalled();
-        expect(ErrorUtils.handleCommandError).toHaveBeenCalled();
+        expect(PorterUtils.handleCommandError).toHaveBeenCalled();
     }));
 });

package/lib/porter/utils/ErrorUtils/ErrorUtils.js

@@ -41,7 +41,10 @@ function handleCommandError(command, error) {
     if (error.response.data) {
         let errorMessage;
         if (error.response.data['invalid-params']) {
-            errorMessage = JSON.stringify(error.response.data['invalid-params']);
+            errorMessage = error.response.data['invalid-params']
+                .map((item) => `${item.name} - ${item.reason}`)
+                .join('\n');
+            return command.error(chalk_1.default.red(errorMessage));
         }
         else {
             errorMessage = error.response.data.title;

package/lib/porter/utils/ErrorUtils/ErrorUtils.spec.js

@@ -97,7 +97,7 @@ describe('handleCommandError', () => {
         // read the mock call strings directly otherwise colours cause test failures with .toEqual()
         expect(stderrSpy.mock.calls[0][0]).toContain('You must be logged in as a DXP super admin or Squiz support staff to use this service');
     }));
-    it('correctly displays the console logs for axios errors from the porter service', () => __awaiter(void 0, void 0, void 0, function* () {
+    it('correctly displays the console logs for invalid-params errors from the porter service', () => __awaiter(void 0, void 0, void 0, function* () {
         const command = new commander_1.Command();
         const errorStatus = 400;
         const errorTitle = 'Bad request';
@@ -115,7 +115,22 @@ describe('handleCommandError', () => {
         (0, ErrorUtils_1.handleCommandError)(command, new axios_1.AxiosError(errorTitle, `${errorStatus}`, undefined, undefined, errorResponse));
         expect(stderrSpy).toHaveBeenCalledTimes(1);
         // read the mock call strings directly otherwise colours cause test failures with .toEqual()
-        expect(stderrSpy.mock.calls[0][0]).toContain(JSON.stringify(errorResponse.data['invalid-params']));
+        expect(stderrSpy.mock.calls[0][0]).toContain(`${errorResponse.data['invalid-params'][0].name} - ${errorResponse.data['invalid-params'][0].reason}`);
+    }));
+    it('correctly displays the console logs for errors (using the title) from the porter service', () => __awaiter(void 0, void 0, void 0, function* () {
+        const errorStatus = 400;
+        const errorTitle = 'Bad request';
+        const command = new commander_1.Command();
+        const errorResponse = {
+            data: {
+                title: errorTitle,
+                status: errorStatus,
+            },
+        };
+        (0, ErrorUtils_1.handleCommandError)(command, new axios_1.AxiosError(errorTitle, `${errorStatus}`, undefined, undefined, errorResponse));
+        expect(stderrSpy).toHaveBeenCalledTimes(1);
+        // read the mock call strings directly otherwise colours cause test failures with .toEqual()
+        expect(stderrSpy.mock.calls[0][0]).toContain(errorTitle);
     }));
 });
 describe('handleError', () => {

package/lib/porter/utils/GetProjectConfig/GetProjectConfig.js

@@ -16,6 +16,7 @@ exports.getProjectConfig = void 0;
 const path_1 = __importDefault(require("path"));
 const promises_1 = __importDefault(require("fs/promises"));
 const CoreUtils_1 = require("../CoreUtils/CoreUtils");
+const constants_1 = require("../../constants");
 function getProjectConfig() {
     return __awaiter(this, void 0, void 0, function* () {
         try {
@@ -25,7 +26,7 @@ function getProjectConfig() {
         }
         catch (err) {
             (0, CoreUtils_1.logDebug)(err);
-            throw new Error('You must be within a porter project directory to use this command');
+            throw new Error(constants_1.PORTER_ERRORS.projectDirectoryInvalid);
         }
     });
 }

package/lib/porter/utils/GetProjectConfig/GetProjectConfig.spec.js

@@ -14,24 +14,25 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const GetProjectConfig_1 = require("./GetProjectConfig");
 const promises_1 = __importDefault(require("fs/promises"));
+const constants_1 = require("../../constants");
 jest.mock('fs/promises', () => {
     return {
         readFile: jest.fn(),
     };
 });
 describe('getProjectConfig', () => {
-    it('should throw an error if cannot config file does not exist', () => __awaiter(void 0, void 0, void 0, function* () {
+    it('should throw an error if config file does not exist', () => __awaiter(void 0, void 0, void 0, function* () {
         jest.spyOn(promises_1.default, 'readFile').mockImplementationOnce(() => {
             throw new Error('ENOENT');
         });
-        yield expect((0, GetProjectConfig_1.getProjectConfig)()).rejects.toThrowError('You must be within a porter project directory to use this command');
+        yield expect((0, GetProjectConfig_1.getProjectConfig)()).rejects.toThrowError(constants_1.PORTER_ERRORS.projectDirectoryInvalid);
         expect(promises_1.default.readFile).toHaveBeenCalled();
     }));
     it('should throw an error if cannot parse config file', () => __awaiter(void 0, void 0, void 0, function* () {
         jest
             .spyOn(promises_1.default, 'readFile')
             .mockImplementationOnce(() => Promise.resolve('invalid-json'));
-        yield expect((0, GetProjectConfig_1.getProjectConfig)()).rejects.toThrowError('You must be within a porter project directory to use this command');
+        yield expect((0, GetProjectConfig_1.getProjectConfig)()).rejects.toThrowError(constants_1.PORTER_ERRORS.projectDirectoryInvalid);
         expect(promises_1.default.readFile).toHaveBeenCalled();
     }));
     it('should return the project config json', () => __awaiter(void 0, void 0, void 0, function* () {

package/lib/porter/utils/GetProjectName/GetProjectName.d.ts

@@ -0,0 +1,4 @@
+/**
+ * The project name set in the project config file.
+ */
+export declare function getProjectName(): Promise<string>;

package/lib/porter/utils/GetProjectName/GetProjectName.js

@@ -0,0 +1,30 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProjectName = void 0;
+const GetProjectConfig_1 = require("../GetProjectConfig/GetProjectConfig");
+const constants_1 = require("../../constants");
+const CoreUtils_1 = require("../CoreUtils/CoreUtils");
+/**
+ * The project name set in the project config file.
+ */
+function getProjectName() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const config = yield (0, GetProjectConfig_1.getProjectConfig)();
+        const { projectName } = config;
+        if (!projectName) {
+            (0, CoreUtils_1.logDebug)(`Missing project name. Config: ${JSON.stringify(config)}`);
+            throw new Error(constants_1.PORTER_ERRORS.projectNameMissing);
+        }
+        return projectName;
+    });
+}
+exports.getProjectName = getProjectName;

package/lib/porter/utils/GetProjectName/GetProjectName.spec.d.ts

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

package/lib/porter/utils/GetProjectName/GetProjectName.spec.js

@@ -0,0 +1,91 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const constants_1 = require("../../constants");
+const GetProjectConfig = __importStar(require("../GetProjectConfig/GetProjectConfig"));
+const GetProjectName_1 = require("./GetProjectName");
+describe('getProjectName', () => {
+    beforeEach(() => {
+        jest.mock('fs/promises', () => {
+            return {
+                readFile: jest.fn(),
+            };
+        });
+        jest.mock('../GetProjectConfig/GetProjectConfig', () => {
+            return {
+                getProjectConfig: jest.fn(),
+            };
+        });
+    });
+    it('should throw an error if could not retrieve project config', () => __awaiter(void 0, void 0, void 0, function* () {
+        const mockErrorMessage = 'missing config';
+        jest
+            .spyOn(GetProjectConfig, 'getProjectConfig')
+            .mockImplementationOnce(() => {
+            throw new Error(mockErrorMessage);
+        });
+        yield expect((0, GetProjectName_1.getProjectName)()).rejects.toThrowError(mockErrorMessage);
+    }));
+    it('should throw an error if project name is missing from config file', () => __awaiter(void 0, void 0, void 0, function* () {
+        const projectConfigBlank = {
+            projectName: '',
+            service: 'dxp-porter',
+            version: '0.1.0',
+        };
+        const projectConfigMissing = {
+            service: 'dxp-porter',
+            version: '0.1.0',
+        };
+        jest
+            .spyOn(GetProjectConfig, 'getProjectConfig')
+            .mockImplementationOnce(() => Promise.resolve(projectConfigBlank))
+            .mockImplementationOnce(() => Promise.resolve(projectConfigMissing));
+        // Blank project name
+        yield expect((0, GetProjectName_1.getProjectName)()).rejects.toThrowError(constants_1.PORTER_ERRORS.projectNameMissing);
+        // Missing project name
+        yield expect((0, GetProjectName_1.getProjectName)()).rejects.toThrowError(constants_1.PORTER_ERRORS.projectNameMissing);
+    }));
+    it('should return the project name from the project config', () => __awaiter(void 0, void 0, void 0, function* () {
+        const projectConfig = {
+            service: 'dxp-porter',
+            projectName: 'mock-name',
+            version: '0.1.0',
+        };
+        jest
+            .spyOn(GetProjectConfig, 'getProjectConfig')
+            .mockImplementationOnce(() => Promise.resolve(projectConfig));
+        const projectName = yield (0, GetProjectName_1.getProjectName)();
+        expect(projectName).toStrictEqual('mock-name');
+    }));
+});

package/lib/porter/utils/index.d.ts

@@ -4,3 +4,4 @@ export * from './CoreUtils/CoreUtils';
 export * from './DoesPathExist/DoesPathExist';
 export * from './ErrorUtils/ErrorUtils';
 export * from './GetProjectConfig/GetProjectConfig';
+export * from './GetProjectName/GetProjectName';

package/lib/porter/utils/index.js

@@ -20,3 +20,4 @@ __exportStar(require("./CoreUtils/CoreUtils"), exports);
 __exportStar(require("./DoesPathExist/DoesPathExist"), exports);
 __exportStar(require("./ErrorUtils/ErrorUtils"), exports);
 __exportStar(require("./GetProjectConfig/GetProjectConfig"), exports);
+__exportStar(require("./GetProjectName/GetProjectName"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/dxp-cli-next",
-  "version": "5.15.0-develop.1",
+  "version": "5.15.0-develop.3",
   "repository": {
     "url": "https://gitlab.squiz.net/dxp/dxp-cli-next"
   },
@@ -41,7 +41,7 @@
   "dependencies": {
     "@apidevtools/swagger-parser": "10.1.0",
     "@squiz/component-cli-lib": "1.65.1",
-    "@squiz/dxp-porter-shared": "0.2.7",
+    "@squiz/dxp-porter-shared": "0.3.0",
     "axios": "1.1.3",
     "cli-color": "2.0.3",
     "commander": "9.4.0",