テストシナリオを作成したら、それを実行してテストレポートを生成できます。適切な実行方法の選択#
Apidog は、さまざまなテスト要件に適した複数のテストシナリオ実行方法を提供しています。この方法はローカルマシンから開始され、小規模で迅速なテストに適しています。開発とテストを同時に行う場合に特に効果的で、リアルタイムの監視と即時の調整が可能です。大規模なデータや反復シナリオの処理に最適で、この方法は実行速度を向上させます。オフラインで実行できるため、リソースが制限された環境やグラフィカルユーザーインターフェースを必要としない環境に適しています。こ の実行方式は CI/CD パイプラインに統合されており、自動統合および継続的デプロイメントプロセスに最適です。各コード更新後に API の安定性を確認するためにテストを頻繁に実行する環境で特に有用です。チームは自社サーバー上に Apidog Runner をセットアップし、より強力なコンピューティングリソースを活用してテストできます。この方法はスケジュールタスクにも対応しているため、定期的なテストが必要なシナリオや、テスト需要が大きいシナリオに最適です。テストシナリオで環境変数またはグローバル変数を使用している場合、選択した実行方法によってこれらの変数の実際の値が異なる可能性があり、テスト結果に不整合が生じることがあります。詳細はこちら。 はじめに#
1
目的のテストシナリオに移動し、リクエストを実行する環境を選択します。
3
現在の実行について、合格率、実行時間、その他のデータなどの情報を表示するテストレポートが表示されます。各リクエストを展開して、検証とアサーションを確認できます。
4
「more」をクリックして、実際のリクエストとレスポンスの詳細を確認します。
テストシナリオの実行オプション#
Apidog でテストシナリオを実行する際、特定の要件に 合わせてテスト実行を調整するために、複数の設定とオプションを構成できます。以下では、これらの設定における重要な項目について説明します。シナリオ内のリクエストの送信先となるサービス（ベース URL）と、使用する変数セットを指定します。詳細については、環境とサービスをご確認ください。カスタ ムリクエストは独自の完全な URL を持っているため、インポートされたステップとは異なり、このコンテキストで設定された環境には送信されません。テストデータ#
テストシナリオでは、外部テストデータセットのインポートがサポートされています。テストシナリオを実行すると、システムはデータファイル内のすべてのデータセットをループ処理し、データセット内のデータを対応する変数に割り当てます。詳細については、データ駆動テストをご確認ください。シナリオ内のすべてのステップをループで実行する回数を構成します。処理するデータ量が多い場合は、パフォーマンスを最適化するために、Apidog クライアントではなく Apidog CLI を使用して実行することをお勧めします。スレッド#
複数のスレッドで全ステップを実行し、スレッド間のデータは干渉を防ぐために分離された状態に保たれます。この機能は Beta 版であり、さらなるパフォーマンス最適化が必要になる場合があります。本格的な負荷テストには、代わりにパフォーマンステスト機能を使用することをお勧めします。
CLI ではスレッドはサポートされていません。実行場所#
テストシナリオを実行するために実際にハードウェアリソースを消費するマシンです。テストシナリオで開始されるすべてのリクエストは、ここで指定されたマシンから送信されます。そのため、リクエスト元マシンのネットワーク環境の違いにより、テスト結果が異なる場合があります。この設定は、テストシナリオの実行構成の一部として保存されません。毎回、デフォルトではローカルマシンがテストシナリオの実行に使用されます。また、この設定は一括実行や CLI 実行時には有効になりません。これらの場合、リクエストは現在のマシンのリソースを使用して開始されます。
Advanced Settings の右側にある「Share」オプションを有効にすると、各テストシナリオ実行後に生成されるテストレポートが、プロジェクトの他のメンバーと自動的に共有されます。チーム内で共有されたすべてのテストレポートは、Test Reports セクションの Shared タブで確認できます。詳細については、テストレポートを参照してください。詳細設定#
エラー時#
アサーション失敗、データ形式の検証失敗、サーバーエラーなどを含むエラーをテストでどのように処理するかを構成します。オプションは次のとおりです。無視: エラーが発生した場合も次のステップの実行を続行します（デフォルト設定）。
続行: エラーが発生した場合、現在の反復を終了し、次の反復を開始します。
実行を終了: エラーが発生した場合、実行全体を停止します。
リクエスト/レスポンスを保存#
デフォルトでは、Apidog はすべてのリクエストとレスポンスを保存します。リクエストまたはレスポンスが非常に大きい場合（数 MB になる可能性がある場合）、かなりのディスク容量を消費することがあります。このオプションを有効にすると、すべてのリクエストとレスポンスを保存せず、アサーションと検証の結果のみを保存できます。また、容量を節約するために、失敗したリクエストとレスポンスのみを保存することも選択できます。変数値を保持#
こ のオプションはデフォルトで有効になっており、テスト中に変更された グローバル変数と環境変数の現在値が、最後に変更された結果を保持するようにします。このオプションを無効にすると、テスト実行後にグローバル変数と環境変数は変更されず、実行前の値が保持されます。ローカル変数はこの設定の影響を受けず、各実行後にクリアされます。保存済み Cookie で実行#
Apidog の右下にある Cookies アイコンから Cookie 管理にアクセスできます。Apidog は API リクエストを行う際に Cookie を自動的に保存します。テストシナリオの実行中に保存済み Cookie を使用したい場合は、このオプションを有効にします。実行後に Cookie を保存#
上記と同様に、テストシナリオの実行後に保存済み Cookie を更新したい場合は、このオプションを有効にします。Apidog でこれらの詳細設定を構成す ることで、特定のテストニーズに合わせてテスト実行を細かく調整し、効率的で正確なテスト実行を実現できます。テストシナリオ設計モードでの実行時設定#
テストシナリオ設計モードにいる場合、関連する実行時構成は「Run」ボタンの右側に折りたたまれています。この設定ボタンにマウスを合わせると、このテストシナリオの詳細な実行時構成を確認できます。機能テストの実行#
機能テストを実行すると、テストシナリオ実行ページに移動します。下の画像の円グラフはテスト結果の概要を示し、テストシナリオの実行中にリアルタイムで更新されます。円グラフの下には、実行中の詳細なテストステップが表示され、各ステップのステータスが実行中に表示されます。機能テストの実行が完了したら、関連するエンドポイントをクリックして、テスト中のメトリクスとステータスを確認できます。これには、エンドポイント名、リクエストメソッド、リクエスト URL、レスポンスステータスコード、レスポンスタイム、レスポンス内容、データ検証、アサーション結果が含まれます。詳細については、テストレポートを参照してください。異なる実行方法間で環境変数/グローバル変数を使用するためのルール#
環境変数とグローバル変数は永続的であり、複数回の実行や異なるテストシナリオ間で長期的に使用するために保存できます。ただし、使用される実際の変数値は、選択した実行方法によって異なる場合があります。例:テストシナリオが環境変数 Token を使用している場合、クライアント内で実行すると正常に実行される可能性がありますが、セルフホスト Runner を使用して実行すると、Token の値が正しくないため失敗する可能性があります。この不一致は、実行時に環境変数 Token の実際の値がクライアント内にローカル保存された値から取得されるために発生することがあります。しかし、セルフホスト Runner で実行する場合、Runner には同じローカル保存済みの Token がないため、失敗につながります。この問題に対処するために、Apidog は異なる実行方法間で環境変数/グローバル変数の値を管理するための一連のルールを提供しています。| 実行方法 | 環境変数/グローバル変数の使用 | 変数の保存場所 |
|---|
| ローカル（クライアント、Web） | 環境変数/グローバル変数の現在値を使用して実行します。 | ローカルに保存されます。手動で変更することも、プリプロセッサ/ポストプロセッサを通じて更新することもできます。Environment Management > Environment/Global Variables > Current Values で確認できます。 |
| CLI、CI/CD | リアルタイムオンライン実行の場合:- 環境変数/グローバル変数の初期値を使用して実行します （デフォルト）。
- テストシナリオを実行するマシン上のファイルに保存された環境変数/グローバル変数の値を、
--variables path オプションで使用するように指定します。詳細はこちら。
- エクスポートされたファイルに含まれる環境変数/グローバル変数の値を使用して実行します。
| - 初期値は Apidog Cloud に保存され、クライアント内で手動でのみ変更で きます。
--variables path オプションで指定されたファイルに保存され、手動変更またはプリプロセッサ/ポストプロセッサによる更新が可能です。- エクスポートされたファイルに保存されます。手動で変更することも、プリプロセッサ/ポストプロセッサを通じて更新することもできます。
|
| セルフホスト Runner | - 環境変数/グローバル変数の初期値を使用して実行します （デフォルト）。
- Runner 内にローカル保存された値を使用して実行します。 詳細はこちら。
| - 初期値は Apidog Cloud に保存され、クライアント内で手動でのみ変更できます。
- 指定された Runner 内に保存されます。手動で変更することも、プリプロセッサ/ポストプロセッサを通じて更新することもできます。製品のユーザーインターフェース、または Runner 内の
/opt/runner/variables にあるファイルから確認できます。
|
他のプロジェクトのエンドポイントを含むテストシナリオの実行#
テストシナリオに他のプロジェクトからインポートされたエンドポイントが含まれている場合、実行時のこれらのエンドポイントのリクエスト URL は、Environment associations で設定した構成によって決まります。現在のプロジェクトの「Develop Env」が別のプロジェクトの「Prod Env」に関連付けられている場合、「Develop Env」を使用してテストシナリオを実行すると、インポートされたエンドポイントは「Prod Env」の URL に送信されます。その他すべてのエンドポイントは、現在のプロジェク トの「Develop Env」の URL を使用します。さまざまなテストの実装#
前述の手順は、テストシナリオの基本的な実行を示しています。テストシナリオを設定する際には、さまざまな高度な設定を組み込むことで、多様なテスト要件を満たすことができます。データ駆動テスト: 多様なデータセットを使用してテストを実施し、さまざまなシナリオにおけるシステム動作を検証します。 パフォーマンステスト: さまざまな負荷条件下でシステムパフォーマンスを評価し、スケーラビリティと応答性を確認します。 スケジュールタスク: テスト活動の範囲、アプローチ、タイミングを詳述した構造化された計画を確立します。 CI/CD 統合: ビルド、テスト、デプロイメントプロセスを自動化し、信頼性の高い頻繁なソフトウェアリリースを実現します。 
