Merge pull request #3620 from mulkieran/use-retry

Use tenacity for retries in Python tests

Author: mulkieran

.github/workflows/support.yml

@@ -46,6 +46,7 @@ jobs:
               python3-psutil
               python3-pyudev
               python3-semantic_version
+              python3-tenacity
             task: PYTHONPATH=./src make -f Makefile lint
             working-directory: ./tests/client-dbus
           - dependencies: black python3-isort

.github/workflows/weekly.yml

@@ -24,6 +24,7 @@ jobs:
               python3-psutil
               python3-pyudev
               python3-semantic_version
+              python3-tenacity
             task: PYTHONPATH=./src make -f Makefile lint
             working-directory: ./tests/client-dbus
           - dependencies: black python3-isort

tests-fmf/python.fmf

@@ -10,6 +10,7 @@ require:
   - python3-dbus-python-client-gen
   - python3-psutil
   - python3-pyudev
+  - python3-tenacity
 
 environment:
   TANG_URL: localhost

tests/client-dbus/tests/udev/_utils.py

@@ -31,6 +31,7 @@
 import dbus
 import psutil
 import pyudev
+from tenacity import Retrying, retry_if_exception_type, stop_after_delay, wait_fixed
 
 # isort: LOCAL
 from stratisd_client_dbus import (
@@ -341,27 +342,24 @@ def start_service(self):
             text=True,
         )
 
-        dbus_interface_present = False
-        limit = time.time() + 120.0
-        while (
-            time.time() <= limit
-            and not dbus_interface_present
-            and service.poll() is None
-        ):
-            try:
-                get_object(TOP_OBJECT)
-                dbus_interface_present = True
-            except dbus.exceptions.DBusException:
-                time.sleep(0.5)
+        try:
+            for attempt in Retrying(
+                retry=(retry_if_exception_type(dbus.exceptions.DBusException)),
+                stop=stop_after_delay(120),
+                wait=wait_fixed(0.5),
+                reraise=True,
+            ):
+                if service.poll() is not None:
+                    raise RuntimeError(
+                        f"Daemon unexpectedly exited with exit code {service.returncode}"
+                    )
 
-        time.sleep(1)
-        if service.poll() is not None:
+                with attempt:
+                    get_object(TOP_OBJECT)
+        except dbus.exceptions.DBusException as err:
             raise RuntimeError(
-                f"Daemon unexpectedly exited with exit code {service.returncode}"
-            )
-
-        if not dbus_interface_present:
-            raise RuntimeError("No D-Bus interface for stratisd found")
+                "No D-Bus interface for stratisd found although stratisd appears to be running"
+            ) from err
 
         self._service = service  # pylint: disable=attribute-defined-outside-init
         return self