uipath-test

UiPath Test Assistant

Manage UiPath Test Manager resources (projects, test cases, test sets, executions) and generate persona-tailored shareable test reports.

When to Use This Skill

• User wants to list, create, update, delete Test Manager projects, test cases, test sets, or executions
• User wants to view or analyse test execution results
• User wants to generate a shareable test report tailored to a QA engineer, developer, or release manager
• User asks about test coverage, regression trends, or failure rates
• User needs a go/no-go decision summary based on recent test executions
• User wants to triage a failed run — which cases failed, which assertion broke, which step it died on
• User asks whether a failure is a real regression or a flaky test (result history over past executions)
• User needs failure evidence — screenshots and logs pulled off the failed cases for a defect

Concepts

What is Testmanager?

UiPath Test Manager is a web application that manages the testing lifecycle of projects, enabling requirements traceability, test planning, and reporting. Its key business objects are:

• Requirements - Defines what needs to be tested.
• Test cases - Defines the scenarios to be tested. A testcase can have teststeps. A testcase can be executed or run directly.
• Test sets - Groups of test cases for execution.
• Test executions - When a test set or a test case is run, a test execution is created.
• Test case logs - Logs of a test case in an execution. A testcase can be navigated from testcaselogs.
• Test step logs — Step-level logs within a test case log.
• Test case log assertions - Assertion steps of a test case log in an execution.
• External (Playwright) test packages - A Playwright suite packaged as an external test package and uploaded to Orchestrator. Ingestion auto-creates one test case per Playwright test (no link step) and labels each with PW_Tag_*, PW_Project_*, PW_Suite_*, PW_File_*. These run on serverless cloud runtimes — see references/playwright-first-mile-guide.md.

CLI tool for UiPath Test Manager (uip tm). Use uip tm --help and uip tm <command> <subcommand> --help to discover commands and options. Always pass --output json on every uip command.

Commands

Common uip tm commands organized by resource type.

Project Commands

Get folder keys with uip or folders list -n <name> --all --output json — returns all folders visible to the current user.

Requirements Commands

Test Cases Commands

Flag shapes for test case and step identifiers — do not interchange:

• --test-case-id <UUID> — used by run, steps list, steps add, list-result-history. Get the UUID from uip tm testcases list --output json (Id field).
• --test-case-key <PROJECT_KEY:NUMBER> — singular, used by update, delete, link-automation, unlink-automation, list-testsets. Example: DEMO:1.
• --test-case-keys <KEY1,KEY2,...> — plural, comma-separated, used by testcases add and testcases remove for bulk membership changes on a test set.
• --step-id <UUID> — used by all steps subcommands except list and add. Get the UUID from steps list (Id field).

Test Sets Commands

Keys use the format PROJECT_KEY:NUMBER (e.g., INV:42). To add or remove test cases in a test set, use uip tm testcases add / uip tm testcases remove — those verbs live under the testcases group, not under testsets.

Playwright test sets: --playwright-projects <names...> (space-separated, case-sensitive playwright.config project names) runs only the selected projects and persists the selection on the test set. It requires every test case in the set to come from one Playwright package; unknown names fail fast listing the valid ones. Probe first with playwright-context and branch on IsPlaywright. Both need a Test Manager with Playwright support and a CLI carrying the external-package commands — references/playwright-first-mile-guide.md opens with the check to run and what to do when they are absent.

Executions Commands

run lives under three groups, all distinct:

• uip tm testcases run — start a new execution for one or more test cases (--test-case-id UUIDs, space-separated).
• uip tm testsets run — start a new execution for an entire test set (--test-set-key).
• uip tm executions run — re-run an existing execution by --execution-id, optionally narrowed to specific --test-case-log-ids.

Test Case Log Commands

Test Step Log Commands

Report Commands

Attachment Commands

Result Commands

Pack Commands (Playwright)

Packing is offline — no auth needed. The upload → ingestion → label-fill → run pipeline is in references/playwright-first-mile-guide.md.

Wait Commands

User Commands

Custom Field Commands

Custom fields are project-scoped field definitions you attach to Requirement, TestCase, or TestSet objects. The top-level customfield commands manage these definitions. The nested label and value subgroups operate on the per-object rows that fill in those fields. The --object-type flag is case-sensitive and accepts only Requirement, TestCase, or TestSet. The --data-type flag accepts only Text or Label (also PascalCase).

Custom Field — Label-type rows

All customfield label verbs require --object-type <Requirement\|TestCase\|TestSet>.

Custom Field — Text-type rows

All customfield value verbs require --object-type <Requirement\|TestCase\|TestSet>. create additionally requires --data-type <Text\|Label> (must match the field's definition).

Object Label Commands

Object labels are tag-style metadata applied to Requirement, TestCase, TestSet, TestExecution, TestCaseLog. Use --object-type for the parent kind and --object-ids for the target objects.

Critical Rules

1. Always check login first — run uip login status --output json before any Test Manager operation. If not authenticated, run uip login to sign in.
2. Always pass --output json to every uip command — no exceptions. Structured JSON output is what you need to reason about results reliably, even when you only plan to summarize them back to the user.
3. Cap retries at 3 for any failing uip CLI command. After 3 failures, stop and report the error to the user (see Rule — never fall back to direct REST APIs).
4. Handle empty results — if a list command returns an empty array, stop and inform the user rather than proceeding with a null key. Exception: a zero-result tm testcases list --filter call may be a prefix miss rather than a truly empty dataset — apply Rule 8's prefix fallback to disambiguate; stop only when the fallback also finds nothing. Filtered lookups on other resources (project, customfield) returning empty are real empty results — stop as usual.
5. Confirm before delete — always confirm the target resource key with the user before running any delete command — unless the user already authorized this exact delete. All delete commands require --yes (or -y) to proceed; omitting it exits without deleting.
6. For operations requiring folder key — use uip or folders list -n <folder-name> --all --output json when the user named a folder; when picking one yourself, list without --all so you only get folders you are a member of (run /uipath-platform for folder management details).
7. Discover before assuming — never guess automation names, folder keys, project IDs, or test case keys. Always run the matching list command first (e.g., uip tm testcases list-automations, uip or folders list -n <folder-name> --all).
8. Narrow list calls server-side when the user names an entity. When the user provides a name, key, label, or tag, check uip tm <resource> list --help (or uip or <resource> list --help) for the narrowing flag the command exposes and pass it on the list call. Never list all results and filter client-side — it wastes tokens and misses paginated entries. Applies to every entity across uip tm and uip or. Exception: tm testcases list --filter matches by prefix. A mid-name term returns zero — retry --filter with a broader name prefix from context; re-list without --filter only when no workable prefix exists, paging through ALL results (--limit/--offset) before concluding the target is absent.
9. run needs a default Orchestrator folder — set one only on the exact missing-folder error. uip tm testcases run and uip tm testsets run both require a default folder on the project. Attempt the run first and match the failure text exactly: a project with no default folder fails with "Message": "HTTP 400: Please assign folder to project level before executing testcases." (errorCode: itemNotFound). Only on that error, set one with uip tm project set-default-folder --project-key <PROJECT_KEY> --folder-key <FOLDER_KEY> --output json, then retry once. Get folder keys with uip or folders list -n <folder-name> --all --output json. Do NOT treat other errors as folder problems: an unusable default folder surfaces as an opaque HTTP 5xx on the run, and set-default-folder with a nonexistent folder key fails with "HTTP 400: Internal Server Error." (errorCode: unknown) — both stop under Rule 10 rather than triggering a folder overwrite. Never overwrite a default folder that is already working — an arbitrary folder picked off or folders list may be one Test Manager rejects, breaking every subsequent run on that project. This recovery is the one named run exception to Rule 10; any other run failure still stops.
10. On any uip command failure or ambiguity, STOP and ask the user — do NOT fall back to direct REST API calls. When a uip command errors, returns malformed output, or the right flag/value is unclear (e.g., multiple matching entities, missing identifier, unexpected schema), interrupt and ask the user before proceeding. This overrides any instinct to "try the underlying API instead." Two exceptions, both expected outcomes rather than faults, each identified by its exact error: (a) a run failing with "HTTP 400: Please assign folder to project level before executing testcases." — the missing-default-folder signal; set the folder per Rule 9 and retry once. (b) uip tm wait exiting with code 2 and "Timed out after <N>s waiting for execution '<EXECUTION_ID>'. Last status: <status>." — the bounded --timeout working as designed; report the non-finish and carry on with the remaining steps. Other wait failures (Polling failed/interrupted/aborted ..., exit code 1) are real faults, not timeouts. Every other failure still stops here.

Quick Start

Verify authentication

uip login status --output json

If not authenticated, run uip login to sign in.

Set the active tenant (if needed)

uip login tenant set <TENANT_NAME> --output json

For more authentication details, run /uipath-platform.

Confirm project scope

Ask the user for the project name or key before any Test Manager call. For multi-project scenarios, collect ALL names or keys in one prompt. Resolve each to a PROJECT_KEY:

uip tm project list --filter <NAME_OR_KEY> --output json

Zero matches → stop and ask the user. Multiple matches → list candidates and ask the user to pick. Reuse the confirmed PROJECT_KEY for every downstream command.

  # Get project
  uip tm project list --filter <PROJECT_NAME_OR_KEY> --output json

  # List test sets in a project
  uip tm testsets list --project-key <PROJECT_KEY> --filter <TEST_SET_NAME_OR_KEY> --output json

  # List test cases assigned to a test set
  uip tm testsets list-testcases --project-key <PROJECT_KEY> --test-set-key <TEST_SET_KEY> --output json

  # List recent executions for a test set
  uip tm executions list --project-key <PROJECT_KEY> --test-set-id <TEST_SET_ID> --limit 100 --output json

  # List test case logs for an execution (nested subcommand under `executions`)
  uip tm executions testcaselogs list --execution-id <EXECUTION_ID> --project-key <PROJECT_KEY> --output json

  # List assertions of a test case log
  uip tm testcaselog list-assertions --project-key <PROJECT_KEY> --test-case-log-id <TEST_CASE_LOG_ID> --output json

  # List step-level logs of a test case log
  uip tm teststeplog list --project-key <PROJECT_KEY> --test-case-log-id <TEST_CASE_LOG_ID> --output json

Troubleshooting

If a command fails unexpectedly:

1. Verify the command syntax: uip tm <command> --help
2. Check authentication: uip login status --output json

Navigate to a workflow

Anti-patterns

• Do NOT proceed if authentication fails — all Test Manager API calls require a valid bearer token. Fail fast rather than surfacing confusing 401 errors later.
• Do NOT guess command names — verb-noun composites are required. The CLI uses explicit verb-noun forms; bare verbs do not exist. Confirm with uip tm <resource> --help --output json.
• Do NOT link-automation Playwright test cases. Playwright ingestion links them to the package automatically; the manual link step belongs to the Studio/RPA pipeline only.