Test Manager との API 連携

概要

Test Manager ソフトウェア開発キット (SDK) を使用すると、Test Manager と開発ツールを連携できます。 この種類の連携により、アーティファクト (要件、ストーリー、不具合) を同期して UiPath® の 自動化機能を実現できます。

次のアーキテクチャ図は、UiPath® コンポーネントとサード パーティ ツールとの連携機能を表しています。詳しくは、「ALM ツールとの連携」の「ALM 連携パターン」をご覧ください。

連携のシナリオ

以下の一般的なシナリオに基づいて、連携の動作を理解できます。

• 外部要件を同期する
• 外部ツールで不具合を作成する
• 外部テスト ケースにオートメーションを割り当てる
• 外部ツールに結果を取得する

外部要件を同期する

要件などのアーティファクトを同期する主な目的は、そのアーティファクトにテスト ケースを割り当てることです。これにより、そのテスト ケースでカバーされる要件がわかります。テスト ケースを割り当てるには、お使いの外部ツールのすべての要件を Test Manager に同期する必要があります。この操作を Test Manager で行う方法については「要件」をご覧ください。

外部要件を Test Manager に同期する場合は、以下の点を考慮します。

• 外部ツールは、主にテスト プロセスで使用します。外部で同期した要件は、Test Manager で読み取り専用になります。
• Test Manager での要件は、外部ツールを使用して更新されます。
• Test Manager ですべてのアーティファクトおよび関連するレコードをカスケード削除で削除することはできますが、お勧めはできません。
• 要件の説明では、書式設定を目的として Markdown を使用していることがあります。

外部ツールで不具合を作成する

Test Manager には、テスト ケース ログから不具合を作成するときに呼び出される Webhook が用意されています (「テスト結果」を参照)。Test Manager プロジェクトの連携を設定して、不具合の作成に必要なテスト ケース ログ情報を受け取ることができます (例: Jira Server)。[テスト結果] > テスト ケース キー > [不具合] に移動して、不具合が作成されたツールに素早くアクセスできます。

外部テスト ケースにオートメーションを割り当てる

Studio を使用してオートメーション機能を有効化するには、テスト ケースを Test Manager に同期する必要があります。

外部テスト ケースにオートメーションを割り当てる場合は、以下の点を考慮します。

• 外部ツールは、外部テスト ケースと Test Manager でそのテスト ケースに対応するアーティファクトとのマッピング情報を格納します。
• テスト ケースを Test Manager と同期した後で、オートメーションを割り当てることができます。
• 外部ツールでオートメーション情報を表示すると、オートメーションが割り当てられていることがわかるので、これは良い方法であるといえます。

外部ツールに結果を取得する

結果を取得するには、Test Manager の REST API を介して TestExecution オブジェクトに対するクエリを実行する必要があります。TestExecution オブジェクトは、テスト セットの実行によって生成された結果で構成されます。TestExecution は、テスト ケースの結果を表す TestCaseLogs オブジェクトへの参照を保持します。

定期的に結果をポーリングする必要があります。20 秒以上の間隔で新しい結果を取得することを検討してください。

連携を設定する

連携は、個別のサービスとして設定する必要があります。RESTful Web サービスを使用できる外部ツールであれば、そこで使用されるテクノロジに制限はありません。

以下の図は、外部ツールから Test Manager にアーティファクトを同期する方法の例を示しています。

注: 外部ツールの機能によっては、中継する Integration Service が不要な場合があります。