Python (pytest, Selenium, Playwright)

本页由英文自动翻译。

添加 helper

把这个辅助工具复制到你的测试文件夹。它只用标准库，无需安装任何东西，并从 PROXYMAIL_QA_API_KEY 读取 API 密钥：

"""Disposable inboxes for Python tests (pytest with Selenium or Playwright):
create a test address, sign up with it in your app, then wait for the code or
link from the email it gets. Guide: https://proxymail.qa/docs/python

The API key comes from the test run's environment (PROXYMAIL_QA_API_KEY).
When PROXYMAIL_QA_RUN is set (start_run, or the GitHub Action), every call
adds what it saw to that run. Standard library only; Python 3.9 or later.
"""

import contextlib
import json
import math
import os
import time
import urllib.error
import urllib.parse
import urllib.request
from datetime import datetime, timezone

BASE_URL = os.environ.get("PROXYMAIL_QA_API_URL", "https://api.proxymail.qa/v1")
# Sent with every call. Some networks and firewalls turn away Python's
# default user agent (Python-urllib), so the helper names itself.
USER_AGENT = "proxymail-qa-python/1"


class ProxyMailQAError(Exception):
    """An API error. When a wait finds nothing, hint says why (an email
    provider in sandbox mode, say), and the message includes it."""

    def __init__(self, status, message, hint=None):
        super().__init__(f"{message} {hint}" if hint else message)
        self.status = status
        self.hint = hint


def _request(method, path, body=None, retry=False):
    key = os.environ.get("PROXYMAIL_QA_API_KEY")
    if not key:
        raise RuntimeError("Set PROXYMAIL_QA_API_KEY for the test run.")
    headers = {"Authorization": f"Bearer {key}", "Content-Type": "application/json", "User-Agent": USER_AGENT}
    run = os.environ.get("PROXYMAIL_QA_RUN")
    if run:
        headers["Proxy-Mail-QA-Run"] = run
        # A wait that will be asked again: its "nothing arrived" isn't evidence yet.
        if retry:
            headers["Proxy-Mail-QA-Run-Retry"] = "true"
        # The test this call belongs to (set_test, or the pytest hooks below).
        if _test["name"]:
            headers["Proxy-Mail-QA-Test"] = urllib.parse.quote(_test["name"], safe="")
    request = urllib.request.Request(
        BASE_URL + path,
        method=method,
        data=None if body is None else json.dumps(body).encode(),
        headers=headers,
    )
    try:
        with urllib.request.urlopen(request, timeout=40) as response:
            raw = response.read()
            if response.headers.get("Content-Type", "").startswith("text/markdown"):
                return raw.decode()
            return json.loads(raw) if raw else None
    except urllib.error.HTTPError as error:
        try:
            payload = json.loads(error.read() or b"{}")
        except ValueError:
            # Not the API's answer: a wrong address, or a proxy or firewall on the way.
            payload = {"message": f"HTTP {error.code} from {BASE_URL}, but not from the Proxy Mail QA API. Check PROXYMAIL_QA_API_URL, and whether a proxy or firewall turned the call away."}
        raise ProxyMailQAError(error.code, payload.get("message", str(error)), payload.get("hint")) from None


def create_address(**options):
    """A new test address with a persona and a password for the sign-up form:
    {"address": ..., "password": ..., "persona": {...}}. Options include
    label, lifetime_days, domain, age ("adult", "under13", ...), country, and
    where it's used: site (a host or page URL) and environment ("staging")."""
    return _request("POST", "/addresses", {"persona": True, "password": True, **options})


def form_values(fields, address=None, **options):
    """What to type or pick in each field of a sign-up form. fields lists what
    the page says about each one: {"id", "type", "name", "label",
    "placeholder", "autocomplete", "pattern", "min_length", "max_length",
    "options": [{"value", "label"}]}. Returns {"address", "password",
    "values": [{"id", "kind", "value", "note"}, ...]}, from a new address made
    for the form (options as for create_address, such as age) or the one
    given. You fill in the form."""
    body = {"fields": fields, **options}
    if address:
        body["address"] = address
    return _request("POST", "/form-values", body)


def find_addresses(tags=None, country=None, min_age=None, max_age=None, has_password=None, search=None, limit=None, site=None, environment=None):
    """Test accounts made earlier, newest first, where every filter given
    matches: find_addresses(tags=["age-gate"], country="GB", max_age=17)
    finds under-18s in GB. Ages are whole years today, from the persona's
    date of birth; search is part of the address, label, notes, name or
    username; site and environment are where it's used."""
    query = [("tag", tag) for tag in tags or []]
    filters = (("country", country), ("min_age", min_age), ("max_age", max_age), ("search", search), ("limit", limit), ("site", site), ("environment", environment))
    for name, value in filters:
        if value is not None:
            query.append((name, value))
    if has_password is not None:
        query.append(("has_password", "true" if has_password else "false"))
    return _request("GET", "/addresses" + ("?" + urllib.parse.urlencode(query) if query else ""))


def check_out_account(tags=None, country=None, min_age=None, max_age=None, has_password=None, search=None, minutes=None, site=None, environment=None):
    """An account from the pool: one matching every filter given that nobody
    else has checked out (the least recently used first), held for `minutes`
    (default 10). Raises ProxyMailQAError 409 when every match is checked
    out, 404 when none match. Tag accounts with their state (verified,
    premium, ...) to make pools."""
    filters = {"tags": tags, "country": country, "min_age": min_age, "max_age": max_age, "has_password": has_password, "search": search, "minutes": minutes}
    filters.update(site=site, environment=environment)
    return _request("POST", "/addresses/checkout", {name: value for name, value in filters.items() if value is not None})


def sign_in_account(site=None, environment=None, tags=None):
    """The saved test account to sign in with, and its password, in one call:
    one with a saved password and every tag given, used on this site first,
    then the one that got mail most recently. None when none fits. Needs a
    key created with "Can read saved passwords"; every reveal is logged."""
    body = {name: value for name, value in (("site", site), ("environment", environment), ("tags", tags)) if value is not None}
    try:
        return _request("POST", "/addresses/sign-in", body)
    except ProxyMailQAError as error:
        if error.status == 404:
            return None
        raise


def mark_dev_host(host):
    """Marks a host ("localhost:3000") as a dev environment of the project:
    links to it then pass check_email's local-links check."""
    return _request("POST", "/project/dev-hosts", {"host": host})["dev_hosts"]


def update_project(name=None, website=None, environments=None, email_prefix=None, mail_domain=None):
    """Changes the project, as in Project settings: its name, website,
    environments, email prefix or default mail domain. Only the arguments given
    change; website="" or email_prefix="" removes one. Needs the project's lead
    (or an organisation owner or admin), and is in the project's activity log."""
    fields = {"name": name, "website": website, "environments": environments, "email_prefix": email_prefix, "mail_domain": mail_domain}
    return _request("PATCH", "/project", {k: v for k, v in fields.items() if v is not None})


def extend_checkout(account, minutes=None):
    """Holds a checked-out account longer: `minutes` from now (default 10,
    at most 60)."""
    body = {"token": account["checkout"]["token"]}
    if minutes is not None:
        body["minutes"] = minutes
    return _request("POST", f"/addresses/{urllib.parse.quote(account['address'])}/extend", body)


def return_account(account, add_tags=None, remove_tags=None):
    """Frees a checked-out account for the next test, recording the state
    it was left in (tags to add and remove)."""
    body = {"token": account["checkout"]["token"], "add_tags": add_tags, "remove_tags": remove_tags}
    return _request("POST", f"/addresses/{urllib.parse.quote(account['address'])}/return", body)


@contextlib.contextmanager
def checked_out_account(create=None, check=None, reset=None, new_account=None, attempts=3, **filters):
    """with checked_out_account(tags=["premium"]) as account: ... checks an
    account out and always returns it.

    Hooks make it an account in the state the test needs. Your test code runs
    them, with your own access to the app; Proxy Mail QA never signs in to it.
    create(account) makes a new one when none is free: sign up with
    account["address"] and account["password"], verify it and set its state
    (new_account holds create_address options such as age or label).
    check(account) confirms the state: return False or raise when it isn't,
    and it's reset and checked again, or another account is tried; one that
    still fails loses the filter's tags and is tagged check-failed.
    reset(account) restores the state afterwards; if it fails, the account
    loses the filter's tags and is tagged needs-reset."""
    account = _prepare_account(create, check, reset, new_account or {}, attempts, filters)
    try:
        yield account
    except BaseException:
        with contextlib.suppress(Exception):
            _restore_account(account, reset, filters)
        raise
    _restore_account(account, reset, filters)


def _prepare_account(create, check, reset, new_account, attempts, filters):
    tried, last = [], ""
    for _ in range(attempts):
        try:
            account = check_out_account(**filters)
        except ProxyMailQAError as error:
            if error.status not in (404, 409):
                raise
            # None matches, or every match is busy: make one, if the test can.
            if create:
                return _new_account(create, check, new_account, filters)
            if tried:  # accounts that failed their check have left the pool
                break
            raise
        if account["address"] in tried:  # every match has been tried
            with contextlib.suppress(Exception):
                return_account(account)
            break
        tried.append(account["address"])
        problem = _failed_check(check, account)
        if problem is None:
            return account
        if reset:
            try:
                reset(account)
                problem = _failed_check(check, account)
            except Exception as error:
                problem = f"reset failed: {error}"
            if problem is None:
                return account
        last = problem
        _note(f"Test account failed its check ({problem}); it loses its tags and is tagged check-failed.", account["address"])
        with contextlib.suppress(Exception):
            return_account(account, add_tags=["check-failed"], remove_tags=filters.get("tags"))
    if create:
        return _new_account(create, check, new_account, filters)
    tried_text = f": tried {', '.join(tried)}" + (f" (last: {last})" if last else "") if tried else ""
    raise RuntimeError(f"No test account passed the check{tried_text}. Pass create to make one.")


def _new_account(create, check, new_account, filters):
    """Makes an account with the create hook, held from the start so no
    parallel test takes it half made, then tags and checks it."""
    tags = [tag.lower() for tag in filters.get("tags") or []]
    min_age, max_age = filters.get("min_age"), filters.get("max_age")
    if (min_age is not None or max_age is not None) and not (new_account.get("age") or new_account.get("date_of_birth")):
        raise ValueError("Give new_account an age or date_of_birth, so new accounts match min_age and max_age.")
    options = {**new_account}
    if filters.get("country") and "country" not in options:
        options["country"] = filters["country"]
    created = create_address(**options)
    held = check_out_account(search=created["address"], minutes=filters.get("minutes"))
    if held["address"] != created["address"]:
        with contextlib.suppress(Exception):
            return_account(held)
        raise RuntimeError(f"Couldn't hold the new account {created['address']}.")
    try:
        create({**held, "password": created["password"]})
        tagged = _set_tags(created["address"], sorted(set(held["tags"]) | set(tags)))
        account = {**tagged, "checkout": held["checkout"]}
        age = _age((account.get("persona") or {}).get("date_of_birth"))
        if age is not None and ((min_age is not None and age < min_age) or (max_age is not None and age > max_age)):
            raise ValueError(f"The new account is {age}, outside min_age and max_age: give new_account a matching age.")
        problem = _failed_check(check, account)
        if problem is not None:
            raise RuntimeError(f"The new account {created['address']} failed its check after create: {problem}")
        _note("Made a new test account" + (f" tagged {', '.join(tags)}." if tags else "."), created["address"])
        return account
    except BaseException:
        # Untagged, it stays out of the pool; it expires with its address.
        with contextlib.suppress(Exception):
            _set_tags(created["address"], held["tags"])
        with contextlib.suppress(Exception):
            return_account(held)
        raise


def _restore_account(account, reset, filters):
    """Runs reset, then returns the account. If reset fails, the account
    leaves the pool's state (needs-reset) and the error is raised."""
    if reset:
        try:
            reset(account)
        except Exception as error:
            _note(f"Couldn't reset the test account ({error}); it loses its tags and is tagged needs-reset.", account["address"])
            with contextlib.suppress(Exception):
                return_account(account, add_tags=["needs-reset"], remove_tags=filters.get("tags"))
            raise
    with contextlib.suppress(Exception):
        return_account(account)


def _failed_check(check, account):
    """None when the account passes (or there's no check), or why it doesn't."""
    if check is None:
        return None
    try:
        return "check returned False" if check(account) is False else None
    except Exception as error:  # such as an AssertionError
        return str(error) or type(error).__name__


def _set_tags(address, tags):
    return _request("PATCH", f"/addresses/{urllib.parse.quote(address)}", {"tags": tags})


def _age(date_of_birth):
    """Whole years from a YYYY-MM-DD date of birth, or None without one."""
    if not date_of_birth:
        return None
    born, today = datetime.strptime(date_of_birth, "%Y-%m-%d").date(), datetime.now(timezone.utc).date()
    return today.year - born.year - ((today.month, today.day) < (born.month, born.day))


def _note(text, address):
    """Adds a line to the current run, if there is one, without failing the test."""
    if os.environ.get("PROXYMAIL_QA_RUN"):
        with contextlib.suppress(Exception):
            add_run_note(text, address=address)


def _wait(kind, address, since, timeout, extra):
    deadline = time.monotonic() + timeout
    since = since.astimezone(timezone.utc).isoformat()
    while True:
        left = max(0, min(30, int(deadline - time.monotonic())))
        query = urllib.parse.urlencode({"since": since, "timeout": left, **extra})
        more = time.monotonic() + left < deadline - 0.5
        try:
            return _request("GET", f"/addresses/{urllib.parse.quote(address)}/{kind}?{query}", retry=more)
        except ProxyMailQAError as error:
            # Only a wait that found nothing is repeated, until the timeout.
            if error.status != 404 or not str(error).startswith(f"No {kind} arrived") or time.monotonic() >= deadline - 0.5:
                raise


def wait_for_code(address, since, timeout=30, unused=False, type=None):
    """The code from the newest email received since `since` (a datetime),
    waiting up to `timeout` seconds. unused=True skips codes already used
    (returned by an earlier wait, or copied or filled in the app or Proxy
    Mail QA for Chrome). type="coupon" waits for a coupon or promo code
    instead, "any" for either."""
    extra = {"unused": "true"} if unused else {}
    if type and type != "otp":
        extra["type"] = type
    return _wait("code", address, since, timeout, extra)["value"]


def wait_for_coupon(address, since, timeout=300, unused=False):
    """The coupon or promo code from the newest offer email received since
    `since`, waiting up to `timeout` seconds (offers often come minutes
    later): {"code", "discount", "valid_until", "after_seconds"}, where
    discount is our "20% off" and valid_until a date, when the email states
    them."""
    match = _wait("code", address, since, timeout, {"type": "coupon", **({"unused": "true"} if unused else {})})
    return {"code": match["value"], "discount": match.get("discount"), "valid_until": match.get("valid_until"), "after_seconds": match.get("after_seconds")}


def wait_for_link(address, since, type="verify", app=None, timeout=30, unused=False):
    """The link from the newest email received since `since`: verify,
    magic_signin, invite, reset or any; or unsubscribe (the email's own
    unsubscribe link) or list_unsubscribe (the List-Unsubscribe header's).
    app=True asks for the link that opens a mobile app (myapp://...) when the
    email also has a web one; unused=True skips links already used."""
    extra = {"type": type, **({} if app is None else {"app": "true" if app else "false"}), **({"unused": "true"} if unused else {})}
    return _wait("link", address, since, timeout, extra)["value"]


def _count_query(since, type, subtype, service, category=None, **extra):
    query = {key: value for key, value in extra.items()}
    if category:
        query["category"] = category
    if since is not None:
        query["since"] = since if isinstance(since, str) else since.astimezone(timezone.utc).isoformat()
    if service:
        query["service"] = service
    if type:
        query["type"] = type
    if subtype:
        query["subtype"] = subtype if isinstance(subtype, str) else ",".join(subtype)
    return "?" + urllib.parse.urlencode(query) if query else ""


def count_emails(address, since=None, type=None, subtype=None, service=None, category=None):
    """How many emails reached the address, each summarised without its
    content: {"count": ..., "emails": [{"received_at", "service", "type",
    "subtype", "category", "gap_seconds", "attachments"}, ...]}. type is
    "code" or "link"; category is "auth", "transactional" or "marketing";
    without since, every email the address has received. Count after waiting
    for the first email, so a duplicate has had time to arrive."""
    query = _count_query(since, type, subtype, service, category)
    return _request("GET", f"/addresses/{urllib.parse.quote(address)}/count{query}")


def check_email(
    address, since=None, type=None, subtype=None, service=None, email_id=None, expect_host=None, expect_text=None,
    expect_language=None, expect_within=None, category=None, expect_attachment=None,
):
    """Checks one email the address received (the newest that matches, or
    email_id): SPF, DKIM and DMARC, local and plain http links, where its link
    goes (expect_host), a stated expiry, a plain-text part, size, image-only
    emails, phrases it should contain (expect_text, a list) and its language
    (expect_language, such as "de"), and how soon after since it arrived
    (expect_within, such as "5m"), and the attachments it should have
    (expect_attachment, a list: "application/pdf", ".ics", "invoice-*.pdf").
    Returns {"passed", "failed", "warnings",
    "checks": [{"check", "status", "detail"}, ...]}, never the email's content.
    Wait for the email first."""
    query = _count_query(since, type, subtype, service, category)
    extra = [(name, value) for name, value in (("email_id", email_id), ("expect_host", expect_host), ("expect_language", expect_language), ("expect_within", expect_within)) if value]
    extra += [("expect_text", phrase) for phrase in expect_text or []]
    extra += [("expect_attachment", pattern) for pattern in expect_attachment or []]
    if extra:
        query += ("&" if query else "?") + urllib.parse.urlencode(extra)
    return _request("GET", f"/addresses/{urllib.parse.quote(address)}/checks{query}")


def expect_no_email(address, since=None, timeout=30, type=None, subtype=None, service=None, category=None):
    """Returns when no matching email arrives within `timeout` seconds, for
    checks such as "an unsubscribed user gets nothing" (category="marketing",
    so receipts can still arrive); raises
    ProxyMailQAError (status 409) as soon as one does. Pass since as the time
    of the action, so an email that came before the call still counts;
    without it, from now."""
    deadline = time.monotonic() + timeout
    while True:
        left = max(0, min(30, math.ceil(deadline - time.monotonic())))
        query = _count_query(since, type, subtype, service, category, timeout=left)
        more = time.monotonic() + left < deadline - 0.5
        result = _request("GET", f"/addresses/{urllib.parse.quote(address)}/none{query}", retry=more)
        # The server's since, so later requests watch from the same moment.
        since = result["since"]
        if time.monotonic() >= deadline - 0.5:
            return result


def mark_unsubscribed(address, email_id=None, service=None, at=None, grace=None):
    """Records that the address unsubscribed from a sender, after the test did
    it in its own browser (Proxy Mail QA never opens unsubscribe links). Any
    later marketing email from that sender fails after_unsubscribe, however
    long after. Name the sender with email_id or service (a name or domain);
    with neither, the newest marketing email decides. at backdates it, and
    grace ("2h", "1d") lets marketing already on its way through."""
    if at is not None and not isinstance(at, str):
        at = at.astimezone(timezone.utc).isoformat()
    body = {"email_id": email_id, "service": service, "at": at, "grace": grace}
    return _request("POST", f"/addresses/{urllib.parse.quote(address)}/unsubscribed", {k: v for k, v in body.items() if v is not None})


def mark_resubscribed(address, service=None, email_id=None):
    """The address subscribed again: ends the watch for that sender (the only
    one, when there's one)."""
    query = urllib.parse.urlencode({k: v for k, v in {"service": service, "email_id": email_id}.items() if v is not None})
    return _request("DELETE", f"/addresses/{urllib.parse.quote(address)}/unsubscribed" + (f"?{query}" if query else ""))


def check_unsubscribe(address):
    """Each unsubscribe and the marketing emails from that sender that came
    after it, by id and how long after: {"passed", "watches": [...]}."""
    return _request("GET", f"/addresses/{urllib.parse.quote(address)}/unsubscribed")


def offers(address):
    """Each sender's coupons and which version of the address each went to
    (plain, capitals or +tag). Mail to all of them reaches one inbox, so
    passed is False when an offer reached two or more: one person got it
    twice."""
    return _request("GET", f"/addresses/{urllib.parse.quote(address)}/offers")


def check_sequence(address, steps, since=None):
    """Whether a welcome series or drip campaign came in order and on time:
    each step is a dict with any of subject (a phrase), category, type ("code"
    or "link"), after ("1d") and within ("2h"). Each answers pass, early,
    late, missing or waiting; "done" is False while one is still waiting."""
    if since is not None and not isinstance(since, str):
        since = since.astimezone(timezone.utc).isoformat()
    body = {"steps": steps, **({"since": since} if since else {})}
    return _request("POST", f"/addresses/{urllib.parse.quote(address)}/sequence", body)


def record_coupon_result(address, result, code=None, email_id=None, message=None, one_time=False, discount_applied=None):
    """After applying a coupon at checkout (on staging with test payments,
    never real card details), records what the app did: "accepted",
    "rejected" or "error", with its message. The answer's "check" is the
    coupon_result verdict: it fails a coupon accepted after its end date, for
    an offer already given to another version of the address, or twice when
    one_time."""
    body = {"result": result, "code": code, "email_id": email_id, "message": message, "one_time": one_time, "discount_applied": discount_applied}
    return _request("POST", f"/addresses/{urllib.parse.quote(address)}/coupon-result", {k: v for k, v in body.items() if v is not None})


_KEEP = object()


def record_consent(address, marketing=_KEEP, prechecked=_KEEP, double_opt_in=_KEEP):
    """Records what the address agreed to at sign-up: marketing ("opted_in"
    or "declined"), prechecked (the box was ticked when the form loaded) and
    double_opt_in ("confirmed" or "pending"). Only what's given changes.
    check_email then judges marketing email by the rules where the persona
    lives (a test aid, not legal advice)."""
    given = {"marketing": marketing, "prechecked": prechecked, "double_opt_in": double_opt_in}
    return _request("PUT", f"/addresses/{urllib.parse.quote(address)}/consent", {k: v for k, v in given.items() if v is not _KEEP})


def consent(address):
    """What the address agreed to, as recorded."""
    return _request("GET", f"/addresses/{urllib.parse.quote(address)}/consent")


def start_run(name, source=None, meta=None):
    """Starts a run: later calls (from this process and any it starts) add
    what they saw, for a report on the pull request. Returns {"id", "url",
    ...}. In GitHub Actions, the Proxy Mail QA action does this for you."""
    run = _request("POST", "/runs", {"name": name, "meta": meta or {}, **({"source": source} if source else {})})
    os.environ["PROXYMAIL_QA_RUN"] = run["id"]
    return run


def add_run_note(text, failed=False, address=None):
    """A line of your own in the run; failed=True fails it."""
    _request("POST", f"/runs/{os.environ['PROXYMAIL_QA_RUN']}/notes", {"text": text, "failed": failed, "address": address})


def finish_run(failed=False):
    """Finishes the run: passed unless an email was missing or came when none
    should have, an email check, a test, or an unsubscribe, offer or coupon
    check failed, a note failed it, or failed=True says the tests failed."""
    return _request("POST", f"/runs/{os.environ.pop('PROXYMAIL_QA_RUN')}/finish", {"failed": failed})


def set_test(name):
    """Names the test the following calls belong to (None for none), so the
    run's report says which test each email came from. The pytest hooks at
    the end of this file do it for you."""
    _test["name"] = " ".join(str(name).split())[:200] if name else None


def record_test(name, status, duration_ms=None, error=None):
    """A test's result in the run: status is "passed", "failed", "flaky" or
    "skipped", and a failed test fails the run."""
    body = {"name": name, "status": status, "duration_ms": duration_ms, "error": error}
    _request("POST", f"/runs/{os.environ['PROXYMAIL_QA_RUN']}/tests", {key: value for key, value in body.items() if value is not None})


def record_test_totals(passed, failed, skipped=0, flaky=0):
    """How the suite went, for the top of the run's report."""
    totals = {"passed": passed, "failed": failed, "skipped": skipped, "flaky": flaky}
    _request("POST", f"/runs/{os.environ['PROXYMAIL_QA_RUN']}/tests", {"totals": totals})


def run_report(run_id=None):
    """The run's report in Markdown, for a pull request or job summary."""
    return _request("GET", f"/runs/{run_id or os.environ['PROXYMAIL_QA_RUN']}?format=markdown")


def update_address(address, **changes):
    """Changes a test account's details, such as after the app changed them:
    first_name, last_name, username, date_of_birth, country, label, notes or
    tags. None clears one."""
    return _request("PATCH", f"/addresses/{urllib.parse.quote(address)}", changes)


def set_password(address, password=None, label="password"):
    """Saves the password a test account uses now, after the app changed or
    reset it. Without one, a strong password is generated and returned once,
    as "password"."""
    body = {"label": label}
    if password is not None:
        body["password"] = password
    return _request("PUT", f"/addresses/{urllib.parse.quote(address)}/password", body)


def variants(address):
    """Versions of the address for testing a sign-up form: "delivered" ones
    (capitals, plus tags with special characters) whose mail reaches its
    inbox, "undeliverable" ones, and "invalid" ones it should reject."""
    return _request("GET", f"/addresses/{urllib.parse.quote(address)}/variants")


def name_variants(field=None, max_length=None):
    """Awkward names for a form's name field ("first_name", "last_name",
    "full_name" or "display_name"): "accept" (apostrophes, accents, other
    scripts, one letter, exactly max_length), "reject" (over max_length,
    empty, only spaces), "store_as_text" (HTML or SQL the app must store as
    typed, never run) and "decide" (digits, symbols, emoji, spaces around,
    very long ones: note what the app did)."""
    query = {k: v for k, v in {"field": field, "max_length": max_length}.items() if v is not None}
    return _request("GET", "/variants/names" + ("?" + urllib.parse.urlencode(query) if query else ""))


def password_variants(min_length=None, max_length=None, symbols=None):
    """Awkward passwords within the field's rules: "accept" (the minimum and
    maximum, each symbol class, spaces, non-ASCII), "reject" (one under or
    over, a symbol where none are allowed) and "decide" (only digits, only
    lower case, a space at the start or end, emoji, composed and decomposed
    accents, bcrypt's 72 bytes). Fresh each call."""
    query = {k: v for k, v in {"min_length": min_length, "max_length": max_length}.items() if v is not None}
    if symbols is not None:
        query["symbols"] = "true" if symbols else "false"
    return _request("GET", "/variants/passwords" + ("?" + urllib.parse.urlencode(query) if query else ""))


def delete_address(address):
    _request("DELETE", f"/addresses/{urllib.parse.quote(address)}")


def now():
    """The time to pass as `since`: call it just before submitting the form."""
    return datetime.now(timezone.utc)


# pytest: in a run (PROXYMAIL_QA_RUN), the report says which test each email
# came from, records each failed test with the start of its error, and shows
# the totals. Turn it on by importing the hooks into your conftest.py:
#
#   from proxymail_qa import pytest_runtest_setup, pytest_runtest_teardown, pytest_runtest_logreport, pytest_sessionfinish

_test = {"name": None}
_totals = {"passed": 0, "failed": 0, "skipped": 0, "flaky": 0}


def _test_name(nodeid):
    """tests/test_signup.py::TestSignUp::test_code[firefox] reads as
    TestSignUp › test_code[firefox]."""
    return " › ".join(nodeid.split("::")[1:]) or nodeid


def pytest_runtest_setup(item):
    set_test(_test_name(item.nodeid))


def pytest_runtest_teardown(item):
    set_test(None)


def pytest_runtest_logreport(report):
    if not os.environ.get("PROXYMAIL_QA_RUN"):
        return
    if report.skipped and report.when in ("setup", "call"):
        _totals["skipped"] += 1
    elif report.failed and report.when in ("setup", "call"):
        _totals["failed"] += 1
        # pytest's one-line summary of the failure, such as "AssertionError: …".
        crash = getattr(getattr(report.longrepr, "reprcrash", None), "message", None)
        error = " ".join((crash or str(report.longrepr).strip().splitlines()[-1]).split())[:300]
        with contextlib.suppress(Exception):
            record_test(_test_name(report.nodeid), "failed", round(report.duration * 1000), error)
    elif report.passed and report.when == "call":
        _totals["passed"] += 1


def pytest_sessionfinish(session, exitstatus):
    if os.environ.get("PROXYMAIL_QA_RUN") and any(_totals.values()):
        with contextlib.suppress(Exception):
            record_test_totals(**_totals)

Selenium

一个用 Selenium 编写、输入验证码的注册测试。

from selenium.webdriver.common.by import By

from proxymail_qa import create_address, delete_address, now, wait_for_code


def test_sign_up_sends_a_working_code(driver):  # your WebDriver fixture
    account = create_address()
    driver.get("https://staging.example.com/signup")
    driver.find_element(By.NAME, "email").send_keys(account["address"])
    driver.find_element(By.NAME, "password").send_keys(account["password"])

    submitted = now()
    driver.find_element(By.CSS_SELECTOR, "button[type=submit]").click()

    code = wait_for_code(account["address"], since=submitted)
    driver.find_element(By.NAME, "code").send_keys(code)
    delete_address(account["address"])

Python 的 Playwright

或者用 Python 的 Playwright，打开验证链接。

since 让等待忽略表单提交之前发送的任何邮件。等待最长 30 秒；需要更久时传入 timeout。如果没有邮件到达，ProxyMailQAError 会尽 Proxy Mail QA 所知说明原因，例如你的应用的邮件服务商只向已验证地址发信。

如果是验证码而不是链接，使用 wait_for_code；打开移动应用的链接，使用 wait_for_link(address, since, app=True)。

import re

from playwright.sync_api import Page, expect

from proxymail_qa import create_address, delete_address, now, wait_for_link


def test_sign_up_verifies_the_email(page: Page):
    account = create_address()
    page.goto("/signup")
    page.get_by_label("Email").fill(account["address"])
    page.get_by_label("Password").fill(account["password"])

    submitted = now()
    page.get_by_role("button", name="Sign up").click()

    page.goto(wait_for_link(account["address"], since=submitted))
    expect(page).to_have_url(re.compile("verified"))
    delete_address(account["address"])

注册表单的填写值

form_values 会为表单的每个字段给出要输入或选择的值，来自为此新建的地址：符合字段规则的用户名和密码、符合字段格式的出生日期、下拉列表中提供的国家。按页面上的样子描述每个字段，然后填写：

result = form_values([
    {"id": "email", "type": "email", "label": "Email"},
    {"id": "pw", "type": "password", "label": "Password", "min_length": 12},
    {"id": "dob", "type": "text", "label": "Date of birth", "placeholder": "DD/MM/YYYY"},
])
for field in result["values"]:
    if field["value"] is not None:
        page.locator(f"#{field['id']}").fill(field["value"])

age= 和 country= 决定新地址的形式；address= 使用之前创建的地址。详见 REST API 指南。

检查邮件没有到达，或只到达一次

有些测试在什么都没发生时才算通过：已退订的用户收不到新闻简报，一分钟内第二次重置请求会被拒绝。expect_no_email 会监视地址，一旦有匹配的邮件到达就抛出 ProxyMailQAError（状态码 409）。count_emails 统计到达的邮件数，用于“恰好一封验证邮件”：

import time

from proxymail_qa import count_emails, expect_no_email, now, wait_for_link


def test_unsubscribed_users_get_no_newsletter(app, unsubscribed):
    sent = now()
    app.send_newsletter()
    expect_no_email(unsubscribed["address"], since=sent, timeout=20)


def test_sign_up_sends_one_verification_email(page, account):
    submitted = now()
    page.get_by_role("button", name="Sign up").click()
    wait_for_link(account["address"], since=submitted)
    time.sleep(10)  # give a duplicate time to arrive
    assert count_emails(account["address"], since=submitted, type="link")["count"] == 1

两者都不返回邮件内容：每封邮件只概括为到达时间、发件人，以及是否含有验证码或链接。筛选条件：type（"code" 或 "link"）、subtype（例如 "verify" 或 "reset"）、service 和 category（"marketing"，这样收据仍可到达）。

要测试退订本身，在测试的浏览器中退订，然后记录下来：mark_unsubscribed(address, email_id=...)（或 service="acme.com"，对已在途中的邮件用 grace="1d"）。之后该发件人的任何营销邮件都会让 after_unsubscribe 失败，有邮件到达时 check_unsubscribe(address)["passed"] 为 false；mark_resubscribed(address) 结束监视。其余内容见 REST API 指南，在 CI 中运行介绍密钥、并行运行和清理。

检查邮件的发送和构建

check_email 会对到达的邮件运行检查：SPF、DKIM 和 DMARC，指向 localhost 或纯 http 的链接，链接指向哪里，是否说明登录验证码或链接何时过期，纯文本部分，大小和纯图片邮件，以及在你要求时，邮件应包含的短语（expect_text=[...]）和语言（expect_language="de"）。它返回检查结论，从不返回邮件内容：

from proxymail_qa import check_email, now, wait_for_link


def test_verification_email_is_well_built(page, account):
    submitted = now()
    page.get_by_role("button", name="Sign up").click()
    wait_for_link(account["address"], since=submitted)
    result = check_email(account["address"], since=submitted, type="link", expect_host="staging.example.com")
    assert result["passed"], [c for c in result["checks"] if c["status"] == "fail"]

各项检查的含义见 REST API 指南。要测试在你本机运行的应用？执行一次 mark_dev_host("localhost:3000")，指向它的链接就能通过 local_links。

用于并行测试的账号池

为账号标记其状态，然后让每个测试借用一个其他测试都没在用的账号：with checked_out_account(tags=["verified", "premium"]) as account: 借出一个账号，并始终归还。要记录测试做了哪些改动，在 check_out_account(...) 之后自己调用 return_account(account, add_tags=[...], remove_tags=[...])。详见 REST API 指南。

当测试需要在你的应用中处于特定状态的账号（已验证、高级套餐、没有订单）时，传入三个钩子。这些钩子由你的测试代码用它自己对应用的访问权限运行；Proxy Mail QA 从不登录你的应用。这里 app 代表你自己与应用交互的代码。

def create(account):  # when none is free: sign up, verify, upgrade
    submitted = now()
    app.sign_up(account["address"], account["password"])
    app.open(wait_for_link(account["address"], since=submitted))
    app.admin.set_plan(account["address"], "premium")


def check(account):  # still in that state? Return False or raise if not
    return app.admin.user(account["address"])["plan"] == "premium"


def reset(account):  # after the test: put it back
    app.admin.reset_user(account["address"], plan="premium", orders=[])


with checked_out_account(tags=["verified", "premium"], create=create, check=check, reset=reset) as account:
    ...

未通过 check 的账号会被重置并再次检查；仍未通过的账号会失去池标签，被标记为 check-failed，然后尝试下一个（attempts，默认 3）。没有匹配或全部已借出时运行 create，作用于从一开始就为此测试保留的新地址（new_account 接受 create_address 选项，例如 age）。如果测试后 reset 失败，账号会被标记为 needs-reset 并离开账号池。Node.js 客户端的用法相同。

运行报告

设置 PROXYMAIL_QA_RUN 后，每次调用都会把看到的内容加入该运行：地址、哪些邮件到达及多快到达、验证码、每个链接指向哪里、各项检查，以及始终未到的邮件。在 GitHub Actions 中，Proxy Mail QA action 会设置它并把报告发布到拉取请求上。在其他环境中，在测试前调用 start_run("Sign-up tests")（比如在会话级 fixture 中），测试后调用 finish_run(failed=...)；run_report() 以 Markdown 格式给出报告。

每封邮件来自哪个测试

在 pytest 中，把辅助工具的钩子导入 conftest.py。这样在运行中，每次调用都会写明所属测试，报告会显示每封邮件来自哪个测试，运行还会记录每个失败的测试及其错误的开头，以及总数：

from proxymail_qa import pytest_runtest_setup, pytest_runtest_teardown, pytest_runtest_logreport, pytest_sessionfinish

在运行之外它们不做任何事。其他运行器可以自己调用 set_test(name)、record_test(name, status, duration_ms, error) 和 record_test_totals(passed, failed, skipped, flaky)。

重新找到测试账号

find_addresses 返回之前创建的、匹配所有给定筛选条件的测试账号，最新的在前：tags、country、min_age 和 max_age（按今天计算的整岁，依据角色的出生日期）、has_password、search（地址、标注、备注、姓名或用户名的一部分），以及 site 和 environment（使用位置，用 create_address(site=..., environment=...) 设置）。

from proxymail_qa import find_addresses

teen = find_addresses(tags=["age-gate"], country="GB", max_age=17, has_password=True)[0]

sign_in_account(site=..., tags=[...]) 更进一步：返回用于登录的已保存测试账号及其密码，优先返回在此站点用过的账号，没有合适的则返回 None。它需要具有“可读取已保存密码”权限的密钥。

from proxymail_qa import sign_in_account

account = sign_in_account(site="staging.example.com", tags=["verified"])
page.get_by_label("Email").fill(account["address"])
page.get_by_label("Password").fill(account["password"])

保持测试账号同步

当测试在应用中修改了账号时，记录下来，让保存的信息仍能登录：修改或重置密码后调用 set_password(address, "the-new-password")（不传密码则生成一个，只返回一次）；新的姓名、用户名、出生日期或国家，或者标注、备注和标签，用 update_address(address, username="new_name")。

要用特殊但有效的地址测试注册表单，variants(address) 会列出邮件仍能到达该地址收件箱的变体，以及表单应拒绝的无效地址（详情）。对于表单的其他字段，name_variants(field="first_name", max_length=50) 和 password_variants(min_length=8, max_length=64, symbols=True) 提供可输入的姓名和密码，按应用应如何处理分组：accept、reject、store_as_text（绝不能执行的 HTML 或 SQL）和 decide（详情）。占用池中账号超出计划时间的测试可以调用 extend_checkout(account, minutes=20)。

优惠券和优惠

offers、record_coupon_result、check_sequence、record_consent、consent、mark_unsubscribed、mark_resubscribed 和 check_unsubscribe 属于营销和优惠邮件，这是一项 Labs 功能，由密钥的创建者在应用的 Account settings → Labs 中开启；开启前，调用会引发 403 错误并说明此情况。

注册某项优惠后，wait_for_coupon 会等待它的优惠券（默认 5 分钟，因为优惠邮件常常要过一阵才到），并返回优惠码、邮件中写明的折扣和有效期，以及它在 since 之后多久到达：

from proxymail_qa import check_email, now, wait_for_coupon

signed_up = now()
page.get_by_role("button", name="Get 20% off").click()
offer = wait_for_coupon(account["address"], since=signed_up)
assert offer["discount"] == "20% off"
assert check_email(account["address"], since=signed_up, type="code", subtype="coupon", expect_within="5m")["passed"]

要检查欢迎优惠是否每人只发一次，可以用同一地址的另一个版本再注册一次（variants(address)["delivered"] 会列出这些版本，比如 name+promo1@…）。如果优惠发给了不止一个版本，offers(address)["passed"] 就是 False。

在结账时使用优惠券后（在 staging 环境中使用测试支付），用 record_coupon_result(address, "accepted", message=...) 记录应用的处理结果；它的 ["check"] 就是 coupon_result 判定。以下情况会判定失败：优惠券在截止日期后仍被接受、重复使用的优惠被接受，或在 one_time=True 时被接受两次。

对于欢迎系列邮件或定时营销邮件，check_sequence(address, [{"subject": "Welcome"}, {"subject": "tips", "after": "1d"}], since=signed_up) 会说明每封邮件是否按顺序、按时到达。

要测试各国的营销规则，先用 country 创建地址，再在提交注册表单后调用 record_consent(address, marketing="declined", prechecked=False)；之后，如果发送了不该发的营销邮件，check_email(address, category="marketing") 会让 marketing_consent 判定失败。consent(address) 可读回这些记录。

wait_for_code(address, since, type="coupon") 只返回验证码。

对本页有疑问？

可以用任何语言提问。文档可以立即回答，你也可以把问题发给 Proxy Mail QA 团队，他们会用英文回复。

询问文档