From e56d95fdd454c497f530d09fd040a383495d2fb8 Mon Sep 17 00:00:00 2001
From: deathaxe <deathaxe82@googlemail.com>
Date: Sun, 2 Jun 2024 17:52:18 +0200
Subject: [PATCH] Add support for condition timeout message

---
 README.md                       | 43 ++++++++++++++++++++++++++++++---
 unittesting/core/py33/runner.py |  6 ++++-
 unittesting/core/py38/runner.py |  6 ++++-
 3 files changed, 50 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 62145b5c..47d69b88 100644
--- a/README.md
+++ b/README.md
@@ -378,8 +378,24 @@ the following
   the runner continues the generator, if not, the runner will wait until the
   condition is met with the default timeout of 4s. The result of the callable
   can be also retrieved from the `yield` statement. The yielded object could 
-  be also a dictionary of the form `{"condition": callable, timeout: timeout}` 
-  to specify timeout in ms.
+  also be a dictionary of the form 
+
+  ```py
+  {
+    # required condition callable
+    "condition": callable,
+    # system timestamp when to start condition checks (default: `time.time()`)
+    "start_time": timestamp,
+    # optional the interval to invoke `condition()` (default: 17)
+    "period": milliseconds,
+    # optional timeout to wait for condition to be met (default: value from unittesting.json or 4000)
+    "timeout": milliseconds,
+    # optional message to print, if condition is not met within timeout
+    "timeout_message": "Condition not fulfilled"
+  }
+  ```
+
+  to specify various overrides such as poll interval or timeout in ms.
 
 - if the yielded object is an integer, say `x`, then it will [continue][4] the
   generator after `x` ms.
@@ -397,7 +413,7 @@ from unittesting import DeferrableTestCase
 
 class TestCondition(DeferrableTestCase):
 
-    def test_condition(self):
+    def test_condition1(self):
         x = []
 
         def append():
@@ -411,6 +427,27 @@ class TestCondition(DeferrableTestCase):
         # wait until `condition()` is true
         yield condition
 
+        self.assertEqual(x[0], 1)
+
+    def test_condition2(self):
+        x = []
+
+        def append():
+            x.append(1)
+
+        def condition():
+            return len(x) == 1
+
+        sublime.set_timeout(append, 100)
+
+        # wait until `condition()` is true
+        yield {
+          "condition": condition,
+          "period": 200,
+          "timeout": 5000,
+          "timeout_message": "Not enough items added to x"
+        }
+
         self.assertEqual(x[0], 1)
 ```
 
diff --git a/unittesting/core/py33/runner.py b/unittesting/core/py33/runner.py
index 88aba103..701de101 100644
--- a/unittesting/core/py33/runner.py
+++ b/unittesting/core/py33/runner.py
@@ -108,6 +108,7 @@ def _wait_condition(
             period=DEFAULT_CONDITION_POLL_TIME,
             timeout=self.condition_timeout,
             start_time=None,
+            timeout_message=None
         ):
             if start_time is None:
                 start_time = time.time()
@@ -121,8 +122,11 @@ def _wait_condition(
             if send_value:
                 _continue_testing(deferred, send_value=send_value)
             elif (time.time() - start_time) * 1000 >= timeout:
+                if timeout_message is None:
+                    timeout_message = "Condition not fulfilled"
                 error = TimeoutError(
-                    "Condition not fulfilled within {:.2f} seconds".format(
+                    "{} within {:.2f} seconds".format(
+                        timeout_message,
                         timeout / 1000
                     )
                 )
diff --git a/unittesting/core/py38/runner.py b/unittesting/core/py38/runner.py
index 517e76cd..eb52bcb6 100644
--- a/unittesting/core/py38/runner.py
+++ b/unittesting/core/py38/runner.py
@@ -117,6 +117,7 @@ def _wait_condition(
             period=DEFAULT_CONDITION_POLL_TIME,
             timeout=self.condition_timeout,
             start_time=None,
+            timeout_message=None
         ):
             if start_time is None:
                 start_time = time.time()
@@ -130,8 +131,11 @@ def _wait_condition(
             if send_value:
                 _continue_testing(deferred, send_value=send_value)
             elif (time.time() - start_time) * 1000 >= timeout:
+                if timeout_message is None:
+                    timeout_message = "Condition not fulfilled"
                 error = TimeoutError(
-                    "Condition not fulfilled within {:.2f} seconds".format(
+                    "{} within {:.2f} seconds".format(
+                        timeout_message,
                         timeout / 1000
                     )
                 )