@sasjs/cli 6.5.0 → 6.7.0

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

@@ -0,0 +1,477 @@
+"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 __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+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 __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 collectLogs_1 = require("../collectLogs");
+var types_1 = require("../types");
+var sasLog = "NOTE: Copyright (c) 2016 by SAS Institute Inc., Cary, NC, USA.\nNOTE: SAS (r) Proprietary Software 9.4 (TS1M9)\n\n1    data work.x;\n2      set work.y;\n3    run;\nERROR 22-322: Syntax error, expecting one of the following: ;, RUN, QUIT.\nWARNING: Apparent symbolic reference X not resolved.\nNOTE: Variable flag is uninitialized.\nNOTE: The data set WORK.X has 5 observations and 2 variables.\n";
+var cleanLog = "NOTE: Copyright (c) 2016 by SAS Institute Inc., Cary, NC, USA.\n\n1    data work.x;\n2      x = 1;\n3    run;\nNOTE: The data set WORK.X has 1 observations and 1 variables.\n";
+var buildLog = "> tsc -p .\nERROR: Cannot find module './config'\nERROR: Command failed with exit code 2\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-collect-'))];
+        case 1: return [2 /*return*/, _a.sent()];
+    }
+}); }); };
+var writeFiles = function (folder, files) { return __awaiter(void 0, void 0, void 0, function () {
+    var _a, _b, _c, name_1, contents, filePath, e_1_1;
+    var e_1, _d;
+    return __generator(this, function (_e) {
+        switch (_e.label) {
+            case 0:
+                _e.trys.push([0, 6, 7, 8]);
+                _a = __values(Object.entries(files)), _b = _a.next();
+                _e.label = 1;
+            case 1:
+                if (!!_b.done) return [3 /*break*/, 5];
+                _c = __read(_b.value, 2), name_1 = _c[0], contents = _c[1];
+                filePath = path_1.default.join(folder, name_1);
+                return [4 /*yield*/, fs_1.promises.mkdir(path_1.default.dirname(filePath), { recursive: true })];
+            case 2:
+                _e.sent();
+                return [4 /*yield*/, fs_1.promises.writeFile(filePath, contents)];
+            case 3:
+                _e.sent();
+                _e.label = 4;
+            case 4:
+                _b = _a.next();
+                return [3 /*break*/, 1];
+            case 5: return [3 /*break*/, 8];
+            case 6:
+                e_1_1 = _e.sent();
+                e_1 = { error: e_1_1 };
+                return [3 /*break*/, 8];
+            case 7:
+                try {
+                    if (_b && !_b.done && (_d = _a.return)) _d.call(_a);
+                }
+                finally { if (e_1) throw e_1.error; }
+                return [7 /*endfinally*/];
+            case 8: return [2 /*return*/];
+        }
+    });
+}); };
+describe('collectLogFiles', function () {
+    it('returns a single file as it was given', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var folder, _a, files, missing;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0: return [4 /*yield*/, tempFolder()];
+                case 1:
+                    folder = _b.sent();
+                    return [4 /*yield*/, writeFiles(folder, { 'run.log': sasLog })];
+                case 2:
+                    _b.sent();
+                    return [4 /*yield*/, (0, collectLogs_1.collectLogFiles)([
+                            path_1.default.join(folder, 'run.log')
+                        ])];
+                case 3:
+                    _a = _b.sent(), files = _a.files, missing = _a.missing;
+                    expect(files).toEqual([path_1.default.join(folder, 'run.log')]);
+                    expect(missing).toEqual([]);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('walks a folder, and the folders under it', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var folder, files;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, tempFolder()];
+                case 1:
+                    folder = _a.sent();
+                    return [4 /*yield*/, writeFiles(folder, {
+                            'a.log': sasLog,
+                            'nested/b.log': sasLog,
+                            'nested/deep/c.log': sasLog
+                        })];
+                case 2:
+                    _a.sent();
+                    return [4 /*yield*/, (0, collectLogs_1.collectLogFiles)([folder])];
+                case 3:
+                    files = (_a.sent()).files;
+                    expect(files.map(function (file) { return path_1.default.relative(folder, file); })).toEqual(expect.arrayContaining([
+                        'a.log',
+                        path_1.default.join('nested', 'b.log'),
+                        path_1.default.join('nested', 'deep', 'c.log')
+                    ]));
+                    expect(files).toHaveLength(3);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('does not walk into node_modules', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var folder, files;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, tempFolder()];
+                case 1:
+                    folder = _a.sent();
+                    return [4 /*yield*/, writeFiles(folder, {
+                            'a.log': sasLog,
+                            'node_modules/pkg/b.log': sasLog
+                        })];
+                case 2:
+                    _a.sent();
+                    return [4 /*yield*/, (0, collectLogs_1.collectLogFiles)([folder])];
+                case 3:
+                    files = (_a.sent()).files;
+                    expect(files).toHaveLength(1);
+                    expect(files[0]).toEqual(path_1.default.join(folder, 'a.log'));
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('reports a folder it cannot list instead of treating it as empty', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var folder, readdir, _a, files, unreadable;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0: return [4 /*yield*/, tempFolder()];
+                case 1:
+                    folder = _b.sent();
+                    return [4 /*yield*/, writeFiles(folder, { 'logs/a.log': sasLog })];
+                case 2:
+                    _b.sent();
+                    readdir = jest
+                        .spyOn(require('fs/promises'), 'readdir')
+                        .mockRejectedValue(Object.assign(new Error('denied'), { code: 'EACCES' }));
+                    return [4 /*yield*/, (0, collectLogs_1.collectLogFiles)([
+                            path_1.default.join(folder, 'logs')
+                        ])];
+                case 3:
+                    _a = _b.sent(), files = _a.files, unreadable = _a.unreadable;
+                    readdir.mockRestore();
+                    expect(files).toEqual([]);
+                    expect(unreadable).toHaveLength(1);
+                    expect(unreadable[0].reason).toEqual('could not be listed (EACCES)');
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('reports a path that does not exist instead of failing', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var folder, _a, files, missing;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0: return [4 /*yield*/, tempFolder()];
+                case 1:
+                    folder = _b.sent();
+                    return [4 /*yield*/, (0, collectLogs_1.collectLogFiles)([
+                            path_1.default.join(folder, 'nope.log')
+                        ])];
+                case 2:
+                    _a = _b.sent(), files = _a.files, missing = _a.missing;
+                    expect(files).toEqual([]);
+                    expect(missing).toEqual([path_1.default.join(folder, 'nope.log')]);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('lists the same file once when a file and its folder are both named', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var folder, files;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, tempFolder()];
+                case 1:
+                    folder = _a.sent();
+                    return [4 /*yield*/, writeFiles(folder, { 'a.log': sasLog })];
+                case 2:
+                    _a.sent();
+                    return [4 /*yield*/, (0, collectLogs_1.collectLogFiles)([
+                            folder,
+                            path_1.default.join(folder, 'a.log')
+                        ])];
+                case 3:
+                    files = (_a.sent()).files;
+                    expect(files).toEqual([path_1.default.join(folder, 'a.log')]);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('sorts the files so two runs produce the same report', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var folder, files;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, tempFolder()];
+                case 1:
+                    folder = _a.sent();
+                    return [4 /*yield*/, writeFiles(folder, { 'b.log': sasLog, 'a.log': sasLog })];
+                case 2:
+                    _a.sent();
+                    return [4 /*yield*/, (0, collectLogs_1.collectLogFiles)([folder])];
+                case 3:
+                    files = (_a.sent()).files;
+                    expect(files.map(function (file) { return path_1.default.basename(file); })).toEqual(['a.log', 'b.log']);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});
+describe('toDisplayPath', function () {
+    var originalProjectDir = process.projectDir;
+    afterEach(function () {
+        process.projectDir = originalProjectDir;
+    });
+    it('is relative to the project folder', function () {
+        process.projectDir = path_1.default.join('project', 'root');
+        expect((0, collectLogs_1.toDisplayPath)(path_1.default.join('project', 'root', 'sasjsresults', 'run.log'))).toEqual('sasjsresults/run.log');
+    });
+    it('is absolute for a file outside the project folder', function () {
+        process.projectDir = path_1.default.join(os_1.default.tmpdir(), 'sasjs-logcheck-project');
+        var outside = path_1.default.join(os_1.default.tmpdir(), 'elsewhere', 'run.log');
+        expect((0, collectLogs_1.toDisplayPath)(outside)).toEqual(outside.split(path_1.default.sep).join('/'));
+    });
+});
+describe('scanLogFile', function () {
+    it('reports the issues a SAS log carries', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var folder, filePath, log;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, tempFolder()];
+                case 1:
+                    folder = _a.sent();
+                    filePath = path_1.default.join(folder, 'run.log');
+                    return [4 /*yield*/, fs_1.promises.writeFile(filePath, sasLog)];
+                case 2:
+                    _a.sent();
+                    return [4 /*yield*/, (0, collectLogs_1.scanLogFile)(filePath, types_1.defaultLogCheckConfig)];
+                case 3:
+                    log = _a.sent();
+                    expect(log.skippedReason).toBeUndefined();
+                    expect(log.counts).toEqual({ errors: 1, warnings: 1, notes: 1 });
+                    expect(log.issues.map(function (issue) { return issue.severity; })).toEqual([
+                        'error',
+                        'warning',
+                        'note'
+                    ]);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('reports a clean log as checked, with nothing in it', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var folder, filePath, log;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, tempFolder()];
+                case 1:
+                    folder = _a.sent();
+                    filePath = path_1.default.join(folder, 'clean.log');
+                    return [4 /*yield*/, fs_1.promises.writeFile(filePath, cleanLog)];
+                case 2:
+                    _a.sent();
+                    return [4 /*yield*/, (0, collectLogs_1.scanLogFile)(filePath, types_1.defaultLogCheckConfig)];
+                case 3:
+                    log = _a.sent();
+                    expect(log.skippedReason).toBeUndefined();
+                    expect(log.counts).toEqual({ errors: 0, warnings: 0, notes: 0 });
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('skips a log another tool wrote', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var folder, filePath, log;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, tempFolder()];
+                case 1:
+                    folder = _a.sent();
+                    filePath = path_1.default.join(folder, 'build.log');
+                    return [4 /*yield*/, fs_1.promises.writeFile(filePath, buildLog)];
+                case 2:
+                    _a.sent();
+                    return [4 /*yield*/, (0, collectLogs_1.scanLogFile)(filePath, types_1.defaultLogCheckConfig)];
+                case 3:
+                    log = _a.sent();
+                    expect(log.skippedReason).toEqual('not a SAS log');
+                    expect(log.issues).toEqual([]);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('reports a path that is not a file', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var folder, log;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, tempFolder()];
+                case 1:
+                    folder = _a.sent();
+                    return [4 /*yield*/, (0, collectLogs_1.scanLogFile)(folder, types_1.defaultLogCheckConfig)];
+                case 2:
+                    log = _a.sent();
+                    expect(log.skippedReason).toEqual('not a file');
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('reports a file that vanished before it could be read', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var folder, log;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, tempFolder()];
+                case 1:
+                    folder = _a.sent();
+                    return [4 /*yield*/, (0, collectLogs_1.scanLogFile)(path_1.default.join(folder, 'missing.log'), types_1.defaultLogCheckConfig)];
+                case 2:
+                    log = _a.sent();
+                    expect(log.skippedReason).toEqual('could not be read');
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('sets a suppressed issue aside instead of reporting it', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var folder, filePath, log;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, tempFolder()];
+                case 1:
+                    folder = _a.sent();
+                    filePath = path_1.default.join(folder, 'run.log');
+                    return [4 /*yield*/, fs_1.promises.writeFile(filePath, sasLog)];
+                case 2:
+                    _a.sent();
+                    return [4 /*yield*/, (0, collectLogs_1.scanLogFile)(filePath, __assign(__assign({}, types_1.defaultLogCheckConfig), { ignoreCodes: ['22-322'] }))];
+                case 3:
+                    log = _a.sent();
+                    expect(log.issues.map(function (issue) { return issue.severity; })).toEqual([
+                        'warning',
+                        'note'
+                    ]);
+                    expect(log.suppressed).toHaveLength(1);
+                    expect(log.suppressed[0].code).toEqual('22-322');
+                    expect(log.counts).toEqual({ errors: 0, warnings: 1, notes: 1 });
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});
+describe('partitionIssues', function () {
+    var issues = [
+        {
+            line: 0,
+            endLine: 0,
+            column: 0,
+            endColumn: 5,
+            severity: 'error',
+            code: '22-322',
+            message: 'Syntax error'
+        },
+        {
+            line: 1,
+            endLine: 1,
+            column: 0,
+            endColumn: 5,
+            severity: 'warning',
+            message: 'Apparent symbolic reference'
+        },
+        {
+            line: 2,
+            endLine: 2,
+            column: 0,
+            endColumn: 5,
+            severity: 'note',
+            code: '49-169',
+            message: 'Line was truncated'
+        }
+    ];
+    it('keeps every issue when nothing is suppressed', function () {
+        var _a = (0, collectLogs_1.partitionIssues)(issues, []), kept = _a.issues, suppressed = _a.suppressed;
+        expect(kept).toHaveLength(3);
+        expect(suppressed).toHaveLength(0);
+    });
+    it('suppresses by message code, and leaves an uncoded issue alone', function () {
+        var _a = (0, collectLogs_1.partitionIssues)(issues, [
+            '22-322',
+            '49-169'
+        ]), kept = _a.issues, suppressed = _a.suppressed;
+        expect(kept).toHaveLength(1);
+        expect(kept[0].severity).toEqual('warning');
+        expect(suppressed).toHaveLength(2);
+    });
+});
+describe('countIssues', function () {
+    it('counts by severity', function () {
+        expect((0, collectLogs_1.countIssues)([
+            { severity: 'error' },
+            { severity: 'error' },
+            { severity: 'warning' },
+            { severity: 'note' }
+        ])).toEqual({ errors: 2, warnings: 1, notes: 1 });
+    });
+});

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

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