Studio ガイド

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 のファイルへのリンク

手順

ライブラリプロジェクトの [デザイン] リボンから [新しいサービス] を選択します。 [サービスエディター] ウィンドウが表示されます。
使用する Swagger リソースを選択します。
- ローカルにある Swagger の JSON ファイルを使用する場合は、[ファイルまたはリンク] フィールドの横にある [その他のオプション] メニューを選択します。インポートする Swagger のファイルを参照して開きます。
- Swagger のファイルへのリンクを使用する場合は、Swagger のリンクを [ファイルまたはリンク] フィールドに直接入力します。
[サービスエディター] で [読み込み] を選択します。これで、Swagger ファイルに含まれる定義済みのすべてのエンドポイントが [サービスエディター] に読み込まれます。
Enter the method or operation you need in the Search Operations search box and view the returned results. For Swagger files, the methods are marked with different colors for each endpoint that you want to load. The namespace is generated automatically, but you can edit it.
[保存] を選択して、サービスをライブラリに連携させます。

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

結果

サービスがライブラリプロジェクトに読み込まれます。そのエンドポイントは、設定した名前空間下の [ アクティビティ ] パネルでアクティビティとして使用できます。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

プロジェクトの種類としてテストオートメーションを使用して、Studio 内でテストプロジェクトを作成します。
[ パッケージを管理 ] ウィンドウを使用して、パブリッシュ済みのライブラリを依存関係としてインストールします。
ライブラリで先ほど定義したシーケンスファイルが、ライブラリの名前空間により [アクティビティ] パネルで使用できるようになります。これとともに Postman のインポートから生成されたアクティビティも使用可能になります。
これらのアクティビティは、API テストオートメーションプロジェクトで、 UiPath.Testing.Activities パッケージに含まれるアクティビティと組み合わせて使用します。デモアプリケーションでローンを申し込むときに入力したデータを検証するためのテストプロジェクトを作成しました。この小さなテストでは、[ プロパティ ] パネルに表示される一連のハードコードされた変数を使用します。この単純なテストプロセスは、アプリケーションが正しく応答するかどうかを確認するためのスモークテストとして使用されました。Studio では、自動化のニーズに応じて、こうしたテストをいくつか作成できます。
1 つのテストプロジェクトで複数のシナリオを検証するには、リボンの [新規] > [データドリブンテストケース] を使用します。こちらの説明に従い、データセットをインポートします。下図は、このようなテストケースの例です。インポートにより、値は引数に格納され、アクティビティにマッピングされます。
[ファイルを実行する] または [データバリエーションを使用してファイルをデバッグ] を選択し、使用するデータを選択します。これは、複数のデータセットを使用して、いくつかのシナリオをテストするときに便利です。
プロセスの実行後、結果は [出力] パネルに表示されます。