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

CI/CD integrations user guide

Last updated Apr 28, 2025

UiPath Run Tests

Application: Testing

Type: Post-Build task

UiPath Run tests is available in standard jobs and pipelines, and lets you:

  • Run an existing Test Set in Orchestrator.
  • Package, deploy and run test cases, by specifying the path to a UiPath test project.

After the test run has finished, the Test Result tab is published to the Jenkins build, showing the detailed results. Additionally, a JUnit test results file is created to the test result output path, when specified, or to the workspace root if not specified.

Depending on the result, the build is either marked as successful (all test cases are passed), or unstable (at least one test case failed).



Configuration

Job parameter

Description

Target

  • Specify an existing test set on UiPath Orchestrator (to execute test set).
  • Provide the project.json path of a UiPath Testing project (to execute test project).

Test result output path

The executed test set returns the test result as junit.xml. Specify the path where the result should be stored, relative to the Jenkins workspace directory (for example, result.xml).

Input Parameters

Define custom arguments for your test cases to override default values at the test set level. Through the arguments, you can set parameters to test cases at runtime. To define arguments, you need to publish a package with arguments.

Orchestrator address

The address of the Orchestrator instance onto which the package(s) will be deployed.

Orchestrator tenant

The Orchestrator tenant onto which the package(s) will be deployed.

Orchestrator folder

The folder to deploy to.

If the folder is a Classic folder, you will also need to set the environments field.
For Modern folders, setting the environments. is not required.
To input subfolders make sure to input both the parent folder name and the name of the subfolder. For instance, use AccountingTeam\TeamJohn.

Environments (Required for Classic folders)

The environment onto which the package will be deployed as a process. For the project and environment with existing processes, the processes will be updated to use the latest project version. Specify the environment onto which the package will be deployed as a process. For the project and environment with existing processes, the processes will be updated to use the latest project version.

Authentication

For authentication towards Orchestrator, you need to create credentials in Jenkins upfront. There are four options to authenticate:

(1) Authenticate to an on-premise Orchestrator using username and password.

(2) Authenticate to a cloud Orchestrator using a refresh token (API key).

(3) Authenticate to a cloud Orchestrator using external app authentication.

(4) Authenticate to an on-premise Orchestrator using .

Timeout (seconds)

The execution timeout for the test run. The default value is 7200 seconds. If the timeout exceeds before the execution on Orchestrator is finished and returns the result, the built will cancel and be marked as failed.

Trace logging level

Setting used to enable trace logging to one of the following levels:

  • None
  • Critical
  • Error
  • Warning
  • Information
  • Verbose. (The default is set to None).

    Useful for debugging purposes.

Pipeline example

pipeline {
  agent any
  environment {
    MAJOR = '1'
    MINOR = '0'
  }
  stages {
    stage ('PostBuild') {
      steps {
        UiPathTest (
          testTarget: [$class: 'TestSetEntry', testSet: "My Test Set"],
          orchestratorAddress: "OrchestratorUrl",
          orchestratorTenant: "tenant name",
          folderName: "folder name",
          timeout: "10000",
          traceLoggingLevel: 'None',
          testResultsOutputPath: "result.xml",
          credentials: [$class: 'UserPassAuthenticationEntry', credentialsId: "credentialsId"]
        )
      }
    }
  }
}pipeline {
  agent any
  environment {
    MAJOR = '1'
    MINOR = '0'
  }
  stages {
    stage ('PostBuild') {
      steps {
        UiPathTest (
          testTarget: [$class: 'TestSetEntry', testSet: "My Test Set"],
          orchestratorAddress: "OrchestratorUrl",
          orchestratorTenant: "tenant name",
          folderName: "folder name",
          timeout: "10000",
          traceLoggingLevel: 'None',
          testResultsOutputPath: "result.xml",
          credentials: [$class: 'UserPassAuthenticationEntry', credentialsId: "credentialsId"]
        )
      }
    }
  }
}
  • Configuration
  • Pipeline example

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2025 UiPath. All rights reserved.