- Overview
- UiPath CLI
- Azure DevOps extension
- Jenkins plugin
CI/CD integrations user guide
Testing a package or running a test set
Prerequisites:
- Create a package or a test set.
- Run the CLI
exe(for Windows) ordll(for Linux) file. - Add the required Orchestrator API access application scopes.
To test a package, take the following steps:
- Run the
testtask, usinguipcli test. You can see a list of the available sub-tasks. - Specify the required parameters and run the
runsub-task. See the list of parameters below.
| Parameter | Description |
|---|---|
-P , or --project-path | The path to the Testing package file that you want to test. |
--projectKey | The project key displayed in Test Manager > Dashboard tab > Projects > All projects. The project key is the prefix for all object keys. Required when using Test Manager. |
--testsetkey | The Test Set key displayed in Test Manager > Test Sets tab > Key column. Ensure that the Test Set includes the most recent version of the Test Cases. If the Test Set is not in the default folder, make sure to include the relevant folder name before it. For instance, use AccountingTeam\TestSet. |
-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. |
--out | The type of the result file <junit|uipath>. |
-r , or --result_path | The 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 --timeout | The 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. |
--attachRobotLogs | Attaches Robot Logs for each executed Test Case, and a JUnit Test Report. |
|
| The repository URL where the project is versioned. |
|
| The repository commit where the project was built from. |
|
| The repository branch where the project was built from. |
|
| VCS system repository type. |
|
| Automation Hub idea URL. |
--releaseNotes | Add release notes. |
--disableBuiltInNugetFeeds | Disable built-in nuget feeds. |
|
| 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. When using Test Manager, include: |
-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. |
|
| Display the trace of the events. |
--identityURL ( Required for PaaS or MSI deployments) | The URL of your identity server. |
|
| Displays the parameters and examples for this command. |
|
| Display version information. |
Orchestrator URL (pos. 0) ( Required ) | The URL of the Orchestrator instance. |
|
| 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:
Orchestrator testing:
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.jsontest run "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json" --out junittest 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
Test Manager testing:
test run "https://cloud.uipath.com/" "TenantName" --projectKey "MyTestProject" --testsetkey "MyTestSet" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S "********" --applicationScope "OR.Folders OR.Execution TM.Projects TM.TestSets TM.TestExecutions OR.Assets OR.BackgroundTasks OR.Robots.Read OR.Machines.Read OR.Jobs OR.TestSets OR.TestSetExecutions OR.Monitoring OR.Settings.Read" -o "FolderName" --out "junit" --result_path "C:\TestResults"test run "https://cloud.uipath.com/" "TenantName" --projectKey "MyTestProject" -P "C:\userprofile\AutomationProjectWithTestCases\project.json" -e "TestEnvironment" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S "********" --applicationScope "OR.Folders OR.Execution TM.Projects TM.TestSets TM.TestExecutions OR.Assets OR.BackgroundTasks OR.Robots.Read OR.Machines.Read OR.Jobs OR.TestSets OR.TestSetExecutions OR.Monitoring OR.Settings.Read" -o "FolderName" --out "uipath" --result_path "C:\TestResults"
For more details on using Test Manager with UiPath CLI, see Testing a package or running a test set in Test Manager.
