@sasjs/cli 6.6.0 → 6.8.0

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

@@ -0,0 +1,354 @@
+"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 __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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var path_1 = __importDefault(require("path"));
+var os_1 = __importDefault(require("os"));
+var fs_1 = require("fs");
+var processLogCheck_1 = require("../processLogCheck");
+var types_1 = require("../types");
+var sasLog = function (note) {
+    if (note === void 0) { note = 'NOTE: Variable flag is uninitialized.'; }
+    return "NOTE: Copyright (c) 2016 by SAS Institute Inc., Cary, NC, USA.\n\n1    data work.x;\n2      set work.y;\n3    run;\nERROR 22-322: Syntax error.\nWARNING: Apparent symbolic reference X not resolved.\n".concat(note, "\n");
+};
+var cleanLog = "NOTE: Copyright (c) 2016 by SAS Institute Inc., Cary, NC, USA.\n\n1    data work.x;\n2      x = 1;\n3    run;\n";
+var warningsOnly = "NOTE: Copyright (c) 2016 by SAS Institute Inc., Cary, NC, USA.\n\n1    data work.x;\n2      set work.y;\n3    run;\nWARNING: Apparent symbolic reference X not resolved.\n";
+var buildLog = "> tsc -p .\nERROR: Cannot find module './config'\n";
+var tempFolder = function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+    switch (_a.label) {
+        case 0: return [4 /*yield*/, fs_1.promises.mkdtemp(path_1.default.join(os_1.default.tmpdir(), 'sasjs-logcheck-process-'))];
+        case 1: return [2 /*return*/, _a.sent()];
+    }
+}); }); };
+var config = function (overrides) {
+    if (overrides === void 0) { overrides = {}; }
+    return (__assign(__assign(__assign({}, types_1.defaultLogCheckConfig), { ignoreCodes: [], ignorePaths: [] }), overrides));
+};
+describe('processLogCheck', function () {
+    var originalProjectDir = process.projectDir;
+    afterEach(function () {
+        process.projectDir = originalProjectDir;
+    });
+    it('checks every log in the results folder when given no path', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var folder, summary;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, tempFolder()];
+                case 1:
+                    folder = _a.sent();
+                    process.projectDir = folder;
+                    return [4 /*yield*/, fs_1.promises.mkdir(path_1.default.join(folder, 'sasjsresults'))];
+                case 2:
+                    _a.sent();
+                    return [4 /*yield*/, fs_1.promises.writeFile(path_1.default.join(folder, 'sasjsresults', 'run.log'), sasLog())];
+                case 3:
+                    _a.sent();
+                    return [4 /*yield*/, fs_1.promises.writeFile(path_1.default.join(folder, 'sasjsresults', 'build.log'), buildLog)];
+                case 4:
+                    _a.sent();
+                    return [4 /*yield*/, (0, processLogCheck_1.processLogCheck)({ config: config() })];
+                case 5:
+                    summary = _a.sent();
+                    expect(summary.usedDefaultInput).toBe(true);
+                    expect(summary.searched).toEqual(['sasjsresults']);
+                    expect(summary.logs).toHaveLength(2);
+                    expect(summary.totals).toEqual({
+                        errors: 1,
+                        warnings: 1,
+                        notes: 1,
+                        suppressed: 0,
+                        logs: 1,
+                        skipped: 1
+                    });
+                    expect(summary.skipped).toEqual([
+                        { displayPath: 'sasjsresults/build.log', reason: 'not a SAS log' }
+                    ]);
+                    expect(summary.failure).toEqual('1 error');
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('checks only the paths it was given', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var folder, summary;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, tempFolder()];
+                case 1:
+                    folder = _a.sent();
+                    process.projectDir = folder;
+                    return [4 /*yield*/, fs_1.promises.writeFile(path_1.default.join(folder, 'one.log'), sasLog())];
+                case 2:
+                    _a.sent();
+                    return [4 /*yield*/, fs_1.promises.writeFile(path_1.default.join(folder, 'two.log'), sasLog())];
+                case 3:
+                    _a.sent();
+                    return [4 /*yield*/, (0, processLogCheck_1.processLogCheck)({
+                            paths: [path_1.default.join(folder, 'one.log')],
+                            config: config()
+                        })];
+                case 4:
+                    summary = _a.sent();
+                    expect(summary.usedDefaultInput).toBe(false);
+                    expect(summary.logs).toHaveLength(1);
+                    expect(summary.logs[0].displayPath).toEqual('one.log');
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('counts a log excluded by ignorePaths as skipped, not as clean', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var folder, summary;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, tempFolder()];
+                case 1:
+                    folder = _a.sent();
+                    process.projectDir = folder;
+                    return [4 /*yield*/, fs_1.promises.writeFile(path_1.default.join(folder, 'keep.log'), cleanLog)];
+                case 2:
+                    _a.sent();
+                    return [4 /*yield*/, fs_1.promises.writeFile(path_1.default.join(folder, 'legacy.log'), sasLog())];
+                case 3:
+                    _a.sent();
+                    return [4 /*yield*/, (0, processLogCheck_1.processLogCheck)({
+                            paths: [folder],
+                            config: config({ ignorePaths: ['legacy.log'] })
+                        })];
+                case 4:
+                    summary = _a.sent();
+                    expect(summary.totals.logs).toEqual(1);
+                    expect(summary.skipped).toEqual([
+                        { displayPath: 'legacy.log', reason: 'excluded by ignorePaths' }
+                    ]);
+                    // The count in the summary and the entries in the report describe the same
+                    // run: the excluded file is a file that was passed over, not a file that
+                    // never existed.
+                    expect(summary.totals.skipped).toEqual(summary.skipped.length);
+                    expect(summary.failure).toBeUndefined();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('sets a suppressed issue aside without counting it', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var folder, summary;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, tempFolder()];
+                case 1:
+                    folder = _a.sent();
+                    process.projectDir = folder;
+                    return [4 /*yield*/, fs_1.promises.writeFile(path_1.default.join(folder, 'run.log'), sasLog())];
+                case 2:
+                    _a.sent();
+                    return [4 /*yield*/, (0, processLogCheck_1.processLogCheck)({
+                            paths: [folder],
+                            config: config({ ignoreCodes: ['22-322'] })
+                        })];
+                case 3:
+                    summary = _a.sent();
+                    expect(summary.totals.errors).toEqual(0);
+                    expect(summary.totals.suppressed).toEqual(1);
+                    expect(summary.failure).toBeUndefined();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('reports a path that does not exist as a failure', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var folder, summary;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, tempFolder()];
+                case 1:
+                    folder = _a.sent();
+                    process.projectDir = folder;
+                    return [4 /*yield*/, (0, processLogCheck_1.processLogCheck)({
+                            paths: [path_1.default.join(folder, 'nope.log')],
+                            config: config()
+                        })];
+                case 2:
+                    summary = _a.sent();
+                    expect(summary.missing).toEqual([path_1.default.join(folder, 'nope.log')]);
+                    expect(summary.failure).toEqual('1 path not found');
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('fails on a folder it could not list', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var folder, readdir, summary;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, tempFolder()];
+                case 1:
+                    folder = _a.sent();
+                    process.projectDir = folder;
+                    return [4 /*yield*/, fs_1.promises.mkdir(path_1.default.join(folder, 'logs'))];
+                case 2:
+                    _a.sent();
+                    readdir = jest
+                        .spyOn(require('fs/promises'), 'readdir')
+                        .mockRejectedValue(Object.assign(new Error('denied'), { code: 'EACCES' }));
+                    return [4 /*yield*/, (0, processLogCheck_1.processLogCheck)({
+                            paths: [path_1.default.join(folder, 'logs')],
+                            config: config()
+                        })];
+                case 3:
+                    summary = _a.sent();
+                    readdir.mockRestore();
+                    expect(summary.unreadable).toEqual([
+                        { displayPath: 'logs', reason: 'could not be listed (EACCES)' }
+                    ]);
+                    expect(summary.failure).toEqual('1 folder could not be read');
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('reports the default folder as missing rather than throwing', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var folder, summary;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, tempFolder()];
+                case 1:
+                    folder = _a.sent();
+                    process.projectDir = folder;
+                    return [4 /*yield*/, (0, processLogCheck_1.processLogCheck)({ config: config() })];
+                case 2:
+                    summary = _a.sent();
+                    expect(summary.usedDefaultInput).toBe(true);
+                    expect(summary.failure).toEqual('1 path not found');
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});
+describe('defaultInputPath', function () {
+    var originalProjectDir = process.projectDir;
+    afterEach(function () {
+        process.projectDir = originalProjectDir;
+    });
+    it('is sasjsresults under the project folder', function () {
+        process.projectDir = path_1.default.join('some', 'project');
+        expect((0, processLogCheck_1.defaultInputPath)(config())).toEqual(path_1.default.resolve(path_1.default.join('some', 'project'), 'sasjsresults'));
+    });
+    it('falls back to the working directory when no project is set', function () {
+        process.projectDir = undefined;
+        expect((0, processLogCheck_1.defaultInputPath)(config())).toEqual(path_1.default.resolve(process.cwd(), 'sasjsresults'));
+    });
+    it('honours the folder the config names', function () {
+        process.projectDir = 'some/project';
+        expect((0, processLogCheck_1.defaultInputPath)(config({ folder: 'logs' }))).toEqual(path_1.default.resolve('some/project', 'logs'));
+    });
+});
+describe('describeFailure', function () {
+    var totals = function (errors, warnings, notes) { return ({
+        errors: errors,
+        warnings: warnings,
+        notes: notes,
+        suppressed: 0,
+        logs: 1,
+        skipped: 0
+    }); };
+    it('fails on an error under the default policy', function () {
+        expect((0, processLogCheck_1.describeFailure)(totals(1, 0, 0), config())).toEqual('1 error');
+    });
+    it('passes a warning under the default policy', function () {
+        expect((0, processLogCheck_1.describeFailure)(totals(0, 3, 0), config())).toBeUndefined();
+    });
+    it('fails on a warning when the policy says warning', function () {
+        expect((0, processLogCheck_1.describeFailure)(totals(0, 3, 0), config({ failOn: 'warning' }))).toEqual('3 warnings');
+    });
+    it('fails on a note only when the policy says note', function () {
+        expect((0, processLogCheck_1.describeFailure)(totals(0, 0, 2), config({ failOn: 'warning' }))).toBeUndefined();
+        expect((0, processLogCheck_1.describeFailure)(totals(0, 0, 2), config({ failOn: 'note' }))).toEqual('2 notes');
+    });
+    it('never fails under the never policy, when no budget is set', function () {
+        expect((0, processLogCheck_1.describeFailure)(totals(9, 9, 9), config({ failOn: 'never' }))).toBeUndefined();
+    });
+    it('still fails on an exceeded budget under the never policy', function () {
+        expect((0, processLogCheck_1.describeFailure)(totals(0, 3, 0), config({ failOn: 'never', maxWarnings: 0 }))).toEqual('3 warnings (budget 0)');
+    });
+    it('fails when the warnings exceed the budget', function () {
+        expect((0, processLogCheck_1.describeFailure)(totals(0, 3, 0), config({ maxWarnings: 2 }))).toEqual('3 warnings (budget 2)');
+        expect((0, processLogCheck_1.describeFailure)(totals(0, 2, 0), config({ maxWarnings: 2 }))).toBeUndefined();
+    });
+    it('fails on a folder it could not read, before any issue', function () {
+        expect((0, processLogCheck_1.describeFailure)(totals(4, 0, 0), config(), 0, 1)).toEqual('1 folder could not be read');
+        expect((0, processLogCheck_1.describeFailure)(totals(0, 0, 0), config(), 0, 2)).toEqual('2 folders could not be read');
+    });
+    it('reports a missing path before any issue', function () {
+        expect((0, processLogCheck_1.describeFailure)(totals(4, 0, 0), config(), 2)).toEqual('2 paths not found');
+    });
+});
+describe('sumTotals', function () {
+    it('treats every log it was given as a file it read', function () {
+        expect((0, processLogCheck_1.sumTotals)([
+            { counts: { errors: 0, warnings: 0, notes: 0 }, suppressed: [] }
+        ]).skipped).toEqual(0);
+    });
+    it('adds the counts of the logs it was given', function () {
+        var logs = [
+            {
+                counts: { errors: 2, warnings: 1, notes: 0 },
+                suppressed: [{}]
+            },
+            {
+                counts: { errors: 0, warnings: 0, notes: 3 },
+                suppressed: []
+            }
+        ];
+        expect((0, processLogCheck_1.sumTotals)(logs, 3)).toEqual({
+            errors: 2,
+            warnings: 1,
+            notes: 3,
+            suppressed: 1,
+            logs: 2,
+            skipped: 1
+        });
+    });
+});

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

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