@salesforce/cli-plugins-testkit 2.4.3 → 2.5.1

package/lib/execCmd.d.ts

@@ -1,6 +1,8 @@
+/// <reference types="node" />
+import { SpawnOptionsWithoutStdio } from 'child_process';
 import { SfError } from '@salesforce/core';
 import { Duration } from '@salesforce/kit';
-import { AnyJson } from '@salesforce/ts-types';
+import { AnyJson, Many } from '@salesforce/ts-types';
 import { ExecOptions, ShellString } from 'shelljs';
 declare type Collection = Record<string, AnyJson> | Array<Record<string, AnyJson>>;
 export interface ExecCmdOptions extends ExecOptions {
@@ -108,4 +110,53 @@ export declare function execCmd<T = Collection>(cmd: string, options: ExecCmdOpt
     async: true;
     cli?: 'sf';
 }): Promise<SfExecCmdResult<T>>;
+export declare enum Interaction {
+    DOWN = "\u001B[B",
+    UP = "\u001B[A",
+    ENTER = "\r",
+    SELECT = " ",
+    Yes = "Y\r",
+    No = "N\r",
+    BACKSPACE = "\b"
+}
+export declare type InteractiveCommandExecutionResult = {
+    code: number | null;
+    stdout: string;
+    stderr: string;
+    duration: Duration;
+};
+export declare type InteractiveCommandExecutionOptions = {
+    ensureExitCode?: number;
+} & SpawnOptionsWithoutStdio;
+/**
+ * A map of questions and answers to be used in an interactive command.
+ *
+ * The questions are strings that will be used to match the question asked by the command.
+ */
+export declare type PromptAnswers = Record<string, Many<string>>;
+/**
+ * Execute an interactive command.
+ *
+ * @example
+ * ```
+ * import { TestSession, execInteractiveCmd, Interaction } from '@salesforce/cli-plugins-testkit';
+ *
+ * const result = await execInteractiveCmd(
+ *    'dev generate plugin',
+ *    {
+ *      'internal Salesforce team': Interaction.Yes,
+ *      'name of your new plugin': ['plugin-awesome', Interaction.ENTER],
+ *      'description for your plugin': ['a description', Interaction.ENTER],
+ *      'Select the existing "sf" commands you plan to extend': [
+ *        Interaction.SELECT,
+ *        Interaction.DOWN,
+ *        Interaction.SELECT,
+ *        Interaction.ENTER,
+ *      ],
+ *    },
+ *    { cwd: session.dir, ensureExitCode: 0 }
+ *  );
+ * ```
+ */
+export declare function execInteractiveCmd(command: string, answers: PromptAnswers, options?: InteractiveCommandExecutionOptions): Promise<InteractiveCommandExecutionResult>;
 export {};

package/lib/execCmd.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.execCmd = void 0;
+exports.execInteractiveCmd = exports.Interaction = exports.execCmd = void 0;
 /*
  * Copyright (c) 2021, salesforce.com, inc.
  * All rights reserved.
@@ -8,6 +8,7 @@ exports.execCmd = void 0;
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 const fs = require("fs");
+const child_process_1 = require("child_process");
 const path_1 = require("path");
 const util_1 = require("util");
 const kit_1 = require("@salesforce/kit");
@@ -66,7 +67,8 @@ const getExitCodeError = (cmd, expectedCode, output) => {
  */
 const buildCmd = (cmdArgs, options) => {
     const debug = (0, debug_1.default)('testkit:buildCmd');
-    const bin = kit_1.env.getString('TESTKIT_EXECUTABLE_PATH') ?? (0, path_1.join)(process.cwd(), 'bin', 'dev');
+    const bin = kit_1.env.getString('TESTKIT_EXECUTABLE_PATH') ??
+        (0, path_1.join)(process.cwd(), 'bin', process.platform === 'win32' ? 'dev.cmd' : 'dev');
     const which = shelljs.which(bin);
     let resolvedPath = (0, path_1.resolve)(bin);
     // If which finds the path in the system path, use that.
@@ -159,4 +161,122 @@ function execCmd(cmd, options = DEFAULT_EXEC_OPTIONS) {
     }
 }
 exports.execCmd = execCmd;
+function toString(arrOrString) {
+    if (Array.isArray(arrOrString)) {
+        return arrOrString.join('');
+    }
+    return arrOrString;
+}
+function toArray(arrOrString) {
+    if (Array.isArray(arrOrString)) {
+        return arrOrString;
+    }
+    return [arrOrString];
+}
+var Interaction;
+(function (Interaction) {
+    Interaction["DOWN"] = "\u001B[B";
+    Interaction["UP"] = "\u001B[A";
+    Interaction["ENTER"] = "\r";
+    Interaction["SELECT"] = " ";
+    Interaction["Yes"] = "Y\r";
+    Interaction["No"] = "N\r";
+    Interaction["BACKSPACE"] = "\b";
+})(Interaction = exports.Interaction || (exports.Interaction = {}));
+/**
+ * Execute an interactive command.
+ *
+ * @example
+ * ```
+ * import { TestSession, execInteractiveCmd, Interaction } from '@salesforce/cli-plugins-testkit';
+ *
+ * const result = await execInteractiveCmd(
+ *    'dev generate plugin',
+ *    {
+ *      'internal Salesforce team': Interaction.Yes,
+ *      'name of your new plugin': ['plugin-awesome', Interaction.ENTER],
+ *      'description for your plugin': ['a description', Interaction.ENTER],
+ *      'Select the existing "sf" commands you plan to extend': [
+ *        Interaction.SELECT,
+ *        Interaction.DOWN,
+ *        Interaction.SELECT,
+ *        Interaction.ENTER,
+ *      ],
+ *    },
+ *    { cwd: session.dir, ensureExitCode: 0 }
+ *  );
+ * ```
+ */
+async function execInteractiveCmd(command, answers, options = {}) {
+    const debug = (0, debug_1.default)('testkit:execInteractiveCmd');
+    return new Promise((resolve, reject) => {
+        const bin = buildCmd('').trim();
+        const startTime = process.hrtime();
+        const child = (0, child_process_1.spawn)(bin, command.split(' '), { cwd: process.cwd(), ...options });
+        child.stdin.setDefaultEncoding('utf-8');
+        const seen = new Set();
+        const output = {
+            stdout: [],
+            stderr: [],
+        };
+        const scrollLimit = kit_1.env.getNumber('TESTKIT_SCROLL_LIMIT', 1000) ?? 1000;
+        let scrollCount = 0;
+        const handleData = (data, stream) => {
+            if (scrollCount > scrollLimit) {
+                reject(new Error(`Scroll limit of ${scrollLimit} reached`));
+            }
+            const current = data.toString();
+            debug(`${stream}: ${current}`);
+            output[stream].push(current);
+            const matchingQuestion = Object.keys(answers)
+                .filter((key) => !seen.has(key))
+                .find((key) => new RegExp(key).test(current));
+            if (!matchingQuestion)
+                return;
+            const answerString = toString(answers[matchingQuestion]);
+            const answerArray = toArray(answers[matchingQuestion]);
+            // If the answer includes a string that's NOT an Interactive enum value, then we need to scroll to it.
+            const scrollTarget = answerArray.find((answer) => !Object.values(Interaction).includes(answer));
+            const shouldScrollForAnswer = current.includes('❯') && scrollTarget;
+            if (shouldScrollForAnswer) {
+                const regex = /(?<=❯\s)(.*)/g;
+                const selected = (current.match(regex) ?? [''])[0].trim();
+                if (selected === scrollTarget) {
+                    seen.add(matchingQuestion);
+                    child.stdin.write(Interaction.ENTER);
+                }
+                else {
+                    scrollCount += 1;
+                    child.stdin.write(Interaction.DOWN);
+                }
+            }
+            else {
+                seen.add(matchingQuestion);
+                scrollCount = 0;
+                child.stdin.write(answerString);
+            }
+        };
+        child.stdout.on('data', (data) => handleData(data, 'stdout'));
+        child.stderr.on('data', (data) => handleData(data, 'stderr'));
+        child.on('close', (code) => {
+            debug(`child process exited with code ${code}`);
+            child.stdin.end();
+            const result = {
+                code,
+                stdout: stripAnsi(output.stdout.join('\n')),
+                stderr: stripAnsi(output.stderr.join('\n')),
+                duration: hrtimeToMillisDuration(process.hrtime(startTime)),
+            };
+            if ((0, ts_types_1.isNumber)(options.ensureExitCode) && code !== options.ensureExitCode) {
+                reject(getExitCodeError(command, options.ensureExitCode, {
+                    stdout: result.stdout,
+                    stderr: result.stderr,
+                    code: result.code,
+                }));
+            }
+            resolve(result);
+        });
+    });
+}
+exports.execInteractiveCmd = execInteractiveCmd;
 //# sourceMappingURL=execCmd.js.map

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": "2.4.3",
+  "version": "2.5.1",
   "author": "Salesforce",
   "license": "BSD-3-Clause",
   "main": "lib/index.js",