Timeout support in WebSocketTestSession #2195
-
|
Hi! I'm trying to test a WebSocket endpoint with One thing I've noticed is that starlette/starlette/testclient.py Lines 145 to 146 in 2168e47 starlette/starlette/testclient.py Lines 165 to 166 in 2168e47 This, unfortunately, makes the unit tests hang infinitely if the app under test does not behave properly. Would adding and passing the |
Beta Was this translation helpful? Give feedback.
Replies: 2 comments 7 replies
-
|
I'd really like a timeout option when testing websockets, so i created #2329 as potential fix. |
Beta Was this translation helpful? Give feedback.
-
|
I'd recommend you use pure-ASGI when you want to test timeouts. Or connect over a socket and use a real |
Beta Was this translation helpful? Give feedback.
-
|
That's fair but you can use a pytest extension that just generally fails if a test takes more than X seconds. Maybe not as precise as you want w.r.t to where exactly the failure occurred but it will also protect you against other reasons a SUT might just hang / run forever and should be enough for you to go and look at logs or investigate locally in more detail. |
Beta Was this translation helpful? Give feedback.
-
|
That's how i'm currently working around having no timeout option on the In addition, some of my tests have longer sections unrelated to the websocket itself, so i have to account for them in the generic timeout and that is rather high. That means when it's actually the websocket thats blocking and running into the timeout, the tests waits for way longer than it needs to (e.g. whole test needs timeouts of >60s, whereas for most websocket receives i could already timeout after 1 second). |
Beta Was this translation helpful? Give feedback.
-
|
The objection to add such a trivial request is not clear. especially when the fix is so simple and straight forward since queues are supporting timeout. |
Beta Was this translation helpful? Give feedback.
-
|
Bump. My use case is:
If no message is sent, my test suite hangs permanently on |
Beta Was this translation helpful? Give feedback.
-
|
@JohnScolaro I haven't tested this thoroughly, its excessive and it would be nice to have this sort of functionality in the library itself - but from initial tests it seems to work fine: receive_task = asyncio.create_task(websocket.receive_json())
done, _ = await asyncio.wait([receive_task], timeout=60)
if receive_task in done:
data = receive_task.result()
else:
receive_task.cancel()
await websocket.close()
return |
Beta Was this translation helpful? Give feedback.
I'd recommend you use pure-ASGI when you want to test timeouts. Or connect over a socket and use a real
httpxinstance, it will help make sure your catching the right errors.