test_debug_ita_monitor.py 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370
  1. import ast
  2. import io
  3. import subprocess
  4. import sys
  5. import unittest
  6. from contextlib import redirect_stderr, redirect_stdout
  7. from pathlib import Path
  8. from unittest.mock import Mock, patch
  9. from tools.debug_ita_monitor import (
  10. DEFAULT_MAX_PROBES,
  11. DEFAULT_MAX_WAIT_SECONDS,
  12. MIN_SAFE_WAIT_SECONDS,
  13. run_monitor,
  14. )
  15. from tools.debug_ita_session import DebugConfigurationError
  16. from vs_types import AvailabilityStatus, VSQueryResult
  17. class FakeMonitorPage:
  18. def __init__(self):
  19. self.url = "https://prenotami.esteri.it/Services"
  20. self.form_structure = None
  21. def ele(self, _selector, timeout=None):
  22. del timeout
  23. return None
  24. def run_js(self, _script):
  25. return self.form_structure
  26. class FakeMonitorPlugin:
  27. sequence = ["none"]
  28. last_instance = None
  29. def __init__(self, group_id):
  30. self.group_id = group_id
  31. self.page = FakeMonitorPage()
  32. self.create_session_calls = 0
  33. self.query_calls = 0
  34. self.cleanup_calls = 0
  35. FakeMonitorPlugin.last_instance = self
  36. def set_log(self, logger):
  37. self.logger = logger
  38. def set_config(self, config):
  39. self.config = config
  40. def create_session(self):
  41. self.create_session_calls += 1
  42. def query(self, apt_type):
  43. behavior = self.sequence[min(self.query_calls, len(self.sequence) - 1)]
  44. self.query_calls += 1
  45. if behavior == "weak":
  46. self.page.form_structure = {
  47. "path": "/Services/Booking/1321",
  48. "form": {
  49. "method": "POST",
  50. "action_path": "/Services/Booking/1321",
  51. "secret": "must-not-appear",
  52. },
  53. "fields": [
  54. {
  55. "tag": "input",
  56. "type": "hidden",
  57. "id": "RequestToken",
  58. "name": "__RequestVerificationToken",
  59. "required": False,
  60. "value": "private@example.test",
  61. }
  62. ],
  63. "buttons": [],
  64. }
  65. return VSQueryResult(
  66. success=True,
  67. apt_type=apt_type,
  68. availability_status=AvailabilityStatus.NoneAvailable,
  69. )
  70. if behavior == "unexpected":
  71. return VSQueryResult(
  72. success=True,
  73. apt_type=apt_type,
  74. availability_status=AvailabilityStatus.Available,
  75. )
  76. if behavior == "error":
  77. raise RuntimeError(
  78. "private@example.test failed with token "
  79. "abcdefghijklmnopqrstuvwxyz123456"
  80. )
  81. return VSQueryResult(
  82. success=False,
  83. apt_type=apt_type,
  84. availability_status=AvailabilityStatus.NoneAvailable,
  85. )
  86. def cleanup(self):
  87. self.cleanup_calls += 1
  88. class DebugItaMonitorTests(unittest.TestCase):
  89. def setUp(self):
  90. FakeMonitorPlugin.sequence = ["none"]
  91. FakeMonitorPlugin.last_instance = None
  92. @staticmethod
  93. def _run(
  94. *,
  95. apply=True,
  96. max_probes=3,
  97. randint=lambda _minimum, _maximum: 60,
  98. sleep=lambda _seconds: None,
  99. ):
  100. stdout = io.StringIO()
  101. stderr = io.StringIO()
  102. with (
  103. patch(
  104. "tools.debug_ita_monitor.resolve_chrome_path",
  105. return_value=Path("/test/chrome"),
  106. ),
  107. patch(
  108. "tools.debug_ita_monitor._get_query_credentials",
  109. return_value=("offline@example.test", "offline-password"),
  110. ) as credential_reader,
  111. patch(
  112. "tools.debug_ita_monitor._prepare_query_profile",
  113. return_value=Path("/offline/ita-query-profile"),
  114. ) as profile_preparer,
  115. patch(
  116. "tools.debug_ita_monitor._bind_query_profile",
  117. return_value=Mock(),
  118. ),
  119. patch("tools.debug_ita_monitor.ItaPlugin", FakeMonitorPlugin),
  120. patch.dict("tools.debug_ita_monitor.os.environ", {}, clear=False),
  121. redirect_stdout(stdout),
  122. redirect_stderr(stderr),
  123. ):
  124. exit_code = run_monitor(
  125. {},
  126. apply=apply,
  127. non_interactive=True,
  128. min_wait=MIN_SAFE_WAIT_SECONDS,
  129. max_wait=DEFAULT_MAX_WAIT_SECONDS,
  130. max_probes=max_probes,
  131. randint=randint,
  132. sleep=sleep,
  133. )
  134. return (
  135. exit_code,
  136. stdout.getvalue(),
  137. stderr.getvalue(),
  138. credential_reader,
  139. profile_preparer,
  140. )
  141. def test_default_preflight_requires_no_credentials_or_plugin(self):
  142. exit_code, stdout, stderr, credential_reader, profile_preparer = self._run(
  143. apply=False
  144. )
  145. self.assertEqual(exit_code, 0)
  146. credential_reader.assert_not_called()
  147. profile_preparer.assert_not_called()
  148. self.assertIsNone(FakeMonitorPlugin.last_instance)
  149. self.assertIn("ITA_MONITOR_PREFLIGHT_OK", stdout)
  150. self.assertIn("external_request=false", stdout)
  151. self.assertEqual(stderr, "")
  152. def test_no_slot_monitor_reuses_one_session_and_stops_at_max_probes(self):
  153. FakeMonitorPlugin.sequence = ["none", "none", "none"]
  154. waits = []
  155. random_values = iter([60, 300])
  156. exit_code, stdout, stderr, _, _ = self._run(
  157. max_probes=3,
  158. randint=lambda _minimum, _maximum: next(random_values),
  159. sleep=waits.append,
  160. )
  161. plugin = FakeMonitorPlugin.last_instance
  162. self.assertEqual(exit_code, 0)
  163. self.assertEqual(plugin.create_session_calls, 1)
  164. self.assertEqual(plugin.query_calls, 3)
  165. self.assertEqual(plugin.cleanup_calls, 1)
  166. self.assertEqual(waits, [60, 300])
  167. self.assertIn("probe=3", stdout)
  168. self.assertIn("ITA_MONITOR_MAX_PROBES_REACHED", stdout)
  169. self.assertEqual(stderr, "")
  170. def test_weak_signal_stops_immediately_and_prints_sanitized_alert(self):
  171. FakeMonitorPlugin.sequence = ["none", "weak", "none"]
  172. waits = []
  173. exit_code, stdout, stderr, _, _ = self._run(
  174. max_probes=3,
  175. sleep=waits.append,
  176. )
  177. plugin = FakeMonitorPlugin.last_instance
  178. self.assertEqual(exit_code, 4)
  179. self.assertEqual(plugin.create_session_calls, 1)
  180. self.assertEqual(plugin.query_calls, 2)
  181. self.assertEqual(plugin.cleanup_calls, 1)
  182. self.assertEqual(waits, [60])
  183. self.assertIn("\aITA_MONITOR_WEAK_SIGNAL", stdout)
  184. self.assertIn("action=start-user-book-recheck-now", stdout)
  185. self.assertIn("ITA_BOOKING_FORM_STRUCTURE=", stdout)
  186. self.assertNotIn("private@example.test", stdout)
  187. self.assertNotIn("must-not-appear", stdout)
  188. self.assertEqual(stderr, "")
  189. def test_weak_signal_publishes_one_local_handoff_only_when_enabled(self):
  190. FakeMonitorPlugin.sequence = ["weak"]
  191. published = []
  192. stdout = io.StringIO()
  193. stderr = io.StringIO()
  194. with (
  195. patch(
  196. "tools.debug_ita_monitor.resolve_chrome_path",
  197. return_value=Path("/test/chrome"),
  198. ),
  199. patch(
  200. "tools.debug_ita_monitor._get_query_credentials",
  201. return_value=("offline@example.test", "offline-password"),
  202. ),
  203. patch(
  204. "tools.debug_ita_monitor._prepare_query_profile",
  205. return_value=Path("/offline/ita-query-profile"),
  206. ),
  207. patch(
  208. "tools.debug_ita_monitor._bind_query_profile",
  209. return_value=Mock(),
  210. ),
  211. patch("tools.debug_ita_monitor.ItaPlugin", FakeMonitorPlugin),
  212. patch.dict("tools.debug_ita_monitor.os.environ", {}, clear=False),
  213. redirect_stdout(stdout),
  214. redirect_stderr(stderr),
  215. ):
  216. exit_code = run_monitor(
  217. {},
  218. apply=True,
  219. non_interactive=True,
  220. min_wait=MIN_SAFE_WAIT_SECONDS,
  221. max_wait=DEFAULT_MAX_WAIT_SECONDS,
  222. max_probes=3,
  223. publish_local_signal=True,
  224. signal_publisher=lambda: published.append("weak"),
  225. )
  226. self.assertEqual(exit_code, 4)
  227. self.assertEqual(published, ["weak"])
  228. self.assertIn("ITA_MONITOR_HANDOFF_PUBLISHED", stdout.getvalue())
  229. self.assertEqual(stderr.getvalue(), "")
  230. def test_unexpected_result_stops_without_another_probe(self):
  231. FakeMonitorPlugin.sequence = ["unexpected", "none"]
  232. exit_code, stdout, _stderr, _, _ = self._run(max_probes=3)
  233. plugin = FakeMonitorPlugin.last_instance
  234. self.assertEqual(exit_code, 4)
  235. self.assertEqual(plugin.query_calls, 1)
  236. self.assertEqual(plugin.cleanup_calls, 1)
  237. self.assertIn("ITA_MONITOR_SAFE_STOP", stdout)
  238. def test_query_error_stops_without_retry_and_redacts_diagnostics(self):
  239. FakeMonitorPlugin.sequence = ["error", "none"]
  240. exit_code, stdout, stderr, _, _ = self._run(max_probes=3)
  241. plugin = FakeMonitorPlugin.last_instance
  242. self.assertEqual(exit_code, 1)
  243. self.assertEqual(plugin.query_calls, 1)
  244. self.assertEqual(plugin.cleanup_calls, 1)
  245. self.assertIn("ITA_MONITOR_FAILED type=RuntimeError", stdout)
  246. self.assertNotIn("private@example.test", stdout)
  247. self.assertNotIn("abcdefghijklmnopqrstuvwxyz123456", stdout)
  248. self.assertEqual(stderr, "")
  249. def test_ctrl_c_during_wait_cleans_up_without_traceback(self):
  250. def interrupted_sleep(_seconds):
  251. raise KeyboardInterrupt
  252. exit_code, stdout, stderr, _, _ = self._run(
  253. max_probes=3,
  254. sleep=interrupted_sleep,
  255. )
  256. plugin = FakeMonitorPlugin.last_instance
  257. self.assertEqual(exit_code, 130)
  258. self.assertEqual(plugin.query_calls, 1)
  259. self.assertEqual(plugin.cleanup_calls, 1)
  260. self.assertIn("ITA_MONITOR_CANCELLED", stdout)
  261. self.assertIn("ITA_MONITOR_CLEANUP_OK", stdout)
  262. self.assertNotIn("Traceback", stdout + stderr)
  263. def test_unsafe_limits_fail_before_credentials_or_plugin(self):
  264. with (
  265. patch(
  266. "tools.debug_ita_monitor._get_query_credentials",
  267. side_effect=AssertionError("credentials must not be read"),
  268. ),
  269. patch(
  270. "tools.debug_ita_monitor.ItaPlugin",
  271. side_effect=AssertionError("plugin must not be created"),
  272. ),
  273. self.assertRaises(DebugConfigurationError),
  274. ):
  275. run_monitor(
  276. {},
  277. apply=True,
  278. non_interactive=True,
  279. min_wait=59,
  280. max_wait=300,
  281. max_probes=1,
  282. )
  283. def test_cli_default_is_a_real_zero_network_preflight(self):
  284. repo_root = Path(__file__).resolve().parents[2]
  285. completed = subprocess.run(
  286. [sys.executable, str(repo_root / "tools" / "debug_ita_monitor.py")],
  287. cwd=repo_root,
  288. check=False,
  289. capture_output=True,
  290. text=True,
  291. )
  292. self.assertEqual(completed.returncode, 0)
  293. self.assertIn("ITA_MONITOR_PREFLIGHT_OK", completed.stdout)
  294. self.assertIn("external_request=false", completed.stdout)
  295. self.assertEqual(completed.stderr, "")
  296. def test_source_has_one_query_call_and_no_book_or_redis_dependency(self):
  297. source_path = (
  298. Path(__file__).resolve().parents[2]
  299. / "tools"
  300. / "debug_ita_monitor.py"
  301. )
  302. source = source_path.read_text(encoding="utf-8")
  303. tree = ast.parse(source)
  304. query_calls = [
  305. node
  306. for node in ast.walk(tree)
  307. if isinstance(node, ast.Call)
  308. and isinstance(node.func, ast.Attribute)
  309. and node.func.attr == "query"
  310. ]
  311. book_calls = [
  312. node
  313. for node in ast.walk(tree)
  314. if isinstance(node, ast.Call)
  315. and isinstance(node.func, ast.Attribute)
  316. and node.func.attr == "book"
  317. ]
  318. self.assertEqual(len(query_calls), 1)
  319. self.assertEqual(book_calls, [])
  320. self.assertNotIn("redis", source.lower())
  321. def test_defaults_match_the_existing_italy_sentinel_cadence(self):
  322. self.assertEqual(MIN_SAFE_WAIT_SECONDS, 60)
  323. self.assertEqual(DEFAULT_MAX_WAIT_SECONDS, 300)
  324. self.assertEqual(DEFAULT_MAX_PROBES, 10)
  325. if __name__ == "__main__":
  326. unittest.main()