1.0.0.dev3

Author: Dmitry Vorobjev

.pre-commit-config.yaml

@@ -1,3 +1,9 @@
+## 1.0.0.dev3
+### Добавлено
+- добавлено описание плагина и пример работы с ним
+### Удалено
+- удалены неиспользуемые зависимости и файлы
+
 ## 1.0.0.dev2
 ### Добавлено
 - добавлена настройка максимально допустимого количество отличающихся пикселей

CHANGELOG.md

@@ -1,73 +1,27 @@
-# Pytest plugin for visual testing
+# pytest-assert-screenshot
 
-Based on [pixelmatch-py](https://github.com/whtsky/pixelmatch-py) image comparison library.
+Этот плагин - форк плагина [pytest-playwright-visual](https://github.com/symon-storozhenko/pytest-playwright-visual).
 
-## Main Features:
-- snapshots creation on the first run
-- visual review of mismatches
-- failing on `--update-screenshots` to make users manually review images
-- snapshot name is optional, `test_name.png` is auto-generated by default
-- updated folder structure: `snapshots/file_name/test_name/test_name.png`
+Плагин предназначен для сравнения скриншотов при UI-тестировании веб-приложений. Плагин может быть исопльзован с любым UI-фреймворком.
 
-## Installation
+В плагине добавлена возможность задавать допустимое количество отличающихся пикселей на скриншоте. Это помогает сделать тесты более стабильными.
 
-```bash
-$ pip install pytest-playwright-visual
-```
-
-## Usage
-
-This plugin provides a `assert_screenshot` fixture which is used to create snapshots and compare it.
-
-Example:
-
-```python
-def test_myapp(page, assert_snapshot):
-    page.goto("https://example.com")
-    assert_snapshot(page.screenshot())
-```
-Then, run pytest:
-```bash
-$ pytest
-```
-The first time you run pytest, snapshots will be created, and you will get the error:
-
-```console
-Failed: --> New snapshot(s) created. Please review images
-```
-
-The next run, the snapshots comparison will take place.
-
-To update snapshots, run:
-
-```bash
-$ pytest --update-screenshots
-```
-
-After updating, tests will fail and you will need to review images.
-
-In case of a mismatch, `screenshot_tests_failures` folder will be created with `Actual_..`, `Expected_..` and `Diff_..` images generated.
-
-## Folder Structure Example
-
-![img_2.png](img_2.png)
-
-## API
-**assert_snapshot(page.screenshot(), threshold: float = 0.1, name='test_name[browser][os].png', fail_fast=False)**
-- `threshold` - sets the threshold for the comparison of the screenshots:`0` to `1`. Default is `0.1`
-- `name` - `.png` extensions only. Default is `test_name.png` (recommended)
-- `fail_fast` - If `True`, will fail after first different pixel. `False` by default
-
-## Change snapshots path
-
-You can change the default path where snapshots are stored by setting `pytest.snapshots_path` and/or
-`pytest.screenshot_failures_path` value in `pytest_configure()` hook in your root `conftest.py`:
+После установки пакета в тестах с использованием библиотеки pytest становится доступна фикстура assert-screenshot:
 ```python
-def pytest_configure():
-    pytest.snapshots_path = Path.cwd() / "screenshots"
-    pytest.snapshot_failures_path = Path.cwd() / "screenshots_failures"
-```
-
-## License
-
-Apache 2.0 LICENSE
+class TestExamplesVisual:
+    def test_visual_auth_page(self, ui_client: UIClient, assert_screenshot):
+        """Визуальный тест страницы авторизации"""
+        # ARRANGE
+        ui_client.page_auth.navigate()
+        # ACT
+        screenshot_page_auth = ui_client.page_auth.make_screenshot()
+        # ASSERT
+        screenshot_name = OperationsFile.generate_screenshot_name()
+        logger.debug('Имя базового скриншота = ' + screenshot_name)
+        assert_screenshot(
+            screenshot_page_auth,
+            threshold=0.12,
+            name=screenshot_name,
+            fail_fast=False,
+        )
+```

README.md

@@ -1,4 +0,0 @@
-black==21.7b0
-mypy==0.910
-requests==2.25.1
-types-requests==2.25.6

img_2.png

@@ -4,7 +4,7 @@
 
 setup(
     name='pytest-assert-screenshot',
-    version='1.0.0.dev2',
+    version='1.0.0.dev3',
     author='Dmitry Vorobjev',
     author_email='dmitry.vorobjev@gmail.com',
     description='A pytest fixture for visual testing',