test_notification_service.py 69 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780
  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. @pytest.mark.asyncio
  480. async def test_webhook_generic_format_includes_image(self, service):
  481. """Verify generic webhook includes base64-encoded image when provided."""
  482. config = {
  483. "webhook_url": "http://test.local/webhook",
  484. "field_title": "title",
  485. "field_message": "message",
  486. }
  487. mock_response = MagicMock()
  488. mock_response.status_code = 200
  489. mock_client = AsyncMock()
  490. mock_client.post = AsyncMock(return_value=mock_response)
  491. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client:
  492. mock_get_client.return_value = mock_client
  493. image_bytes = b"\xff\xd8\xff\xe0fake-jpeg-data"
  494. success, message = await service._send_webhook(config, "Test Title", "Test Message", image_data=image_bytes)
  495. assert success is True
  496. call_args = mock_client.post.call_args
  497. payload = call_args.kwargs.get("json") or call_args[1].get("json")
  498. assert "image" in payload
  499. import base64
  500. assert payload["image"] == base64.b64encode(image_bytes).decode("ascii")
  501. @pytest.mark.asyncio
  502. async def test_webhook_generic_format_no_image_when_none(self, service):
  503. """Verify generic webhook omits image field when no image_data provided."""
  504. config = {
  505. "webhook_url": "http://test.local/webhook",
  506. "field_title": "title",
  507. "field_message": "message",
  508. }
  509. mock_response = MagicMock()
  510. mock_response.status_code = 200
  511. mock_client = AsyncMock()
  512. mock_client.post = AsyncMock(return_value=mock_response)
  513. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client:
  514. mock_get_client.return_value = mock_client
  515. success, message = await service._send_webhook(config, "Test Title", "Test Message")
  516. assert success is True
  517. call_args = mock_client.post.call_args
  518. payload = call_args.kwargs.get("json") or call_args[1].get("json")
  519. assert "image" not in payload
  520. @pytest.mark.asyncio
  521. async def test_webhook_slack_format_excludes_image(self, service):
  522. """Verify Slack format does not include image even when provided."""
  523. config = {
  524. "webhook_url": "http://mattermost.local/hooks/abc123",
  525. "payload_format": "slack",
  526. }
  527. mock_response = MagicMock()
  528. mock_response.status_code = 200
  529. mock_client = AsyncMock()
  530. mock_client.post = AsyncMock(return_value=mock_response)
  531. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client:
  532. mock_get_client.return_value = mock_client
  533. success, message = await service._send_webhook(
  534. config, "Test Title", "Test Message", image_data=b"fake-image"
  535. )
  536. assert success is True
  537. call_args = mock_client.post.call_args
  538. payload = call_args.kwargs.get("json") or call_args[1].get("json")
  539. assert "image" not in payload
  540. class TestHomeAssistantProvider:
  541. """Tests for Home Assistant notification provider."""
  542. @pytest.fixture
  543. def service(self):
  544. return NotificationService()
  545. @pytest.mark.asyncio
  546. async def test_send_homeassistant_success(self, service):
  547. """Verify HA provider sends persistent notification to correct endpoint."""
  548. mock_response = MagicMock()
  549. mock_response.status_code = 200
  550. mock_client = AsyncMock()
  551. mock_client.post = AsyncMock(return_value=mock_response)
  552. mock_db = AsyncMock()
  553. with (
  554. patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client,
  555. patch(
  556. "backend.app.api.routes.settings.get_homeassistant_settings",
  557. new_callable=AsyncMock,
  558. ) as mock_ha_settings,
  559. ):
  560. mock_get_client.return_value = mock_client
  561. mock_ha_settings.return_value = {
  562. "ha_url": "http://ha.local:8123",
  563. "ha_token": "test-token-123",
  564. "ha_enabled": True,
  565. }
  566. success, message = await service._send_homeassistant({}, "Test Title", "Test Message", db=mock_db)
  567. assert success is True
  568. mock_client.post.assert_called_once()
  569. call_args = mock_client.post.call_args
  570. assert call_args[0][0] == "http://ha.local:8123/api/services/persistent_notification/create"
  571. payload = call_args.kwargs.get("json") or call_args[1].get("json")
  572. assert payload["title"] == "Test Title"
  573. assert payload["message"] == "Test Message"
  574. @pytest.mark.asyncio
  575. async def test_send_homeassistant_no_db_no_env(self, service):
  576. """Verify HA provider fails gracefully without DB or env vars."""
  577. with patch.dict("os.environ", {}, clear=True):
  578. success, message = await service._send_homeassistant({}, "Test", "Test", db=None)
  579. assert success is False
  580. assert "not configured" in message.lower()
  581. @pytest.mark.asyncio
  582. async def test_send_homeassistant_auth_failure(self, service):
  583. """Verify HA provider reports auth failure."""
  584. mock_response = MagicMock()
  585. mock_response.status_code = 401
  586. mock_client = AsyncMock()
  587. mock_client.post = AsyncMock(return_value=mock_response)
  588. mock_db = AsyncMock()
  589. with (
  590. patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client,
  591. patch(
  592. "backend.app.api.routes.settings.get_homeassistant_settings",
  593. new_callable=AsyncMock,
  594. ) as mock_ha_settings,
  595. ):
  596. mock_get_client.return_value = mock_client
  597. mock_ha_settings.return_value = {
  598. "ha_url": "http://ha.local:8123",
  599. "ha_token": "bad-token",
  600. "ha_enabled": True,
  601. }
  602. success, message = await service._send_homeassistant({}, "Test", "Test", db=mock_db)
  603. assert success is False
  604. assert "authentication" in message.lower()
  605. @pytest.mark.asyncio
  606. async def test_send_homeassistant_env_fallback(self, service):
  607. """Verify HA provider falls back to env vars when no DB session."""
  608. mock_response = MagicMock()
  609. mock_response.status_code = 200
  610. mock_client = AsyncMock()
  611. mock_client.post = AsyncMock(return_value=mock_response)
  612. with (
  613. patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client,
  614. patch.dict("os.environ", {"HA_URL": "http://env-ha:8123", "HA_TOKEN": "env-token"}),
  615. ):
  616. mock_get_client.return_value = mock_client
  617. success, message = await service._send_homeassistant({}, "Test", "Test", db=None)
  618. assert success is True
  619. call_args = mock_client.post.call_args
  620. assert "env-ha:8123" in call_args[0][0]
  621. @pytest.mark.asyncio
  622. async def test_send_homeassistant_empty_config_accepted(self, service):
  623. """Verify HA provider works with empty config dict (no fields needed)."""
  624. mock_response = MagicMock()
  625. mock_response.status_code = 200
  626. mock_client = AsyncMock()
  627. mock_client.post = AsyncMock(return_value=mock_response)
  628. mock_db = AsyncMock()
  629. with (
  630. patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client,
  631. patch(
  632. "backend.app.api.routes.settings.get_homeassistant_settings",
  633. new_callable=AsyncMock,
  634. ) as mock_ha_settings,
  635. ):
  636. mock_get_client.return_value = mock_client
  637. mock_ha_settings.return_value = {
  638. "ha_url": "http://ha.local:8123",
  639. "ha_token": "token",
  640. "ha_enabled": True,
  641. }
  642. success, _ = await service._send_homeassistant({}, "Title", "Body", db=mock_db)
  643. assert success is True
  644. @pytest.mark.asyncio
  645. async def test_send_to_provider_dispatches_homeassistant(self, service):
  646. """Verify _send_to_provider dispatches to _send_homeassistant."""
  647. provider = MagicMock()
  648. provider.provider_type = "homeassistant"
  649. provider.config = "{}"
  650. provider.quiet_hours_enabled = False
  651. with patch.object(service, "_send_homeassistant", new_callable=AsyncMock) as mock_send:
  652. mock_send.return_value = (True, "OK")
  653. success, _ = await service._send_to_provider(provider, "Title", "Message", db=AsyncMock())
  654. assert success is True
  655. mock_send.assert_called_once()
  656. class TestNotificationVariableFallbacks:
  657. """Tests for notification variable fallback values."""
  658. @pytest.fixture
  659. def service(self):
  660. return NotificationService()
  661. def test_format_duration_with_valid_seconds(self, service):
  662. """Verify duration formats correctly with valid input."""
  663. result = service._format_duration(3661) # 1h 1m 1s
  664. assert "1h" in result
  665. def test_format_duration_with_none_returns_unknown(self, service):
  666. """CRITICAL: Verify None duration returns 'Unknown' fallback."""
  667. result = service._format_duration(None)
  668. assert result == "Unknown"
  669. def test_format_duration_with_zero(self, service):
  670. """Verify zero duration formats correctly."""
  671. result = service._format_duration(0)
  672. # Should return some valid string, not "Unknown"
  673. assert result is not None
  674. assert isinstance(result, str)
  675. def test_format_duration_hours_and_minutes(self, service):
  676. """Verify duration formats hours and minutes."""
  677. result = service._format_duration(5400) # 1h 30m
  678. assert "1h" in result
  679. assert "30m" in result
  680. def test_format_duration_minutes_only(self, service):
  681. """Verify duration formats minutes only when < 1 hour."""
  682. result = service._format_duration(1800) # 30m
  683. assert "30m" in result or "30" in result
  684. @pytest.mark.asyncio
  685. async def test_print_complete_fallback_values(self, service):
  686. """CRITICAL: Verify fallback values when archive_data is missing."""
  687. mock_db = AsyncMock()
  688. with (
  689. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  690. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  691. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  692. ):
  693. mock_get.return_value = [] # No providers, just testing variable setup
  694. mock_build.return_value = ("Test", "Test")
  695. await service.on_print_complete(
  696. printer_id=1,
  697. printer_name="Test",
  698. status="completed",
  699. data={"subtask_name": "test_print"},
  700. db=mock_db,
  701. archive_data=None, # No archive data - should use fallbacks
  702. )
  703. # Test passes if no exception is raised with missing archive_data
  704. @pytest.mark.asyncio
  705. async def test_print_complete_with_archive_data(self, service):
  706. """Verify archive data values are used when provided."""
  707. mock_db = AsyncMock()
  708. captured_variables = {}
  709. async def capture_build(db, event_type, variables):
  710. captured_variables.update(variables)
  711. return ("Test", "Test")
  712. with (
  713. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  714. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  715. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  716. ):
  717. mock_get.return_value = []
  718. await service.on_print_complete(
  719. printer_id=1,
  720. printer_name="Test",
  721. status="completed",
  722. data={"subtask_name": "test_print"},
  723. db=mock_db,
  724. archive_data={
  725. "print_time_seconds": 3600,
  726. "actual_filament_grams": 50.5,
  727. },
  728. )
  729. # When archive data is provided, duration should not be "Unknown"
  730. if captured_variables.get("duration"):
  731. assert captured_variables["duration"] != "Unknown"
  732. @pytest.mark.asyncio
  733. async def test_print_complete_with_finish_photo_url(self, service):
  734. """Verify finish_photo_url is passed through from archive_data."""
  735. mock_db = AsyncMock()
  736. mock_provider = MagicMock()
  737. mock_provider.id = 1
  738. captured_variables = {}
  739. async def capture_build(db, event_type, variables):
  740. captured_variables.update(variables)
  741. return ("Test", "Test")
  742. with (
  743. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  744. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  745. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  746. ):
  747. mock_get.return_value = [mock_provider]
  748. await service.on_print_complete(
  749. printer_id=1,
  750. printer_name="Test",
  751. status="completed",
  752. data={"subtask_name": "test_print"},
  753. db=mock_db,
  754. archive_data={
  755. "print_time_seconds": 3600,
  756. "actual_filament_grams": 50.5,
  757. "finish_photo_url": "http://localhost:8000/api/v1/archives/1/photos/finish_test.jpg",
  758. },
  759. )
  760. # finish_photo_url should be passed through to template variables
  761. assert (
  762. captured_variables.get("finish_photo_url")
  763. == "http://localhost:8000/api/v1/archives/1/photos/finish_test.jpg"
  764. )
  765. @pytest.mark.asyncio
  766. async def test_print_start_estimated_time_fallback(self, service):
  767. """Verify estimated time shows 'Unknown' when not available."""
  768. mock_db = AsyncMock()
  769. mock_provider = MagicMock()
  770. mock_provider.id = 1
  771. captured_variables = {}
  772. async def capture_build(db, event_type, variables):
  773. captured_variables.update(variables)
  774. return ("Test", "Test")
  775. with (
  776. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  777. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  778. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  779. patch("backend.app.api.routes.settings.get_setting", new_callable=AsyncMock, return_value=None),
  780. ):
  781. # Need at least one provider to trigger message building
  782. mock_get.return_value = [mock_provider]
  783. await service.on_print_start(
  784. printer_id=1,
  785. printer_name="Test",
  786. data={
  787. "subtask_name": "test",
  788. # No estimated_time or mc_remaining_time
  789. },
  790. db=mock_db,
  791. )
  792. # When no time data, should show "Unknown"
  793. assert captured_variables.get("estimated_time") == "Unknown"
  794. @pytest.mark.asyncio
  795. async def test_print_progress_remaining_time_fallback(self, service):
  796. """Verify remaining time shows 'Unknown' when not available."""
  797. mock_db = AsyncMock()
  798. mock_provider = MagicMock()
  799. mock_provider.id = 1
  800. captured_variables = {}
  801. async def capture_build(db, event_type, variables):
  802. captured_variables.update(variables)
  803. return ("Test", "Test")
  804. with (
  805. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  806. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  807. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  808. patch("backend.app.api.routes.settings.get_setting", new_callable=AsyncMock, return_value=None),
  809. ):
  810. # Need at least one provider to trigger message building
  811. mock_get.return_value = [mock_provider]
  812. await service.on_print_progress(
  813. printer_id=1,
  814. printer_name="Test",
  815. progress=50,
  816. remaining_time=None, # No remaining time
  817. filename="test.3mf",
  818. db=mock_db,
  819. )
  820. # When no remaining time, should show "Unknown"
  821. assert captured_variables.get("remaining_time") == "Unknown"
  822. @pytest.mark.asyncio
  823. async def test_filename_fallback_to_unknown(self, service):
  824. """Verify filename defaults to 'Unknown' when not provided."""
  825. mock_db = AsyncMock()
  826. mock_provider = MagicMock()
  827. mock_provider.id = 1
  828. captured_variables = {}
  829. async def capture_build(db, event_type, variables):
  830. captured_variables.update(variables)
  831. return ("Test", "Test")
  832. with (
  833. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  834. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  835. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  836. ):
  837. # Need at least one provider to trigger message building
  838. mock_get.return_value = [mock_provider]
  839. await service.on_print_complete(
  840. printer_id=1,
  841. printer_name="Test",
  842. status="completed",
  843. data={}, # No subtask_name or filename
  844. db=mock_db,
  845. )
  846. # Filename should default to something (either "Unknown" or cleaned empty)
  847. assert "filename" in captured_variables
  848. @pytest.mark.asyncio
  849. async def test_print_start_uses_archive_print_time_seconds(self, service):
  850. """Verify print_time_seconds from archive_data is used for estimated_time."""
  851. mock_db = AsyncMock()
  852. mock_provider = MagicMock()
  853. mock_provider.id = 1
  854. captured_variables = {}
  855. async def capture_build(db, event_type, variables):
  856. captured_variables.update(variables)
  857. return ("Test", "Test")
  858. with (
  859. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  860. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  861. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  862. patch("backend.app.api.routes.settings.get_setting", new_callable=AsyncMock, return_value=None),
  863. ):
  864. mock_get.return_value = [mock_provider]
  865. # Pass archive_data with print_time_seconds (7200 seconds = 2 hours)
  866. await service.on_print_start(
  867. printer_id=1,
  868. printer_name="Test",
  869. data={"subtask_name": "test"},
  870. db=mock_db,
  871. archive_data={"print_time_seconds": 7200},
  872. )
  873. # Should use archive's print_time_seconds: 7200 seconds = 2h 0m
  874. assert captured_variables.get("estimated_time") == "2h 0m"
  875. @pytest.mark.asyncio
  876. async def test_print_start_archive_data_overrides_mqtt(self, service):
  877. """Verify archive_data takes priority over MQTT remaining_time."""
  878. mock_db = AsyncMock()
  879. mock_provider = MagicMock()
  880. mock_provider.id = 1
  881. captured_variables = {}
  882. async def capture_build(db, event_type, variables):
  883. captured_variables.update(variables)
  884. return ("Test", "Test")
  885. with (
  886. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  887. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  888. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  889. patch("backend.app.api.routes.settings.get_setting", new_callable=AsyncMock, return_value=None),
  890. ):
  891. mock_get.return_value = [mock_provider]
  892. # Both archive_data and MQTT remaining_time provided
  893. # Archive says 2 hours, MQTT says 30 minutes (wrong at start)
  894. await service.on_print_start(
  895. printer_id=1,
  896. printer_name="Test",
  897. data={
  898. "subtask_name": "test",
  899. "remaining_time": 1800, # 30 minutes from MQTT
  900. },
  901. db=mock_db,
  902. archive_data={"print_time_seconds": 7200}, # 2 hours from 3MF
  903. )
  904. # Should use archive's print_time_seconds (more reliable)
  905. assert captured_variables.get("estimated_time") == "2h 0m"
  906. @pytest.mark.asyncio
  907. async def test_print_start_falls_back_to_mqtt_when_no_archive(self, service):
  908. """Verify MQTT remaining_time is used when archive_data not provided."""
  909. mock_db = AsyncMock()
  910. mock_provider = MagicMock()
  911. mock_provider.id = 1
  912. captured_variables = {}
  913. async def capture_build(db, event_type, variables):
  914. captured_variables.update(variables)
  915. return ("Test", "Test")
  916. with (
  917. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  918. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  919. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  920. patch("backend.app.api.routes.settings.get_setting", new_callable=AsyncMock, return_value=None),
  921. ):
  922. mock_get.return_value = [mock_provider]
  923. # Only MQTT remaining_time provided (1800 seconds = 30 minutes)
  924. await service.on_print_start(
  925. printer_id=1,
  926. printer_name="Test",
  927. data={
  928. "subtask_name": "test",
  929. "remaining_time": 1800,
  930. },
  931. db=mock_db,
  932. # No archive_data
  933. )
  934. # Should use MQTT remaining_time
  935. assert captured_variables.get("estimated_time") == "30m"
  936. @pytest.mark.asyncio
  937. async def test_print_start_eta_calculated_from_estimated_time(self, service):
  938. """Verify ETA is calculated as wall-clock time from estimated_time."""
  939. mock_db = AsyncMock()
  940. mock_provider = MagicMock()
  941. mock_provider.id = 1
  942. captured_variables = {}
  943. async def capture_build(db, event_type, variables):
  944. captured_variables.update(variables)
  945. return ("Test", "Test")
  946. with (
  947. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  948. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  949. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  950. patch("backend.app.api.routes.settings.get_setting", new_callable=AsyncMock, return_value=None),
  951. ):
  952. mock_get.return_value = [mock_provider]
  953. await service.on_print_start(
  954. printer_id=1,
  955. printer_name="Test",
  956. data={"subtask_name": "test"},
  957. db=mock_db,
  958. archive_data={"print_time_seconds": 3600}, # 1 hour
  959. )
  960. # ETA should be a time string in HH:MM format
  961. eta = captured_variables.get("eta")
  962. assert eta is not None
  963. assert eta != "Unknown"
  964. assert ":" in eta # HH:MM format
  965. @pytest.mark.asyncio
  966. async def test_print_start_eta_unknown_when_no_time(self, service):
  967. """Verify ETA shows 'Unknown' when no time data available."""
  968. mock_db = AsyncMock()
  969. mock_provider = MagicMock()
  970. mock_provider.id = 1
  971. captured_variables = {}
  972. async def capture_build(db, event_type, variables):
  973. captured_variables.update(variables)
  974. return ("Test", "Test")
  975. with (
  976. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  977. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  978. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  979. patch("backend.app.api.routes.settings.get_setting", new_callable=AsyncMock, return_value=None),
  980. ):
  981. mock_get.return_value = [mock_provider]
  982. await service.on_print_start(
  983. printer_id=1,
  984. printer_name="Test",
  985. data={"subtask_name": "test"},
  986. db=mock_db,
  987. )
  988. assert captured_variables.get("eta") == "Unknown"
  989. @pytest.mark.asyncio
  990. async def test_print_start_eta_respects_12h_format(self, service):
  991. """Verify ETA uses 12-hour format when time_format is '12h'."""
  992. mock_db = AsyncMock()
  993. mock_provider = MagicMock()
  994. mock_provider.id = 1
  995. captured_variables = {}
  996. async def capture_build(db, event_type, variables):
  997. captured_variables.update(variables)
  998. return ("Test", "Test")
  999. with (
  1000. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1001. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1002. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1003. patch("backend.app.api.routes.settings.get_setting", new_callable=AsyncMock, return_value="12h"),
  1004. ):
  1005. mock_get.return_value = [mock_provider]
  1006. await service.on_print_start(
  1007. printer_id=1,
  1008. printer_name="Test",
  1009. data={"subtask_name": "test"},
  1010. db=mock_db,
  1011. archive_data={"print_time_seconds": 3600},
  1012. )
  1013. eta = captured_variables.get("eta")
  1014. assert eta is not None
  1015. # 12h format should contain AM or PM
  1016. assert "AM" in eta or "PM" in eta
  1017. class TestNotificationTemplates:
  1018. """Tests for notification message template rendering."""
  1019. @pytest.fixture
  1020. def service(self):
  1021. return NotificationService()
  1022. @pytest.mark.asyncio
  1023. async def test_template_renders_variables(self, service):
  1024. """Verify template variables are replaced correctly."""
  1025. template_title = "Print {progress}% Complete"
  1026. template_body = "{printer}: {filename}\nRemaining: {remaining_time}"
  1027. variables = {
  1028. "printer": "Test Printer",
  1029. "filename": "test.3mf",
  1030. "progress": "50",
  1031. "remaining_time": "1h 30m",
  1032. }
  1033. title = template_title.format(**variables)
  1034. body = template_body.format(**variables)
  1035. assert title == "Print 50% Complete"
  1036. assert "Test Printer" in body
  1037. assert "test.3mf" in body
  1038. assert "1h 30m" in body
  1039. @pytest.mark.asyncio
  1040. async def test_template_handles_missing_variables(self, service):
  1041. """Verify missing template variables don't cause crashes."""
  1042. template = "{printer}: {unknown_var}"
  1043. variables = {"printer": "Test"}
  1044. # Should handle gracefully - either leave placeholder or skip
  1045. try:
  1046. result = template.format_map({**variables, "unknown_var": "{unknown_var}"})
  1047. assert "Test" in result
  1048. except KeyError:
  1049. pytest.fail("Template should handle missing variables gracefully")
  1050. class TestPrinterErrorNotifications:
  1051. """Tests for HMS error (printer error) notifications."""
  1052. @pytest.fixture
  1053. def service(self):
  1054. return NotificationService()
  1055. @pytest.fixture
  1056. def mock_provider(self):
  1057. """Create a mock notification provider with error notifications enabled."""
  1058. provider = MagicMock()
  1059. provider.id = 1
  1060. provider.name = "Test Provider"
  1061. provider.provider_type = "webhook"
  1062. provider.enabled = True
  1063. provider.config = json.dumps({"webhook_url": "http://test.local/webhook"})
  1064. provider.on_printer_error = True # Enable error notifications
  1065. provider.quiet_hours_enabled = False
  1066. provider.daily_digest_enabled = False
  1067. provider.printer_id = None
  1068. return provider
  1069. @pytest.fixture
  1070. def mock_db(self):
  1071. """Create a mock database session."""
  1072. db = AsyncMock()
  1073. db.commit = AsyncMock()
  1074. return db
  1075. @pytest.mark.asyncio
  1076. async def test_on_printer_error_sends_notification(self, service, mock_provider, mock_db):
  1077. """Verify HMS error notification is sent when triggered."""
  1078. with (
  1079. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1080. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  1081. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  1082. ):
  1083. mock_get.return_value = [mock_provider]
  1084. mock_build.return_value = ("Printer Error", "AMS/Filament Error: 0700_8010")
  1085. await service.on_printer_error(
  1086. printer_id=1,
  1087. printer_name="Test Printer",
  1088. error_type="AMS/Filament Error",
  1089. db=mock_db,
  1090. error_detail="Error code: 0700_8010",
  1091. )
  1092. mock_get.assert_called_once()
  1093. mock_send.assert_called_once()
  1094. @pytest.mark.asyncio
  1095. async def test_on_printer_error_skipped_when_disabled(self, service, mock_provider, mock_db):
  1096. """CRITICAL: Verify error notifications respect toggle setting."""
  1097. mock_provider.on_printer_error = False
  1098. with (
  1099. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1100. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  1101. ):
  1102. # Provider with toggle disabled won't be returned
  1103. mock_get.return_value = []
  1104. await service.on_printer_error(
  1105. printer_id=1,
  1106. printer_name="Test",
  1107. error_type="AMS Error",
  1108. db=mock_db,
  1109. error_detail="Test error",
  1110. )
  1111. mock_send.assert_not_called()
  1112. @pytest.mark.asyncio
  1113. async def test_on_printer_error_includes_error_detail(self, service, mock_provider, mock_db):
  1114. """Verify error details are passed to template variables."""
  1115. captured_variables = {}
  1116. async def capture_build(db, event_type, variables):
  1117. captured_variables.update(variables)
  1118. return ("Test", "Test")
  1119. with (
  1120. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1121. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1122. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1123. ):
  1124. mock_get.return_value = [mock_provider]
  1125. await service.on_printer_error(
  1126. printer_id=1,
  1127. printer_name="X1 Carbon",
  1128. error_type="AMS/Filament Error",
  1129. db=mock_db,
  1130. error_detail="Error code: 0700_8010",
  1131. )
  1132. assert captured_variables["printer"] == "X1 Carbon"
  1133. assert captured_variables["error_type"] == "AMS/Filament Error"
  1134. assert captured_variables["error_detail"] == "Error code: 0700_8010"
  1135. @pytest.mark.asyncio
  1136. async def test_on_printer_error_fallback_when_no_detail(self, service, mock_provider, mock_db):
  1137. """Verify fallback message when error_detail is None."""
  1138. captured_variables = {}
  1139. async def capture_build(db, event_type, variables):
  1140. captured_variables.update(variables)
  1141. return ("Test", "Test")
  1142. with (
  1143. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1144. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1145. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1146. ):
  1147. mock_get.return_value = [mock_provider]
  1148. await service.on_printer_error(
  1149. printer_id=1,
  1150. printer_name="Test Printer",
  1151. error_type="Unknown Error",
  1152. db=mock_db,
  1153. error_detail=None, # No detail provided
  1154. )
  1155. assert captured_variables["error_detail"] == "No details available"
  1156. class TestPlateNotEmptyNotifications:
  1157. """Tests for plate not empty (build plate detection) notifications."""
  1158. @pytest.fixture
  1159. def service(self):
  1160. return NotificationService()
  1161. @pytest.fixture
  1162. def mock_provider(self):
  1163. """Create a mock notification provider with plate detection enabled."""
  1164. provider = MagicMock()
  1165. provider.id = 1
  1166. provider.name = "Test Provider"
  1167. provider.provider_type = "webhook"
  1168. provider.enabled = True
  1169. provider.config = json.dumps({"webhook_url": "http://test.local/webhook"})
  1170. provider.on_plate_not_empty = True
  1171. provider.quiet_hours_enabled = False
  1172. provider.daily_digest_enabled = False
  1173. provider.printer_id = None
  1174. return provider
  1175. @pytest.fixture
  1176. def mock_db(self):
  1177. """Create a mock database session."""
  1178. db = AsyncMock()
  1179. db.commit = AsyncMock()
  1180. return db
  1181. @pytest.mark.asyncio
  1182. async def test_on_plate_not_empty_sends_notification(self, service, mock_provider, mock_db):
  1183. """Verify plate not empty notification is sent when triggered."""
  1184. with (
  1185. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1186. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  1187. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  1188. ):
  1189. mock_get.return_value = [mock_provider]
  1190. mock_build.return_value = ("Plate Not Empty", "Objects detected on build plate")
  1191. await service.on_plate_not_empty(
  1192. printer_id=1,
  1193. printer_name="Test Printer",
  1194. db=mock_db,
  1195. difference_percent=5.2,
  1196. )
  1197. mock_get.assert_called_once()
  1198. mock_send.assert_called_once()
  1199. # Verify force_immediate is True (critical alert)
  1200. call_kwargs = mock_send.call_args[1]
  1201. assert call_kwargs.get("force_immediate") is True
  1202. @pytest.mark.asyncio
  1203. async def test_on_plate_not_empty_skipped_when_disabled(self, service, mock_provider, mock_db):
  1204. """Verify notification is skipped when toggle is disabled."""
  1205. mock_provider.on_plate_not_empty = False
  1206. with (
  1207. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1208. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  1209. ):
  1210. mock_get.return_value = []
  1211. await service.on_plate_not_empty(
  1212. printer_id=1,
  1213. printer_name="Test",
  1214. db=mock_db,
  1215. )
  1216. mock_send.assert_not_called()
  1217. @pytest.mark.asyncio
  1218. async def test_on_plate_not_empty_includes_difference_percent(self, service, mock_provider, mock_db):
  1219. """Verify difference percentage is passed to template variables."""
  1220. captured_variables = {}
  1221. async def capture_build(db, event_type, variables):
  1222. captured_variables.update(variables)
  1223. return ("Test", "Test")
  1224. with (
  1225. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1226. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1227. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1228. ):
  1229. mock_get.return_value = [mock_provider]
  1230. await service.on_plate_not_empty(
  1231. printer_id=1,
  1232. printer_name="X1 Carbon",
  1233. db=mock_db,
  1234. difference_percent=3.5,
  1235. )
  1236. assert captured_variables["printer"] == "X1 Carbon"
  1237. assert captured_variables["difference_percent"] == "3.5"
  1238. class TestBedCooledNotifications:
  1239. """Tests for bed cooled (after print) notifications."""
  1240. @pytest.fixture
  1241. def service(self):
  1242. return NotificationService()
  1243. @pytest.fixture
  1244. def mock_provider(self):
  1245. """Create a mock notification provider with bed cooled enabled."""
  1246. provider = MagicMock()
  1247. provider.id = 1
  1248. provider.name = "Test Provider"
  1249. provider.provider_type = "webhook"
  1250. provider.enabled = True
  1251. provider.config = json.dumps({"webhook_url": "http://test.local/webhook"})
  1252. provider.on_bed_cooled = True
  1253. provider.quiet_hours_enabled = False
  1254. provider.daily_digest_enabled = False
  1255. provider.printer_id = None
  1256. return provider
  1257. @pytest.fixture
  1258. def mock_db(self):
  1259. """Create a mock database session."""
  1260. db = AsyncMock()
  1261. db.commit = AsyncMock()
  1262. return db
  1263. @pytest.mark.asyncio
  1264. async def test_on_bed_cooled_sends_notification(self, service, mock_provider, mock_db):
  1265. """Verify bed cooled notification is sent when triggered."""
  1266. with (
  1267. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1268. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  1269. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  1270. ):
  1271. mock_get.return_value = [mock_provider]
  1272. mock_build.return_value = ("Bed Cooled", "Test Printer: Bed cooled to 30°C")
  1273. await service.on_bed_cooled(
  1274. printer_id=1,
  1275. printer_name="Test Printer",
  1276. bed_temp=30.0,
  1277. threshold=35.0,
  1278. filename="benchy.3mf",
  1279. db=mock_db,
  1280. )
  1281. mock_get.assert_called_once()
  1282. mock_send.assert_called_once()
  1283. @pytest.mark.asyncio
  1284. async def test_on_bed_cooled_skipped_when_no_providers(self, service, mock_db):
  1285. """Verify notification is skipped when no providers have bed cooled enabled."""
  1286. with (
  1287. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1288. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  1289. ):
  1290. mock_get.return_value = []
  1291. await service.on_bed_cooled(
  1292. printer_id=1,
  1293. printer_name="Test Printer",
  1294. bed_temp=30.0,
  1295. threshold=35.0,
  1296. filename="benchy.3mf",
  1297. db=mock_db,
  1298. )
  1299. mock_send.assert_not_called()
  1300. @pytest.mark.asyncio
  1301. async def test_on_bed_cooled_includes_correct_variables(self, service, mock_provider, mock_db):
  1302. """Verify bed temp, threshold, and filename are passed to template variables."""
  1303. captured_variables = {}
  1304. async def capture_build(db, event_type, variables):
  1305. captured_variables.update(variables)
  1306. return ("Test", "Test")
  1307. with (
  1308. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1309. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1310. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1311. ):
  1312. mock_get.return_value = [mock_provider]
  1313. await service.on_bed_cooled(
  1314. printer_id=1,
  1315. printer_name="X1 Carbon",
  1316. bed_temp=28.7,
  1317. threshold=35.0,
  1318. filename="benchy.gcode.3mf",
  1319. db=mock_db,
  1320. )
  1321. assert captured_variables["printer"] == "X1 Carbon"
  1322. assert captured_variables["bed_temp"] == "29"
  1323. assert captured_variables["threshold"] == "35"
  1324. assert captured_variables["filename"] == "benchy"
  1325. @pytest.mark.asyncio
  1326. async def test_on_bed_cooled_handles_none_filename(self, service, mock_provider, mock_db):
  1327. """Verify None filename is handled gracefully."""
  1328. captured_variables = {}
  1329. async def capture_build(db, event_type, variables):
  1330. captured_variables.update(variables)
  1331. return ("Test", "Test")
  1332. with (
  1333. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1334. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1335. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1336. ):
  1337. mock_get.return_value = [mock_provider]
  1338. await service.on_bed_cooled(
  1339. printer_id=1,
  1340. printer_name="Test Printer",
  1341. bed_temp=30.0,
  1342. threshold=35.0,
  1343. filename=None,
  1344. db=mock_db,
  1345. )
  1346. assert captured_variables["filename"] == "Unknown"
  1347. class TestFirstLayerCompleteNotifications:
  1348. """Tests for first layer complete notifications."""
  1349. @pytest.fixture
  1350. def service(self):
  1351. return NotificationService()
  1352. @pytest.fixture
  1353. def mock_provider(self):
  1354. """Create a mock notification provider with first layer complete enabled."""
  1355. provider = MagicMock()
  1356. provider.id = 1
  1357. provider.name = "Test Provider"
  1358. provider.provider_type = "webhook"
  1359. provider.enabled = True
  1360. provider.config = json.dumps({"webhook_url": "http://test.local/webhook"})
  1361. provider.on_first_layer_complete = True
  1362. provider.quiet_hours_enabled = False
  1363. provider.daily_digest_enabled = False
  1364. provider.printer_id = None
  1365. return provider
  1366. @pytest.fixture
  1367. def mock_db(self):
  1368. """Create a mock database session."""
  1369. db = AsyncMock()
  1370. db.commit = AsyncMock()
  1371. return db
  1372. @pytest.mark.asyncio
  1373. async def test_on_first_layer_complete_sends_notification(self, service, mock_provider, mock_db):
  1374. """Verify first layer complete notification is sent when triggered."""
  1375. with (
  1376. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1377. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  1378. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  1379. ):
  1380. mock_get.return_value = [mock_provider]
  1381. mock_build.return_value = ("First Layer Complete", "Test Printer: benchy.3mf")
  1382. await service.on_first_layer_complete(
  1383. printer_id=1,
  1384. printer_name="Test Printer",
  1385. filename="benchy.3mf",
  1386. total_layers=50,
  1387. db=mock_db,
  1388. )
  1389. mock_get.assert_called_once()
  1390. mock_send.assert_called_once()
  1391. @pytest.mark.asyncio
  1392. async def test_on_first_layer_complete_skipped_when_no_providers(self, service, mock_db):
  1393. """Verify notification is skipped when no providers have first layer complete enabled."""
  1394. with (
  1395. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1396. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  1397. ):
  1398. mock_get.return_value = []
  1399. await service.on_first_layer_complete(
  1400. printer_id=1,
  1401. printer_name="Test Printer",
  1402. filename="benchy.3mf",
  1403. total_layers=50,
  1404. db=mock_db,
  1405. )
  1406. mock_send.assert_not_called()
  1407. @pytest.mark.asyncio
  1408. async def test_on_first_layer_complete_includes_correct_variables(self, service, mock_provider, mock_db):
  1409. """Verify printer name, filename, and total_layers are passed to template variables."""
  1410. captured_variables = {}
  1411. async def capture_build(db, event_type, variables):
  1412. captured_variables.update(variables)
  1413. return ("Test", "Test")
  1414. with (
  1415. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1416. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1417. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1418. ):
  1419. mock_get.return_value = [mock_provider]
  1420. await service.on_first_layer_complete(
  1421. printer_id=1,
  1422. printer_name="X1 Carbon",
  1423. filename="benchy.gcode.3mf",
  1424. total_layers=120,
  1425. db=mock_db,
  1426. )
  1427. assert captured_variables["printer"] == "X1 Carbon"
  1428. assert captured_variables["filename"] == "benchy"
  1429. assert captured_variables["total_layers"] == "120"
  1430. @pytest.mark.asyncio
  1431. async def test_on_first_layer_complete_passes_image_data(self, service, mock_provider, mock_db):
  1432. """Verify image_data is passed through to _send_to_providers."""
  1433. with (
  1434. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1435. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  1436. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  1437. ):
  1438. mock_get.return_value = [mock_provider]
  1439. mock_build.return_value = ("First Layer Complete", "Test message")
  1440. fake_image = b"\x89PNG\r\n\x1a\nfakeimage"
  1441. await service.on_first_layer_complete(
  1442. printer_id=1,
  1443. printer_name="Test Printer",
  1444. filename="benchy.3mf",
  1445. total_layers=50,
  1446. db=mock_db,
  1447. image_data=fake_image,
  1448. )
  1449. mock_send.assert_called_once()
  1450. call_kwargs = mock_send.call_args
  1451. assert call_kwargs.kwargs.get("image_data") == fake_image