@squiz/dxp-cli-next 5.5.1 → 5.6.0-develop.10

package/lib/job-runner/utils.spec.js

@@ -0,0 +1,116 @@
+"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 utils_1 = require("./utils");
+const commander_1 = require("commander");
+const axios_1 = require("axios");
+const chalk_1 = __importDefault(require("chalk"));
+const path_1 = __importDefault(require("path"));
+const exitSpy = jest.spyOn(process, 'exit').mockImplementation(() => {
+    return undefined;
+}); // prevent process exit on error
+const stderrSpy = jest.spyOn(process.stderr, 'write');
+const logSpy = jest.spyOn(global.console, 'log');
+beforeEach(() => {
+    jest.resetAllMocks();
+});
+describe('handleCommandError', () => {
+    it('correctly displays the console logs for command error', () => __awaiter(void 0, void 0, void 0, function* () {
+        const command = new commander_1.Command();
+        const message = 'Something bad happened';
+        (0, utils_1.handleCommandError)(command, new Error(message));
+        expect(stderrSpy).toHaveBeenCalledTimes(1);
+        console.log(stderrSpy.mock.calls);
+        // read the mock call strings directly otherwise colours cause test failures with .toEqual()
+        expect(stderrSpy.mock.calls[0][0]).toContain(message);
+    }));
+    it('correctly displays the console logs for axios error', () => __awaiter(void 0, void 0, void 0, function* () {
+        const command = new commander_1.Command();
+        const message = 'Something bad happened';
+        const responseMessage = 'I am an error response';
+        const errDetails = 'i am error details';
+        (0, utils_1.handleCommandError)(command, new axios_1.AxiosError(message, '500', undefined, undefined, {
+            data: { message: responseMessage, details: errDetails },
+        }));
+        expect(stderrSpy).toHaveBeenCalledTimes(1);
+        // read the mock call strings directly otherwise colours cause test failures with .toEqual()
+        expect(stderrSpy.mock.calls[0][0]).toContain(`${message}: ${responseMessage} - ${errDetails}`);
+    }));
+    it('correctly displays the console logs for error without a message', () => __awaiter(void 0, void 0, void 0, function* () {
+        const command = new commander_1.Command();
+        (0, utils_1.handleCommandError)(command, new Error());
+        expect(stderrSpy).toHaveBeenCalledTimes(1);
+        // read the mock call strings directly otherwise colours cause test failures with .toEqual()
+        expect(stderrSpy.mock.calls[0][0]).toContain('An unknown error occurred');
+    }));
+});
+describe('writeLineSeparator', () => {
+    it('correctly displays the console logs for line separator', () => __awaiter(void 0, void 0, void 0, function* () {
+        (0, utils_1.writeLineSeparator)();
+        expect(logSpy).toHaveBeenCalledTimes(1);
+        expect(logSpy).toHaveBeenCalledWith(chalk_1.default.cyan('------------------------------'));
+    }));
+});
+describe('validateAxiosStatus', () => {
+    it('correctly validates the status', () => __awaiter(void 0, void 0, void 0, function* () {
+        expect((0, utils_1.validateAxiosStatus)(200)).toBe(true);
+        expect((0, utils_1.validateAxiosStatus)(400)).toBe(false);
+    }));
+});
+describe('buildJobRunnerUrl', () => {
+    it('correctly builds the url with override set ', () => __awaiter(void 0, void 0, void 0, function* () {
+        const url = yield (0, utils_1.buildJobRunnerUrl)(undefined, 'http://localhost:9999/someTenant');
+        expect(url).toBe('http://localhost:9999/someTenant');
+    }));
+});
+describe('readInputFile', () => {
+    it('correctly reads the file ', () => __awaiter(void 0, void 0, void 0, function* () {
+        const res = yield (0, utils_1.readInputFile)(path_1.default.join('./src/__tests__/job-runner/inputs/input.json'));
+        expect(res).toStrictEqual({ something: 'amazing' });
+    }));
+    it('errors if file extension is not .json', () => __awaiter(void 0, void 0, void 0, function* () {
+        yield expect((0, utils_1.readInputFile)(path_1.default.join('./src/__tests__/job-runner/simple-job/main.js'))).rejects.toThrow('Input must be a .json file');
+    }));
+    it('errors if file does not exist', () => __awaiter(void 0, void 0, void 0, function* () {
+        yield expect((0, utils_1.readInputFile)(path_1.default.join('./src/__tests__/job-runner/simple-job/input.json'))).rejects.toThrow('Input could not be found');
+    }));
+    it('errors if file has json extension but cannot be parsed', () => __awaiter(void 0, void 0, void 0, function* () {
+        const source = './src/__tests__/job-runner/inputs/badInput.json';
+        yield expect((0, utils_1.readInputFile)(path_1.default.join(source))).rejects.toThrow(`Unable to read file ${path_1.default.join(source)} - Unexpected token i in JSON at position 1`);
+    }));
+});
+describe('addPaginationToUrl', () => {
+    it('correctly adds the pagination size param to the url', () => __awaiter(void 0, void 0, void 0, function* () {
+        const url = (0, utils_1.addPaginationToUrl)('http://localhost:9999//__dxp/au/job-runner/someTenant/job/latest?', { size: 'tiny', before: '', after: '' });
+        expect(url).toBe('http://localhost:9999//__dxp/au/job-runner/someTenant/job/latest?&page[size]=5');
+    }));
+    it('correctly adds the pagination params to the url', () => __awaiter(void 0, void 0, void 0, function* () {
+        const url = (0, utils_1.addPaginationToUrl)('http://localhost:9999//__dxp/au/job-runner/someTenant/job/latest?', { size: 'tiny', before: '12345', after: '' });
+        expect(url).toBe('http://localhost:9999//__dxp/au/job-runner/someTenant/job/latest?&page[size]=5&page[before]=12345');
+    }));
+    it('correctly throws error for before and after params', () => __awaiter(void 0, void 0, void 0, function* () {
+        expect(() => {
+            (0, utils_1.addPaginationToUrl)('http://localhost:9999//__dxp/au/job-runner/someTenant/job/latest?', { size: 'tiny', before: '12345', after: '54321' });
+        }).toThrow('Only one of before and after can be set');
+    }));
+});
+describe('logArrayResults', () => {
+    it('correctly logs results with links', () => __awaiter(void 0, void 0, void 0, function* () {
+        yield (0, utils_1.logArrayResults)([{ something: 'awesome' }, { somethingElse: 'also awesome' }], { next: 'page[after]=12345', prev: 'page[before]=1234' });
+        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('something')}: "awesome"`);
+        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('somethingElse')}: "also awesome"`);
+        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('prevPageToken')}: 1234`);
+        expect(logSpy).toHaveBeenCalledWith(`${chalk_1.default.bold('nextPageToken')}: 12345`);
+    }));
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/dxp-cli-next",
-  "version": "5.5.1",
+  "version": "5.6.0-develop.10",
   "repository": {
     "url": "https://gitlab.squiz.net/developer-experience/dxp-cli-next"
   },
@@ -39,12 +39,14 @@
     "codecov"
   ],
   "dependencies": {
-    "@squiz/component-cli-lib": "1.22.0",
+    "@squiz/component-cli-lib": "^1.50.1-alpha",
     "axios": "1.1.3",
     "cli-color": "2.0.3",
     "commander": "9.4.0",
+    "dotenv": "^16.3.1",
     "env-paths": "2.2.1",
     "inquirer": "8.2.5",
+    "ora": "^5.4.1",
     "prompt": "^1.3.0",
     "tough-cookie": "4.1.2",
     "update-notifier": "5.1.0"
@@ -74,6 +76,7 @@
     "husky": "8.0.1",
     "jest": "28.1.3",
     "lint-staged": "13.0.3",
+    "nock": "^13.3.1",
     "prettier": "2.7.1",
     "semantic-release": "19.0.3",
     "ts-jest": "28.0.7",