@sasjs/cli 6.28.0 → 6.30.0

package/build/commands/deploy/spec/cbd.spec.js

@@ -68,10 +68,38 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         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 __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+var fs_1 = __importDefault(require("fs"));
 var path_1 = __importDefault(require("path"));
 var node_1 = require("@sasjs/adapter/node");
 var js_base64_1 = require("js-base64");
@@ -85,6 +113,13 @@ var compile_1 = require("../../compile/compile");
 var deploy_1 = require("../deploy");
 var utils_2 = require("./utils");
 var config_1 = require("../../../utils/config");
+/** Every file under a folder, recursively, as absolute paths. */
+var listFiles = function (folderPath) {
+    return fs_1.default.readdirSync(folderPath, { withFileTypes: true }).flatMap(function (entry) {
+        var entryPath = path_1.default.join(folderPath, entry.name);
+        return entry.isDirectory() ? listFiles(entryPath) : [entryPath];
+    });
+};
 describe('sasjs cbd with server type SASJS', function () {
     var target;
     var appName;
@@ -115,9 +150,10 @@ describe('sasjs cbd with server type SASJS', function () {
         });
     }); });
     it("should deploy compile and build to sasjs/server", function () { return __awaiter(void 0, void 0, void 0, function () {
-        var deployMock, _a, customTarget, macroCorePath, mf_getuser, _b, mp_jsonout, ms_webout, webout, mocksPath, appinitJSPath, getdataJSPath, appinitJSContents, getdataJSContents, depsInserts, appinit, getdata, getCode;
-        return __generator(this, function (_c) {
-            switch (_c.label) {
+        var deployMock, _a, customTarget, macroCorePath, mf_getuser, _b, mp_jsonout, ms_webout, webout, depsInserts, getCode, _c, payload, deployed, indexMembers, projectRoot, mocksRoot, mockFiles, mockFiles_1, mockFiles_1_1, filePath, relative, _d, _e, _f, e_1_1, serviceFiles, serviceFiles_1, serviceFiles_1_1, filePath, name_1, contents, member, e_2_1;
+        var e_1, _g, _h, e_2, _j;
+        return __generator(this, function (_k) {
+            switch (_k.label) {
                 case 0:
                     jest.spyOn(fileModule, 'fileExists').mockImplementation(function (filePath) {
                         if (filePath.endsWith('.zip'))
@@ -141,7 +177,7 @@ describe('sasjs cbd with server type SASJS', function () {
                             }
                         })];
                 case 1:
-                    _c.sent();
+                    _k.sent();
                     return [4 /*yield*/, (0, utils_2.updateLocalTarget)(target.name, {
                             jobConfig: undefined,
                             serviceConfig: undefined,
@@ -151,91 +187,139 @@ describe('sasjs cbd with server type SASJS', function () {
                             }
                         })];
                 case 2:
-                    _c.sent();
+                    _k.sent();
                     _a = process;
                     return [4 /*yield*/, (0, config_1.getLocalConfig)()];
                 case 3:
-                    _a.sasjsConfig = _c.sent();
+                    _a.sasjsConfig = _k.sent();
                     return [4 /*yield*/, (0, config_1.findTargetInConfiguration)(target.name, types_1.TargetScope.Local)];
                 case 4:
-                    customTarget = (_c.sent()).target;
+                    customTarget = (_k.sent()).target;
                     return [4 /*yield*/, (0, compile_1.compile)(customTarget)];
                 case 5:
-                    _c.sent();
+                    _k.sent();
                     return [4 /*yield*/, expect((0, build_1.build)(customTarget)).toResolve()];
                 case 6:
-                    _c.sent();
+                    _k.sent();
                     return [4 /*yield*/, (0, deploy_1.deploy)(customTarget, true)];
                 case 7:
-                    _c.sent();
+                    _k.sent();
                     macroCorePath = process.sasjsConstants.macroCorePath;
                     _b = utils_1.removeHeader;
                     return [4 /*yield*/, (0, utils_1.readFile)("".concat(macroCorePath, "/base/mf_getuser.sas"))];
                 case 8:
-                    mf_getuser = _b.apply(void 0, [_c.sent()]);
+                    mf_getuser = _b.apply(void 0, [_k.sent()]);
                     return [4 /*yield*/, (0, utils_1.readFile)("".concat(macroCorePath, "/base/mp_jsonout.sas"))];
                 case 9:
-                    mp_jsonout = _c.sent();
+                    mp_jsonout = _k.sent();
                     return [4 /*yield*/, (0, utils_1.readFile)("".concat(macroCorePath, "/server/ms_webout.sas"))];
                 case 10:
-                    ms_webout = _c.sent();
+                    ms_webout = _k.sent();
                     webout = "%macro webout(action,ds,dslabel=,fmt=,missing=NULL,showmeta=NO,maxobs=MAX);\n  %ms_webout(&action,ds=&ds,dslabel=&dslabel,fmt=&fmt\n    ,missing=&missing\n    ,showmeta=&showmeta\n    ,maxobs=&maxobs\n  )\n%mend;\n";
-                    mocksPath = path_1.default.join(__dirname, appName, 'sasjs', 'mocks');
-                    appinitJSPath = path_1.default.join(mocksPath, 'services', 'common', 'appinit.js');
-                    getdataJSPath = path_1.default.join(mocksPath, 'services', 'common', 'getdata.js');
-                    return [4 /*yield*/, (0, utils_1.readFile)(appinitJSPath)];
-                case 11:
-                    appinitJSContents = _c.sent();
-                    return [4 /*yield*/, (0, utils_1.readFile)(getdataJSPath)];
-                case 12:
-                    getdataJSContents = _c.sent();
                     depsInserts = "\n\n* Service Variables start;\n\n\n* Service Variables end;\n* SAS Macros start;\n\n\n\n* SAS Macros end;\n* SAS Includes start;\n\n* SAS Includes end;\n* Binary Files start;\n\n* Binary Files end;\n\n\n* Service start;\n";
-                    appinit = "/**\n  @file appinit.sas\n  @brief Initialisation service - runs on app startup\n  @details  This is always the first service called when the app is opened.\n\n  <h4> SAS Macros </h4>\n\n**/\n\nproc sql;\ncreate table areas as select distinct area\n  from mydb.springs;\n\n%webout(OPEN)\n%webout(OBJ,areas)\n%webout(CLOSE)\n\n";
-                    getdata = "/**\n  @file getdata.sas\n  @brief Get Data service - runs on app startup\n  @details  This is always the first service called when the app is opened.\n\n  <h4> SAS Macros </h4>\n\n**/\n\n%webout(FETCH)\n\nproc sql;\ncreate table springs as select * from mydb.springs\n  where area in (select area from work.areas);\n\n%webout(OPEN)\n%webout(OBJ,springs)\n%webout(CLOSE)\n\n";
                     getCode = function (file) {
                         return "".concat(mf_getuser).concat(mp_jsonout).concat(ms_webout).concat(webout, "/* provide additional debug info */\n%global _program;\n%put &=syscc;\n%put user=%mf_getuser();\n%put pgm=&_program;\n%put timestamp=%sysfunc(datetime(),datetime19.);").concat(depsInserts).concat(file, "* Service end;");
                     };
-                    expect(deployMock).toHaveBeenCalledWith({
-                        appLoc: target.appLoc,
-                        fileTree: {
-                            members: [
-                                {
-                                    name: 'services',
-                                    type: 'folder',
-                                    members: [
-                                        {
-                                            name: 'common',
-                                            type: 'folder',
-                                            members: [
-                                                {
-                                                    name: 'appinit.js',
-                                                    type: 'file',
-                                                    encoding: 'base64',
-                                                    code: (0, js_base64_1.encode)(appinitJSContents)
-                                                },
-                                                {
-                                                    name: 'appinit',
-                                                    type: 'service',
-                                                    code: getCode((0, utils_1.removeHeader)(appinit))
-                                                },
-                                                {
-                                                    name: 'getdata.js',
-                                                    type: 'file',
-                                                    encoding: 'base64',
-                                                    code: (0, js_base64_1.encode)(getdataJSContents)
-                                                },
-                                                {
-                                                    name: 'getdata',
-                                                    type: 'service',
-                                                    code: getCode((0, utils_1.removeHeader)(getdata))
-                                                }
-                                            ]
-                                        }
-                                    ]
-                                }
-                            ]
-                        }
-                    }, target.appLoc, undefined);
+                    // The payload is derived from the project the command created rather than
+                    // listed by hand. A hand-kept list turned this spec red when the seed app
+                    // gained a data file beside its services - a file the CLI deploys correctly
+                    // - so the reference here is the project itself. What stays explicit is the
+                    // CLI's own contribution: the wrapper, built by `getCode` above.
+                    expect(deployMock).toHaveBeenCalledTimes(1);
+                    _c = __read(deployMock.mock.calls[0], 1), payload = _c[0];
+                    expect(payload.appLoc).toEqual(target.appLoc);
+                    deployed = new Map();
+                    indexMembers = function (members, prefix) {
+                        if (members === void 0) { members = []; }
+                        if (prefix === void 0) { prefix = ''; }
+                        return members.forEach(function (member) {
+                            var memberPath = prefix ? "".concat(prefix, "/").concat(member.name) : member.name;
+                            if (member.type === 'folder')
+                                indexMembers(member.members, memberPath);
+                            else
+                                deployed.set(memberPath, member);
+                        });
+                    };
+                    indexMembers(payload.fileTree.members);
+                    projectRoot = path_1.default.join(__dirname, appName);
+                    mocksRoot = path_1.default.join(projectRoot, 'sasjs', 'mocks');
+                    mockFiles = listFiles(mocksRoot);
+                    _k.label = 11;
+                case 11:
+                    _k.trys.push([11, 16, 17, 18]);
+                    mockFiles_1 = __values(mockFiles), mockFiles_1_1 = mockFiles_1.next();
+                    _k.label = 12;
+                case 12:
+                    if (!!mockFiles_1_1.done) return [3 /*break*/, 15];
+                    filePath = mockFiles_1_1.value;
+                    relative = path_1.default
+                        .relative(mocksRoot, filePath)
+                        .split(path_1.default.sep)
+                        .join('/');
+                    _e = (_d = expect(deployed.get(relative))).toEqual;
+                    _h = {
+                        name: path_1.default.basename(filePath),
+                        type: 'file',
+                        encoding: 'base64'
+                    };
+                    _f = js_base64_1.encode;
+                    return [4 /*yield*/, (0, utils_1.readFile)(filePath)];
+                case 13:
+                    _e.apply(_d, [(_h.code = _f.apply(void 0, [_k.sent()]),
+                            _h)]);
+                    _k.label = 14;
+                case 14:
+                    mockFiles_1_1 = mockFiles_1.next();
+                    return [3 /*break*/, 12];
+                case 15: return [3 /*break*/, 18];
+                case 16:
+                    e_1_1 = _k.sent();
+                    e_1 = { error: e_1_1 };
+                    return [3 /*break*/, 18];
+                case 17:
+                    try {
+                        if (mockFiles_1_1 && !mockFiles_1_1.done && (_g = mockFiles_1.return)) _g.call(mockFiles_1);
+                    }
+                    finally { if (e_1) throw e_1.error; }
+                    return [7 /*endfinally*/];
+                case 18:
+                    serviceFiles = listFiles(path_1.default.join(projectRoot, 'sasjs', 'services', 'common')).filter(function (filePath) { return filePath.endsWith('.sas'); });
+                    _k.label = 19;
+                case 19:
+                    _k.trys.push([19, 24, 25, 26]);
+                    serviceFiles_1 = __values(serviceFiles), serviceFiles_1_1 = serviceFiles_1.next();
+                    _k.label = 20;
+                case 20:
+                    if (!!serviceFiles_1_1.done) return [3 /*break*/, 23];
+                    filePath = serviceFiles_1_1.value;
+                    name_1 = path_1.default.basename(filePath, '.sas');
+                    return [4 /*yield*/, (0, utils_1.readFile)(filePath)];
+                case 21:
+                    contents = _k.sent();
+                    member = deployed.get("services/common/".concat(name_1));
+                    expect(member).toMatchObject({ name: name_1, type: 'service' });
+                    // the compiled service ends its text with a blank line before the end
+                    // marker, whatever trailing whitespace the source file carries
+                    expect(member.code).toEqual(getCode((0, utils_1.removeHeader)(contents).trimEnd() + '\n\n'));
+                    _k.label = 22;
+                case 22:
+                    serviceFiles_1_1 = serviceFiles_1.next();
+                    return [3 /*break*/, 20];
+                case 23: return [3 /*break*/, 26];
+                case 24:
+                    e_2_1 = _k.sent();
+                    e_2 = { error: e_2_1 };
+                    return [3 /*break*/, 26];
+                case 25:
+                    try {
+                        if (serviceFiles_1_1 && !serviceFiles_1_1.done && (_j = serviceFiles_1.return)) _j.call(serviceFiles_1);
+                    }
+                    finally { if (e_2) throw e_2.error; }
+                    return [7 /*endfinally*/];
+                case 26:
+                    // and nothing else: a member the CLI gains or loses shows as a difference
+                    // in the count, rather than silently passing inside a hand-written tree
+                    expect(deployed.size).toEqual(mockFiles.length + serviceFiles.length);
                     return [2 /*return*/];
             }
         });

package/build/commands/shared/createLintConfigFile.js

@@ -1,4 +1,15 @@
 "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) {
@@ -43,18 +54,29 @@ exports.createLintConfigFile = void 0;
 var path_1 = __importDefault(require("path"));
 var lint_1 = require("@sasjs/lint");
 var utils_1 = require("@sasjs/utils");
+/**
+ * Where the settings of a `.sasjslint` are documented.
+ *
+ * The file is read as strict JSON, so it cannot carry comments - the same
+ * problem `sasjsconfig.json` answers with `$schema`, and the same address
+ * pattern (`sasjs init` writes https://cli.sasjs.io/sasjsconfig-schema.json).
+ * An editor that understands JSON schemas then completes the settings and
+ * shows each one's description as it is typed.
+ */
+var lintSchemaUrl = 'https://cli.sasjs.io/sasjslint-schema.json';
 /**
  * Creates a SASjs Lint configuration file.
  * Its name will be of the form '.sasjslint'
  * @param {string} parentFolderName- the name of the project folder.
  */
 var createLintConfigFile = function (parentFolderName) { return __awaiter(void 0, void 0, void 0, function () {
-    var configDestinationPath;
+    var configDestinationPath, config;
     return __generator(this, function (_a) {
         switch (_a.label) {
             case 0:
                 configDestinationPath = path_1.default.join(process.projectDir, parentFolderName, '.sasjslint');
-                return [4 /*yield*/, (0, utils_1.createFile)(configDestinationPath, JSON.stringify(lint_1.DefaultLintConfiguration, null, 2))];
+                config = __assign({ $schema: lintSchemaUrl }, lint_1.DefaultLintConfiguration);
+                return [4 /*yield*/, (0, utils_1.createFile)(configDestinationPath, JSON.stringify(config, null, 2))];
             case 1:
                 _a.sent();
                 return [2 /*return*/];

package/build/commands/shared/spec/createLintConfigFile.spec.d.ts

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

package/build/commands/shared/spec/createLintConfigFile.spec.js

@@ -0,0 +1,132 @@
+"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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __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 = 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 __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var promises_1 = require("fs/promises");
+var os = __importStar(require("os"));
+var path = __importStar(require("path"));
+var lint_1 = require("@sasjs/lint");
+var utils_1 = require("@sasjs/utils");
+var createLintConfigFile_1 = require("../createLintConfigFile");
+/**
+ * The file this writes is the first thing a new project has to edit, and the
+ * only place its settings are described: it is read as strict JSON, so it cannot
+ * carry comments, and `$schema` is what gives an editor the description of each
+ * setting where it is written.
+ */
+describe('createLintConfigFile', function () {
+    var originalProjectDir = process.projectDir;
+    var projectDir;
+    beforeEach(function () { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    projectDir = path.join(os.tmpdir(), "sasjs-lint-config-".concat(Date.now(), "-").concat(Math.random().toString(36).slice(2)));
+                    return [4 /*yield*/, (0, utils_1.createFolder)(projectDir)];
+                case 1:
+                    _a.sent();
+                    process.projectDir = projectDir;
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    afterEach(function () {
+        process.projectDir = originalProjectDir;
+    });
+    it('writes every default setting, with the schema', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var written, _a, _b, _schema, settings;
+        return __generator(this, function (_c) {
+            switch (_c.label) {
+                case 0: return [4 /*yield*/, (0, createLintConfigFile_1.createLintConfigFile)('.')];
+                case 1:
+                    _c.sent();
+                    _b = (_a = JSON).parse;
+                    return [4 /*yield*/, (0, promises_1.readFile)(path.join(projectDir, '.sasjslint'), 'utf-8')];
+                case 2:
+                    written = _b.apply(_a, [_c.sent()]);
+                    expect(written.$schema).toEqual('https://cli.sasjs.io/sasjslint-schema.json');
+                    _schema = written.$schema, settings = __rest(written, ["$schema"]);
+                    expect(settings).toEqual(lint_1.DefaultLintConfiguration);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});

package/build/utils/test.d.ts

@@ -50,6 +50,18 @@ export declare const generateTestTarget: (targetName: string, appLoc: string, se
 export declare const createTestGlobalTarget: (targetName: string, appLoc: string, serviceConfig?: ServiceConfig, serverType?: ServerType) => Promise<Target>;
 export declare const verifyStep: (step?: "db" | "compile" | "build", buildFileName?: string, customFiles?: "custom" | "no") => Promise<void>;
 export declare const mockProcessExit: () => jest.SpyInstance<never, [code?: string | number | null | undefined], any>;
+/**
+ * The file tree of a seed app, read from the archive `sasjs create` downloads.
+ *
+ * A created project used to be compared against a hand-kept list of the files
+ * each template ships, so every seed release that added or removed one turned
+ * this suite red with no change to the CLI - twice in one afternoon, for
+ * `springs.json` and for the angular template's component specs. The template
+ * is what the command copies, so it is what the test compares against: the same
+ * repository, fetched the same way, with the copy's own normalisations applied
+ * where the command makes them.
+ */
+export declare const getTemplateFileTree: (repoUrl: string) => Promise<Folder>;
 export declare const verifyFolder: (folder: Folder, parentFolderName?: string) => Promise<boolean>;
 export declare const verifyPackageJsonContent: (parentFolderName?: string) => Promise<void>;
 export declare const removeAllTargetsFromConfigs: () => Promise<void>;

package/build/utils/test.js

@@ -108,8 +108,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.verifyGitNotPresent = exports.verifyCompiledJob = exports.verifyCompiledService = exports.verifyDotFilesNotGenerated = exports.verifyDotFiles = exports.verifyDocs = exports.updateConfig = exports.updateTarget = exports.removeAllTargetsFromConfigs = exports.verifyPackageJsonContent = exports.verifyFolder = exports.mockProcessExit = exports.verifyStep = exports.createTestGlobalTarget = exports.generateTestTarget = exports.removeTestServerFolder = exports.removeTestApp = exports.createTestMinimalApp = exports.createTestJobsApp = exports.createTestApp = exports.stubNpm = exports.npmCommands = exports.generateUniqueTimestamp = void 0;
+exports.verifyGitNotPresent = exports.verifyCompiledJob = exports.verifyCompiledService = exports.verifyDotFilesNotGenerated = exports.verifyDotFiles = exports.verifyDocs = exports.updateConfig = exports.updateTarget = exports.removeAllTargetsFromConfigs = exports.verifyPackageJsonContent = exports.verifyFolder = exports.getTemplateFileTree = exports.mockProcessExit = exports.verifyStep = exports.createTestGlobalTarget = exports.generateTestTarget = exports.removeTestServerFolder = exports.removeTestApp = exports.createTestMinimalApp = exports.createTestJobsApp = exports.createTestApp = exports.stubNpm = exports.npmCommands = exports.generateUniqueTimestamp = void 0;
 var fs_1 = __importDefault(require("fs"));
+var os_1 = __importDefault(require("os"));
 var path_1 = __importDefault(require("path"));
 var dotenv_1 = __importDefault(require("dotenv"));
 var utils_1 = require("@sasjs/utils");
@@ -122,6 +123,8 @@ var compiledFilesCustom1_1 = require("./fileStructures/compiledFilesCustom1");
 var builtFiles_1 = require("./fileStructures/builtFiles");
 var builtFilesCustom1_1 = require("./fileStructures/builtFilesCustom1");
 var create_1 = require("../commands/create/create");
+var utils_2 = require("./utils");
+var zip_1 = require("./zip");
 var setConstants_1 = require("./setConstants");
 var shell = __importStar(require("./shell"));
 /**
@@ -524,6 +527,68 @@ var verifyBuildJson = function (folders, buildJson, buildSas) {
     });
     return true;
 };
+/**
+ * The file tree of a seed app, read from the archive `sasjs create` downloads.
+ *
+ * A created project used to be compared against a hand-kept list of the files
+ * each template ships, so every seed release that added or removed one turned
+ * this suite red with no change to the CLI - twice in one afternoon, for
+ * `springs.json` and for the angular template's component specs. The template
+ * is what the command copies, so it is what the test compares against: the same
+ * repository, fetched the same way, with the copy's own normalisations applied
+ * where the command makes them.
+ */
+var getTemplateFileTree = function (repoUrl) { return __awaiter(void 0, void 0, void 0, function () {
+    var workspace, archive, main_1, root;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                if (!repoUrl) {
+                    throw new Error("No seed app URL for that template - add it to seedAppUrls in src/utils/utils.ts");
+                }
+                workspace = fs_1.default.mkdtempSync(path_1.default.join(os_1.default.tmpdir(), 'sasjs-template-'));
+                _a.label = 1;
+            case 1:
+                _a.trys.push([1, , 3, 4]);
+                archive = path_1.default.join(workspace, 'main.zip');
+                main_1 = (0, utils_2.downloadFile)("".concat(repoUrl, "/archive/refs/heads/main.zip"), archive);
+                // the seed repos are on `main`, but the command falls back to `master` and
+                // the reference has to be taken from whatever it would have downloaded
+                if (main_1.code || main_1.stderr.includes('404')) {
+                    (0, utils_2.downloadFile)("".concat(repoUrl, "/archive/refs/heads/master.zip"), archive);
+                }
+                return [4 /*yield*/, (0, zip_1.extractZip)(archive, workspace, true)];
+            case 2:
+                _a.sent();
+                root = fs_1.default
+                    .readdirSync(workspace, { withFileTypes: true })
+                    .find(function (entry) { return entry.isDirectory(); });
+                if (!root) {
+                    throw new Error("Could not find the unzipped folder for ".concat(repoUrl));
+                }
+                return [2 /*return*/, toFileTree(path_1.default.join(workspace, root.name), root.name)];
+            case 3:
+                fs_1.default.rmSync(workspace, { recursive: true, force: true });
+                return [7 /*endfinally*/];
+            case 4: return [2 /*return*/];
+        }
+    });
+}); };
+exports.getTemplateFileTree = getTemplateFileTree;
+var toFileTree = function (folderPath, folderName) {
+    var entries = fs_1.default.readdirSync(folderPath, { withFileTypes: true });
+    return {
+        folderName: folderName,
+        // `create` removes this once the docs have been fetched into the folder, so
+        // it is the one file the project is not expected to carry
+        files: entries
+            .filter(function (entry) { return entry.isFile() && entry.name !== '.gitmodules'; })
+            .map(function (entry) { return ({ fileName: entry.name }); }),
+        subFolders: entries
+            .filter(function (entry) { return entry.isDirectory(); })
+            .map(function (entry) { return toFileTree(path_1.default.join(folderPath, entry.name), entry.name); })
+    };
+};
 var verifyFolder = function (folder_1) {
     var args_1 = [];
     for (var _i = 1; _i < arguments.length; _i++) {
@@ -585,9 +650,11 @@ var verifyPackageJsonContent = function () {
                 case 2:
                     packageJsonContent = _a.sent();
                     packageJson = JSON.parse(packageJsonContent);
-                    expect(parentFolderName.includes('minimal')
-                        ? packageJson.devDependencies
-                        : packageJson.dependencies).toEqual(expect.objectContaining({ '@sasjs/core': expect.anything() }));
+                    // Which map the seed app declares its SASjs dependency in is the seed's
+                    // business - a web app carries @sasjs/core as a devDependency (it compiles
+                    // the macros in) while the jobs template installs it as a dependency. What
+                    // this asserts is that the template brings the macros with it at all.
+                    expect(__assign(__assign({}, packageJson.devDependencies), packageJson.dependencies)).toEqual(expect.objectContaining({ '@sasjs/core': expect.anything() }));
                     return [2 /*return*/];
             }
         });

package/build/utils/utils.d.ts

@@ -4,6 +4,14 @@ import SASjs from '@sasjs/adapter/node';
 import { LogJson } from '../types';
 export declare function inExistingProject(folderPath: string): Promise<boolean>;
 export declare function diff(a: any[], b: any[]): any[];
+/**
+ * The seed apps `sasjs create` downloads, by template name.
+ *
+ * One map for the commands that fetch them and the specs that compare their
+ * output, so a template added here is covered by both rather than downloaded
+ * by one and unknown to the other.
+ */
+export declare const seedAppUrls: Record<string, string>;
 export declare function createReactApp(folderPath: string): Promise<void>;
 export declare function createAngularApp(folderPath: string): Promise<void>;
 export declare function createMinimalApp(folderPath: string): Promise<void>;