CLI でテストスイートを実行する

適切な実行方法の選択

Apidog では、さまざまなテスト要件に適した複数のテストスイート実行方法を提供しています。

ローカルでのビジュアル実行:

この方法はローカルマシンから開始され、小規模で迅速なテストに適しています。

開発とテストを同時に行う場合に特に効果的で、リアルタイムの監視と即時の調整が可能です。

ローカル Apidog CLI 実行:

大規模データや反復的なシナリオの処理に最適で、この方法では実行速度が向上します。

オフラインで実行できるため、リソースが制限された環境やグラフィカルユーザーインターフェースを必要としない環境に適しています。

CI/CD 実行:

この実行方式は CI/CD パイプライン内に統合されており、自動統合および継続的デプロイプロセスに最適です。

各コード更新後に API の安定性を確認するため、テストが頻繁に実行される環境で特に有用です。

セルフホスティング Runner 実行:

チームは自社サーバー上に Apidog Runner をセットアップし、より強力なコンピューティングリソースをテストに活用できます。

この方法はスケジュールタスクをサポートしているため、定期的なテストが必要なシナリオや、テスト要求が大きいシナリオに最適です。

TIP

テストスイートで環境変数またはグローバル変数を使用している場合、選択した実行方法によってこれらの変数の実際の値が異なることがあり、テスト結果に不整合が生じる可能性があります。詳細はこちら。

Apidog CLI の実行

Apidog CLI を使用してテストスイートを実行するには、まずテストスイートを作成し、構成する必要があります。その後、Apidog CLI を使用してコマンドラインからテストスイートを実行し、テスト結果とテストレポートを取得できます。

テストスイートで、CI/CD タブに切り替えます。

実行環境や通知方法などのパラメータを設定します。インターフェース内の各設定は、下部に生成される CLI コマンドにリアルタイムで反映されます。

CI/CD プロバイダーセクションで、CLI コマンドラインまたはその他のプラットフォームを選択します。

CLI 呼び出し認証用に、「Add access token」ボタンをクリックし、その後「Generate token」をクリックします。詳細はこちら。

クリックしてコマンドをコピーし、コマンドラインに貼り付けて実行すると、テスト実行プロセスとテストレポートを確認できます。

注: コマンドを正常に実行するには、まず Apidog CLI をインストールする必要があります。すでにインストール済みの場合は、最新バージョンに更新する必要があります。

変数とローカル設定ファイルについて（任意）

一部のシナリオでは、CLI 実行にローカル設定ファイルが必要です。

環境変数 / グローバル変数

「Export current values for use」を選択した場合、エクスポートした変数ファイルを CLI 実行マシンに配置し、--variables <path> でファイルパスを指定する必要があります。

「Use initial Values」と「Export current values for use」の違いについては、次を参照してください: 異なる実行方法間で環境変数/グローバル変数を使用する際のルール。

データベース接続

テストでローカルに保存された「database connections」を使用している場合、インターフェースで設定ファイルのエクスポートが案内され、CLI では --database-connection <path> を通じて使用します。

「database connection」の詳細は変数形式で保存することを推奨します。これにより、CLI 実行時に追加の --database-connection <path> が不要になり、共同作業とメンテナンスもより便利になります。詳細はこちら。

CLI テストレポート

CLI を実行すると、テストスイートの実行統計、および失敗したリクエストの検証情報とアサーション情報を含むコマンドラインテストレポートが取得できます。

CLI を実行したフォルダー内には、HTML 形式の CLI テストレポートを含む /apidog-reports/ フォルダーもあります。

コマンドオプション

Apidog CLI では、テストスイートの実行をカスタマイズするための豊富な設定オプションを提供しています。詳細については、CLI コマンドオプションを参照してください。

CI/CD で Apidog CLI を使用する

Apidog CLI は、Jenkins、GitLab、GitHub Actions など、さまざまなパイプラインツールとの統合をサポートしています。詳細については、CI/CD 統合を参照してください。

CLI でテストスイートを実行する

適切な実行方法の選択#

Apidog CLI の実行#

変数とローカル設定ファイルについて（任意）#

CLI テストレポート#

コマンドオプション#

CI/CD で Apidog CLI を使用する#

適切な実行方法の選択

Apidog CLI の実行

変数とローカル設定ファイルについて（任意）

CLI テストレポート

コマンドオプション

CI/CD で Apidog CLI を使用する