@uipath/test-manager-tool 1.204.0-preview.255 → 1.205.0-preview.256
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +180 -13
- package/dist/THIRD-PARTY-NOTICES.md +32 -1
- package/dist/attachment.input-jpcea4mp.js +36 -0
- package/dist/index-ah3hzwzh.js +3173 -0
- package/dist/index-sa6fzfmt.js +2808 -0
- package/dist/index.js +10 -3
- package/dist/migration-import-run-g9g9c5x3.js +849 -0
- package/dist/tool-2a68c3s5.js +62 -0
- package/dist/tool-7hy7vvfk.js +22083 -0
- package/dist/tool-8b7p4csj.js +296 -0
- package/dist/tool-cpdm080k.js +18358 -0
- package/dist/tool-e3prtphw.js +8376 -0
- package/dist/tool-fxj3gn2v.js +1676 -0
- package/dist/tool-t79gv96d.js +32699 -0
- package/dist/tool.js +8 -2
- package/package.json +2 -2
- package/dist/tool-r7sm9m9e.js +0 -40698
package/README.md
CHANGED
|
@@ -57,9 +57,10 @@ Success responses: `{ "Result": "Success", "Code": "...", "Data": ... }`. Errors
|
|
|
57
57
|
|
|
58
58
|
| Command | Description |
|
|
59
59
|
|---------|-------------|
|
|
60
|
-
| `uip tm project list` | List Test Manager projects. |
|
|
60
|
+
| `uip tm project list` | List Test Manager projects. `IsDefault` marks the tenant's default project, which comes first. |
|
|
61
|
+
| `uip tm project get-default` | Get the tenant's default project, creating it on first use ("Default Project", `TMDP`, open to the tenant's Everyone group). |
|
|
61
62
|
| `uip tm project create` | Create a new Test Manager project. |
|
|
62
|
-
| `uip tm project update` | Update a project name or description. |
|
|
63
|
+
| `uip tm project update` | Update a project name or description. `--set-default` makes it the tenant's default. |
|
|
63
64
|
| `uip tm project delete` | Delete a project by its key. |
|
|
64
65
|
| `uip tm project set-default-folder` | Set the default Orchestrator folder for a project. |
|
|
65
66
|
| `uip tm project clear-default-folder` | Clear the default Orchestrator folder from a project. |
|
|
@@ -80,47 +81,82 @@ Success responses: `{ "Result": "Success", "Code": "...", "Data": ... }`. Errors
|
|
|
80
81
|
| `uip tm requirements list-by-test-execution` | List requirements covered by a test execution. |
|
|
81
82
|
| `uip tm requirements list-testcase-ids` | List the test case UUIDs assigned to a requirement. |
|
|
82
83
|
| `uip tm requirements testcases` | Attach or detach test cases on a requirement. |
|
|
84
|
+
| `uip tm requirements generate-testcases` | Ask the AI to propose test cases for a requirement. `--wait` prints them, numbered; `--create` also creates them and links them to the requirement. `--activity-id` reuses a job that already ran, and `--select` creates only some of its test cases. The job is not marked as used (that route rejects CLI tokens), so the web app can still offer the test cases the CLI creates. |
|
|
85
|
+
| `uip tm requirements evaluate` | Ask the AI to review a requirement and suggest improvements. `--wait` prints the suggestions. `--activity-id <id> --more-suggestions` asks a finished evaluation for more, keeping its inputs. Changes nothing; apply a suggestion with `requirements update`. |
|
|
86
|
+
| `uip tm requirements find-obsolete-testcases` | Ask the AI which test cases linked to a requirement look obsolete. `--wait` prints them, numbered, with a score and confidence. Changes nothing on its own; `--unlink` removes them from the requirement and `--delete --yes` deletes them, `--select` picks some. |
|
|
87
|
+
|
|
88
|
+
The three AI commands need a user login (`uip login`). Test Manager runs each AI job for the user who started it, so a client-credentials (app) login is refused: the server answers it with an error.
|
|
83
89
|
|
|
84
90
|
### `testcases` — Test cases
|
|
85
91
|
|
|
86
92
|
| Command | Description |
|
|
87
93
|
|---------|-------------|
|
|
88
|
-
| `uip tm testcases list` | List all test cases in a project. |
|
|
94
|
+
| `uip tm testcases list` | List all test cases in a project. `--labels` narrows to test cases carrying at least one of the given labels (up to 100); add `--filter` to also narrow by name or key. `--automated --folder-path <path>` (or `--folder-key`) lists only the automated test cases whose package lives in that Orchestrator folder; test cases linked to a Playwright package are left out, because the server route is built for performance testing. The folder lookup needs the `OR.Folders.Read` scope. The label and folder forms need the `TM.TestCases` scope, not just `.Read`. |
|
|
95
|
+
| `uip tm testcases get` | Get one test case by key (`--test-case-key`), or by the automation linked to it (`--automation-id`, a `PackageEntryPointId` or Studio automation id). `--automation-id` returns one linked test case; if several share the automation, use `list` and filter on `PackageEntryPointId`. |
|
|
89
96
|
| `uip tm testcases create` | Create a new test case. |
|
|
90
97
|
| `uip tm testcases update` | Update a test case name, description, or pre/post-condition. |
|
|
91
98
|
| `uip tm testcases delete` | Delete a test case by its key. |
|
|
92
99
|
| `uip tm testcases run` | Run a new execution for one or more test cases. |
|
|
93
|
-
| `uip tm testcases add` | Add test cases to a test set. |
|
|
94
|
-
| `uip tm testcases remove` | Remove test cases from a test set. |
|
|
100
|
+
| `uip tm testcases add` | Add test cases to a test set by key or label. `--labels <l...> --dynamic` assigns test cases dynamically: every test case carrying one of the labels, now or later, is part of the set. |
|
|
101
|
+
| `uip tm testcases remove` | Remove test cases from a test set by key, or `--dynamic [--labels <l...>]` to stop assigning them dynamically. |
|
|
95
102
|
| `uip tm testcases link-automation` | Link an Orchestrator package automation to a test case. For Playwright packages, pass the displayed `specPath > testTitle` name as `--test-name`. When the name is too long to match (shown truncated with `…` in `list-automations`), also pass `--entry-point-id` to bind by id; `--test-name` stays required but is ignored. |
|
|
96
103
|
| `uip tm testcases link-package` | Create and link a test case for every test in an Orchestrator package, in one call. |
|
|
97
104
|
| `uip tm testcases unlink-automation` | Unlink the automation from a test case. |
|
|
98
105
|
| `uip tm testcases list-automations` | List test entry points available in an Orchestrator folder. Each row includes `PackageEntryPointId`, the id to pass to `link-automation --entry-point-id`. |
|
|
99
106
|
| `uip tm testcases list-result-history` | List result history for a specific test case. |
|
|
100
|
-
| `uip tm testcases list-testsets` | List test sets that
|
|
107
|
+
| `uip tm testcases list-testsets` | List the test sets that assign a test case explicitly (`--test-case-key`), or that explicitly assign any test case carrying one of the given labels (`--labels`, up to 100). Test sets that pull a test case in through a dynamic label rule are not listed. `--limit`/`--offset` window the result. The label form needs the `TM.TestCases` and `TM.TestSets` scopes, not just `.Read`. |
|
|
108
|
+
| `uip tm testcases list-requirements` | List the requirements assigned to a test case; rows have the same shape as `requirements list`. `--limit`/`--offset` window the result. |
|
|
109
|
+
| `uip tm testcases list-studio-projects` | List the distinct Studio project names the project's automated test cases come from, sorted (`--filter` prefix match, `--limit`/`--offset`). |
|
|
110
|
+
| `uip tm testcases list-packages` | List the distinct Orchestrator package names the project's automated test cases are linked to, sorted (`--filter` prefix match, `--limit`/`--offset`). |
|
|
111
|
+
| `uip tm testcases group-by` | Count test cases per value of a custom label field (`--field`, `--sort-order asc\|desc`). Test Cloud only; an unknown field is reported as not found. |
|
|
112
|
+
| `uip tm testcases clone` | Queue a copy of a test case under a new name (`--test-case-key`, `--new-name`) and return `Accepted`. Test Manager makes the copy in the background and reports no key, so find it with `list --filter <name>`. `--include labels documents requirements parameters governance` copies more than the defaults (same option shape as `testsets clone`). |
|
|
113
|
+
| `uip tm testcases bulk-create` | Create many test cases from a JSON file (`--file`), 100 per request, each request one transaction. `--labels` for all, `--requirement-key` to assign all, `--skip-existing` to skip, per name, as many items as the project already has with that name. Unknown custom field names, label values outside a field's list and step `clipboardData` over 8000 characters are rejected before anything is sent. `KeysResolved: false` means every item was created but the keys could not be read back. |
|
|
114
|
+
| `uip tm testcases export` | Export test cases (all, or `--test-case-ids`) to an .xlsx file. Test Manager builds it as a background job, so this returns the job id and the commands to check and fetch it; with `--wait --output-file` it polls the job and writes the file. |
|
|
101
115
|
| `uip tm testcases steps add` | Add one or more steps to a test case. |
|
|
102
116
|
| `uip tm testcases steps get` | Get a single test step by its id. |
|
|
103
117
|
| `uip tm testcases steps list` | List the steps of a test case. |
|
|
104
118
|
| `uip tm testcases steps move` | Move a step to a new position in the test case. |
|
|
105
119
|
| `uip tm testcases steps update` | Update a step's description, expected result, or notes. |
|
|
106
120
|
| `uip tm testcases steps delete` | Delete a step from a test case. |
|
|
121
|
+
| `uip tm testcases parameters list` | List the parameters of a test case. |
|
|
122
|
+
| `uip tm testcases parameters get` | Get one parameter of a test case, by name or by id. |
|
|
123
|
+
| `uip tm testcases parameters add` | Add a parameter to a test case. |
|
|
124
|
+
| `uip tm testcases parameters update` | Update a parameter. Fields you do not pass keep their current value. |
|
|
125
|
+
| `uip tm testcases parameters delete` | Delete one or more parameters by id in one call (`--parameter-ids <uuid...>`). Needs `--yes`. |
|
|
107
126
|
|
|
108
127
|
### `testsets` — Test sets
|
|
109
128
|
|
|
110
129
|
| Command | Description |
|
|
111
130
|
|---------|-------------|
|
|
112
|
-
| `uip tm testsets list` | List test sets in a project. |
|
|
131
|
+
| `uip tm testsets list` | List test sets in a project; `--labels` finds sets carrying any of the labels; `--limit`/`--offset` cut a row window out of the matches (folder filter applied first) and the envelope's `Pagination.HasMore` says whether another window exists. |
|
|
113
132
|
| `uip tm testsets create` | Create a new test set. |
|
|
114
133
|
| `uip tm testsets update` | Update a test set name or description. |
|
|
134
|
+
| `uip tm testsets settings get` | Show a test set's settings: execution-order enforcement, stop on failure, coverage, remote control, video recording, Autopilot. |
|
|
135
|
+
| `uip tm testsets settings set` | Switch `--enforce-execution-order` / `--no-enforce-execution-order`; the other settings have no write route in the API yet. |
|
|
115
136
|
| `uip tm testsets delete` | Delete a test set by its key. |
|
|
116
137
|
| `uip tm testsets run` | Run a test set and return the execution ID. Pass `--wait` to block until done. For a Playwright test set, `--playwright-project <name>` runs only that `playwright.config` project (e.g. `chromium`) and saves the selection on the test set. Only one project may be selected per automated execution. |
|
|
117
|
-
| `uip tm testsets list-testcases` | List test cases
|
|
138
|
+
| `uip tm testsets list-testcases` | List the test cases a run executes — static links plus dynamic-label matches — with `AssignmentType` `Static`, `Dynamic`, or `Both`. |
|
|
139
|
+
| `uip tm testsets get-dynamic-assignment` | Show the labels that assign test cases to a test set dynamically, and how many test cases they match now. Set them with `testsets create --dynamic-labels` or `testcases add --labels --dynamic`; stop with `testcases remove --dynamic`. |
|
|
118
140
|
| `uip tm testsets playwright-context` | Show a test set's Playwright context: whether it resolves to a single Playwright package and which projects are available/selected (probe before using `run --playwright-project`). |
|
|
141
|
+
| `uip tm testsets get` | Show a test set with its Orchestrator folder, selected packages and execution target. |
|
|
142
|
+
| `uip tm testsets clone` | Copy a test set under `--new-name` (assigned cases and their parameter overrides, custom fields, label filter; `--include labels documents` for more). Waits until the copy exists and holds the source's static test cases (`Result: Cloned`; labels and documents arrive right after), unless `--no-wait`. |
|
|
143
|
+
| `uip tm testsets group-by` | Count the project's test sets per value of a custom label field (Test Cloud). |
|
|
144
|
+
| `uip tm testsets assign-user` | Assign a person (`--assignee-email` or `--assignee-id`) to test cases in the set, picked by key, label or `--all`; `--unassign` clears. |
|
|
145
|
+
| `uip tm testsets set-execution-order` | Set the order the set's test cases run in; list every assigned case. Make the set honour it with `settings set --enforce-execution-order`. |
|
|
146
|
+
| `uip tm testsets set-folder` | Point the set at an Orchestrator folder by `--folder-path` or `--folder-key`. |
|
|
147
|
+
| `uip tm testsets set-robot` | Set the robot account the set runs with: `--robot-name` (resolved in the set's folder) or `--robot-user-key` (resolved to its name). |
|
|
148
|
+
| `uip tm testsets set-execution-target` | Set runtime type, robot and machine for the set; unmentioned fields keep their value, a machine change or a runtime type without a machine (serverless, attendedStudioWeb) drops the old machine, `--clear-machine` / `--clear-robot` remove them (Test Cloud). |
|
|
149
|
+
| `uip tm testsets autoselect-packages` | Show the package versions Test Manager would pick for the set's automated cases (read-only). |
|
|
119
150
|
|
|
120
151
|
### `executions` — Test executions
|
|
121
152
|
|
|
122
153
|
| Command | Description |
|
|
123
154
|
|---------|-------------|
|
|
155
|
+
| `uip tm executions finish` | Close a manual execution early, while some of its test case logs are unfinished. A run whose logs all finished has already closed itself. |
|
|
156
|
+
| `uip tm executions delete` | Delete an execution and the test case logs and log snapshots it owns, running or not. Needs `--yes`. |
|
|
157
|
+
| `uip tm executions set-reporting-date` | Book an execution against a given day so reports count it there. Only works once the run is closed, and rejects dates before 2019-01-01. |
|
|
158
|
+
| `uip tm executions export` | Export the executions a filter matches to an .xlsx file; each row's Name cell links back to Test Manager. For one execution's own report, use `report export`. |
|
|
159
|
+
| `uip tm executions cancel` | Ask Test Manager to stop a running automated execution and its Orchestrator jobs. Read `Status`, not `Result`: `Cancelling` means Test Manager recorded the stop; `Running` means it was forwarded to Orchestrator and reaches `Cancelled` once Orchestrator reports back; a terminal status means the run was already over. Manual runs are closed with `finish`. |
|
|
124
160
|
| `uip tm executions list` | List top n executions for a project or test set. |
|
|
125
161
|
| `uip tm executions list-filtered` | List executions for a project using the full filtered API. |
|
|
126
162
|
| `uip tm executions run` | Run a test execution. |
|
|
@@ -128,13 +164,35 @@ Success responses: `{ "Result": "Success", "Code": "...", "Data": ... }`. Errors
|
|
|
128
164
|
| `uip tm executions get-stats` | Get aggregated pass/fail/none stats for an execution. |
|
|
129
165
|
| `uip tm executions testcaselogs list` | List test case logs produced by an execution. |
|
|
130
166
|
|
|
131
|
-
### `
|
|
167
|
+
### `defects` — Defects
|
|
168
|
+
|
|
169
|
+
A defect is raised from one failed test case result and synced to the project's defect tracker (Jira, Azure DevOps, …). Defects are addressed by UUID only.
|
|
170
|
+
|
|
171
|
+
| Command | Description |
|
|
172
|
+
|---|---|
|
|
173
|
+
| `uip tm defects list` | List defects in a project (`--changed-since`, `--sort-by`, `--limit`/`--offset`). |
|
|
174
|
+
| `uip tm defects get` | Get a defect by id. |
|
|
175
|
+
| `uip tm defects create` | Raise a defect from a test case's result in an execution (`--test-case-id` or `--test-case-key`). |
|
|
176
|
+
| `uip tm defects update` | Update status, priority, or the external tracker link. |
|
|
177
|
+
| `uip tm defects delete` | Delete a defect (the tracker issue is kept). |
|
|
178
|
+
| `uip tm defects get-external-issue` | Show the tracker issue a defect is synced to. |
|
|
179
|
+
| `uip tm defects get-related` | Get what a defect links to: `--object-type TestCase`, `TestExecution`, `TestCaseLog`, or `Requirement` (a list). |
|
|
180
|
+
| `uip tm defects attachments list` | List a defect's attachments. |
|
|
181
|
+
| `uip tm defects attachments download` | Download one defect attachment (`--result-path` or `--output-file`; `--overwrite` to replace an existing file). |
|
|
182
|
+
|
|
183
|
+
### `testcaselog` — Test case logs
|
|
132
184
|
|
|
133
185
|
| Command | Description |
|
|
134
186
|
|---------|-------------|
|
|
135
187
|
| `uip tm testcaselog start` | Start a test case execution within a test execution. |
|
|
136
188
|
| `uip tm testcaselog finish` | Finish a test case execution and record all step results. |
|
|
189
|
+
| `uip tm testcaselog list` | List test case logs across a project, filtered and paged. |
|
|
190
|
+
| `uip tm testcaselog get` | Read one test case log, optionally with its assertions. |
|
|
191
|
+
| `uip tm testcaselog latest` | Read the most recent finished log for each given test case. |
|
|
137
192
|
| `uip tm testcaselog list-assertions` | List assertions for a test case log. |
|
|
193
|
+
| `uip tm testcaselog cancel` | Ask Test Manager to cancel a running automated test case execution. |
|
|
194
|
+
| `uip tm testcaselog render-assertions` | Render a test case log's assertions as markdown, ready to paste into a report or defect. |
|
|
195
|
+
| `uip tm testcaselog get-robot-logs` | Get a test case log's robot logs: an expiring download link, or the file itself with `--output-file`. |
|
|
138
196
|
|
|
139
197
|
### `teststeplog` — Test step logs
|
|
140
198
|
|
|
@@ -153,13 +211,105 @@ Success responses: `{ "Result": "Success", "Code": "...", "Data": ... }`. Errors
|
|
|
153
211
|
| Command | Description |
|
|
154
212
|
|---------|-------------|
|
|
155
213
|
| `uip tm report get` | Get a summary report for a completed test execution. |
|
|
214
|
+
| `uip tm report export` | Export a report file: one execution's report with `--execution-id` (`--format excel\|pdf\|junit`, default excel), or a PDF of chosen test case results with `--test-case-log-ids` (two or more come back as one .zip, a PDF per result; needs a Test Cloud licence). Returns the job id and the commands to check and fetch it; with `--wait --output-file` it polls the job and writes the file. JUnit is a tenant feature; where it is off, `result download` builds JUnit XML on the CLI. |
|
|
215
|
+
|
|
216
|
+
### `export-jobs` — File export jobs
|
|
217
|
+
|
|
218
|
+
Test Manager builds its Excel, PDF and JUnit exports in the background and stores the file as a
|
|
219
|
+
hidden attachment on the project. An export command returns the job; when the job reads
|
|
220
|
+
`Completed`, its `AttachmentId` is the file, which `attachment download --attachment-id <id>
|
|
221
|
+
--object-type project` fetches. The product UI is told over a push channel the CLI does not have,
|
|
222
|
+
so reading the job is the whole mechanism.
|
|
223
|
+
|
|
224
|
+
| Command | Description |
|
|
225
|
+
|---------|-------------|
|
|
226
|
+
| `uip tm export-jobs get` | Get the status of a file export job. The job must belong to the project you name, or it reads as not found. `--object-type` only picks which permission is checked, not which job is read. |
|
|
227
|
+
|
|
228
|
+
### `perf-scenario` — Performance testing
|
|
229
|
+
|
|
230
|
+
A scenario holds load groups (a test case, its package and folder, and a load profile). Running it creates an execution, and each load group of that execution gets its own id: `load-groups list --execution-id` reports it, and the per-execution reads take it as `--load-group-id`. `load-groups update` / `remove` take the scenario's load-group id instead. Needs the `TM.PerformanceScenarios` and `TM.PerformanceScenarioExecutions` scopes.
|
|
231
|
+
|
|
232
|
+
| Command | Description |
|
|
233
|
+
|---------|-------------|
|
|
234
|
+
| `uip tm perf-scenario create` | Create a performance scenario in a project. |
|
|
235
|
+
| `uip tm perf-scenario get` | Get a scenario (`--scenario-key`) and the load groups bound to it. |
|
|
236
|
+
| `uip tm perf-scenario list` | List a project's scenarios (`--search`, `--limit`/`--offset`). |
|
|
237
|
+
| `uip tm perf-scenario delete` | Delete a scenario and its load groups (`--yes`). Past executions are kept; a running one is not stopped. |
|
|
238
|
+
| `uip tm perf-scenario execute` | Run a scenario: a dry run by default, or `--execution-type performanceTesting`; `--wait` polls until it ends. |
|
|
239
|
+
| `uip tm perf-scenario stop` | Cancel a running execution. |
|
|
240
|
+
| `uip tm perf-scenario list-dry-run-reports` | Check for a passing dry run, which a full run needs. |
|
|
241
|
+
| `uip tm perf-scenario licenses get` | Virtual-user units left on the tenant's performance testing licence. |
|
|
242
|
+
| `uip tm perf-scenario executions list` | List a scenario's executions (`--execution-type`, `--limit`/`--offset`). |
|
|
243
|
+
| `uip tm perf-scenario load-groups add` | Bind a test case to a scenario as a new load group. |
|
|
244
|
+
| `uip tm perf-scenario load-groups update` | Change a load group's profile; only the flags passed change. |
|
|
245
|
+
| `uip tm perf-scenario load-groups remove` | Remove a load group from a scenario. |
|
|
246
|
+
| `uip tm perf-scenario load-groups list` | List the load groups of one execution, with their result. |
|
|
247
|
+
| `uip tm perf-scenario load-groups get` | Get one load group of an execution: result, test case and the profile it ran with. |
|
|
248
|
+
| `uip tm perf-scenario jobs list` | List the Orchestrator jobs of a load group execution (`--limit`/`--offset`). |
|
|
249
|
+
| `uip tm perf-scenario robot-logs list` | List the robot logs of a load group execution (`--level`, `--limit` up to 500, `--offset`). |
|
|
250
|
+
| `uip tm perf-scenario results get` | Get an execution's full data bundle (time series, CPU/RAM, logs). |
|
|
251
|
+
| `uip tm perf-scenario http-errors list` | List HTTP errors for a load group execution in a time window. |
|
|
252
|
+
| `uip tm perf-scenario automation-errors list` | List automation-step failures for a load group execution in a time window. |
|
|
253
|
+
| `uip tm perf-scenario transaction-metrics list` | Per-transaction response times and throughput for a load group (API tests). |
|
|
254
|
+
| `uip tm perf-scenario report generate` | Render an authored report (PDF or HTML) and return its in-app link. |
|
|
255
|
+
| `uip tm perf-scenario report compare` | Render an authored comparison across executions of one scenario. |
|
|
256
|
+
|
|
257
|
+
### `migration` — Project migration (.tmh packages)
|
|
258
|
+
|
|
259
|
+
Moves a whole project between tenants or environments. A `.tmh` is a transfer format holding
|
|
260
|
+
the project's content and a manifest, not a report for a person to read.
|
|
261
|
+
|
|
262
|
+
| Command | Description |
|
|
263
|
+
|---------|-------------|
|
|
264
|
+
| `uip tm project export` | Export a project to a `.tmh` package. Returns the job id and the commands to check and fetch it; with `--wait` it polls the background job and writes the file. |
|
|
265
|
+
| `uip tm project import` | Import a `.tmh` package into an existing project, or one created from the package with `--create-project`. Uploads in chunks and returns the job id; with `--wait` it polls until the import finishes. |
|
|
266
|
+
| `uip tm migration get` | Get a migration job of the named project by id. |
|
|
267
|
+
| `uip tm migration download` | Download the `.tmh` from an export job that already finished, without exporting again. |
|
|
268
|
+
| `uip tm migration list` | List migration jobs across the tenant, newest first. |
|
|
269
|
+
| `uip tm migration schemas list` | List the `.tmh` schema versions the service accepts, newest first. |
|
|
270
|
+
| `uip tm migration schemas download` | Download one schema version as a zip; `--schema-version latest` takes the newest. |
|
|
271
|
+
|
|
272
|
+
The service never pushes a migration-job event, so `export --wait` polls `migration/job/{id}` — the
|
|
273
|
+
product UI has no other mechanism either. `--include` / `--exclude` take space-separated content
|
|
274
|
+
names: `governance`, `project-config`, `prompts` and `automation` for export, the same less
|
|
275
|
+
`prompts` for import. `-h` lists them with their defaults.
|
|
276
|
+
`project-config` needs a Test Cloud tenant and returns HTTP 403 elsewhere, which is a licence gate
|
|
277
|
+
rather than a permissions problem.
|
|
278
|
+
|
|
279
|
+
Every command except `migration schemas` takes `--project-id` or `--project-key`. The schema
|
|
280
|
+
routes are tenant-wide and need the `TM.Users` (or `TM.Users.Read`) scope instead of `TM.Projects`. Prefer `--project-id`: it is used
|
|
281
|
+
as-is, while a key costs one extra lookup to resolve it first. `--project-id` wins if both are
|
|
282
|
+
given.
|
|
283
|
+
|
|
284
|
+
The package is streamed to `<output-file>.<id>.partial`, unique to each download, and renamed into place once complete and
|
|
285
|
+
confirmed to be a zip, so an interrupted download never leaves a truncated `.tmh`. An existing
|
|
286
|
+
file is refused unless `--overwrite` is given, and a directory always is. The final check and the
|
|
287
|
+
rename run under a lock on the target, so two downloads to one path cannot replace each other.
|
|
288
|
+
In a browser host the package is held in memory and written once, and anything over 256 MiB is
|
|
289
|
+
refused with a pointer to the terminal CLI.
|
|
290
|
+
|
|
291
|
+
The service filters job reads by tenant only and never checks the project in the route, so
|
|
292
|
+
`migration get` and `migration download` first read the named project, which the service does gate
|
|
293
|
+
on project read permission, then report a job from any other project as not found.
|
|
294
|
+
`migration list` has no such check: it lists across the whole tenant, including projects you have
|
|
295
|
+
no role on.
|
|
296
|
+
|
|
297
|
+
An import reads the whole package into memory, so packages over 2 GiB are refused, and sends it
|
|
298
|
+
in 4 MB chunks. A chunk is retried
|
|
299
|
+
only when it provably never reached the service, because the service counts a repeated chunk
|
|
300
|
+
and then fails the import as "Chunks missing". A failed import has no rollback: whatever it wrote
|
|
301
|
+
stays in the target project, so check or delete it before importing again.
|
|
156
302
|
|
|
157
303
|
### `attachment` — Attachments
|
|
158
304
|
|
|
159
305
|
| Command | Description |
|
|
160
306
|
|---------|-------------|
|
|
307
|
+
| `uip tm attachment list` | List attachments for Test Manager objects, one row per object with its attachments nested. |
|
|
308
|
+
| `uip tm attachment get` | Get one attachment's metadata by id. |
|
|
161
309
|
| `uip tm attachment upload` | Upload a file as an attachment to a Test Manager object. |
|
|
162
|
-
| `uip tm attachment download` | Download attachments
|
|
310
|
+
| `uip tm attachment download` | Download attachments: every file of an execution's test cases, or one file by id. |
|
|
311
|
+
| `uip tm attachment update` | Rename an attachment. |
|
|
312
|
+
| `uip tm attachment delete` | Delete an attachment by id. |
|
|
163
313
|
|
|
164
314
|
### `customfield` — Custom fields
|
|
165
315
|
|
|
@@ -186,9 +336,17 @@ Success responses: `{ "Result": "Success", "Code": "...", "Data": ... }`. Errors
|
|
|
186
336
|
| Command | Description |
|
|
187
337
|
|---------|-------------|
|
|
188
338
|
| `uip tm objectlabel list` | List distinct label names for one object type. |
|
|
189
|
-
| `uip tm objectlabel add` | Add labels to one or more objects. |
|
|
190
|
-
| `uip tm objectlabel get` | Get
|
|
191
|
-
| `uip tm objectlabel remove` | Remove labels from multiple objects. |
|
|
339
|
+
| `uip tm objectlabel add` | Add labels to one or more objects. `--label-type` accepts `userLabel` only. |
|
|
340
|
+
| `uip tm objectlabel get` | Get the visible label rows (user, system, generated) for one object by `--object-id`, with label ids and label types. Internal labels are not returned. |
|
|
341
|
+
| `uip tm objectlabel remove` | Remove user and generated labels from multiple objects. The server keeps system labels (matched names are listed in `SkippedSystemLabels`) and internal label names are never sent (`SkippedInternalLabels` lists `--labels`: requested internal names; `--remove-all-labels`: user or generated labels sharing a name with an internal one), and `Result` is `Skipped` when nothing was removable. Names match case-insensitively; removed names are listed in `RemovedLabels`. `--remove-all-labels` removes the user and generated labels (except any sharing a name with an internal label), unlike the UI's clear-all, which also deletes internal labels. Reads the objects' labels first, so it needs read access to them and removes nothing when they cannot be read. Makes at least two read requests per object (more when an object has over 100 label names), five objects at a time, before writing. At most 100 object ids per call. |
|
|
342
|
+
|
|
343
|
+
### `prompts` — Prompt library
|
|
344
|
+
|
|
345
|
+
| Command | Description |
|
|
346
|
+
|---------|-------------|
|
|
347
|
+
| `uip tm prompts list` | List prompts in a project's prompt library, built-in samples included; filter by mode of use, name/description prefix, or creator. |
|
|
348
|
+
| `uip tm prompts get` | Get one prompt by `--name` (exact match) or `--prompt-id`. |
|
|
349
|
+
| `uip tm prompts create` | Add a prompt, with guidelines inline (`--guidelines`) or from a file (`--guidelines-file`). |
|
|
192
350
|
|
|
193
351
|
### `user` — User data
|
|
194
352
|
|
|
@@ -196,6 +354,12 @@ Success responses: `{ "Result": "Success", "Code": "...", "Data": ... }`. Errors
|
|
|
196
354
|
|---------|-------------|
|
|
197
355
|
| `uip tm user get` | Get data for the currently authenticated user. |
|
|
198
356
|
|
|
357
|
+
### `run` — Run a package's tests from CI
|
|
358
|
+
|
|
359
|
+
| Command | Description |
|
|
360
|
+
|---------|-------------|
|
|
361
|
+
| `uip tm run --type package` | Run every test in a package already uploaded to Orchestrator. `--package-version` takes an app version (`1.0`, runs its latest patch) or an exact version (refused if a newer patch of the same app version exists, since Test Manager always runs the latest). It waits for Test Manager to see the package, build a hidden test set, apply `--input-path` overrides, run it, re-run failed and cancelled tests (`--max-retries`), and write a JUnit or UiPath JSON report (`--format`, `--result-path`). Assertions are read only for tests that did not pass, unless `--include-passed-assertions` is set. One `--timeout` covers the whole command, retries included; waiting for Test Manager to index the package is also capped at 5 minutes. Exits 0 when every test passes, 1 when a test fails or the run is cancelled, 2 on a login or permission problem, 3 on a bad option or input, 4 on timeout. A timeout or other error after the tests started still writes the report, with unfinished tests marked skipped. A run fails rather than pass when Test Manager counts more tests than it has results for (`MissingResults`), and tests whose assertions could not be read are listed in `AssertionsNotRead`. The login token is refreshed during long runs. Each run leaves its hidden test set in the project; nothing deletes it yet, as with uipcli. Needs `--project-key` or `--project-id`. Made for CI, as the replacement for `uipcli test run`. |
|
|
362
|
+
|
|
199
363
|
### `wait` — Wait for execution
|
|
200
364
|
|
|
201
365
|
| Command | Description |
|
|
@@ -216,6 +380,9 @@ uip tm testcases create --project-key DEMO --name "Login smoke" --description "L
|
|
|
216
380
|
# Run a test set and wait for it to finish
|
|
217
381
|
uip tm testsets run --test-set-key DEMO:10 --wait
|
|
218
382
|
|
|
383
|
+
# CI: run every test in an uploaded package, retry failures, write JUnit
|
|
384
|
+
uip tm run --type package --project-key DEMO --package-name MyTests --package-version 1.0.3 --folder-path Shared --max-retries 2 --result-path ./results
|
|
385
|
+
|
|
219
386
|
# Download execution results as JUnit XML
|
|
220
387
|
uip tm result download --execution-id a1b2c3d4-0000-0000-0000-000000000001 --project-key DEMO --result-path ./junit.xml
|
|
221
388
|
|
|
@@ -5,7 +5,7 @@ compiled into its `dist/` output rather than installed alongside it.
|
|
|
5
5
|
Their licences and copyright notices are reproduced here in full, as
|
|
6
6
|
those licences require.
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
32 bundled dependencies:
|
|
9
9
|
|
|
10
10
|
- @playwright/test@1.61.1 — Apache-2.0
|
|
11
11
|
- bundle-name@4.1.0 — MIT
|
|
@@ -14,6 +14,7 @@ those licences require.
|
|
|
14
14
|
- default-browser@5.5.0 — MIT
|
|
15
15
|
- default-browser-id@5.0.1 — MIT
|
|
16
16
|
- define-lazy-prop@3.0.0 — MIT
|
|
17
|
+
- fflate@0.8.3 — MIT
|
|
17
18
|
- immediate@3.0.6 — MIT
|
|
18
19
|
- inherits@2.0.4 — ISC
|
|
19
20
|
- is-docker@3.0.0 — MIT
|
|
@@ -396,6 +397,36 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
|
|
|
396
397
|
|
|
397
398
|
---
|
|
398
399
|
|
|
400
|
+
## fflate@0.8.3
|
|
401
|
+
|
|
402
|
+
SPDX: MIT
|
|
403
|
+
|
|
404
|
+
```
|
|
405
|
+
MIT License
|
|
406
|
+
|
|
407
|
+
Copyright (c) 2026 Arjun Barrett
|
|
408
|
+
|
|
409
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
410
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
411
|
+
in the Software without restriction, including without limitation the rights
|
|
412
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
413
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
414
|
+
furnished to do so, subject to the following conditions:
|
|
415
|
+
|
|
416
|
+
The above copyright notice and this permission notice shall be included in all
|
|
417
|
+
copies or substantial portions of the Software.
|
|
418
|
+
|
|
419
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
420
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
421
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
422
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
423
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
424
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
425
|
+
SOFTWARE.
|
|
426
|
+
```
|
|
427
|
+
|
|
428
|
+
---
|
|
429
|
+
|
|
399
430
|
## immediate@3.0.6
|
|
400
431
|
|
|
401
432
|
SPDX: MIT
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import {
|
|
2
|
+
ATTACHMENT_OBJECT_TYPES,
|
|
3
|
+
toDeleteAttachmentRequest,
|
|
4
|
+
toDownloadAttachmentRequest,
|
|
5
|
+
toGetAttachmentByIdRequest,
|
|
6
|
+
toGetAttachmentsByObjectIdRequest,
|
|
7
|
+
toGetAttachmentsByObjectIdsRequest,
|
|
8
|
+
toUpdateAttachmentRequest,
|
|
9
|
+
toUploadAttachmentRequest,
|
|
10
|
+
toUploadTaggedAttachmentRequest
|
|
11
|
+
} from "./tool-2a68c3s5.js";
|
|
12
|
+
import {
|
|
13
|
+
UiPathTestManagementHubAttachmentAbstractionsEnumsAttachmentSource,
|
|
14
|
+
UiPathTestManagementHubAttachmentAbstractionsEnumsAttachmentType,
|
|
15
|
+
UiPathTestManagementHubAttachmentAbstractionsEnumsAttachmentUploadSource,
|
|
16
|
+
UiPathTestManagementHubCommonEnumsObjectType
|
|
17
|
+
} from "./tool-cpdm080k.js";
|
|
18
|
+
import"./tool-8b7p4csj.js";
|
|
19
|
+
import"./tool-1de529jm.js";
|
|
20
|
+
export {
|
|
21
|
+
ATTACHMENT_OBJECT_TYPES,
|
|
22
|
+
UiPathTestManagementHubAttachmentAbstractionsEnumsAttachmentSource as AttachmentSource,
|
|
23
|
+
UiPathTestManagementHubAttachmentAbstractionsEnumsAttachmentType as AttachmentType,
|
|
24
|
+
UiPathTestManagementHubAttachmentAbstractionsEnumsAttachmentUploadSource as AttachmentUploadSource,
|
|
25
|
+
UiPathTestManagementHubCommonEnumsObjectType as ObjectType,
|
|
26
|
+
toDeleteAttachmentRequest,
|
|
27
|
+
toDownloadAttachmentRequest,
|
|
28
|
+
toGetAttachmentByIdRequest,
|
|
29
|
+
toGetAttachmentsByObjectIdRequest,
|
|
30
|
+
toGetAttachmentsByObjectIdsRequest,
|
|
31
|
+
toUpdateAttachmentRequest,
|
|
32
|
+
toUploadAttachmentRequest,
|
|
33
|
+
toUploadTaggedAttachmentRequest
|
|
34
|
+
};
|
|
35
|
+
|
|
36
|
+
//# debugId=8AED24F541C40EDE64756E2164756E21
|