"Run mabl tests" GitHubアクションを使用して、GitHub Actionsのワークフローの一部としてmablテストを自動的にトリガーします。"Run mabl tests" GitHubアクションを使用すると、次のことを行うことができます。
- GitHubで新しいデプロイを開始してすぐに、mablの特定の環境やアプリケーションに関連するmablプランを実行する
- mablテストの結果をGitHub内で直接確認する
- mablテストの結果に基づいてパイプライン内の後続のアクションをカスタマイズする
セットアップ
"Run mabl tests" GitHubアクションをセットアップするには、次の手順を実行します。
- mablアプリケーションで、
CI/CD integration
APIキーを作成します。APIキーにアクセスできるユーザーは、ワークスペースの所有者に限定されています。 - GitHubで、GitHub Actionsシークレットを使用して、mabl APIキーを
MABL_API_KEY
という名前で保存します。 - "Run mabl tests" GitHubアクションをリポジトリのGitHub Actionsワークフローに追加します。
- このアクション内のプレースホルダーの値を、実行するmablテストのパラメーターに置き換えます。少なくとも、トリガーするmablプランのアプリケーションIDや環境IDを含める必要があります。
ブラウザー、ブランチ、プランラベル、URLオーバーライドなど、mablテストを実行するためのパラメーターの一覧については、Example workflow: Completeを参照してください。
mabl GitHubインテグレーション (アプリケーション) をインストールすると、プルリクエスト内の結果など、より詳細なやり取りが可能になります。詳細については、「GitHubインテグレーションのセットアップ」を参照してください。
アクションのカスタマイズ
Example workflowでは、コミットのプッシュやタグ付けが行われたときにmablテストがトリガーされます。実行させたい内容に応じて、プルリクエストのオープンやスケジュールに基づいて実行するテストの設定など、異なるイベントを使ってmablテストをトリガーできます。
また、テスト結果の統計を利用して、パイプラインで実行される後続のアクションを制御できます。たとえば、次のことを行うことができます。
- 1回のテストの失敗で自動的に失敗するのではなく、特定のしきい値や合格したテストの割合に基づいて失敗するように、パイプラインを簡単にカスタマイズできます。
- すべてのテストが成功した場合に、ビルドを次の環境に自動的にプロモートするようにパイプラインを設定することで、開発環境または本番環境へのプッシュを手動でタグ付けしたりトリガーしたりする必要がなくなります。
GitHubアクションの実行
mablは、パイプラインからデプロイメントイベントを受信するとすぐに、アクションで定義された特定のパラメーターに基づいて、mablデプロイイベントを自動的にトリガーします。トリガーされたすべてのテストが完了するまで、アクションは継続的にmablをポーリングします。
失敗時の動作を変更していない限り、アクションが失敗を返すとパイプラインは停止します。
アクションのログの表示
デプロイメントが行われた後、アクションによってトリガーされたmablテストの結果をGitHubアクションのログで直接確認できます。
- [Actions] タブをクリックし、mablのGitHub Actionsワークフローを開いてアクションのログを表示します。
- PRで実行するようにmabl GitHubアクションを設定している場合は、[Details] ボタンをクリックしてアクションのログを表示することもできます。
GitHub Actionsのログには、ブラウザー、ステータス、テスト名、実行時間、mablアプリケーションの出力への直接リンクなどが記載された表をはじめ、mablテストに関する有用な情報が記録されています。