@sasjs/cli 6.7.0 → 6.8.0

package/README.md

@@ -23,7 +23,7 @@
 - Optionally synchronise a local folder onto the server filesystem using `sasjs fs`
 - Trigger Viya Jobs & Flows (`sasjs job execute` / `sasjs flow execute`)
 - Enforce code quality rules with `sasjs lint`
-- Check what SAS actually printed, and fail a pipeline on it, with `sasjs logcheck`
+- Check what SAS actually printed, and fail a pipeline on it, with `sasjs logcheck` - the same check reports the log of `run`, `request`, `job execute` and `flow execute`, and can fail those commands too via `logCheck.autoCheck`
 - Generate HTML5 documentation (requires doxygen) with `sasjs doc`
 - Create and execute SAS tests (`sasjs test`)
 

package/build/commands/flow/flowCommand.js

@@ -60,6 +60,7 @@ var command_1 = require("../../types/command");
 var targetCommand_1 = require("../../types/command/targetCommand");
 var utils_1 = require("../../utils");
 var execute_1 = require("./execute");
+var logcheck_1 = require("../../utils/logcheck");
 var FlowSubCommand;
 (function (FlowSubCommand) {
     FlowSubCommand["Execute"] = "execute";
@@ -97,6 +98,11 @@ var executeParseOptions = {
     streamLog: {
         type: 'boolean',
         description: 'Flag indicating whether the logs should be streamed to a local file as the job executes.'
+    },
+    logcheck: {
+        type: 'boolean',
+        default: undefined,
+        description: 'Check the log of every job in the flow, and fail when logCheck in sasjsconfig.json says so. --no-logcheck switches both the report and the verdict off. A log streamed with --streamLog goes straight to its file and is not checked.'
     }
 };
 var FlowCommand = /** @class */ (function (_super) {
@@ -117,7 +123,9 @@ var FlowCommand = /** @class */ (function (_super) {
             var target, sasjs, authConfig, _a;
             return __generator(this, function (_b) {
                 switch (_b.label) {
-                    case 0: return [4 /*yield*/, this.getTargetInfo()];
+                    case 0:
+                        (0, logcheck_1.setLogCheckMode)((0, logcheck_1.logCheckModeOf)(this.parsed.logcheck));
+                        return [4 /*yield*/, this.getTargetInfo()];
                     case 1:
                         target = (_b.sent()).target;
                         sasjs = (0, utils_1.getSASjs)(target);
@@ -160,6 +168,8 @@ var FlowCommand = /** @class */ (function (_super) {
                                 return command_1.ReturnCode.Success;
                             })
                                 .catch(function (err) {
+                                if ((0, logcheck_1.isLogCheckFailure)(err))
+                                    return command_1.ReturnCode.LogCheckError;
                                 (0, utils_1.displayError)(err, 'An error has occurred when executing this flow.');
                                 return command_1.ReturnCode.InternalError;
                             })];

package/build/commands/flow/internal/executeFlow.js

@@ -44,6 +44,7 @@ var utils_1 = require("../../../utils");
 var _1 = require(".");
 var csvColumns_1 = __importDefault(require("./csvColumns"));
 var flow_1 = require("../../../types/flow");
+var logcheck_1 = require("../../../utils/logcheck");
 var executeFlow = function (flow, sasjs, pollOptions, target, authConfig, csvFile) { return __awaiter(void 0, void 0, void 0, function () {
     var logFolder, flowName, jobStatus, flowStatus;
     return __generator(this, function (_a) {
@@ -55,10 +56,10 @@ var executeFlow = function (flow, sasjs, pollOptions, target, authConfig, csvFil
                 jobStatus = true, flowStatus = { terminate: false, message: '' };
                 flow.execution = 'started';
                 return [4 /*yield*/, Promise.all(flow.jobs.map(function (job) { return __awaiter(void 0, void 0, void 0, function () {
-                        var jobLocation, logName, submittedJob, details, predecessors, data;
-                        var _a, _b;
-                        return __generator(this, function (_c) {
-                            switch (_c.label) {
+                        var jobLocation, logName, submittedJob, details, jobLogText, savedLog, predecessors, data;
+                        var _a, _b, _c;
+                        return __generator(this, function (_d) {
+                            switch (_d.label) {
                                 case 0:
                                     jobLocation = (0, utils_1.prefixAppLoc)(target.appLoc, job.location);
                                     (0, utils_1.displaySuccess)("'".concat(job.location, "' has been submitted for execution."));
@@ -71,7 +72,7 @@ var executeFlow = function (flow, sasjs, pollOptions, target, authConfig, csvFil
                                             contextName: target.contextName
                                         }, authConfig, true, pollOptions, true, job.macroVars, undefined, (0, utils_1.persistTokensRefreshedByAdapter)(target))
                                             .catch(function (err) { return __awaiter(void 0, void 0, void 0, function () {
-                                            var logName, predecessors, data;
+                                            var savedLog, predecessors, data;
                                             var _a, _b, _c, _d;
                                             return __generator(this, function (_e) {
                                                 switch (_e.label) {
@@ -88,8 +89,10 @@ var executeFlow = function (flow, sasjs, pollOptions, target, authConfig, csvFil
                                                                 (0, utils_1.displayError)(err, 'Error while saving log file.');
                                                             })];
                                                     case 1:
-                                                        logName = _e.sent();
-                                                        logName = logName ? "".concat(logFolder, "/").concat(logName) : '';
+                                                        savedLog = _e.sent();
+                                                        logName = (savedLog === null || savedLog === void 0 ? void 0 : savedLog.fileName)
+                                                            ? "".concat(logFolder, "/").concat(savedLog.fileName)
+                                                            : '';
                                                         predecessors = ((_c = flow.predecessors) === null || _c === void 0 ? void 0 : _c.length)
                                                             ? flow.predecessors
                                                             : ['none'];
@@ -103,9 +106,18 @@ var executeFlow = function (flow, sasjs, pollOptions, target, authConfig, csvFil
                                                         ];
                                                         return [4 /*yield*/, (0, _1.saveToCsv)(csvFile, data, Object.values(csvColumns_1.default), 'id').catch(function (err) {
                                                                 (0, utils_1.displayError)(err, 'Error while saving CSV file.');
-                                                            })];
+                                                            })
+                                                            // after the report and the log file: a check that fails is still a job
+                                                            // someone has to find in the CSV, with its log on disk
+                                                        ];
                                                     case 2:
                                                         _e.sent();
+                                                        if (!(savedLog === null || savedLog === void 0 ? void 0 : savedLog.logText)) return [3 /*break*/, 4];
+                                                        return [4 /*yield*/, (0, logcheck_1.checkLog)(savedLog.logText, "".concat(flowName, "/").concat(jobLocation))];
+                                                    case 3:
+                                                        _e.sent();
+                                                        _e.label = 4;
+                                                    case 4:
                                                         job.status = flow_1.FlowWaveJobStatus.Failure;
                                                         if (logName) {
                                                             (_d = process.logger) === null || _d === void 0 ? void 0 : _d.info("Log file located at: ".concat((0, _1.normalizeFilePath)(logName)));
@@ -120,20 +132,24 @@ var executeFlow = function (flow, sasjs, pollOptions, target, authConfig, csvFil
                                             });
                                         }); })];
                                 case 1:
-                                    submittedJob = _c.sent();
-                                    if (!(submittedJob === null || submittedJob === void 0 ? void 0 : submittedJob.job)) return [3 /*break*/, 5];
+                                    submittedJob = _d.sent();
+                                    if (!(submittedJob === null || submittedJob === void 0 ? void 0 : submittedJob.job)) return [3 /*break*/, 7];
                                     submittedJob = submittedJob.job;
                                     details = (0, _1.parseJobDetails)(submittedJob);
+                                    jobLogText = '';
                                     if (!!pollOptions.streamLog) return [3 /*break*/, 3];
                                     return [4 /*yield*/, (0, _1.saveLog)(submittedJob.links, flowName, jobLocation, logFolder, sasjs, target.serverUrl, authConfig.access_token, details === null || details === void 0 ? void 0 : details.lineCount).catch(function (err) {
                                             (0, utils_1.displayError)(err, 'Error while saving log file.');
                                         })];
                                 case 2:
-                                    logName = (_c.sent());
-                                    logName = logName ? "".concat(logFolder, "/").concat(logName) : '';
-                                    _c.label = 3;
+                                    savedLog = _d.sent();
+                                    logName = (savedLog === null || savedLog === void 0 ? void 0 : savedLog.fileName)
+                                        ? "".concat(logFolder, "/").concat(savedLog.fileName)
+                                        : '';
+                                    jobLogText = (_a = savedLog === null || savedLog === void 0 ? void 0 : savedLog.logText) !== null && _a !== void 0 ? _a : '';
+                                    _d.label = 3;
                                 case 3:
-                                    predecessors = ((_a = flow.predecessors) === null || _a === void 0 ? void 0 : _a.length)
+                                    predecessors = ((_b = flow.predecessors) === null || _b === void 0 ? void 0 : _b.length)
                                         ? flow.predecessors
                                         : ['none'];
                                     data = [
@@ -144,9 +160,18 @@ var executeFlow = function (flow, sasjs, pollOptions, target, authConfig, csvFil
                                         logName,
                                         details === null || details === void 0 ? void 0 : details.details
                                     ];
-                                    return [4 /*yield*/, (0, _1.saveToCsv)(csvFile, data, Object.values(csvColumns_1.default), 'id').catch(function (err) { return (0, utils_1.displayError)(err, 'Error while saving CSV file.'); })];
+                                    return [4 /*yield*/, (0, _1.saveToCsv)(csvFile, data, Object.values(csvColumns_1.default), 'id').catch(function (err) { return (0, utils_1.displayError)(err, 'Error while saving CSV file.'); })
+                                        // after the report and the log file: a check that fails is still a job
+                                        // someone has to find in the CSV, with its log on disk
+                                    ];
                                 case 4:
-                                    _c.sent();
+                                    _d.sent();
+                                    if (!jobLogText) return [3 /*break*/, 6];
+                                    return [4 /*yield*/, (0, logcheck_1.checkLog)(jobLogText, "".concat(flowName, "/").concat(jobLocation))];
+                                case 5:
+                                    _d.sent();
+                                    _d.label = 6;
+                                case 6:
                                     job.status =
                                         submittedJob.state === 'completed'
                                             ? 'success'
@@ -160,7 +185,7 @@ var executeFlow = function (flow, sasjs, pollOptions, target, authConfig, csvFil
                                             : ''));
                                     }
                                     if (logName) {
-                                        (_b = process.logger) === null || _b === void 0 ? void 0 : _b.info("Log file located at: ".concat((0, _1.normalizeFilePath)(logName)));
+                                        (_c = process.logger) === null || _c === void 0 ? void 0 : _c.info("Log file located at: ".concat((0, _1.normalizeFilePath)(logName)));
                                     }
                                     if (flow.jobs.filter(function (j) { return j.status === 'success'; })
                                         .length === flow.jobs.length) {
@@ -171,8 +196,8 @@ var executeFlow = function (flow, sasjs, pollOptions, target, authConfig, csvFil
                                         (0, utils_1.displayError)({}, "'".concat(flowName, "' flow failed!"));
                                         jobStatus = false;
                                     }
-                                    _c.label = 5;
-                                case 5: return [2 /*return*/];
+                                    _d.label = 7;
+                                case 7: return [2 /*return*/];
                             }
                         });
                     }); }))];

package/build/commands/flow/internal/saveLog.d.ts

@@ -1,2 +1,13 @@
 import SASjs from '@sasjs/adapter/node';
-export declare const saveLog: (links: any[], flowName: string, jobLocation: string, logFolder: string, sasjs: SASjs, serverUrl: string, access_token: string, lineCount?: number) => Promise<string | null>;
+/**
+ * A job's log, both as written and as text.
+ *
+ * The caller checks the text after the file is on disk: a job whose log fails
+ * the check is exactly the job whose log is wanted for reading, so writing it
+ * first is the difference between a diagnosable failure and an empty folder.
+ */
+export interface SavedFlowLog {
+    fileName: string | null;
+    logText: string;
+}
+export declare const saveLog: (links: any[], flowName: string, jobLocation: string, logFolder: string, sasjs: SASjs, serverUrl: string, access_token: string, lineCount?: number) => Promise<SavedFlowLog>;

package/build/commands/flow/internal/saveLog.js

@@ -108,8 +108,8 @@ var saveLog = function (links_1, flowName_1, jobLocation_1, logFolder_1, sasjs_1
                     })];
                 case 5:
                     _a.sent();
-                    return [2 /*return*/, logName];
-                case 6: return [2 /*return*/, null];
+                    return [2 /*return*/, { fileName: logName, logText: logParsed }];
+                case 6: return [2 /*return*/, { fileName: null, logText: '' }];
             }
         });
     });

package/build/commands/flow/internal/spec/executeFlow.spec.js

@@ -78,6 +78,7 @@ var executeFlow_1 = require("../executeFlow");
 var saveLogModule = __importStar(require("../saveLog"));
 var saveToCsvModule = __importStar(require("../saveToCsv"));
 var normalizeFilePath = __importStar(require("../normalizeFilePath"));
+var logcheckModule = __importStar(require("../../../../utils/logcheck"));
 var csvColumns_1 = __importDefault(require("../csvColumns"));
 var pollOptions = {
     maxPollCount: 0,
@@ -103,7 +104,9 @@ describe('executeFlow', function () {
     beforeEach(function () {
         jest
             .spyOn(saveLogModule, 'saveLog')
-            .mockImplementation(function () { return Promise.resolve(fakeLogFileName); });
+            .mockImplementation(function () {
+            return Promise.resolve({ fileName: fakeLogFileName, logText: '' });
+        });
         jest
             .spyOn(saveToCsvModule, 'saveToCsv')
             .mockImplementation(function () { return Promise.resolve(); });
@@ -244,6 +247,46 @@ describe('executeFlow', function () {
             }
         });
     }); });
+    it('writes the report and the log before a failing check stops the flow', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var flowName, flow, saveLogSpy, csvSpy, checkSpy;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    flowName = 'checkedFlow';
+                    flow = {
+                        name: flowName,
+                        jobs: [{ location: 'jobs/testJob/job' }],
+                        predecessors: []
+                    };
+                    jest
+                        .spyOn(sasjs, 'startComputeJob')
+                        .mockResolvedValue({ job: { state: 'success' } });
+                    saveLogSpy = jest
+                        .spyOn(saveLogModule, 'saveLog')
+                        .mockImplementation(function () {
+                        return Promise.resolve({ fileName: fakeLogFileName, logText: 'ERROR 22-322' });
+                    });
+                    csvSpy = jest
+                        .spyOn(saveToCsvModule, 'saveToCsv')
+                        .mockImplementation(function () { return Promise.resolve(); });
+                    checkSpy = jest
+                        .spyOn(logcheckModule, 'checkLog')
+                        .mockRejectedValue(new Error('SAS log check failed'));
+                    return [4 /*yield*/, expect((0, executeFlow_1.executeFlow)(flow, sasjs, pollOptions, target, {}, '')).rejects.toThrow('SAS log check failed')
+                        // the job whose log fails the check is the job a reader has to find in the
+                        // CSV, with its log on disk
+                    ];
+                case 1:
+                    _a.sent();
+                    // the job whose log fails the check is the job a reader has to find in the
+                    // CSV, with its log on disk
+                    expect(saveLogSpy.mock.invocationCallOrder[0]).toBeLessThan(checkSpy.mock.invocationCallOrder[0]);
+                    expect(csvSpy.mock.invocationCallOrder[0]).toBeLessThan(checkSpy.mock.invocationCallOrder[0]);
+                    checkSpy.mockRestore();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
 });
 var validateSaveToCsv = function (jobExecutionInOrder) {
     expect(saveToCsvModule.saveToCsv).toHaveBeenCalledTimes(jobExecutionInOrder.length);

package/build/commands/flow/spec/flowCommand.spec.js

@@ -100,6 +100,7 @@ var utils_1 = require("@sasjs/utils");
 var configUtils = __importStar(require("../../../utils/config"));
 var setConstantsUtils = __importStar(require("../../../utils/setConstants"));
 var command_1 = require("../../../types/command");
+var logcheck_1 = require("../../../utils/logcheck");
 var defaultArgs = ['node', 'sasjs'];
 var target = new utils_1.Target({
     name: 'test',
@@ -115,6 +116,49 @@ describe('FlowCommand', function () {
     beforeEach(function () {
         setupMocks();
     });
+    afterEach(function () { return (0, logcheck_1.setLogCheckMode)('auto'); });
+    it('should return the logcheck code when the log check failed the flow', 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(executeModule, 'execute')
+                        .mockImplementation(function () { return Promise.reject(new logcheck_1.LogCheckFailure('3 errors')); });
+                    command = new flowCommand_1.FlowCommand(__spreadArray(__spreadArray([], __read(defaultArgs), false), [
+                        'flow',
+                        'execute',
+                        '--source',
+                        source
+                    ], false));
+                    _a = expect;
+                    return [4 /*yield*/, command.execute()];
+                case 1:
+                    _a.apply(void 0, [_b.sent()]).toEqual(command_1.ReturnCode.LogCheckError);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('should switch the log check off for --no-logcheck', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var command;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    command = new flowCommand_1.FlowCommand(__spreadArray(__spreadArray([], __read(defaultArgs), false), [
+                        'flow',
+                        'execute',
+                        '--source',
+                        source,
+                        '--no-logcheck'
+                    ], false));
+                    return [4 /*yield*/, command.execute()];
+                case 1:
+                    _a.sent();
+                    expect((0, logcheck_1.getLogCheckMode)()).toEqual('off');
+                    return [2 /*return*/];
+            }
+        });
+    }); });
     it('should parse sasjs flow execute command', function () { return __awaiter(void 0, void 0, void 0, function () {
         var args, command, targetInfo;
         return __generator(this, function (_a) {

package/build/commands/job/internal/execute/sas9.js

@@ -39,6 +39,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.executeJobSas9 = executeJobSas9;
 var utils_1 = require("../utils");
 var parseSourceFile_1 = require("../../../../utils/parseSourceFile");
+var logcheck_1 = require("../../../../utils/logcheck");
 /**
  * Triggers an existing Stored Process for execution as a "job".  See online documentation here: https://cli.sasjs.io/job/
  * @param {object} sasjs - Configuration object of the SASJS adapter.
@@ -70,30 +71,32 @@ function executeJobSas9(sasjs, config, jobPath, logFile, output, source) {
                 case 3:
                     result = _a.sent();
                     endTime = new Date().getTime();
-                    if (!result) return [3 /*break*/, 9];
-                    if (!(result.status === 200)) return [3 /*break*/, 8];
+                    if (!result) return [3 /*break*/, 10];
+                    if (!(result.status === 200)) return [3 /*break*/, 9];
                     // handle success
                     process.logger.success("Job executed successfully! in ".concat((endTime - startTime) / 1000, " seconds"));
                     if (!(!!logFile && result.log)) return [3 /*break*/, 5];
-                    return [4 /*yield*/, (0, utils_1.saveLog)(result.log, logFile, jobPath)
-                        // save output if it is present
-                    ];
+                    return [4 /*yield*/, (0, utils_1.saveLog)(result.log, logFile, jobPath)];
                 case 4:
                     _a.sent();
                     _a.label = 5;
-                case 5:
-                    if (!(!!output && result.result)) return [3 /*break*/, 7];
-                    return [4 /*yield*/, (0, utils_1.saveOutput)(result.result, output)];
+                case 5: return [4 /*yield*/, (0, logcheck_1.checkLog)(result.log, jobPath)
+                    // save output if it is present
+                ];
                 case 6:
                     _a.sent();
-                    _a.label = 7;
-                case 7: return [3 /*break*/, 9];
-                case 8:
+                    if (!(!!output && result.result)) return [3 /*break*/, 8];
+                    return [4 /*yield*/, (0, utils_1.saveOutput)(result.result, output)];
+                case 7:
+                    _a.sent();
+                    _a.label = 8;
+                case 8: return [3 /*break*/, 10];
+                case 9:
                     // handle failure
                     process.logger.error(result.message);
                     process.logger.error(JSON.stringify(result.error, null, 2));
-                    _a.label = 9;
-                case 9: return [2 /*return*/, result];
+                    _a.label = 10;
+                case 10: return [2 /*return*/, result];
             }
         });
     });

package/build/commands/job/internal/execute/sasjs.js

@@ -38,6 +38,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.executeJobSasjs = executeJobSasjs;
 var utils_1 = require("../utils");
+var logcheck_1 = require("../../../../utils/logcheck");
 /**
  * Triggers existing job for execution on SASJS server.
  * @param {object} sasjs - configuration object of SAS adapter.
@@ -58,23 +59,25 @@ function executeJobSasjs(sasjs, target, jobPath, logFile, output, authConfig) {
                     }, target.appLoc, authConfig)];
                 case 1:
                     response = _b.sent();
-                    if (!response) return [3 /*break*/, 5];
+                    if (!response) return [3 /*break*/, 6];
                     // handle success
                     (_a = process.logger) === null || _a === void 0 ? void 0 : _a.success('Job executed successfully!');
                     if (!(!!logFile && response.log)) return [3 /*break*/, 3];
-                    return [4 /*yield*/, (0, utils_1.saveLog)(response.log, logFile, jobPath)
-                        // save output if it is present
-                    ];
+                    return [4 /*yield*/, (0, utils_1.saveLog)(response.log, logFile, jobPath)];
                 case 2:
                     _b.sent();
                     _b.label = 3;
-                case 3:
-                    if (!(!!output && response.result)) return [3 /*break*/, 5];
-                    return [4 /*yield*/, (0, utils_1.saveOutput)(response.result, output)];
+                case 3: return [4 /*yield*/, (0, logcheck_1.checkLog)(response.log, jobPath)
+                    // save output if it is present
+                ];
                 case 4:
                     _b.sent();
-                    _b.label = 5;
-                case 5: return [2 /*return*/, response];
+                    if (!(!!output && response.result)) return [3 /*break*/, 6];
+                    return [4 /*yield*/, (0, utils_1.saveOutput)(response.result, output)];
+                case 5:
+                    _b.sent();
+                    _b.label = 6;
+                case 6: return [2 /*return*/, response];
             }
         });
     });