@testrigor/testrigor-cli 0.0.42-beta

package/dist/util/utils.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidUrl = exports.extractRunIdFromDetailsUrl = exports.extractUrlWithoutQueryParams = exports.removeExtension = exports.getExtensionLength = exports.isValidFileExtensionToUpload = exports.isJsonFile = exports.isTextFile = exports.isYamlFile = exports.rendererToUse = exports.isRunningOnCi = exports.pathExists = exports.getHomeDir = exports.createDirectory = exports.UPLOAD_TIMEOUT_MS = exports.MAX_FILE_SIZE_100_MB = void 0;
+const Fs = require("@supercharge/fs");
+const path = require("path");
+// eslint-disable-next-line @typescript-eslint/no-var-requires, no-undef
+const isCi = require("is-ci");
+const YAML_EXTENSION = ".yaml";
+const YML_EXTENSION = ".yml";
+const TXT_EXTENSION = ".txt";
+const JSON_EXTENSION = ".json";
+const FILE_UPLOAD_EXTENSIONS = [".zip", ".exe", ".msi", ".apk", ".aab", ".ipa"];
+const DIRECTORY_NAME = ".testrigor";
+const TESTRIGOR_CLI_HOME = process.env.TESTRIGOR_CLI_HOME || path.join(Fs.homeDir(), DIRECTORY_NAME);
+const NOT_AVAILABLE_TEST_SUITE_RUN = "not-available";
+exports.MAX_FILE_SIZE_100_MB = 100 * 1024 * 1024;
+exports.UPLOAD_TIMEOUT_MS = 10 * 60 * 1000; // 10 minutes for large file uploads
+async function createDirectory(name) {
+    const directoryPath = path.join(TESTRIGOR_CLI_HOME, name);
+    await Fs.ensureDir(directoryPath);
+    return directoryPath;
+}
+exports.createDirectory = createDirectory;
+function getHomeDir() {
+    return TESTRIGOR_CLI_HOME;
+}
+exports.getHomeDir = getHomeDir;
+async function pathExists(name) {
+    if (!name) {
+        return false;
+    }
+    return Fs.pathExists(path.join(TESTRIGOR_CLI_HOME, name));
+}
+exports.pathExists = pathExists;
+function isRunningOnCi() {
+    return isCi;
+}
+exports.isRunningOnCi = isRunningOnCi;
+function rendererToUse() {
+    return isRunningOnCi() ? "verbose" : "default";
+}
+exports.rendererToUse = rendererToUse;
+function isYamlFile(fileName) {
+    return fileName.endsWith(YAML_EXTENSION) || fileName.endsWith(YML_EXTENSION);
+}
+exports.isYamlFile = isYamlFile;
+function isTextFile(fileName) {
+    return fileName.endsWith(TXT_EXTENSION);
+}
+exports.isTextFile = isTextFile;
+function isJsonFile(fileName) {
+    return fileName.endsWith(JSON_EXTENSION);
+}
+exports.isJsonFile = isJsonFile;
+function isValidFileExtensionToUpload(fileName) {
+    return FILE_UPLOAD_EXTENSIONS.some((ext) => fileName.endsWith(ext));
+}
+exports.isValidFileExtensionToUpload = isValidFileExtensionToUpload;
+function getExtensionLength(fileName) {
+    if (fileName.endsWith(YAML_EXTENSION)) {
+        return 5;
+    }
+    if (fileName.endsWith(YML_EXTENSION) || fileName.endsWith(TXT_EXTENSION)) {
+        return 4;
+    }
+    return 0;
+}
+exports.getExtensionLength = getExtensionLength;
+function removeExtension(fileName) {
+    return fileName.slice(0, -getExtensionLength(fileName));
+}
+exports.removeExtension = removeExtension;
+function extractUrlWithoutQueryParams(urlString) {
+    const url = new URL(urlString);
+    url.search = "";
+    return url.toString();
+}
+exports.extractUrlWithoutQueryParams = extractUrlWithoutQueryParams;
+function extractRunIdFromDetailsUrl(detailsUrl) {
+    if (!detailsUrl) {
+        return NOT_AVAILABLE_TEST_SUITE_RUN;
+    }
+    const parts = detailsUrl.split("/");
+    return parts[parts.length - 1];
+}
+exports.extractRunIdFromDetailsUrl = extractRunIdFromDetailsUrl;
+function isValidUrl(url) {
+    try {
+        // Basic URL validation - accepts http, https, localhost, self, and supports ports
+        const urlPattern = /^(https?:\/\/)?([\w.-]+|localhost|self)(:\d+)?(\/[^\s]*)?$/i;
+        return urlPattern.test(url);
+    }
+    catch {
+        return false;
+    }
+}
+exports.isValidUrl = isValidUrl;

package/oclif.manifest.json

@@ -0,0 +1,265 @@
+{
+  "version": "0.0.42-beta",
+  "commands": {
+    "authenticate": {
+      "id": "authenticate",
+      "description": "Set your testRigor authentication token",
+      "strict": true,
+      "pluginName": "@testrigor/testrigor-cli",
+      "pluginAlias": "@testrigor/testrigor-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "hiddenAliases": [],
+      "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"
+      ],
+      "flags": {},
+      "args": {}
+    },
+    "test-suite:config": {
+      "id": "test-suite:config",
+      "description": "Configure test suite settings and default test suite ID",
+      "strict": true,
+      "pluginName": "@testrigor/testrigor-cli",
+      "pluginAlias": "@testrigor/testrigor-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "hiddenAliases": [],
+      "examples": [
+        "testrigor test-suite config --default TEST-SUITE-ID",
+        "testrigor test-suite config --show",
+        "testrigor test-suite config --delete"
+      ],
+      "flags": {
+        "default": {
+          "name": "default",
+          "type": "option",
+          "description": "Set the default test suite ID",
+          "multiple": false,
+          "exclusive": [
+            "delete",
+            "show"
+          ]
+        },
+        "delete": {
+          "name": "delete",
+          "type": "boolean",
+          "description": "Remove the default test suite ID",
+          "allowNo": false,
+          "exclusive": [
+            "default",
+            "show"
+          ]
+        },
+        "show": {
+          "name": "show",
+          "type": "boolean",
+          "description": "Show current configuration",
+          "allowNo": false,
+          "exclusive": [
+            "default",
+            "delete"
+          ]
+        }
+      },
+      "args": {}
+    },
+    "test-suite:run": {
+      "id": "test-suite:run",
+      "description": "Run all tests of a Test Suite",
+      "strict": true,
+      "pluginName": "@testrigor/testrigor-cli",
+      "pluginAlias": "@testrigor/testrigor-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "hiddenAliases": [],
+      "examples": [],
+      "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
+        },
+        "async": {
+          "name": "async",
+          "type": "boolean",
+          "char": "w",
+          "description": "Don't wait for the test suite to finish",
+          "allowNo": false,
+          "aliases": [
+            "nowait"
+          ]
+        },
+        "branch": {
+          "name": "branch",
+          "type": "option",
+          "description": "The branch name",
+          "multiple": false,
+          "dependsOn": [
+            "commit"
+          ]
+        },
+        "commit": {
+          "name": "commit",
+          "type": "option",
+          "description": "The commit",
+          "multiple": false,
+          "dependsOn": [
+            "branch"
+          ]
+        },
+        "localhost": {
+          "name": "localhost",
+          "type": "boolean",
+          "description": "Localhost run",
+          "allowNo": false,
+          "dependsOn": [
+            "url"
+          ],
+          "aliases": [
+            "tunnel"
+          ]
+        },
+        "url": {
+          "name": "url",
+          "type": "option",
+          "description": "The url",
+          "multiple": false
+        },
+        "file-path": {
+          "name": "file-path",
+          "type": "option",
+          "description": "Path to the file stored locally. It will upload the new file to be used. File type should be according to the file type accepted for the Test Suite type of testing. If the parameter --url is used, this parameter will be ignored.",
+          "multiple": false
+        },
+        "junit-report-save-path": {
+          "name": "junit-report-save-path",
+          "type": "option",
+          "description": "JUnit report save path",
+          "multiple": false
+        },
+        "variables-path": {
+          "name": "variables-path",
+          "type": "option",
+          "description": "Variables path",
+          "multiple": false
+        },
+        "test-cases-path": {
+          "name": "test-cases-path",
+          "type": "option",
+          "description": "Test cases files",
+          "multiple": false
+        },
+        "rules-path": {
+          "name": "rules-path",
+          "type": "option",
+          "description": "Rules path",
+          "multiple": false
+        },
+        "settings-path": {
+          "name": "settings-path",
+          "type": "option",
+          "description": "Settings path",
+          "multiple": false
+        },
+        "test-case-uuid": {
+          "name": "test-case-uuid",
+          "type": "option",
+          "description": "Test case uuid",
+          "multiple": false,
+          "dependsOn": [
+            "url"
+          ]
+        },
+        "auto-create-ai-rules": {
+          "name": "auto-create-ai-rules",
+          "type": "boolean",
+          "description": "Enable auto create AI based rules",
+          "allowNo": false
+        },
+        "explicit-mutations": {
+          "name": "explicit-mutations",
+          "type": "boolean",
+          "description": "In cases where you are always using mutations, such as storing test cases in your own repository, and you always send us the set of test cases you have through our API you should send \"--explicit-mutations\"",
+          "allowNo": false
+        },
+        "labels": {
+          "name": "labels",
+          "type": "option",
+          "description": "Run tests of specific labels",
+          "multiple": true
+        },
+        "excluded-labels": {
+          "name": "excluded-labels",
+          "type": "option",
+          "description": "Not run tests of specific labels",
+          "multiple": true
+        },
+        "base-url-web": {
+          "name": "base-url-web",
+          "type": "option",
+          "description": "Base URL for web interface (e.g., https://app.testrigor.com)",
+          "multiple": false
+        },
+        "base-url-api": {
+          "name": "base-url-api",
+          "type": "option",
+          "description": "Base URL for API2 (e.g., https://api2.testrigor.com)",
+          "multiple": false
+        },
+        "chrome-extension": {
+          "name": "chrome-extension",
+          "type": "option",
+          "description": "Chrome extension: \"name=EXT_NAME file=PATH_TO_CRX\"",
+          "multiple": true,
+          "exclusive": [
+            "file-path"
+          ]
+        }
+      },
+      "args": {
+        "testSuiteId": {
+          "name": "testSuiteId",
+          "description": "The test suite id (optional if set in config)",
+          "required": false
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -0,0 +1,98 @@
+{
+  "name": "@testrigor/testrigor-cli",
+  "version": "0.0.42-beta",
+  "description": "TestRigor Command Line",
+  "author": "Ivo Parun Rua @parunruaivo",
+  "bin": {
+    "testrigor": "bin/run"
+  },
+  "homepage": "https://github.com/TestRigor/testrigor-cli",
+  "license": "MIT",
+  "main": "dist/index.ts",
+  "repository": "TestRigor/testrigor-cli",
+  "files": [
+    "/bin",
+    "/dist",
+    "/npm-shrinkwrap.json",
+    "oclif.manifest.json"
+  ],
+  "dependencies": {
+    "@oclif/core": "^2",
+    "@oclif/plugin-help": "^5",
+    "@oclif/plugin-plugins": "^3.2.0",
+    "@supercharge/fs": "^3.4.0",
+    "form-data": "^4.0.1",
+    "glob": "^10.3.10",
+    "gunzip-maybe": "^1.4.2",
+    "is-ci": "^3.0.1",
+    "listr2": "^8.0.1",
+    "node-fetch-commonjs": "3.3.1",
+    "tar-stream": "^3.1.6",
+    "unzip-stream": "^0.3.1",
+    "yaml": "^2.3.4"
+  },
+  "devDependencies": {
+    "@oclif/test": "^2.4.2",
+    "@types/chai": "^4",
+    "@types/eslint__js": "^8.42.3",
+    "@types/is-ci": "^3.0.4",
+    "@types/mocha": "^9.0.0",
+    "@types/node": "^16.18.39",
+    "@types/tar-stream": "^3.1.3",
+    "@types/unzip-stream": "^0.3.4",
+    "@types/unzipper": "^0.10.9",
+    "@typescript-eslint/eslint-plugin": "^7.18.0",
+    "chai": "^4",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-mocha": "^10.5.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "globals": "^15.12.0",
+    "mocha": "^10.1.0",
+    "oclif": "^3.11.2",
+    "shx": "^0.3.4",
+    "ts-node": "^10.9.1",
+    "tslib": "^2.6.1",
+    "typescript": "^4.9.5",
+    "typescript-eslint": "^7.18.0"
+  },
+  "oclif": {
+    "bin": "testrigor",
+    "dirname": "testrigor-cli",
+    "commands": "./dist/commands",
+    "plugins": [
+      "@oclif/plugin-help",
+      "@oclif/plugin-plugins"
+    ],
+    "topicSeparator": " ",
+    "topics": {
+      "test-suite": {
+        "description": "Commands for managing and running test suites"
+      },
+      "test-suite:run": {
+        "description": "Run all tests of a Test Suite"
+      },
+      "authenticate": {
+        "description": "Set your testRigor personal authentication token"
+      }
+    }
+  },
+  "scripts": {
+    "build": "shx rm -rf dist && tsc -b",
+    "lint": "eslint .",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "posttest": "npm run lint",
+    "prepack": "npm run build && oclif manifest && oclif readme",
+    "test": "mocha --forbid-only \"test/**/*.ts\"",
+    "version": "oclif readme && git add README.md",
+    "tarballs": "npm run prepack && oclif pack tarballs"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "bugs": "https://github.com/TestRigor/testrigor-cli/issues",
+  "keywords": [
+    "oclif"
+  ],
+  "types": "dist/index.d.ts"
+}