Use inline_snapshot.external_file instead of syrupy (#29)

Author: George-Ogden

.mirror.lock

@@ -1,5 +1,5 @@
 # DANGER: EDIT AT YOUR OWN RISK. Track this file in version control so that others can sync files correctly.
-- commit: fcb7c4aabba41339f8d81aa8b3a16dc3dd22a347
+- commit: 92e853634a273b8e222ca470242ec1f4aa4022d0
   files:
   - .github/python-release.yaml
   - .github/python-test.yaml

.pre-commit-config.yaml

@@ -8,7 +8,7 @@ ci:
 
 repos:
   - repo: https://github.com/George-Ogden/mirror-rorrim/
-    rev: v0.4.5
+    rev: v0.4.6
     hooks:
       - id: mirror-check
         fail_fast: true
@@ -21,7 +21,6 @@ repos:
       - id: end-of-file-fixer
       - id: mixed-line-ending
       - id: trailing-whitespace
-        exclude: test_data/.*/snapshots/
       - id: requirements-txt-fixer
 
   - repo: https://github.com/George-Ogden/linter/
@@ -64,6 +63,7 @@ repos:
     rev: v2.4.0
     hooks:
       - id: check-merge-conflict
+        exclude: test_data/.*/snapshots/
       - id: dbg-check
         exclude: test_data/.*/snapshots/
       - id: todo-check

mirror/checker_test.py

@@ -1,6 +1,6 @@
 from inline_snapshot import snapshot
+from inline_snapshot._external._external_file import ExternalFile
 import pytest
-from syrupy.assertion import SnapshotAssertion
 
 from .checker import MirrorChecker
 from .main import check_for_errors
@@ -86,7 +86,7 @@ def test_checker_check(
     expected_log: str,
     local_git_repo: GitDir,
     test_data_path: AbsDir,
-    snapshot: SnapshotAssertion,
+    json_snapshot: ExternalFile,
     caplog: pytest.LogCaptureFixture,
     log_cleanly: None,
 ) -> None:
@@ -97,4 +97,4 @@ def test_checker_check(
         check_for_errors(checker.check)()
     assert e.value.code == exitcode
     assert normalize_message(caplog.text, git_dir=local_git_repo) == expected_log
-    assert snapshot_of_repo(local_git_repo, include_lockfile=True) == snapshot
+    assert snapshot_of_repo(local_git_repo, include_lockfile=True) == json_snapshot

mirror/conftest.py

@@ -5,18 +5,16 @@
 import textwrap
 
 import git
+from inline_snapshot import external_file
+from inline_snapshot._external._external_file import ExternalFile
 from loguru import logger
 import pytest
 from pytest import FixtureRequest, LogCaptureFixture
-from syrupy.assertion import SnapshotAssertion
-from syrupy.extensions.amber import AmberSnapshotExtension
-from syrupy.location import PyTestLocation
-from syrupy.types import SnapshotIndex
 import yaml
 from yaml import Node
 
 from .logger import ProgramState
-from .typed_path import AbsDir, AbsFile, GitDir, RelDir, RelFile
+from .typed_path import AbsDir, AbsFile, Ext, GitDir, RelDir, RelFile
 
 
 @pytest.fixture
@@ -37,20 +35,19 @@ def local_git_repo(typed_tmp_path: AbsDir, request: FixtureRequest) -> Generator
     os.chdir(request.config.invocation_params.dir)
 
 
-class DifferentNameExtension(AmberSnapshotExtension):
-    location: AbsFile
+@pytest.fixture
+def snapshot_file(test_data_path: AbsDir, test_name: str) -> AbsFile:
+    return test_data_path / RelDir("snapshots") / RelFile(test_name)
+
 
-    @classmethod
-    def get_location(cls, *, test_location: PyTestLocation, index: SnapshotIndex = 0) -> str:
-        return os.fspath(cls.location)
+@pytest.fixture
+def json_snapshot(snapshot_file: AbsFile) -> ExternalFile:
+    return external_file(os.fspath(snapshot_file + Ext(".json")))
 
 
 @pytest.fixture
-def snapshot(
-    snapshot: SnapshotAssertion, test_data_path: AbsDir, test_name: str
-) -> SnapshotAssertion:
-    DifferentNameExtension.location = test_data_path / RelDir("snapshots") / RelFile(test_name)
-    return snapshot.use_extension(DifferentNameExtension)
+def text_snapshot(snapshot_file: AbsFile) -> ExternalFile:
+    return external_file(os.fspath(snapshot_file + Ext(".txt")))
 
 
 @pytest.fixture(autouse=True)

mirror/diff_test.py

@@ -4,8 +4,9 @@
 import tempfile
 import textwrap
 
+import _pytest.fixtures
+from inline_snapshot._external._external_file import ExternalFile
 import pytest
-from syrupy.assertion import SnapshotAssertion
 
 from .diff import Diff
 from .file import MirrorFile
@@ -19,8 +20,14 @@ def test_data_path(global_test_data_path: AbsDir) -> AbsDir:
 
 
 @pytest.fixture
-def test_name(file: MirrorFile) -> str:
-    return os.fspath(file.target)
+def test_name(file: MirrorFile, request: _pytest.fixtures.FixtureRequest) -> str:
+    while not isinstance(request, _pytest.fixtures.TopRequest):
+        assert isinstance(request, _pytest.fixtures.SubRequest)
+        request = request._parent_request
+    func_name: str = request.node.function.__name__
+    assert func_name.startswith("test_diff_")
+    name = func_name.replace("test_diff_", "", count=1)
+    return os.fspath(RelDir(name) / file.target)
 
 
 @pytest.mark.parametrize(
@@ -35,7 +42,7 @@ def test_name(file: MirrorFile) -> str:
     ],
 )
 def test_diff_apply_new_file(
-    file: MirrorFile, test_data_path: AbsDir, snapshot: SnapshotAssertion, local_git_repo: GitDir
+    file: MirrorFile, test_data_path: AbsDir, text_snapshot: ExternalFile, local_git_repo: GitDir
 ) -> None:
     remote = AbsDir(tempfile.mkdtemp())
     add_commit(remote, test_data_path / RelDir("remote"))
@@ -47,7 +54,7 @@ def test_diff_apply_new_file(
         shutil.copy2(current_path, tmp_filepath)
     diff.apply(local_git_repo)
     with open(tmp_filepath) as f:
-        assert f.read() == snapshot
+        assert f.read() == text_snapshot
 
 
 @pytest.mark.typed
@@ -144,7 +151,7 @@ def test_diff_from_commit_empty(local_git_repo: GitDir) -> None:
     ],
 )
 def test_diff_apply_versioned_file(
-    file: MirrorFile, test_data_path: AbsDir, snapshot: SnapshotAssertion, local_git_repo: GitDir
+    file: MirrorFile, test_data_path: AbsDir, text_snapshot: ExternalFile, local_git_repo: GitDir
 ) -> None:
     test_data_path /= RelDir("merge")
     remote_path = GitDir(tempfile.mkdtemp(), check=False)
@@ -164,4 +171,4 @@ def test_diff_apply_versioned_file(
         shutil.copy2(test_data_path / file.target, local_git_repo / file.target)
     diff.apply(local_git_repo)
     with open(local_git_repo / file.target) as f:
-        assert f.read() == snapshot
+        assert f.read() == text_snapshot

mirror/installer_test.py

@@ -1,7 +1,7 @@
 from unittest import mock
 
+from inline_snapshot._external._external_file import ExternalFile
 import pytest
-from syrupy.assertion import SnapshotAssertion
 
 from .constants import MIRROR_FILE
 from .repo import MirrorRepo
@@ -59,12 +59,12 @@ def test_installer_install(
     source: tuple[str | None, str] | None,
     local_git_repo: GitDir,
     test_data_path: AbsDir,
-    snapshot: SnapshotAssertion,
+    json_snapshot: ExternalFile,
 ) -> None:
     installer = quick_installer(local_git_repo, source)
     setup_repo(local_git_repo, test_data_path / RelDir(test_name))
 
     if isinstance(installer.source, RelFile):
         object.__setattr__(installer, "source", local_git_repo / installer.source)
     installer.install()
-    assert snapshot_of_repo(local_git_repo, include_lockfile=False) == snapshot
+    assert snapshot_of_repo(local_git_repo, include_lockfile=False) == json_snapshot

mirror/main_test.py

@@ -235,7 +235,7 @@ def test_main_with_keyboard_interrupt(
     mirror_existed_before = (local_git_repo / MIRROR_LOCK).exists()
     with (
         pytest.raises(SystemExit) as e,
-        mock.patch.object(GitHelper, "wait", mock.Mock(side_effect=[KeyboardInterrupt])),  # type: ignore [list-item]
+        mock.patch.object(GitHelper, "wait", mock.Mock(side_effect=[KeyboardInterrupt])),
     ):
         main.main(argv, prog_name=MIRROR_NAME)
     assert e.value.code != 0

mirror/mirror_test.py

@@ -3,9 +3,9 @@
 import tempfile
 
 from inline_snapshot import snapshot
+from inline_snapshot._external._external_file import ExternalFile
 import pytest
 from pytest import LogCaptureFixture
-from syrupy.assertion import SnapshotAssertion
 
 from .config_parser import Parser
 from .constants import MIRROR_LOCK
@@ -138,7 +138,7 @@ def multiple_repos_local_test_case() -> Mirror:
         (multiple_repos_local_test_case(), multiple_repos_local_test_case.__name__),
     ],
 )
-def test_mirror_state(mirror: Mirror, snapshot: SnapshotAssertion, typed_tmp_path: AbsDir) -> None:
+def test_mirror_state(mirror: Mirror, text_snapshot: ExternalFile, typed_tmp_path: AbsDir) -> None:
     mirror.checkout_all()
     with open(typed_tmp_path / RelFile(MIRROR_LOCK), "a+") as f:
         mirror.state.dump(f)
@@ -147,7 +147,7 @@ def test_mirror_state(mirror: Mirror, snapshot: SnapshotAssertion, typed_tmp_pat
         if hasattr(mirror, "__replacement__"):
             for search, replacement in mirror.__replacement__.items():
                 contents = contents.replace(search, replacement)
-        assert contents == snapshot
+        assert contents == text_snapshot
 
 
 def all_up_to_date_test_case() -> Mirror:

mirror/repo_test.py

@@ -7,9 +7,9 @@
 import git
 from git import GitError
 from inline_snapshot import snapshot
+from inline_snapshot._external._external_file import ExternalFile
 import pytest
 from pytest import LogCaptureFixture
-from syrupy.assertion import SnapshotAssertion
 
 from .config import MirrorRepoConfig
 from .config_parser_test import quick_mirror_repo_config
@@ -133,7 +133,7 @@ def repo_renaming_test_case() -> MirrorRepo:
     ],
 )
 def test_update_all(
-    repo: MirrorRepo, test_data_path: AbsDir, snapshot: SnapshotAssertion, local_git_repo: GitDir
+    repo: MirrorRepo, test_data_path: AbsDir, json_snapshot: ExternalFile, local_git_repo: GitDir
 ) -> None:
     for file in repo.files:
         existing_file = test_data_path / RelDir("local") / file.target
@@ -149,7 +149,7 @@ def test_update_all(
             with open(local_git_repo / RelFile(filename)) as f:
                 repo_contents[filename] = f.read()
         break
-    assert repo_contents == snapshot
+    assert repo_contents == json_snapshot
 
 
 def quick_repo_state(source: str, commit: str, files: Sequence[str]) -> MirrorRepoState:

mirror/syncer_test.py

@@ -1,5 +1,5 @@
+from inline_snapshot._external._external_file import ExternalFile
 import pytest
-from syrupy.assertion import SnapshotAssertion
 
 from .syncer import MirrorSyncer
 from .test_utils import setup_repo, snapshot_of_repo
@@ -26,9 +26,9 @@ def quick_syncer(target: str | AbsDir | None) -> MirrorSyncer:
     ],
 )
 def test_installer_install(
-    test_name: str, local_git_repo: GitDir, test_data_path: AbsDir, snapshot: SnapshotAssertion
+    test_name: str, local_git_repo: GitDir, test_data_path: AbsDir, json_snapshot: ExternalFile
 ) -> None:
     syncer = quick_syncer(local_git_repo)
     setup_repo(local_git_repo, test_data_path / RelDir(test_name))
     syncer.sync()
-    assert snapshot_of_repo(local_git_repo, include_lockfile=True) == snapshot
+    assert snapshot_of_repo(local_git_repo, include_lockfile=True) == json_snapshot