From 41838070c66c9b275b8f68a7d6ed27bf02bab301 Mon Sep 17 00:00:00 2001 From: C Freeman Date: Wed, 3 Nov 2021 13:23:42 -0400 Subject: [PATCH] Address request from #10771 - add timeouts to thread join in test (#11297) * Address request from #10771 There was a request to add a timeout to the join in #10771. The thread itself is unlikely to hang - more likely situation here is the subscription failing to cause updates, causing the main thread to hang forever on the condition variable. Added time outs to both so we can have a bit more information about what actually happened when the test completes. * Restyled by autopep8 Co-authored-by: Restyled.io --- .../python/test/test_scripts/base.py | 20 +++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/src/controller/python/test/test_scripts/base.py b/src/controller/python/test/test_scripts/base.py index 1c824d2457983a..b7fa7f9fefb230 100644 --- a/src/controller/python/test/test_scripts/base.py +++ b/src/controller/python/test/test_scripts/base.py @@ -370,10 +370,22 @@ def run(self): changeThread.start() with handler.cv: while handler.subscriptionReceived < 5: - # We should observe 10 attribute changes - handler.cv.wait() - changeThread.join() - return True + # We should observe 5 attribute changes + # The changing thread will change the value after 3 seconds. If we're waiting more than 10, assume something + # is really wrong and bail out here with some information. + if not handler.cv.wait(10.0): + self.logger.error( + f"Failed to receive subscription update") + break + + # thread changes 5 times, and sleeps for 3 seconds in between. Add an additional 3 seconds of slack. Timeout is in seconds. + changeThread.join(18.0) + if changeThread.is_alive(): + # Thread join timed out + self.logger.error(f"Failed to join change thread") + return False + return True if handler.subscriptionReceived == 5 else False + except Exception as ex: self.logger.exception(f"Failed to finish API test: {ex}") return False