pytest-regtest 2.0.1__tar.gz → 2.0.3__tar.gz

{pytest-regtest-2.0.1/pytest_regtest/pytest_regtest.egg-info → pytest-regtest-2.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pytest-regtest
-Version: 2.0.1
+Version: 2.0.3
 Summary: "pytest plugin for snapshot regression testing"
 Author: Uwe Schmitt
 Author-email: uwe.schmitt@id.ethz.ch
@@ -20,27 +20,30 @@ Provides-Extra: dev
 Requires-Dist: twine; extra == "dev"
 Requires-Dist: build; extra == "dev"
 Requires-Dist: wheel; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
 
-# README
+# pytest-regtest
 
 ## About
 
 `pytest-regtest` is a plugin for [pytest](https://pytest.org) to implement
-[regression testing](https://en.wikipedia.org/wiki/Regression_testing).
+**regression testing**.
 
 Unlike [functional testing](https://en.wikipedia.org/wiki/Functional_testing),
-regression testing does not test whether the software produces the correct
-results, but whether it behaves as it did before the changes were introduced.
+[regression testing](https://en.wikipedia.org/wiki/Regression_testing)
+testing does not test whether the software produces the correct
+results, but whether it behaves as it did before changes were introduced.
 
-**Regression testing** is a common technique to get implement basic testing before
-refactoring legacy code that lacks a test suite.
+More specifically, `pytest-regtest` provides **snapshot testing**, which
+implements regression testing by recording the textual output of a test
+function and comparing this recorded output to a reference output.
 
-More specifically, `pytest-regtest` provides **snapshot testing**, which implements
-regression testing by recording the textual output of a test function and
-comparing this recorded output to a reference output.
+**Regression testing** is a common technique to implement basic testing
+before refactoring legacy code that lacks a test suite.
 
-Snapshot testing can be used to implement tests for complex outcomes, such as
-recording textual database dumps or the results of a scientific analysis routine.
+Snapshot testing can also be used to implement tests for complex outcomes, such
+as recording textual database dumps or the results of a scientific analysis
+routine.
 
 
 ## Installation
@@ -51,14 +54,13 @@ To install and activate this plugin execute:
 
 ## Basic Usage
 
-*pytest-regtest* plugin provides multiple fixtures.
 
 ### Write a test
 
+*pytest-regtest* plugin provides multiple fixtures.
 To record output, use the fixture *regtest* that works like a file handle:
 
-```python
-
+```py
 def test_squares_up_to_ten(regtest):
 
     result = [i*i for i in range(10)]
@@ -68,7 +70,6 @@ def test_squares_up_to_ten(regtest):
 
     # alternative method to record output:
     regtest.write("done")
-
 ```
 
 You can also use the `regtest_all` fixture. This enables all output to stdout to be
@@ -82,7 +83,7 @@ recorded output for this test function so far and thus the test will
 fail with a message including a diff:
 
 
-```sh
+```bash
 $ pytest test_demo.py
 ========================= test session starts ==========================
 platform darwin -- Python 3.11.4, pytest-7.4.3, pluggy-1.3.0
@@ -118,7 +119,7 @@ This is a diff of the current output `is` to a previously recorded output
 To record the current output, we run *pytest* with the *--reset-regtest*
 flag:
 
-```sh
+```bash
 $ py.test -v --regtest-reset test_demo.py
 ========================= test session starts ==========================
 platform darwin -- Python 3.11.4, pytest-7.4.3, pluggy-1.3.0
@@ -143,7 +144,7 @@ Don't forget to commit this folder to your version control system!
 
 When we run the test again, it succeeds:
 
-```sh
+```bash
 $ py.test test_demo.py
 ========================= test session starts ==========================
 platform darwin -- Python 3.11.4, pytest-7.4.3, pluggy-1.3.0
@@ -160,10 +161,10 @@ total number of failed regression tests: 0
 
 ### Break the test
 
-Let us we break the test by changing the recoreded output to compute
+Let us we break the test by changing the test function to compute
 11 instead of 10 square numbers:
 
-```python
+```py
 def test_squares_up_to_ten(regtest):
 
     result = [i*i for i in range(11)]  # changed!
@@ -178,7 +179,7 @@ def test_squares_up_to_ten(regtest):
 The next run of pytest delivers a nice diff of the current and expected output
 from this test function:
 
-```sh
+```bash
 $ pytest test_demo.py
 ========================= test session starts ==========================
 platform darwin -- Python 3.11.4, pytest-7.4.3, pluggy-1.3.0
@@ -215,7 +216,7 @@ FAILED test_demo.py::test_squares_up_to_ten
 The `regtest` fixture also works as a context manager  to capture
 all output from the wrapped code block:
 
-```python
+```py
 def test_squares_up_to_ten(regtest):
 
     result = [i*i for i in range(10)]
@@ -229,7 +230,7 @@ def test_squares_up_to_ten(regtest):
 The `regtest_all` fixture leads to recording of all output to `stdout` in a
 test function.
 
-```python
+```py
 def test_all(regtest_all):
     print("this line will be recorded.")
     print("and this line also.")
@@ -240,14 +241,18 @@ def test_all(regtest_all):
 
 You can reset recorded output of files and functions individually as:
 
-    $ py.test --regtest-reset test_demo.py
-    $ py.test --regtest-reset test_demo.py::test_squares_up_to_ten
+```bash
+$ py.test --regtest-reset test_demo.py
+$ py.test --regtest-reset test_demo.py::test_squares_up_to_ten
+```
 
 ### Suppress diff for failed tests
 
-To supress the diff and only see the stats use:
+To hide the diff and just show the number of lines changed, use:
 
-    $ py.test --regtest-nodiff ...
+```bash
+$ py.test --regtest-nodiff ...
+```
 
 
 ### Show all recorded output
@@ -256,7 +261,9 @@ To supress the diff and only see the stats use:
 For complex diffs it helps to see the full recorded output also.
 To enable this use:
 
-    $ py.test --regtest-tee...
+```bash
+$ py.test --regtest-tee...
+```
 
 
 ### Line endings
@@ -284,31 +291,31 @@ Per default the plugin:
 
 You can register own converters in `conftest.py`:
 
-```python
-    import re
-    import pytest_regtest
-
-    @pytest_regtest.register_converter_pre
-    def remove_password_lines(txt):
-        """modify recorded output BEFORE the default fixes
-        like temp folders or hex object ids are applied"""
-
-        # remove lines with passwords:
-        lines = txt.splitlines(keepends=True)
-        lines = [l for l in lines if "password is" not in l]
-        return "".join(lines)
-
-    @pytest_regtest.register_converter_post
-    def fix_time_measurements(txt):
-        """modify recorded output AFTER the default fixes
-        like temp folders or hex object ids are applied"""
-
-        # fix time measurements:
-        return re.sub(
-            "\d+(\.\d+)? seconds",
-            "<SECONDS> seconds",
-            txt
-        )
+```py
+import re
+import pytest_regtest
+
+@pytest_regtest.register_converter_pre
+def remove_password_lines(txt):
+    """modify recorded output BEFORE the default fixes
+    like temp folders or hex object ids are applied"""
+
+    # remove lines with passwords:
+    lines = txt.splitlines(keepends=True)
+    lines = [l for l in lines if "password is" not in l]
+    return "".join(lines)
+
+@pytest_regtest.register_converter_post
+def fix_time_measurements(txt):
+    """modify recorded output AFTER the default fixes
+    like temp folders or hex object ids are applied"""
+
+    # fix time measurements:
+    return re.sub(
+        "\d+(\.\d+)? seconds",
+        "<SECONDS> seconds",
+        txt
+    )
 ```
 
 If you register multiple converters they will be applied in the order of

{pytest-regtest-2.0.1 → pytest-regtest-2.0.3}/README.md

@@ -1,23 +1,25 @@
-# README
+# pytest-regtest
 
 ## About
 
 `pytest-regtest` is a plugin for [pytest](https://pytest.org) to implement
-[regression testing](https://en.wikipedia.org/wiki/Regression_testing).
+**regression testing**.
 
 Unlike [functional testing](https://en.wikipedia.org/wiki/Functional_testing),
-regression testing does not test whether the software produces the correct
-results, but whether it behaves as it did before the changes were introduced.
+[regression testing](https://en.wikipedia.org/wiki/Regression_testing)
+testing does not test whether the software produces the correct
+results, but whether it behaves as it did before changes were introduced.
 
-**Regression testing** is a common technique to get implement basic testing before
-refactoring legacy code that lacks a test suite.
+More specifically, `pytest-regtest` provides **snapshot testing**, which
+implements regression testing by recording the textual output of a test
+function and comparing this recorded output to a reference output.
 
-More specifically, `pytest-regtest` provides **snapshot testing**, which implements
-regression testing by recording the textual output of a test function and
-comparing this recorded output to a reference output.
+**Regression testing** is a common technique to implement basic testing
+before refactoring legacy code that lacks a test suite.
 
-Snapshot testing can be used to implement tests for complex outcomes, such as
-recording textual database dumps or the results of a scientific analysis routine.
+Snapshot testing can also be used to implement tests for complex outcomes, such
+as recording textual database dumps or the results of a scientific analysis
+routine.
 
 
 ## Installation
@@ -28,14 +30,13 @@ To install and activate this plugin execute:
 
 ## Basic Usage
 
-*pytest-regtest* plugin provides multiple fixtures.
 
 ### Write a test
 
+*pytest-regtest* plugin provides multiple fixtures.
 To record output, use the fixture *regtest* that works like a file handle:
 
-```python
-
+```py
 def test_squares_up_to_ten(regtest):
 
     result = [i*i for i in range(10)]
@@ -45,7 +46,6 @@ def test_squares_up_to_ten(regtest):
 
     # alternative method to record output:
     regtest.write("done")
-
 ```
 
 You can also use the `regtest_all` fixture. This enables all output to stdout to be
@@ -59,7 +59,7 @@ recorded output for this test function so far and thus the test will
 fail with a message including a diff:
 
 
-```sh
+```bash
 $ pytest test_demo.py
 ========================= test session starts ==========================
 platform darwin -- Python 3.11.4, pytest-7.4.3, pluggy-1.3.0
@@ -95,7 +95,7 @@ This is a diff of the current output `is` to a previously recorded output
 To record the current output, we run *pytest* with the *--reset-regtest*
 flag:
 
-```sh
+```bash
 $ py.test -v --regtest-reset test_demo.py
 ========================= test session starts ==========================
 platform darwin -- Python 3.11.4, pytest-7.4.3, pluggy-1.3.0
@@ -120,7 +120,7 @@ Don't forget to commit this folder to your version control system!
 
 When we run the test again, it succeeds:
 
-```sh
+```bash
 $ py.test test_demo.py
 ========================= test session starts ==========================
 platform darwin -- Python 3.11.4, pytest-7.4.3, pluggy-1.3.0
@@ -137,10 +137,10 @@ total number of failed regression tests: 0
 
 ### Break the test
 
-Let us we break the test by changing the recoreded output to compute
+Let us we break the test by changing the test function to compute
 11 instead of 10 square numbers:
 
-```python
+```py
 def test_squares_up_to_ten(regtest):
 
     result = [i*i for i in range(11)]  # changed!
@@ -155,7 +155,7 @@ def test_squares_up_to_ten(regtest):
 The next run of pytest delivers a nice diff of the current and expected output
 from this test function:
 
-```sh
+```bash
 $ pytest test_demo.py
 ========================= test session starts ==========================
 platform darwin -- Python 3.11.4, pytest-7.4.3, pluggy-1.3.0
@@ -192,7 +192,7 @@ FAILED test_demo.py::test_squares_up_to_ten
 The `regtest` fixture also works as a context manager  to capture
 all output from the wrapped code block:
 
-```python
+```py
 def test_squares_up_to_ten(regtest):
 
     result = [i*i for i in range(10)]
@@ -206,7 +206,7 @@ def test_squares_up_to_ten(regtest):
 The `regtest_all` fixture leads to recording of all output to `stdout` in a
 test function.
 
-```python
+```py
 def test_all(regtest_all):
     print("this line will be recorded.")
     print("and this line also.")
@@ -217,14 +217,18 @@ def test_all(regtest_all):
 
 You can reset recorded output of files and functions individually as:
 
-    $ py.test --regtest-reset test_demo.py
-    $ py.test --regtest-reset test_demo.py::test_squares_up_to_ten
+```bash
+$ py.test --regtest-reset test_demo.py
+$ py.test --regtest-reset test_demo.py::test_squares_up_to_ten
+```
 
 ### Suppress diff for failed tests
 
-To supress the diff and only see the stats use:
+To hide the diff and just show the number of lines changed, use:
 
-    $ py.test --regtest-nodiff ...
+```bash
+$ py.test --regtest-nodiff ...
+```
 
 
 ### Show all recorded output
@@ -233,7 +237,9 @@ To supress the diff and only see the stats use:
 For complex diffs it helps to see the full recorded output also.
 To enable this use:
 
-    $ py.test --regtest-tee...
+```bash
+$ py.test --regtest-tee...
+```
 
 
 ### Line endings
@@ -261,31 +267,31 @@ Per default the plugin:
 
 You can register own converters in `conftest.py`:
 
-```python
-    import re
-    import pytest_regtest
-
-    @pytest_regtest.register_converter_pre
-    def remove_password_lines(txt):
-        """modify recorded output BEFORE the default fixes
-        like temp folders or hex object ids are applied"""
-
-        # remove lines with passwords:
-        lines = txt.splitlines(keepends=True)
-        lines = [l for l in lines if "password is" not in l]
-        return "".join(lines)
-
-    @pytest_regtest.register_converter_post
-    def fix_time_measurements(txt):
-        """modify recorded output AFTER the default fixes
-        like temp folders or hex object ids are applied"""
-
-        # fix time measurements:
-        return re.sub(
-            "\d+(\.\d+)? seconds",
-            "<SECONDS> seconds",
-            txt
-        )
+```py
+import re
+import pytest_regtest
+
+@pytest_regtest.register_converter_pre
+def remove_password_lines(txt):
+    """modify recorded output BEFORE the default fixes
+    like temp folders or hex object ids are applied"""
+
+    # remove lines with passwords:
+    lines = txt.splitlines(keepends=True)
+    lines = [l for l in lines if "password is" not in l]
+    return "".join(lines)
+
+@pytest_regtest.register_converter_post
+def fix_time_measurements(txt):
+    """modify recorded output AFTER the default fixes
+    like temp folders or hex object ids are applied"""
+
+    # fix time measurements:
+    return re.sub(
+        "\d+(\.\d+)? seconds",
+        "<SECONDS> seconds",
+        txt
+    )
 ```
 
 If you register multiple converters they will be applied in the order of

pytest-regtest-2.0.3/pyproject.toml

@@ -0,0 +1,19 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+
+
+[tool.tox]
+legacy_tox_ini = '''
+[tox]
+isolated_build = true
+envlist = py39,py310,py311,py312
+package = sdist
+
+[testenv]
+skip_install = false
+passenv = *
+allowlist_externals = pytest
+extras = dev
+commands =
+    pytest -ra -v tests
+'''

pytest-regtest-2.0.3/pytest_regtest/__init__.py

@@ -0,0 +1,2 @@
+from importlib.metadata import version as _version
+__version__ = _version(__package__)

{pytest-regtest-2.0.1 → pytest-regtest-2.0.3/pytest_regtest/pytest_regtest.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pytest-regtest
-Version: 2.0.1
+Version: 2.0.3
 Summary: "pytest plugin for snapshot regression testing"
 Author: Uwe Schmitt
 Author-email: uwe.schmitt@id.ethz.ch
@@ -20,27 +20,30 @@ Provides-Extra: dev
 Requires-Dist: twine; extra == "dev"
 Requires-Dist: build; extra == "dev"
 Requires-Dist: wheel; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
 
-# README
+# pytest-regtest
 
 ## About
 
 `pytest-regtest` is a plugin for [pytest](https://pytest.org) to implement
-[regression testing](https://en.wikipedia.org/wiki/Regression_testing).
+**regression testing**.
 
 Unlike [functional testing](https://en.wikipedia.org/wiki/Functional_testing),
-regression testing does not test whether the software produces the correct
-results, but whether it behaves as it did before the changes were introduced.
+[regression testing](https://en.wikipedia.org/wiki/Regression_testing)
+testing does not test whether the software produces the correct
+results, but whether it behaves as it did before changes were introduced.
 
-**Regression testing** is a common technique to get implement basic testing before
-refactoring legacy code that lacks a test suite.
+More specifically, `pytest-regtest` provides **snapshot testing**, which
+implements regression testing by recording the textual output of a test
+function and comparing this recorded output to a reference output.
 
-More specifically, `pytest-regtest` provides **snapshot testing**, which implements
-regression testing by recording the textual output of a test function and
-comparing this recorded output to a reference output.
+**Regression testing** is a common technique to implement basic testing
+before refactoring legacy code that lacks a test suite.
 
-Snapshot testing can be used to implement tests for complex outcomes, such as
-recording textual database dumps or the results of a scientific analysis routine.
+Snapshot testing can also be used to implement tests for complex outcomes, such
+as recording textual database dumps or the results of a scientific analysis
+routine.
 
 
 ## Installation
@@ -51,14 +54,13 @@ To install and activate this plugin execute:
 
 ## Basic Usage
 
-*pytest-regtest* plugin provides multiple fixtures.
 
 ### Write a test
 
+*pytest-regtest* plugin provides multiple fixtures.
 To record output, use the fixture *regtest* that works like a file handle:
 
-```python
-
+```py
 def test_squares_up_to_ten(regtest):
 
     result = [i*i for i in range(10)]
@@ -68,7 +70,6 @@ def test_squares_up_to_ten(regtest):
 
     # alternative method to record output:
     regtest.write("done")
-
 ```
 
 You can also use the `regtest_all` fixture. This enables all output to stdout to be
@@ -82,7 +83,7 @@ recorded output for this test function so far and thus the test will
 fail with a message including a diff:
 
 
-```sh
+```bash
 $ pytest test_demo.py
 ========================= test session starts ==========================
 platform darwin -- Python 3.11.4, pytest-7.4.3, pluggy-1.3.0
@@ -118,7 +119,7 @@ This is a diff of the current output `is` to a previously recorded output
 To record the current output, we run *pytest* with the *--reset-regtest*
 flag:
 
-```sh
+```bash
 $ py.test -v --regtest-reset test_demo.py
 ========================= test session starts ==========================
 platform darwin -- Python 3.11.4, pytest-7.4.3, pluggy-1.3.0
@@ -143,7 +144,7 @@ Don't forget to commit this folder to your version control system!
 
 When we run the test again, it succeeds:
 
-```sh
+```bash
 $ py.test test_demo.py
 ========================= test session starts ==========================
 platform darwin -- Python 3.11.4, pytest-7.4.3, pluggy-1.3.0
@@ -160,10 +161,10 @@ total number of failed regression tests: 0
 
 ### Break the test
 
-Let us we break the test by changing the recoreded output to compute
+Let us we break the test by changing the test function to compute
 11 instead of 10 square numbers:
 
-```python
+```py
 def test_squares_up_to_ten(regtest):
 
     result = [i*i for i in range(11)]  # changed!
@@ -178,7 +179,7 @@ def test_squares_up_to_ten(regtest):
 The next run of pytest delivers a nice diff of the current and expected output
 from this test function:
 
-```sh
+```bash
 $ pytest test_demo.py
 ========================= test session starts ==========================
 platform darwin -- Python 3.11.4, pytest-7.4.3, pluggy-1.3.0
@@ -215,7 +216,7 @@ FAILED test_demo.py::test_squares_up_to_ten
 The `regtest` fixture also works as a context manager  to capture
 all output from the wrapped code block:
 
-```python
+```py
 def test_squares_up_to_ten(regtest):
 
     result = [i*i for i in range(10)]
@@ -229,7 +230,7 @@ def test_squares_up_to_ten(regtest):
 The `regtest_all` fixture leads to recording of all output to `stdout` in a
 test function.
 
-```python
+```py
 def test_all(regtest_all):
     print("this line will be recorded.")
     print("and this line also.")
@@ -240,14 +241,18 @@ def test_all(regtest_all):
 
 You can reset recorded output of files and functions individually as:
 
-    $ py.test --regtest-reset test_demo.py
-    $ py.test --regtest-reset test_demo.py::test_squares_up_to_ten
+```bash
+$ py.test --regtest-reset test_demo.py
+$ py.test --regtest-reset test_demo.py::test_squares_up_to_ten
+```
 
 ### Suppress diff for failed tests
 
-To supress the diff and only see the stats use:
+To hide the diff and just show the number of lines changed, use:
 
-    $ py.test --regtest-nodiff ...
+```bash
+$ py.test --regtest-nodiff ...
+```
 
 
 ### Show all recorded output
@@ -256,7 +261,9 @@ To supress the diff and only see the stats use:
 For complex diffs it helps to see the full recorded output also.
 To enable this use:
 
-    $ py.test --regtest-tee...
+```bash
+$ py.test --regtest-tee...
+```
 
 
 ### Line endings
@@ -284,31 +291,31 @@ Per default the plugin:
 
 You can register own converters in `conftest.py`:
 
-```python
-    import re
-    import pytest_regtest
-
-    @pytest_regtest.register_converter_pre
-    def remove_password_lines(txt):
-        """modify recorded output BEFORE the default fixes
-        like temp folders or hex object ids are applied"""
-
-        # remove lines with passwords:
-        lines = txt.splitlines(keepends=True)
-        lines = [l for l in lines if "password is" not in l]
-        return "".join(lines)
-
-    @pytest_regtest.register_converter_post
-    def fix_time_measurements(txt):
-        """modify recorded output AFTER the default fixes
-        like temp folders or hex object ids are applied"""
-
-        # fix time measurements:
-        return re.sub(
-            "\d+(\.\d+)? seconds",
-            "<SECONDS> seconds",
-            txt
-        )
+```py
+import re
+import pytest_regtest
+
+@pytest_regtest.register_converter_pre
+def remove_password_lines(txt):
+    """modify recorded output BEFORE the default fixes
+    like temp folders or hex object ids are applied"""
+
+    # remove lines with passwords:
+    lines = txt.splitlines(keepends=True)
+    lines = [l for l in lines if "password is" not in l]
+    return "".join(lines)
+
+@pytest_regtest.register_converter_post
+def fix_time_measurements(txt):
+    """modify recorded output AFTER the default fixes
+    like temp folders or hex object ids are applied"""
+
+    # fix time measurements:
+    return re.sub(
+        "\d+(\.\d+)? seconds",
+        "<SECONDS> seconds",
+        txt
+    )
 ```
 
 If you register multiple converters they will be applied in the order of

{pytest-regtest-2.0.1 → pytest-regtest-2.0.3}/pytest_regtest/pytest_regtest.egg-info/SOURCES.txt

@@ -3,6 +3,8 @@ MANIFEST.in
 README.md
 pyproject.toml
 setup.cfg
+pytest_regtest/__init__.py
+pytest_regtest/pytest_regtest.py
 pytest_regtest/pytest_regtest.egg-info/PKG-INFO
 pytest_regtest/pytest_regtest.egg-info/SOURCES.txt
 pytest_regtest/pytest_regtest.egg-info/dependency_links.txt

{pytest-regtest-2.0.1 → pytest-regtest-2.0.3}/pytest_regtest/pytest_regtest.egg-info/requires.txt

@@ -4,3 +4,4 @@ pytest>7.2
 twine
 build
 wheel
+pytest

pytest-regtest-2.0.3/pytest_regtest/pytest_regtest.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+__init__
+pytest_regtest

pytest-regtest-2.0.3/pytest_regtest/pytest_regtest.py

@@ -0,0 +1,380 @@
+import difflib
+import functools
+import inspect
+import os
+import re
+import sys
+import tempfile
+from hashlib import sha512
+from io import StringIO
+
+import pytest
+from _pytest._code.code import TerminalRepr
+from _pytest._io import TerminalWriter
+
+pytest_plugins = ["pytester"]
+
+IS_WIN = sys.platform == "win32"
+
+
+def ljust(s, *a):
+    return s.ljust(*a)
+
+
+class RegtestException(Exception):
+    pass
+
+
+def pytest_addoption(parser):
+    """Add options to control the timeout plugin"""
+    group = parser.getgroup("regtest", "regression test plugin")
+    group.addoption(
+        "--regtest-reset",
+        action="store_true",
+        help="do not run regtest but record current output",
+    )
+    group.addoption(
+        "--regtest-tee",
+        action="store_true",
+        default=False,
+        help="print recorded results to console too",
+    )
+    group.addoption(
+        "--regtest-consider-line-endings",
+        action="store_true",
+        default=False,
+        help="do not strip whitespaces at end of recorded lines",
+    )
+    group.addoption(
+        "--regtest-nodiff",
+        action="store_true",
+        default=False,
+        help="do not show diff output for failed regresson tests",
+    )
+
+
+def pytest_configure(config):
+    config.pluginmanager.register(PytestRegtestPlugin())
+
+
+class PytestRegtestPlugin:
+    def __init__(self):
+        self._reset_regtest_outputs = []
+        self._failed_regtests = []
+
+    @pytest.hookimpl(trylast=True)
+    def pytest_runtest_call(self, item):
+        if hasattr(item, "regtest_stream"):
+            self.check_recorded_output(item)
+
+    def check_recorded_output(self, item):
+        test_folder = item.fspath.dirname
+        regtest_stream = item.regtest_stream
+        identifier = regtest_stream.identifier
+
+        recorded_output_path = result_file_path(test_folder, item.nodeid, identifier)
+
+        config = item.config
+
+        ignore_line_endings = not config.getvalue("--regtest-consider-line-endings")
+        reset = config.getvalue("--regtest-reset")
+
+        if reset:
+            os.makedirs(os.path.dirname(recorded_output_path), exist_ok=True)
+            with open(recorded_output_path, "w", encoding="utf-8") as fh:
+                fh.write("".join(regtest_stream.get_lines()))
+            self._reset_regtest_outputs.append(recorded_output_path)
+            return
+
+        if os.path.exists(recorded_output_path):
+            with open(recorded_output_path, "r", encoding="utf-8") as fh:
+                tobe = fh.readlines()
+        else:
+            tobe = []
+
+        current = regtest_stream.get_lines()
+        if ignore_line_endings:
+            current = [line.rstrip() for line in current]
+            tobe = [line.rstrip() for line in tobe]
+
+        if current != tobe:
+            self._failed_regtests.append(item)
+            raise RegtestException(current, tobe, regtest_stream)
+
+    @pytest.hookimpl(hookwrapper=True)
+    def pytest_pyfunc_call(self, pyfuncitem):
+        stdout = sys.stdout
+        if "regtest_all" in pyfuncitem.fixturenames and hasattr(
+            pyfuncitem, "regtest_stream"
+        ):
+            sys.stdout = pyfuncitem.regtest_stream
+        yield
+        sys.stdout = stdout
+
+    @pytest.hookimpl(hookwrapper=True)
+    def pytest_report_teststatus(self, report, config):
+        outcome = yield
+        if report.when == "call":
+            if config.getvalue("--regtest-reset"):
+                result = outcome.get_result()
+                if result[0] != "failed":
+                    outcome.force_result((result[0], "R", "RESET"))
+
+    def pytest_terminal_summary(self, terminalreporter, exitstatus, config):
+        terminalreporter.ensure_newline()
+        terminalreporter.section("pytest-regtest report", sep="-", blue=True, bold=True)
+        terminalreporter.write("total number of failed regression tests: ", bold=True)
+        terminalreporter.line(str(len(self._failed_regtests)))
+        if config.getvalue("--regtest-reset"):
+            if config.option.verbose:
+                terminalreporter.line(
+                    "the following output files have been reset:", bold=True
+                )
+                for path in self._reset_regtest_outputs:
+                    rel_path = os.path.relpath(path)
+                    terminalreporter.line("  " + rel_path)
+            else:
+                terminalreporter.write(
+                    "total number of reset output files: ", bold=True
+                )
+                terminalreporter.line(str(len(self._reset_regtest_outputs)))
+
+    @pytest.hookimpl(hookwrapper=True)
+    def pytest_runtest_makereport(self, item, call):
+        outcome = yield
+        if call.when == "teardown" and hasattr(item, "regtest_stream"):
+            if item.config.getvalue("--regtest-tee"):
+                tw = TerminalWriter()
+                tw.line()
+                line = "recorded raw output to regtest fixture: "
+                line = ljust(line, tw.fullwidth, "-")
+                tw.line(line, green=True)
+                tw.write(item.regtest_stream.get_output() + "\n", cyan=True)
+                tw.line("-" * tw.fullwidth, green=True)
+                tw.line()
+                tw.flush()
+
+                test_folder = item.fspath.dirname
+                regtest_stream = item.regtest_stream
+                identifier = regtest_stream.identifier
+
+                recorded_output_path = result_file_path(
+                    test_folder, item.nodeid, identifier
+                )
+                result = outcome.get_result()
+                result.longrepr = CollectErrorRepr(
+                    [f"wrote recorded output to {recorded_output_path}"], [dict()]
+                )
+                return
+
+        if call.when != "call" or not hasattr(item, "regtest_stream"):
+            return
+
+        if call.excinfo is not None and call.excinfo.type is RegtestException:
+            current, recorded, regtest_stream = call.excinfo.value.args
+
+            nodeid = item.nodeid + (
+                ""
+                if regtest_stream.identifier is None
+                else "__" + regtest_stream.identifier
+            )
+
+            nodiff = item.config.getvalue("--regtest-nodiff")
+            ignore_line_endings = not item.config.getvalue(
+                "--regtest-consider-line-endings"
+            )
+
+            result = outcome.get_result()
+
+            if not ignore_line_endings:
+                # add quotes around lines in diff:
+
+                current = list(map(repr, current))
+                recorded = list(map(repr, recorded))
+
+            collected = list(
+                difflib.unified_diff(current, recorded, "is", "tobe", lineterm="")
+            )
+
+            msg = "\nregression test output differences for {}:\n".format(nodeid)
+            if nodiff:
+                msg_diff = f"{len(collected)} lines in diff"
+            else:
+                msg_diff = ">   " + "\n>   ".join(collected)
+
+            result.longrepr = CollectErrorRepr(
+                [msg, msg_diff + "\n"], [dict(), dict(red=True, bold=True)]
+            )
+
+
+def result_file_path(test_folder, nodeid, identifier):
+    file_name, __, test_function = nodeid.partition("::")
+    file_name = os.path.basename(file_name)
+
+    for c in "/\\:*\"'?<>|":
+        test_function = test_function.replace(c, "-")
+
+    # If file name is too long, hash parameters.
+    if len(test_function) > 100:
+        test_function = (
+            test_function[:88]
+            + "__"
+            + sha512(test_function.encode("utf-8")).hexdigest()[:10]
+        )
+
+    test_function = test_function.replace(" ", "_")
+    stem, __ = os.path.splitext(file_name)
+    if identifier is not None:
+        output_file_name = stem + "." + test_function + "__" + identifier + ".out"
+    else:
+        output_file_name = stem + "." + test_function + ".out"
+
+    return os.path.join(test_folder, "_regtest_outputs", output_file_name)
+
+
+@pytest.fixture
+def regtest(request):
+    yield RegtestStream(request)
+
+
+@pytest.fixture
+def regtest_all(regtest):
+    yield regtest
+
+
+class RegtestStream:
+    def __init__(self, request):
+        request.node.regtest_stream = self
+        self.request = request
+        self.buffer = StringIO()
+        self.identifier = None
+
+    def write(self, what):
+        self.buffer.write(what)
+
+    def flush(self):
+        pass
+
+    def get_lines(self):
+        output = self.buffer.getvalue()
+        if not output:
+            return []
+        output = cleanup(output, self.request)
+        lines = output.splitlines(keepends=True)
+        return lines
+
+    def get_output(self):
+        return self.buffer.getvalue()
+
+    def __enter__(self):
+        sys.stdout = self
+        return self
+
+    def __exit__(self, *a):
+        sys.stdout = sys.__stdout__
+        return False  # dont suppress exception
+
+
+def cleanup(output, request):
+    for converter in _converters_pre:
+        output = converter(output, request)
+
+    output = _std_conversion(output, request)
+
+    for converter in _converters_post:
+        output = converter(output, request)
+
+    # in python 3 a string should not contain binary symbols...:
+    if contains_binary(output):
+        request.raiseerror(
+            "recorded output for regression test contains unprintable characters."
+        )
+
+    return output
+
+
+# the function below is modified version of http://stackoverflow.com/questions/898669/
+textchars = bytearray({7, 8, 9, 10, 12, 13, 27} | set(range(0x20, 0x100)) - {0x7F})
+
+
+def contains_binary(txt):
+    return bool(txt.translate(dict(zip(textchars, " " * 9999))).replace(" ", ""))
+
+
+_converters_pre = []
+_converters_post = []
+
+
+def _fix_pre_v2_converter_function(function):
+    @functools.wraps(function)
+    def fixed_converter_function(output, request):
+        return function(output)
+
+    return fixed_converter_function
+
+
+def register_converter_pre(function):
+    if function not in _converters_pre:
+        signature = inspect.signature(function)
+        # keep downward compatibility:
+        if len(signature.parameters) == 1:
+            function = _fix_pre_v2_converter_function(function)
+        _converters_pre.append(function)
+
+
+def register_converter_post(function):
+    if function not in _converters_post:
+        signature = inspect.signature(function)
+        # keep downward compatibility:
+        if len(signature.parameters) == 1:
+            function = _fix_pre_v2_converter_function(function)
+        _converters_post.append(function)
+
+
+def _std_replacements(request):
+    if "tmpdir" in request.fixturenames:
+        tmpdir = request.getfixturevalue("tmpdir").strpath + os.path.sep
+        yield tmpdir, "<tmpdir_from_fixture>/"
+        tmpdir = request.getfixturevalue("tmpdir").strpath
+        yield tmpdir, "<tmpdir_from_fixture>"
+
+    regexp = os.path.join(
+        os.path.realpath(tempfile.gettempdir()), "pytest-of-.*", r"pytest-\d+/"
+    )
+    yield regexp, "<pytest_tempdir>/"
+
+    regexp = os.path.join(tempfile.gettempdir(), "tmp[_a-zA-Z0-9]+")
+
+    yield regexp, "<tmpdir_from_tempfile_module>"
+    yield os.path.realpath(
+        tempfile.gettempdir()
+    ) + os.path.sep, "<tmpdir_from_tempfile_module>/"
+    yield os.path.realpath(tempfile.gettempdir()), "<tmpdir_from_tempfile_module>"
+    yield tempfile.tempdir + os.path.sep, "<tmpdir_from_tempfile_module>/"
+    yield tempfile.tempdir, "<tmpdir_from_tempfile_module>"
+    yield r"var/folders/.*/pytest-of.*/", "<pytest_tempdir>/"
+
+    # replace hex object ids in output by 0x?????????
+    yield r" 0x[0-9a-fA-F]+", " 0x?????????"
+
+
+def _std_conversion(output, request):
+    fixed = []
+    for line in output.splitlines(keepends=True):
+        for regex, replacement in _std_replacements(request):
+            if IS_WIN:
+                # fix windows backwards slashes in regex
+                regex = regex.replace("\\", "\\\\")
+            line, __ = re.subn(regex, replacement, line)
+        fixed.append(line)
+    return "".join(fixed)
+
+
+class CollectErrorRepr(TerminalRepr):
+    def __init__(self, messages, colors):
+        self.messages = messages
+        self.colors = colors
+
+    def toterminal(self, out):
+        for message, color in zip(self.messages, self.colors):
+            out.line(message, **color)

{pytest-regtest-2.0.1 → pytest-regtest-2.0.3}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = pytest-regtest
-version = 2.0.1
+version = 2.0.3
 license = MIT
 description = "pytest plugin for snapshot regression testing"
 long_description = file: README.md
@@ -20,13 +20,11 @@ project_urls =
 [options]
 install_requires = 
 	pytest>7.2
-packages = find:
+package_dir = 
+	= pytest_regtest
 zip_safe = False
 python_requires = >=3.9
 
-[options.packages.find]
-where = pytest_regtest/
-
 [options.entry_points]
 pytest11 = 
 	regtest = pytest_regtest
@@ -36,6 +34,7 @@ dev =
 	twine
 	build
 	wheel
+	pytest
 
 [egg_info]
 tag_build = 

{pytest-regtest-2.0.1 → pytest-regtest-2.0.3}/tests/test_plugin.py

@@ -19,6 +19,7 @@ def create_test_regtest_context_manager(testdir):
                 print(tempfile.gettempdir())
                 print(tempfile.mkdtemp())
                 print("obj id is", hex(id(tempfile)))
+            regtest.flush()
 
          """
     )
@@ -39,6 +40,7 @@ def create_test_regtest_fh(testdir):
             print(tempfile.gettempdir(), file=regtest)
             print(tempfile.mkdtemp(), file=regtest)
             print("obj id is", hex(id(tempfile)), file=regtest)
+            regtest.flush()
 
          """
     )
@@ -149,6 +151,42 @@ def test_failed_test(testdir):
     result.assert_outcomes(failed=1)
 
 
+def test_converter_pre_pre_v2(testdir):
+    testdir.makepyfile(
+        """
+        import tempfile
+        from pytest_regtest import register_converter_pre
+
+        @register_converter_pre
+        def to_upper_conv(line):
+            return line.upper()
+
+        def test_regtest(regtest_all, tmpdir):
+            print("this is expected outcome")
+            print("obj id is 0xabcdeffff")
+         """
+    )
+    result = testdir.runpytest_subprocess()
+    result.assert_outcomes(failed=1)
+
+    expected_diff = """
+                    >   --- is
+                    >   +++ tobe
+                    >   @@ -1,2 +0,0 @@
+                    >   -THIS IS EXPECTED OUTCOME
+                    >   -OBJ ID IS 0XABCDEFFFF
+                    """.strip().split(
+        "\n"
+    )
+
+    result.stdout.fnmatch_lines(
+        [line.lstrip() for line in expected_diff], consecutive=True
+    )
+
+    result = testdir.runpytest("--regtest-reset")
+    result.assert_outcomes(passed=1)
+
+
 def test_converter_pre(testdir):
     testdir.makepyfile(
         """
@@ -185,6 +223,48 @@ def test_converter_pre(testdir):
     result.assert_outcomes(passed=1)
 
 
+def test_converter_post_pre_v2(testdir):
+    testdir.makepyfile(
+        """
+        import tempfile
+        from pytest_regtest import register_converter_post
+
+        @register_converter_post
+        def to_upper_conv(line):
+            return line.upper()
+
+        def test_regtest(regtest_all, tmpdir):
+            print("this is expected outcome")
+            print(tmpdir.join("test").strpath)
+            print(tempfile.gettempdir())
+            print(tempfile.mkdtemp())
+            print("obj id is", hex(id(tempfile)))
+         """
+    )
+    result = testdir.runpytest_subprocess()
+    result.assert_outcomes(failed=1)
+
+    expected_diff = """
+                    >   --- is
+                    >   +++ tobe
+                    >   @@ -1,5 +0,0 @@
+                    >   -THIS IS EXPECTED OUTCOME
+                    >   -<TMPDIR_FROM_FIXTURE>/TEST
+                    >   -<TMPDIR_FROM_TEMPFILE_MODULE>
+                    >   -<TMPDIR_FROM_TEMPFILE_MODULE>
+                    >   -OBJ ID IS 0X?????????
+                    """.strip().split(
+        "\n"
+    )
+
+    result.stdout.fnmatch_lines(
+        [line.lstrip() for line in expected_diff], consecutive=True
+    )
+
+    result = testdir.runpytest("--regtest-reset")
+    result.assert_outcomes(passed=1)
+
+
 def test_converter_post(testdir):
     testdir.makepyfile(
         """
@@ -227,6 +307,7 @@ def test_converter_post(testdir):
     result.assert_outcomes(passed=1)
 
 
+
 def test_consider_line_endings(create_test_regtest_fh):
     create_test_regtest_fh.runpytest("--regtest-reset")
 

pytest-regtest-2.0.1/pyproject.toml

@@ -1,2 +0,0 @@
-[build-system]
-requires = ["setuptools", "wheel"]

pytest-regtest-2.0.1/pytest_regtest/pytest_regtest.egg-info/top_level.txt

@@ -1 +0,0 @@
-