localstack-snapshot 0.3.4__tar.gz → 0.3.5__tar.gz

{localstack_snapshot-0.3.4 → localstack_snapshot-0.3.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: localstack-snapshot
-Version: 0.3.4
+Version: 0.3.5
 Summary: Extracted snapshot testing lib for LocalStack
 Author-email: LocalStack Contributors <info@localstack.cloud>
 License: 
@@ -218,10 +218,10 @@ License-File: LICENSE
 Requires-Dist: jsonpath-ng>1.6
 Requires-Dist: deepdiff
 Provides-Extra: dev
-Requires-Dist: black==23.10.0; extra == "dev"
-Requires-Dist: pytest>=7.0; extra == "dev"
-Requires-Dist: coverage[toml]>=5.0.0; extra == "dev"
-Requires-Dist: ruff==0.1.0; extra == "dev"
+Requires-Dist: black==26.5.1; extra == "dev"
+Requires-Dist: pytest>=9.1.1; extra == "dev"
+Requires-Dist: coverage[toml]>=7.15.4; extra == "dev"
+Requires-Dist: ruff==0.16.5; extra == "dev"
 Dynamic: license-file
 
 Snapshot testing for pytest

localstack_snapshot-0.3.5/localstack_snapshot/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.3.5"

{localstack_snapshot-0.3.4 → localstack_snapshot-0.3.5}/localstack_snapshot/pytest/snapshot.py

@@ -1,5 +1,6 @@
 import json
 import os
+from pathlib import Path
 from typing import Optional
 
 import pytest
@@ -97,6 +98,27 @@ def pytest_runtest_call(item: Item) -> None:
         sm._assert_all(verify, paths)
 
 
+def package_scoped_nodeid(item: Item) -> str:
+    """The item's nodeid relative to its enclosing package, independent of pytest's rootdir.
+
+    Snapshot entries are keyed by the pytest nodeid, which is relative to pytest's rootdir.
+    The committed ``*.snapshot.json`` / ``*.validation.json`` files assume the rootdir is the
+    package containing the test (``tests/...::<test>``), but pytest can be invoked with a
+    different rootdir — VS Code's test runner, for example, pins ``--rootdir=<workspace folder>``,
+    which prefixes every nodeid with the package directory and makes every lookup of a recorded
+    entry miss. Keying by the nodeid relative to the nearest enclosing ``pyproject.toml`` keeps
+    the entries stable no matter where pytest was started from.
+    """
+    path = Path(item.path)
+    for parent in path.parents:
+        if (parent / "pyproject.toml").is_file():
+            # Partition splits by the first occurance and also returns the partition itself
+            # "tests/test_thing.py::TestThing::test_case".partition("::") == ("tests/test_thing.py", "::", "TestThing::test_case")
+            _, separator, remainder = item.nodeid.partition("::")
+            return path.relative_to(parent).as_posix() + separator + remainder
+    return item.nodeid
+
+
 @pytest.fixture(scope="function")
 def _snapshot_session(request: SubRequest):
     update_overwrite = os.environ.get("SNAPSHOT_UPDATE") == "1"
@@ -104,7 +126,7 @@ def _snapshot_session(request: SubRequest):
 
     sm = SnapshotSession(
         base_file_path=os.path.join(request.fspath.dirname, request.fspath.purebasename),
-        scope_key=request.node.nodeid,
+        scope_key=package_scoped_nodeid(request.node),
         update=update_overwrite or request.config.option.snapshot_update,
         raw=raw_overwrite or request.config.option.snapshot_raw,
         verify=False if request.config.option.snapshot_skip_all else True,

{localstack_snapshot-0.3.4 → localstack_snapshot-0.3.5}/localstack_snapshot/snapshots/prototype.py

@@ -217,7 +217,7 @@ class SnapshotSession:
 
         if not self.update and (not self.recorded_state or self.recorded_state.get(key) is None):
             raise Exception(
-                f"No state for {self.scope_key} recorded. Please (re-)generate the snapshot for this test."
+                f"No state for {key} recorded. Please (re-)generate the snapshot for this test."
             )
 
         # TODO: we should return something meaningful here

{localstack_snapshot-0.3.4 → localstack_snapshot-0.3.5}/localstack_snapshot/snapshots/transformer.py

@@ -89,8 +89,7 @@ def _register_serialized_reference_replacement(
 
 
 class Transformer(Protocol):
-    def transform(self, input_data: dict, *, ctx: TransformContext) -> dict:
-        ...
+    def transform(self, input_data: dict, *, ctx: TransformContext) -> dict: ...
 
 
 # Transformers

{localstack_snapshot-0.3.4 → localstack_snapshot-0.3.5}/localstack_snapshot.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: localstack-snapshot
-Version: 0.3.4
+Version: 0.3.5
 Summary: Extracted snapshot testing lib for LocalStack
 Author-email: LocalStack Contributors <info@localstack.cloud>
 License: 
@@ -218,10 +218,10 @@ License-File: LICENSE
 Requires-Dist: jsonpath-ng>1.6
 Requires-Dist: deepdiff
 Provides-Extra: dev
-Requires-Dist: black==23.10.0; extra == "dev"
-Requires-Dist: pytest>=7.0; extra == "dev"
-Requires-Dist: coverage[toml]>=5.0.0; extra == "dev"
-Requires-Dist: ruff==0.1.0; extra == "dev"
+Requires-Dist: black==26.5.1; extra == "dev"
+Requires-Dist: pytest>=9.1.1; extra == "dev"
+Requires-Dist: coverage[toml]>=7.15.4; extra == "dev"
+Requires-Dist: ruff==0.16.5; extra == "dev"
 Dynamic: license-file
 
 Snapshot testing for pytest

{localstack_snapshot-0.3.4 → localstack_snapshot-0.3.5}/localstack_snapshot.egg-info/SOURCES.txt

@@ -16,5 +16,6 @@ localstack_snapshot/snapshots/transformer.py
 localstack_snapshot/snapshots/transformer_utility.py
 localstack_snapshot/util/__init__.py
 localstack_snapshot/util/encoding.py
+tests/test_pytest_snapshot.py
 tests/test_snapshots.py
 tests/test_transformer.py

localstack_snapshot-0.3.5/localstack_snapshot.egg-info/requires.txt

@@ -0,0 +1,8 @@
+jsonpath-ng>1.6
+deepdiff
+
+[dev]
+black==26.5.1
+pytest>=9.1.1
+coverage[toml]>=7.15.4
+ruff==0.16.5

{localstack_snapshot-0.3.4 → localstack_snapshot-0.3.5}/pyproject.toml

@@ -7,7 +7,7 @@ name = "localstack-snapshot"
 authors = [
     { name = "LocalStack Contributors", email = "info@localstack.cloud" }
 ]
-version = "0.3.4"
+version = "0.3.5"
 description = "Extracted snapshot testing lib for LocalStack"
 dependencies = [
     "jsonpath-ng>1.6",
@@ -28,10 +28,10 @@ dynamic = ["readme"]
 
 [project.optional-dependencies]
 dev = [
-    "black==23.10.0",
-    "pytest>=7.0",
-    "coverage[toml]>=5.0.0",
-    "ruff==0.1.0"
+    "black==26.5.1",
+    "pytest>=9.1.1",
+    "coverage[toml]>=7.15.4",
+    "ruff==0.16.5"
 ]
 
 [tool.setuptools]
@@ -56,11 +56,6 @@ include = '((localstack_snapshot)/.*\.py$|tests/.*\.py$)'
 # Always generate Python 3.10-compatible code.
 target-version = "py310"
 line-length = 110
-select = ["B", "C", "E", "F", "I", "W", "T", "B9"]
-ignore = [
-    "E501", # E501 Line too long - handled by black, see https://docs.astral.sh/ruff/faq/#is-ruff-compatible-with-black
-    "C901", # C901 complex-structure - later refactoring will handle this, see https://docs.astral.sh/ruff/rules/complex-structure/#complex-structure-c901
-]
 exclude = [
     ".venv*",
     "venv*",
@@ -70,3 +65,9 @@ exclude = [
     "*.egg-info",
     ".git",
 ]
+[tool.ruff.lint]
+select = ["B", "C", "E", "F", "I", "W", "T", "B9"]
+ignore = [
+    "E501", # E501 Line too long - handled by black, see https://docs.astral.sh/ruff/faq/#is-ruff-compatible-with-black
+    "C901", # C901 complex-structure - later refactoring will handle this, see https://docs.astral.sh/ruff/rules/complex-structure/#complex-structure-c901
+]

localstack_snapshot-0.3.5/tests/test_pytest_snapshot.py

@@ -0,0 +1,53 @@
+from pathlib import Path
+from types import SimpleNamespace
+
+from localstack_snapshot.pytest.snapshot import package_scoped_nodeid
+
+
+def _create_package(root: Path) -> Path:
+    package = root / "my-package"
+    (package / "tests" / "services").mkdir(parents=True)
+    (package / "pyproject.toml").touch()
+    return package
+
+
+def test_nodeid_from_a_package_rooted_run_is_unchanged(tmp_path):
+    package = _create_package(tmp_path)
+    item = SimpleNamespace(
+        path=package / "tests" / "services" / "test_thing.py",
+        nodeid="tests/services/test_thing.py::TestThing::test_case[param]",
+    )
+
+    assert (
+        package_scoped_nodeid(item) == "tests/services/test_thing.py::TestThing::test_case[param]"
+    )
+
+
+def test_nodeid_from_a_repo_rooted_run_is_anchored_to_the_package(tmp_path):
+    package = _create_package(tmp_path)
+    item = SimpleNamespace(
+        path=package / "tests" / "services" / "test_thing.py",
+        nodeid="my-package/tests/services/test_thing.py::test_case",
+    )
+
+    assert package_scoped_nodeid(item) == "tests/services/test_thing.py::test_case"
+
+
+def test_nearest_pyproject_wins_over_the_workspace_root(tmp_path):
+    (tmp_path / "pyproject.toml").touch()
+    package = _create_package(tmp_path)
+    item = SimpleNamespace(
+        path=package / "tests" / "services" / "test_thing.py",
+        nodeid="my-package/tests/services/test_thing.py::test_case",
+    )
+
+    assert package_scoped_nodeid(item) == "tests/services/test_thing.py::test_case"
+
+
+def test_nodeid_without_an_enclosing_package_is_unchanged(tmp_path):
+    item = SimpleNamespace(
+        path=tmp_path / "tests" / "test_thing.py",
+        nodeid="tests/test_thing.py::test_case",
+    )
+
+    assert package_scoped_nodeid(item) == "tests/test_thing.py::test_case"

localstack_snapshot-0.3.4/localstack_snapshot/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.3.4"

localstack_snapshot-0.3.4/localstack_snapshot.egg-info/requires.txt

@@ -1,8 +0,0 @@
-jsonpath-ng>1.6
-deepdiff
-
-[dev]
-black==23.10.0
-pytest>=7.0
-coverage[toml]>=5.0.0
-ruff==0.1.0