実際の Gmail アカウントをテスト用の受信トレイにすると、最初はうまく動きます。よくある問題は次のとおりです。
問題が起きるところ
- トークンが失効します。 同意画面がテスト中の OAuth アプリには、7日で期限切れになるリフレッシュトークンが発行されます。誰かがログインして新しいトークンをコピーするまで、パイプラインは失敗し続けます。
- 制限付きスコープ。 メールを読むには Gmail の制限付きスコープが必要です。アプリをテスト中の状態から移すには Google の審査が必要になることがあり、用途によってはセキュリティ評価も求められます。テスト用のヘルパーには大きな負担です。
- すべての実行で1つの受信トレイ。 プラスアドレス(
qa+run123@gmail.com)でテストごとに別のアドレスを持てますが、メールはすべて同じメールボックスに届きます。並列実行では互いのコードを読んでしまい、再試行では前回のコードを拾うことがあります。 - 固定の待ち時間と壊れやすい解析。 スクリプトは
sleepでポーリングし、正規表現でコードを取り出します。マーケティング担当がメールテンプレートを変えた日に、この正規表現は壊れます。 - 人の操作が必要。 Google がログインの確認を求めても、テストは応答できません。電話を持っている人が対応する必要があります。
代わりにテストごとに1つのアドレス
Proxy Mail QA はテストごとに専用のアドレスと受信トレイを用意し、指定した時刻より後に届いたメールを待ちます。
import { ProxyMailQA } from 'proxymail-qa';
const qa = new ProxyMailQA(); // reads PROXYMAIL_QA_API_KEYconst { address } = await qa.createAddress({ label: 'sign-up test' });
const since = new Date();// …fill in the sign-up form with `address` and submit…const { value: code } = await qa.waitForCode(address, { since });- 更新するトークンがありません。 API キー は1週間で期限切れになりません。CI のシークレットに保存してください。
- 衝突しません。 各アドレスは1つのテスト専用なので、並列実行で互いのメールを見ることはありません。
- 正規表現は不要です。 コードやリンクは、届いた時刻とともにそのまま返されます。
- 固定のスリープは不要です。 メールが届くとすぐに待機が終わり、
sinceにより古いコードが返されることはありません。
移行の手順
- 登録ステップの Gmail のアドレスを、
createAddressの新しいアドレスに置き換えます。 - 受信トレイのポーリングと正規表現を、
waitForCodeまたはwaitForLinkに置き換えます。 - CI から Gmail の認証情報と、トークンを更新するジョブを削除します。
Playwright、Cypress、pytest のガイドでは、各フレームワークで同じ手順を説明しています。