test_notification_service.py 46 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194
  1. """Unit tests for NotificationService.
  2. Tests event-based notifications and toggle behavior.
  3. """
  4. import json
  5. from datetime import datetime
  6. from unittest.mock import AsyncMock, MagicMock, patch
  7. import pytest
  8. from backend.app.services.notification_service import NotificationService
  9. class TestNotificationService:
  10. """Tests for NotificationService class."""
  11. @pytest.fixture
  12. def service(self):
  13. """Create a fresh NotificationService instance."""
  14. return NotificationService()
  15. @pytest.fixture
  16. def mock_provider(self):
  17. """Create a mock notification provider."""
  18. provider = MagicMock()
  19. provider.id = 1
  20. provider.name = "Test Provider"
  21. provider.provider_type = "webhook"
  22. provider.enabled = True
  23. provider.config = json.dumps({"webhook_url": "http://test.local/webhook"})
  24. provider.on_print_start = True
  25. provider.on_print_complete = True
  26. provider.on_print_failed = True
  27. provider.on_print_stopped = False
  28. provider.on_print_progress = False
  29. provider.on_printer_offline = False
  30. provider.on_printer_error = False
  31. provider.on_filament_low = False
  32. provider.on_maintenance_due = False
  33. provider.on_ams_humidity_high = False
  34. provider.on_ams_temperature_high = False
  35. provider.quiet_hours_enabled = False
  36. provider.quiet_hours_start = None
  37. provider.quiet_hours_end = None
  38. provider.daily_digest_enabled = False
  39. provider.daily_digest_time = None
  40. provider.printer_id = None
  41. return provider
  42. @pytest.fixture
  43. def mock_db(self):
  44. """Create a mock database session."""
  45. db = AsyncMock()
  46. db.commit = AsyncMock()
  47. return db
  48. # ========================================================================
  49. # Tests for on_print_start
  50. # ========================================================================
  51. @pytest.mark.asyncio
  52. async def test_on_print_start_sends_notification(self, service, mock_provider, mock_db):
  53. """Verify notification is sent when print starts."""
  54. with (
  55. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  56. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  57. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  58. ):
  59. mock_get.return_value = [mock_provider]
  60. mock_build.return_value = ("Print Started", "Test Printer: test.3mf")
  61. await service.on_print_start(
  62. printer_id=1,
  63. printer_name="Test Printer",
  64. data={"filename": "test.3mf", "subtask_name": "test"},
  65. db=mock_db,
  66. )
  67. mock_get.assert_called_once()
  68. mock_send.assert_called_once()
  69. @pytest.mark.asyncio
  70. async def test_on_print_start_skipped_when_no_providers(self, service, mock_db):
  71. """Verify no error when no providers are configured for event."""
  72. with (
  73. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  74. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  75. ):
  76. mock_get.return_value = []
  77. await service.on_print_start(
  78. printer_id=1,
  79. printer_name="Test Printer",
  80. data={},
  81. db=mock_db,
  82. )
  83. mock_send.assert_not_called()
  84. # ========================================================================
  85. # Tests for on_print_complete (status routing)
  86. # ========================================================================
  87. @pytest.mark.asyncio
  88. async def test_on_print_complete_routes_completed_status(self, service, mock_provider, mock_db):
  89. """Verify completed status uses on_print_complete field."""
  90. with (
  91. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  92. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  93. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  94. ):
  95. mock_get.return_value = [mock_provider]
  96. mock_build.return_value = ("Test", "Test")
  97. await service.on_print_complete(
  98. printer_id=1,
  99. printer_name="Test",
  100. status="completed",
  101. data={},
  102. db=mock_db,
  103. )
  104. # Verify the correct event field was queried
  105. call_args = mock_get.call_args
  106. assert call_args[0][1] == "on_print_complete"
  107. @pytest.mark.asyncio
  108. async def test_on_print_complete_routes_failed_status(self, service, mock_provider, mock_db):
  109. """Verify failed status uses on_print_failed field."""
  110. with (
  111. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  112. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  113. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  114. ):
  115. mock_get.return_value = [mock_provider]
  116. mock_build.return_value = ("Test", "Test")
  117. await service.on_print_complete(
  118. printer_id=1,
  119. printer_name="Test",
  120. status="failed",
  121. data={},
  122. db=mock_db,
  123. )
  124. call_args = mock_get.call_args
  125. assert call_args[0][1] == "on_print_failed"
  126. @pytest.mark.asyncio
  127. async def test_on_print_complete_routes_stopped_status(self, service, mock_provider, mock_db):
  128. """Verify stopped status uses on_print_stopped field."""
  129. with (
  130. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  131. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  132. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  133. ):
  134. mock_get.return_value = [mock_provider]
  135. mock_build.return_value = ("Test", "Test")
  136. await service.on_print_complete(
  137. printer_id=1,
  138. printer_name="Test",
  139. status="stopped",
  140. data={},
  141. db=mock_db,
  142. )
  143. call_args = mock_get.call_args
  144. assert call_args[0][1] == "on_print_stopped"
  145. @pytest.mark.asyncio
  146. async def test_on_print_complete_routes_aborted_status(self, service, mock_provider, mock_db):
  147. """Verify aborted status uses on_print_stopped field."""
  148. with (
  149. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  150. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  151. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  152. ):
  153. mock_get.return_value = [mock_provider]
  154. mock_build.return_value = ("Test", "Test")
  155. await service.on_print_complete(
  156. printer_id=1,
  157. printer_name="Test",
  158. status="aborted",
  159. data={},
  160. db=mock_db,
  161. )
  162. call_args = mock_get.call_args
  163. assert call_args[0][1] == "on_print_stopped"
  164. # ========================================================================
  165. # Tests for provider filtering
  166. # ========================================================================
  167. @pytest.mark.asyncio
  168. async def test_disabled_provider_not_returned(self, service, mock_provider, mock_db):
  169. """CRITICAL: Verify disabled providers don't receive notifications."""
  170. mock_provider.enabled = False
  171. # The actual filtering happens in _get_providers_for_event
  172. # which queries only enabled providers
  173. with patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get:
  174. # Simulate the query filtering out disabled providers
  175. mock_get.return_value = []
  176. result = await service._get_providers_for_event(mock_db, "on_print_start", printer_id=1)
  177. assert len(result) == 0
  178. @pytest.mark.asyncio
  179. async def test_provider_filtered_by_printer_id(self, service, mock_provider, mock_db):
  180. """Verify providers can be filtered by specific printer."""
  181. mock_provider.printer_id = 2 # Linked to printer 2
  182. with patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get:
  183. # When querying for printer 1, provider linked to printer 2 is excluded
  184. mock_get.return_value = []
  185. result = await service._get_providers_for_event(mock_db, "on_print_start", printer_id=1)
  186. assert len(result) == 0
  187. # ========================================================================
  188. # Tests for quiet hours
  189. # ========================================================================
  190. def test_is_in_quiet_hours_during_quiet_period(self, service, mock_provider):
  191. """Verify notifications are blocked during quiet hours."""
  192. mock_provider.quiet_hours_enabled = True
  193. mock_provider.quiet_hours_start = "22:00"
  194. mock_provider.quiet_hours_end = "07:00"
  195. with patch("backend.app.services.notification_service.datetime") as mock_datetime:
  196. # Test during quiet hours (23:00)
  197. mock_now = MagicMock()
  198. mock_now.hour = 23
  199. mock_now.minute = 0
  200. mock_datetime.now.return_value = mock_now
  201. result = service._is_in_quiet_hours(mock_provider)
  202. assert result is True
  203. def test_is_in_quiet_hours_outside_quiet_period(self, service, mock_provider):
  204. """Verify notifications are allowed outside quiet hours."""
  205. mock_provider.quiet_hours_enabled = True
  206. mock_provider.quiet_hours_start = "22:00"
  207. mock_provider.quiet_hours_end = "07:00"
  208. with patch("backend.app.services.notification_service.datetime") as mock_datetime:
  209. # Test outside quiet hours (12:00)
  210. mock_now = MagicMock()
  211. mock_now.hour = 12
  212. mock_now.minute = 0
  213. mock_datetime.now.return_value = mock_now
  214. result = service._is_in_quiet_hours(mock_provider)
  215. assert result is False
  216. def test_is_in_quiet_hours_disabled(self, service, mock_provider):
  217. """Verify quiet hours check returns False when disabled."""
  218. mock_provider.quiet_hours_enabled = False
  219. result = service._is_in_quiet_hours(mock_provider)
  220. assert result is False
  221. def test_is_in_quiet_hours_early_morning(self, service, mock_provider):
  222. """Verify quiet hours work across midnight (early morning)."""
  223. mock_provider.quiet_hours_enabled = True
  224. mock_provider.quiet_hours_start = "22:00"
  225. mock_provider.quiet_hours_end = "07:00"
  226. with patch("backend.app.services.notification_service.datetime") as mock_datetime:
  227. # Test early morning (03:00) - should be in quiet hours
  228. mock_now = MagicMock()
  229. mock_now.hour = 3
  230. mock_now.minute = 0
  231. mock_datetime.now.return_value = mock_now
  232. result = service._is_in_quiet_hours(mock_provider)
  233. assert result is True
  234. # ========================================================================
  235. # Tests for AMS alarms
  236. # ========================================================================
  237. @pytest.mark.asyncio
  238. async def test_on_ams_humidity_high_sends_notification(self, service, mock_provider, mock_db):
  239. """Verify AMS humidity alarm sends notification."""
  240. mock_provider.on_ams_humidity_high = True
  241. with (
  242. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  243. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  244. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  245. ):
  246. mock_get.return_value = [mock_provider]
  247. mock_build.return_value = ("AMS Humidity Alert", "High humidity detected")
  248. await service.on_ams_humidity_high(
  249. printer_id=1,
  250. printer_name="Test Printer",
  251. ams_label="AMS-A",
  252. humidity=75.0,
  253. threshold=60.0,
  254. db=mock_db,
  255. )
  256. mock_send.assert_called_once()
  257. # Verify force_immediate is True for alarms
  258. call_kwargs = mock_send.call_args[1]
  259. assert call_kwargs.get("force_immediate") is True
  260. @pytest.mark.asyncio
  261. async def test_on_ams_temperature_high_sends_notification(self, service, mock_provider, mock_db):
  262. """Verify AMS temperature alarm sends notification."""
  263. mock_provider.on_ams_temperature_high = True
  264. with (
  265. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  266. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  267. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  268. ):
  269. mock_get.return_value = [mock_provider]
  270. mock_build.return_value = ("AMS Temperature Alert", "High temp detected")
  271. await service.on_ams_temperature_high(
  272. printer_id=1,
  273. printer_name="Test Printer",
  274. ams_label="AMS-A",
  275. temperature=40.0,
  276. threshold=35.0,
  277. db=mock_db,
  278. )
  279. mock_send.assert_called_once()
  280. # Verify force_immediate is True for alarms
  281. call_kwargs = mock_send.call_args[1]
  282. assert call_kwargs.get("force_immediate") is True
  283. @pytest.mark.asyncio
  284. async def test_ams_alarm_skipped_when_toggle_disabled(self, service, mock_provider, mock_db):
  285. """CRITICAL: Verify AMS alarms respect toggle setting."""
  286. mock_provider.on_ams_humidity_high = False
  287. with (
  288. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  289. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  290. ):
  291. # Provider with toggle disabled won't be returned
  292. mock_get.return_value = []
  293. await service.on_ams_humidity_high(
  294. printer_id=1,
  295. printer_name="Test",
  296. ams_label="AMS-A",
  297. humidity=75.0,
  298. threshold=60.0,
  299. db=mock_db,
  300. )
  301. mock_send.assert_not_called()
  302. # ========================================================================
  303. # Tests for daily digest
  304. # ========================================================================
  305. @pytest.mark.asyncio
  306. async def test_daily_digest_queues_notification(self, service, mock_provider, mock_db):
  307. """Verify notifications are queued when digest mode is enabled."""
  308. mock_provider.daily_digest_enabled = True
  309. mock_provider.daily_digest_time = "09:00"
  310. with (
  311. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  312. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  313. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  314. ):
  315. mock_get.return_value = [mock_provider]
  316. mock_build.return_value = ("Test", "Test")
  317. await service.on_print_complete(
  318. printer_id=1,
  319. printer_name="Test",
  320. status="completed",
  321. data={},
  322. db=mock_db,
  323. )
  324. # When digest is enabled, _send_to_providers should still be called
  325. # but internally it will queue instead of send immediately
  326. mock_send.assert_called_once()
  327. @pytest.mark.asyncio
  328. async def test_force_immediate_bypasses_digest(self, service, mock_provider, mock_db):
  329. """Verify force_immediate=True bypasses digest mode."""
  330. mock_provider.daily_digest_enabled = True
  331. mock_provider.on_ams_humidity_high = True
  332. with (
  333. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  334. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  335. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  336. ):
  337. mock_get.return_value = [mock_provider]
  338. mock_build.return_value = ("Alert", "Alert message")
  339. await service.on_ams_humidity_high(
  340. printer_id=1,
  341. printer_name="Test",
  342. ams_label="AMS-A",
  343. humidity=75.0,
  344. threshold=60.0,
  345. db=mock_db,
  346. )
  347. # Verify force_immediate is passed
  348. call_kwargs = mock_send.call_args[1]
  349. assert call_kwargs.get("force_immediate") is True
  350. class TestDigestModeAlwaysSendsImmediately:
  351. """CRITICAL: Tests that notifications always send immediately regardless of digest setting."""
  352. @pytest.fixture
  353. def service(self):
  354. return NotificationService()
  355. @pytest.mark.asyncio
  356. async def test_notification_sends_immediately_even_with_digest_enabled(self, service):
  357. """CRITICAL: All notifications must be sent immediately, digest is just a summary."""
  358. # Create a mock provider with digest enabled
  359. mock_provider = MagicMock()
  360. mock_provider.id = 1
  361. mock_provider.name = "Test Provider"
  362. mock_provider.provider_type = "ntfy"
  363. mock_provider.enabled = True
  364. mock_provider.daily_digest_enabled = True # Digest enabled
  365. mock_provider.daily_digest_time = "23:59"
  366. mock_provider.config = '{"server": "https://ntfy.sh", "topic": "test"}'
  367. mock_db = AsyncMock()
  368. # Mock the _send_to_provider method
  369. with (
  370. patch.object(service, "_send_to_provider", new_callable=AsyncMock) as mock_send,
  371. patch.object(service, "_queue_for_digest", new_callable=AsyncMock) as mock_queue,
  372. patch.object(service, "_update_provider_status", new_callable=AsyncMock),
  373. patch.object(service, "_log_notification", new_callable=AsyncMock),
  374. ):
  375. mock_send.return_value = (True, None)
  376. await service._send_to_providers(
  377. providers=[mock_provider],
  378. title="Print Started",
  379. message="Your print has started",
  380. db=mock_db,
  381. event_type="print_start",
  382. )
  383. # CRITICAL: _send_to_provider MUST be called (immediate send)
  384. mock_send.assert_called_once()
  385. # Digest queue should also be called (for daily summary)
  386. mock_queue.assert_called_once()
  387. @pytest.mark.asyncio
  388. async def test_notification_sends_without_digest_queue_when_disabled(self, service):
  389. """When digest is disabled, notification sends but no digest queue."""
  390. mock_provider = MagicMock()
  391. mock_provider.id = 1
  392. mock_provider.name = "Test Provider"
  393. mock_provider.provider_type = "ntfy"
  394. mock_provider.enabled = True
  395. mock_provider.daily_digest_enabled = False # Digest disabled
  396. mock_provider.daily_digest_time = None
  397. mock_provider.config = '{"server": "https://ntfy.sh", "topic": "test"}'
  398. mock_db = AsyncMock()
  399. with (
  400. patch.object(service, "_send_to_provider", new_callable=AsyncMock) as mock_send,
  401. patch.object(service, "_queue_for_digest", new_callable=AsyncMock) as mock_queue,
  402. patch.object(service, "_update_provider_status", new_callable=AsyncMock),
  403. patch.object(service, "_log_notification", new_callable=AsyncMock),
  404. ):
  405. mock_send.return_value = (True, None)
  406. await service._send_to_providers(
  407. providers=[mock_provider],
  408. title="Print Started",
  409. message="Your print has started",
  410. db=mock_db,
  411. event_type="print_start",
  412. )
  413. # Notification must still be sent immediately
  414. mock_send.assert_called_once()
  415. # Digest queue should NOT be called when digest is disabled
  416. mock_queue.assert_not_called()
  417. class TestNotificationProviderTypes:
  418. """Tests for different notification provider types."""
  419. @pytest.fixture
  420. def service(self):
  421. return NotificationService()
  422. @pytest.mark.asyncio
  423. async def test_webhook_provider_sends_request(self, service):
  424. """Verify webhook provider sends HTTP request."""
  425. config = {
  426. "webhook_url": "http://test.local/webhook",
  427. "field_title": "title",
  428. "field_message": "message",
  429. }
  430. # Create a mock response
  431. mock_response = MagicMock()
  432. mock_response.status_code = 200
  433. # Mock the _get_client method
  434. mock_client = AsyncMock()
  435. mock_client.post = AsyncMock(return_value=mock_response)
  436. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client:
  437. mock_get_client.return_value = mock_client
  438. success, message = await service._send_webhook(config, "Test Title", "Test Message")
  439. assert success is True
  440. mock_client.post.assert_called_once()
  441. @pytest.mark.asyncio
  442. async def test_webhook_handles_failure(self, service):
  443. """Verify webhook gracefully handles HTTP errors."""
  444. config = {
  445. "webhook_url": "http://test.local/webhook",
  446. }
  447. with patch("httpx.AsyncClient") as mock_client_class:
  448. mock_instance = AsyncMock()
  449. mock_instance.post.side_effect = Exception("Connection failed")
  450. mock_client_class.return_value.__aenter__ = AsyncMock(return_value=mock_instance)
  451. mock_client_class.return_value.__aexit__ = AsyncMock()
  452. success, message = await service._send_webhook(config, "Test", "Test")
  453. assert success is False
  454. assert "Connection failed" in message or "error" in message.lower()
  455. @pytest.mark.asyncio
  456. async def test_webhook_slack_format_sends_text_only(self, service):
  457. """Verify Slack/Mattermost format sends only text field."""
  458. config = {
  459. "webhook_url": "http://mattermost.local/hooks/abc123",
  460. "payload_format": "slack",
  461. }
  462. mock_response = MagicMock()
  463. mock_response.status_code = 200
  464. mock_client = AsyncMock()
  465. mock_client.post = AsyncMock(return_value=mock_response)
  466. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client:
  467. mock_get_client.return_value = mock_client
  468. success, message = await service._send_webhook(config, "Test Title", "Test Message")
  469. assert success is True
  470. mock_client.post.assert_called_once()
  471. # Verify payload format is Slack-compatible
  472. call_args = mock_client.post.call_args
  473. payload = call_args.kwargs.get("json") or call_args[1].get("json")
  474. assert "text" in payload
  475. assert "*Test Title*" in payload["text"]
  476. assert "Test Message" in payload["text"]
  477. # Should NOT have generic fields
  478. assert "timestamp" not in payload
  479. assert "source" not in payload
  480. class TestNotificationVariableFallbacks:
  481. """Tests for notification variable fallback values."""
  482. @pytest.fixture
  483. def service(self):
  484. return NotificationService()
  485. def test_format_duration_with_valid_seconds(self, service):
  486. """Verify duration formats correctly with valid input."""
  487. result = service._format_duration(3661) # 1h 1m 1s
  488. assert "1h" in result
  489. def test_format_duration_with_none_returns_unknown(self, service):
  490. """CRITICAL: Verify None duration returns 'Unknown' fallback."""
  491. result = service._format_duration(None)
  492. assert result == "Unknown"
  493. def test_format_duration_with_zero(self, service):
  494. """Verify zero duration formats correctly."""
  495. result = service._format_duration(0)
  496. # Should return some valid string, not "Unknown"
  497. assert result is not None
  498. assert isinstance(result, str)
  499. def test_format_duration_hours_and_minutes(self, service):
  500. """Verify duration formats hours and minutes."""
  501. result = service._format_duration(5400) # 1h 30m
  502. assert "1h" in result
  503. assert "30m" in result
  504. def test_format_duration_minutes_only(self, service):
  505. """Verify duration formats minutes only when < 1 hour."""
  506. result = service._format_duration(1800) # 30m
  507. assert "30m" in result or "30" in result
  508. @pytest.mark.asyncio
  509. async def test_print_complete_fallback_values(self, service):
  510. """CRITICAL: Verify fallback values when archive_data is missing."""
  511. mock_db = AsyncMock()
  512. with (
  513. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  514. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  515. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  516. ):
  517. mock_get.return_value = [] # No providers, just testing variable setup
  518. mock_build.return_value = ("Test", "Test")
  519. await service.on_print_complete(
  520. printer_id=1,
  521. printer_name="Test",
  522. status="completed",
  523. data={"subtask_name": "test_print"},
  524. db=mock_db,
  525. archive_data=None, # No archive data - should use fallbacks
  526. )
  527. # Test passes if no exception is raised with missing archive_data
  528. @pytest.mark.asyncio
  529. async def test_print_complete_with_archive_data(self, service):
  530. """Verify archive data values are used when provided."""
  531. mock_db = AsyncMock()
  532. captured_variables = {}
  533. async def capture_build(db, event_type, variables):
  534. captured_variables.update(variables)
  535. return ("Test", "Test")
  536. with (
  537. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  538. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  539. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  540. ):
  541. mock_get.return_value = []
  542. await service.on_print_complete(
  543. printer_id=1,
  544. printer_name="Test",
  545. status="completed",
  546. data={"subtask_name": "test_print"},
  547. db=mock_db,
  548. archive_data={
  549. "print_time_seconds": 3600,
  550. "actual_filament_grams": 50.5,
  551. },
  552. )
  553. # When archive data is provided, duration should not be "Unknown"
  554. if captured_variables.get("duration"):
  555. assert captured_variables["duration"] != "Unknown"
  556. @pytest.mark.asyncio
  557. async def test_print_complete_with_finish_photo_url(self, service):
  558. """Verify finish_photo_url is passed through from archive_data."""
  559. mock_db = AsyncMock()
  560. mock_provider = MagicMock()
  561. mock_provider.id = 1
  562. captured_variables = {}
  563. async def capture_build(db, event_type, variables):
  564. captured_variables.update(variables)
  565. return ("Test", "Test")
  566. with (
  567. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  568. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  569. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  570. ):
  571. mock_get.return_value = [mock_provider]
  572. await service.on_print_complete(
  573. printer_id=1,
  574. printer_name="Test",
  575. status="completed",
  576. data={"subtask_name": "test_print"},
  577. db=mock_db,
  578. archive_data={
  579. "print_time_seconds": 3600,
  580. "actual_filament_grams": 50.5,
  581. "finish_photo_url": "http://localhost:8000/api/v1/archives/1/photos/finish_test.jpg",
  582. },
  583. )
  584. # finish_photo_url should be passed through to template variables
  585. assert (
  586. captured_variables.get("finish_photo_url")
  587. == "http://localhost:8000/api/v1/archives/1/photos/finish_test.jpg"
  588. )
  589. @pytest.mark.asyncio
  590. async def test_print_start_estimated_time_fallback(self, service):
  591. """Verify estimated time shows 'Unknown' when not available."""
  592. mock_db = AsyncMock()
  593. mock_provider = MagicMock()
  594. mock_provider.id = 1
  595. captured_variables = {}
  596. async def capture_build(db, event_type, variables):
  597. captured_variables.update(variables)
  598. return ("Test", "Test")
  599. with (
  600. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  601. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  602. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  603. ):
  604. # Need at least one provider to trigger message building
  605. mock_get.return_value = [mock_provider]
  606. await service.on_print_start(
  607. printer_id=1,
  608. printer_name="Test",
  609. data={
  610. "subtask_name": "test",
  611. # No estimated_time or mc_remaining_time
  612. },
  613. db=mock_db,
  614. )
  615. # When no time data, should show "Unknown"
  616. assert captured_variables.get("estimated_time") == "Unknown"
  617. @pytest.mark.asyncio
  618. async def test_print_progress_remaining_time_fallback(self, service):
  619. """Verify remaining time shows 'Unknown' when not available."""
  620. mock_db = AsyncMock()
  621. mock_provider = MagicMock()
  622. mock_provider.id = 1
  623. captured_variables = {}
  624. async def capture_build(db, event_type, variables):
  625. captured_variables.update(variables)
  626. return ("Test", "Test")
  627. with (
  628. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  629. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  630. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  631. ):
  632. # Need at least one provider to trigger message building
  633. mock_get.return_value = [mock_provider]
  634. await service.on_print_progress(
  635. printer_id=1,
  636. printer_name="Test",
  637. progress=50,
  638. remaining_time=None, # No remaining time
  639. filename="test.3mf",
  640. db=mock_db,
  641. )
  642. # When no remaining time, should show "Unknown"
  643. assert captured_variables.get("remaining_time") == "Unknown"
  644. @pytest.mark.asyncio
  645. async def test_filename_fallback_to_unknown(self, service):
  646. """Verify filename defaults to 'Unknown' when not provided."""
  647. mock_db = AsyncMock()
  648. mock_provider = MagicMock()
  649. mock_provider.id = 1
  650. captured_variables = {}
  651. async def capture_build(db, event_type, variables):
  652. captured_variables.update(variables)
  653. return ("Test", "Test")
  654. with (
  655. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  656. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  657. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  658. ):
  659. # Need at least one provider to trigger message building
  660. mock_get.return_value = [mock_provider]
  661. await service.on_print_complete(
  662. printer_id=1,
  663. printer_name="Test",
  664. status="completed",
  665. data={}, # No subtask_name or filename
  666. db=mock_db,
  667. )
  668. # Filename should default to something (either "Unknown" or cleaned empty)
  669. assert "filename" in captured_variables
  670. @pytest.mark.asyncio
  671. async def test_print_start_uses_archive_print_time_seconds(self, service):
  672. """Verify print_time_seconds from archive_data is used for estimated_time."""
  673. mock_db = AsyncMock()
  674. mock_provider = MagicMock()
  675. mock_provider.id = 1
  676. captured_variables = {}
  677. async def capture_build(db, event_type, variables):
  678. captured_variables.update(variables)
  679. return ("Test", "Test")
  680. with (
  681. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  682. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  683. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  684. ):
  685. mock_get.return_value = [mock_provider]
  686. # Pass archive_data with print_time_seconds (7200 seconds = 2 hours)
  687. await service.on_print_start(
  688. printer_id=1,
  689. printer_name="Test",
  690. data={"subtask_name": "test"},
  691. db=mock_db,
  692. archive_data={"print_time_seconds": 7200},
  693. )
  694. # Should use archive's print_time_seconds: 7200 seconds = 2h 0m
  695. assert captured_variables.get("estimated_time") == "2h 0m"
  696. @pytest.mark.asyncio
  697. async def test_print_start_archive_data_overrides_mqtt(self, service):
  698. """Verify archive_data takes priority over MQTT remaining_time."""
  699. mock_db = AsyncMock()
  700. mock_provider = MagicMock()
  701. mock_provider.id = 1
  702. captured_variables = {}
  703. async def capture_build(db, event_type, variables):
  704. captured_variables.update(variables)
  705. return ("Test", "Test")
  706. with (
  707. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  708. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  709. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  710. ):
  711. mock_get.return_value = [mock_provider]
  712. # Both archive_data and MQTT remaining_time provided
  713. # Archive says 2 hours, MQTT says 30 minutes (wrong at start)
  714. await service.on_print_start(
  715. printer_id=1,
  716. printer_name="Test",
  717. data={
  718. "subtask_name": "test",
  719. "remaining_time": 1800, # 30 minutes from MQTT
  720. },
  721. db=mock_db,
  722. archive_data={"print_time_seconds": 7200}, # 2 hours from 3MF
  723. )
  724. # Should use archive's print_time_seconds (more reliable)
  725. assert captured_variables.get("estimated_time") == "2h 0m"
  726. @pytest.mark.asyncio
  727. async def test_print_start_falls_back_to_mqtt_when_no_archive(self, service):
  728. """Verify MQTT remaining_time is used when archive_data not provided."""
  729. mock_db = AsyncMock()
  730. mock_provider = MagicMock()
  731. mock_provider.id = 1
  732. captured_variables = {}
  733. async def capture_build(db, event_type, variables):
  734. captured_variables.update(variables)
  735. return ("Test", "Test")
  736. with (
  737. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  738. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  739. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  740. ):
  741. mock_get.return_value = [mock_provider]
  742. # Only MQTT remaining_time provided (1800 seconds = 30 minutes)
  743. await service.on_print_start(
  744. printer_id=1,
  745. printer_name="Test",
  746. data={
  747. "subtask_name": "test",
  748. "remaining_time": 1800,
  749. },
  750. db=mock_db,
  751. # No archive_data
  752. )
  753. # Should use MQTT remaining_time
  754. assert captured_variables.get("estimated_time") == "30m"
  755. class TestNotificationTemplates:
  756. """Tests for notification message template rendering."""
  757. @pytest.fixture
  758. def service(self):
  759. return NotificationService()
  760. @pytest.mark.asyncio
  761. async def test_template_renders_variables(self, service):
  762. """Verify template variables are replaced correctly."""
  763. template_title = "Print {progress}% Complete"
  764. template_body = "{printer}: {filename}\nRemaining: {remaining_time}"
  765. variables = {
  766. "printer": "Test Printer",
  767. "filename": "test.3mf",
  768. "progress": "50",
  769. "remaining_time": "1h 30m",
  770. }
  771. title = template_title.format(**variables)
  772. body = template_body.format(**variables)
  773. assert title == "Print 50% Complete"
  774. assert "Test Printer" in body
  775. assert "test.3mf" in body
  776. assert "1h 30m" in body
  777. @pytest.mark.asyncio
  778. async def test_template_handles_missing_variables(self, service):
  779. """Verify missing template variables don't cause crashes."""
  780. template = "{printer}: {unknown_var}"
  781. variables = {"printer": "Test"}
  782. # Should handle gracefully - either leave placeholder or skip
  783. try:
  784. result = template.format_map({**variables, "unknown_var": "{unknown_var}"})
  785. assert "Test" in result
  786. except KeyError:
  787. pytest.fail("Template should handle missing variables gracefully")
  788. class TestPrinterErrorNotifications:
  789. """Tests for HMS error (printer error) notifications."""
  790. @pytest.fixture
  791. def service(self):
  792. return NotificationService()
  793. @pytest.fixture
  794. def mock_provider(self):
  795. """Create a mock notification provider with error notifications enabled."""
  796. provider = MagicMock()
  797. provider.id = 1
  798. provider.name = "Test Provider"
  799. provider.provider_type = "webhook"
  800. provider.enabled = True
  801. provider.config = json.dumps({"webhook_url": "http://test.local/webhook"})
  802. provider.on_printer_error = True # Enable error notifications
  803. provider.quiet_hours_enabled = False
  804. provider.daily_digest_enabled = False
  805. provider.printer_id = None
  806. return provider
  807. @pytest.fixture
  808. def mock_db(self):
  809. """Create a mock database session."""
  810. db = AsyncMock()
  811. db.commit = AsyncMock()
  812. return db
  813. @pytest.mark.asyncio
  814. async def test_on_printer_error_sends_notification(self, service, mock_provider, mock_db):
  815. """Verify HMS error notification is sent when triggered."""
  816. with (
  817. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  818. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  819. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  820. ):
  821. mock_get.return_value = [mock_provider]
  822. mock_build.return_value = ("Printer Error", "AMS/Filament Error: 0700_8010")
  823. await service.on_printer_error(
  824. printer_id=1,
  825. printer_name="Test Printer",
  826. error_type="AMS/Filament Error",
  827. db=mock_db,
  828. error_detail="Error code: 0700_8010",
  829. )
  830. mock_get.assert_called_once()
  831. mock_send.assert_called_once()
  832. @pytest.mark.asyncio
  833. async def test_on_printer_error_skipped_when_disabled(self, service, mock_provider, mock_db):
  834. """CRITICAL: Verify error notifications respect toggle setting."""
  835. mock_provider.on_printer_error = False
  836. with (
  837. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  838. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  839. ):
  840. # Provider with toggle disabled won't be returned
  841. mock_get.return_value = []
  842. await service.on_printer_error(
  843. printer_id=1,
  844. printer_name="Test",
  845. error_type="AMS Error",
  846. db=mock_db,
  847. error_detail="Test error",
  848. )
  849. mock_send.assert_not_called()
  850. @pytest.mark.asyncio
  851. async def test_on_printer_error_includes_error_detail(self, service, mock_provider, mock_db):
  852. """Verify error details are passed to template variables."""
  853. captured_variables = {}
  854. async def capture_build(db, event_type, variables):
  855. captured_variables.update(variables)
  856. return ("Test", "Test")
  857. with (
  858. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  859. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  860. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  861. ):
  862. mock_get.return_value = [mock_provider]
  863. await service.on_printer_error(
  864. printer_id=1,
  865. printer_name="X1 Carbon",
  866. error_type="AMS/Filament Error",
  867. db=mock_db,
  868. error_detail="Error code: 0700_8010",
  869. )
  870. assert captured_variables["printer"] == "X1 Carbon"
  871. assert captured_variables["error_type"] == "AMS/Filament Error"
  872. assert captured_variables["error_detail"] == "Error code: 0700_8010"
  873. @pytest.mark.asyncio
  874. async def test_on_printer_error_fallback_when_no_detail(self, service, mock_provider, mock_db):
  875. """Verify fallback message when error_detail is None."""
  876. captured_variables = {}
  877. async def capture_build(db, event_type, variables):
  878. captured_variables.update(variables)
  879. return ("Test", "Test")
  880. with (
  881. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  882. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  883. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  884. ):
  885. mock_get.return_value = [mock_provider]
  886. await service.on_printer_error(
  887. printer_id=1,
  888. printer_name="Test Printer",
  889. error_type="Unknown Error",
  890. db=mock_db,
  891. error_detail=None, # No detail provided
  892. )
  893. assert captured_variables["error_detail"] == "No details available"
  894. class TestPlateNotEmptyNotifications:
  895. """Tests for plate not empty (build plate detection) notifications."""
  896. @pytest.fixture
  897. def service(self):
  898. return NotificationService()
  899. @pytest.fixture
  900. def mock_provider(self):
  901. """Create a mock notification provider with plate detection enabled."""
  902. provider = MagicMock()
  903. provider.id = 1
  904. provider.name = "Test Provider"
  905. provider.provider_type = "webhook"
  906. provider.enabled = True
  907. provider.config = json.dumps({"webhook_url": "http://test.local/webhook"})
  908. provider.on_plate_not_empty = True
  909. provider.quiet_hours_enabled = False
  910. provider.daily_digest_enabled = False
  911. provider.printer_id = None
  912. return provider
  913. @pytest.fixture
  914. def mock_db(self):
  915. """Create a mock database session."""
  916. db = AsyncMock()
  917. db.commit = AsyncMock()
  918. return db
  919. @pytest.mark.asyncio
  920. async def test_on_plate_not_empty_sends_notification(self, service, mock_provider, mock_db):
  921. """Verify plate not empty notification is sent when triggered."""
  922. with (
  923. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  924. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  925. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  926. ):
  927. mock_get.return_value = [mock_provider]
  928. mock_build.return_value = ("Plate Not Empty", "Objects detected on build plate")
  929. await service.on_plate_not_empty(
  930. printer_id=1,
  931. printer_name="Test Printer",
  932. db=mock_db,
  933. difference_percent=5.2,
  934. )
  935. mock_get.assert_called_once()
  936. mock_send.assert_called_once()
  937. # Verify force_immediate is True (critical alert)
  938. call_kwargs = mock_send.call_args[1]
  939. assert call_kwargs.get("force_immediate") is True
  940. @pytest.mark.asyncio
  941. async def test_on_plate_not_empty_skipped_when_disabled(self, service, mock_provider, mock_db):
  942. """Verify notification is skipped when toggle is disabled."""
  943. mock_provider.on_plate_not_empty = False
  944. with (
  945. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  946. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  947. ):
  948. mock_get.return_value = []
  949. await service.on_plate_not_empty(
  950. printer_id=1,
  951. printer_name="Test",
  952. db=mock_db,
  953. )
  954. mock_send.assert_not_called()
  955. @pytest.mark.asyncio
  956. async def test_on_plate_not_empty_includes_difference_percent(self, service, mock_provider, mock_db):
  957. """Verify difference percentage is passed to template variables."""
  958. captured_variables = {}
  959. async def capture_build(db, event_type, variables):
  960. captured_variables.update(variables)
  961. return ("Test", "Test")
  962. with (
  963. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  964. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  965. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  966. ):
  967. mock_get.return_value = [mock_provider]
  968. await service.on_plate_not_empty(
  969. printer_id=1,
  970. printer_name="X1 Carbon",
  971. db=mock_db,
  972. difference_percent=3.5,
  973. )
  974. assert captured_variables["printer"] == "X1 Carbon"
  975. assert captured_variables["difference_percent"] == "3.5"