Fix: Add abstract get_snapshot_file method to SnapshotFileLayout class

- Make SnapshotFileLayout class abstract with ABC
- Add abstract get_snapshot_file method for type safety
- Update pytest-selfie tests with proper fixture usage
- Add concrete TestSnapshotFileLayout implementation in example tests

Co-Authored-By: [email protected] <[email protected]>

Author: devin-ai-integration[bot]

python/example-pytest-selfie/tests/to_be_file_test.py

@@ -10,8 +10,13 @@
 )
 
 
+class TestSnapshotFileLayout(SnapshotFileLayout):
+    def get_snapshot_file(self, test_file: TypedPath) -> TypedPath:
+        return TypedPath(str(test_file).replace(".jpg", ".ss"))
+
+
 def test_to_be_file():
-    layout = SnapshotFileLayout(FSImplementation())
+    layout = TestSnapshotFileLayout(FSImplementation())
     tracker = ToBeFileWriteTracker()
 
     # Record the current call stack.

python/pytest-selfie/pyproject.toml

@@ -35,5 +35,6 @@ ignore = [ "S", "FA",  "PYI", "EM", "PLR",  "FBT", "COM", "RET", "PTH", "PLW", "
 "PLC0414", # import alias does not rename original package
 "W291", # trailing whitespace, we need it for testing snapshots
 "PGH003", # specific rule codes when ignoring type issues
-"ISC001"
+"ISC001",
+"F401" # unused imports - needed for pytest fixtures
 ]

python/pytest-selfie/tests/__init__.py

@@ -0,0 +1 @@
+"""Tests for pytest-selfie."""

python/pytest-selfie/tests/test_plugin.py

@@ -1,40 +1,51 @@
 import os
 from pathlib import Path
-from typing import Any, Optional
+from typing import Any
+
 import pytest
 from _pytest.config import Config
+
 from pytest_selfie.plugin import PytestSnapshotSystem, SelfieSettingsAPI
 from selfie_lib import Mode, TypedPath
 
+
 class MockConfig(Config):  # type: ignore
     def __init__(self, tmp_path: Path):
         self._rootpath = tmp_path
 
-    def getoption(self, name: str, default: Any = None, skip: bool = False) -> Any:
+    def getoption(self, _name: str, default: Any = None, _skip: bool = False) -> Any:
         return default
 
     @property
     def rootpath(self) -> Path:
         return self._rootpath
 
-def test_snapshot_system_initialization(tmp_path):
-    config = MockConfig(Path(tmp_path))
-    settings = SelfieSettingsAPI(config)
+
+@pytest.fixture()
+def mock_config(tmp_path: Path) -> MockConfig:
+    """Create a mock config for testing."""
+    return MockConfig(tmp_path)
+
+
+def test_snapshot_system_initialization(mock_config):  # type: ignore[misc]
+    settings = SelfieSettingsAPI(mock_config)
     system = PytestSnapshotSystem(settings)
     assert system.mode == Mode.interactive
     assert isinstance(system.fs, object)
 
-def test_snapshot_file_layout(tmp_path):
-    config = MockConfig(Path(tmp_path))
-    settings = SelfieSettingsAPI(config)
+
+def test_snapshot_file_layout(mock_config):  # type: ignore[misc]
+    settings = SelfieSettingsAPI(mock_config)
     system = PytestSnapshotSystem(settings)
-    test_file = TypedPath.of_file(os.path.join(str(tmp_path), "test_example.py"))
+    test_file = TypedPath.of_file(
+        os.path.join(str(mock_config.rootpath), "test_example.py")
+    )
     snapshot_file = system.layout.get_snapshot_file(test_file)
     assert str(snapshot_file).endswith("test_example.ss")
 
-def test_snapshot_system_mode_from_env(tmp_path, monkeypatch):
-    monkeypatch.setenv('SELFIE', 'readonly')
-    config = MockConfig(Path(tmp_path))
-    settings = SelfieSettingsAPI(config)
+
+def test_snapshot_system_mode_from_env(mock_config, monkeypatch):  # type: ignore[misc]
+    monkeypatch.setenv("SELFIE", "readonly")
+    settings = SelfieSettingsAPI(mock_config)
     system = PytestSnapshotSystem(settings)
     assert system.mode == Mode.readonly

python/selfie-lib/selfie_lib/WriteTracker.py

@@ -1,7 +1,7 @@
 import inspect
 import os
 import threading
-from abc import ABC
+from abc import ABC, abstractmethod
 from functools import total_ordering
 from pathlib import Path
 from typing import Dict, Generic, List, Optional, TypeVar, cast
@@ -82,7 +82,7 @@ def __hash__(self):
         return hash((self.location, tuple(self.rest_of_stack)))
 
 
-class SnapshotFileLayout:
+class SnapshotFileLayout(ABC):
     def __init__(self, fs: FS):
         self.fs = fs
 
@@ -92,6 +92,10 @@ def sourcefile_for_call(self, call: CallLocation) -> TypedPath:
             raise ValueError("No file path available in CallLocation.")
         return TypedPath(os.path.abspath(Path(file_path)))
 
+    @abstractmethod
+    def get_snapshot_file(self, test_file: TypedPath) -> TypedPath:
+        pass
+
 
 def recordCall(callerFileOnly: bool) -> CallStack:
     stack_frames_raw = inspect.stack()