@sasjs/cli 6.4.3 → 6.4.4

package/build/commands/create/spec/create.spec.js

@@ -1,37 +1,4 @@
 "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) {
@@ -82,22 +49,12 @@ var reactAppFiles_1 = require("./reactAppFiles");
 var angularAppFiles_1 = require("./angularAppFiles");
 var create_1 = require("../create");
 var utils_2 = require("../../../utils");
-var shell = __importStar(require("../../../utils/shell"));
 describe('sasjs create', function () {
     beforeAll(function () {
         dotenv_1.default.config();
     });
     beforeEach(function () {
-        var exec = shell.exec;
-        jest.spyOn(shell, 'exec').mockImplementation(function (command) {
-            if (!command.includes('npm install')) {
-                return exec(command, {
-                    silent: true
-                });
-            }
-            // The real install is skipped; the caller ignores the result.
-            return { stdout: '', stderr: '', code: 0 };
-        });
+        (0, test_1.stubNpm)();
     });
     afterEach(function () { return __awaiter(void 0, void 0, void 0, function () {
         return __generator(this, function (_a) {
@@ -128,9 +85,15 @@ describe('sasjs create', function () {
                     return [4 /*yield*/, expect((0, create_1.create)('.', '')).toResolve()];
                 case 3:
                     _a.sent();
-                    return [4 /*yield*/, verifyCreate('.', '')];
+                    return [4 /*yield*/, verifyCreate('.', '')
+                        // verifyCreate's package.json assertion is only meaningful if create asked
+                        // npm to add the dependency - the stub writes what that command writes.
+                    ];
                 case 4:
                     _a.sent();
+                    // verifyCreate's package.json assertion is only meaningful if create asked
+                    // npm to add the dependency - the stub writes what that command writes.
+                    expect(test_1.npmCommands).toContain('npm i @sasjs/core --save');
                     return [2 /*return*/];
             }
         });
@@ -301,9 +264,17 @@ var verifyCreateWeb = function (appName, appType) { return __awaiter(void 0, voi
                 return [4 /*yield*/, (0, test_1.verifyFolder)(fileStructure)];
             case 1:
                 _a.sent();
-                return [4 /*yield*/, (0, test_1.verifyPackageJsonContent)(appName)];
+                return [4 /*yield*/, (0, test_1.verifyPackageJsonContent)(appName)
+                    // A seed app carries its dependencies in the template's package.json, so the
+                    // command create issues for it is a plain install - the same trade as above:
+                    // the stub writes what npm would, and this asserts the CLI asked for it.
+                ];
             case 2:
                 _a.sent();
+                // A seed app carries its dependencies in the template's package.json, so the
+                // command create issues for it is a plain install - the same trade as above:
+                // the stub writes what npm would, and this asserts the CLI asked for it.
+                expect(test_1.npmCommands).toContain('npm install');
                 return [2 /*return*/];
         }
     });

package/build/utils/spec/utils.spec.js

@@ -357,6 +357,7 @@ describe('utils', function () {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
+                        (0, test_1.stubNpm)();
                         reactFolder = 'react-seed-app';
                         reactFolderPath = path_1.default.join(__dirname, reactFolder);
                         sasjsFolderPath = path_1.default.join(reactFolderPath, 'sasjs');

package/build/utils/test.d.ts

@@ -11,6 +11,36 @@ import { ServiceConfig, JobConfig } from '@sasjs/utils/types/config';
  * short random suffix make that impossible while keeping the name readable.
  */
 export declare const generateUniqueTimestamp: () => string;
+/**
+ * Every npm command the stub has answered since it was last installed, in order
+ * - so a spec can assert the command the CLI issued, not only the package.json
+ * it left behind. `stubNpm` empties it, so one test sees only its own commands.
+ */
+export declare const npmCommands: string[];
+/**
+ * Answers the npm commands `create` and `init` issue, and runs everything else
+ * for real.
+ *
+ * Scaffolding an app shells out to npm three ways: `npm init` (about 0.6s), an
+ * install of @sasjs/core (about 1.3s) and, for a seed app, that app's whole
+ * dependency tree (about 3s for minimal, 27s for react). Every spec that
+ * creates an app pays all of it, again and again, and every one of those calls
+ * needs the registry to answer - so the "mocked" suite is neither fast nor
+ * offline.
+ *
+ * None of it is the CLI's own behaviour. The CLI owns the command it issues and
+ * the package.json a project is left with, so the stub answers those three
+ * commands with exactly that effect and records them in `npmCommands`; every
+ * other command - the template downloads, compiles, builds and docs - still runs
+ * for real.
+ *
+ * Call it where the app is created: from `beforeEach`, or from a helper that
+ * runs there. Jest restores spies before each test, so a stub installed in
+ * `beforeAll` is gone before the first test body runs - and because `npmCommands`
+ * is emptied on installation, a spec asserting on it must install the stub in
+ * the same test that creates the app.
+ */
+export declare const stubNpm: () => void;
 export declare const createTestApp: (parentFolder: string, appName: string) => Promise<void>;
 export declare const createTestJobsApp: (parentFolder: string, appName: string) => Promise<void>;
 export declare const createTestMinimalApp: (parentFolder: string, appName: string) => Promise<void>;

package/build/utils/test.js

@@ -10,6 +10,39 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
+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) {
@@ -75,7 +108,8 @@ 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.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.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 path_1 = __importDefault(require("path"));
 var dotenv_1 = __importDefault(require("dotenv"));
 var utils_1 = require("@sasjs/utils");
@@ -89,6 +123,7 @@ var builtFiles_1 = require("./fileStructures/builtFiles");
 var builtFilesCustom1_1 = require("./fileStructures/builtFilesCustom1");
 var create_1 = require("../commands/create/create");
 var setConstants_1 = require("./setConstants");
+var shell = __importStar(require("./shell"));
 /**
  * A name for a test app or output folder that two specs cannot collide on.
  *
@@ -104,11 +139,134 @@ var generateUniqueTimestamp = function () {
         .slice(2, 7));
 };
 exports.generateUniqueTimestamp = generateUniqueTimestamp;
+/**
+ * Every npm command the stub has answered since it was last installed, in order
+ * - so a spec can assert the command the CLI issued, not only the package.json
+ * it left behind. `stubNpm` empties it, so one test sees only its own commands.
+ */
+exports.npmCommands = [];
+/** The marker this helper puts on the mock it installs. */
+var stubMarker = Symbol('stubNpm');
+/**
+ * Answers the npm commands `create` and `init` issue, and runs everything else
+ * for real.
+ *
+ * Scaffolding an app shells out to npm three ways: `npm init` (about 0.6s), an
+ * install of @sasjs/core (about 1.3s) and, for a seed app, that app's whole
+ * dependency tree (about 3s for minimal, 27s for react). Every spec that
+ * creates an app pays all of it, again and again, and every one of those calls
+ * needs the registry to answer - so the "mocked" suite is neither fast nor
+ * offline.
+ *
+ * None of it is the CLI's own behaviour. The CLI owns the command it issues and
+ * the package.json a project is left with, so the stub answers those three
+ * commands with exactly that effect and records them in `npmCommands`; every
+ * other command - the template downloads, compiles, builds and docs - still runs
+ * for real.
+ *
+ * Call it where the app is created: from `beforeEach`, or from a helper that
+ * runs there. Jest restores spies before each test, so a stub installed in
+ * `beforeAll` is gone before the first test body runs - and because `npmCommands`
+ * is emptied on installation, a spec asserting on it must install the stub in
+ * the same test that creates the app.
+ */
+var stubNpm = function () {
+    // Re-install when jest has restored the previous stub: the marker goes with the
+    // mock, so its absence is what tells a restored stub from a live one. The
+    // marker also distinguishes this stub from a spy a spec installed for its own
+    // reasons - a bare `isMockFunction` check cannot, and would leave the npm calls
+    // running for real.
+    if (shell.exec[stubMarker])
+        return;
+    exports.npmCommands.length = 0;
+    var realExec = shell.exec;
+    var stub = jest
+        .spyOn(shell, 'exec')
+        .mockImplementation(function (command, options) {
+        if (options === void 0) { options = {}; }
+        var call = npmCall(command);
+        if (!call)
+            return realExec(command, options);
+        exports.npmCommands.push(call.command);
+        call.run();
+        return { stdout: '', stderr: '', code: 0 };
+    });
+    stub[stubMarker] = true;
+};
+exports.stubNpm = stubNpm;
+/**
+ * Parses one of the CLI's shell commands into the npm call it stands for, or
+ * null when it is a command that must really run.
+ */
+var npmCall = function (command) {
+    // Every npm command is issued as `cd "<folder>" && npm ...`.
+    var parsed = /^cd "([^"]+)" && (npm .*)$/.exec(command);
+    if (!parsed)
+        return null;
+    var _a = __read(parsed, 3), folder = _a[1], npm = _a[2];
+    if (/^npm init\b/.test(npm))
+        return { command: npm, run: function () { return writePackageJson(folder); } };
+    if (/^npm i(nstall)? @sasjs\/core\b/.test(npm))
+        return { command: npm, run: function () { return addCoreDependency(folder); } };
+    // A seed app's own tree. The template's package.json already declares it and
+    // no spec reads node_modules, so there is nothing here to install.
+    if (/^npm install$/.test(npm))
+        return { command: npm, run: function () { } };
+    // An npm command this stub does not answer would go to the registry and cost
+    // seconds per call, with nothing here to show for it - so say so instead of
+    // quietly running it. A new npm call in the CLI means teaching this stub.
+    throw new Error("stubNpm does not know how to answer the npm command: ".concat(command));
+};
+/** The package.json `npm init --yes` writes into an otherwise empty folder. */
+var writePackageJson = function (folder) {
+    var filePath = path_1.default.join(folder, 'package.json');
+    if (fs_1.default.existsSync(filePath))
+        return;
+    fs_1.default.writeFileSync(filePath, JSON.stringify({
+        name: path_1.default.basename(folder),
+        version: '1.0.0',
+        description: '',
+        main: 'index.js',
+        scripts: { test: 'echo "Error: no test specified" && exit 1' },
+        keywords: [],
+        author: '',
+        license: 'ISC'
+    }, null, 2));
+};
+/** What `npm i @sasjs/core --save` does to package.json and the lockfile. */
+var addCoreDependency = function (folder) {
+    var filePath = path_1.default.join(folder, 'package.json');
+    var packageJson = fs_1.default.existsSync(filePath)
+        ? JSON.parse(fs_1.default.readFileSync(filePath, 'utf8'))
+        : {};
+    packageJson.dependencies = __assign(__assign({}, (packageJson.dependencies || {})), { 
+        // The range the CLI itself declares. Any range satisfies the specs, and
+        // reading it here means the stub cannot drift from the package it tests.
+        '@sasjs/core': cliPackageJson().dependencies['@sasjs/core'] });
+    fs_1.default.writeFileSync(filePath, JSON.stringify(packageJson, null, 2));
+    // An install leaves a lockfile behind, and specs assert on its presence.
+    fs_1.default.writeFileSync(path_1.default.join(folder, 'package-lock.json'), JSON.stringify({
+        name: packageJson.name,
+        version: packageJson.version,
+        lockfileVersion: 3,
+        packages: {
+            '': {
+                name: packageJson.name,
+                version: packageJson.version,
+                dependencies: packageJson.dependencies
+            }
+        }
+    }, null, 2));
+};
+var cliPackageJson = function () {
+    return JSON.parse(fs_1.default.readFileSync(path_1.default.join(__dirname, '..', '..', 'package.json'), 'utf8'));
+};
 var createTestApp = function (parentFolder, appName) { return __awaiter(void 0, void 0, void 0, function () {
     var _a;
     return __generator(this, function (_b) {
         switch (_b.label) {
             case 0:
+                (0, exports.stubNpm)();
                 process.projectDir = parentFolder;
                 return [4 /*yield*/, (0, create_1.create)(appName, '')];
             case 1:
@@ -132,6 +290,7 @@ var createTestJobsApp = function (parentFolder, appName) { return __awaiter(void
     return __generator(this, function (_b) {
         switch (_b.label) {
             case 0:
+                (0, exports.stubNpm)();
                 process.projectDir = parentFolder;
                 return [4 /*yield*/, (0, create_1.create)(appName, 'jobs')];
             case 1:
@@ -158,6 +317,7 @@ var createTestMinimalApp = function (parentFolder, appName) { return __awaiter(v
     return __generator(this, function (_b) {
         switch (_b.label) {
             case 0:
+                (0, exports.stubNpm)();
                 process.projectDir = parentFolder;
                 return [4 /*yield*/, (0, create_1.create)(appName, 'minimal')];
             case 1:

package/package.json

@@ -73,7 +73,7 @@
     "@sasjs/adapter": "^5.1.1",
     "@sasjs/core": "^6.1.1",
     "@sasjs/lint": "4.8.1",
-    "@sasjs/utils": "^4.1.1",
+    "@sasjs/utils": "^4.1.2",
     "axios": "1.20.0",
     "chalk": "4.1.2",
     "dotenv": "18.0.8",
@@ -123,5 +123,5 @@
     "ws": "8.21.0",
     "nanoid": "3.3.18"
   },
-  "version": "6.4.3"
+  "version": "6.4.4"
 }