@salesforce/cli-plugins-testkit 3.2.19 → 3.2.21

package/lib/execCmd.d.ts

@@ -18,7 +18,11 @@ type BaseExecOptions = {
      */
     cli?: CLI;
 };
-export type ExecCmdOptions = ExecOptions & BaseExecOptions;
+export type ExecCmdOptions = ExecOptions & BaseExecOptions & ({
+    cwd: string;
+} | {
+    cwd?: never;
+});
 type ExcludeMethods<T> = Pick<T, NonNullable<{
     [K in keyof T]: T[K] extends (_: any) => any ? never : K;
 }[keyof T]>>;

package/lib/execCmd.js

@@ -17,6 +17,7 @@ const debug_1 = require("debug");
 const shelljs = require("shelljs");
 const shelljs_1 = require("shelljs");
 const stripAnsi = require("strip-ansi");
+const genUniqueString_1 = require("./genUniqueString");
 const buildCmdOptions = (options) => {
     const defaults = {
         env: { ...process.env, ...options?.env },
@@ -34,10 +35,10 @@ const buildCmdOptions = (options) => {
 // Create a Duration instance from process.hrtime
 const hrtimeToMillisDuration = (hrTime) => kit_1.Duration.milliseconds(hrTime[0] * kit_1.Duration.MILLIS_IN_SECONDS + hrTime[1] / 1e6);
 // Add JSON output if json flag is set
-const addJsonOutput = (cmd, result) => {
+const addJsonOutput = (cmd, result, file) => {
     if (cmd.includes('--json')) {
         try {
-            result.jsonOutput = (0, kit_1.parseJson)(stripAnsi(result.shellOutput.stdout));
+            result.jsonOutput = (0, kit_1.parseJson)(stripAnsi(fs.readFileSync(file, 'utf-8')));
         }
         catch (parseErr) {
             result.jsonError = parseErr;
@@ -92,30 +93,45 @@ const execCmdSync = (cmd, options) => {
     const cmdOptions = buildCmdOptions(options);
     debug(`Running cmd: ${cmd}`);
     debug(`Cmd options: ${(0, util_1.inspect)(cmdOptions)}`);
+    const stdoutFile = `${(0, genUniqueString_1.genUniqueString)('stdout')}.txt`;
+    const stderrFile = `${(0, genUniqueString_1.genUniqueString)('stderr')}.txt`;
+    const stdoutFileLocation = (0, path_1.join)(cmdOptions.cwd, stdoutFile);
+    const stderrFileLocation = (0, path_1.join)(cmdOptions.cwd, stderrFile);
     const result = {
-        shellOutput: '',
+        shellOutput: new shelljs_1.ShellString(''),
         execCmdDuration: kit_1.Duration.seconds(0),
     };
     // Execute the command in a synchronous child process
     const startTime = process.hrtime();
-    result.shellOutput = shelljs.exec(cmd, cmdOptions);
+    const code = shelljs.exec(`${cmd} 1> ${stdoutFile} 2> ${stderrFile} `, cmdOptions).code;
+    // capture the output for both stdout and stderr
+    result.shellOutput = new shelljs_1.ShellString(stripAnsi(fs.readFileSync(stdoutFileLocation, 'utf-8')));
     result.shellOutput.stdout = stripAnsi(result.shellOutput.stdout);
-    result.shellOutput.stderr = stripAnsi(result.shellOutput.stderr);
+    const shellStringForStderr = new shelljs_1.ShellString(stripAnsi(fs.readFileSync(stderrFileLocation, 'utf-8')));
+    // The ShellString constructor sets the argument as stdout, so we strip 'stdout' and set as stderr
+    result.shellOutput.stderr = stripAnsi(shellStringForStderr.stdout);
+    result.shellOutput.code = code;
     result.execCmdDuration = hrtimeToMillisDuration(process.hrtime(startTime));
     debug(`Command completed with exit code: ${result.shellOutput.code}`);
     if ((0, ts_types_1.isNumber)(cmdOptions.ensureExitCode) && result.shellOutput.code !== cmdOptions.ensureExitCode) {
         throw getExitCodeError(cmd, cmdOptions.ensureExitCode, result.shellOutput);
     }
-    return addJsonOutput(cmd, result);
+    const withJson = addJsonOutput(cmd, result, stdoutFileLocation);
+    fs.rmSync(stderrFileLocation);
+    fs.rmSync(stdoutFileLocation);
+    return withJson;
 };
 const execCmdAsync = async (cmd, options) => {
     const debug = (0, debug_1.default)('testkit:execCmdAsync');
     // Add on the bin path
     cmd = buildCmd(cmd, options);
-    const resultPromise = new Promise((resolve, reject) => {
+    return new Promise((resolve, reject) => {
         const cmdOptions = buildCmdOptions(options);
         debug(`Running cmd: ${cmd}`);
         debug(`Cmd options: ${(0, util_1.inspect)(cmdOptions)}`);
+        // buildCmdOptions will always
+        const stdoutFileLocation = (0, path_1.join)(cmdOptions.cwd, `${(0, genUniqueString_1.genUniqueString)('stdout')}.txt`);
+        const stderrFileLocation = (0, path_1.join)(cmdOptions.cwd, `${(0, genUniqueString_1.genUniqueString)('stderr')}.txt`);
         const callback = (code, stdout, stderr) => {
             const execCmdDuration = hrtimeToMillisDuration(process.hrtime(startTime));
             debug(`Command completed with exit code: ${code}`);
@@ -126,19 +142,28 @@ const execCmdAsync = async (cmd, options) => {
                 reject(getExitCodeError(cmd, cmdOptions.ensureExitCode, output));
             }
             const result = {
-                shellOutput: new shelljs_1.ShellString(stdout),
+                shellOutput: new shelljs_1.ShellString(fs.readFileSync(stdoutFileLocation, 'utf-8')),
                 execCmdDuration,
             };
             result.shellOutput.code = code;
-            result.shellOutput.stdout = stripAnsi(stdout);
-            result.shellOutput.stderr = stripAnsi(stderr);
-            resolve(addJsonOutput(cmd, result));
+            if (code === 0) {
+                result.shellOutput = new shelljs_1.ShellString(stripAnsi(fs.readFileSync(stdoutFileLocation, 'utf-8')));
+                result.shellOutput.stdout = stripAnsi(result.shellOutput.stdout);
+            }
+            else {
+                result.shellOutput = new shelljs_1.ShellString(stripAnsi(fs.readFileSync(stderrFileLocation, 'utf-8')));
+                // The ShellString constructor sets the argument as stdout, so we strip 'stdout' and set as stderr
+                result.shellOutput.stderr = stripAnsi(result.shellOutput.stdout);
+            }
+            const addJson = addJsonOutput(cmd, result, stdoutFileLocation);
+            fs.rmSync(stdoutFileLocation);
+            fs.rmSync(stderrFileLocation);
+            resolve(addJson);
         };
         // Execute the command async in a child process
         const startTime = process.hrtime();
-        shelljs.exec(cmd, cmdOptions, callback);
+        shelljs.exec(`${cmd} 1> ${stdoutFileLocation} 2> ${stderrFileLocation}`, cmdOptions, callback);
     });
-    return resultPromise;
 };
 function execCmd(cmd, options) {
     if (options?.async) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/cli-plugins-testkit",
   "description": "Provides test utilities to assist Salesforce CLI plug-in authors with writing non-unit tests (NUT).",
-  "version": "3.2.19",
+  "version": "3.2.21",
   "author": "Salesforce",
   "license": "BSD-3-Clause",
   "main": "lib/index.js",
@@ -54,30 +54,30 @@
   },
   "devDependencies": {
     "@salesforce/dev-config": "^3.0.0",
-    "@salesforce/dev-scripts": "^3.1.0",
+    "@salesforce/dev-scripts": "^3.1.1",
     "@salesforce/prettier-config": "^0.0.2",
-    "@salesforce/ts-sinon": "^1.4.4",
+    "@salesforce/ts-sinon": "^1.4.5",
     "@types/archiver": "^5.1.0",
     "@types/debug": "^4.1.5",
     "@typescript-eslint/eslint-plugin": "^5.45.0",
-    "@typescript-eslint/parser": "^5.48.2",
+    "@typescript-eslint/parser": "^5.50.0",
     "chai": "^4.3.7",
-    "eslint": "^8.31.0",
+    "eslint": "^8.33.0",
     "eslint-config-prettier": "^8.6.0",
     "eslint-config-salesforce": "^1.1.0",
     "eslint-config-salesforce-license": "^0.2.0",
     "eslint-config-salesforce-typescript": "^1.1.1",
     "eslint-plugin-header": "^3.1.1",
     "eslint-plugin-import": "2.27.5",
-    "eslint-plugin-jsdoc": "^39.6.9",
+    "eslint-plugin-jsdoc": "^39.8.0",
     "husky": "^7.0.4",
     "mocha": "^9.1.3",
     "nyc": "^15.1.0",
-    "prettier": "^2.8.1",
+    "prettier": "^2.8.4",
     "pretty-quick": "^3.1.0",
     "sinon": "10.0.0",
     "ts-node": "^10.0.0",
-    "typescript": "^4.9.4"
+    "typescript": "^4.9.5"
   },
   "config": {},
   "publishConfig": {