レポート

対象

このレッスンの受講者は、以下の予備知識を身につけている必要があります。

「mablアプリケーションの概要」レッスンを受講し、mablアプリケーションの基本について理解している。
デプロイメントイベントAPIを使用して、mablとCI/CDフローを統合する方法について理解している。

レッスン内容

学習目標

このレッスンを修了すると、以下の知識や技能が身につきます。

ワークスペースレポートとプランレポートの内容と、それらのレポートを設定して配布する方法
Webhookを使用してmablからデータを自動的にエクスポートする方法
実行結果APIを使用して結果を取得する方法 (これは必ずデプロイメントイベントAPIと組み合わせて使用)

これが重要である理由

ワークスペース内の単一ユーザーまたはユーザーグループに情報を配布する機能
プランおよび全体的なワークスペースの状態とステータスに関するインサイト

要素の定義 (方法)

Mablではこのように、要素を使って「why (理由)」を明確にして解決します。ここでは、要素の定義と、既知の内容に結び付けるための例について説明します。

ワークスペースレポート

ワークスペースレポートは、ワークスペース内のアクティビティのサマリーです。自分のメールアドレスに送信されます。ワークスペースレポートは、[User settings] で、個々のユーザーによって、個々のユーザーに対して設定されます。サマリーには、ワークスペースの概要、最近のテスト実行、成功と失敗、最近のインサイトが表示されます。これらの最近の実行やインサイト、個々のテストそのものへのリンクは、電子メールで提供されます。

プランレポート

プランレポートは、ワークスペース内のすべてのユーザーまたは一部のユーザーに送信できるプランレベルのレポートです。スケジュールに基づいて、あるいはプランの成功や失敗などのイベントに基づいてトリガーできます。トリガーは相互に排他的です。つまり、スケジュールされたレポートとトリガーされたレポートがある場合は、両方とも配信されます。

Webhook

Webhook JSONペイロードは、プラン/テストのステータス、そのステータスの原因、プラン/テストの成功と失敗と、次の識別子を示します。

プラン

ID、名前、ラベル、href、タグ、実行ステータス、実行ID、実行href

テスト

ID、名前、ラベル、href、タグ、開始時刻、終了時刻、成功 (true、false)

実行イベントAPI

実行イベントAPIは、デプロイメントイベントAPIによってトリガーされたすべてのプランとテストに関するサマリー情報を含むJSONオブジェクトを返します。

要素の解説 (内容)

ワークスペースレポートの使用方法

ワークスペースレポートは、アプリケーションの右上隅にある [Workspace name] ドロップダウンをクリックすると表示される [User Settings] で設定します。

ワークスペースレポートの設定のビデオ

そこから、自分だけに配信されるワークスペースレポートをスケジュールできます。このレポートは、日次、週次、またはカスタムスケジュール (特定の曜日と時刻) で配信できます。週次レポートは、レポート設定を保存した日から送信されます。例: [Weekly] を選択し、[Wednesday] で保存すると、毎週水曜日にレポートが届きます。

プランレポートの使用方法

プランレポートもワークスペースレポートも設定変更は簡単です。

プランレポートの設定のビデオ

更新するプランを表示したら、封筒アイコンをクリックして、レポート設定のモーダルを開きます。デフォルトでは、ワークスペース内のすべてのユーザーにレポートが送信されます。個々のメールと、レポートの送信頻度 (毎日、毎週) を選択できます。無効にするには、頻度を [Never] に設定します。

週次レポートは、ワークスペースレポートと同じスケジュールロジックに従います。

注: ワークスペースレポートとプランレポートの両方を選択した場合、2つの別々のレポートが配信されます。

Webhookの使用方法

左下隅にある [Settings] をクリックし、[Webhook] タブに移動します。
[Add Webhook] をクリックして設定します。
Webhookの名前を追加します。
mablが呼び出して、保留中または完了した実行について記述されたJSONペイロードを配信するターゲットURLを追加します。
実行前や実行後のトリガーを設定します。

結果を [On Failure] や [On Success] に設定し、条件が満たされた場合に起動します。
実行前のWebhookでは、成功レスポンスを要求するチェックボックスをオンにすることもできます。これにより、エンドポイントは、テストを続行するために2xx/3xx応答を返すようになります。2xx/3xx以外のレスポンスを受信した場合、テストは失敗します。

必要に応じて、厳格なSSL検証を設定します。mablによって、すべての接続で有効なSSL証明書が使用されることが常に保証されます。
指定したワークスペースのすべてのWebhookは並列で実行され、完了までの最大時間は60秒です。それ以上の場合は、失敗したと見なされます。

実行イベントAPI

まとめ

復習 - ここで学習した内容

実行前と実行後の段階でWebhookを追加する方法

つながり - 既知の内容や業務との関連性

応用 - 今後の使用方法

これにより、mablからデータを自動的に取得し、CIワークフローに送ることができるようになります。

プランレポートとワークスペースレポートにより、ワークスペースレベルやプランレベルで何が起こっているかを把握することができます。