API テスト オートメーション

Studio では「新しいサービス」ウィザードによる API テスト オートメーションがサポートされており、Swagger などのさまざまな API 形式で API の定義をインポートしてテストすることができます。Studio の API テスト オートメーション機能を使用すると、さまざまなサービスにわたって、自動化されたテストを構築、管理、実行できます。

インポート後は、テスト オートメーション プロジェクトでサービスの定義を使用して、エンドポイント、応答、動作を検証できます。また、サービス ライブラリを .nupkg パッケージとしてローカルまたは Orchestrator にパブリッシュして、テスト ワークフローで依存関係として再利用することもできます。

Studio では、API コレクションをインポートするための追加オプションとして Postman もサポートしています。コレクションをインポートするには、Postman アカウントで API キー を生成し、 新しいサービス ウィザードで使用します。Studio は Postman のコマンド ライン ランナーである Newman と連携しているため、コマンド ラインから直接コレクションを検証できます。Postman の要件について詳しくは、「 Postman コレクション」をご覧ください。

API テスト オートメーションの新しいサービス ウィザードを使用する

この例では、「新しいサービス」ウィザードを使用し、Studio に Swagger の JSON ファイルまたは Swagger のリンクを読み込んで、API テスト オートメーションの実行を開始する方法を説明します。

前提条件

この例の手順を実行するには、次のいずれかのリソースが利用可能である必要があります。

• Swagger からお使いのマシンにエクスポートした JSON ファイル
• Swagger のファイルへのリンク

手順

1. ライブラリ プロジェクトの [デザイン] リボンから [新しいサービス] を選択します。

   [サービス エディター] ウィンドウが表示されます。

2. 使用する Swagger リソースを選択します。
   • ローカルにある Swagger の JSON ファイルを使用する場合は、[ファイルまたはリンク] フィールドの横にある [その他のオプション] メニューを選択します。インポートする Swagger のファイルを参照して開きます。
   • Swagger のファイルへのリンクを使用する場合は、Swagger のリンクを [ファイルまたはリンク] フィールドに直接入力します。
3. [サービス エディター] で [読み込み] を選択します。

   これで、Swagger ファイルに含まれる定義済みのすべてのエンドポイントが [サービス エディター] に読み込まれます。

4. 必要なメソッドまたは操作を [操作を検索] ボックスに入力し、返された結果を表示します。

   Swagger のファイルの場合、メソッドは、読み込むエンドポイントごとに異なる色でマークされます。

   名前空間は自動的に生成されますが、編集できます。

5. [保存] を選択して、サービスをライブラリに連携させます。

図 1. [サービス エディター] に読み込まれた Swagger のファイル

Postman を使用した API テストの例

以下の例では、Postman で定義したデータ コレクションを使用します。Studio のライブラリにデータ コレクションをインポートし、そのライブラリをコレクションとともにパブリッシュしてからテスト プロジェクトにインストールして、UiPath.Testing.Activities パッケージのテスト アクティビティの部分を使用してデータの使用状況を検証します。

テスト ケースは銀行の顧客向けに設計されたもので、自動的にローンへの申し込みを行うとともに、ローンに関するデータを取得するワークフローで使用します。

Postman および Newman のインストールの前提条件は、こちらのページで確認できます。

データ コレクションを定義する

Postman では、データ コレクションを定義するか、既存のコレクションを現在のワークスペースにインポートします。この例では、ローンへの申し込み、ローンに関する詳細の取得と削除に関するデータ コレクションを作成しました。このコレクションを API テスト プロジェクトで使用することで、今回のワークフローの論理が適切かどうかを確認できます。

コレクションをインポートする

Studio にコレクションをインポートするには、ライブラリ プロジェクトを作成し、[新しいサービス] ウィンドウを使用します。コレクションへのアクセスは、Postman の API キーによって許可されます。このキーを [ファイルまたはリンク] フィールドに入力して、[読み込み] をクリックします。

プロジェクトへの読み込みが必要なエンドポイントだけを選択し、必要に応じて新しい [名前空間] を追加します。

[リンクされたコレクション] ボックスをチェックし、実行時に、コレクションのローカルに保存されたバージョンではなく、リンクを使用して最新のバージョンが実行されるようにします。完了したら [保存] をクリックします。

データ コレクションを使用する

Studio のライブラリへのコレクションのインポートが完了すると、エンドポイントが自動的にアクティビティに変換され、[アクティビティ] タブの、あらかじめ設定した名前空間の下に表示されます。

この例では、エンドポイントから生成されたアクティビティごとに、別々のシーケンス ファイルを作成しました。

アクティビティの追加後、[プロパティ] パネルに Postman 環境を追加します (二重引用符 "" で囲みます)。

Postman コレクションに定義したデータ値が、引数としてインポートされます。

ライブラリは、ローカルまたは Orchestrator で .nupkg パッケージとしてパブリッシュできます。

API テスト プロジェクトにライブラリを読み込む

1. プロジェクトの種類としてテスト オートメーションを使用して、Studio 内でテスト プロジェクトを作成します。
   
   

   

   
   
2. パブリッシュされたライブラリを、[パッケージを管理] ウィンドウを使用して依存関係としてインストールします。
   
   

   

   
   
3. ライブラリで先ほど定義したシーケンス ファイルが、ライブラリの名前空間により [アクティビティ] パネルで使用できるようになります。これとともに Postman のインポートから生成されたアクティビティも使用可能になります。
   
   

   

   
   
4. これらのアクティビティを、UiPath.Testing.Activities パッケージのアクティビティ部分と組み合わせて、API テスト オートメーション プロジェクトで使用します。このデモ アプリケーションでは、ローンを申し込む際に入力したデータを検証するテスト プロジェクトを作成しました。この小さなテストでは、一連のハードコードされた変数を使用しています。それらは、下記の [プロパティ] パネルで確認できます。
   
   

   

   
   

   この簡単なテスト プロセスは、アプリケーションが適切に応答するかを確認するスモーク テストとして使用されました。Studio では、自動化のニーズに合わせて、このようなテストをいくつか作成できます。

5. 1 つのテスト プロジェクトで複数のシナリオを検証するには、リボンの [新規] > [データ ドリブン テスト ケース] を使用します。こちらの説明に従い、データ セットをインポートします。下図は、このようなテスト ケースの例です。インポートにより、値は引数に格納され、アクティビティにマッピングされます。
   
   

   

   
   
6. [ファイルを実行する] または [データ バリエーションを使用してファイルをデバッグ] を選択し、使用するデータを選択します。これは、複数のデータ セットを使用して、いくつかのシナリオをテストするときに便利です。
   
   

   

   
   

7. プロセスの実行後、結果は [出力] パネルに表示されます。