Merge pull request #16 from joseph-roitman/full-coverage

Full coverage

pytest_snapshot/plugin.py

@@ -67,8 +67,6 @@ def __enter__(self):
         return self
 
     def __exit__(self, exc_type, exc_val, exc_tb):
-        if exc_type is not None:
-            return False
         if self._created_snapshots or self._updated_snapshots or self._snapshots_to_delete:
             message_lines = ['Snapshot directory was modified: {}'.format(shorten_path(self.snapshot_dir))]
             if self._created_snapshots:
@@ -109,8 +107,6 @@ def _snapshot_path(self, snapshot_name):
         """
         if isinstance(snapshot_name, Path):
             snapshot_path = snapshot_name.absolute()
-            if self._snapshot_dir is None:
-                self.snapshot_dir = snapshot_path.parent
         else:
             snapshot_path = self.snapshot_dir.joinpath(snapshot_name)
 

setup.py

@@ -27,7 +27,7 @@ def read(fname):
         'packaging',
         'pathlib2>=2.2.0;python_version<"3.6"',  # identical to pytest's setup.py
         'pytest>=3.0.0',
-        'typing',
+        'typing;python_version<"3.5"',
     ],
     classifiers=[
         'Development Status :: 4 - Beta',

tests/test_assert_match.py

@@ -1,5 +1,6 @@
 import pytest
 
+from pytest_snapshot.plugin import text_type
 from tests.utils import assert_pytest_passes
 
 
@@ -57,6 +58,20 @@ def test_sth(snapshot):
     assert result.ret == 1
 
 
+def test_assert_match_invalid_type(testdir, basic_case_dir):
+    testdir.makepyfile("""
+        def test_sth(snapshot):
+            snapshot.snapshot_dir = 'case_dir'
+            snapshot.assert_match(b'incorrect typed obj', 'snapshot1.txt')
+    """)
+    result = testdir.runpytest('-v')
+    result.stdout.fnmatch_lines([
+        '*::test_sth FAILED*',
+        'E* TypeError: value must be {}'.format(text_type.__name__),
+    ])
+    assert result.ret == 1
+
+
 def test_assert_match_missing_snapshot(testdir, basic_case_dir):
     testdir.makepyfile("""
         def test_sth(snapshot):
@@ -134,6 +149,34 @@ def test_sth(snapshot):
     assert_pytest_passes(testdir)  # assert that snapshot update worked
 
 
+def test_assert_match_update_existing_snapshot_and_exception_in_test(testdir, basic_case_dir):
+    """
+    Tests that `Snapshot.assert_match` works when updating an existing snapshot and then the test function fails.
+    In this case, both the snapshot update error and the test function error are printed out.
+    """
+    testdir.makepyfile("""
+        try:
+            from pathlib import Path
+        except ImportError:
+            from pathlib2 import Path
+
+        def test_sth(snapshot):
+            snapshot.snapshot_dir = 'case_dir'
+            snapshot.assert_match(u'the NEW value of snapshot1.txt', 'snapshot1.txt')
+            assert False
+    """)
+    result = testdir.runpytest('-v', '--snapshot-update')
+    result.stdout.fnmatch_lines([
+        '*::test_sth FAILED*',
+        '*::test_sth ERROR*',
+        "E* AssertionError: Snapshot directory was modified: case_dir",
+        'E*   Updated snapshots:',
+        'E*     snapshot1.txt',
+        'E* assert False',
+    ])
+    assert result.ret == 1
+
+
 def test_assert_match_create_new_snapshot(testdir, basic_case_dir):
     testdir.makepyfile("""
         def test_sth(snapshot):

tests/test_misc.py

@@ -1,5 +1,11 @@
+from pytest_snapshot.plugin import shorten_path
 from tests.utils import assert_pytest_passes
 
+try:
+    from pathlib import Path
+except ImportError:
+    from pathlib2 import Path
+
 
 def test_help_message(testdir):
     result = testdir.runpytest('--help')
@@ -42,3 +48,12 @@ def test_sth(snapshot, param):
         '*::test_sth?b? PASSED*',
     ])
     assert result.ret == 0
+
+
+def test_shorten_path_in_cwd():
+    assert shorten_path(Path('a/b').absolute()) == Path('a/b')
+
+
+def test_shorten_path_outside_cwd():
+    path_outside_cwd = Path().absolute().parent.joinpath('a/b')
+    assert shorten_path(path_outside_cwd) == path_outside_cwd

tox.ini

@@ -1,13 +1,12 @@
 # For more information about tox, see https://tox.readthedocs.io/en/latest/
 [tox]
 envlist =
-    py27-pytest{3,4},
-    py35-pytest{3,4,5,},
-    py36-pytest{3,4,5,},
-    py37-pytest{3,4,5,},
-    py38-pytest{3,4,5},
-    py38-pytest-coverage,
-    pypy3-pytest{3,4,5,},
+    py27-pytest{3,4}-coverage,
+    py35-pytest{3,4,5,}-coverage,
+    py36-pytest{3,4,5,}-coverage,
+    py37-pytest{3,4,5,}-coverage,
+    py38-pytest{3,4,5,}-coverage,
+    pypy3-pytest{3,4,5,}-coverage,
     flake8
 
 [testenv]