@sasjs/cli 6.8.0 → 6.8.1

package/build/commands/fs/fsCommand.d.ts

@@ -7,6 +7,6 @@ export declare class FSCommand extends TargetCommand {
     getOutputPath(): Promise<string>;
     execute(): Promise<ReturnCode>;
     compile(): Promise<ReturnCode>;
-    deploy(): Promise<ReturnCode.Success | ReturnCode.InternalError>;
-    sync(): Promise<ReturnCode.Success | ReturnCode.InternalError>;
+    deploy(): Promise<ReturnCode.Success | ReturnCode.InternalError | ReturnCode.LogCheckError>;
+    sync(): Promise<ReturnCode.Success | ReturnCode.InternalError | ReturnCode.LogCheckError>;
 }

package/build/commands/fs/fsCommand.js

@@ -113,6 +113,7 @@ var utils_2 = require("@sasjs/utils");
 // bundle that imported anything from the barrel (sasjs/utils#275, #283).
 var fs_1 = require("@sasjs/utils/fs");
 var executeCode_1 = require("./internal/executeCode");
+var logcheck_1 = require("../../utils/logcheck");
 var FsSubCommand;
 (function (FsSubCommand) {
     FsSubCommand["Compile"] = "compile";
@@ -123,7 +124,12 @@ var syntax = 'fs <subCommand> [options]';
 var usage = 'Usage: sasjs fs <subCommand> [options]';
 var description = 'Handles operations around file system synchronisation';
 var parseOptions = {
-    output: { type: 'string', alias: 'o' }
+    output: { type: 'string', alias: 'o' },
+    logcheck: {
+        type: 'boolean',
+        default: undefined,
+        description: 'Check the SAS log this command received, and fail when logCheck in sasjsconfig.json says so. --no-logcheck switches both the report and the verdict off.'
+    }
 };
 var compileCommandSyntax = 'fs <subCommand> <local> [options]';
 var compileCommandUsage = 'sasjs fs compile <localFolder> [options]';
@@ -243,6 +249,7 @@ var FSCommand = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
+                        (0, logcheck_1.setLogCheckMode)((0, logcheck_1.logCheckModeOf)(this.parsed.logcheck));
                         if (!(this.parsed.subCommand === FsSubCommand.Compile)) return [3 /*break*/, 2];
                         return [4 /*yield*/, this.compile()];
                     case 1: return [2 /*return*/, _a.sent()];
@@ -324,8 +331,18 @@ var FSCommand = /** @class */ (function (_super) {
                                 var log = _b.log;
                                 return __generator(this, function (_c) {
                                     switch (_c.label) {
-                                        case 0: return [4 /*yield*/, (0, utils_1.saveLog)(log, path_1.default.join(outputFolder, 'deploy.log'), '', false)];
+                                        case 0: return [4 /*yield*/, (0, utils_1.saveLog)(log, path_1.default.join(outputFolder, 'deploy.log'), '', false)
+                                            // after the log file is written: a deploy whose log fails the check is
+                                            // the deploy whose record someone needs to read
+                                        ];
                                         case 1:
+                                            _c.sent();
+                                            // after the log file is written: a deploy whose log fails the check is
+                                            // the deploy whose record someone needs to read
+                                            return [4 /*yield*/, (0, logcheck_1.checkLog)(log, 'fs deploy')];
+                                        case 2:
+                                            // after the log file is written: a deploy whose log fails the check is
+                                            // the deploy whose record someone needs to read
                                             _c.sent();
                                             return [2 /*return*/];
                                     }
@@ -337,6 +354,10 @@ var FSCommand = /** @class */ (function (_super) {
                         return [2 /*return*/, command_1.ReturnCode.Success];
                     case 7:
                         error_1 = _f.sent();
+                        // the verdict the caller asked for, not an internal failure: it carries
+                        // its own exit code and has already printed the report
+                        if ((0, logcheck_1.isLogCheckFailure)(error_1))
+                            return [2 /*return*/, command_1.ReturnCode.LogCheckError];
                         logPath = path_1.default.join(outputFolder, 'error.log');
                         return [4 /*yield*/, createErrorLogFile(error_1, logPath)];
                     case 8:
@@ -386,7 +407,7 @@ var FSCommand = /** @class */ (function (_super) {
                                         outputFolder = _v.sent();
                                         _v.label = 2;
                                     case 2:
-                                        _v.trys.push([2, 15, , 17]);
+                                        _v.trys.push([2, 17, , 19]);
                                         (_h = process.logger) === null || _h === void 0 ? void 0 : _h.info('generating program to get remote hash');
                                         return [4 /*yield*/, (0, fs_1.generateProgramToGetRemoteHash)(obj.remote)];
                                     case 3:
@@ -400,15 +421,18 @@ var FSCommand = /** @class */ (function (_super) {
                                         log = (_v.sent()).log;
                                         return [4 /*yield*/, (0, utils_1.saveLog)(log, path_1.default.join(outputFolder, 'getRemoteHash.log'), '', false)];
                                     case 6:
+                                        _v.sent();
+                                        return [4 /*yield*/, (0, logcheck_1.checkLog)(log, 'fs sync')];
+                                    case 7:
                                         _v.sent();
                                         (_k = process.logger) === null || _k === void 0 ? void 0 : _k.info('extracting hashes from log');
                                         remoteHashes = (0, fs_1.extractHashArray)(log);
                                         return [4 /*yield*/, createHashFile(JSON.stringify(remoteHashes, null, 2), path_1.default.join(outputFolder, 'hashesBeforeSync.json'))];
-                                    case 7:
+                                    case 8:
                                         _v.sent();
                                         (_l = process.logger) === null || _l === void 0 ? void 0 : _l.info('creating the hash of local folder');
                                         return [4 /*yield*/, (0, fs_1.getHash)((0, utils_2.getAbsolutePath)(obj.local, process.projectDir))];
-                                    case 8:
+                                    case 9:
                                         localHash = _v.sent();
                                         remoteHashMap_1 = remoteHashes.reduce(function (map, item) {
                                             var from = obj.remote.replace(/\//g, path_1.default.sep);
@@ -424,25 +448,28 @@ var FSCommand = /** @class */ (function (_super) {
                                         (_o = process.logger) === null || _o === void 0 ? void 0 : _o.info('Extract differences from local and remote hash');
                                         hashedDiff = (0, fs_1.compareHashes)(localHash, remoteHashMap_1);
                                         return [4 /*yield*/, createHashFile(JSON.stringify(hashedDiff, null, 2), path_1.default.join(outputFolder, 'hashesDiff.json'))];
-                                    case 9:
+                                    case 10:
                                         _v.sent();
                                         (_p = process.logger) === null || _p === void 0 ? void 0 : _p.info('generating program to sync differences');
                                         return [4 /*yield*/, (0, fs_1.generateProgramToSyncHashDiff)(hashedDiff, obj.remote)];
-                                    case 10:
+                                    case 11:
                                         syncProgram = _v.sent();
                                         return [4 /*yield*/, createProgramFile(syncProgram, path_1.default.join(outputFolder, 'syncProgram.sas'))];
-                                    case 11:
+                                    case 12:
                                         _v.sent();
                                         (_q = process.logger) === null || _q === void 0 ? void 0 : _q.info('executing program to sync differences');
                                         return [4 /*yield*/, (0, executeCode_1.executeCode)(target, syncProgram)];
-                                    case 12:
+                                    case 13:
                                         syncLog = (_v.sent()).log;
                                         return [4 /*yield*/, (0, utils_1.saveLog)(syncLog, path_1.default.join(outputFolder, 'sync.log'), '', false)];
-                                    case 13:
+                                    case 14:
+                                        _v.sent();
+                                        return [4 /*yield*/, (0, logcheck_1.checkLog)(syncLog, 'fs sync')];
+                                    case 15:
                                         _v.sent();
                                         syncedHash = (0, fs_1.extractHashArray)(syncLog);
                                         return [4 /*yield*/, createHashFile(JSON.stringify(syncedHash, null, 2), path_1.default.join(outputFolder, 'hashesAfterSync.json'))];
-                                    case 14:
+                                    case 16:
                                         _v.sent();
                                         syncedHashMap = syncedHash.reduce(function (map, item) {
                                             var from = obj.remote.replace(/\//g, path_1.default.sep);
@@ -472,16 +499,18 @@ var FSCommand = /** @class */ (function (_super) {
                                                 (_a = process.logger) === null || _a === void 0 ? void 0 : _a.log("* ".concat(item));
                                             });
                                         }
-                                        return [3 /*break*/, 17];
-                                    case 15:
+                                        return [3 /*break*/, 19];
+                                    case 17:
                                         error_2 = _v.sent();
+                                        if ((0, logcheck_1.isLogCheckFailure)(error_2))
+                                            return [2 /*return*/, { value: command_1.ReturnCode.LogCheckError }];
                                         logPath = path_1.default.join(outputFolder, 'error.log');
                                         return [4 /*yield*/, createErrorLogFile(error_2, logPath)];
-                                    case 16:
+                                    case 18:
                                         _v.sent();
                                         (_t = process.logger) === null || _t === void 0 ? void 0 : _t.error("An error has occurred. For more info see ".concat(logPath));
                                         return [2 /*return*/, { value: command_1.ReturnCode.InternalError }];
-                                    case 17: return [2 /*return*/];
+                                    case 19: return [2 /*return*/];
                                 }
                             });
                         };

package/build/commands/fs/internal/executeCode.d.ts

@@ -1,4 +1,10 @@
 import { Target } from '@sasjs/utils';
+/**
+ * Runs generated SAS and returns the log it came back with.
+ *
+ * The caller saves that log and then checks it - not here, because a check that
+ * throws before the log file is written is a failed run nobody can read.
+ */
 export declare const executeCode: (target: Target, code: string) => Promise<{
     log: any;
 }>;

package/build/commands/fs/internal/executeCode.js

@@ -39,6 +39,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.executeCode = void 0;
 var utils_1 = require("@sasjs/utils");
 var utils_2 = require("../../../utils/");
+/**
+ * Runs generated SAS and returns the log it came back with.
+ *
+ * The caller saves that log and then checks it - not here, because a check that
+ * throws before the log file is written is a failed run nobody can read.
+ */
 var executeCode = function (target, code) { return __awaiter(void 0, void 0, void 0, function () {
     return __generator(this, function (_a) {
         switch (_a.label) {

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

@@ -234,6 +234,11 @@ function executeJobViya(sasjs, authConfig, jobPath, target, waitForJob, output,
                     return [3 /*break*/, 21];
                 case 20:
                     error_1 = _c.sent();
+                    // A log-check failure is the verdict the caller asked for, not a parse
+                    // error: swallowing it here printed "Logcheck failed" and then exited 0,
+                    // which is the green pipeline the feature exists to prevent.
+                    if ((0, logcheck_1.isLogCheckFailure)(error_1))
+                        throw error_1;
                     // handle use case when submitted job can't be parsed
                     result = false;
                     (0, displayResult_1.displayError)(null, 'An error has occurred when parsing an output of the job.');

package/build/commands/job/spec/execute.spec.js

@@ -79,6 +79,9 @@ var path_1 = __importDefault(require("path"));
 var utils_2 = require("../../../utils");
 var utilsModule = __importStar(require("../../../utils/utils"));
 var configUtils = __importStar(require("../../../utils/config"));
+var logcheckModule = __importStar(require("../../../utils/logcheck"));
+var fetchLogFileContentModule = __importStar(require("../../shared/fetchLogFileContent"));
+var logcheck_1 = require("../../../utils/logcheck");
 var execute_1 = require("../internal/execute");
 var mocks_1 = require("./mocks");
 var sasjs = new node_1.default();
@@ -165,6 +168,32 @@ describe('executeJobViya', function () {
             }
         });
     }); });
+    it('propagates a log-check failure instead of reporting a parse error', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var failure;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    // a job whose log fails the check used to print the verdict and then exit 0,
+                    // because this function's catch-all treated the failure as a bad output
+                    jest.spyOn(sasjs, 'startComputeJob').mockResolvedValue({
+                        job: {
+                            state: 'completed',
+                            links: [{ rel: 'log', method: 'GET', href: '/log' }],
+                            logStatistics: { lineCount: 5 }
+                        }
+                    });
+                    jest
+                        .spyOn(fetchLogFileContentModule, 'fetchLogFileContent')
+                        .mockResolvedValue('ERROR: deliberate');
+                    failure = new logcheck_1.LogCheckFailure('SAS log check failed for test/job');
+                    jest.spyOn(logcheckModule, 'checkLog').mockRejectedValue(failure);
+                    return [4 /*yield*/, expect((0, execute_1.executeJobViya)(sasjs, mocks_1.mockAuthConfig, 'test/job', target, true, false, testLogsPath, undefined, false, undefined, false)).rejects.toBe(failure)];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
 });
 describe('executeJobSasjs', function () {
     beforeEach(function () { return __awaiter(void 0, void 0, void 0, function () {

package/package.json

@@ -123,5 +123,5 @@
     "ws": "8.21.0",
     "nanoid": "3.3.18"
   },
-  "version": "6.8.0"
+  "version": "6.8.1"
 }