@sasjs/cli 6.6.0 → 6.7.0

package/build/commands/logcheck/spec/logcheckCommand.spec.js

@@ -0,0 +1,360 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __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 __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var configModule = __importStar(require("../logCheckConfig"));
+var processModule = __importStar(require("../processLogCheck"));
+var renderModule = __importStar(require("../renderLogCheck"));
+var logcheckCommand_1 = require("../logcheckCommand");
+var utils_1 = require("@sasjs/utils");
+var command_1 = require("../../../types/command");
+var types_1 = require("../types");
+var defaultArgs = ['node', 'sasjs', 'logcheck'];
+var summary = function (overrides) {
+    if (overrides === void 0) { overrides = {}; }
+    return (__assign({ logs: [], skipped: [], missing: [], unreadable: [], usedDefaultInput: false, searched: ['sasjsresults'], totals: {
+            errors: 0,
+            warnings: 0,
+            notes: 0,
+            suppressed: 0,
+            logs: 0,
+            skipped: 0
+        } }, overrides));
+};
+var setupMocks = function () {
+    jest
+        .spyOn(configModule, 'readLogCheckConfig')
+        .mockImplementation(function () { return Promise.resolve(__assign({}, types_1.defaultLogCheckConfig)); });
+    jest
+        .spyOn(processModule, 'processLogCheck')
+        .mockImplementation(function () { return Promise.resolve(summary()); });
+    jest.spyOn(renderModule, 'renderLogCheck').mockImplementation(function () { return undefined; });
+    process.logger = new utils_1.Logger(utils_1.LogLevel.Off);
+    jest.spyOn(process.logger, 'error');
+    jest.spyOn(process.logger, 'log');
+};
+describe('LogCheckCommand', function () {
+    beforeEach(function () {
+        setupMocks();
+    });
+    it('parses the paths it was given', function () {
+        var command = new logcheckCommand_1.LogCheckCommand(__spreadArray(__spreadArray([], __read(defaultArgs), false), ['a.log', 'logs'], false));
+        expect(command.name).toEqual('logcheck');
+        expect(command.parsed.paths).toEqual(['a.log', 'logs']);
+    });
+    it('answers to its alias', function () {
+        var command = new logcheckCommand_1.LogCheckCommand(['node', 'sasjs', 'lc', 'a.log']);
+        expect(command.name).toEqual('logcheck');
+        expect(command.parsed.paths).toEqual(['a.log']);
+    });
+    it('checks the default folder when it is given no path', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var command;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    command = new logcheckCommand_1.LogCheckCommand(defaultArgs);
+                    return [4 /*yield*/, command.execute()];
+                case 1:
+                    _a.sent();
+                    expect(processModule.processLogCheck).toHaveBeenCalledWith({
+                        paths: [],
+                        config: expect.objectContaining({ failOn: 'error' })
+                    });
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('passes the flags over the config file', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var command;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    command = new logcheckCommand_1.LogCheckCommand(__spreadArray(__spreadArray([], __read(defaultArgs), false), [
+                        '--fail-on',
+                        'warning',
+                        '--max-warnings',
+                        '3',
+                        '--ignore-code',
+                        '49-169',
+                        '--ignore-path',
+                        'legacy/*'
+                    ], false));
+                    return [4 /*yield*/, command.execute()];
+                case 1:
+                    _a.sent();
+                    expect(processModule.processLogCheck).toHaveBeenCalledWith({
+                        paths: [],
+                        config: expect.objectContaining({
+                            failOn: 'warning',
+                            maxWarnings: 3,
+                            ignoreCodes: ['49-169'],
+                            ignorePaths: ['legacy/*']
+                        })
+                    });
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('reads a single value of a repeatable option as a list', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var command;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    command = new logcheckCommand_1.LogCheckCommand(__spreadArray(__spreadArray([], __read(defaultArgs), false), [
+                        '--ignore-code',
+                        '22-322'
+                    ], false));
+                    return [4 /*yield*/, command.execute()];
+                case 1:
+                    _a.sent();
+                    expect(processModule.processLogCheck.mock.calls[0][0].config
+                        .ignoreCodes).toEqual(['22-322']);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('renders the human report by default', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var command;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    command = new logcheckCommand_1.LogCheckCommand(__spreadArray(__spreadArray([], __read(defaultArgs), false), ['a.log'], false));
+                    return [4 /*yield*/, command.execute()];
+                case 1:
+                    _a.sent();
+                    expect(renderModule.renderLogCheck).toHaveBeenCalledWith(expect.anything(), expect.anything(), { format: 'human', verbose: false });
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('renders JSON when the shorthand flag is used', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var command;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    command = new logcheckCommand_1.LogCheckCommand(__spreadArray(__spreadArray([], __read(defaultArgs), false), ['--json'], false));
+                    return [4 /*yield*/, command.execute()];
+                case 1:
+                    _a.sent();
+                    expect(renderModule.renderLogCheck).toHaveBeenCalledWith(expect.anything(), expect.anything(), { format: 'json', verbose: false });
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('passes the verbose flag on to the report', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var command;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    command = new logcheckCommand_1.LogCheckCommand(__spreadArray(__spreadArray([], __read(defaultArgs), false), ['--verbose'], false));
+                    return [4 /*yield*/, command.execute()];
+                case 1:
+                    _a.sent();
+                    expect(renderModule.renderLogCheck).toHaveBeenCalledWith(expect.anything(), expect.anything(), { format: 'human', verbose: true });
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('returns success when the summary carries no failure', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var command, _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    command = new logcheckCommand_1.LogCheckCommand(defaultArgs);
+                    _a = expect;
+                    return [4 /*yield*/, command.execute()];
+                case 1:
+                    _a.apply(void 0, [_b.sent()]).toEqual(command_1.ReturnCode.Success);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('returns the logcheck code when the summary failed', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var command, _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    jest
+                        .spyOn(processModule, 'processLogCheck')
+                        .mockImplementation(function () {
+                        return Promise.resolve(summary({ failure: '2 errors' }));
+                    });
+                    command = new logcheckCommand_1.LogCheckCommand(defaultArgs);
+                    _a = expect;
+                    return [4 /*yield*/, command.execute()];
+                case 1:
+                    _a.apply(void 0, [_b.sent()]).toEqual(command_1.ReturnCode.LogCheckError);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('refuses a failOn that is not a policy', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var command, _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    command = new logcheckCommand_1.LogCheckCommand(__spreadArray(__spreadArray([], __read(defaultArgs), false), ['--fail-on', 'loud'], false));
+                    _a = expect;
+                    return [4 /*yield*/, command.execute()];
+                case 1:
+                    _a.apply(void 0, [_b.sent()]).toEqual(command_1.ReturnCode.InvalidCommand);
+                    expect(process.logger.error).toHaveBeenCalled();
+                    expect(processModule.processLogCheck).not.toHaveBeenCalled();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('refuses a format that is not one of the three', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var command, _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    command = new logcheckCommand_1.LogCheckCommand(__spreadArray(__spreadArray([], __read(defaultArgs), false), ['--format', 'xml'], false));
+                    _a = expect;
+                    return [4 /*yield*/, command.execute()];
+                case 1:
+                    _a.apply(void 0, [_b.sent()]).toEqual(command_1.ReturnCode.InvalidCommand);
+                    expect(processModule.processLogCheck).not.toHaveBeenCalled();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('reports a broken config as an internal error', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var command, _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    jest
+                        .spyOn(configModule, 'readLogCheckConfig')
+                        .mockImplementation(function () { return Promise.reject(new Error('bad config')); });
+                    command = new logcheckCommand_1.LogCheckCommand(defaultArgs);
+                    _a = expect;
+                    return [4 /*yield*/, command.execute()];
+                case 1:
+                    _a.apply(void 0, [_b.sent()]).toEqual(command_1.ReturnCode.InternalError);
+                    expect(process.logger.error).toHaveBeenCalled();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('reports a scan that threw as an internal error', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var command, _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    jest
+                        .spyOn(processModule, 'processLogCheck')
+                        .mockImplementation(function () { return Promise.reject(new Error('boom')); });
+                    command = new logcheckCommand_1.LogCheckCommand(defaultArgs);
+                    _a = expect;
+                    return [4 /*yield*/, command.execute()];
+                case 1:
+                    _a.apply(void 0, [_b.sent()]).toEqual(command_1.ReturnCode.InternalError);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});

package/build/commands/logcheck/spec/processLogCheck.spec.d.ts

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