openmodule-test 13.5.0__tar.gz → 14.0.0__tar.gz

{openmodule_test-13.5.0 → openmodule_test-14.0.0}/ChangeLog

@@ -1,6 +1,18 @@
 CHANGES
 =======
 
+v14.0.0
+-------
+
+* Add breaking changes to docs
+* OM-693 Openmodule sentry v2
+* Update known\_issues.md [skip ci]
+
+v13.6.0
+-------
+
+* OM-697 OpenModule Verbesserungen
+
 v13.5.0
 -------
 
@@ -147,8 +159,6 @@ v12.0.0.rc0
 * SettingsProvider docs
 * SettingsProvider docs
 * added settings\_models requirement, marking Test\* classes that are not tests with \_\_test\_\_ = False
-* AAAAAAAABBBBBBBBBBBBBBMerge branch 'master' into DEV-5415
-* [skip ci] Broken until settings\_model pip package is fixed. Removed deprecated features for v12. Using settings\_models in SettingsProvider
 
 v11.1.1
 -------
@@ -159,11 +169,6 @@ v11.1.0
 -------
 
 * csv export library, databox upload and schedule library tips
-
-v11.1.0.rc5
------------
-
-* again no language set in testing
 * removed mock rpcs from schema
 
 v11.0.3
@@ -204,14 +209,3 @@ v10.0.2
 -------
 
 * touching a filer, since the tag's job is skipped because the commit mentioned 'sk\_ip ci'
-
-v10.0.2.rc2
------------
-
-* added more documentation [skip ci]
-* fixes an issue in the multiprocessing\_logging package in testcases
-
-v10.0.2.rc1
------------
-
-* Refactor for backend class for controller v2

{openmodule_test-13.5.0 → openmodule_test-14.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openmodule_test
-Version: 13.5.0
+Version: 14.0.0
 Summary: Libraries for testing openmodule services
 Home-page: https://gitlab.com/arivo-public/device-python/openmodule.git
 Author: ARIVO

{openmodule_test-13.5.0 → openmodule_test-14.0.0}/interrupt.py

@@ -4,7 +4,6 @@ import queue
 import sys
 import time
 import traceback
-import warnings
 from multiprocessing import Process, Event
 from signal import SIGINT, SIGKILL
 from textwrap import dedent

{openmodule_test-13.5.0 → openmodule_test-14.0.0}/openmodule_test.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openmodule-test
-Version: 13.5.0
+Version: 14.0.0
 Summary: Libraries for testing openmodule services
 Home-page: https://gitlab.com/arivo-public/device-python/openmodule.git
 Author: ARIVO

{openmodule_test-13.5.0 → openmodule_test-14.0.0}/openmodule_test.egg-info/SOURCES.txt

@@ -17,6 +17,7 @@ setup.py
 ./package_reader.py
 ./presence.py
 ./rpc.py
+./sentry.py
 ./settings.py
 ./utils.py
 ./zeromq.py

openmodule_test-14.0.0/openmodule_test.egg-info/pbr.json

@@ -0,0 +1 @@
+{"git_version": "bdd61c9", "is_release": true}

{openmodule_test-13.5.0 → openmodule_test-14.0.0}/openmodule_test.egg-info/requires.txt

@@ -1,3 +1,2 @@
 multiprocessing_logging
-fakeredis==1.7.6
 freezegun

{openmodule_test-13.5.0 → openmodule_test-14.0.0}/requirements.txt

@@ -1,3 +1,2 @@
 multiprocessing_logging
-fakeredis==1.7.6
 freezegun

openmodule_test-14.0.0/sentry.py

@@ -0,0 +1,65 @@
+from typing import List
+from unittest import TestCase, mock
+
+import sentry_sdk
+from sentry_sdk.envelope import Envelope
+
+from openmodule import sentry
+from openmodule_test.utils import wait_for_value
+
+
+class SentryTestTransport(sentry_sdk.transport.Transport):
+    """
+    Custom transport for testing that stores envelopes in a list.
+    """
+
+    def __init__(self, options=None):
+        super().__init__(options)
+        self.envelopes: List[Envelope] = []
+
+    def capture_envelope(self, envelope: Envelope):
+        self.envelopes.append(envelope)
+
+    def get_envelopes(self, clear: bool = True) -> List[Envelope]:
+        envelopes = self.envelopes
+        if clear:
+            self.envelopes = []
+        return envelopes
+
+
+class SentryTestMixin(TestCase):
+    """
+    Test mixin for testing with sentry. It patches the sentry transport to store envelopes in a list.
+    Provides the get_sent_envelopes method to get the stored envelopes.
+    """
+    _sentry_transport_patch: mock._patch
+
+    @classmethod
+    def setUpClass(cls) -> None:
+        cls._sentry_transport_patch = mock.patch("openmodule.sentry.StoringTransport", SentryTestTransport)
+        cls._sentry_transport_patch.start()
+        super().setUpClass()
+
+    def tearDown(self) -> None:
+        super().tearDown()
+        sentry.deinit_sentry()
+
+    @classmethod
+    def tearDownClass(cls) -> None:
+        super().tearDownClass()
+        cls._sentry_transport_patch.stop()
+
+    @property
+    def sentry_transport(self) -> SentryTestTransport:
+        transport = sentry_sdk.get_global_scope().client.transport
+        self.assertIsInstance(transport, SentryTestTransport)
+        return transport
+
+    def _get_envelopes(self) -> List[Envelope]:
+        return self.sentry_transport.envelopes
+
+    def get_sent_envelopes(self, timeout: float = 0, clear: bool = True) -> List[Envelope]:
+        envelopes = wait_for_value(self._get_envelopes, target=[], invert_target=True, timeout=timeout)
+        if clear:
+            self.sentry_transport.envelopes = []
+        return envelopes

openmodule_test-14.0.0/utils.py

@@ -0,0 +1,36 @@
+import time
+from typing import Optional, Callable, TypeVar
+
+T = TypeVar("T")
+NoTarget = object()
+
+
+class DeveloperError(Exception):
+    """
+    An exception which indicates a developer error. This is used instead of assertions in testcases because if
+    one were to check for AssertionErrors and an assertion is raised not because of a tested condition, but
+    because the test-utils were used incorrectly, then there is no way to distinguish between those.
+
+    Use only in testcases, use normal assertions for service code. you can still use assertions in
+    setUp(), tearDown(), setUpClass(), tearDownClass() code, because nobody would catch assertions there
+    """
+
+
+def wait_for_value(getter: Callable[[], Optional[T]], target: Optional[T] = NoTarget, invert_target: bool = False,
+                   timeout: float = 3, sleep_time: float = 0.01) -> T:
+    """
+    Waits until the getter returns the target value or the target value.
+    If no target is specified, waits until the getter returns a value different from the first value it returned.
+        WARNING: your code might be fast enough that the first value is already the 'changed' value, in that case
+            this function will wait for the timeout. If you want to avoid this, specify a target.
+    If invert_target is True, waits until the getter returns a value different from the target value.
+    """
+    start = current = getter()
+    end_time = time.time() + timeout
+    while (target is NoTarget and current == start) or (
+            target is not NoTarget and (current == target) == invert_target):
+        time.sleep(sleep_time)
+        current = getter()
+        if time.time() > end_time:
+            raise TimeoutError(f"Timeout waiting for value {target}. Current value: {current}")
+    return current

openmodule_test-13.5.0/openmodule_test.egg-info/pbr.json

@@ -1 +0,0 @@
-{"git_version": "84be0cd", "is_release": true}

openmodule_test-13.5.0/utils.py

@@ -1,9 +0,0 @@
-class DeveloperError(Exception):
-    """
-    An exception which indicates a developer error. This is used instead of assertions in testcases because if
-    one were to check for AssertionErrors and an assertion is raised not because of a tested condition, but
-    because the test-utils were used incorrectly, then there is no way to distinguish between those.
-
-    Use only in testcases, use normal assertions for service code. you can still use assertions in
-    setUp(), tearDown(), setUpClass(), tearDownClass() code, because nobody would catch assertions there
-    """