@testrigor/testrigor-cli 1.0.0 → 2.0.0

package/dist/commands/test-suite/validate-syntax.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const core_1 = require("@oclif/core");
-const node_fetch_commonjs_1 = require("node-fetch-commonjs");
 const command_base_1 = require("../../command-base");
 const environments_1 = require("../../config/environments");
 const parser_1 = require("../../util/parser");
@@ -67,7 +66,7 @@ class ValidateSyntax extends command_base_1.CommandBase {
         if (explicitMutations) {
             body.explicitMutations = explicitMutations;
         }
-        const response = await (0, node_fetch_commonjs_1.default)(`${this.TESTRIGOR_API2_URL}/apps/${testSuiteId}/validate-syntax`, {
+        const response = await fetch(`${this.TESTRIGOR_API2_URL}/apps/${testSuiteId}/validate-syntax`, {
             method: "POST",
             body: JSON.stringify(body),
             headers: {
@@ -82,7 +81,6 @@ class ValidateSyntax extends command_base_1.CommandBase {
         return (await response.json());
     }
 }
-exports.default = ValidateSyntax;
 ValidateSyntax.description = "Validate step syntax against a test suite's reusable rules, without running the steps";
 ValidateSyntax.examples = [
     'testrigor test-suite validate-syntax <test-suite-id> --steps "click \\"Login\\""',
@@ -115,3 +113,4 @@ ValidateSyntax.args = {
         required: false,
     }),
 };
+exports.default = ValidateSyntax;

package/dist/flags/chrome-extension.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ChromeExtensionFlag = void 0;
+const tslib_1 = require("tslib");
 const core_1 = require("@oclif/core");
-const fs = require("fs");
-const path = require("path");
+const fs = tslib_1.__importStar(require("fs"));
+const path = tslib_1.__importStar(require("path"));
 const utils_1 = require("../util/utils");
 let totalChromeExtensionSize = 0;
 exports.ChromeExtensionFlag = core_1.Flags.custom({

package/dist/types.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-import { ReadStream } from "fs";
 export type RetestResponse = {
     result: string;
     msg: string;
@@ -62,16 +60,6 @@ export type ChromeExtensionInput = {
     name: string;
     file: string;
 };
-/**
- * Represents a single chrome extension override with its binary file.
- */
-export type ChromeExtensionOverrideItem = {
-    name: string;
-    file: ReadStream;
-};
-export type ChromeExtensionOverridesRequest = {
-    chromeExtensions: ChromeExtensionOverrideItem[];
-};
 export type StoredValueFileInput = {
     name: string;
     file: string;

package/dist/util/appium.js

@@ -1,27 +1,39 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.stopAppium = exports.startAppium = exports.getRunningAppiumPid = exports.isProcessRunning = exports.ensureDriver = exports.getDriverStatus = exports.checkAppiumInstalled = exports.PID_FILE = exports.PID_DIR = exports.REQUIRED_DRIVERS = exports.DEFAULT_BASE_PATH = exports.DEFAULT_PORT = void 0;
-const childProcess = require("child_process");
-const fs = require("fs");
-const util = require("util");
-const path = require("path");
-const os = require("os");
-const Fs = require("@supercharge/fs");
+exports.PID_FILE = exports.PID_DIR = exports.REQUIRED_DRIVERS = exports.DEFAULT_BASE_PATH = exports.DEFAULT_PORT = void 0;
+exports.checkAppiumInstalled = checkAppiumInstalled;
+exports.getDriverStatus = getDriverStatus;
+exports.ensureDriver = ensureDriver;
+exports.isProcessRunning = isProcessRunning;
+exports.getRunningAppiumPid = getRunningAppiumPid;
+exports.startAppium = startAppium;
+exports.stopAppium = stopAppium;
+const tslib_1 = require("tslib");
+const childProcess = tslib_1.__importStar(require("child_process"));
+const fs = tslib_1.__importStar(require("fs"));
+const util = tslib_1.__importStar(require("util"));
+const path = tslib_1.__importStar(require("path"));
+const os = tslib_1.__importStar(require("os"));
+const fs_1 = tslib_1.__importDefault(require("@supercharge/fs"));
+const utils_1 = require("./utils");
 const execFile = util.promisify(childProcess.execFile);
 const PROJECT_ROOT = path.resolve(__dirname, "..", "..");
-const APPIUM_HOME = path.join(PROJECT_ROOT, ".appium");
 const DEFAULT_PORT = 4723;
 exports.DEFAULT_PORT = DEFAULT_PORT;
 const DEFAULT_BASE_PATH = "/wd/hub";
 exports.DEFAULT_BASE_PATH = DEFAULT_BASE_PATH;
-const PID_DIR = path.join(os.homedir(), ".testrigor");
+const PID_DIR = (0, utils_1.getHomeDir)();
 exports.PID_DIR = PID_DIR;
 const PID_FILE = path.join(PID_DIR, "appium.pid");
 exports.PID_FILE = PID_FILE;
 const LOG_FILE = path.join(os.tmpdir(), "testrigor-appium.log");
+// Appium writes its drivers here (hundreds of MB). It must live under the
+// user's home, not the install directory: a global install is often
+// root-owned, and `npm update -g` would wipe the drivers on every upgrade.
+const APPIUM_HOME = process.env.APPIUM_HOME || path.join((0, utils_1.getHomeDir)(), "appium-home");
 const REQUIRED_DRIVERS = [
     { name: "uiautomator2", version: "4.2.3" },
-    { name: "xcuitest", version: "9.2.4" },
+    { name: "xcuitest", version: "10.43.1" },
 ];
 exports.REQUIRED_DRIVERS = REQUIRED_DRIVERS;
 function getAppiumBin() {
@@ -34,19 +46,36 @@ function getAppiumEnv() {
         CHROMELABS_URL: "https://googlechromelabs.github.io",
     };
 }
+/**
+ * Appium refuses to start unless APPIUM_HOME already exists, so create it
+ * before any invocation and surface a permission problem as itself rather
+ * than as a generic "appium is broken".
+ */
+async function ensureAppiumHome() {
+    try {
+        await fs_1.default.ensureDir(APPIUM_HOME);
+    }
+    catch (error) {
+        throw new Error(`Cannot create the mobile server directory at ${APPIUM_HOME}: ` +
+            `${error instanceof Error ? error.message : String(error)}\n` +
+            "Check that you own that directory, or point APPIUM_HOME at a writable one.");
+    }
+}
 async function checkAppiumInstalled() {
     const appiumBin = getAppiumBin();
-    if (!(await Fs.exists(appiumBin))) {
-        throw new Error(`Appium binary not found at ${appiumBin}. Try reinstalling testrigor-cli.`);
+    if (!(await fs_1.default.exists(appiumBin))) {
+        throw new Error(`Appium binary not found at ${appiumBin}. ` +
+            "Reinstall the CLI with: npm install -g @testrigor/testrigor-cli");
     }
+    await ensureAppiumHome();
     try {
         await execFile(appiumBin, ["--version"], { env: getAppiumEnv() });
     }
-    catch {
-        throw new Error(`Appium binary at ${appiumBin} is not working. Try reinstalling testrigor-cli.`);
+    catch (error) {
+        const detail = error instanceof Error ? error.message : String(error);
+        throw new Error(`Appium binary at ${appiumBin} failed to run (APPIUM_HOME=${APPIUM_HOME}).\n${detail}`);
     }
 }
-exports.checkAppiumInstalled = checkAppiumInstalled;
 async function getDriverStatus(driverName, requiredVersion) {
     const appiumBin = getAppiumBin();
     try {
@@ -66,7 +95,6 @@ async function getDriverStatus(driverName, requiredVersion) {
         return { installed: false, upToDate: false };
     }
 }
-exports.getDriverStatus = getDriverStatus;
 async function ensureDriver(driverName, requiredVersion) {
     const appiumBin = getAppiumBin();
     const env = getAppiumEnv();
@@ -86,10 +114,9 @@ async function ensureDriver(driverName, requiredVersion) {
     }
     catch (error) {
         const raw = error instanceof Error ? error.message : String(error);
-        return raw.split("\n")[0].replace(/^Command failed:.*?Error:\s*/, "").trim();
+        return raw.replace(/^Command failed:.*?Error:\s*/, "").trim();
     }
 }
-exports.ensureDriver = ensureDriver;
 function isProcessRunning(pid) {
     try {
         process.kill(pid, 0);
@@ -99,25 +126,52 @@ function isProcessRunning(pid) {
         return false;
     }
 }
-exports.isProcessRunning = isProcessRunning;
 function killSafe(pid) {
     if (isProcessRunning(pid)) {
         process.kill(pid);
     }
 }
 async function getRunningAppiumPid() {
-    if (!(await Fs.exists(PID_FILE))) {
+    if (!(await fs_1.default.exists(PID_FILE))) {
         return null;
     }
-    const existingPid = Number((await Fs.content(PID_FILE)).trim());
+    const existingPid = Number((await fs_1.default.content(PID_FILE)).trim());
     if (isProcessRunning(existingPid)) {
         return existingPid;
     }
-    await Fs.removeFile(PID_FILE);
+    await fs_1.default.removeFile(PID_FILE);
     return null;
 }
-exports.getRunningAppiumPid = getRunningAppiumPid;
-async function healthCheck(port, retries = 15, interval = 2000) {
+/**
+ * Last lines of the Appium log, so a server that dies on startup reports the
+ * reason instead of just a health-check timeout. The log is shared across
+ * invocations, so only bytes written after `fromOffset` are considered.
+ */
+function readLogTail(fromOffset, lines = 20) {
+    let fd;
+    try {
+        fd = fs.openSync(LOG_FILE, "r");
+        const size = fs.fstatSync(fd).size;
+        if (size <= fromOffset)
+            return "";
+        const maxTailBytes = 64 * 1024;
+        const start = Math.max(fromOffset, size - maxTailBytes);
+        const buffer = Buffer.alloc(size - start);
+        fs.readSync(fd, buffer, 0, buffer.length, start);
+        const content = buffer.toString("utf8").trimEnd();
+        if (!content)
+            return "";
+        return content.split("\n").slice(-lines).join("\n");
+    }
+    catch {
+        return "";
+    }
+    finally {
+        if (fd !== undefined)
+            fs.closeSync(fd);
+    }
+}
+async function healthCheck(port, logOffset, retries = 15, interval = 2000) {
     const url = `http://127.0.0.1:${port}/wd/hub/status`;
     let lastError = "";
     for (let i = 0; i < retries; i++) {
@@ -133,7 +187,11 @@ async function healthCheck(port, retries = 15, interval = 2000) {
         }
         await new Promise((r) => setTimeout(r, interval));
     }
-    throw new Error(`Mobile server not ready after ${retries} attempts: ${lastError}`);
+    const tail = readLogTail(logOffset);
+    throw new Error(`Mobile server not ready after ${retries} attempts: ${lastError}` +
+        (tail
+            ? `\nLast lines of ${LOG_FILE}:\n${tail}`
+            : `\nSee ${LOG_FILE} for details.`));
 }
 async function startAppium(port = DEFAULT_PORT, logLevel = "debug") {
     const existingPid = await getRunningAppiumPid();
@@ -141,7 +199,9 @@ async function startAppium(port = DEFAULT_PORT, logLevel = "debug") {
         return { pid: existingPid, alreadyRunning: true };
     }
     const appiumBin = getAppiumBin();
+    await ensureAppiumHome();
     const logStream = fs.openSync(LOG_FILE, "a");
+    const logOffset = fs.fstatSync(logStream).size;
     const appiumProcess = childProcess.spawn(appiumBin, [
         "--port",
         String(port),
@@ -161,29 +221,27 @@ async function startAppium(port = DEFAULT_PORT, logLevel = "debug") {
         throw new Error("Failed to start Appium server: no PID returned");
     }
     appiumProcess.unref();
-    await Fs.ensureDir(PID_DIR);
-    await Fs.writeFile(PID_FILE, String(pid));
+    await fs_1.default.ensureDir(PID_DIR);
+    await fs_1.default.writeFile(PID_FILE, String(pid));
     try {
-        await healthCheck(port);
+        await healthCheck(port, logOffset);
     }
     catch (err) {
         killSafe(pid);
-        await Fs.removeFile(PID_FILE);
+        await fs_1.default.removeFile(PID_FILE);
         throw err;
     }
     return { pid, alreadyRunning: false };
 }
-exports.startAppium = startAppium;
 async function stopAppium() {
-    if (!(await Fs.exists(PID_FILE))) {
+    if (!(await fs_1.default.exists(PID_FILE))) {
         return null;
     }
-    const pidContent = (await Fs.content(PID_FILE)).trim();
+    const pidContent = (await fs_1.default.content(PID_FILE)).trim();
     const pid = Number(pidContent);
     if (!isNaN(pid) && isProcessRunning(pid)) {
         process.kill(pid, "SIGTERM");
     }
-    await Fs.removeFile(PID_FILE);
+    await fs_1.default.removeFile(PID_FILE);
     return pid;
 }
-exports.stopAppium = stopAppium;

package/dist/util/certificate-uploader.js

@@ -1,14 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.uploadClientCertificate = void 0;
-const fs = require("fs");
-const path = require("path");
-const node_fetch_commonjs_1 = require("node-fetch-commonjs");
+exports.uploadClientCertificate = uploadClientCertificate;
+const tslib_1 = require("tslib");
+const fs = tslib_1.__importStar(require("fs"));
+const path = tslib_1.__importStar(require("path"));
 const type_guards_1 = require("./type-guards");
 async function uploadClientCertificate(api2BaseUrl, testSuiteId, token, localFilePath, password) {
     const fileName = path.basename(localFilePath);
     const certBase64 = fs.readFileSync(localFilePath).toString("base64");
-    const response = await (0, node_fetch_commonjs_1.default)(`${api2BaseUrl}/apps/${testSuiteId}/test_data/global_variables/client_certificate`, {
+    const response = await fetch(`${api2BaseUrl}/apps/${testSuiteId}/test_data/global_variables/client_certificate`, {
         method: "POST",
         body: JSON.stringify({ fileName, certBase64, password }),
         headers: {
@@ -29,4 +29,3 @@ async function uploadClientCertificate(api2BaseUrl, testSuiteId, token, localFil
         info: responseJson.data.info,
     };
 }
-exports.uploadClientCertificate = uploadClientCertificate;

package/dist/util/config.js

@@ -1,9 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deleteConfigProperty = exports.updateConfigProperty = exports.readConfigProperty = exports.writeConfig = exports.readConfig = exports.getConfigPath = void 0;
+exports.getConfigPath = getConfigPath;
+exports.readConfig = readConfig;
+exports.writeConfig = writeConfig;
+exports.readConfigProperty = readConfigProperty;
+exports.updateConfigProperty = updateConfigProperty;
+exports.deleteConfigProperty = deleteConfigProperty;
+const tslib_1 = require("tslib");
 const core_1 = require("@oclif/core");
-const Fs = require("@supercharge/fs");
-const path = require("path");
+const fs_1 = tslib_1.__importDefault(require("@supercharge/fs"));
+const path = tslib_1.__importStar(require("path"));
 const yaml_1 = require("yaml");
 const utils_1 = require("./utils");
 /**
@@ -14,17 +20,16 @@ function getConfigPath() {
     const configPath = path.join(homeDir, "testrigor.yml");
     return { homeDir, configPath };
 }
-exports.getConfigPath = getConfigPath;
 /**
  * Read testRigor configuration from ~/.testrigor/testrigor.yml
  */
 async function readConfig() {
     const { configPath } = getConfigPath();
-    if (!(await Fs.pathExists(configPath))) {
+    if (!(await fs_1.default.pathExists(configPath))) {
         return {};
     }
     try {
-        const content = await Fs.content(configPath);
+        const content = await fs_1.default.content(configPath);
         return (0, yaml_1.parse)(content.toString()) || {};
     }
     catch (error) {
@@ -34,26 +39,24 @@ async function readConfig() {
         return {};
     }
 }
-exports.readConfig = readConfig;
 /**
  * Write testRigor configuration to ~/.testrigor/testrigor.yml
  */
 async function writeConfig(config) {
     const { homeDir, configPath } = getConfigPath();
     // Ensure the config directory exists
-    if (!(await Fs.pathExists(homeDir))) {
-        await Fs.ensureDir(homeDir);
+    if (!(await fs_1.default.pathExists(homeDir))) {
+        await fs_1.default.ensureDir(homeDir);
     }
     // Avoid writing empty objects as "{}"
     const configContent = Object.keys(config).length > 0 ? (0, yaml_1.stringify)(config) : "";
     if (configContent.trim() === "") {
-        await Fs.writeFile(configPath, "");
+        await fs_1.default.writeFile(configPath, "");
     }
     else {
-        await Fs.writeFile(configPath, configContent);
+        await fs_1.default.writeFile(configPath, configContent);
     }
 }
-exports.writeConfig = writeConfig;
 /**
  * Read a specific property from testRigor configuration
  */
@@ -61,7 +64,6 @@ async function readConfigProperty(property) {
     const config = await readConfig();
     return config[property] || null;
 }
-exports.readConfigProperty = readConfigProperty;
 /**
  * Update a specific property in testRigor configuration
  */
@@ -75,7 +77,6 @@ async function updateConfigProperty(property, value) {
     }
     await writeConfig(config);
 }
-exports.updateConfigProperty = updateConfigProperty;
 /**
  * Delete a specific property from testRigor configuration
  */
@@ -84,4 +85,3 @@ async function deleteConfigProperty(property) {
     delete config[property];
     await writeConfig(config);
 }
-exports.deleteConfigProperty = deleteConfigProperty;

package/dist/util/parser.js

@@ -1,7 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseSettings = exports.parseRules = exports.parseTestCases = void 0;
-const Fs = require("@supercharge/fs");
+exports.parseTestCases = parseTestCases;
+exports.parseRules = parseRules;
+exports.parseSettings = parseSettings;
+const tslib_1 = require("tslib");
+const fs_1 = tslib_1.__importDefault(require("@supercharge/fs"));
 const glob_1 = require("glob");
 const yaml_1 = require("yaml");
 const utils_1 = require("./utils");
@@ -10,7 +13,7 @@ async function parseTestCases(path) {
     const files = await (0, glob_1.glob)(path, { withFileTypes: true });
     for (const file of files) {
         if (file.isFile()) {
-            const content = await Fs.content(file.fullpath());
+            const content = await fs_1.default.content(file.fullpath());
             if ((0, utils_1.isYamlFile)(file.name)) {
                 const json = (0, yaml_1.parse)(content.toString());
                 const testCase = {
@@ -39,13 +42,12 @@ async function parseTestCases(path) {
     }
     return result;
 }
-exports.parseTestCases = parseTestCases;
 async function parseRules(path) {
     const result = [];
     const files = await (0, glob_1.glob)(path, { withFileTypes: true });
     for (const file of files) {
         if (file.isFile()) {
-            const content = await Fs.content(file.fullpath());
+            const content = await fs_1.default.content(file.fullpath());
             if ((0, utils_1.isYamlFile)(file.name)) {
                 const json = (0, yaml_1.parse)(content.toString());
                 const ruleName = (0, utils_1.removeExtension)(file.name);
@@ -69,9 +71,8 @@ async function parseRules(path) {
     }
     return result;
 }
-exports.parseRules = parseRules;
 async function parseSettings(path) {
-    const content = await Fs.content(path);
+    const content = await fs_1.default.content(path);
     if ((0, utils_1.isYamlFile)(path)) {
         return (0, yaml_1.parse)(content.toString());
     }
@@ -80,4 +81,3 @@ async function parseSettings(path) {
     }
     return {};
 }
-exports.parseSettings = parseSettings;

package/dist/util/request-builder.d.ts

@@ -1,11 +1,5 @@
-import * as FormData from "form-data";
 import { ChromeExtensionInput } from "../types";
-export interface ChromeExtensionFormDataResult {
-    form: FormData;
-    cleanup: () => void;
-}
 /**
- * Converts ChromeExtensionInput[] -> ChromeExtensionOverridesRequest -> FormData
- * Returns both the FormData and a cleanup function to close streams.
+ * Builds the multipart body for the chrome extension overrides of a retest.
  */
-export declare function buildChromeExtensionFormData(chromeExtensions: ChromeExtensionInput[]): ChromeExtensionFormDataResult;
+export declare function buildChromeExtensionFormData(chromeExtensions: ChromeExtensionInput[]): Promise<FormData>;

package/dist/util/request-builder.js

@@ -1,49 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildChromeExtensionFormData = void 0;
-const FormData = require("form-data");
-const Fs = require("@supercharge/fs");
-const path = require("path");
-function toChromeExtensionOverrideItem(input) {
+exports.buildChromeExtensionFormData = buildChromeExtensionFormData;
+const tslib_1 = require("tslib");
+const fs_1 = require("fs");
+const path = tslib_1.__importStar(require("path"));
+async function readChromeExtension(input) {
     try {
-        return {
-            name: input.name,
-            file: Fs.createReadStream(input.file),
-        };
+        return await (0, fs_1.openAsBlob)(input.file);
     }
     catch (error) {
         throw new Error(`Failed to read chrome extension file "${input.file}": ${error instanceof Error ? error.message : String(error)}`);
     }
 }
-function toChromeExtensionOverridesRequest(extensionInputs) {
-    const chromeExtensions = extensionInputs.map(toChromeExtensionOverrideItem);
-    const streams = chromeExtensions.map((item) => item.file);
-    return {
-        request: { chromeExtensions },
-        streams,
-    };
-}
 /**
- * Converts ChromeExtensionInput[] -> ChromeExtensionOverridesRequest -> FormData
- * Returns both the FormData and a cleanup function to close streams.
+ * Builds the multipart body for the chrome extension overrides of a retest.
  */
-function buildChromeExtensionFormData(chromeExtensions) {
-    const { request, streams } = toChromeExtensionOverridesRequest(chromeExtensions);
+async function buildChromeExtensionFormData(chromeExtensions) {
+    const files = await Promise.all(chromeExtensions.map(readChromeExtension));
     const form = new FormData();
-    request.chromeExtensions.forEach((ext, index) => {
+    chromeExtensions.forEach((ext, index) => {
         form.append(`chromeExtensions[${index}].name`, ext.name);
-        const fileName = path.basename(chromeExtensions[index].file);
-        form.append(`chromeExtensions[${index}].file`, ext.file, {
-            filename: fileName,
-        });
+        form.append(`chromeExtensions[${index}].file`, files[index], path.basename(ext.file));
     });
-    const cleanup = () => {
-        streams.forEach((stream) => {
-            if (!stream.destroyed) {
-                stream.destroy();
-            }
-        });
-    };
-    return { form, cleanup };
+    return form;
 }
-exports.buildChromeExtensionFormData = buildChromeExtensionFormData;

package/dist/util/trtc.d.ts

@@ -1 +1,3 @@
+export declare function extractZip(dir: string, stream: NodeJS.ReadableStream): Promise<string>;
+export declare function extractTar(dir: string, stream: NodeJS.ReadableStream): Promise<string>;
 export declare function download(dir: string): Promise<string>;