通知を受け取る

UiPath Test Suite

UiPath Test Suite

ジョブのタスク

概要


パイプラインはさまざまなステージで構成されているため、複数のジョブに分類できます。ジョブごとに、UiPath Integration for Azure DevOps に含まれる UiPath タスクを含むステップを構成することができます。

前提条件


To prepare your environment, see Azure DevOps extension prerequisites.

考慮事項


パイプラインでタスクの実行を開始する前に、以下のことを考慮に入れておいてください。

  • UiPath タスクは Windows ベースのビルド エージェントでのみ実行する必要があります。
  • Configure UiPath Orchestrator service connection.
  • テスト機能には、Orchestrator バージョン 2020.4 以上が必要です。
  • Orchestrator のオンプレミス バージョンを HTTPS で使用する場合は、SSL 証明書をインポートして、Orchestrator への HTTPS 呼び出しが信頼できることを確認します。

パイプライン エージェント プールに UiPath タスクを追加する


パイプラインでオートメーション手順を定義するには、個々のタスクをエージェント プールに追加して設定する必要があります。

  1. Azure DevOps で [Pipelines] に移動します。
  2. 新しいパイプラインを作成するか、既存のパイプラインを編集します。
  3. エージェント プールにジョブを追加します。
  4. 次のいずれかのタスクを検索します。
  5. [Add] をクリックして、タスクを設定します。
  6. 必要に応じてエージェント プール内のタスクを再配置して、パイプラインを保存します。
12281228

UiPath のジョブを実行


このタスクを使用して、Orchestrator インスタンスに既にデプロイされているプロセスを実行できます。
For more information, see Processes and Jobs.

構成

以下の表を使用して、[UiPath のジョブを実行] の入力を設定します。

Input

Description

Display name (Required)

Enter a name for your task.

Orchestrator connection (Required)

Configure the service connection to access UiPath Orchestrator services. You can configure a connection only for this step or use an existing global connection.

For more information, see Configuring UiPath Orchestrator service connection.

Process (Required)

The process is the package version that is linked to a particular folder type. You need to configure this input based on the type of folder on which the process is deployed.

For modern folders, the input is the name of the process that's listed in the Processes tab. To find out the process name, you can open Orchestrator, open your folder, and navigate to Automations > Processes.

For classic folders (deprecated), the input is the name of the process name, followed by and underscore, and then the environment name, where the Robots are hosted.

As an example for this naming convention, consider the following variables:
The name of the process isTestAutomation.
The name of the environment is Production.

Your process name for this input is TestAutomation_Production.

Related articles:

Input parameters

Specify the file path to a JSON input file, such as Input\jobParameters.json.

Priority

Select the priority of the job execution if you want to set a specific order at the process level. By default, this input is set to Normal.

Orchestrator folder (Required)

Specify the folder where the process is being deployed. For classic folders, you can use specific robot names. For modern folders, you can use specific user and machine names.

Strategy

Specify the execution strategy for dynamic allocation or robot-specific.

For dynamically allocated jobs, the process is executed under the account and machine that is available.
Alternatively, you can choose robot-specific jobs.

Job Type

Available only on modern folders.

Choose the license model of the runtime under which the job is to be executed.

For more information, see Robot licensing.

No. of jobs

Available only for dynamic allocation strategy.

Specify the number of times you want to run this task. By default, this input is set to 1.

User

Available only on modern folders alongside a dynamic allocation strategy.

Add the machine username. For example, a local user for this input is MachineName\UserName.

Machine

Available only on modern folders alongside a dynamic allocation strategy.

The name of the machine that runs the execution.

Output

The results are collected in a JSON file. You need to specify the path of the job results (e.g., Output\testResults.json). If you leave this input blank, the default output is sent to the artifact staging directory under the following name UiPathResults.json.

Timeout

Specify the number of seconds to wait before the request times out.

Fail task when job fails

Select this input if you want to set the task as failed when at least one job failed. This input is selected by default.

Wait for job completion

Wait for job run completion. This input is selected by default.

Trace Level

Select the logging level from the dropdown list.

robotsIds

Comma-separated list of specific robot names.

783783

YAML パイプライン

[UiPath のジョブを実行] の完全に解析された YAML ドキュメントをプレビューできます。

クリックして、YAML パイプラインをプレビューします。
- task: [email protected]
  displayName: 'Start ProcessProject'
  inputs:
    #orchestratorConnection: 'service-connection-name' # Service connection to UiPath Orchestrator
    #processName: 'ProccessProject_CI-Pipeline' # The name of the process
    #parametersFilePath: 'Input\\jobParameters.json' # json file with input values if the process requires them
    #priority: 'Low' # Options 'Low', 'Normal', 'High'
    #folderName: 'MyFolder' # Specify the folder to deploy to. For clasic folders, you can use specific robot names. For modern folders, you can use specific user and machine names.
    #strategy: 'Dynamically' # Options 'Specific', 'Dynamically'
    #jobCount: 1 # The number of job runs. (default 1) - used if strategy is 'Dynamically'
    #user: 'MyUser'
    #machine: 'machine'
    #robotsIds: 'robot1, robot2'
    #resultFilePath: 'Output\\testResults.json'
    #timeout: 3600
    #failWhenJobFails: false
    #waitForJobCompletion: false,
    #traceLevel: 'None' # Options: Critical, Error, Warning, Information, Verbose, None

UiPath のアセットを管理


このタスクを使用して、Orchestrator インスタンスのアセットをデプロイ、更新、削除できます。

次のアセットの種類がサポートされています。

  • Text - 文字列のみ格納します (引用符を追加する必要はありません)。
  • Boolean - true または false の値をサポートします。
  • Integer - 整数値のみ格納します。
  • Credential - contains usernames and passwords that the Robot requires to execute particular processes. For this asset type, you need to encode the username and password by using :: to separate the two fields.

アセットをデプロイするには、次の例のように、UTF-8 でエンコードされた CSV ファイルに追加する必要があります。
name,type,value, description asset_1_name,text,asset_value, asset_2_name,integer,123,asset_3_name,boolean,false, this is an asset description asset_4_name,credential,"username::password",

For more information, see Orchestrator Assets.

構成

以下の表を使用して、[UiPath のアセットを管理] の入力を設定します。

Argument

Description

Display name (Required)

Enter a name for your task.

Orchestrator connection (Required)

Configure the service connection to access UiPath Orchestrator services. You can configure a connection only for this step or use an existing global connection.

For more information, see Configuring UiPath Orchestrator service connection.

Orchestrator folder (Required)

Specify the folder where the process is being deployed. For classic folders, you can use specific robot names. For modern folders, you can use specific user and machine names.

Choose asset action (Required)

Select an option from the dropdown list.

Assets CSV File (Required)

Add the CSV file path. You can use the same file for both Deploy and Update asset actions.

Considerations:
• The usage of quotes within values is allowed (e.g., ""A new version of RPA REPORT – AM Email Quote to Agent is available"").
• JSON values are supported (e.g., "{""MaxRetryNumber"":3 ,""Name"":My Test Process}").
• Comments are not supported (e.g.asset_1_name,credential,""username::password"" # asset_1_description comment).

For Delete asset actions, use only the name column and leave the other columns empty.

(Optional) You can set a description for each asset using the following syntax: type, value , description.

Trace Level

Select the logging level from the dropdown list.

928928

YAML パイプライン

[UiPath のアセットを管理] の完全に解析された YAML ドキュメントをプレビューできます。

クリックして、YAML パイプラインをプレビューします。
- task: [email protected]
  displayName: 'Deploy/Update assets'
  inputs:
    #orchestratorConnection: 'service-connection-name' # Service connection to UiPath Orchestrator
    #assetActionType: 'Deploy' # Options: Deploy, Delete
    #csvFile: 'assets_deploy.csv' # the path to the csv file containing the assets description,
    #traceLevel: 'None' # Options: Critical, Error, Warning, Information, Verbose, None

UiPath の Nuget パッケージをパブリッシュ


この UiPath タスクでは、既存の UiPath プロジェクトを NuGet パッケージ化できます。

構成

以下の表を使用して、[UiPath の NuGet パッケージをパブリッシュ] の入力を設定します。

Argument

Description

Display name (Required)

Enter a name for your task.

Choose versioning method (Required)

You can select an automatically generated version, use the project version, or define a new version.

For more information, see Package Versions.

Version (Required)

Available only on modern folders alongside a dynamic allocation strategy.

Specifying the package version provides the possibility of tracking the built packages and their source versioning more efficiently. For example, the Microsoft assembly pattern can be utilized to build the NuGet package version: [Major].[Minor].[BuildNumber].[RevisionNumber].

Project(s) Path (Required)

Select the location of the project that is going to be packaged. It can be a direct path to a project.json file or a directory with one or multiple projects. In the latter case, each level one project is packaged individually.

Choose output type (Required only for manual versioning)

Set a project type for the project that is going to be packaged. If you set None, the project type is going to be extracted from the project's JSON file.

The following project types are supported: 'Process', 'Library', 'Tests', 'Objects', 'None'.

Orchestrator connection (Required)

Configure the service connection to access UiPath Orchestrator services. You can configure a connection only for this step or use an existing global connection.

For more information, see Configuring UiPath Orchestrator service connection.

Output Path

Set a folder path where the package is going to be placed.

Run workflows analysis

Select this option to run workflow analysis rules on your automation project (e.g., Fail jobs in case of errors). By default, this option is not activated.

For more information, see Application Testing Workflow Analyzer Rules.

Trace Level

Select the logging level from the dropdown list.

946946

YAML パイプライン

[UiPath の NuGet パッケージをパブリッシュ] の完全に解析された YAML ドキュメントをプレビューできます。

クリックして、YAML パイプラインをプレビューします。
- task: [email protected]
  inputs:
    #versionType: AutoVersion # Options: AutoVersion, CurrentVersion, ManualVersion 
    #version: '1.0.0' # Required when versionType == ManualVersion
    #projectJsonPath: '$(Build.SourcesDirectory)\MyFirstProcess'
    #outputPath: '$(Build.ArtifactStagingDirectory)\Packages\MyFirstProcess'
    #outputType: 'None' # Options: Process, Library, Tests, Objects, None
    #runWorkflowAnalysis: 'False'
    #orchestratorConnection: 'service-connection-name' # Service connection to UiPath Orchestrator,
    #traceLevel: 'None' # Options: Critical, Error, Warning, Information, Verbose, None

UiPath の NuGet パッケージをデプロイ


[UiPath の NuGet パッケージをデプロイ] タスクでは、UiPath Orchestrator に UiPath の NuGet パッケージをデプロイできます。

🚧

重要

お使いのネットワークで、以下の NuGet パッケージ フィードへのアクセスが許可されていることを確認してください。

構成

以下の表を使用して、[UiPath の NuGet パッケージをデプロイ] の入力を設定します。

Argument

Description

Display name (Required)

Enter a name for your task.

Orchestrator connection (Required)

Configure the service connection to access UiPath Orchestrator services. You can configure a connection only for this step or use an existing global connection.

For more information, see Configuring UiPath Orchestrator service connection.

Package(s) (Required)

Define the feed for your UiPath NuGet packages.

Automatically create process

Select this option if you want to deploy a package without creating a process. The option is selected by default.

If selected, you need to configure the Entry Point Path parameter.

Orchestrator folder (Required)

Specify the folder where the process is being deployed. For classic folders (deprecated), you can use specific robot names. For modern folders, you can use specific user and machine names.

Environment

(Optional) If you use classic folders (deprecated), you need to define the environment where the packages are going to be deployed. You can use this field to create or update packages.

You can use the following example to add your environments to this field, separated by a comma: testingEnvironment, productionEnvironment.

Entry Point Path(s) (Required)

Specify entry point paths to create or update a process. The entry point path specifies the file path starting from the root of the project.

Before configuring the entry point paths, consider the following:
Entry points are available for Orchestrator version 21.4 or higher (e.g. 21.4.UiPathDeploy.entryPoints). For Orchestrator versions lower than 21.4, you need to enter any value, as the field must not remain empty.
The default entry point is set to Main.xaml.
Multiple entrypoints can be specified as 'Main.xaml, EntryPoint2.xaml '.
For classic folders (deprecated) you can specify only one entry point for each environment.
For nested folders you need to specify the file path, as follows:
Folder01/Folder02/Main.xaml or Folder01/Folder02/Entrypoint.xaml

For more information, see Orchestrator Entry Points.

Trace Level

Select the logging level from the dropdown list.

862862

YAML パイプライン

[UiPath の NuGet パッケージをデプロイ] の完全に解析された YAML ドキュメントをプレビューできます。

クリックして、YAML パイプラインをプレビューします。
- task: [email protected]
  inputs:
    #orchestratorConnection: # Service connection to UiPath Orchestrator
    #packagesPath: '$(Build.ArtifactStagingDirectory)\Packages\ITAutomationProcess'
    #folderName: 'ITAutomation'
    #environments: 'AutomationRobots' # Optional,
    #traceLevel: 'None' # Options: Critical, Error, Warning, Information, Verbose, None

UiPath のテストを実行


Typically, the UiPath Test task runs an existing test set on Orchestrator. Additionally, you can use it to pack, deploy, and run test cases by specifying the path to a UiPath test project. The latter option shows up in Orchestrator as a transient test set.

タスクの実行が終了すると、テスト結果が Azure DevOps の [Test] タブにアップロードされます。テスト結果の出力パスを JUnit 形式で指定できます。

結果に基づき、ビルドは成功 (すべてのテスト ケースが成功) または失敗 (少なくとも 1 つのテスト ケースが失敗) とマークされます。

構成

以下の表を使用して、[UiPath のテストを実行] の入力を設定します。

Argument

Description

Display name (Required)

Enter a name for your task.

Choose a test execution method

Choose the test that you want to execute:
Execute test set: Specify and run an existing test set in Orchestrator.
Execute tests in project: Specify a project, deploy the package and run the test cases as part of a transient test set.

Orchestrator connection (Required)

Configure the service connection to access UiPath Orchestrator services. You can configure a connection only for this step or use an existing global connection.

For more information, see Configuring UiPath Orchestrator service connection.

Input parameters

Specify the file path to a JSON input file, such as Input\jobParameters.json.

Specify the type argument if you're creating new input arguments at the Test Set level. Otherwise, you can use name and value.

Test set (Required for Execute test set method)

Specify the name of your Orchestrator test set.

Test project path (Required for Execute tests in project method)

Specify the test project location that is going to be executed as part of a transient test set.

Environment (Required for Execute tests in project method)

If you use classic folders (deprecated), you need to define the environment where the packages are going to be deployed. You can use this field to create or update packages.

You can use the following example to add your environments to this field, separated by a comma: testingEnvironment, productionEnvironment.

Orchestrator folder (Required)

Specify the folder where the process is being deployed. For classic folders (deprecated), you can use specific robot names. For modern folders, you can use specific user and machine names.

Test results output path

Specify the test results output path in JUnit format (e.g., Output\testResults.json).

Timeout

Specify the number of seconds to wait before the request times out.

Trace Level

Select the logging level from the dropdown list.

Attach Robot Logs

Select this option to attach INFO level logs from the executing Robot. By default, this is unselected.

For more information, see Robot Logs.

936936

YAML パイプライン

[UiPath のテストを実行] の完全に解析された YAML ドキュメントをプレビューできます。

クリックして、YAML パイプラインをプレビューします。
-- task: [email protected]
  inputs:
    #testTarget: TestProject # Options: TestProject, TestSet
    #orchestratorConnection: # Service connection to UiPath Orchestrator
    #testProjectPath: '$(Build.SourcesDirectory)\MobileAutomationTests' # Required only when testTarget = TestProject
    #testSet: 'MobileAutomationTests' # Required only when testTarget = TestSet
    #folderName: 'MobileAutomationTesting'
    #environment: 'TestingRobots' # Required only when testTarget = TestProject and the folder is a classic folder
    #testReportDestination: '$(Build.ArtifactStagingDirectory)\report.xml' # Optional
    #timeout: 200 # Optional, default = 3600s,
    #traceLevel: 'None' # Options: Critical, Error, Warning, Information, Verbose, None task: [email protected]
  inputs:
    #testTarget: TestProject # Options: TestProject, TestSet
    #orchestratorConnection: # Service connection to UiPath Orchestrator
    #testProjectPath: '$(Build.SourcesDirectory)\MobileAutomationTests' # Required only when testTarget = TestProject
    #testSet: 'MobileAutomationTests' # Required only when testTarget = TestSet
    #folderName: 'MobileAutomationTesting'
    #environment: 'TestingRobots' # Required only when testTarget = TestProject and the folder is a classic folder
    #testReportDestination: '$(Build.ArtifactStagingDirectory)\report.xml' # Optional
    #timeout: 200 # Optional, default = 3600s,
    #traceLevel: 'None' # Options: Critical, Error, Warning, Information, Verbose, None- task: [email protected]
  inputs:
    #testTarget: TestProject # Options: TestProject, TestSet
    #orchestratorConnection: # Service connection to UiPath Orchestrator
    #testProjectPath: '$(Build.SourcesDirectory)\MobileAutomationTests' # Required only when testTarget = TestProject
    #testSet: 'MobileAutomationTests' # Required only when testTarget = TestSet
    #folderName: 'MobileAutomationTesting'
    #environment: 'TestingRobots' # Required only when testTarget = TestProject and the folder is a classic folder
    #testReportDestination: '$(Build.ArtifactStagingDirectory)\report.xml' # Optional
    #timeout: 200 # Optional, default = 3600s,
    #traceLevel: 'None' # Options: Critical, Error, Warning, Information, Verbose, None

23 日前に更新


ジョブのタスク


改善の提案は、API リファレンスのページでは制限されています

改善を提案できるのは Markdown の本文コンテンツのみであり、API 仕様に行うことはできません。