Write end-to-end tests for your web apps with Playwright and pytest.
- Support for all modern browsers including Chromium, WebKit and Firefox.
- Support for headless and headful execution.
- Built-in fixtures that provide browser primitives to test functions.
pip install pytest-playwright
Use the page
fixture to write a basic test. See more examples.
def test_example_is_working(page):
page.goto("https://example.com")
assert page.innerText('h1') == 'Example Domain'
page.click("text=More information")
To run your tests, use pytest CLI.
# Run tests (Chromium and headless by default)
pytest
# Run tests in headful mode
pytest --headful
# Run tests in a different browser (chromium, firefox, webkit)
pytest --browser firefox
# Run tests in multiple browsers
pytest --browser chromium --browser webkit
This plugin configures Playwright-specific fixtures for pytest. To use these fixtures, use the fixture name as an argument to the test function.
def test_my_app_is_working(fixture_name):
# Test using fixture_name
# ...
Function scope: These fixtures are created when requested in a test function and destroyed when the test ends.
context
: New browser context for a test.page
: New browser page for a test.
Session scope: These fixtures are created when requested in a test function and destroyed when all tests end.
browser
: Browser instance launched by Playwright.browser_name
: Browser name as string.is_chromium
,is_webkit
,is_firefox
: Booleans for the respective browser types.
Customizing fixture options: For browser
and context
fixtures, use the the following fixtures to define custom launch options.
browser_type_launch_args
: Override launch arguments forbrowserType.launch()
. It should return a Dict.browser_context_args
: Override the options forbrowser.newContext()
. It should return a Dict.
from playwright.sync_api import Page
def test_visit_admin_dashboard(page: Page):
page.goto("/admin")
# ...
import pytest
@pytest.mark.skip_browser("firefox")
def test_visit_example(page):
page.goto("https://example.com")
# ...
import pytest
@pytest.mark.only_browser("chromium")
def test_visit_example(page):
page.goto("https://example.com")
# ...
Start Pytest with the base-url
argument.
pytest --base-url http://localhost:8080
def test_visit_example(page):
page.goto("/admin")
# -> Will result in http://localhost:8080/admin
Use the breakpoint()
statement in your test code to pause execution and get a pdb REPL.
def test_bing_is_working(page):
page.goto("https://bing.com")
breakpoint()
# ...
You can capture screenshots for failed tests with a pytest runtest hook. Add this to your conftest.py
file.
Note that this snippet uses slugify
to convert test names to file paths, which can be installed with pip install python-slugify
.
# In conftest.py
from slugify import slugify
from pathlib import Path
def pytest_runtest_makereport(item, call) -> None:
if call.when == "call":
if call.excinfo is not None:
page = item.funcargs["page"]
screenshot_dir = Path(".playwright-screenshots")
screenshot_dir.mkdir(exist_ok=True)
page.screenshot(path=str(screenshot_dir / f"{slugify(item.nodeid)}.png"))
Use the Playwright GitHub Action or guides for other CI providers to deploy your tests to CI/CD
Thanks to Max Schmitt for creating and maintaining this project.