mabl botアプリケーションを使用すると、GitHubのプルリクエスト (PR) やコミットチェックの一部としてGitHubチェックを実行できます。mabl GitHubチェックでは、次のことを行うことができます。
- mablデプロイイベントの結果をGitHubで直接表示する
- GitHub PRを承認してマージする前に、テストチェックに合格することを要求する
- プルリクエストの閲覧者がGitHubからmablテストを手動で再実行できるようにする
mabl GitHubチェックを利用すると、開発プロセスの早い段階でフィードバックを取得して、コードの変更によってリグレッションが発生しないようにすることができます。
セットアップ
開始するには、GitHubインテグレーションのセットアップの記事に記載された手順に従います。
インテグレーション設定の構成
[Edit GitHub integration] ページで、[Run GitHub checks on deployment] をオンにします。
プルリクエストの閲覧者がGitHubからmablテストの再実行を手動でトリガーできるようにするには、[Allow manually re-running GitHub checks] をオンにします。
インテグレーション設定の構成
mablテストの実行
mablテストの出力をGitHubチェックとして確認するには、mablデプロイイベントをトリガーし、デプロイイベントにコードリビジョンハッシュを関連付ける必要があります。
デプロイイベント
デプロイイベントは、ワークスペース内のプランのうち、アプリケーション、環境、プランラベルなど、指定された条件に一致するすべてのプランを並列に実行することです。次のいずれかの方法を使用して、mablデプロイイベントをトリガーできます。
- mabl CLIの
mabl deployments create
コマンド run-mabl-tests
GitHubアクション- CI/CDインテグレーション
- デプロイイベントAPIと
curl
コマンド
コードリビジョンハッシュ
mablデプロイイベントをGitHubチェックに関連付けるには、コードリビジョンハッシュ (GitHubコミットハッシュともいう) の値を渡す必要があります。
ハッシュはGitHubのコミットの詳細から取得できます。ハッシュの最初の7文字またはすべての文字のいずれかをコピーします。
コードリビジョンハッシュの取得
たとえば、次のmabl CLIコマンドは、デプロイイベントをトリガーして、そのデプロイイベントを特定のコードリビジョンハッシュに関連付けます。
mabl deployments create -a <application-id> -e <environment-id> --revision <code-revision-hash>
チェックの詳細の確認
デプロイイベントが実行されると、コミットIDに対するmabl GitHubチェックが表示され、最初は「pending」、次に「successful」または「failed」と表示されます。[Details] ボタンをクリックして、次の内容を確認します。
- チェックの一部として実行されたすべてのプランとテストのリスト
- 各テスト実行のステータス: 「Passed」または「Failed」
GitHubでテスト名をクリックして、スクリーンショット、DOMスナップショット、ネットワークアクティビティなどのテスト実行出力の詳細を確認します。
GitHubチェックの詳細
テストの再実行
GitHubインテグレーションでGitHubチェックの手動での再実行を許可している場合は、[Re-run] ボタンをクリックしてテストを再度実行できます。
GitHubチェックの更新
追加のmablテストを実行し、PRをマージする前にこれらをGitHubチェックに関連付ける場合は、新規のデプロイイベントをトリガーし、PRの最新コミットのコードリビジョンハッシュの値を渡します。
最新のPRからのコードリビジョンハッシュの取得
mabl CLIでこれを行うには、mabl CLIコマンドmabl deployments create
を使用し、--revision
オプションの値としてハッシュを指定します。
これらの追加のテスト実行の結果は、新しいmabl GitHubチェックとして表示されます。