feat: make a screenshot if a test is failing

Author: mxschmitt

README.md

@@ -71,6 +71,10 @@ Possible values: `chromium`, `firefox`, `webkit`
 
 By default, the tests run in headless mode. You can pass the `--headful` CLI flag to run the browser in headful mode.
 
+### `--screenshot-on-error`
+
+By using the `--screenshot-on-error` argument for each failing test the screenshots will be stored in the `pytest_playwright` directory to upload them e.g. on your CI provider as an asset for debugging purposes.
+
 ## Examples
 
 ### Skipping by browser type

pytest_playwright/pytest_playwright.py

@@ -17,6 +17,8 @@
 import asyncio
 
 import pytest
+from pathlib import Path
+from slugify import slugify
 
 from playwright import sync_playwright
 from playwright.sync_api import Browser, BrowserContext, Page
@@ -42,6 +44,17 @@ def pytest_configure(config: Any) -> None:
     )
 
 
+def pytest_runtest_makereport(item: Any, call: Any) -> None:
+    if call.when == "call":
+        if call.excinfo is not None:
+            config = item.funcargs["pytestconfig"]
+            if config.getoption("--screenshot-on-error"):
+                page: Page = item.funcargs["page"]
+                screenshot_dir = Path(".playwright-screenshots")
+                screenshot_dir.mkdir(exist_ok=True)
+                page.screenshot(path=screenshot_dir / f"{slugify(item.nodeid)}.png")
+
+
 def _get_skiplist(request: Any, values: List[str], value_name: str) -> List[str]:
     skipped_values: List[str] = []
     # Allowlist
@@ -174,3 +187,9 @@ def pytest_addoption(parser: Any) -> None:
         default=False,
         help="Run tests in headful mode.",
     )
+    parser.addoption(
+        "--screenshot-on-error",
+        action="store_true",
+        default=False,
+        help="Saves a screenshot in the '.playwright-screenshots' directory if a test is failing",
+    )

setup.py

@@ -13,7 +13,12 @@
     url="https://github.com/microsoft/playwright-pytest",
     packages=["pytest_playwright"],
     include_package_data=True,
-    install_requires=["playwright>=0.0.4", "pytest", "pytest-base-url"],
+    install_requires=[
+        "playwright>=0.0.4",
+        "pytest",
+        "pytest-base-url",
+        "python-slugify==4.*",
+    ],
     entry_points={"pytest11": ["playwright = pytest_playwright.pytest_playwright"]},
     classifiers=[
         "Programming Language :: Python :: 3",

tests/test_playwright.py

@@ -13,6 +13,8 @@
 # limitations under the License.
 
 from typing import Any
+import os
+from pathlib import Path
 
 
 def test_default(testdir: Any) -> None:
@@ -177,3 +179,16 @@ def test_base_url(page):
     result = testdir.runpytest("--browser", "test123")
     result.assert_outcomes(errors=1)
     assert "'test123' is not allowed" in "\n".join(result.outlines)
+
+
+def test_make_screenshot(testdir: Any) -> None:
+    testdir.makepyfile(
+        """
+        def test_my_test(page):
+            raise ValueError("test123")
+    """
+    )
+    result = testdir.runpytest("--screenshot-on-error")
+    result.assert_outcomes(failed=1)
+    screenshot_files = os.listdir(Path(str(testdir)) / ".playwright-screenshots")
+    assert screenshot_files == ["test-make-screenshot-py-test-my-test-chromium.png"]