testscript: raise exceptions in wait_until_*() helper

Better to get more context when things fail and prevent assert clutter.

On-behalf-of: SAP philipp.schuster@sap.com
Signed-off-by: Philipp Schuster <philipp.schuster@cyberus-technology.de>

Author: phip1611

tests/testscript.py

@@ -818,22 +818,22 @@ def is_shutoff():
                 controllerVM.execute('virsh domstate testvm | grep "shut off"')[0] == 0
             )
 
-        assert wait_until_succeed(is_shutoff)
+        wait_until_succeed(is_shutoff)
 
         controllerVM.fail("find /run/libvirt/ch -name *.xml | grep .")
 
         controllerVM.succeed("virsh start testvm")
         wait_for_ssh(controllerVM)
 
         controllerVM.succeed("virsh shutdown testvm")
-        assert wait_until_succeed(is_shutoff)
+        wait_until_succeed(is_shutoff)
         controllerVM.fail("find /run/libvirt/ch -name *.xml | grep .")
 
         controllerVM.succeed("virsh start testvm")
         wait_for_ssh(controllerVM)
 
         controllerVM.succeed("virsh destroy testvm")
-        assert wait_until_succeed(is_shutoff)
+        wait_until_succeed(is_shutoff)
         controllerVM.fail("find /run/libvirt/ch -name *.xml | grep .")
 
     def test_libvirt_event_stop_failed(self):
@@ -942,7 +942,7 @@ def prompt():
             )
             return status == 0
 
-        assert wait_until_succeed(prompt)
+        wait_until_succeed(prompt)
 
         controllerVM.succeed(
             textwrap.dedent("""
@@ -1055,7 +1055,7 @@ def migration_finished():
             status, _ = controllerVM.execute("screen -ls | grep migrate")
             return status != 0
 
-        self.assertTrue(wait_until_succeed(migration_finished))
+        wait_until_succeed(migration_finished)
 
         computeVM.succeed("virsh list | grep testvm | grep running")
 
@@ -1353,11 +1353,8 @@ def check_virsh_list(vm):
             status, _ = vm.execute("virsh list | grep testvm > /dev/null")
             return status == 0
 
-        status = wait_until_fail(lambda: check_virsh_list(controllerVM))
-        assert status
-
-        status = wait_until_fail(lambda: check_virsh_list(computeVM))
-        assert status
+        wait_until_fail(lambda: check_virsh_list(controllerVM))
+        wait_until_fail(lambda: check_virsh_list(computeVM))
 
     def test_live_migration_kill_chv_on_receiver_side(self):
         """
@@ -1391,11 +1388,9 @@ def check_virsh_list(vm):
             status, _ = vm.execute("virsh list | grep testvm > /dev/null")
             return status == 0
 
-        status = wait_until_fail(lambda: check_virsh_list(computeVM))
-        assert status
+        wait_until_fail(lambda: check_virsh_list(computeVM))
 
-        status = wait_until_succeed(lambda: check_virsh_list(controllerVM))
-        assert status
+        wait_until_succeed(lambda: check_virsh_list(controllerVM))
 
         controllerVM.succeed("virsh list | grep 'running'")
 
@@ -1944,29 +1939,34 @@ def measure_ms(func):
     return (time.time() - start) * 1000
 
 
-def wait_until_succeed(func, retries=600) -> bool:
+def wait_until_succeed(func, retries=600):
     """
     Waits for the command to succeed.
     After each failure, it waits 100ms.
 
     :param func: Function that is expected to succeed.
     :param retries: Amount of retries.
-    :return: whether the function succeeded eventually
     """
     for _i in range(retries):
         if func():
-            return True
+            return
         time.sleep(0.1)
-    return False
+    raise RuntimeError("function didn't succeed")
+
 
+def wait_until_fail(func, retries=600):
+    """
+    Waits for the command to succeed.
+    After each failure, it waits 100ms.
 
-def wait_until_fail(func):
-    retries = 600
+    :param func: Function that is expected to succeed.
+    :param retries: Amount of retries.
+    """
     for i in range(retries):
         if not func():
-            return True
+            return
         time.sleep(0.1)
-    return False
+    raise RuntimeError("function didn't fail")
 
 
 def wait_for_ssh(machine: Machine, user="root", password="root", ip="192.168.1.2"):
@@ -2160,10 +2160,7 @@ def wait_for_guest_pci_device_enumeration(machine: Machine, new_count: int):
     :return:
     """
     # retries=20 => max 2s => we expect hotplug events to be relatively quick
-    if not wait_until_succeed(lambda: number_of_devices(machine) == new_count, 20):
-        raise RuntimeError(
-            f"guest did acknowledge PCI hotplug event: should be {new_count} but is {number_of_devices(machine)}"
-        )
+    wait_until_succeed(lambda: number_of_devices(machine) == new_count, 20)
 
 
 runner = unittest.TextTestRunner()