cicd-integrations
2023.10
false
  • Overview
    • About CI/CD pipelines
  • UiPath CLI
    • About UiPath CLI
    • Downloading UiPath CLI
    • Compatibility matrix
    • Running UiPath CLI
    • Managing NuGet feeds
  • Azure DevOps extension
  • Jenkins plugin
UiPath logo, featuring letters U and I in white

CI/CD integrations user guide

Last updated Apr 28, 2025

Testing a package or running a test set

Prerequisites:

  • Create a package or a test set.
  • Run the CLI exe (for Windows) or dll (for Linux) file.
  • Add the required Orchestrator API access application scopes.

To test a package, take the following steps:

  1. Run the test task, using uipcli test. You can see a list of the available sub-tasks.
  2. Specify the required parameters and run the run sub-task.

    See the list of parameters below.

    Parameter

    Description

    -P, or --project-pathThe path to the Testing package file that you want to test.
    -s, or --testset

    The name shown for the Test Set you wish to execute. Ensure that the Test Set includes the most recent version of the Test Cases.If the Test Set isn't in the default folder, make sure to include the relevant folder name before it. For instance, use AccountingTeam\TestSet.

    --outThe type of the result file <junit|uipath>.
    -r, or --result_pathThe destination path of the file where you want to store the results.
    -e, or --environment (Required for classic folders) The environment where you want to deploy the package. You must pair it with the project path.
    -w, or --timeoutThe time (in seconds) that you want to wait for the Test Set to execute. The default value is 7200 seconds.
    -i, or --input_path (Required if the entry-point workflow has input parameters that you want to pass through the command line) The full path to a JSON input file.
    --attachRobotLogsAttaches Robot Logs for each executed Test Case, and a JUnit Test Report.

    --repositoryUrl

    The repository URL where the project is versioned.

    --repositoryCommit

    The repository commit where the project was built from.

    --repositoryBranch

    The repository branch where the project was built from.

    --repositoryType

    VCS system repository type.

    --projectUrl

    Automation Hub idea URL.

    --releaseNotesAdd release notes.
    --disableBuiltInNugetFeedsDisable built-in nuget feeds.

    --retryCount

    Number of retries for failed test cases.

    -u, or --username (Required if you use Basic Authentication, through a username and a password)

    The username used for authenticating to Orchestrator. You must pair it with the corresponding password.

    -p, or --password (Required if you use Basic Authentication, through a username and a password)

    The password used for authenticating to Orchestrator. You must pair it with the corresponding username.

    -t, or --token (Required if you use token-based authentication)

    The OAuth2 refresh token used for authenticating to Orchestrator. You must pair it with the Account Name and Client ID.

    -a, or --accountName (Required if you use token-based authentication)

    The Orchestrator CloudRPA account name. You must pair it with the OAuth2 refresh token and Client ID.

    -A, --accountForApp

    The Orchestrator CloudRPA account name(organization name). You must pair it with the Application ID, Application Secret, and Application scope for external application.

    -I, or --applicationId (Required if you use external application authentication)

    The external Application ID. You must pair it with the Application Account, Application Secret, and Application scope.

    -S, or --applicationSecret (Required if you use external application authentication)

    The external Application Secret. You must pair it with the Application Account, Application ID, and Application scope.

    --applicationScope (Required if you use external application authentication)

    The list of application scopes, separated by single spaces. You must pair it with the Application Account, Application ID, and Application Secret for external application

    -o, or --organizationUnit

    The Orchestrator folder where you want to execute the Test Sets.

    -l, or --language

    The language used in the Orchestrator user interface.

    -y, or --disableTelemetry

    Disable telemetry data.

    --traceLevel

    Display the trace of the events.

    --identityURL (Required for PaaS deployments only)

    The URL of your identity server.

    --help

    Displays the parameters and examples for this command.

    --version

    Display version information.

    Orchestrator URL (pos. 0) (Required) The URL of the Orchestrator instance.

    Orchestrator Tenant (pos. 1)

    • (Required) for SaaP deployments.
    • (Optional) for PaaS deployments.
    		The tenant inside which the package, or Test Set are.

Usage:

test run <orchestrator_url> <orchestrator_tenant> [-i <input_path>] [-P <package>] [-s <testset>] [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <account_for_app> -I <application_id> -S <application_secret> --applicationScope] [-e <environment>] [-o <folder_organization_unit>] [-l <language>]test run <orchestrator_url> <orchestrator_tenant> [-i <input_path>] [-P <package>] [-s <testset>] [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <account_for_app> -I <application_id> -S <application_secret> --applicationScope] [-e <environment>] [-o <folder_organization_unit>] [-l <language>]

Examples:

  • test run "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json"

  • test run "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -I "76000552-3e4f-4590-9317-cdb420001f1d" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" --identityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json"

  • test run "https://automation-suite.base.url.com/" "TenantName" -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json"

  • test run "https://cloud.uipath.com/" "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json

  • test run "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json" --out junit

  • test run "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json" --out uipath

Was this page helpful?

Support and Services
Get The Help You Need
UiPath Academy
Learning RPA - Automation Courses
UiPath Forum
UiPath Community Forum
Uipath Logo White
Trust and Security
Terms of Use
Privacy Policy
Cookies Policy
© 2005-2025 UiPath. All rights reserved.