mabl CLIでのデプロイイベント
mabl CLIでのmablデプロイイベントの作成と確認
mablデプロイイベントを使用すると、mablテストをCI/CDワークフローに統合し、コードがデプロイされた時点ですぐにそのコードをテストできます。デプロイイベントにより、ワークスペース内のプランのうち、アプリケーション、環境、プランラベルなど、指定された条件に一致するすべてのプランのクラウド実行が並行してトリガーされます。
mabl CLIには、mablデプロイイベントの作成、リスト表示、監視、詳細情報の取得を行うためのコマンドが用意されています。
mabl deployments create
mabl deployments createコマンドは、デプロイイベントをトリガーします。少なくとも、実行するプランのアプリケーションIDまたは環境IDを指定する必要があります。mabl deployments createを実行すると、mabl CLIはmablアプリケーションでのデプロイ結果へのリンクを返します。
オプション
| オプション | 詳細 |
|---|---|
--application-id, -a | mablテストを実行するアプリケーション。指定した場合、このアプリケーションに関連するプランのみがトリガーされます。 |
--environment-id, -e | mablテストを実行する環境。指定した場合、この環境に関連するプランのみがトリガーされます。 |
--override-environment-id | テストを実行する環境をオーバーライドします。実行するプランの選択には使用されません。--application-idを指定する必要があります。 |
--await-completion | デプロイイベントが完了するまでスクリプトの処理を止めて待機し、ステータス取得の更新を出力します。デフォルト値はfalseです。 |
--fast-failure | デプロイイベントで最初のテストが失敗するまで、スクリプトの処理を止めます。--await-completionを指定する必要があります。デフォルト値はfalseです。 |
--silent | デプロイイベントの完了の待機中に、mabl CLIがステータス取得の更新を出力しないようにします。--await-completionを指定する必要があります。デフォルト値はfalseです。 |
--output, -o | JSONまたはyaml形式でデプロイイベントの出力を返します。 |
--browsers, -b | テストを実行するブラウザー。複数指定する場合はスペースで区切ります。デフォルト値は "chrome" です。 |
--labels, -l | スペース区切りのプランラベルのリストのいずれかのラベルと一致するプランを実行します。 |
--http-headers | ブラウザーリクエストに追加するHTTPヘッダー。複数指定する場合はスペースで区切ります (例: "x-header:foo")。 |
--url, -u | デプロイに使用するURL。 |
--app-url | デプロイに使用するアプリケーション/Web URL。 |
--api-url | デプロイに使用するAPI URL。 |
--api-key, -k | スクリプトでコマンドを認証するためのAPIキー。 |
--rebaseline-images, --rbi | 視覚的変化モデルのベースラインの再構築を行います。デフォルト値はfalseです。 |
--set-static-baseline, --ssbi | デプロイイベントでのテスト実行のスクリーンショットを、その環境で以後行われるすべてのプラン実行の静的な視覚的ベースラインとして使用します。デフォルト値はfalseです。 |
--revision, --rev | デプロイイベントを特定のgitコミットハッシュまたはリビジョンIDに関連付けます。 |
--repository-url | このフラグにリポジトリのURLを指定して、デプロイイベントを特定のリポジトリに関連付けます。例: "[email protected]:foo/bar.git" |
--mabl-branch | テストを実行するmablブランチ |
--auto-branch | --mabl-branchコマンドで指定した値を使って新しいブランチを作成します。--mabl-branchの指定が必要です。デフォルト値はfalseです。 |
--snapshot-from | mablブランチから環境に対して現在の状態のスナップショットを作成します。メインブランチの場合は "master" を使用します。--environment-idを指定する必要があります。 |
注
mabl deployments createでは、少なくともアプリケーションIDまたは環境IDを指定する必要があります。
Examples
# Trigger a deployment of all plans with a "regression" label
mabl deployments create -e <環境ID> --labels regression
# Trigger a deployment event to run plans on Chrome and Firefox
mabl deployments create -e <環境ID> -a <アプリケーションID> --browsers chrome firefox
# Trigger a deployment event on a new branch called "test-branch"
mabl deployments create -e <環境ID> --mabl-branch test-branch --auto-branch
mabl deployments list
mabl deployments listコマンドは、デプロイイベントID、トリガーされた日時、使用したアプリケーションまたは環境、および成功したテストと失敗したテストの総数を返します。
オプション
| オプション | 説明 |
|---|---|
--limit, -l | 返すデプロイイベントの数。デフォルトは10です。 |
--output, -o | 出力形式を指定します。"json" または "yaml" のいずれかを指定できます。 |
例
# List the five most recent deployment events in your workspace
mabl deployments list --limit 5
# List deployment events in JSON format
mabl deployments list --output json
mabl deployments watch
mabl deployments watchコマンドは、デプロイイベントの実行中にポーリングステータスを出力します。デプロイイベントが完了すると、mabl CLIはデプロイイベントで実行された各テストおよびプランの最終的なステータスと実行時間を出力します。
オプション
| オプション | 説明 |
|---|---|
--fast-failure | デプロイイベントで最初のテストが失敗するまで、スクリプトの処理を止めます。 |
--silent | デプロイイベントの完了の待機中に、mabl CLIがステータスポーリングの更新と結果の出力を行わないようにします。 |
--output, -o | 出力形式を指定します。"json" または "yaml" のいずれかを指定できます。 |
例
# Watch a deployment event until it finishes
mabl deployments watch <デプロイイベントID>
# Pause a script until a mabl deployment event completes
mabl deployments watch <デプロイイベントID> --silent
mabl deployments describe
mabl deployments describeコマンドは、以下のようなデプロイイベントの詳細情報を返します。
- 環境ID
- 受信時刻
- プランラベル
- デプロイイベントステータス
- プランステータス
- テストステータス
注
mabl CLI出力では、テストは "journeys" と呼ばれます。
オプション
| オプション | 説明 |
|---|---|
--output, -o | 出力形式を指定します。"json"、"yaml"、"markdown" のいずれかを指定できます。 |
例
# Output details on a deployment event in JSON format
mabl deployments describe <デプロイイベントID> --output json
Updated about 1 month ago