CICD 連携 - Test Manager でパッケージをテストまたはテストセットを実行する

cicd-integrations

2023.10

false

CI/CD 連携ユーザーガイド

概要
- CI/CD パイプラインについて
UiPath CLI
- UiPath CLI について
- UiPath CLI をダウンロードする
- 相互運用性マトリクス
- UiPath CLI を実行する
- NuGet フィードを管理する
- UiPath CLI タスクを実行する
  - UiPath CLI タスクについて
  - Orchestrator からアセットを削除する
  - Orchestrator にアセットをデプロイする
  - Orchestrator 内でジョブを実行する
  - プロジェクトを分析する
  - Orchestrator にパッケージをデプロイする
  - プロジェクトをパッケージ化する
  - パッケージをテストするか、テストセットを実行する
  - Test Manager でパッケージをテストする、またはテストセットを実行する
  - 入力パラメーター JSON 形式
Azure DevOps 拡張機能
Jenkins プラグイン

重要 :

このコンテンツの一部は機械翻訳によって処理されており、完全な翻訳を保証するものではありません。新しいコンテンツの翻訳は、およそ 1 ～ 2 週間で公開されます。

Test Manager でパッケージをテストする、またはテストセットを実行する

Test Manager と UiPath CLI を使用して、UiPath パッケージをテストするか、テストセットを実行します。

Test Manager でパッケージをテストする、またはテストセットを実行する

前提条件

最新バージョンの Test Manager を使用します (Automation Suite へのデリバリーの場合は Test Manager 2.2510 以降、スタンドアロンでのインストールの場合は Test Manager 25.10 以降)。
すでに Orchestrator でテストセットを実行している場合は、そのテストセットを Test Manager にインポートします。詳細については、「 Test Manager - Orchestrator のテストセットをインポートする」をご覧ください。インポート後に testset-key を取得します。
Test Manager でプロジェクトを作成し、プロジェクトキーを取得します。[プロジェクト] > [すべてのプロジェクト] > [ダッシュボード] タブ> Test Manager からプロジェクトキーを取得します。
自動化されたテストケースを含むパッケージまたはテストセットを作成します。Test Manager の [テストセット] タブ> [キー] 列> testset-key を取得します。
クライアント ID とクライアントシークレットを取得します。クライアント ID とクライアントシークレットの取得方法の詳細については、「 CI/CD との連携 - UiPath CLI タスクを実行する」の「外部アプリケーションを登録する」をご覧ください。
CLI の exe ファイル (Windows の場合) または dll ファイル (Linux の場合) を実行します。
必要な Test Manager API アクセスのアプリケーションスコープを追加します。Test Manager のスコープについて詳しくは、「 CI/CD との連携 - UiPath CLI タスクを実行する」をご覧ください。

CLI で Test Manager を使用する

Test Manager を使用してパッケージをテストするには、次の手順を実行します。 uipcli test を使用してテストタスクを実行します。利用可能なサブタスクのリストが表示されます。必要なパラメーターを指定し、run サブタスクを実行します。

Orchestrator でのテストの代わりに Test Manager を使用するには、test run コマンドで --projectKey パラメーターを指定します。CLI によって、テストが Test Manager 経由で自動的にルーティングされます。

テストコマンドのパラメーター

パラメーター	説明	Required
`Orchestrator URL (pos. 0)`	Orchestrator インスタンスの URL です	はい
`Orchestrator Tenant (pos. 1)`	パッケージまたはテストセットが含まれるテナント	SaaS デプロイの場合は必須、PaaS デプロイの場合は任意
`-P`, `--project-path`	テストするテストパッケージファイルへのパスです	いいえ
`--projectKey`	Test Manager の >[ダッシュボード] タブに表示されるプロジェクトキー> [プロジェクト] > [すべてのプロジェクト]プロジェクトキーは、すべてのオブジェクトキーのプレフィックスです。	はい (Test Manager の場合)
`--testsetkey`	Test Manager の [テストセット] タブ> [キー] 列に表示されるテストセット>キーです。テストセットに最新バージョンのテストケースが含まれていることを確認します。テストセットが既定のフォルダーに含まれていない場合は、前に適切なフォルダー名を含めてください。例: AccountingTeam\TestSet	いいえ
`-s`, `--testset`	実行するテストセットに表示される名前です。テストセットに最新バージョンのテストケースが含まれていることを確認します。テストセットが既定のフォルダーに含まれていない場合は、前に適切なフォルダー名を含めてください。例: AccountingTeam\TestSet	いいえ
`--out`	結果ファイルの種類 (junit または uipath) です	いいえ
`-r`, `--result_path`	結果の保存先のファイルのパスです	いいえ
`-e`, `--environment`	パッケージをデプロイする環境です。これは、 `project path`	クラシックフォルダーに必要です
`-w`, `--timeout`	テストセットの実行を待機する時間 (秒単位) です。既定値は 7200 秒です	いいえ
`-i`, `--input_path`	JSON 入力ファイルへのフルパスです。ファイル構造について詳しくは、「入力パラメーター JSON 形式」をご覧ください。	エントリポイントワークフローに入力パラメーターがある場合は必須です
`--attachRobotLogs`	実行された各テストケースのロボットログと JUnit テストレポートを添付します	いいえ
`--repositoryUrl`	プロジェクトがバージョン管理されているリポジトリの URL です	いいえ
`--repositoryCommit`	プロジェクトの構築元であるリポジトリのコミットです	いいえ
`--repositoryBranch`	プロジェクトの構築元のリポジトリブランチです	いいえ
`--repositoryType`	VCSシステム・リポジトリ・タイプ	いいえ
`--projectUrl`	Automation Hub のアイデアの URL	いいえ
`--releaseNotes`	リリースノートの追加	いいえ
`--disableBuiltInNugetFeeds`	組み込みの NuGet フィードを無効化	いいえ
`--retryCount`	失敗したテストケースのリトライ回数 (既定では、リトライは設定されていません)	いいえ
`-u`, `--username`	Orchestrator への認証に使用するユーザー名です。対応するパスワードと組み合わせる必要があります	基本認証に必要です
`-p`, `--password`	Orchestrator への認証に使用するパスワードです。対応するユーザー名と組み合わせる必要があります	基本認証に必要です
`-t`, `--token`	Orchestrator への認証に使用される OAuth2 更新トークンです。アカウント名およびクライアント ID と組み合わせる必要があります	トークンベースの認証に必要です
`-a`, `--accountName`	Orchestrator Cloud RPA のアカウント名です。OAuth2 更新トークンおよびクライアント ID と組み合わせる必要があります	トークンベースの認証に必要です
`-A`, `--accountForApp`	Orchestrator Cloud RPA のアカウント名 (組織名) です。外部アプリケーションのアプリケーション ID、アプリケーションシークレット、アプリケーションスコープと組み合わせて使用する必要があります。	いいえ
`-I`, `--applicationId`	外部アプリケーション ID です。アプリケーションアカウント、アプリケーションシークレット、アプリケーションスコープと組み合わせて使用する必要があります	外部アプリケーションの認証に必要
`-S`, `--applicationSecret`	外部アプリケーションシークレットです。アプリケーションアカウント、アプリケーション ID、アプリケーションスコープと組み合わせて使用する必要があります	外部アプリケーションの認証に必要
`--applicationScope`	アプリケーションスコープを単一のスペースで区切って列挙したリストです。外部アプリケーションのアプリケーションアカウント、アプリケーション ID、アプリケーションシークレットと組み合わせて使用する必要があります。	外部アプリケーションの認証に必要
`-o`, `--organizationUnit`	テストセットを実行する Orchestrator のフォルダーです。	いいえ
`-l`, `--language`	Orchestrator のユーザーインターフェイスで使用される言語	いいえ
`--traceLevel`	イベントのトレースを表示します	いいえ
`--identityURL`	Identity Server の URL です	PaaS または MSI のデプロイに必要です

注: Test Manager に必要なアプリケーションスコープ

Test Manager を使用する場合、 --applicationScope パラメーターに以下のスコープを含める必要があります。

TM.Projects TM.TestSets TM.TestExecutions

Orchestrator のスコープに加えて、以下の操作も行います。

OR.Assets OR.BackgroundTasks OR.Execution OR.Folders OR.Robots.Read OR.Machines.Read OR.Jobs OR.TestSets OR.TestSetExecutions OR.Monitoring OR.Settings.Read

使用例

Test Manager で既存のテストセットを実行します

# Windows
uipcli 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"

# Linux
uipcli 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 "./test-results"
# Windows
uipcli 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"

# Linux
uipcli 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 "./test-results"

プロジェクトから一時的なテストセットを作成して実行する

一時的なテストセットは、プロジェクトパスからその場で作成される一時的なテストセットです。

uipcli test run "https://cloud.uipath.com/" "TenantName" \
  --projectKey "MyTestProject" \
  -P "./MyTestProject/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 "./test-results"
uipcli test run "https://cloud.uipath.com/" "TenantName" \
  --projectKey "MyTestProject" \
  -P "./MyTestProject/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 "./test-results"

パラメーターを上書きしてテストを実行する

uipcli test run "https://cloud.uipath.com/" "TenantName" \
  --projectKey "MyTestProject" \
  --testsetkey "MyTestSet" \
  -i "./test-parameters.json" \
  -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 "./test-results"
uipcli test run "https://cloud.uipath.com/" "TenantName" \
  --projectKey "MyTestProject" \
  --testsetkey "MyTestSet" \
  -i "./test-parameters.json" \
  -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 "./test-results"

ロボットログが添付されてテストを実行する

uipcli test run "https://cloud.uipath.com/" "TenantName" \
  --projectKey "MyTestProject" \
  --testsetkey "MyTestSet" \
  --attachRobotLogs true \
  -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 "./test-results"
uipcli test run "https://cloud.uipath.com/" "TenantName" \
  --projectKey "MyTestProject" \
  --testsetkey "MyTestSet" \
  --attachRobotLogs true \
  -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 "./test-results"

レポートの種類

Test Manager では、次の 2 つの出力形式がサポートされています。

形式	説明	ユースケース
`junit`	JUnit XML 形式	CI/CD との連携 (Jenkins、Azure DevOps、GitHub Actions)
`uipath`	UiPath のネイティブ形式	Test Manager 固有のデータを含む詳細な実行レポート

Orchestrator のテストからの移行

変更前 (Orchestrator のテスト)

uipcli test run "https://cloud.uipath.com/" "TenantName" \
  -s "MyTestSet" \
  -u "username" \
  -p "password" \
  -o "FolderName" \
  -P "./project.json"
uipcli test run "https://cloud.uipath.com/" "TenantName" \
  -s "MyTestSet" \
  -u "username" \
  -p "password" \
  -o "FolderName" \
  -P "./project.json"

実行後 (Test Manager)

uipcli 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 "./results"
uipcli 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 "./results"

主な違い

--projectKeyパラメーターを追加して Test Manager を有効化します
テストセットの識別に-sではなく --testsetkey を使用する
Test Manager で OAuth 認証 (アプリケーション資格情報) が必要
出力形式を --out で指定し、出力先を --result_path で指定
Test Manager のスコープを --applicationScope に含める

ベストプラクティス

Test Manager の設定

さまざまなアプリケーションやチーム専用の Test Manager プロジェクトを作成する
わかりやすいプロジェクトキーとテストセットキーを使用して、簡単に識別できるようにします
目的 (回帰、煙、統合など) ごとにテストセットを整理します。

パラメータ管理

環境固有の構成には、パラメーターファイル (-i) を使用します
機密性の高いパラメーターは、パラメーターファイルではなく CI/CD シークレットに保存する
テストセットの説明に必要なパラメーターを文書化します

リトライロジック

断続的に失敗する可能性のある不安定なテストには --retryCount を使用します
テスト期間に基づいて適切な --timeout 値を設定する
リトライパターンを監視して、不安定なテストを特定して修正します

報告

CI/CD パイプライン連携に junit 形式を使用する
Test Manager で詳細を分析するには uipath 形式を使用します
テストの不合格をデバッグするための --attachRobotLogs の有効化

CI/CD との連携

セキュリティで保護された環境変数を使用して Test Manager の認証を設定する
コードのコミットまたはプル要求に対する自動テスト実行を設定する
テストレポートをビルド成果物としてアーカイブし、履歴を追跡

このページは役に立ちましたか?

前へパッケージをテストするか、テストセットを実行する

次へ入力パラメーター JSON 形式

Test Manager でパッケージをテストする、またはテスト セットを実行する​

前提条件​

CLI で Test Manager を使用する​

テスト コマンドのパラメーター​

使用例​

Test Manager で既存のテスト セットを実行します​

プロジェクトから一時的なテスト セットを作成して実行する​

パラメーターを上書きしてテストを実行する​

ロボット ログが添付されてテストを実行する​

レポートの種類​

Orchestrator のテストからの移行​

変更前 (Orchestrator のテスト)​

実行後 (Test Manager)​

主な違い​

ベスト プラクティス​

Test Manager の設定​

パラメータ管理​

リトライ ロジック​

報告​

CI/CD との連携​

このページは役に立ちましたか?

Test Manager でパッケージをテストする、またはテストセットを実行する

前提条件

CLI で Test Manager を使用する

テストコマンドのパラメーター

使用例

Test Manager で既存のテストセットを実行します

プロジェクトから一時的なテストセットを作成して実行する

パラメーターを上書きしてテストを実行する

ロボットログが添付されてテストを実行する

レポートの種類

Orchestrator のテストからの移行

変更前 (Orchestrator のテスト)

実行後 (Test Manager)

主な違い

ベストプラクティス

Test Manager の設定

パラメータ管理

リトライロジック

報告

CI/CD との連携