必要なモジュールをインポートする
まず、次の Firebase Test Lab イベントの処理に必要なモジュールをインポートします。
// The Cloud Functions for Firebase SDK to set up triggers and logging.
const {onTestMatrixCompleted} = require("firebase-functions/v2/testLab");
const {logger} = require("firebase-functions");
# The Cloud Functions for Firebase SDK to set up triggers and logging.
from firebase_functions import test_lab_fn, params
# The requests library to send web requests to Slack.
import requests
TestMatrix の完了時に関数をトリガーする
Firebase Test Lab 関数をトリガーするには、テスト マトリックス完了イベントのハンドラを定義します。この例では、関数はテストの完了時にトリガーされ、CloudEvent オブジェクトからテスト マトリックス データを取得して、対応するテスト結果を Slack チャネルに送信します。
exports.posttestresultstoslack = onTestMatrixCompleted(
{secrets: ["SLACK_WEBHOOK_URL"]},
async (event) => {
// Obtain Test Matrix properties from the CloudEvent
const {testMatrixId, state, outcomeSummary} = event.data;
// Create the title of the message
const title = `${getSlackmoji(state)} ${getSlackmoji(
outcomeSummary,
)} ${testMatrixId}`;
// Create the details of the message
const details = `Status: *${state}* ${getSlackmoji(
state,
)}\nOutcome: *${outcomeSummary}* ${getSlackmoji(outcomeSummary)}
`;
// Post the message to slack
const slackResponse = await postToSlack(title, details);
// Log the response
logger.log(slackResponse);
});
@test_lab_fn.on_test_matrix_completed(secrets=["SLACK_WEBHOOK_URL"])
def posttestresultstoslack(
event: test_lab_fn.CloudEvent[test_lab_fn.TestMatrixCompletedData]) -> None:
"""Posts a test matrix result to Slack."""
# Obtain Test Matrix properties from the CloudEvent
test_matrix_id = event.data.test_matrix_id
state = event.data.state
outcome_summary = event.data.outcome_summary
# Create the title of the message
title = f"{slackmoji(state)} {slackmoji(outcome_summary)} {test_matrix_id}"
# Create the details of the message
details = (f"Status: *{state}* {slackmoji(state)}\n"
f"Outcome: *{outcome_summary}* {slackmoji(outcome_summary)}")
# Post the message to Slack
response = post_to_slack(title, details)
# Log the response
print(response.status_code, response.text)
クライアントの詳細にアクセスする
テスト マトリックスはさまざまなソースやワークフローから作成される場合があります。そのため、テストのソースやその他の重要なコンテキストに基づいてさまざまなアクションを実行する関数を作成することが望ましい場合がよくあります。これを実現するため、gcloud
ではテストの開始時に任意の情報を渡すことができ、後で関数内でこの情報にアクセスすることができます。次に例を示します。
gcloud beta firebase test android run \
--app=path/to/app.apk \
--client-details testType=pr,link=<path/to/pull-request>
次に、関数内の情報にアクセスします。
const testType = event.data.clientInfo.details.testType;
const link = event.data.clientInfo.details.link;
test_type: str | None = event.data.client_info.details.get("testType")
link: str | None = event.data.client_info.details.get("link")