Merge pull request #44 from canonical/fix-dcbase-dedup

dedup dcbase.replace

pyproject.toml

@@ -8,7 +8,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "ops-scenario"
 
-version = "4.0.1"
+version = "4.0.2"
 
 authors = [
     { name = "Pietro Pasotti", email = "[email protected]" }

scenario/state.py

@@ -80,9 +80,11 @@ class StateValidationError(RuntimeError):
 @dataclasses.dataclass(frozen=True)
 class _DCBase:
     def replace(self, *args, **kwargs):
-        return dataclasses.replace(self, *args, **kwargs)
+        """Produce a deep copy of this class, with some arguments replaced with new ones."""
+        return dataclasses.replace(self.copy(), *args, **kwargs)
 
     def copy(self) -> "Self":
+        """Produce a deep copy of this object."""
         return copy.deepcopy(self)
 
 

tests/test_consistency_checker.py

@@ -287,7 +287,7 @@ def test_relation_without_endpoint():
 
     assert_consistent(
         State(
-            relations=[Relation("foo", relation_id=1), Relation("bar", relation_id=1)]
+            relations=[Relation("foo", relation_id=1), Relation("bar", relation_id=2)]
         ),
         Event("start"),
         _CharmSpec(

tests/test_dcbase.py

@@ -0,0 +1,41 @@
+import dataclasses
+from typing import Dict, List
+
+from scenario.state import _DCBase
+
+
+@dataclasses.dataclass(frozen=True)
+class Foo(_DCBase):
+    a: int
+    b: List[int]
+    c: Dict[int, List[int]]
+
+
+def test_base_case():
+    l = [1, 2]
+    l1 = [1, 2, 3]
+    d = {1: l1}
+    f = Foo(1, l, d)
+    g = f.replace(a=2)
+
+    assert g.a == 2
+    assert g.b == l
+    assert g.c == d
+    assert g.c[1] == l1
+
+
+def test_dedup_on_replace():
+    l = [1, 2]
+    l1 = [1, 2, 3]
+    d = {1: l1}
+    f = Foo(1, l, d)
+    g = f.replace(a=2)
+
+    l.append(3)
+    l1.append(4)
+    d[2] = "foobar"
+
+    assert g.a == 2
+    assert g.b == [1, 2]
+    assert g.c == {1: [1, 2, 3]}
+    assert g.c[1] == [1, 2, 3]