英語から自動翻訳されています。

英語で読む
Proxy Mail QA

テスト用コードの受信トレイとして Gmail を使うのはやめましょう

始まりは単純です。チームの Gmail アカウント、テストごとのプラスアドレス、そしてコードを読むスクリプト。数か月後、トークンの期限切れで月曜の朝にテストが失敗し、2 つの実行が互いのコードを読み、誰かが手作業でサインインして直すことになります。

更新日:

実際の 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_KEY
const { 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 により古いコードが返されることはありません。

移行の手順

  1. 登録ステップの Gmail のアドレスを、createAddress の新しいアドレスに置き換えます。
  2. 受信トレイのポーリングと正規表現を、waitForCode または waitForLink に置き換えます。
  3. CI から Gmail の認証情報と、トークンを更新するジョブを削除します。

Playwright、Cypress、pytest のガイドでは、各フレームワークで同じ手順を説明しています。

次のサインアップテストで試してみてください

無料プラン、クレジットカード不要。アドレスを作成して、コードやリンクが届くのを確かめてください。

無料アカウントを作成アプリを開く

よくある質問

Gmail のトークンが 1 週間で使えなくなるのはなぜですか?

Google Cloud プロジェクトの OAuth 同意画面が Testing の場合、Google はリフレッシュトークンを 7 日で失効させます(アプリが名前、メール、プロフィールだけを求める場合は除きますが、それではメールを読めません)。アプリを公開すれば避けられますが、Gmail の読み取りスコープは制限されているため、公開アプリには先に Google の審査が必要になることがあります。

アプリパスワードで IMAP を使うだけではだめですか?

アプリパスワードを使うには、アカウントで2段階認証プロセスを有効にする必要があります。また、組織の Google Workspace 管理者はアプリパスワードを無効にできます。使える場合でも、すべてのテストが1つの受信トレイを共有し、ほかのメールの中から自分のメールを探す必要があります。

Gmail のプラスアドレスを使えば、テストごとに別のアドレスを持てます。それで十分ではありませんか?

テストごとに別のアドレスは持てますが、別の受信トレイは持てません。メールはすべて1つのメールボックスに届くため、スクリプトは正しいメールを探す必要があり、届くのが遅れたメールが別のテストと結び付けられることがあります。また、+ を含むアドレスを受け付けない登録フォームもあります。

テスト専用に2つ目の Gmail アカウントを作るのはどうですか?

Google は、自動化ソフトウェアで操作されているブラウザからのログインをブロックすることがあります。また、新しいアカウントでは電話番号の確認を求められることがあります。いずれの場合も人の操作が必要になり、そのアカウントがまた共有の受信トレイになります。

AI ツールでアプリを作りましたか?使ったツールを選んでください

このページについて質問がありますか?

質問はどの言語でもかまいません。ドキュメントからすぐに回答を得ることも、Proxy Mail QA チームに質問を送ることもできます。チームからの返信は英語です。