@sasjs/cli 6.5.0 → 6.7.0

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

@@ -0,0 +1,323 @@
+"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 logCheckConfig_1 = require("../logCheckConfig");
+var types_1 = require("../types");
+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-config-'))];
+        case 1: return [2 /*return*/, _a.sent()];
+    }
+}); }); };
+describe('parseLogCheckSection', function () {
+    it('returns the defaults when the section is absent', function () {
+        expect((0, logCheckConfig_1.parseLogCheckSection)(undefined)).toEqual(types_1.defaultLogCheckConfig);
+        expect((0, logCheckConfig_1.parseLogCheckSection)(null)).toEqual(types_1.defaultLogCheckConfig);
+    });
+    it('returns the defaults when the section is empty', function () {
+        expect((0, logCheckConfig_1.parseLogCheckSection)({})).toEqual(types_1.defaultLogCheckConfig);
+    });
+    it('reads every supported setting', function () {
+        var config = (0, logCheckConfig_1.parseLogCheckSection)({
+            failOn: 'warning',
+            maxWarnings: 4,
+            ignoreCodes: ['49-169'],
+            ignorePaths: ['sasjsresults/legacy'],
+            folder: 'logs'
+        });
+        expect(config).toEqual({
+            failOn: 'warning',
+            maxWarnings: 4,
+            ignoreCodes: ['49-169'],
+            ignorePaths: ['sasjsresults/legacy'],
+            folder: 'logs'
+        });
+    });
+    it('refuses a failOn that is not one of the four policies', function () {
+        expect(function () { return (0, logCheckConfig_1.parseLogCheckSection)({ failOn: 'warnings' }); }).toThrow('must be one of error, warning, note, never');
+    });
+    it('refuses a maxWarnings that is not a whole number of zero or more', function () {
+        expect(function () { return (0, logCheckConfig_1.parseLogCheckSection)({ maxWarnings: -1 }); }).toThrow('whole number of zero or more');
+        expect(function () { return (0, logCheckConfig_1.parseLogCheckSection)({ maxWarnings: 1.5 }); }).toThrow('whole number of zero or more');
+        expect(function () { return (0, logCheckConfig_1.parseLogCheckSection)({ maxWarnings: '3' }); }).toThrow('whole number of zero or more');
+    });
+    it('refuses a suppressions list that is not an array of strings', function () {
+        expect(function () { return (0, logCheckConfig_1.parseLogCheckSection)({ ignoreCodes: '49-169' }); }).toThrow('must be an array of strings');
+        expect(function () { return (0, logCheckConfig_1.parseLogCheckSection)({ ignorePaths: [1] }); }).toThrow('must be an array of strings');
+    });
+    it('refuses an empty folder name', function () {
+        expect(function () { return (0, logCheckConfig_1.parseLogCheckSection)({ folder: '  ' }); }).toThrow('must be a non-empty string');
+    });
+    it('refuses a section that is not an object', function () {
+        expect(function () { return (0, logCheckConfig_1.parseLogCheckSection)(['failOn'], 'sasjsconfig.json'); }).toThrow('must be an object');
+        expect(function () { return (0, logCheckConfig_1.parseLogCheckSection)('error', 'sasjsconfig.json'); }).toThrow('must be an object');
+    });
+    it('trims and de-duplicates the suppressions', function () {
+        var config = (0, logCheckConfig_1.parseLogCheckSection)({
+            ignoreCodes: [' 49-169 ', '49-169', ''],
+            ignorePaths: ['a', 'a']
+        });
+        expect(config.ignoreCodes).toEqual(['49-169']);
+        expect(config.ignorePaths).toEqual(['a']);
+    });
+});
+describe('readLogCheckConfig', function () {
+    var originalProjectDir = process.projectDir;
+    afterEach(function () {
+        process.projectDir = originalProjectDir;
+    });
+    var withConfig = function (contents) { return __awaiter(void 0, void 0, void 0, function () {
+        var folder;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, tempFolder()];
+                case 1:
+                    folder = _a.sent();
+                    process.projectDir = folder;
+                    if (!(contents !== undefined)) return [3 /*break*/, 3];
+                    return [4 /*yield*/, fs_1.promises.writeFile(path_1.default.join(folder, 'sasjsconfig.json'), typeof contents === 'string' ? contents : JSON.stringify(contents))];
+                case 2:
+                    _a.sent();
+                    _a.label = 3;
+                case 3: return [2 /*return*/, folder];
+            }
+        });
+    }); };
+    it('returns the defaults when the project has no sasjsconfig.json', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0: return [4 /*yield*/, withConfig(undefined)];
+                case 1:
+                    _b.sent();
+                    _a = expect;
+                    return [4 /*yield*/, (0, logCheckConfig_1.readLogCheckConfig)()];
+                case 2:
+                    _a.apply(void 0, [_b.sent()]).toEqual(types_1.defaultLogCheckConfig);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('reads the section from the top level of the config', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0: return [4 /*yield*/, withConfig({ logCheck: { failOn: 'note' } })];
+                case 1:
+                    _b.sent();
+                    _a = expect;
+                    return [4 /*yield*/, (0, logCheckConfig_1.readLogCheckConfig)()];
+                case 2:
+                    _a.apply(void 0, [(_b.sent()).failOn]).toEqual('note');
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('reads the section from a wrapped config', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0: return [4 /*yield*/, withConfig({ config: { logCheck: { failOn: 'never' } } })];
+                case 1:
+                    _b.sent();
+                    _a = expect;
+                    return [4 /*yield*/, (0, logCheckConfig_1.readLogCheckConfig)()];
+                case 2:
+                    _a.apply(void 0, [(_b.sent()).failOn]).toEqual('never');
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('follows the project results folder a config names', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0: return [4 /*yield*/, withConfig({ sasjsResultsFolder: 'build-output/results' })];
+                case 1:
+                    _b.sent();
+                    _a = expect;
+                    return [4 /*yield*/, (0, logCheckConfig_1.readLogCheckConfig)()];
+                case 2:
+                    _a.apply(void 0, [(_b.sent()).folder]).toEqual('build-output/results');
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('prefers the folder the logCheck section names', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0: return [4 /*yield*/, withConfig({
+                        sasjsResultsFolder: 'build-output/results',
+                        logCheck: { folder: 'logs' }
+                    })];
+                case 1:
+                    _b.sent();
+                    _a = expect;
+                    return [4 /*yield*/, (0, logCheckConfig_1.readLogCheckConfig)()];
+                case 2:
+                    _a.apply(void 0, [(_b.sent()).folder]).toEqual('logs');
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('fails loudly on a config that is not valid JSON', function () { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, withConfig('{ "logCheck": ')];
+                case 1:
+                    _a.sent();
+                    return [4 /*yield*/, expect((0, logCheckConfig_1.readLogCheckConfig)()).rejects.toThrow('Could not parse')];
+                case 2:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});
+describe('mergeConfig', function () {
+    var base = __assign(__assign({}, types_1.defaultLogCheckConfig), { ignoreCodes: ['49-169'], ignorePaths: ['legacy'] });
+    it('prefers the command line over the file', function () {
+        var merged = (0, logCheckConfig_1.mergeConfig)(__assign(__assign({}, base), { failOn: 'error' }), { failOn: 'note' });
+        expect(merged.failOn).toEqual('note');
+    });
+    it('returns the config unchanged when there are no overrides', function () {
+        expect((0, logCheckConfig_1.mergeConfig)(__assign(__assign({}, base), { failOn: 'note' })).failOn).toEqual('note');
+    });
+    it('keeps the file value when the flag is absent', function () {
+        expect((0, logCheckConfig_1.mergeConfig)(__assign(__assign({}, base), { maxWarnings: 5 }), {}).maxWarnings).toEqual(5);
+    });
+    it('adds suppressions instead of replacing them', function () {
+        var merged = (0, logCheckConfig_1.mergeConfig)(base, {
+            ignoreCodes: ['22-322'],
+            ignorePaths: ['build.log']
+        });
+        expect(merged.ignoreCodes).toEqual(['49-169', '22-322']);
+        expect(merged.ignorePaths).toEqual(['legacy', 'build.log']);
+    });
+    it('does not mutate the config it was given', function () {
+        var config = __assign(__assign({}, base), { ignoreCodes: ['49-169'] });
+        (0, logCheckConfig_1.mergeConfig)(config, { ignoreCodes: ['22-322'] });
+        expect(config.ignoreCodes).toEqual(['49-169']);
+    });
+    it('treats an empty override list as no override', function () {
+        expect((0, logCheckConfig_1.mergeConfig)(base, { ignoreCodes: [] }).ignoreCodes).toEqual([
+            '49-169'
+        ]);
+    });
+});
+describe('matchesPath', function () {
+    it('matches a plain entry as whole path segments', function () {
+        expect((0, logCheckConfig_1.matchesPath)('sasjsresults/legacy/run.log', 'sasjsresults/legacy')).toBe(true);
+        expect((0, logCheckConfig_1.matchesPath)('sasjsresults/run.log', 'sasjsresults/legacy')).toBe(false);
+        expect((0, logCheckConfig_1.matchesPath)('sasjsresults/legacy', 'sasjsresults/legacy')).toBe(true);
+    });
+    it('does not let a fragment of a name silence a file', function () {
+        // The reviewer's case: `test` silencing `latest.log`, and `logs` silencing
+        // anything that merely contains it.
+        expect((0, logCheckConfig_1.matchesPath)('latest.log', 'test')).toBe(false);
+        expect((0, logCheckConfig_1.matchesPath)('sasjsresults/nested-logs/run.log', 'logs')).toBe(false);
+        expect((0, logCheckConfig_1.matchesPath)('sasjsresults/run.log', 'run')).toBe(false);
+    });
+    it('matches at any depth, on a segment boundary', function () {
+        expect((0, logCheckConfig_1.matchesPath)('test/run.log', 'test')).toBe(true);
+        expect((0, logCheckConfig_1.matchesPath)('sasjsresults/test/run.log', 'test')).toBe(true);
+        expect((0, logCheckConfig_1.matchesPath)('sasjsresults/latest-test/run.log', 'test')).toBe(false);
+    });
+    it('ignores a leading `./` and a trailing separator', function () {
+        expect((0, logCheckConfig_1.matchesPath)('logs/run.log', './logs/')).toBe(true);
+    });
+    it('matches a single wildcard without crossing folders', function () {
+        expect((0, logCheckConfig_1.matchesPath)('sasjsresults/build.log', 'sasjsresults/*.log')).toBe(true);
+        expect((0, logCheckConfig_1.matchesPath)('sasjsresults/nested/build.log', 'sasjsresults/*.log')).toBe(false);
+    });
+    it('lets a leading double wildcard match the folder itself', function () {
+        expect((0, logCheckConfig_1.matchesPath)('build.log', '**/build.log')).toBe(true);
+        expect((0, logCheckConfig_1.matchesPath)('a/b/build.log', '**/build.log')).toBe(true);
+    });
+    it('matches a single character wildcard', function () {
+        expect((0, logCheckConfig_1.matchesPath)('logs/a1.log', 'logs/a?.log')).toBe(true);
+        expect((0, logCheckConfig_1.matchesPath)('logs/a12.log', 'logs/a?.log')).toBe(false);
+    });
+    it('ignores an empty pattern', function () {
+        expect((0, logCheckConfig_1.matchesPath)('sasjsresults/run.log', '   ')).toBe(false);
+    });
+    it('reads a Windows path the same way as a POSIX one', function () {
+        var windowsPath = ['sasjsresults', 'run.log'].join(path_1.default.sep);
+        expect((0, logCheckConfig_1.matchesPath)(windowsPath, 'sasjsresults/run.log')).toBe(true);
+    });
+    it('reports whether any pattern covers the path', function () {
+        expect((0, logCheckConfig_1.isIgnoredPath)('a/b.log', ['x', '**/b.log'])).toBe(true);
+        expect((0, logCheckConfig_1.isIgnoredPath)('a/c.log', ['x', '**/b.log'])).toBe(false);
+    });
+});
+describe('globToRegExp', function () {
+    it('escapes the regular-expression characters of a literal pattern', function () {
+        expect((0, logCheckConfig_1.globToRegExp)('logs/a+b.log').test('logs/a+b.log')).toBe(true);
+        expect((0, logCheckConfig_1.globToRegExp)('logs/a+b.log').test('logs/aab.log')).toBe(false);
+    });
+    it('anchors the pattern at both ends', function () {
+        expect((0, logCheckConfig_1.globToRegExp)('run.log').test('myrun.log')).toBe(false);
+    });
+    it('treats a double wildcard anywhere as any characters', function () {
+        expect((0, logCheckConfig_1.globToRegExp)('logs/**/x.log').test('logs/x.log')).toBe(true);
+        expect((0, logCheckConfig_1.globToRegExp)('logs/**/x.log').test('logs/a/b/x.log')).toBe(true);
+    });
+});
+describe('toPosix', function () {
+    it('uses forward slashes on every platform', function () {
+        expect((0, logCheckConfig_1.toPosix)(['a', 'b.log'].join(path_1.default.sep))).toEqual('a/b.log');
+    });
+});

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

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