localstack-snapshot 0.1.0__tar.gz → 0.2.0__tar.gz

{localstack-snapshot-0.1.0 → localstack_snapshot-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: localstack-snapshot
-Version: 0.1.0
+Version: 0.2.0
 Summary: Extracted snapshot testing lib for LocalStack
 Author-email: LocalStack Contributors <info@localstack.cloud>
 License: 
@@ -215,9 +215,8 @@ Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: jsonpath-ng==1.5.3
+Requires-Dist: jsonpath-ng>1.6
 Requires-Dist: deepdiff
-Requires-Dist: botocore
 Provides-Extra: dev
 Requires-Dist: black==23.10.0; extra == "dev"
 Requires-Dist: pytest>=7.0; extra == "dev"

localstack_snapshot-0.2.0/localstack_snapshot/__init__.py

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

{localstack-snapshot-0.1.0 → localstack_snapshot-0.2.0}/localstack_snapshot/snapshots/prototype.py

@@ -1,3 +1,4 @@
+import io
 import json
 import logging
 import os
@@ -7,7 +8,6 @@ from pathlib import Path
 from re import Pattern
 from typing import Dict, List, Optional
 
-from botocore.response import StreamingBody
 from deepdiff import DeepDiff
 from jsonpath_ng import DatumInContext
 from jsonpath_ng.ext import parse
@@ -164,6 +164,23 @@ class SnapshotSession:
     def _update(self, key: str, obj_state: dict) -> None:
         self.observed_state[key] = obj_state
 
+    def match_object(self, key: str, obj: object) -> None:
+        def _convert_object_to_dict(obj_):
+            if isinstance(obj_, dict):
+                for key in list(obj_.keys()):
+                    if key.startswith("_"):
+                        del obj_[key]
+                    else:
+                        obj_[key] = _convert_object_to_dict(obj_[key])
+            elif isinstance(obj_, list):
+                for idx, val in enumerate(obj_):
+                    obj_[idx] = _convert_object_to_dict(val)
+            elif hasattr(obj_, "__dict__"):
+                return _convert_object_to_dict(obj_.__dict__)
+            return obj_
+
+        return self.match(key, _convert_object_to_dict(obj))
+
     def match(self, key: str, obj: dict) -> None:
         if key in self.called_keys:
             raise Exception(
@@ -243,11 +260,10 @@ class SnapshotSession:
     def _transform_dict_to_parseable_values(self, original):
         """recursively goes through dict and tries to resolve values to strings (& parse them as json if possible)"""
         for k, v in original.items():
-            if isinstance(v, StreamingBody):
+            if isinstance(v, io.IOBase):
                 # update v for json parsing below
-                original[k] = v = v.read().decode(
-                    "utf-8"
-                )  # TODO: patch boto client so this doesn't break any further read() calls
+                # TODO: patch boto client so this doesn't break any further read() calls
+                original[k] = v = v.read().decode("utf-8")
             if isinstance(v, list) and v:
                 for item in v:
                     if isinstance(item, dict):
@@ -339,7 +355,7 @@ class SnapshotSession:
 
         def build_full_path_nodes(field_match: DatumInContext):
             """Traverse the matched Datum to build the path field by field"""
-            full_path_nodes = [str(field_match.path)]
+            full_path_nodes = [str(field_match.path).replace("'", "")]
             next_node = field_match
             while next_node.context is not None:
                 full_path_nodes.append(str(next_node.context.path))

{localstack-snapshot-0.1.0 → localstack_snapshot-0.2.0}/localstack_snapshot/snapshots/transformer.py

@@ -16,6 +16,10 @@ SNAPSHOT_LOGGER.setLevel(logging.DEBUG if os.environ.get("DEBUG_SNAPSHOT") else
 GlobalReplacementFn = Callable[[str], str]
 
 
+class TransformerException(Exception):
+    pass
+
+
 class TransformContext:
     _cache: dict
     replacements: list[GlobalReplacementFn]
@@ -43,6 +47,19 @@ class TransformContext:
 def _register_serialized_reference_replacement(
     transform_context: TransformContext, *, reference_value: str, replacement: str
 ):
+    # Provide a better error message for the TypeError if the reference value is not iterable (e.g., float)
+    # Example: `TypeError: argument of type 'float' is not iterable`
+    # Using a list would throw an AttributeError because `.replace` is not applicable.
+    # The snapshot library currently only supports strings for reference replacements
+    if not isinstance(reference_value, str):
+        message = (
+            f"The reference value {reference_value} of type {type(reference_value)} is not a string."
+            f" Consider using `reference_replacement=False` in your transformer"
+            f" for the replacement {replacement} because reference replacements are only supported for strings."
+        )
+        SNAPSHOT_LOGGER.error(message)
+        raise TransformerException(message)
+
     if '"' in reference_value:
         reference_value = reference_value.replace('"', '\\"')
 
@@ -327,3 +344,19 @@ class TimestampTransformer:
 
     def _transform_list(self, input_data: list, ctx: TransformContext = None) -> list:
         return [self._transform(e, ctx=ctx) for e in input_data]
+
+
+class TextTransformer:
+    def __init__(self, text: str, replacement: str):
+        self.text = text
+        self.replacement = replacement
+
+    def transform(self, input_data: dict, *, ctx: TransformContext) -> dict:
+        def replace_val(s):
+            return s.replace(self.text, self.replacement)
+
+        ctx.register_serialized_replacement(replace_val)
+        SNAPSHOT_LOGGER.debug(
+            f"Registering text pattern '{self.text}' in snapshot with '{self.replacement}'"
+        )
+        return input_data

{localstack-snapshot-0.1.0 → localstack_snapshot-0.2.0}/localstack_snapshot/snapshots/transformer_utility.py

@@ -5,6 +5,7 @@ from localstack_snapshot.snapshots.transformer import (
     JsonpathTransformer,
     KeyValueBasedTransformer,
     RegexTransformer,
+    TextTransformer,
 )
 
 
@@ -67,3 +68,16 @@ class TransformerUtility:
         :return: RegexTransformer
         """
         return RegexTransformer(regex, replacement)
+
+    @staticmethod
+    def text(text: str, replacement: str):
+        """Creates a new TextTransformer. All occurrences in the string-converted dict will be replaced.
+
+        Useful if the text contains special characters that would confuse the RegexTransformer, like '+' or '('.
+
+        :param text: the text that should be replaced
+        :param replacement: the value which will replace the original value.
+
+        :return: TextTransformer
+        """
+        return TextTransformer(text, replacement)

{localstack-snapshot-0.1.0 → localstack_snapshot-0.2.0}/localstack_snapshot.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: localstack-snapshot
-Version: 0.1.0
+Version: 0.2.0
 Summary: Extracted snapshot testing lib for LocalStack
 Author-email: LocalStack Contributors <info@localstack.cloud>
 License: 
@@ -215,9 +215,8 @@ Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: jsonpath-ng==1.5.3
+Requires-Dist: jsonpath-ng>1.6
 Requires-Dist: deepdiff
-Requires-Dist: botocore
 Provides-Extra: dev
 Requires-Dist: black==23.10.0; extra == "dev"
 Requires-Dist: pytest>=7.0; extra == "dev"

{localstack-snapshot-0.1.0 → localstack_snapshot-0.2.0}/localstack_snapshot.egg-info/requires.txt

@@ -1,6 +1,5 @@
-jsonpath-ng==1.5.3
+jsonpath-ng>1.6
 deepdiff
-botocore
 
 [dev]
 black==23.10.0

{localstack-snapshot-0.1.0 → localstack_snapshot-0.2.0}/pyproject.toml

@@ -7,12 +7,11 @@ name = "localstack-snapshot"
 authors = [
     { name = "LocalStack Contributors", email = "info@localstack.cloud" }
 ]
-version = "0.1.0"
+version = "0.2.0"
 description = "Extracted snapshot testing lib for LocalStack"
 dependencies = [
-    "jsonpath-ng==1.5.3",  # TODO: resolve this pin
+    "jsonpath-ng>1.6",
     "deepdiff",
-    "botocore",
 ]
 requires-python = ">=3.10"
 license = {file = "LICENSE"}

{localstack-snapshot-0.1.0 → localstack_snapshot-0.2.0}/tests/test_snapshots.py

@@ -1,3 +1,5 @@
+import io
+
 import pytest
 
 from localstack_snapshot.snapshots import SnapshotSession
@@ -20,6 +22,12 @@ class TestSnapshotManager:
             sm._assert_all()
         ctx.match("Parity snapshot failed")
 
+    def test_diff_with_io_stream(self):
+        sm = SnapshotSession(scope_key="A", verify=True, base_file_path="", update=False)
+        sm.recorded_state = {"key_a": {"a": "data"}}
+        sm.match("key_a", {"a": io.BytesIO(b"data")})
+        sm._assert_all()
+
     def test_multiple_assertmatch_with_same_key_fail(self):
         sm = SnapshotSession(scope_key="A", verify=True, base_file_path="", update=False)
         sm.recorded_state = {"key_a": {"a": 3}}
@@ -37,6 +45,48 @@ class TestSnapshotManager:
         sm.match("key_a", {"aaa": "something", "bbb": "something hello"})
         sm._assert_all()
 
+    def test_match_object_nochange(self):
+        class CustomObject:
+            def __init__(self, name, nested=False):
+                self.name = name
+                if nested:
+                    self.nested = CustomObject(f"nested{name}")
+                    self.listed = [CustomObject(f"listed{name}"), "otherobj"]
+
+        sm = SnapshotSession(scope_key="A", verify=True, base_file_path="", update=False)
+        sm.recorded_state = {
+            "key_a": {
+                "name": "myname",
+                "nested": {"name": "nestedmyname"},
+                "listed": [{"name": "listedmyname"}, "otherobj"],
+            }
+        }
+        sm.match_object("key_a", CustomObject(name="myname", nested=True))
+        sm._assert_all()
+
+    def test_match_object_ignore_private_values(self):
+        class CustomObject:
+            def __init__(self, name):
+                self.name = name
+                self._internal = "n/a"
+
+        sm = SnapshotSession(scope_key="A", verify=True, base_file_path="", update=False)
+        sm.recorded_state = {"key_a": {"name": "myname"}}
+        sm.match_object("key_a", CustomObject(name="myname"))
+        sm._assert_all()
+
+    def test_match_object_change(self):
+        class CustomObject:
+            def __init__(self, name):
+                self.name = name
+
+        sm = SnapshotSession(scope_key="A", verify=True, base_file_path="", update=False)
+        sm.recorded_state = {"key_a": {"name": "myname"}}
+        sm.match_object("key_a", CustomObject(name="diffname"))
+        with pytest.raises(Exception) as ctx:
+            sm._assert_all()
+        ctx.match("Parity snapshot failed")
+
     # def test_context_replacement_no_change(self):
     #     sm = SnapshotSession(scope_key="A", verify=True, base_file_path="", update=False)
     #     sm.add_transformer(TransformerUtility.key_value("name"))

{localstack-snapshot-0.1.0 → localstack_snapshot-0.2.0}/tests/test_transformer.py

@@ -211,6 +211,31 @@ class TestTransformer:
         output = transformer.transform(input, ctx=ctx)
         assert output == expected
 
+    @pytest.mark.parametrize(
+        "value",
+        [
+            "a+b",
+            "question?",
+            "amount: $4.00",
+            "emoji: ^^",
+            "sentence.",
+            "others (like so)",
+            "special {char}",
+        ],
+    )
+    def test_text(self, value):
+        input = {"key": f"some {value} with more text"}
+
+        expected = {"key": "some <value> with more text"}
+
+        transformer = TransformerUtility.text(value, "<value>")
+
+        ctx = TransformContext()
+        output = transformer.transform(json.dumps(input), ctx=ctx)
+        for sr in ctx.serialized_replacements:
+            output = sr(output)
+        assert json.loads(output) == expected
+
 
 class TestTimestampTransformer:
     def test_generic_timestamp_transformer(self):

localstack-snapshot-0.1.0/localstack_snapshot/__init__.py

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