eventsourcing 9.2.21__py3-none-any.whl → 9.3.0__py3-none-any.whl

eventsourcing/tests/system_tests/test_system.py

@@ -0,0 +1,284 @@
+from __future__ import annotations
+
+from typing import ClassVar, Sequence
+from unittest.case import TestCase
+from uuid import NAMESPACE_URL, uuid4, uuid5
+
+from eventsourcing.application import Application, RecordingEvent
+from eventsourcing.domain import Aggregate
+from eventsourcing.persistence import IntegrityError, Notification, Tracking
+from eventsourcing.system import (
+    Follower,
+    Leader,
+    ProcessApplication,
+    RecordingEventReceiver,
+    System,
+)
+from eventsourcing.tests.application import BankAccounts
+from eventsourcing.tests.application_tests.test_processapplication import EmailProcess
+from eventsourcing.tests.domain import BankAccount
+from eventsourcing.utils import get_topic, resolve_topic
+
+system_defined_as_global = System(
+    pipes=[
+        [
+            BankAccounts,
+            EmailProcess,
+        ],
+        [Application],
+    ]
+)
+
+
+class TestSystem(TestCase):
+    def test_graph_nodes_and_edges(self):
+        system = System(
+            pipes=[
+                [
+                    BankAccounts,
+                    EmailProcess,
+                ],
+                [Application],
+            ]
+        )
+        self.assertEqual(len(system.nodes), 3)
+        self.assertEqual(system.nodes["BankAccounts"], get_topic(BankAccounts))
+        self.assertEqual(system.nodes["EmailProcess"], get_topic(EmailProcess))
+        self.assertEqual(system.nodes["Application"], get_topic(Application))
+
+        self.assertEqual(system.leaders, ["BankAccounts"])
+        self.assertEqual(system.followers, ["EmailProcess"])
+        self.assertEqual(system.singles, ["Application"])
+
+        self.assertEqual(len(system.edges), 1)
+        self.assertIn(
+            (
+                "BankAccounts",
+                "EmailProcess",
+            ),
+            system.edges,
+        )
+
+        self.assertEqual(len(system.singles), 1)
+
+    def test_duplicate_edges_are_eliminated(self):
+        system = System(
+            pipes=[
+                [
+                    BankAccounts,
+                    EmailProcess,
+                ],
+                [
+                    BankAccounts,
+                    EmailProcess,
+                ],
+                [Application],
+            ]
+        )
+        self.assertEqual(len(system.nodes), 3)
+        self.assertEqual(system.nodes["BankAccounts"], get_topic(BankAccounts))
+        self.assertEqual(system.nodes["EmailProcess"], get_topic(EmailProcess))
+        self.assertEqual(system.nodes["Application"], get_topic(Application))
+
+        self.assertEqual(system.leaders, ["BankAccounts"])
+        self.assertEqual(system.followers, ["EmailProcess"])
+        self.assertEqual(system.singles, ["Application"])
+
+        self.assertEqual(len(system.edges), 1)
+        self.assertIn(
+            (
+                "BankAccounts",
+                "EmailProcess",
+            ),
+            system.edges,
+        )
+
+        self.assertEqual(len(system.singles), 1)
+
+    def test_raises_type_error_not_a_follower(self):
+        with self.assertRaises(TypeError) as cm:
+            System(
+                pipes=[
+                    [
+                        BankAccounts,
+                        Leader,
+                    ],
+                ]
+            )
+        exception = cm.exception
+        self.assertEqual(
+            exception.args[0],
+            "Not a follower class: <class 'eventsourcing.system.Leader'>",
+        )
+
+    def test_raises_type_error_not_a_processor(self):
+        with self.assertRaises(TypeError) as cm:
+            System(
+                pipes=[
+                    [
+                        BankAccounts,
+                        Follower,
+                        EmailProcess,
+                    ],
+                ]
+            )
+        exception = cm.exception
+        self.assertEqual(
+            exception.args[0],
+            "Not a process application class: <class 'eventsourcing.system.Follower'>",
+        )
+
+    def test_is_leaders_only(self):
+        system = System(
+            pipes=[
+                [
+                    Leader,
+                    ProcessApplication,
+                    ProcessApplication,
+                ],
+            ]
+        )
+        self.assertEqual(list(system.leaders_only), ["Leader"])
+
+    def test_leader_class(self):
+        system = System(
+            pipes=[
+                [
+                    Application,
+                    ProcessApplication,
+                    ProcessApplication,
+                ],
+            ]
+        )
+        self.assertTrue(issubclass(system.leader_cls("Application"), Leader))
+        self.assertTrue(issubclass(system.leader_cls("ProcessApplication"), Leader))
+
+    def test_system_has_topic_if_defined_as_module_attribute(self):
+        system_topic = system_defined_as_global.topic
+        self.assertTrue(system_topic.endswith("test_system:system_defined_as_global"))
+        self.assertEqual(resolve_topic(system_topic), system_defined_as_global)
+
+    def test_system_topic_is_none_if_defined_in_function_body(self):
+        system = System([[]])
+        self.assertIsNone(system.topic)
+
+
+class TestLeader(TestCase):
+    def test(self):
+        # Define fixture that receives prompts.
+        class FollowerFixture(RecordingEventReceiver):
+            def __init__(self):
+                self.num_received = 0
+
+            def receive_recording_event(self, _: RecordingEvent) -> None:
+                self.num_received += 1
+
+        # Test fixture is working.
+        follower = FollowerFixture()
+        follower.receive_recording_event(RecordingEvent("Leader", [], 1))
+        self.assertEqual(follower.num_received, 1)
+
+        # Construct leader.
+        leader = Leader()
+        leader.lead(follower)
+
+        # Check follower receives a prompt when there are new events.
+        leader.save(Aggregate())
+        self.assertEqual(follower.num_received, 2)
+
+        # Check follower doesn't receive prompt when no new events.
+        leader.save()
+        self.assertEqual(follower.num_received, 2)
+
+        # Check follower doesn't receive prompt when recordings are filtered out.
+        leader.notify_topics = ["topic1"]
+        leader.save(Aggregate())
+        self.assertEqual(follower.num_received, 2)
+
+
+class TestFollower(TestCase):
+    def test_process_event(self):
+        class UUID5EmailNotification(Aggregate):
+            def __init__(self, to, subject, message):
+                self.to = to
+                self.subject = subject
+                self.message = message
+
+            @staticmethod
+            def create_id(to: str):
+                return uuid5(NAMESPACE_URL, f"/emails/{to}")
+
+        class UUID5EmailProcess(EmailProcess):
+            def policy(self, domain_event, processing_event):
+                if isinstance(domain_event, BankAccount.Opened):
+                    notification = UUID5EmailNotification(
+                        to=domain_event.email_address,
+                        subject="Your New Account",
+                        message=f"Dear {domain_event.full_name}, ...",
+                    )
+                    processing_event.collect_events(notification)
+
+        bank_accounts = BankAccounts()
+        email_process = UUID5EmailProcess()
+
+        account = BankAccount.open(
+            full_name="Alice",
+            email_address="alice@example.com",
+        )
+
+        recordings = bank_accounts.save(account)
+
+        self.assertEqual(len(recordings), 1)
+
+        aggregate_event = recordings[0].domain_event
+        notification = recordings[0].notification
+        tracking = Tracking(bank_accounts.name, notification.id)
+
+        # Process the event.
+        email_process.process_event(aggregate_event, tracking)
+        self.assertEqual(
+            email_process.recorder.max_tracking_id(bank_accounts.name), notification.id
+        )
+
+        # Process the event again, ignore tracking integrity error.
+        email_process.process_event(aggregate_event, tracking)
+        self.assertEqual(
+            email_process.recorder.max_tracking_id(bank_accounts.name), notification.id
+        )
+
+        # Create another event that will cause conflict with email processing.
+        account = BankAccount.open(
+            full_name="Alice",
+            email_address="alice@example.com",
+        )
+        recordings = bank_accounts.save(account)
+
+        # Process the event and expect an integrity error.
+        aggregate_event = recordings[0].domain_event
+        notification = recordings[0].notification
+        tracking = Tracking(bank_accounts.name, notification.id)
+        with self.assertRaises(IntegrityError):
+            email_process.process_event(aggregate_event, tracking)
+
+    def test_filter_received_notifications(self):
+        class MyFollower(Follower):
+            follow_topics: ClassVar[Sequence[str]] = []
+
+            def policy(self, *args, **kwargs):
+                pass
+
+        follower = MyFollower()
+        notifications = [
+            Notification(
+                id=1,
+                originator_id=uuid4(),
+                originator_version=1,
+                state=b"",
+                topic="topic1",
+            )
+        ]
+        self.assertEqual(len(follower.filter_received_notifications(notifications)), 1)
+        follower.follow_topics = ["topic1"]
+        self.assertEqual(len(follower.filter_received_notifications(notifications)), 1)
+        follower.follow_topics = ["topic2"]
+        self.assertEqual(len(follower.filter_received_notifications(notifications)), 0)

eventsourcing/tests/utils_tests/test_utils.py

@@ -0,0 +1,226 @@
+from typing import cast
+from unittest import TestCase
+
+import eventsourcing
+from eventsourcing.domain import Aggregate
+from eventsourcing.utils import (
+    TopicError,
+    clear_topic_cache,
+    get_topic,
+    register_topic,
+    resolve_topic,
+    retry,
+    strtobool,
+)
+
+
+class TestRetryDecorator(TestCase):
+    def test_bare(self):
+        @retry
+        def f():
+            pass
+
+        f()
+
+    def test_no_args(self):
+        @retry()
+        def f():
+            pass
+
+        f()
+
+    def test_exception_single_value(self):
+        @retry(ValueError)
+        def f():
+            pass
+
+        f()
+
+    def test_exception_sequence(self):
+        @retry((ValueError, TypeError))
+        def f():
+            pass
+
+        f()
+
+    def test_exception_type_error(self):
+        with self.assertRaises(TypeError):
+
+            @retry(1)
+            def _():
+                pass
+
+        with self.assertRaises(TypeError):
+
+            @retry((ValueError, 1))
+            def _():
+                pass
+
+    def test_exception_raised_no_retry(self):
+        self.call_count = 0
+
+        @retry(ValueError)
+        def f():
+            self.call_count += 1
+            raise ValueError
+
+        with self.assertRaises(ValueError):
+            f()
+
+        self.assertEqual(self.call_count, 1)
+
+    def test_max_attempts(self):
+        self.call_count = 0
+
+        @retry(ValueError, max_attempts=2)
+        def f():
+            self.call_count += 1
+            raise ValueError
+
+        with self.assertRaises(ValueError):
+            f()
+
+        self.assertEqual(self.call_count, 2)
+
+    def test_max_attempts_not_int(self):
+        with self.assertRaises(TypeError):
+
+            @retry(ValueError, max_attempts="a")
+            def f():
+                pass
+
+    def test_wait(self):
+        self.call_count = 0
+
+        @retry(ValueError, max_attempts=2, wait=0.001)
+        def f():
+            self.call_count += 1
+            raise ValueError
+
+        with self.assertRaises(ValueError):
+            f()
+
+        self.assertEqual(self.call_count, 2)
+
+    def test_wait_not_float(self):
+        with self.assertRaises(TypeError):
+
+            @retry(ValueError, max_attempts=1, wait="a")
+            def f():
+                pass
+
+    def test_stall(self):
+        self.call_count = 0
+
+        @retry(ValueError, max_attempts=2, stall=0.001)
+        def f():
+            self.call_count += 1
+            raise ValueError
+
+        with self.assertRaises(ValueError):
+            f()
+
+        self.assertEqual(self.call_count, 2)
+
+    def test_stall_not_float(self):
+        with self.assertRaises(TypeError):
+
+            @retry(ValueError, max_attempts=1, stall="a")
+            def f():
+                pass
+
+
+class TestStrtobool(TestCase):
+    def test_true_values(self):
+        for s in ("y", "yes", "t", "true", "on", "1"):
+            self.assertTrue(strtobool(s), s)
+
+    def test_false_values(self):
+        for s in ("n", "no", "f", "false", "off", "0"):
+            self.assertFalse(strtobool(s), s)
+
+    def test_raises_value_error(self):
+        for s in ("", "a", "b", "c"):
+            with self.assertRaises(ValueError):
+                strtobool(s)
+
+    def test_raises_type_error(self):
+        for x in (None, True, False, 1, 2, 3):
+            with self.assertRaises(TypeError):
+                strtobool(cast(str, x))
+
+
+class TestTopics(TestCase):
+    def test_get_topic(self):
+        self.assertEqual("eventsourcing.domain:Aggregate", get_topic(Aggregate))
+
+    def test_resolve_topic(self):
+        self.assertEqual(Aggregate, resolve_topic("eventsourcing.domain:Aggregate"))
+
+    def test_register_topic_rename_class(self):
+        register_topic("eventsourcing.domain:OldClass", Aggregate)
+        self.assertEqual(Aggregate, resolve_topic("eventsourcing.domain:OldClass"))
+        self.assertEqual(
+            Aggregate.Created, resolve_topic("eventsourcing.domain:OldClass.Created")
+        )
+
+    def test_register_topic_move_module_into_package(self):
+        register_topic("oldmodule", eventsourcing.domain)
+        self.assertEqual(Aggregate, resolve_topic("oldmodule:Aggregate"))
+        self.assertEqual(
+            Aggregate.Created, resolve_topic("oldmodule:Aggregate.Created")
+        )
+
+    def test_register_topic_rename_package(self):
+        register_topic("oldpackage", eventsourcing)
+        self.assertEqual(Aggregate, resolve_topic("oldpackage.domain:Aggregate"))
+        self.assertEqual(
+            Aggregate.Created, resolve_topic("oldpackage.domain:Aggregate.Created")
+        )
+
+    def test_register_topic_move_package(self):
+        register_topic("old.eventsourcing.domain", eventsourcing.domain)
+        self.assertEqual(Aggregate, resolve_topic("old.eventsourcing.domain:Aggregate"))
+
+    def test_register_topic_rename_package_and_module(self):
+        register_topic("old.old", eventsourcing.domain)
+        self.assertEqual(Aggregate, resolve_topic("old.old:Aggregate"))
+
+    def test_topic_errors(self):
+        # Wrong module name.
+        with self.assertRaises(TopicError) as cm:
+            resolve_topic("oldmodule:Aggregate")
+        expected_msg = (
+            "Failed to resolve topic 'oldmodule:Aggregate': No module named 'oldmodule'"
+        )
+        self.assertEqual(expected_msg, cm.exception.args[0])
+
+        # Wrong class name.
+        with self.assertRaises(TopicError) as cm:
+            resolve_topic("eventsourcing.domain:OldClass")
+        expected_msg = (
+            "Failed to resolve topic 'eventsourcing.domain:OldClass': "
+            "module 'eventsourcing.domain' has no attribute 'OldClass'"
+        )
+        self.assertEqual(expected_msg, cm.exception.args[0])
+
+        # Wrong class attribute.
+        with self.assertRaises(TopicError) as cm:
+            resolve_topic("eventsourcing.domain:Aggregate.OldClass")
+        expected_msg = (
+            "Failed to resolve topic 'eventsourcing.domain:Aggregate.OldClass': "
+            "type object 'Aggregate' has no attribute 'OldClass'"
+        )
+        self.assertEqual(expected_msg, cm.exception.args[0])
+
+        # Can register same thing twice.
+        register_topic("old", eventsourcing)
+        register_topic("old", eventsourcing)
+
+        # Can't overwrite with another thing.
+        with self.assertRaises(TopicError) as cm:
+            register_topic("old", TestCase)
+        self.assertIn("is already registered for topic 'old'", cm.exception.args[0])
+
+    def tearDown(self) -> None:
+        clear_topic_cache()