@sasjs/cli
Version:
Command line interface for SASjs
458 lines (457 loc) • 23.2 kB
JavaScript
"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;
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 __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 test_1 = require("../../../utils/test");
var utils_1 = require("@sasjs/utils");
var generateDocs_1 = require("../generateDocs");
var utils_2 = require("../../../utils");
var types_1 = require("../../../types");
describe('sasjs doc', function () {
var appName = "test-app-doc-".concat((0, utils_1.generateTimestamp)());
var docOutputDefault = path_1.default.join(__dirname, appName, 'sasjsbuild', 'docs');
var doxyContentPath = path_1.default.join(__dirname, appName, 'sasjs', 'doxy');
var defaultTarget;
var defaultConfig;
beforeAll(function () { return __awaiter(void 0, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, (0, test_1.createTestApp)(__dirname, appName)];
case 1:
_a.sent();
return [4 /*yield*/, (0, utils_2.findTargetInConfiguration)('viya', types_1.TargetScope.Local)];
case 2:
(defaultTarget = (_a.sent()).target);
return [4 /*yield*/, (0, utils_2.getLocalConfig)()];
case 3:
defaultConfig = _a.sent();
return [2 /*return*/];
}
});
}); });
afterEach(function () { return __awaiter(void 0, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, (0, utils_1.deleteFolder)(docOutputDefault)];
case 1:
_a.sent();
return [2 /*return*/];
}
});
}); });
afterAll(function () { return __awaiter(void 0, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, (0, test_1.removeTestApp)(__dirname, appName)];
case 1:
_a.sent();
return [2 /*return*/];
}
});
}); });
it("should generate docs", function () { return __awaiter(void 0, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, expect((0, generateDocs_1.generateDocs)(defaultTarget, defaultConfig)).resolves.toEqual({
outDirectory: docOutputDefault
})];
case 1:
_a.sent();
return [4 /*yield*/, (0, test_1.verifyDocs)(docOutputDefault, defaultTarget.name)];
case 2:
_a.sent();
return [2 /*return*/];
}
});
}); });
it("should generate docs having doxy folder at relative path", function () { return __awaiter(void 0, void 0, void 0, function () {
var doxyContentPathNew, config;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
doxyContentPathNew = path_1.default.join(__dirname, appName, 'doxy-custom-folder');
return [4 /*yield*/, (0, utils_1.copy)(doxyContentPath, doxyContentPathNew)];
case 1:
_a.sent();
return [4 /*yield*/, (0, utils_1.deleteFolder)(doxyContentPath)];
case 2:
_a.sent();
config = __assign(__assign({}, defaultConfig), { docConfig: {
doxyContent: {
readMe: '../README.md',
path: './doxy-custom-folder'
}
} });
return [4 /*yield*/, expect((0, generateDocs_1.generateDocs)(defaultTarget, config)).resolves.toEqual({
outDirectory: docOutputDefault
})];
case 3:
_a.sent();
return [4 /*yield*/, (0, test_1.verifyDocs)(docOutputDefault, defaultTarget.name)];
case 4:
_a.sent();
return [4 /*yield*/, (0, utils_1.copy)(doxyContentPathNew, doxyContentPath)];
case 5:
_a.sent();
return [4 /*yield*/, (0, utils_1.deleteFolder)(doxyContentPathNew)];
case 6:
_a.sent();
return [2 /*return*/];
}
});
}); });
it("should generate docs for having doxy folder at absolute path", function () { return __awaiter(void 0, void 0, void 0, function () {
var doxyContentPathNew, config;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
doxyContentPathNew = path_1.default.join(__dirname, appName, 'doxy-custom-folder');
return [4 /*yield*/, (0, utils_1.copy)(doxyContentPath, doxyContentPathNew)];
case 1:
_a.sent();
return [4 /*yield*/, (0, utils_1.deleteFolder)(doxyContentPath)];
case 2:
_a.sent();
config = __assign(__assign({}, defaultConfig), { docConfig: {
doxyContent: {
readMe: '../README.md',
path: doxyContentPathNew
}
} });
return [4 /*yield*/, expect((0, generateDocs_1.generateDocs)(defaultTarget, config)).resolves.toEqual({
outDirectory: docOutputDefault
})];
case 3:
_a.sent();
return [4 /*yield*/, (0, test_1.verifyDocs)(docOutputDefault, defaultTarget.name)];
case 4:
_a.sent();
return [4 /*yield*/, (0, utils_1.copy)(doxyContentPathNew, doxyContentPath)];
case 5:
_a.sent();
return [4 /*yield*/, (0, utils_1.deleteFolder)(doxyContentPathNew)];
case 6:
_a.sent();
return [2 /*return*/];
}
});
}); });
it("should generate docs for having space in folderPath(parent Folder)", function () { return __awaiter(void 0, void 0, void 0, function () {
var config;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
config = __assign(__assign({}, defaultConfig), { docConfig: { displayMacroCore: false } });
return [4 /*yield*/, expect((0, generateDocs_1.generateDocs)(defaultTarget, config)).resolves.toEqual({
outDirectory: docOutputDefault
})];
case 1:
_a.sent();
return [4 /*yield*/, (0, test_1.verifyDocs)(docOutputDefault, defaultTarget.name, false)];
case 2:
_a.sent();
return [2 /*return*/];
}
});
}); });
it("should generate docs to ./my-docs-<timestamp>", function () { return __awaiter(void 0, void 0, void 0, function () {
var docOutputProvided;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
docOutputProvided = path_1.default.join(__dirname, appName, "my-docs-".concat((0, utils_1.generateTimestamp)()));
return [4 /*yield*/, expect((0, generateDocs_1.generateDocs)(defaultTarget, defaultConfig, docOutputProvided)).resolves.toEqual({
outDirectory: docOutputProvided
})];
case 1:
_a.sent();
return [4 /*yield*/, (0, test_1.verifyDocs)(docOutputProvided, defaultTarget.name)];
case 2:
_a.sent();
return [2 /*return*/];
}
});
}); });
it("should generate docs without sasjs/core", function () { return __awaiter(void 0, void 0, void 0, function () {
var config;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, expect((0, utils_1.folderExists)(docOutputDefault)).resolves.toEqual(false)];
case 1:
_a.sent();
config = __assign(__assign({}, defaultConfig), { docConfig: { displayMacroCore: false } });
return [4 /*yield*/, expect((0, generateDocs_1.generateDocs)(defaultTarget, config)).resolves.toEqual({
outDirectory: docOutputDefault
})];
case 2:
_a.sent();
return [4 /*yield*/, (0, test_1.verifyDocs)(docOutputDefault, defaultTarget.name, false)];
case 3:
_a.sent();
return [2 /*return*/];
}
});
}); });
it("should generate docs to sasjsconfig.json's outDirectory", function () { return __awaiter(void 0, void 0, void 0, function () {
var docOutputProvided, config;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
docOutputProvided = path_1.default.join(__dirname, appName, "xyz-".concat((0, utils_1.generateTimestamp)()));
config = __assign(__assign({}, defaultConfig), { docConfig: { outDirectory: docOutputProvided } });
return [4 /*yield*/, expect((0, generateDocs_1.generateDocs)(defaultTarget, config)).resolves.toEqual({
outDirectory: docOutputProvided
})];
case 1:
_a.sent();
return [4 /*yield*/, (0, test_1.verifyDocs)(docOutputProvided, defaultTarget.name)];
case 2:
_a.sent();
return [2 /*return*/];
}
});
}); });
it("should generate docs to default location having docConfig.outDirectory is empty", function () { return __awaiter(void 0, void 0, void 0, function () {
var config;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
config = __assign(__assign({}, defaultConfig), { docConfig: { outDirectory: '' } });
return [4 /*yield*/, expect((0, generateDocs_1.generateDocs)(defaultTarget, config)).resolves.toEqual({
outDirectory: docOutputDefault
})];
case 1:
_a.sent();
return [4 /*yield*/, (0, test_1.verifyDocs)(docOutputDefault, defaultTarget.name)];
case 2:
_a.sent();
return [2 /*return*/];
}
});
}); });
it("should fail to generate docs for not having Doxyfile configuration", function () { return __awaiter(void 0, void 0, void 0, function () {
var doxyFile, doxyFileNew;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
doxyFile = path_1.default.join(__dirname, appName, 'sasjs/doxy/Doxyfile');
doxyFileNew = path_1.default.join(__dirname, appName, 'sasjs/doxy/Doxytemp');
return [4 /*yield*/, (0, utils_1.copy)(doxyFile, doxyFileNew)];
case 1:
_a.sent();
return [4 /*yield*/, (0, utils_1.deleteFile)(doxyFile)];
case 2:
_a.sent();
return [4 /*yield*/, expect((0, generateDocs_1.generateDocs)(defaultTarget, defaultConfig)).rejects.toEqual(expect.stringMatching(/^Doxygen Configuration File is not found!/))];
case 3:
_a.sent();
return [4 /*yield*/, (0, utils_1.copy)(doxyFileNew, doxyFile)];
case 4:
_a.sent();
return [4 /*yield*/, (0, utils_1.deleteFile)(doxyFileNew)];
case 5:
_a.sent();
return [2 /*return*/];
}
});
}); });
it("should generate docs if no target is present", function () { return __awaiter(void 0, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, expect((0, generateDocs_1.generateDocs)(undefined, defaultConfig)).resolves.toEqual({
outDirectory: docOutputDefault
})];
case 1:
_a.sent();
return [4 /*yield*/, (0, test_1.verifyDocs)(docOutputDefault, 'no-target')];
case 2:
_a.sent();
return [2 /*return*/];
}
});
}); });
it("should generate docs having target precedence over root level", function () { return __awaiter(void 0, void 0, void 0, function () {
var docOutputProvided, target;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
docOutputProvided = path_1.default.join(__dirname, appName, "xyz-".concat((0, utils_1.generateTimestamp)()));
target = new utils_1.Target(__assign(__assign({}, defaultTarget.toJson()), { docConfig: {
displayMacroCore: false,
enableLineage: false,
outDirectory: docOutputProvided
} }));
return [4 /*yield*/, expect((0, generateDocs_1.generateDocs)(target, defaultConfig)).resolves.toEqual({
outDirectory: docOutputProvided
})];
case 1:
_a.sent();
return [4 /*yield*/, (0, test_1.verifyDocs)(docOutputProvided, defaultTarget.name, false)];
case 2:
_a.sent();
return [4 /*yield*/, (0, test_1.verifyDotFilesNotGenerated)(docOutputProvided)];
case 3:
_a.sent();
return [2 /*return*/];
}
});
}); });
it("should generate docs having target precedence over root level(no docConfig)", function () { return __awaiter(void 0, void 0, void 0, function () {
var docOutputProvided, config, target;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
docOutputProvided = path_1.default.join(__dirname, appName, "xyz-".concat((0, utils_1.generateTimestamp)()));
config = __assign(__assign({}, defaultConfig), { docConfig: null });
target = new utils_1.Target(__assign(__assign({}, defaultTarget.toJson()), { docConfig: {
displayMacroCore: false,
enableLineage: false,
outDirectory: docOutputProvided
} }));
return [4 /*yield*/, expect((0, generateDocs_1.generateDocs)(target, config)).resolves.toEqual({
outDirectory: docOutputProvided
})];
case 1:
_a.sent();
return [4 /*yield*/, (0, test_1.verifyDocs)(docOutputProvided, defaultTarget.name, false)];
case 2:
_a.sent();
return [4 /*yield*/, (0, test_1.verifyDotFilesNotGenerated)(docOutputProvided)];
case 3:
_a.sent();
return [2 /*return*/];
}
});
}); });
it("should generate docs having no docConfig at root level", function () { return __awaiter(void 0, void 0, void 0, function () {
var config;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
config = __assign(__assign({}, defaultConfig), { docConfig: null });
return [4 /*yield*/, expect((0, generateDocs_1.generateDocs)(defaultTarget, config, undefined)).resolves.toEqual({ outDirectory: docOutputDefault })];
case 1:
_a.sent();
return [4 /*yield*/, (0, test_1.verifyDocs)(docOutputDefault, defaultTarget.name)];
case 2:
_a.sent();
return [4 /*yield*/, (0, test_1.verifyDotFiles)(docOutputDefault)];
case 3:
_a.sent();
return [2 /*return*/];
}
});
}); });
it("should generate docs having empty docConfig at root level", function () { return __awaiter(void 0, void 0, void 0, function () {
var config;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
config = __assign(__assign({}, defaultConfig), { docConfig: {} });
return [4 /*yield*/, expect((0, generateDocs_1.generateDocs)(defaultTarget, config)).resolves.toEqual({
outDirectory: docOutputDefault
})];
case 1:
_a.sent();
return [4 /*yield*/, (0, test_1.verifyDocs)(docOutputDefault, defaultTarget.name)];
case 2:
_a.sent();
return [4 /*yield*/, (0, test_1.verifyDotFiles)(docOutputDefault)];
case 3:
_a.sent();
return [2 /*return*/];
}
});
}); });
it("should generate docs having no docConfig at root level and no targets", function () { return __awaiter(void 0, void 0, void 0, function () {
var config;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
config = __assign(__assign({}, defaultConfig), { docConfig: null });
return [4 /*yield*/, expect((0, generateDocs_1.generateDocs)(undefined, config)).resolves.toEqual({
outDirectory: docOutputDefault
})];
case 1:
_a.sent();
return [4 /*yield*/, (0, test_1.verifyDocs)(docOutputDefault, 'no-target')];
case 2:
_a.sent();
return [4 /*yield*/, (0, test_1.verifyDotFiles)(docOutputDefault)];
case 3:
_a.sent();
return [2 /*return*/];
}
});
}); });
it("should generate docs having empty docConfig at root level and no targets", function () { return __awaiter(void 0, void 0, void 0, function () {
var config;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
config = __assign(__assign({}, defaultConfig), { docConfig: {} });
return [4 /*yield*/, expect((0, generateDocs_1.generateDocs)(undefined, config)).resolves.toEqual({
outDirectory: docOutputDefault
})];
case 1:
_a.sent();
return [4 /*yield*/, (0, test_1.verifyDocs)(docOutputDefault, 'no-target')];
case 2:
_a.sent();
return [4 /*yield*/, (0, test_1.verifyDotFiles)(docOutputDefault)];
case 3:
_a.sent();
return [2 /*return*/];
}
});
}); });
});