@testrigor/testrigor-cli 0.0.51-beta → 1.0.0

package/dist/commands/test-suite/validate-syntax.d.ts

@@ -0,0 +1,20 @@
+import { CommandBase } from "../../command-base";
+export default class ValidateSyntax extends CommandBase<typeof ValidateSyntax> {
+    static description: string;
+    static examples: string[];
+    private TESTRIGOR_API2_URL;
+    static flags: {
+        steps: 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>;
+        "base-url-api": 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>;
+        "explicit-mutations": import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    static args: {
+        testSuiteId: import("@oclif/core/lib/interfaces/parser").Arg<string | undefined, Record<string, unknown>>;
+    };
+    run(): Promise<void>;
+    private resolveStepsToValidate;
+    private reportValidationResults;
+    private callValidateSyntax;
+}

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

@@ -0,0 +1,117 @@
+"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");
+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());
+    }
+}
+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\\""',
+    '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,
+    }),
+};

package/dist/types.d.ts

@@ -51,6 +51,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/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.0.51-beta",
+  "version": "1.0.0",
   "commands": {
     "authenticate": {
       "id": "authenticate",
@@ -275,6 +275,103 @@
           "required": false
         }
       }
+    },
+    "test-suite:validate-syntax": {
+      "id": "test-suite:validate-syntax",
+      "description": "Validate step syntax against a test suite's reusable rules, without running the steps",
+      "strict": true,
+      "pluginName": "@testrigor/testrigor-cli",
+      "pluginAlias": "@testrigor/testrigor-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "hiddenAliases": [],
+      "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}\""
+      ],
+      "flags": {
+        "auth-token": {
+          "name": "auth-token",
+          "type": "option",
+          "description": "Personal authentication token",
+          "required": false,
+          "helpGroup": "GLOBAL",
+          "multiple": false
+        },
+        "token": {
+          "name": "token",
+          "type": "option",
+          "char": "t",
+          "description": "Suite authentication token",
+          "required": false,
+          "helpGroup": "GLOBAL",
+          "multiple": false
+        },
+        "min-port": {
+          "name": "min-port",
+          "type": "option",
+          "description": "Min port for tunnel",
+          "multiple": false,
+          "default": 40000
+        },
+        "max-port": {
+          "name": "max-port",
+          "type": "option",
+          "description": "Max port for tunnel",
+          "multiple": false,
+          "default": 50000
+        },
+        "verbose": {
+          "name": "verbose",
+          "type": "boolean",
+          "description": "Verbose output",
+          "helpGroup": "GLOBAL",
+          "allowNo": false
+        },
+        "steps": {
+          "name": "steps",
+          "type": "option",
+          "description": "Raw step text to validate directly",
+          "multiple": false,
+          "exclusive": [
+            "test-cases-path"
+          ]
+        },
+        "test-cases-path": {
+          "name": "test-cases-path",
+          "type": "option",
+          "description": "Test case files to validate (same glob format as `test-suite run --test-cases-path`)",
+          "multiple": false,
+          "exclusive": [
+            "steps"
+          ]
+        },
+        "base-url-api": {
+          "name": "base-url-api",
+          "type": "option",
+          "description": "Base URL for API2 (e.g., https://api2.testrigor.com)",
+          "multiple": false
+        },
+        "rules-path": {
+          "name": "rules-path",
+          "type": "option",
+          "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`)",
+          "multiple": false
+        },
+        "explicit-mutations": {
+          "name": "explicit-mutations",
+          "type": "boolean",
+          "description": "Validate using only the supplied rules instead of merging them with the suite's saved rules",
+          "allowNo": false
+        }
+      },
+      "args": {
+        "testSuiteId": {
+          "name": "testSuiteId",
+          "description": "The test suite id (optional if set in config)",
+          "required": false
+        }
+      }
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testrigor/testrigor-cli",
-  "version": "0.0.51-beta",
+  "version": "1.0.0",
   "description": "TestRigor Command Line",
   "author": "Ivo Parun Rua @parunruaivo",
   "bin": {
@@ -77,6 +77,9 @@
       "test-suite:run": {
         "description": "Run all tests of a Test Suite"
       },
+      "test-suite:validate-syntax": {
+        "description": "Validate step syntax against a test suite's reusable rules, without running the steps"
+      },
       "authenticate": {
         "description": "Set your testRigor personal authentication token"
       }