tests: add function to wait while condition holds

This adds a new utils function that is a slight generalisation
of `wait_for` with an additional condition that must always be
met while waiting.

`wait_for` now calls this new function with the condition being
one that is always true.

Author: jp1ac4

tests/test_framework/utils.py

@@ -35,9 +35,19 @@ def wait_for(success, timeout=TIMEOUT, debug_fn=None):
     debug_fn is logged at each call to success, it can be useful for debugging
     when tests fail.
     """
+    wait_for_while_condition_holds(success, lambda: True, timeout, debug_fn)
+
+
+def wait_for_while_condition_holds(success, condition, timeout=TIMEOUT, debug_fn=None):
+    """
+    Run success() either until it returns True, or until the timeout is reached,
+    as long as condition() holds.
+    debug_fn is logged at each call to success, it can be useful for debugging
+    when tests fail.
+    """
     start_time = time.time()
     interval = 0.25
-    while not success() and time.time() < start_time + timeout:
+    while not success() and condition() and time.time() < start_time + timeout:
         if debug_fn is not None:
             logging.info(debug_fn())
         time.sleep(interval)
@@ -46,6 +56,10 @@ def wait_for(success, timeout=TIMEOUT, debug_fn=None):
             interval = 5
     if time.time() > start_time + timeout:
         raise ValueError("Error waiting for {}", success)
+    if not condition():
+        raise ValueError(
+            "Condition {} not met while waiting for {}", condition, success
+        )
 
 
 def get_txid(hex_tx):