@sasjs/cli/build/commands/docs/spec/docsCommand.spec.js

Command line interface for SASjs

"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    var desc = Object.getOwnPropertyDescriptor(m, k);
    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
      desc = { enumerable: true, get: function() { return m[k]; } };
    }
    Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
    Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
    o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
    if (mod && mod.__esModule) return mod;
    var result = {};
    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
    __setModuleDefault(result, mod);
    return result;
};
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;
    return g = { next: verb(0), "throw": verb(1), "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 __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 __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
        if (ar || !(i in from)) {
            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
            ar[i] = from[i];
        }
    }
    return to.concat(ar || Array.prototype.slice.call(from));
};
Object.defineProperty(exports, "__esModule", { value: true });
var docsCommand_1 = require("../docsCommand");
var generateDocsModule = __importStar(require("../generateDocs"));
var generateDotModule = __importStar(require("../generateDot"));
var initDocsModule = __importStar(require("../initDocs"));
var command_1 = require("../../../types/command");
var configUtils = __importStar(require("../../../utils/config"));
var setConstantsUtils = __importStar(require("../../../utils/setConstants"));
var logger_1 = require("@sasjs/utils/logger");
var utils_1 = require("@sasjs/utils");
var target = new utils_1.Target({
    name: 'test',
    appLoc: '/Public/test/',
    serverType: utils_1.ServerType.SasViya,
    contextName: 'test context'
});
var config = {};
describe('DocsCommand - generate docs', function () {
    var defaultArgs = ['node', 'sasjs'];
    beforeEach(function () {
        setupMocks();
    });
    it('should parse a simple sasjs doc command', function () {
        var args = __spreadArray(__spreadArray([], __read(defaultArgs), false), ['doc'], false);
        var command = new docsCommand_1.DocsCommand(args);
        expect(command.name).toEqual('doc');
        expect(command.subCommand).toEqual('');
    });
    it('should parse a sasjs doc command with a target', function () { return __awaiter(void 0, void 0, void 0, function () {
        var args, command, targetInfo;
        return __generator(this, function (_a) {
            switch (_a.label) {
                case 0:
                    args = __spreadArray(__spreadArray([], __read(defaultArgs), false), ['doc', '-t', 'test'], false);
                    command = new docsCommand_1.DocsCommand(args);
                    return [4 /*yield*/, command.getTargetInfo()];
                case 1:
                    targetInfo = _a.sent();
                    expect(command.name).toEqual('doc');
                    expect(command.subCommand).toEqual('');
                    expect(targetInfo.target).toEqual(target);
                    return [2 /*return*/];
            }
        });
    }); });
    it('should parse an aliased sasjs docs command', function () {
        var args = __spreadArray(__spreadArray([], __read(defaultArgs), false), ['docs'], false);
        var command = new docsCommand_1.DocsCommand(args);
        expect(command.name).toEqual('doc');
        expect(command.subCommand).toEqual('');
    });
    it('should call the generateDocs handler when executed', function () { return __awaiter(void 0, void 0, void 0, function () {
        var args, command;
        return __generator(this, function (_a) {
            switch (_a.label) {
                case 0:
                    args = __spreadArray(__spreadArray([], __read(defaultArgs), false), ['docs'], false);
                    command = new docsCommand_1.DocsCommand(args);
                    return [4 /*yield*/, command.execute()];
                case 1:
                    _a.sent();
                    expect(generateDocsModule.generateDocs).toHaveBeenCalled();
                    return [2 /*return*/];
            }
        });
    }); });
    it('should return with the success code after execution', function () { return __awaiter(void 0, void 0, void 0, function () {
        var args, command, returnCode;
        return __generator(this, function (_a) {
            switch (_a.label) {
                case 0:
                    args = __spreadArray(__spreadArray([], __read(defaultArgs), false), ['docs'], false);
                    command = new docsCommand_1.DocsCommand(args);
                    return [4 /*yield*/, command.execute()];
                case 1:
                    returnCode = _a.sent();
                    expect(returnCode).toEqual(command_1.ReturnCode.Success);
                    expect(process.logger.success).toHaveBeenCalled();
                    return [2 /*return*/];
            }
        });
    }); });
    it('should return with the error code when execution fails', function () { return __awaiter(void 0, void 0, void 0, function () {
        var args, command, returnCode;
        return __generator(this, function (_a) {
            switch (_a.label) {
                case 0:
                    args = __spreadArray(__spreadArray([], __read(defaultArgs), false), ['docs'], false);
                    jest
                        .spyOn(generateDocsModule, 'generateDocs')
                        .mockImplementation(function () { return Promise.reject(); });
                    command = new docsCommand_1.DocsCommand(args);
                    return [4 /*yield*/, command.execute()];
                case 1:
                    returnCode = _a.sent();
                    expect(returnCode).toEqual(command_1.ReturnCode.InternalError);
                    expect(process.logger.error).toHaveBeenCalled();
                    return [2 /*return*/];
            }
        });
    }); });
});
describe('DocsCommand - generate dot', function () {
    var defaultArgs = ['node', 'sasjs'];
    beforeEach(function () {
        setupMocks();
    });
    it('should parse a simple sasjs doc lineage command', function () {
        var args = __spreadArray(__spreadArray([], __read(defaultArgs), false), ['doc', 'lineage'], false);
        var command = new docsCommand_1.DocsCommand(args);
        expect(command.name).toEqual('doc');
        expect(command.subCommand).toEqual('lineage');
    });
    it('should parse a sasjs doc command with a target', function () { return __awaiter(void 0, void 0, void 0, function () {
        var args, command, targetInfo;
        return __generator(this, function (_a) {
            switch (_a.label) {
                case 0:
                    args = __spreadArray(__spreadArray([], __read(defaultArgs), false), ['doc', 'lineage', '-t', 'test'], false);
                    command = new docsCommand_1.DocsCommand(args);
                    return [4 /*yield*/, command.getTargetInfo()];
                case 1:
                    targetInfo = _a.sent();
                    expect(command.name).toEqual('doc');
                    expect(command.subCommand).toEqual('lineage');
                    expect(targetInfo.target).toEqual(target);
                    return [2 /*return*/];
            }
        });
    }); });
    it('should parse an aliased sasjs docs lineage command', function () {
        var args = __spreadArray(__spreadArray([], __read(defaultArgs), false), ['docs', 'lineage'], false);
        var command = new docsCommand_1.DocsCommand(args);
        expect(command.name).toEqual('doc');
        expect(command.subCommand).toEqual('lineage');
    });
    it('should call the generateDocs handler when executed', function () { return __awaiter(void 0, void 0, void 0, function () {
        var args, command;
        return __generator(this, function (_a) {
            switch (_a.label) {
                case 0:
                    args = __spreadArray(__spreadArray([], __read(defaultArgs), false), ['docs', 'lineage'], false);
                    command = new docsCommand_1.DocsCommand(args);
                    return [4 /*yield*/, command.execute()];
                case 1:
                    _a.sent();
                    expect(generateDotModule.generateDot).toHaveBeenCalled();
                    return [2 /*return*/];
            }
        });
    }); });
    it('should return with the success code after execution', function () { return __awaiter(void 0, void 0, void 0, function () {
        var args, command, returnCode;
        return __generator(this, function (_a) {
            switch (_a.label) {
                case 0:
                    args = __spreadArray(__spreadArray([], __read(defaultArgs), false), ['docs', 'lineage'], false);
                    command = new docsCommand_1.DocsCommand(args);
                    return [4 /*yield*/, command.execute()];
                case 1:
                    returnCode = _a.sent();
                    expect(returnCode).toEqual(command_1.ReturnCode.Success);
                    expect(process.logger.success).toHaveBeenCalled();
                    return [2 /*return*/];
            }
        });
    }); });
    it('should return with the error code when execution fails', function () { return __awaiter(void 0, void 0, void 0, function () {
        var args, command, returnCode;
        return __generator(this, function (_a) {
            switch (_a.label) {
                case 0:
                    args = __spreadArray(__spreadArray([], __read(defaultArgs), false), ['docs', 'lineage'], false);
                    jest
                        .spyOn(generateDotModule, 'generateDot')
                        .mockImplementation(function () { return Promise.reject(); });
                    command = new docsCommand_1.DocsCommand(args);
                    return [4 /*yield*/, command.execute()];
                case 1:
                    returnCode = _a.sent();
                    expect(returnCode).toEqual(command_1.ReturnCode.InternalError);
                    expect(process.logger.error).toHaveBeenCalled();
                    return [2 /*return*/];
            }
        });
    }); });
});
describe('DocsCommand - init docs', function () {
    var defaultArgs = ['node', 'sasjs'];
    beforeEach(function () {
        setupMocks();
    });
    it('should parse a simple sasjs doc init command', function () {
        var args = __spreadArray(__spreadArray([], __read(defaultArgs), false), ['doc', 'init'], false);
        var command = new docsCommand_1.DocsCommand(args);
        expect(command.name).toEqual('doc');
        expect(command.subCommand).toEqual('init');
    });
    it('should parse an aliased sasjs docs init command', function () {
        var args = __spreadArray(__spreadArray([], __read(defaultArgs), false), ['docs', 'init'], false);
        var command = new docsCommand_1.DocsCommand(args);
        expect(command.name).toEqual('doc');
        expect(command.subCommand).toEqual('init');
    });
    it('should call the initDocs handler when executed', function () { return __awaiter(void 0, void 0, void 0, function () {
        var args, command;
        return __generator(this, function (_a) {
            switch (_a.label) {
                case 0:
                    args = __spreadArray(__spreadArray([], __read(defaultArgs), false), ['docs', 'init'], false);
                    command = new docsCommand_1.DocsCommand(args);
                    return [4 /*yield*/, command.execute()];
                case 1:
                    _a.sent();
                    expect(initDocsModule.initDocs).toHaveBeenCalled();
                    return [2 /*return*/];
            }
        });
    }); });
    it('should return with the success code after execution', function () { return __awaiter(void 0, void 0, void 0, function () {
        var args, command, returnCode;
        return __generator(this, function (_a) {
            switch (_a.label) {
                case 0:
                    args = __spreadArray(__spreadArray([], __read(defaultArgs), false), ['docs', 'init'], false);
                    command = new docsCommand_1.DocsCommand(args);
                    return [4 /*yield*/, command.execute()];
                case 1:
                    returnCode = _a.sent();
                    expect(returnCode).toEqual(command_1.ReturnCode.Success);
                    expect(process.logger.success).toHaveBeenCalled();
                    return [2 /*return*/];
            }
        });
    }); });
    it('should return with the error code when execution fails', function () { return __awaiter(void 0, void 0, void 0, function () {
        var args, command, returnCode;
        return __generator(this, function (_a) {
            switch (_a.label) {
                case 0:
                    args = __spreadArray(__spreadArray([], __read(defaultArgs), false), ['docs', 'init'], false);
                    jest
                        .spyOn(initDocsModule, 'initDocs')
                        .mockImplementation(function () { return Promise.reject(); });
                    command = new docsCommand_1.DocsCommand(args);
                    return [4 /*yield*/, command.execute()];
                case 1:
                    returnCode = _a.sent();
                    expect(returnCode).toEqual(command_1.ReturnCode.InternalError);
                    expect(process.logger.error).toHaveBeenCalled();
                    return [2 /*return*/];
            }
        });
    }); });
});
var setupMocks = function () {
    jest.resetAllMocks();
    jest.mock('../generateDocs');
    jest.mock('../generateDot');
    jest.mock('../initDocs');
    jest
        .spyOn(generateDocsModule, 'generateDocs')
        .mockImplementation(function () { return Promise.resolve({ outDirectory: 'test' }); });
    jest
        .spyOn(generateDotModule, 'generateDot')
        .mockImplementation(function () { return Promise.resolve({ outDirectory: 'test' }); });
    jest
        .spyOn(initDocsModule, 'initDocs')
        .mockImplementation(function () { return Promise.resolve(); });
    process.logger = new logger_1.Logger(logger_1.LogLevel.Off);
    jest.spyOn(process.logger, 'success');
    jest.spyOn(process.logger, 'error');
    jest
        .spyOn(configUtils, 'findTargetInConfiguration')
        .mockImplementation(function () { return Promise.resolve({ target: target, isLocal: true }); });
    jest
        .spyOn(configUtils, 'getLocalConfig')
        .mockImplementation(function () { return Promise.resolve(config); });
    jest
        .spyOn(setConstantsUtils, 'setConstants')
        .mockImplementation(function () { return Promise.resolve(); });
};