pytest-image-snapshot 0.1.0__tar.gz

pytest-image-snapshot-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Bojan Mihelac
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

pytest-image-snapshot-0.1.0/MANIFEST.in

@@ -0,0 +1,5 @@
+include LICENSE
+include README.md
+
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]

pytest-image-snapshot-0.1.0/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.1
+Name: pytest-image-snapshot
+Version: 0.1.0
+Summary: A pytest plugin for image snapshot management and comparison.
+Home-page: https://github.com/bmihelac/pytest-image-snapshot
+Author: Bojan Mihelac
+Author-email: bojan@informatikamihelac.com
+Maintainer: Bojan Mihelac
+Maintainer-email: bojan@informatikamihelac.com
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Testing
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.5
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pytest>=3.5.0
+Requires-Dist: Pillow
+
+# pytest-image-snapshot
+
+[![PyPI version](https://img.shields.io/pypi/v/pytest-image-snapshot.svg)](https://pypi.org/project/pytest-image-snapshot)
+
+[![Python versions](https://img.shields.io/pypi/pyversions/pytest-image-snapshot.svg)](https://pypi.org/project/pytest-image-snapshot)
+
+A pytest plugin for image snapshot management and comparison.
+
+------------------------------------------------------------------------
+
+## Features
+
+- **Image Comparison**: Automatically compares a test-generated image with a pre-stored snapshot, identifying any visual discrepancies.
+- **Snapshot Creation**: If a reference snapshot doesn't exist, the plugin will create it during the test run, making initial setup effortless.
+- **Verbose Mode Display**: Capable of displaying the difference image for quick visual feedback in case of mismatches when running tests with `-v`.
+- **Snapshot Update Option**: Includes a `--image-snapshot-update` flag to update existing snapshots or create new ones, accommodating visual changes in your project.
+
+
+## Requirements
+
+-   Pillow
+
+## Installation
+
+You can install \"pytest-image-snapshot\" via
+[pip](https://pypi.org/project/pip/) from
+[PyPI](https://pypi.org/project):
+
+    $ pip install pytest-image-snapshot
+
+## Pytest Image Snapshot Usage Example
+
+The `image_snapshot` fixture is designed for visual regression testing in pytest. It compares a generated image in your tests with a stored reference image (snapshot). If the snapshot doesn't exist, it will be automatically created. This makes the fixture ideal for both creating initial snapshots and for ongoing comparison in visual tests.
+
+### Usage
+
+Here's a example of how to utilize the `image_snapshot` fixture:
+
+```python
+from PIL import Image
+
+def test_image(image_snapshot):
+    # Create a new white image of 100x100 pixels
+    image = Image.new('RGB', (100, 100), 'white')
+    # Compare it to the snapshot stored in test_snapshots/test.png
+    # If test_snapshots/test.png does not exist, it will be created
+    image_snapshot(image, "test_snapshots/test.png")
+```
+
+> **⚠️ Warning:**
+>
+> The `image_snapshot` fixture does not automatically create directories for storing image snapshots. Ensure that the necessary directories (e.g., `test_snapshots/`) are created in your project structure before running tests.
+
+### Verbose Mode (`-v` or `--verbose`)
+
+The verbose mode enhances the output detail for `image_snapshot` tests:
+- `-v`: Displays the 'diff' image when there's a mismatch.
+- `-vv`: Shows all three images - 'diff', 'original', and 'current' for a comprehensive comparison.
+
+This feature assists in quickly identifying and analyzing visual differences during test failures.
+
+### Updating Snapshots (`--image-snapshot-update`)
+
+Use the `--image-snapshot-update` flag to update or create new reference snapshots. This is useful for incorporating intentional visual changes into your tests, ensuring that your snapshots always reflect the current expected state.
+
+```bash
+pytest --image-snapshot-update
+```
+
+## Example
+
+Visual regression test for home page with [playwright](https://playwright.dev/python/docs/intro):
+
+```python
+from io import BytesIO
+
+def test_homepage(page: Page, image_snapshot):
+    page.goto("http://localhost:8000")
+    # convert screenshot to image
+    screenshot = Image.open(BytesIO(page.screenshot()))
+    is_image_equal(screenshot, "test_snapshots/homepage.png")
+```
+
+## Contributing
+
+Contributions are very welcome. Tests can be run with
+[tox](https://tox.readthedocs.io/en/latest/), please ensure the coverage
+at least stays the same before you submit a pull request.
+
+## License
+
+Distributed under the terms of the
+[MIT](http://opensource.org/licenses/MIT) license,
+\"pytest-image-snapshot\" is free and open source software
+
+## Issues
+
+If you encounter any problems, please [file an
+issue](https://github.com/bmihelac/pytest-image-snapshot/issues) along
+with a detailed description.
+
+--- 
+
+This [pytest](https://github.com/pytest-dev/pytest) plugin was generated
+with [Cookiecutter](https://github.com/audreyr/cookiecutter) along with
+[\@hackebrot](https://github.com/hackebrot)\'s
+[cookiecutter-pytest-plugin](https://github.com/pytest-dev/cookiecutter-pytest-plugin)
+template.
+

pytest-image-snapshot-0.1.0/README.md

@@ -0,0 +1,109 @@
+# pytest-image-snapshot
+
+[![PyPI version](https://img.shields.io/pypi/v/pytest-image-snapshot.svg)](https://pypi.org/project/pytest-image-snapshot)
+
+[![Python versions](https://img.shields.io/pypi/pyversions/pytest-image-snapshot.svg)](https://pypi.org/project/pytest-image-snapshot)
+
+A pytest plugin for image snapshot management and comparison.
+
+------------------------------------------------------------------------
+
+## Features
+
+- **Image Comparison**: Automatically compares a test-generated image with a pre-stored snapshot, identifying any visual discrepancies.
+- **Snapshot Creation**: If a reference snapshot doesn't exist, the plugin will create it during the test run, making initial setup effortless.
+- **Verbose Mode Display**: Capable of displaying the difference image for quick visual feedback in case of mismatches when running tests with `-v`.
+- **Snapshot Update Option**: Includes a `--image-snapshot-update` flag to update existing snapshots or create new ones, accommodating visual changes in your project.
+
+
+## Requirements
+
+-   Pillow
+
+## Installation
+
+You can install \"pytest-image-snapshot\" via
+[pip](https://pypi.org/project/pip/) from
+[PyPI](https://pypi.org/project):
+
+    $ pip install pytest-image-snapshot
+
+## Pytest Image Snapshot Usage Example
+
+The `image_snapshot` fixture is designed for visual regression testing in pytest. It compares a generated image in your tests with a stored reference image (snapshot). If the snapshot doesn't exist, it will be automatically created. This makes the fixture ideal for both creating initial snapshots and for ongoing comparison in visual tests.
+
+### Usage
+
+Here's a example of how to utilize the `image_snapshot` fixture:
+
+```python
+from PIL import Image
+
+def test_image(image_snapshot):
+    # Create a new white image of 100x100 pixels
+    image = Image.new('RGB', (100, 100), 'white')
+    # Compare it to the snapshot stored in test_snapshots/test.png
+    # If test_snapshots/test.png does not exist, it will be created
+    image_snapshot(image, "test_snapshots/test.png")
+```
+
+> **⚠️ Warning:**
+>
+> The `image_snapshot` fixture does not automatically create directories for storing image snapshots. Ensure that the necessary directories (e.g., `test_snapshots/`) are created in your project structure before running tests.
+
+### Verbose Mode (`-v` or `--verbose`)
+
+The verbose mode enhances the output detail for `image_snapshot` tests:
+- `-v`: Displays the 'diff' image when there's a mismatch.
+- `-vv`: Shows all three images - 'diff', 'original', and 'current' for a comprehensive comparison.
+
+This feature assists in quickly identifying and analyzing visual differences during test failures.
+
+### Updating Snapshots (`--image-snapshot-update`)
+
+Use the `--image-snapshot-update` flag to update or create new reference snapshots. This is useful for incorporating intentional visual changes into your tests, ensuring that your snapshots always reflect the current expected state.
+
+```bash
+pytest --image-snapshot-update
+```
+
+## Example
+
+Visual regression test for home page with [playwright](https://playwright.dev/python/docs/intro):
+
+```python
+from io import BytesIO
+
+def test_homepage(page: Page, image_snapshot):
+    page.goto("http://localhost:8000")
+    # convert screenshot to image
+    screenshot = Image.open(BytesIO(page.screenshot()))
+    is_image_equal(screenshot, "test_snapshots/homepage.png")
+```
+
+## Contributing
+
+Contributions are very welcome. Tests can be run with
+[tox](https://tox.readthedocs.io/en/latest/), please ensure the coverage
+at least stays the same before you submit a pull request.
+
+## License
+
+Distributed under the terms of the
+[MIT](http://opensource.org/licenses/MIT) license,
+\"pytest-image-snapshot\" is free and open source software
+
+## Issues
+
+If you encounter any problems, please [file an
+issue](https://github.com/bmihelac/pytest-image-snapshot/issues) along
+with a detailed description.
+
+--- 
+
+This [pytest](https://github.com/pytest-dev/pytest) plugin was generated
+with [Cookiecutter](https://github.com/audreyr/cookiecutter) along with
+[\@hackebrot](https://github.com/hackebrot)\'s
+[cookiecutter-pytest-plugin](https://github.com/pytest-dev/cookiecutter-pytest-plugin)
+template.
+

pytest-image-snapshot-0.1.0/pytest_image_snapshot.egg-info/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.1
+Name: pytest-image-snapshot
+Version: 0.1.0
+Summary: A pytest plugin for image snapshot management and comparison.
+Home-page: https://github.com/bmihelac/pytest-image-snapshot
+Author: Bojan Mihelac
+Author-email: bojan@informatikamihelac.com
+Maintainer: Bojan Mihelac
+Maintainer-email: bojan@informatikamihelac.com
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Testing
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.5
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pytest>=3.5.0
+Requires-Dist: Pillow
+
+# pytest-image-snapshot
+
+[![PyPI version](https://img.shields.io/pypi/v/pytest-image-snapshot.svg)](https://pypi.org/project/pytest-image-snapshot)
+
+[![Python versions](https://img.shields.io/pypi/pyversions/pytest-image-snapshot.svg)](https://pypi.org/project/pytest-image-snapshot)
+
+A pytest plugin for image snapshot management and comparison.
+
+------------------------------------------------------------------------
+
+## Features
+
+- **Image Comparison**: Automatically compares a test-generated image with a pre-stored snapshot, identifying any visual discrepancies.
+- **Snapshot Creation**: If a reference snapshot doesn't exist, the plugin will create it during the test run, making initial setup effortless.
+- **Verbose Mode Display**: Capable of displaying the difference image for quick visual feedback in case of mismatches when running tests with `-v`.
+- **Snapshot Update Option**: Includes a `--image-snapshot-update` flag to update existing snapshots or create new ones, accommodating visual changes in your project.
+
+
+## Requirements
+
+-   Pillow
+
+## Installation
+
+You can install \"pytest-image-snapshot\" via
+[pip](https://pypi.org/project/pip/) from
+[PyPI](https://pypi.org/project):
+
+    $ pip install pytest-image-snapshot
+
+## Pytest Image Snapshot Usage Example
+
+The `image_snapshot` fixture is designed for visual regression testing in pytest. It compares a generated image in your tests with a stored reference image (snapshot). If the snapshot doesn't exist, it will be automatically created. This makes the fixture ideal for both creating initial snapshots and for ongoing comparison in visual tests.
+
+### Usage
+
+Here's a example of how to utilize the `image_snapshot` fixture:
+
+```python
+from PIL import Image
+
+def test_image(image_snapshot):
+    # Create a new white image of 100x100 pixels
+    image = Image.new('RGB', (100, 100), 'white')
+    # Compare it to the snapshot stored in test_snapshots/test.png
+    # If test_snapshots/test.png does not exist, it will be created
+    image_snapshot(image, "test_snapshots/test.png")
+```
+
+> **⚠️ Warning:**
+>
+> The `image_snapshot` fixture does not automatically create directories for storing image snapshots. Ensure that the necessary directories (e.g., `test_snapshots/`) are created in your project structure before running tests.
+
+### Verbose Mode (`-v` or `--verbose`)
+
+The verbose mode enhances the output detail for `image_snapshot` tests:
+- `-v`: Displays the 'diff' image when there's a mismatch.
+- `-vv`: Shows all three images - 'diff', 'original', and 'current' for a comprehensive comparison.
+
+This feature assists in quickly identifying and analyzing visual differences during test failures.
+
+### Updating Snapshots (`--image-snapshot-update`)
+
+Use the `--image-snapshot-update` flag to update or create new reference snapshots. This is useful for incorporating intentional visual changes into your tests, ensuring that your snapshots always reflect the current expected state.
+
+```bash
+pytest --image-snapshot-update
+```
+
+## Example
+
+Visual regression test for home page with [playwright](https://playwright.dev/python/docs/intro):
+
+```python
+from io import BytesIO
+
+def test_homepage(page: Page, image_snapshot):
+    page.goto("http://localhost:8000")
+    # convert screenshot to image
+    screenshot = Image.open(BytesIO(page.screenshot()))
+    is_image_equal(screenshot, "test_snapshots/homepage.png")
+```
+
+## Contributing
+
+Contributions are very welcome. Tests can be run with
+[tox](https://tox.readthedocs.io/en/latest/), please ensure the coverage
+at least stays the same before you submit a pull request.
+
+## License
+
+Distributed under the terms of the
+[MIT](http://opensource.org/licenses/MIT) license,
+\"pytest-image-snapshot\" is free and open source software
+
+## Issues
+
+If you encounter any problems, please [file an
+issue](https://github.com/bmihelac/pytest-image-snapshot/issues) along
+with a detailed description.
+
+--- 
+
+This [pytest](https://github.com/pytest-dev/pytest) plugin was generated
+with [Cookiecutter](https://github.com/audreyr/cookiecutter) along with
+[\@hackebrot](https://github.com/hackebrot)\'s
+[cookiecutter-pytest-plugin](https://github.com/pytest-dev/cookiecutter-pytest-plugin)
+template.
+

pytest-image-snapshot-0.1.0/pytest_image_snapshot.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+MANIFEST.in
+README.md
+pytest_image_snapshot.py
+setup.cfg
+setup.py
+pytest_image_snapshot.egg-info/PKG-INFO
+pytest_image_snapshot.egg-info/SOURCES.txt
+pytest_image_snapshot.egg-info/dependency_links.txt
+pytest_image_snapshot.egg-info/entry_points.txt
+pytest_image_snapshot.egg-info/requires.txt
+pytest_image_snapshot.egg-info/top_level.txt
+tests/test_image_snapshot.py

pytest-image-snapshot-0.1.0/pytest_image_snapshot.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pytest-image-snapshot-0.1.0/pytest_image_snapshot.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[pytest11]
+image-snapshot = pytest_image_snapshot

pytest-image-snapshot-0.1.0/pytest_image_snapshot.egg-info/requires.txt

@@ -0,0 +1,2 @@
+pytest>=3.5.0
+Pillow

pytest-image-snapshot-0.1.0/pytest_image_snapshot.egg-info/top_level.txt

@@ -0,0 +1 @@
+pytest_image_snapshot

pytest-image-snapshot-0.1.0/pytest_image_snapshot.py

@@ -0,0 +1,64 @@
+from pathlib import Path
+
+import pytest
+from PIL import Image, ImageChops
+
+
+class ImageMismatchError(AssertionError):
+    """Exception raised when images do not match."""
+
+
+def pytest_addoption(parser):
+    parser.addoption(
+        "--image-snapshot-update", action="store_true", help="Update image snapshots"
+    )
+
+
+def extend_to_match_size_rgba(img1, img2):
+    """
+    Extend the smaller image to match the size of the larger one using RGBA mode
+    with a transparent background.
+
+    :param img1: First PIL Image object in RGBA mode
+    :param img2: Second PIL Image object in RGBA mode
+    :return: Tuple of two PIL Image objects with the same size
+    """
+    max_width = max(img1.width, img2.width)
+    max_height = max(img1.height, img2.height)
+
+    def extend_image(img):
+        if img.width == max_width and img.height == max_height:
+            return img
+        new_img = Image.new("RGBA", (max_width, max_height), (0, 0, 0, 0))
+        new_img.paste(img, (0, 0), img)
+        return new_img
+
+    return extend_image(img1.convert("RGBA")), extend_image(img2.convert("RGBA"))
+
+
+@pytest.fixture
+def image_snapshot(request):
+    def _image_snapshot(img, img_path):
+        config = request.config
+        update_snapshots = config.getoption("--image-snapshot-update")
+
+        img_path = Path(img_path)
+        if not update_snapshots and img_path.exists():
+            src_image = Image.open(img_path)
+            img_1, img_2 = extend_to_match_size_rgba(img, src_image)
+            diff = ImageChops.difference(img_1, img_2)
+            if diff.getbbox():
+                if config.option.verbose:
+                    diff.show(title="diff")
+                    if config.option.verbose > 1:
+                        src_image.show(title="original")
+                        img.show(title="new")
+                raise ImageMismatchError(
+                    f"Image does not match the snapshot stored in {img_path}"
+                )
+            else:
+                return
+        img.save(img_path)
+        return
+
+    return _image_snapshot

pytest-image-snapshot-0.1.0/setup.cfg

@@ -0,0 +1,7 @@
+[flake8]
+max-line-length = 88
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

pytest-image-snapshot-0.1.0/setup.py

@@ -0,0 +1,51 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import os
+import codecs
+from setuptools import setup
+
+
+def read(fname):
+    file_path = os.path.join(os.path.dirname(__file__), fname)
+    return codecs.open(file_path, encoding='utf-8').read()
+
+
+setup(
+    name='pytest-image-snapshot',
+    version='0.1.0',
+    author='Bojan Mihelac',
+    author_email='bojan@informatikamihelac.com',
+    maintainer='Bojan Mihelac',
+    maintainer_email='bojan@informatikamihelac.com',
+    license='MIT',
+    url='https://github.com/bmihelac/pytest-image-snapshot',
+    description='A pytest plugin for image snapshot management and comparison.',
+    long_description=read('README.md'),
+    long_description_content_type='text/markdown',
+    py_modules=['pytest_image_snapshot'],
+    python_requires='>=3.5',
+    install_requires=['pytest>=3.5.0', 'Pillow'],
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Framework :: Pytest',
+        'Intended Audience :: Developers',
+        'Topic :: Software Development :: Testing',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3 :: Only',
+        'Programming Language :: Python :: Implementation :: CPython',
+        'Programming Language :: Python :: Implementation :: PyPy',
+        'Operating System :: OS Independent',
+        'License :: OSI Approved :: MIT License',
+    ],
+    entry_points={
+        'pytest11': [
+            'image-snapshot = pytest_image_snapshot',
+        ],
+    },
+)

pytest-image-snapshot-0.1.0/tests/test_image_snapshot.py

@@ -0,0 +1,39 @@
+# -*- coding: utf-8 -*-
+import pytest
+
+from PIL import Image
+
+
+@pytest.fixture
+def test_image(pytester):
+    img = Image.new("RGB", (100, 100), "white")
+    filename = pytester.path.joinpath("white.png")
+    img.save(filename, format="PNG")
+
+
+def test_image_snapshot_fixture(pytester, test_image):
+    pytester.makepyfile(
+        """
+        from PIL import Image
+        import pytest
+
+        def test_image(image_snapshot):
+            image = Image.new('RGB', (100, 100), 'white')
+            image_snapshot(image, "white.png")
+
+        def test_different_image(image_snapshot):
+            image = Image.new('RGB', (150, 150), 'white')
+            with pytest.raises(AssertionError):
+                image_snapshot(image, "white.png")
+    """
+    )
+
+    result = pytester.runpytest("-v")
+
+    result.stdout.fnmatch_lines(
+        [
+            "*::test_image PASSED*",
+        ]
+    )
+
+    assert result.ret == 0