Oven logo

Oven

Published

A pytest wrapper for snapshot testing with playwright

pip install pytest-playwright-snapshot

Package Downloads

Weekly DownloadsMonthly Downloads

Authors

Project URLs

Requires Python

>=3.7

Pytest Plugin for Snapshot Testing with Playwright

This plugin enables snapshot testing in playwright like snapshotting screenshots of pages, element handles etc.

Installation

$ pip install pytest-playwright-snapshot

Usage

This plugin provides a assert_snapshot fixture which is used to create snapshots and compare it.

Example:

def test_myapp(page, assert_snapshot):
    page.goto("https://example.com")
    assert_snapshot(page.screenshot(), "example.png")

Ths first time you run pytest, you will get error like

Failed: Snapshot not found, use --update-snapshots to create it.

As first you need to create golden snapshots to which this plugin will compare in future.

To create snapshots run:

$ pytest --update-snapshots

This will create snapshots for your tests, after that you can run the tests are usual and this will compare the snapshots.

There is threshold kwarg only option which can be used to set the threshold for the comparison of the screenshots and by default it is 0.1

License

Apache 2.0 LICENSE