test_notification_service.py 61 KB

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