test_notification_service.py 46 KB

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