athenad: test connection timeout (#28864)

old-commit-hash: 915aec3f5c2a9321866ee79a69b59534c29234b9

selfdrive/athena/athenad.py

@@ -137,7 +137,7 @@ class UploadQueueCache:
       cloudlog.exception("athena.UploadQueueCache.cache.exception")
 
 
-def handle_long_poll(ws: WebSocket) -> None:
+def handle_long_poll(ws: WebSocket, exit_event: Optional[threading.Event]) -> None:
   end_event = threading.Event()
 
   threads = [
@@ -156,6 +156,8 @@ def handle_long_poll(ws: WebSocket) -> None:
   try:
     while not end_event.is_set():
       time.sleep(0.1)
+      if exit_event is not None and exit_event.is_set():
+        end_event.set()
   except (KeyboardInterrupt, SystemExit):
     end_event.set()
     raise
@@ -758,7 +760,7 @@ def backoff(retries: int) -> int:
   return random.randrange(0, min(128, int(2 ** retries)))
 
 
-def main():
+def main(exit_event: Optional[threading.Event] = None):
   try:
     set_core_affinity([0, 1, 2, 3])
   except Exception:
@@ -773,7 +775,7 @@ def main():
 
   conn_start = None
   conn_retries = 0
-  while 1:
+  while exit_event is None or not exit_event.is_set():
     try:
       if conn_start is None:
         conn_start = time.monotonic()
@@ -790,7 +792,7 @@ def main():
       conn_retries = 0
       cur_upload_items.clear()
 
-      handle_long_poll(ws)
+      handle_long_poll(ws, exit_event)
     except (KeyboardInterrupt, SystemExit):
       break
     except (ConnectionError, TimeoutError, WebSocketException):

selfdrive/athena/tests/test_athenad_ping.py

@@ -0,0 +1,102 @@
+#!/usr/bin/env python3
+import subprocess
+import threading
+import time
+import unittest
+from typing import Callable, cast, Optional
+from unittest.mock import MagicMock
+
+from common.params import Params
+from common.timeout import Timeout
+from selfdrive.athena import athenad
+from system.hardware import TICI
+
+
+def wifi_radio(on: bool) -> None:
+  if not TICI:
+    return
+  print(f"wifi {'on' if on else 'off'}")
+  subprocess.run(["nmcli", "radio", "wifi", "on" if on else "off"], check=True)
+
+
+class TestAthenadPing(unittest.TestCase):
+  params: Params
+  dongle_id: str
+
+  athenad: threading.Thread
+  exit_event: threading.Event
+
+  _create_connection: Callable
+
+  def _get_ping_time(self) -> Optional[str]:
+    return cast(Optional[str], self.params.get("LastAthenaPingTime", encoding="utf-8"))
+
+  def _clear_ping_time(self) -> None:
+    self.params.remove("LastAthenaPingTime")
+
+  def _received_ping(self) -> bool:
+    return self._get_ping_time() is not None
+
+  @classmethod
+  def setUpClass(cls) -> None:
+    cls.params = Params()
+    cls.dongle_id = cls.params.get("DongleId", encoding="utf-8")
+    cls._create_connection = athenad.create_connection
+    athenad.create_connection = MagicMock(wraps=cls._create_connection)
+
+  @classmethod
+  def tearDownClass(cls) -> None:
+    wifi_radio(True)
+    athenad.create_connection = cls._create_connection
+
+  def setUp(self) -> None:
+    wifi_radio(True)
+    self._clear_ping_time()
+
+    self.exit_event = threading.Event()
+    self.athenad = threading.Thread(target=athenad.main, args=(self.exit_event,))
+
+    athenad.create_connection.reset_mock()
+
+  def tearDown(self) -> None:
+    if self.athenad.is_alive():
+      self.exit_event.set()
+      self.athenad.join()
+
+  @unittest.skipIf(not TICI, "only run on desk")
+  def test_timeout(self) -> None:
+    self.athenad.start()
+
+    time.sleep(1)
+    athenad.create_connection.assert_called_once()
+    athenad.create_connection.reset_mock()
+
+    # check normal behaviour
+    with self.subTest("Wi-Fi: receives ping"), Timeout(70, "no ping received"):
+      while not self._received_ping():
+        time.sleep(0.1)
+      print("ping received")
+
+    athenad.create_connection.assert_not_called()
+
+    # websocket should attempt reconnect after short time
+    with self.subTest("LTE: attempt reconnect"):
+      wifi_radio(False)
+      print("waiting for reconnect attempt")
+      start_time = time.monotonic()
+      with Timeout(180, "no reconnect attempt"):
+        while not athenad.create_connection.called:
+          time.sleep(0.1)
+        print(f"reconnect attempt after {time.monotonic() - start_time:.2f}s")
+
+    self._clear_ping_time()
+
+    # check ping received after reconnect
+    with self.subTest("LTE: receives ping"), Timeout(70, "no ping received"):
+      while not self._received_ping():
+        time.sleep(0.1)
+      print("ping received")
+
+
+if __name__ == "__main__":
+  unittest.main()