@testrigor/testrigor-cli 0.0.51-beta → 1.0.1

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

@@ -0,0 +1,118 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const core_1 = require("@oclif/core");
+const node_fetch_commonjs_1 = tslib_1.__importDefault(require("node-fetch-commonjs"));
+const command_base_1 = require("../../command-base");
+const environments_1 = require("../../config/environments");
+const parser_1 = require("../../util/parser");
+const core_2 = require("@oclif/core");
+class ValidateSyntax extends command_base_1.CommandBase {
+    async run() {
+        const flags = this.flags;
+        const args = this.args;
+        const baseUrlApi = flags["base-url-api"] || environments_1.environments.prod.TESTRIGOR_API_URL;
+        this.TESTRIGOR_API2_URL = `${baseUrlApi.replace(/\/$/, "")}/api/v1`;
+        if (!flags.steps && !flags["test-cases-path"]) {
+            this.error("Provide either --steps or --test-cases-path");
+        }
+        const token = await this.resolveToken();
+        const testSuiteId = await this.resolveTestSuiteId(args.testSuiteId);
+        const casesToValidate = await this.resolveStepsToValidate(flags.steps, flags["test-cases-path"]);
+        if (casesToValidate.length === 0) {
+            this.error("No test case files matched --test-cases-path");
+        }
+        const rules = flags["rules-path"]
+            ? await (0, parser_1.parseRules)(flags["rules-path"])
+            : [];
+        const explicitMutations = flags["explicit-mutations"];
+        await this.reportValidationResults(testSuiteId, token, casesToValidate, rules, explicitMutations);
+    }
+    async resolveStepsToValidate(steps, testCasesPath) {
+        if (steps) {
+            return [{ description: "provided steps", customSteps: steps }];
+        }
+        const testCases = await (0, parser_1.parseTestCases)(testCasesPath);
+        return testCases.map((testCase) => ({
+            description: testCase.description,
+            customSteps: testCase.customSteps,
+        }));
+    }
+    async reportValidationResults(testSuiteId, token, cases, rules, explicitMutations) {
+        let hasAnyInvalidTestCases = false;
+        for (const testCase of cases) {
+            const response = await this.callValidateSyntax(testSuiteId, testCase.customSteps, token, rules, explicitMutations);
+            if (response.data && response.data.length > 0) {
+                const parserErrors = response.data;
+                core_2.ux.info(`${testCase.description}: invalid`);
+                for (const parserError of parserErrors) {
+                    core_2.ux.info(`  ${parserError.command} - ${parserError.errorMessage}`);
+                }
+                hasAnyInvalidTestCases = true;
+            }
+            else {
+                core_2.ux.info(`${testCase.description}: valid`);
+            }
+        }
+        if (hasAnyInvalidTestCases) {
+            this.exit(1);
+        }
+        core_2.ux.info("All provided steps are valid.");
+        this.exit(0);
+    }
+    async callValidateSyntax(testSuiteId, steps, token, rules, explicitMutations) {
+        const body = { steps };
+        if (rules.length > 0) {
+            body.rules = rules;
+        }
+        if (explicitMutations) {
+            body.explicitMutations = explicitMutations;
+        }
+        const response = await (0, node_fetch_commonjs_1.default)(`${this.TESTRIGOR_API2_URL}/apps/${testSuiteId}/validate-syntax`, {
+            method: "POST",
+            body: JSON.stringify(body),
+            headers: {
+                "Content-Type": "application/json",
+                Accept: "application/json",
+                "auth-token": token,
+            },
+        });
+        if (!response.ok) {
+            throw new Error(`Failed to validate syntax: ${response.status} ${response.statusText}`);
+        }
+        return (await response.json());
+    }
+}
+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\\""',
+    'testrigor test-suite validate-syntax <test-suite-id> --test-cases-path "test_cases/**/*.{yaml,txt}"',
+];
+ValidateSyntax.flags = {
+    steps: core_1.Flags.string({
+        description: "Raw step text to validate directly",
+        exclusive: ["test-cases-path"],
+    }),
+    "test-cases-path": core_1.Flags.string({
+        description: "Test case files to validate (same glob format as `test-suite run --test-cases-path`)",
+        exclusive: ["steps"],
+    }),
+    "base-url-api": core_1.Flags.string({
+        description: "Base URL for API2 (e.g., https://api2.testrigor.com)",
+    }),
+    "rules-path": core_1.Flags.string({
+        description: "Ad hoc reusable rules to validate against, for rules not yet saved to this suite (same glob format as `test-suite run --rules-path`)",
+    }),
+    "explicit-mutations": core_1.Flags.boolean({
+        description: "Validate using only the supplied rules instead of merging them with the suite's saved rules",
+        default: false,
+    }),
+};
+ValidateSyntax.args = {
+    testSuiteId: core_1.Args.string({
+        name: "testSuiteId",
+        description: "The test suite id (optional if set in config)",
+        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,4 +1,3 @@
-/// <reference types="node" />
 import { ReadStream } from "fs";
 export type RetestResponse = {
     result: string;
@@ -51,6 +50,13 @@ export type Rule = {
     name: string;
     labels: string[];
 };
+export type ParserError = {
+    command?: string;
+    errorMessage?: string;
+};
+export type ValidateSyntaxApiResponse = Api2Wrapper & {
+    data?: ParserError[];
+};
 export type ChromeExtensionInput = {
     name: string;
     file: string;

package/dist/util/appium.js

@@ -1,12 +1,20 @@
 "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 execFile = util.promisify(childProcess.execFile);
 const PROJECT_ROOT = path.resolve(__dirname, "..", "..");
 const APPIUM_HOME = path.join(PROJECT_ROOT, ".appium");
@@ -36,7 +44,7 @@ function getAppiumEnv() {
 }
 async function checkAppiumInstalled() {
     const appiumBin = getAppiumBin();
-    if (!(await Fs.exists(appiumBin))) {
+    if (!(await fs_1.default.exists(appiumBin))) {
         throw new Error(`Appium binary not found at ${appiumBin}. Try reinstalling testrigor-cli.`);
     }
     try {
@@ -46,7 +54,6 @@ async function checkAppiumInstalled() {
         throw new Error(`Appium binary at ${appiumBin} is not working. Try reinstalling testrigor-cli.`);
     }
 }
-exports.checkAppiumInstalled = checkAppiumInstalled;
 async function getDriverStatus(driverName, requiredVersion) {
     const appiumBin = getAppiumBin();
     try {
@@ -66,7 +73,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 +92,12 @@ 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
+            .split("\n")[0]
+            .replace(/^Command failed:.*?Error:\s*/, "")
+            .trim();
     }
 }
-exports.ensureDriver = ensureDriver;
 function isProcessRunning(pid) {
     try {
         process.kill(pid, 0);
@@ -99,24 +107,22 @@ 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) {
     const url = `http://127.0.0.1:${port}/wd/hub/status`;
     let lastError = "";
@@ -161,29 +167,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);
     }
     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,9 +1,10 @@
 "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 node_fetch_commonjs_1 = tslib_1.__importDefault(require("node-fetch-commonjs"));
 const type_guards_1 = require("./type-guards");
 async function uploadClientCertificate(api2BaseUrl, testSuiteId, token, localFilePath, password) {
     const fileName = path.basename(localFilePath);
@@ -29,4 +30,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,4 +1,4 @@
-import * as FormData from "form-data";
+import FormData from "form-data";
 import { ChromeExtensionInput } from "../types";
 export interface ChromeExtensionFormDataResult {
     form: FormData;

package/dist/util/request-builder.js

@@ -1,14 +1,15 @@
 "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");
+exports.buildChromeExtensionFormData = buildChromeExtensionFormData;
+const tslib_1 = require("tslib");
+const form_data_1 = tslib_1.__importDefault(require("form-data"));
+const fs_1 = tslib_1.__importDefault(require("@supercharge/fs"));
+const path = tslib_1.__importStar(require("path"));
 function toChromeExtensionOverrideItem(input) {
     try {
         return {
             name: input.name,
-            file: Fs.createReadStream(input.file),
+            file: fs_1.default.createReadStream(input.file),
         };
     }
     catch (error) {
@@ -29,7 +30,7 @@ function toChromeExtensionOverridesRequest(extensionInputs) {
  */
 function buildChromeExtensionFormData(chromeExtensions) {
     const { request, streams } = toChromeExtensionOverridesRequest(chromeExtensions);
-    const form = new FormData();
+    const form = new form_data_1.default();
     request.chromeExtensions.forEach((ext, index) => {
         form.append(`chromeExtensions[${index}].name`, ext.name);
         const fileName = path.basename(chromeExtensions[index].file);
@@ -46,4 +47,3 @@ function buildChromeExtensionFormData(chromeExtensions) {
     };
     return { form, cleanup };
 }
-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>;