@uipath/test-manager-tool 1.196.0 → 1.197.0-preview.59

package/README.md

@@ -0,0 +1,221 @@
+# UiPath Test Manager Tool (`uip tm`)
+
+> **Full reference:** [UiPath CLI — Test Manager](https://docs.uipath.com/uipath-cli/standalone/latest/user-guide/uip-test-manager)
+
+Manage test cases, test sets, executions, and results in UiPath Test Manager from the command line.
+
+This package adds the `tm` command group to the [`uip` CLI](../cli). Every command is invoked as:
+
+```
+uip tm <group> <command> [options]
+```
+
+Run a group with `--help` to list its commands, and a command with `--help` to see its options and a live example:
+
+```bash
+uip tm testcases --help            # list commands in the testcases group
+uip tm testcases create --help     # options for one command
+```
+
+---
+
+## Getting started
+
+```bash
+# 1. Authenticate the uip CLI (interactive)
+uip login
+
+# 2. Confirm you are logged in
+uip login status --output json
+
+# 3. Discover your projects
+uip tm project list --output json
+```
+
+For CI / non-interactive runs the CLI reads env-auth variables (`UIPATH_CLI_ENABLE_ENV_AUTH=true`, `UIPATH_CLI_AUTH_TOKEN`, plus org/tenant). See the root CLI docs for details.
+
+---
+
+## Global flags
+
+These flags apply to every command.
+
+| Flag | Description |
+|------|-------------|
+| `--output <format>` | Output format: `table`, `json`, `yaml`, or `plain`. Use `json` for scripting. |
+| `--output-filter <expr>` | [JMESPath](https://jmespath.org/) expression applied to the `Data` field before printing. |
+| `--log-level <level>` | Log verbosity: `debug`, `info`, `warn`, `error`. |
+| `--log-file <path>` | Write logs to a file instead of stderr. |
+
+Success responses: `{ "Result": "Success", "Code": "...", "Data": ... }`. Errors: `{ "Result": "Failure", "Message": "...", "Instructions": ... }` + non-zero exit code.
+
+---
+
+## Command surface
+
+### `project` — Test Manager projects
+
+| Command | Description |
+|---------|-------------|
+| `uip tm project list` | List Test Manager projects. |
+| `uip tm project create` | Create a new Test Manager project. |
+| `uip tm project update` | Update a project name or description. |
+| `uip tm project delete` | Delete a project by its key. |
+| `uip tm project set-default-folder` | Set the default Orchestrator folder for a project. |
+| `uip tm project clear-default-folder` | Clear the default Orchestrator folder from a project. |
+| `uip tm project owners list` | List the owners of one or more projects. |
+
+### `requirements` — Requirements
+
+| Command | Description |
+|---------|-------------|
+| `uip tm requirements list` | List requirements in a project. |
+| `uip tm requirements create` | Create a new requirement. |
+| `uip tm requirements get` | Get a requirement by id or key. |
+| `uip tm requirements update` | Update a requirement name or description. |
+| `uip tm requirements delete` | Delete one or more requirements. |
+| `uip tm requirements export` | Export requirements to an .xlsx file. |
+| `uip tm requirements list-by-test-execution` | List requirements covered by a test execution. |
+| `uip tm requirements list-testcase-ids` | List the test case UUIDs assigned to a requirement. |
+| `uip tm requirements testcases` | Attach or detach test cases on a requirement. |
+
+### `testcases` — Test cases
+
+| Command | Description |
+|---------|-------------|
+| `uip tm testcases list` | List all test cases in a project. |
+| `uip tm testcases create` | Create a new test case. |
+| `uip tm testcases update` | Update a test case name, description, or pre/post-condition. |
+| `uip tm testcases delete` | Delete a test case by its key. |
+| `uip tm testcases run` | Run a new execution for one or more test cases. |
+| `uip tm testcases add` | Add test cases to a test set. |
+| `uip tm testcases remove` | Remove test cases from a test set. |
+| `uip tm testcases link-automation` | Link an Orchestrator package automation to a test case. |
+| `uip tm testcases unlink-automation` | Unlink the automation from a test case. |
+| `uip tm testcases list-automations` | List test entry points available in an Orchestrator folder. |
+| `uip tm testcases list-result-history` | List result history for a specific test case. |
+| `uip tm testcases list-steps` | List the steps of a test case. |
+| `uip tm testcases list-testsets` | List test sets that contain a given test case. |
+| `uip tm testcases steps add` | Add one or more steps to a test case. |
+| `uip tm testcases steps get` | Get a single test step by its id. |
+| `uip tm testcases steps list` | List the steps of a test case. |
+| `uip tm testcases steps move` | Move a step to a new position in the test case. |
+| `uip tm testcases steps update` | Update a step's description, expected result, or notes. |
+| `uip tm testcases steps delete` | Delete a step from a test case. |
+
+### `testsets` — Test sets
+
+| Command | Description |
+|---------|-------------|
+| `uip tm testsets list` | List test sets in a project. |
+| `uip tm testsets create` | Create a new test set. |
+| `uip tm testsets update` | Update a test set name or description. |
+| `uip tm testsets delete` | Delete a test set by its key. |
+| `uip tm testsets run` | Run a test set and return the execution ID. Pass `--wait` to block until done. |
+| `uip tm testsets list-testcases` | List test cases assigned to a test set. |
+
+### `executions` — Test executions
+
+| Command | Description |
+|---------|-------------|
+| `uip tm executions list` | List top n executions for a project or test set. |
+| `uip tm executions list-filtered` | List executions for a project using the full filtered API. |
+| `uip tm executions run` | Run a test execution. |
+| `uip tm executions retry` | Retry only the failed test cases of a finished execution. |
+| `uip tm executions get-stats` | Get aggregated pass/fail/none stats for an execution. |
+| `uip tm executions testcaselogs list` | List test case logs produced by an execution. |
+
+### `testcaselog` — Test case logs (manual execution recording)
+
+| Command | Description |
+|---------|-------------|
+| `uip tm testcaselog start` | Start a test case execution within a test execution. |
+| `uip tm testcaselog finish` | Finish a test case execution and record all step results. |
+| `uip tm testcaselog list-assertions` | List assertions for a test case log. |
+
+### `teststeplog` — Test step logs
+
+| Command | Description |
+|---------|-------------|
+| `uip tm teststeplog list` | List test step logs for a test case log. |
+
+### `result` — Execution results
+
+| Command | Description |
+|---------|-------------|
+| `uip tm result download` | Download test execution results as JUnit XML. |
+
+### `report` — Execution reports
+
+| Command | Description |
+|---------|-------------|
+| `uip tm report get` | Get a summary report for a completed test execution. |
+
+### `attachment` — Attachments
+
+| Command | Description |
+|---------|-------------|
+| `uip tm attachment upload` | Upload a file as an attachment to a Test Manager object. |
+| `uip tm attachment download` | Download attachments for test cases in an execution. |
+
+### `customfield` — Custom fields
+
+| Command | Description |
+|---------|-------------|
+| `uip tm customfield list` | List custom field definitions in a project. |
+| `uip tm customfield create` | Create a new custom field definition. |
+| `uip tm customfield get` | Get a custom field definition. |
+| `uip tm customfield update` | Update a custom field definition. |
+| `uip tm customfield delete` | Delete one or more custom field definitions. |
+| `uip tm customfield label add` | Add label values to a custom field across multiple objects. |
+| `uip tm customfield label create` | Upsert label values for an object. |
+| `uip tm customfield label get` | Get a custom field label row by id. |
+| `uip tm customfield label list` | List custom field label rows for an object type. |
+| `uip tm customfield label remove` | Remove label values from a custom field across multiple objects. |
+| `uip tm customfield value create` | Create a custom field value row on an object. |
+| `uip tm customfield value get` | Get a custom field value row. |
+| `uip tm customfield value list` | List text custom field values for an object type. |
+| `uip tm customfield value update` | Update a custom field value row. |
+| `uip tm customfield value delete` | Delete a custom field value row. |
+
+### `objectlabel` — Object labels (tags)
+
+| Command | Description |
+|---------|-------------|
+| `uip tm objectlabel list` | List distinct label names for one object type. |
+| `uip tm objectlabel add` | Add labels to one or more objects. |
+| `uip tm objectlabel get` | Get a single label assignment row by its id. |
+| `uip tm objectlabel remove` | Remove labels from multiple objects. |
+
+### `user` — User data
+
+| Command | Description |
+|---------|-------------|
+| `uip tm user get` | Get data for the currently authenticated user. |
+
+### `wait` — Wait for execution
+
+| Command | Description |
+|---------|-------------|
+| `uip tm wait` | Wait for a test execution to reach a terminal state (pass `--execution-id` and `--project-key`). |
+
+---
+
+## Examples
+
+```bash
+# List projects as JSON
+uip tm project list --output json
+
+# Create a test case
+uip tm testcases create --project-key DEMO --name "Login smoke" --description "Logs in and out"
+
+# Run a test set and wait for it to finish
+uip tm testsets run --test-set-key DEMO:10 --wait
+
+# Download execution results as JUnit XML
+uip tm result download --execution-id a1b2c3d4-0000-0000-0000-000000000001 --project-key DEMO --result-path ./junit.xml
+
+# Retry only the failed test cases of an execution
+uip tm executions retry --execution-id a1b2c3d4-0000-0000-0000-000000000001 --project-key DEMO
+```

package/dist/index.js

@@ -2149,3 +2149,5 @@ var program2 = new Command;
 program2.name(metadata.commandPrefix).description(metadata.description).version(metadata.version);
 await registerCommands(program2);
 program2.parse(process.argv);
+
+//# debugId=96C1541AB487666464756E2164756E21