このページでは、クラウド環境でコマンドラインからテストを一括実行する方法を説明します。
MagicPodのクラウド端末や外部クラウドサービスを使ったテストは、MagicPod Web API経由で簡単に一括実行できます。
本ページでは、以下の2通りの実行方法を紹介します。
magicpod-api-client形式
この形式は、テストの一括実行をリクエストした後、実行完了まで待機し、結果をレスポンスとして返します。curl / Invoke-RestMethod形式
この形式は、テストの一括実行をリクエストするのみで、結果はレスポンスとして返しません。
2つの形式には上記のような違いがあるため、CIサービスと連携して実行し、実行結果を取得して後続ジョブで利用する場合は、magicpod-api-client形式がおすすめです。1回のコマンド実行で結果まで取得できるため、実装をシンプルにできます。
実行方法
1. magicpod-api-client形式
まず、magicpod-api-clientをダウンロードします。
こちらのページから手動でダウンロードするか、以下のコマンドをコピーしてターミナルまたはコマンドプロンプト上で実行してダウンロードしてください。
ダウンロードしたファイルは解凍し、適当な場所に配置します。
curl -L "https://app.magicpod.com/api/v1.0/magicpod-clients/api/{os}/latest/" -H "Authorization: Token {apikey}" --output {filename}.zip
コマンド内の{os}、{apikey}、{filename}の箇所は、以下を参考にご自身の環境に合わせて変更してください。
- {os}: Macはmac、Windowsはwindows、Linuxであればlinuxもしくはlinux_arm64
- {apikey}: APIトークン
- {filename}: お好きなファイル名
（ページから手動でダウンロードする場合は、利用するOSに応じて、linux64_magicpod-api-client.zip、mac64_magicpod-api-client.zip、win64_magicpod-api-client.exe.zipのいずれかを選択してください。）
MagicPodを開き、「テスト一括実行」タブの「詳細」ボタンから一括実行設定画面を開きます。
一括実行設定画面にて、実行内容にあわせたテスト設定を作成・選択します。その後、画面右上の「3点リーダ」>「コマンドラインで実行」を選択します。
実行方法を指定すると、現在選択しているテスト設定、および指定した実行方法に対応した形式のコマンドが画面上に表示されます。これをコピーし、ターミナルやコマンドプロンプトに貼り付けて実行することで、一括実行が開始されます。
「実行方法」の選択肢のうち、（詳細設定）の有無による違いは、コマンドにおけるテスト設定の記述方法にあります。
- （詳細設定）なし：コマンドにおいて一括実行設定番号を指定している
- （詳細設定）あり：コマンドにおいて個別の設定項目をそれぞれ記述している
基本的にどちらを用いても実行内容は同じになるため、テスト設定を画面上で作成・編集し、実行方法は（詳細設定）なしのものを選択することを推奨しています。
なお、コマンドより一部設定内容を変更した上でテスト実行をしたい場合は、
（詳細設定）ありを選択し、個別の設定項目の一部を書き換える
（詳細設定）なしを選択し、一括実行設定番号を指定しつつ上書きしたい個別設定項目を併記する
という2通りの方法がございます。後者の実装方法についてはこちらのページをご参照ください。
2. curl,Invoke-RestMethod形式
まず、「テスト一括実行」タブの「詳細」ボタンから一括実行設定画面を開きます。
一括実行設定画面にて、実行内容にあわせたテスト設定を作成・選択します。その後、画面右上の「3点リーダ」>「コマンドラインで実行」を選択します。
実行方法を指定すると、現在選択しているテスト設定、および指定した実行方法に対応した形式のコマンドが画面上に表示されます。これをコピーし、ターミナルやコマンドプロンプトに貼り付けて実行することで、一括実行が開始されます。
「実行方法」の選択肢のうち、（詳細設定）の有無による違いは、コマンドにおけるテスト設定の記述方法にあります。
- （詳細設定）なし：コマンドにおいて一括実行設定番号を指定している
- （詳細設定）あり：コマンドにおいて個別の設定項目をそれぞれ記述している
基本的にどちらを用いても実行内容は同じになるため、テスト設定を画面上で作成・編集し、実行方法は（詳細設定）なしのものを選択することを推奨しています。
なお、コマンドより一部設定内容を変更した上でテスト実行をしたい場合は、
「（詳細設定）あり」を選択し、個別の設定項目の一部を書き換える
「（詳細設定）なし」を選択し、上書きしたい個別設定項目を併記する
という2通りの方法がございます。後者の実装方法についてはこちらのページをご参照ください。