@testrigor/testrigor-cli 0.0.42-beta

package/README.md

@@ -0,0 +1,33 @@
+## TestRigor Command Line
+
+This is a command line tool for TestRigor. It allows you to run TestRigor tests from the command line.
+
+### Installation
+
+1. Install [Node.js](https://nodejs.org/en/download/) (version 18 or higher)
+2. Install TestRigor CLI: `npm install -g testrigor-cli`
+
+### Examples
+
+1. Basic  `testrigor test-suite run <test-suite-id> --token <token>`
+2. With new URL `testrigor test-suite run <test-suite-id> --token <token> --url <url>`
+3. With file upload `testrigor test-suite run <test-suite-id> --token <token> --file-path <path-to-file>`
+4. With branch `testrigor test-suite run <test-suite-id> --token <token> --branch <branch> --commit <commit>`
+5. With variables `testrigor test-suite run <test-suite-id> --token <token> --variables-path file.json`
+6. Localhost mode `testrigor test-suite run <test-suite-id> --token <token> --localhost`
+7. With test cases `testrigor test-suite run <test-suite-id> --token <token> --test-cases-path test_cases/**/*.{yaml,txt}`
+8. With rules `testrigor test-suite run <test-suite-id> --token <token> --rules-path rules/**/*.yaml`
+9. With settings `testrigor test-suite run <test-suite-id> --token <token> --settings-path settings.yaml` (Can be YAML or JSON)
+10. Run a single test case `testrigor test-suite run <test-suite-id> --token <token> --test-case-uuid <test-case-uuid>`
+11. Run with auto create AI rules enabled `testrigor test-suite run <test-suite-id> --token <token> --test-cases-path test_cases/**/*.{yaml,txt} --auto-create-ai-rules`
+12. Run with explicit mutations enabled `testrigor test-suite run <test-suite-id> --token <token> --test-cases-path test_cases/**/*.{yaml,txt} --explicit-mutations`
+13. With all options `testrigor test-suite run <test-suite-id> --token <token> --url <url> --branch <branch> --commit <commit> --variables-path file.json --localhost --test-cases-path test_cases/**/*.{yaml,txt} --rules-path rules/**/*.{yaml,txt} --auto-create-ai-rules --explicit-mutations`
+14. Save JUnit report to `./junit-report.xml` (works only in sync mode): `testrigor test-suite run <test-suite-id> --token <token> --junit-report-save-path ./report.xml`
+15. With comma-separated labels `testrigor test-suite run <test-suite-id> --token <token> --labels <labels>`
+16. Excluding comma-separated labels `testrigor test-suite run <test-suite-id> --token <token> --excluded-labels <excluded-labels>`
+17. With different WEB and API URLs `testrigor test-suite run <test-suite-id> --token <token> --base-url-web=<base-web-url> --base-url-api=<base_api_url>`
+18. Set the default test suite ID: `testrigor test-suite config --default <test-suite-id>`
+19. Remove the default test suite ID: `testrigor test-suite config --delete`
+20. Show current configuration: `testrigor test-suite config --show`
+21. Authenticate with TestRigor and store credentials (interactive prompt): `testrigor authenticate`
+22. Run with override chrome extensions at runtime (one or more chrome extensions): `test-suite run <test-suite-id> --token <token> --chrome-extension "name=<extension-name> file=<extension-file>" --chrome-extension "name=<extension-name> file=<extension-file>"`

package/bin/dev

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+const path = require('path')
+const project = path.join(__dirname, '..', 'tsconfig.json')
+
+// In dev mode -> use ts-node and dev plugins
+process.env.NODE_ENV = 'development'
+
+require('ts-node').register({project})
+
+// In dev mode, always show stack traces
+oclif.settings.debug = true;
+
+
+// Start the CLI
+oclif.run().then(oclif.flush).catch(oclif.Errors.handle)

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\dev" %*

package/bin/run

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+oclif.run().then(require('@oclif/core/flush')).catch(require('@oclif/core/handle'))

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/dist/command-base.d.ts

@@ -0,0 +1,27 @@
+import { Command, Interfaces } from "@oclif/core";
+import Tunnel from "./util/tunnel";
+export type CommandFlags<T extends typeof Command> = Interfaces.InferredFlags<(typeof CommandBase)["baseFlags"] & T["flags"]>;
+export type Args<T extends typeof Command> = Interfaces.InferredArgs<T["args"]>;
+export declare abstract class CommandBase<T extends typeof Command> extends Command {
+    static baseFlags: {
+        "auth-token": Interfaces.OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        token: Interfaces.OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        "min-port": Interfaces.OptionFlag<number, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        "max-port": Interfaces.OptionFlag<number, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        verbose: Interfaces.BooleanFlag<boolean>;
+    };
+    protected flags: CommandFlags<T>;
+    protected args: Args<T>;
+    protected tunnel: Tunnel;
+    init(): Promise<void>;
+    protected catch(err: Error & {
+        exitCode?: number;
+    }): Promise<any>;
+    protected finally(_: Error | undefined): Promise<any>;
+    protected setTunnel(tunnel: Tunnel): void;
+    protected getTunnel(): Tunnel;
+    private readTokenFromConfig;
+    protected readDefaultTestSuiteId(): Promise<string | null>;
+    protected resolveTestSuiteId(testSuiteId?: string | null): Promise<string>;
+    protected resolveToken(): Promise<string>;
+}

package/dist/command-base.js

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommandBase = void 0;
+const core_1 = require("@oclif/core");
+const config_1 = require("./util/config");
+class CommandBase extends core_1.Command {
+    async init() {
+        await super.init();
+        const { args, flags } = await this.parse({
+            flags: this.ctor.flags,
+            baseFlags: super.ctor.baseFlags,
+            args: this.ctor.args,
+            strict: this.ctor.strict,
+        });
+        this.flags = flags;
+        this.args = args;
+    }
+    async catch(err) {
+        if (this.tunnel) {
+            await this.tunnel.stop();
+        }
+        return super.catch(err);
+    }
+    async finally(_) {
+        if (this.tunnel) {
+            await this.tunnel.stop();
+        }
+        return super.finally(_);
+    }
+    setTunnel(tunnel) {
+        this.tunnel = tunnel;
+    }
+    getTunnel() {
+        return this.tunnel;
+    }
+    async readTokenFromConfig() {
+        return (await (0, config_1.readConfigProperty)("authToken")) || null;
+    }
+    async readDefaultTestSuiteId() {
+        return (await (0, config_1.readConfigProperty)("defaultTestSuiteId")) || null;
+    }
+    async resolveTestSuiteId(testSuiteId) {
+        if (testSuiteId) {
+            return testSuiteId;
+        }
+        const defaultTestSuiteId = await this.readDefaultTestSuiteId();
+        if (defaultTestSuiteId) {
+            return defaultTestSuiteId;
+        }
+        this.error("No test suite ID provided and none found in configuration.\n" +
+            "Please:\n" +
+            "  1. Provide a test suite ID as an argument, or\n" +
+            "  2. Run 'testrigor test-suite config --default YOUR_SUITE_ID' to set a default", { exit: 1 });
+    }
+    async resolveToken() {
+        // Priority 1: TESTRIGOR_API_KEY environment variable (highest priority)
+        if (process.env.TESTRIGOR_API_KEY) {
+            return process.env.TESTRIGOR_API_KEY;
+        }
+        // Priority 2: --authToken flag
+        if (this.flags["auth-token"]) {
+            return this.flags["auth-token"];
+        }
+        // Priority 3: --token flag
+        if (this.flags.token) {
+            return this.flags.token;
+        }
+        // Priority 4: Config yml file
+        const configToken = await this.readTokenFromConfig();
+        if (configToken) {
+            return configToken;
+        }
+        this.error("No authentication token found. Please:\n" +
+            "  1. Set TESTRIGOR_API_KEY environment variable, or\n" +
+            "  2. Use --auth-token TOKEN, or\n" +
+            "  3. Use --token TOKEN, or\n" +
+            "  4. Run 'testrigor authenticate' to store your token", { exit: -1 });
+    }
+}
+exports.CommandBase = CommandBase;
+CommandBase.baseFlags = {
+    "auth-token": core_1.Flags.string({
+        description: "Personal authentication token",
+        required: false,
+        helpGroup: "GLOBAL",
+    }),
+    token: core_1.Flags.string({
+        char: "t",
+        description: "Suite authentication token",
+        required: false,
+        helpGroup: "GLOBAL",
+    }),
+    "min-port": core_1.Flags.integer({
+        description: "Min port for tunnel",
+        default: 40000,
+        min: 40000,
+        max: 50000,
+    }),
+    "max-port": core_1.Flags.integer({
+        description: "Max port for tunnel",
+        default: 50000,
+        min: 40000,
+        max: 50000,
+    }),
+    verbose: core_1.Flags.boolean({
+        description: "Verbose output",
+        default: false,
+        helpGroup: "GLOBAL",
+    }),
+};

package/dist/commands/authenticate.d.ts

@@ -0,0 +1,6 @@
+import { Command } from "@oclif/core";
+export default class Authenticate extends Command {
+    static description: string;
+    static examples: string[];
+    run(): Promise<void>;
+}

package/dist/commands/authenticate.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const core_2 = require("@oclif/core");
+const config_1 = require("../util/config");
+class Authenticate extends core_2.Command {
+    async run() {
+        try {
+            // Load existing config (readConfig handles parse errors gracefully)
+            const config = await (0, config_1.readConfig)();
+            // Handle authentication token
+            let tokenPromptText;
+            if (config.authToken) {
+                tokenPromptText =
+                    "Enter your testRigor API token (press enter to remove)";
+            }
+            else {
+                tokenPromptText =
+                    "Enter your testRigor API token (press enter to skip)";
+            }
+            const token = await core_1.ux.prompt(tokenPromptText, {
+                type: "hide",
+                required: false,
+            });
+            if (!token || token.trim() === "") {
+                if (config.authToken) {
+                    delete config.authToken;
+                    await (0, config_1.writeConfig)(config);
+                    core_1.ux.info("Authentication token removed");
+                }
+                else {
+                    core_1.ux.info("Authentication token setup skipped");
+                }
+            }
+            else {
+                config.authToken = token.trim();
+                await (0, config_1.writeConfig)(config);
+                core_1.ux.info("Authentication token successfully saved");
+                if (config.defaultTestSuiteId) {
+                    core_1.ux.info("You can now use 'testrigor run' to run your default test suite");
+                }
+                else {
+                    core_1.ux.info("Use 'testrigor test-suite config --default TEST_SUITE_ID' to set your default test suite ID, then use 'testrigor run'");
+                }
+            }
+        }
+        catch (error) {
+            core_1.ux.error(`Failed to save configuration: ${error instanceof Error ? error.message : String(error)}`);
+        }
+    }
+}
+exports.default = Authenticate;
+Authenticate.description = "Set your testRigor authentication token";
+Authenticate.examples = [
+    "testrigor authenticate",
+    "Prompts for your API authentication token",
+    "Use 'testrigor test-suite config' to set default test suite ID separately",
+    "Config will be stored in ~/.testrigor/testrigor.yml",
+];

package/dist/commands/test-suite/config.d.ts

@@ -0,0 +1,14 @@
+import { Command } from "@oclif/core";
+export default class Config extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        default: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        delete: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        show: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+    private setDefaultTestSuite;
+    private deleteDefaultTestSuite;
+    private showConfiguration;
+}

package/dist/commands/test-suite/config.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const config_1 = require("../../util/config");
+const allExclusiveFlags = ["default", "delete", "show"];
+function getExclusiveFlags(currentFlag) {
+    return allExclusiveFlags.filter((flag) => flag !== currentFlag);
+}
+class Config extends core_1.Command {
+    async run() {
+        const { flags } = await this.parse(Config);
+        try {
+            if (flags.default) {
+                await this.setDefaultTestSuite(flags.default);
+                return;
+            }
+            if (flags.delete) {
+                await this.deleteDefaultTestSuite();
+                return;
+            }
+            if (flags.show) {
+                await this.showConfiguration();
+                return;
+            }
+            this.error("No action specified.\nFor usage details, run with --help.");
+        }
+        catch (error) {
+            this.error(`Failed to configure test suite: ${error instanceof Error ? error.message : String(error)}`);
+        }
+    }
+    async setDefaultTestSuite(testSuiteId) {
+        const config = await (0, config_1.readConfig)();
+        config.defaultTestSuiteId = testSuiteId.trim();
+        await (0, config_1.writeConfig)(config);
+        core_1.ux.info(`Default test suite ID set to: ${config.defaultTestSuiteId}`);
+        if (config.authToken) {
+            core_1.ux.info("You can now use 'testrigor run' to run your default test suite");
+        }
+        else {
+            core_1.ux.info("Use 'testrigor authenticate' to set your authentication token");
+        }
+    }
+    async deleteDefaultTestSuite() {
+        const config = await (0, config_1.readConfig)();
+        if (!config.defaultTestSuiteId) {
+            core_1.ux.info("No default test suite ID is currently set");
+            return;
+        }
+        delete config.defaultTestSuiteId;
+        await (0, config_1.writeConfig)(config);
+        core_1.ux.info("Default test suite ID removed");
+        if (config.authToken) {
+            core_1.ux.info("Authentication token preserved");
+        }
+    }
+    async showConfiguration() {
+        const config = await (0, config_1.readConfig)();
+        if (Object.keys(config).length === 0) {
+            core_1.ux.info("No configuration found");
+            return;
+        }
+        core_1.ux.info("Current testRigor configuration:");
+        if (config.defaultTestSuiteId) {
+            core_1.ux.info(`  Default test suite ID: ${config.defaultTestSuiteId}`);
+        }
+        else {
+            core_1.ux.info("  Default test suite ID: not set");
+        }
+        if (config.authToken) {
+            core_1.ux.info("  Authentication token: configured");
+        }
+        else {
+            core_1.ux.info("  Authentication token: not set");
+        }
+    }
+}
+exports.default = Config;
+Config.description = "Configure test suite settings and default test suite ID";
+Config.examples = [
+    "testrigor test-suite config --default TEST-SUITE-ID",
+    "testrigor test-suite config --show",
+    "testrigor test-suite config --delete",
+];
+Config.flags = {
+    default: core_1.Flags.string({
+        description: "Set the default test suite ID",
+        exclusive: getExclusiveFlags("default"),
+    }),
+    delete: core_1.Flags.boolean({
+        description: "Remove the default test suite ID",
+        exclusive: getExclusiveFlags("delete"),
+    }),
+    show: core_1.Flags.boolean({
+        description: "Show current configuration",
+        exclusive: getExclusiveFlags("show"),
+    }),
+};

package/dist/commands/test-suite/run.d.ts

@@ -0,0 +1,46 @@
+import { CommandBase } from "../../command-base";
+export default class Run extends CommandBase<typeof Run> {
+    static description: string;
+    static examples: never[];
+    private TESTRIGOR_URL;
+    private TESTRIGOR_API_URL;
+    private TESTRIGOR_API2_URL;
+    static flags: {
+        async: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        branch: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        commit: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        localhost: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        url: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        "file-path": import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        "junit-report-save-path": import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        "variables-path": import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        "test-cases-path": import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        "rules-path": import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        "settings-path": import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        "test-case-uuid": import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        "auto-create-ai-rules": import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        "explicit-mutations": import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        labels: import("@oclif/core/lib/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        "excluded-labels": import("@oclif/core/lib/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        "base-url-web": import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        "base-url-api": import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        "chrome-extension": import("@oclif/core/lib/interfaces").OptionFlag<{
+            name: string;
+            file: string;
+        } | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    static args: {
+        testSuiteId: import("@oclif/core/lib/interfaces/parser").Arg<string | undefined, Record<string, unknown>>;
+    };
+    private initializeUrls;
+    run(): Promise<void>;
+    private fetchStatus;
+    private getStatusApiEndpoint;
+    private callRetest;
+    private uploadFile;
+    private waitForTestSuiteToBeCreated;
+    private waitForTestSuiteToFinish;
+    private fetchTestSuiteStatus;
+    private retryForValidStatus;
+    private startAndWaitForJunitReportToFinish;
+}