@testrigor/testrigor-cli 0.0.51-beta → 1.0.1

package/README.md

@@ -73,3 +73,455 @@ overrideTestNodes: true
 ```
 
 This overrides the device config stored in the test suite and forces mobile mode (no need for `--localhost`).
+
+### Releasing a new version
+
+Every push to `master` runs the CircleCI `publish` workflow. It builds the tarballs, then publishes the package to npm under the `latest` tag. npm refuses to republish an existing version, so a change is only released when it bumps the version.
+
+1. Pick the [semver](https://semver.org) bump: `patch` for fixes, `minor` for new flags or commands, `major` for breaking changes.
+2. Bump the version with npm (don't edit `package.json` by hand):
+
+   ```
+   npm run build
+   npm version patch --no-git-tag-version
+   ```
+
+   This updates the version in `package.json` and in both root entries of `package-lock.json` (`version` and `packages[""].version`). `--no-git-tag-version` stops npm from creating its own commit and `v*` tag. npm also runs the `version` script (`oclif readme && git add README.md`). That script loads the commands from `dist`, which is why you build first. It only rewrites README sections between oclif markers such as `<!-- commands -->
+* [`testrigor authenticate`](#testrigor-authenticate)
+* [`testrigor help [COMMANDS]`](#testrigor-help-commands)
+* [`testrigor plugins`](#testrigor-plugins)
+* [`testrigor plugins:install PLUGIN...`](#testrigor-pluginsinstall-plugin)
+* [`testrigor plugins:inspect PLUGIN...`](#testrigor-pluginsinspect-plugin)
+* [`testrigor plugins:install PLUGIN...`](#testrigor-pluginsinstall-plugin-1)
+* [`testrigor plugins:link PLUGIN`](#testrigor-pluginslink-plugin)
+* [`testrigor plugins:uninstall PLUGIN...`](#testrigor-pluginsuninstall-plugin)
+* [`testrigor plugins:uninstall PLUGIN...`](#testrigor-pluginsuninstall-plugin-1)
+* [`testrigor plugins:uninstall PLUGIN...`](#testrigor-pluginsuninstall-plugin-2)
+* [`testrigor plugins update`](#testrigor-plugins-update)
+* [`testrigor test-suite config`](#testrigor-test-suite-config)
+* [`testrigor test-suite run [TESTSUITEID]`](#testrigor-test-suite-run-testsuiteid)
+* [`testrigor test-suite validate-syntax [TESTSUITEID]`](#testrigor-test-suite-validate-syntax-testsuiteid)
+
+## `testrigor authenticate`
+
+Set your testRigor authentication token
+
+```
+USAGE
+  $ testrigor authenticate
+
+DESCRIPTION
+  Set your testRigor authentication token
+
+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
+```
+
+_See code: [src/commands/authenticate.ts](https://github.com/TestRigor/testrigor-cli/blob/v1.0.1/src/commands/authenticate.ts)_
+
+## `testrigor help [COMMANDS]`
+
+Display help for testrigor.
+
+```
+USAGE
+  $ testrigor help [COMMANDS] [-n]
+
+ARGUMENTS
+  COMMANDS  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for testrigor.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.20/src/commands/help.ts)_
+
+## `testrigor plugins`
+
+List installed plugins.
+
+```
+USAGE
+  $ testrigor plugins [--json] [--core]
+
+FLAGS
+  --core  Show core plugins.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  List installed plugins.
+
+EXAMPLES
+  $ testrigor plugins
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.10.1/src/commands/plugins/index.ts)_
+
+## `testrigor plugins:install PLUGIN...`
+
+Installs a plugin into the CLI.
+
+```
+USAGE
+  $ testrigor plugins:install PLUGIN...
+
+ARGUMENTS
+  PLUGIN  Plugin to install.
+
+FLAGS
+  -f, --force    Run yarn install with force flag.
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Installs a plugin into the CLI.
+  Can be installed from npm or a git url.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
+  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
+  the CLI without the need to patch and update the whole CLI.
+
+
+ALIASES
+  $ testrigor plugins add
+
+EXAMPLES
+  $ testrigor plugins:install myplugin 
+
+  $ testrigor plugins:install https://github.com/someuser/someplugin
+
+  $ testrigor plugins:install someuser/someplugin
+```
+
+## `testrigor plugins:inspect PLUGIN...`
+
+Displays installation properties of a plugin.
+
+```
+USAGE
+  $ testrigor plugins:inspect PLUGIN...
+
+ARGUMENTS
+  PLUGIN  [default: .] Plugin to inspect.
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Displays installation properties of a plugin.
+
+EXAMPLES
+  $ testrigor plugins:inspect myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.10.1/src/commands/plugins/inspect.ts)_
+
+## `testrigor plugins:install PLUGIN...`
+
+Installs a plugin into the CLI.
+
+```
+USAGE
+  $ testrigor plugins:install PLUGIN...
+
+ARGUMENTS
+  PLUGIN  Plugin to install.
+
+FLAGS
+  -f, --force    Run yarn install with force flag.
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Installs a plugin into the CLI.
+  Can be installed from npm or a git url.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
+  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
+  the CLI without the need to patch and update the whole CLI.
+
+
+ALIASES
+  $ testrigor plugins add
+
+EXAMPLES
+  $ testrigor plugins:install myplugin 
+
+  $ testrigor plugins:install https://github.com/someuser/someplugin
+
+  $ testrigor plugins:install someuser/someplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.10.1/src/commands/plugins/install.ts)_
+
+## `testrigor plugins:link PLUGIN`
+
+Links a plugin into the CLI for development.
+
+```
+USAGE
+  $ testrigor plugins:link PLUGIN
+
+ARGUMENTS
+  PATH  [default: .] path to plugin
+
+FLAGS
+  -h, --help      Show CLI help.
+  -v, --verbose
+  --[no-]install  Install dependencies after linking the plugin.
+
+DESCRIPTION
+  Links a plugin into the CLI for development.
+  Installation of a linked plugin will override a user-installed or core plugin.
+
+  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
+  command will override the user-installed or core plugin implementation. This is useful for development work.
+
+
+EXAMPLES
+  $ testrigor plugins:link myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.10.1/src/commands/plugins/link.ts)_
+
+## `testrigor plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ testrigor plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ testrigor plugins unlink
+  $ testrigor plugins remove
+```
+
+## `testrigor plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ testrigor plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ testrigor plugins unlink
+  $ testrigor plugins remove
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.10.1/src/commands/plugins/uninstall.ts)_
+
+## `testrigor plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ testrigor plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ testrigor plugins unlink
+  $ testrigor plugins remove
+```
+
+## `testrigor plugins update`
+
+Update installed plugins.
+
+```
+USAGE
+  $ testrigor plugins update [-h] [-v]
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Update installed plugins.
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.10.1/src/commands/plugins/update.ts)_
+
+## `testrigor test-suite config`
+
+Configure test suite settings and default test suite ID
+
+```
+USAGE
+  $ testrigor test-suite config [--default <value> | --delete | --show]
+
+FLAGS
+  --default=<value>  Set the default test suite ID
+  --delete           Remove the default test suite ID
+  --show             Show current configuration
+
+DESCRIPTION
+  Configure test suite settings and default test suite ID
+
+EXAMPLES
+  $ testrigor test-suite config --default TEST-SUITE-ID
+
+  $ testrigor test-suite config --show
+
+  $ testrigor test-suite config --delete
+```
+
+_See code: [src/commands/test-suite/config.ts](https://github.com/TestRigor/testrigor-cli/blob/v1.0.1/src/commands/test-suite/config.ts)_
+
+## `testrigor test-suite run [TESTSUITEID]`
+
+Run all tests of a Test Suite
+
+```
+USAGE
+  $ testrigor test-suite run [TESTSUITEID] [--auth-token <value>] [-t <value>] [--min-port <value>] [--max-port
+    <value>] [--verbose] [-w] [--branch <value> --commit <value>] [--localhost] [--url <value>]
+    [--junit-report-save-path <value>] [--variables-path <value>] [--test-cases-path <value>] [--rules-path <value>]
+    [--settings-path <value>] [--local-test-nodes-path <value>] [--test-case-uuid <value>] [--auto-create-ai-rules]
+    [--explicit-mutations] [--labels <value>] [--excluded-labels <value>] [--base-url-web <value>] [--base-url-api
+    <value>] [--chrome-extension <value> | --file-path <value>] [--xray-execution-key <value>]
+
+ARGUMENTS
+  TESTSUITEID  The test suite id (optional if set in config)
+
+FLAGS
+  -w, --async                       Don't wait for the test suite to finish
+  --auto-create-ai-rules            Enable auto create AI based rules
+  --base-url-api=<value>            Base URL for API2 (e.g., https://api2.testrigor.com)
+  --base-url-web=<value>            Base URL for web interface (e.g., https://app.testrigor.com)
+  --branch=<value>                  The branch name
+  --chrome-extension=<value>...     Chrome extension: "name=EXT_NAME file=PATH_TO_CRX"
+  --commit=<value>                  The commit
+  --excluded-labels=<value>...      Not run tests of specific labels
+  --explicit-mutations              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"
+  --file-path=<value>               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.
+  --junit-report-save-path=<value>  JUnit report save path
+  --labels=<value>...               Run tests of specific labels
+  --local-test-nodes-path=<value>   Path to a YAML or JSON file with local test nodes configuration
+  --localhost                       Localhost run (auto-detects web vs mobile)
+  --max-port=<value>                [default: 50000] Max port for tunnel
+  --min-port=<value>                [default: 40000] Min port for tunnel
+  --rules-path=<value>              Rules path
+  --settings-path=<value>           Settings path
+  --test-case-uuid=<value>...       Test case uuid (can be repeated). Requires --url (web) or --file-path (mobile app
+                                    upload).
+  --test-cases-path=<value>         Test cases files
+  --url=<value>                     The url
+  --variables-path=<value>          Variables path
+  --xray-execution-key=<value>      Reuse an existing Xray Cloud Test Execution by key (e.g. XR-123) instead of creating
+                                    a new one. Optional; leave blank to create a new execution.
+
+GLOBAL FLAGS
+  -t, --token=<value>   Suite authentication token
+  --auth-token=<value>  Personal authentication token
+  --verbose             Verbose output
+
+DESCRIPTION
+  Run all tests of a Test Suite
+```
+
+_See code: [src/commands/test-suite/run.ts](https://github.com/TestRigor/testrigor-cli/blob/v1.0.1/src/commands/test-suite/run.ts)_
+
+## `testrigor test-suite validate-syntax [TESTSUITEID]`
+
+Validate step syntax against a test suite's reusable rules, without running the steps
+
+```
+USAGE
+  $ testrigor test-suite validate-syntax [TESTSUITEID] [--auth-token <value>] [-t <value>] [--min-port <value>] [--max-port
+    <value>] [--verbose] [--steps <value> | --test-cases-path <value>] [--base-url-api <value>] [--rules-path <value>]
+    [--explicit-mutations]
+
+ARGUMENTS
+  TESTSUITEID  The test suite id (optional if set in config)
+
+FLAGS
+  --base-url-api=<value>     Base URL for API2 (e.g., https://api2.testrigor.com)
+  --explicit-mutations       Validate using only the supplied rules instead of merging them with the suite's saved rules
+  --max-port=<value>         [default: 50000] Max port for tunnel
+  --min-port=<value>         [default: 40000] Min port for tunnel
+  --rules-path=<value>       Ad hoc reusable rules to validate against, for rules not yet saved to this suite (same glob
+                             format as `test-suite run --rules-path`)
+  --steps=<value>            Raw step text to validate directly
+  --test-cases-path=<value>  Test case files to validate (same glob format as `test-suite run --test-cases-path`)
+
+GLOBAL FLAGS
+  -t, --token=<value>   Suite authentication token
+  --auth-token=<value>  Personal authentication token
+  --verbose             Verbose output
+
+DESCRIPTION
+  Validate step syntax against a test suite's reusable rules, without running the steps
+
+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}"
+```
+
+_See code: [src/commands/test-suite/validate-syntax.ts](https://github.com/TestRigor/testrigor-cli/blob/v1.0.1/src/commands/test-suite/validate-syntax.ts)_
+<!-- commandsstop -->`, so this README currently stays unchanged.
+3. Check that the diff only touches the version fields, then build and test from the lockfile:
+
+   ```
+   git diff package.json package-lock.json
+   npm ci && npm run build && npm test
+   ```
+
+4. Commit (e.g. `Updating to version 1.0.1 #TR-XXXX`), open a PR and merge it to `master`.
+
+If the version was edited by hand anyway, run `npm install --package-lock-only` to bring `package-lock.json` back in sync. CI installs with `npm ci`, which fails when `package.json` and `package-lock.json` don't match, so commit the lockfile along with any dependency change.

package/dist/commands/authenticate.js

@@ -49,7 +49,6 @@ class Authenticate extends core_2.Command {
         }
     }
 }
-exports.default = Authenticate;
 Authenticate.description = "Set your testRigor authentication token";
 Authenticate.examples = [
     "testrigor authenticate",
@@ -57,3 +56,4 @@ Authenticate.examples = [
     "Use 'testrigor test-suite config' to set default test suite ID separately",
     "Config will be stored in ~/.testrigor/testrigor.yml",
 ];
+exports.default = Authenticate;

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

@@ -74,7 +74,6 @@ class Config extends core_1.Command {
         }
     }
 }
-exports.default = Config;
 Config.description = "Configure test suite settings and default test suite ID";
 Config.examples = [
     "testrigor test-suite config --default TEST-SUITE-ID",
@@ -95,3 +94,4 @@ Config.flags = {
         exclusive: getExclusiveFlags("show"),
     }),
 };
+exports.default = Config;

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

@@ -1,16 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
 const core_1 = require("@oclif/core");
-const Fs = require("@supercharge/fs");
-const FormData = require("form-data");
+const fs_1 = tslib_1.__importDefault(require("@supercharge/fs"));
+const form_data_1 = tslib_1.__importDefault(require("form-data"));
 const listr2_1 = require("listr2");
-const node_fetch_commonjs_1 = require("node-fetch-commonjs");
+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 chrome_extension_1 = require("../../flags/chrome-extension");
 const parser_1 = require("../../util/parser");
 const request_builder_1 = require("../../util/request-builder");
-const tunnel_1 = require("../../util/tunnel");
+const tunnel_1 = tslib_1.__importDefault(require("../../util/tunnel"));
 const certificate_uploader_1 = require("../../util/certificate-uploader");
 const variable_file_uploader_1 = require("../../util/variable-file-uploader");
 const variables_path_parser_1 = require("../../util/variables-path-parser");
@@ -120,7 +121,7 @@ class Run extends command_base_1.CommandBase {
         }
         if (variablesPath) {
             try {
-                const file = await Fs.content(variablesPath);
+                const file = await fs_1.default.content(variablesPath);
                 const parsed = JSON.parse(file.toString());
                 const { textValues, fileInputs, certInputs } = (0, variables_path_parser_1.parseVariablesJson)(parsed);
                 context.configuration.storedValues = textValues;
@@ -147,7 +148,7 @@ class Run extends command_base_1.CommandBase {
                     context.configuration.baselineMutations = testCases;
                 }
             }
-            catch (e) {
+            catch {
                 core_1.ux.error("--test-cases-path must be a valid JSON path");
             }
         }
@@ -158,7 +159,7 @@ class Run extends command_base_1.CommandBase {
                     context.configuration.ruleMutations = rules;
                 }
             }
-            catch (e) {
+            catch {
                 core_1.ux.error("--rules-path must be a valid JSON path");
             }
         }
@@ -169,7 +170,7 @@ class Run extends command_base_1.CommandBase {
                     context.configuration.settings = settings;
                 }
             }
-            catch (e) {
+            catch {
                 core_1.ux.error("--settings-path must be a valid JSON/YAML path");
             }
         }
@@ -187,7 +188,7 @@ class Run extends command_base_1.CommandBase {
                     Object.assign(context.configuration, localTestNodes);
                 }
             }
-            catch (e) {
+            catch {
                 core_1.ux.error("--local-test-nodes-path must be a valid JSON/YAML path");
             }
         }
@@ -197,12 +198,12 @@ class Run extends command_base_1.CommandBase {
                 delete flags["file-path"];
             }
             else {
-                const fileExists = await Fs.isFile(filePath);
+                const fileExists = await fs_1.default.isFile(filePath);
                 if (!fileExists || !(0, utils_1.isValidFileExtensionToUpload)(filePath)) {
                     core_1.ux.error("--file-path must be one of the valid format types: [zip, exe, msi, apk, aab, ipa, app]");
                 }
-                const fileName = Fs.basename(filePath);
-                const fileSize = Fs.statSync(filePath).size;
+                const fileName = fs_1.default.basename(filePath);
+                const fileSize = fs_1.default.statSync(filePath).size;
                 context.fileProperties = { fileName, fileSize };
             }
         }
@@ -421,8 +422,8 @@ class Run extends command_base_1.CommandBase {
                             }
                             const configuration = ctx.configuration;
                             const filePath = flags["file-path"];
-                            const form = new FormData();
-                            form.append("file", Fs.createReadStream(filePath));
+                            const form = new form_data_1.default();
+                            form.append("file", fs_1.default.createReadStream(filePath));
                             form.append("data", JSON.stringify(configuration));
                             const response = await (0, node_fetch_commonjs_1.default)(`${this.TESTRIGOR_API2_URL}/apps/${testSuiteId}/retest`, {
                                 method: "POST",
@@ -707,7 +708,7 @@ class Run extends command_base_1.CommandBase {
             throw new Error(`Failed to prepare upload: ${preSignedUrlResponse.message}`);
         }
         const preSignedUrlData = preSignedUrlResponse.data;
-        const fileToBeUploaded = Fs.createReadStream(filePath);
+        const fileToBeUploaded = fs_1.default.createReadStream(filePath);
         const uploadFileResponse = await (0, node_fetch_commonjs_1.default)(preSignedUrlData.url, {
             method: "PUT",
             body: fileToBeUploaded,
@@ -823,7 +824,7 @@ class Run extends command_base_1.CommandBase {
                     throw new Error(`Unexpected contentType of junit report: ${contentType}`);
                 }
                 const xmlData = await response.text();
-                await Fs.writeFile(savePath, xmlData);
+                await fs_1.default.writeFile(savePath, xmlData);
                 task.title = JUNIT_REPORT_STATUS.READY;
                 return;
             }
@@ -839,7 +840,6 @@ class Run extends command_base_1.CommandBase {
         }
     }
 }
-exports.default = Run;
 Run.description = "Run all tests of a Test Suite";
 Run.examples = [];
 Run.flags = {
@@ -928,3 +928,4 @@ Run.args = {
         required: false,
     }),
 };
+exports.default = Run;

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;
+}