mirror of
https://github.com/zulip/zulip.git
synced 2025-10-31 20:13:46 +00:00
72018cc26b
This timeout strategy using asynchronous exceptions has a number of safety caveats (read the docstring!!) and should only be used in very specific circumstances. Signed-off-by: Anders Kaseorg <anders@zulip.com>
57 lines
2.2 KiB
Python
57 lines
2.2 KiB
Python
import sys
|
|
import time
|
|
import traceback
|
|
from unittest import skipIf
|
|
|
|
from zerver.lib.test_classes import ZulipTestCase
|
|
from zerver.lib.timeout import TimeoutExpiredError, unsafe_timeout
|
|
|
|
|
|
class TimeoutTestCase(ZulipTestCase):
|
|
# We can't use assertRaises because that doesn't store the
|
|
# traceback, which we want to verify
|
|
|
|
def something_exceptional(self) -> int:
|
|
raise ValueError("Something went wrong")
|
|
|
|
def sleep_x_seconds_y_times(self, x: float, y: int) -> int:
|
|
for i in range(y):
|
|
time.sleep(x)
|
|
return 42 # nocoverage
|
|
|
|
def test_timeout_returns(self) -> None:
|
|
ret = unsafe_timeout(1, lambda: 42)
|
|
self.assertEqual(ret, 42)
|
|
|
|
def test_timeout_exceeded(self) -> None:
|
|
try:
|
|
unsafe_timeout(1, lambda: self.sleep_x_seconds_y_times(0.1, 50))
|
|
raise AssertionError("Failed to raise a timeout")
|
|
except TimeoutExpiredError as exc:
|
|
tb = traceback.format_tb(exc.__traceback__)
|
|
self.assertIn("in sleep_x_seconds_y_times", tb[-1])
|
|
self.assertIn("time.sleep(x)", tb[-1])
|
|
|
|
def test_timeout_raises(self) -> None:
|
|
try:
|
|
unsafe_timeout(1, self.something_exceptional)
|
|
raise AssertionError("Failed to raise an exception")
|
|
except ValueError as exc:
|
|
tb = traceback.format_tb(exc.__traceback__)
|
|
self.assertIn("in something_exceptional", tb[-1])
|
|
self.assertIn("raise ValueError", tb[-1])
|
|
|
|
@skipIf(sys.version_info >= (3, 11), "https://github.com/nedbat/coveragepy/issues/1626")
|
|
def test_timeout_warn(self) -> None:
|
|
# If the sleep is long enough, it will outlast the attempts to
|
|
# kill it
|
|
with self.assertLogs(level="WARNING") as m:
|
|
try:
|
|
unsafe_timeout(1, lambda: self.sleep_x_seconds_y_times(5, 1))
|
|
raise AssertionError("Failed to raise a timeout")
|
|
except TimeoutExpiredError as exc:
|
|
tb = traceback.format_tb(exc.__traceback__)
|
|
self.assertNotIn("in sleep_x_seconds_y_times", tb[-1])
|
|
self.assertIn("raise TimeoutExpiredError", tb[-1])
|
|
self.assertEqual(m.output, ["WARNING:root:Failed to time out backend thread"])
|