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

Studio は、Postman との連携により API テストオートメーションプロジェクトをサポートしています。Postman とは、API へのテスト呼び出しを実行するソフトウェア開発ツールです。この連携には、Postman コレクションのコマンドライン実行機能である Newman も含まれ、コマンドラインから直接、コレクションを実行およびテストできます。

Postman から Studio にコレクションをインポートするには、ライブラリの新しいサービス ウィザードを使用し、一般的な API キーを使用して Postman コレクションにアクセスします。一般的な API キーは、API キーのセクションから生成できます。

インポートしたコレクションは、プロジェクトのテストに使用できます。Postman の前提条件について詳しくは、こちらをご覧ください。

テスト関連では、Studio のライブラリにインポートした Postman のコレクションを .nupkg パッケージとしてローカルまたは Orchestrator 内にパブリッシュし、その後テストオートメーションプロジェクトに依存関係としてインストールするという使用方法があります。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

プロジェクトの種類としてテストオートメーションを使用して、Studio 内でテストプロジェクトを作成します。
パブリッシュされたライブラリを、[パッケージを管理] ウィンドウを使用して依存関係としてインストールします。
ライブラリで先ほど定義したシーケンスファイルが、ライブラリの名前空間により [アクティビティ] パネルで使用できるようになります。これとともに Postman のインポートから生成されたアクティビティも使用可能になります。
これらのアクティビティを、UiPath.Testing.Activities パッケージのアクティビティ部分と組み合わせて、API テストオートメーションプロジェクトで使用します。このデモアプリケーションでは、ローンを申し込む際に入力したデータを検証するテストプロジェクトを作成しました。この小さなテストでは、一連のハードコードされた変数を使用しています。それらは、下記の [プロパティ] パネルで確認できます。

この簡単なテストプロセスは、アプリケーションが適切に応答するかを確認するスモークテストとして使用されました。Studio では、自動化のニーズに合わせて、このようなテストをいくつか作成できます。
1 つのテストプロジェクトで複数のシナリオを検証するには、リボンの [新規] > [データドリブンテストケース] を使用します。こちらの説明に従い、データセットをインポートします。下図は、このようなテストケースの例です。インポートにより、値は引数に格納され、アクティビティにマッピングされます。
[ファイルを実行する] または [データバリエーションを使用してファイルをデバッグ] を選択し、使用するデータを選択します。これは、複数のデータセットを使用して、いくつかのシナリオをテストするときに便利です。
プロセスの実行後、結果は [出力] パネルに表示されます。