test_notification_service.py 79 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007
  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 TestNtfyPriority:
  541. """Per-event ntfy Priority header (#990)."""
  542. @pytest.fixture
  543. def service(self):
  544. return NotificationService()
  545. @staticmethod
  546. def _mock_client(service):
  547. """Patch _get_client and return the mock client + 200 response."""
  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_client.put = AsyncMock(return_value=mock_response)
  553. return mock_client
  554. @pytest.mark.asyncio
  555. async def test_priority_header_set_for_mapped_event(self, service):
  556. """Mapped event → ntfy Priority header carries the configured value."""
  557. config = {
  558. "topic": "bambuddy",
  559. "event_priorities": {"on_print_failed": 5, "on_print_complete": 2},
  560. }
  561. mock_client = self._mock_client(service)
  562. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get:
  563. mock_get.return_value = mock_client
  564. success, _ = await service._send_ntfy(config, "Title", "Body", event_type="on_print_failed")
  565. assert success is True
  566. headers = mock_client.post.call_args.kwargs["headers"]
  567. assert headers.get("Priority") == "5"
  568. @pytest.mark.asyncio
  569. async def test_priority_header_omitted_for_unmapped_event(self, service):
  570. """Unmapped event → no Priority header so ntfy uses its server default."""
  571. config = {
  572. "topic": "bambuddy",
  573. "event_priorities": {"on_print_failed": 5},
  574. }
  575. mock_client = self._mock_client(service)
  576. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get:
  577. mock_get.return_value = mock_client
  578. await service._send_ntfy(config, "Title", "Body", event_type="on_print_complete")
  579. headers = mock_client.post.call_args.kwargs["headers"]
  580. assert "Priority" not in headers
  581. @pytest.mark.asyncio
  582. async def test_priority_header_omitted_when_no_priorities_set(self, service):
  583. """Existing setups (no event_priorities key) keep current behaviour."""
  584. config = {"topic": "bambuddy"}
  585. mock_client = self._mock_client(service)
  586. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get:
  587. mock_get.return_value = mock_client
  588. await service._send_ntfy(config, "Title", "Body", event_type="on_print_failed")
  589. headers = mock_client.post.call_args.kwargs["headers"]
  590. assert "Priority" not in headers
  591. @pytest.mark.asyncio
  592. async def test_priority_header_omitted_when_event_type_missing(self, service):
  593. """Test sends (no event_type) must not emit a Priority header."""
  594. config = {
  595. "topic": "bambuddy",
  596. "event_priorities": {"on_print_failed": 5},
  597. }
  598. mock_client = self._mock_client(service)
  599. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get:
  600. mock_get.return_value = mock_client
  601. await service._send_ntfy(config, "Title", "Body")
  602. headers = mock_client.post.call_args.kwargs["headers"]
  603. assert "Priority" not in headers
  604. @pytest.mark.asyncio
  605. async def test_priority_out_of_range_is_ignored(self, service):
  606. """Values outside 1-5 (or non-numeric) are dropped, not clamped."""
  607. for bad in (0, 6, 99, -1, "not-a-number", None):
  608. config = {
  609. "topic": "bambuddy",
  610. "event_priorities": {"on_print_failed": bad},
  611. }
  612. mock_client = self._mock_client(service)
  613. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get:
  614. mock_get.return_value = mock_client
  615. await service._send_ntfy(config, "Title", "Body", event_type="on_print_failed")
  616. headers = mock_client.post.call_args.kwargs["headers"]
  617. assert "Priority" not in headers, f"unexpected header for bad value {bad!r}"
  618. @pytest.mark.asyncio
  619. async def test_priority_header_set_on_attachment_path(self, service):
  620. """Image-attachment path (PUT) must also carry the Priority header."""
  621. config = {
  622. "topic": "bambuddy",
  623. "event_priorities": {"on_first_layer_complete": 4},
  624. }
  625. mock_client = self._mock_client(service)
  626. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get:
  627. mock_get.return_value = mock_client
  628. await service._send_ntfy(
  629. config,
  630. "Title",
  631. "Body",
  632. image_data=b"\xff\xd8\xff\xe0fake-jpeg",
  633. event_type="on_first_layer_complete",
  634. )
  635. headers = mock_client.put.call_args.kwargs["headers"]
  636. assert headers.get("Priority") == "4"
  637. class TestHomeAssistantProvider:
  638. """Tests for Home Assistant notification provider."""
  639. @pytest.fixture
  640. def service(self):
  641. return NotificationService()
  642. @pytest.mark.asyncio
  643. async def test_send_homeassistant_success(self, service):
  644. """Verify HA provider sends persistent notification to correct endpoint."""
  645. mock_response = MagicMock()
  646. mock_response.status_code = 200
  647. mock_client = AsyncMock()
  648. mock_client.post = AsyncMock(return_value=mock_response)
  649. mock_db = AsyncMock()
  650. with (
  651. patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client,
  652. patch(
  653. "backend.app.api.routes.settings.get_homeassistant_settings",
  654. new_callable=AsyncMock,
  655. ) as mock_ha_settings,
  656. ):
  657. mock_get_client.return_value = mock_client
  658. mock_ha_settings.return_value = {
  659. "ha_url": "http://ha.local:8123",
  660. "ha_token": "test-token-123",
  661. "ha_enabled": True,
  662. }
  663. success, message = await service._send_homeassistant({}, "Test Title", "Test Message", db=mock_db)
  664. assert success is True
  665. mock_client.post.assert_called_once()
  666. call_args = mock_client.post.call_args
  667. assert call_args[0][0] == "http://ha.local:8123/api/services/persistent_notification/create"
  668. payload = call_args.kwargs.get("json") or call_args[1].get("json")
  669. assert payload["title"] == "Test Title"
  670. assert payload["message"] == "Test Message"
  671. @pytest.mark.asyncio
  672. async def test_send_homeassistant_no_db_no_env(self, service):
  673. """Verify HA provider fails gracefully without DB or env vars."""
  674. with patch.dict("os.environ", {}, clear=True):
  675. success, message = await service._send_homeassistant({}, "Test", "Test", db=None)
  676. assert success is False
  677. assert "not configured" in message.lower()
  678. @pytest.mark.asyncio
  679. async def test_send_homeassistant_auth_failure(self, service):
  680. """Verify HA provider reports auth failure."""
  681. mock_response = MagicMock()
  682. mock_response.status_code = 401
  683. mock_client = AsyncMock()
  684. mock_client.post = AsyncMock(return_value=mock_response)
  685. mock_db = AsyncMock()
  686. with (
  687. patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client,
  688. patch(
  689. "backend.app.api.routes.settings.get_homeassistant_settings",
  690. new_callable=AsyncMock,
  691. ) as mock_ha_settings,
  692. ):
  693. mock_get_client.return_value = mock_client
  694. mock_ha_settings.return_value = {
  695. "ha_url": "http://ha.local:8123",
  696. "ha_token": "bad-token",
  697. "ha_enabled": True,
  698. }
  699. success, message = await service._send_homeassistant({}, "Test", "Test", db=mock_db)
  700. assert success is False
  701. assert "authentication" in message.lower()
  702. @pytest.mark.asyncio
  703. async def test_send_homeassistant_env_fallback(self, service):
  704. """Verify HA provider falls back to env vars when no DB session."""
  705. mock_response = MagicMock()
  706. mock_response.status_code = 200
  707. mock_client = AsyncMock()
  708. mock_client.post = AsyncMock(return_value=mock_response)
  709. with (
  710. patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client,
  711. patch.dict("os.environ", {"HA_URL": "http://env-ha:8123", "HA_TOKEN": "env-token"}),
  712. ):
  713. mock_get_client.return_value = mock_client
  714. success, message = await service._send_homeassistant({}, "Test", "Test", db=None)
  715. assert success is True
  716. call_args = mock_client.post.call_args
  717. assert "env-ha:8123" in call_args[0][0]
  718. @pytest.mark.asyncio
  719. async def test_send_homeassistant_empty_config_accepted(self, service):
  720. """Verify HA provider works with empty config dict (no fields needed)."""
  721. mock_response = MagicMock()
  722. mock_response.status_code = 200
  723. mock_client = AsyncMock()
  724. mock_client.post = AsyncMock(return_value=mock_response)
  725. mock_db = AsyncMock()
  726. with (
  727. patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client,
  728. patch(
  729. "backend.app.api.routes.settings.get_homeassistant_settings",
  730. new_callable=AsyncMock,
  731. ) as mock_ha_settings,
  732. ):
  733. mock_get_client.return_value = mock_client
  734. mock_ha_settings.return_value = {
  735. "ha_url": "http://ha.local:8123",
  736. "ha_token": "token",
  737. "ha_enabled": True,
  738. }
  739. success, _ = await service._send_homeassistant({}, "Title", "Body", db=mock_db)
  740. assert success is True
  741. @pytest.mark.asyncio
  742. async def test_send_to_provider_dispatches_homeassistant(self, service):
  743. """Verify _send_to_provider dispatches to _send_homeassistant."""
  744. provider = MagicMock()
  745. provider.provider_type = "homeassistant"
  746. provider.config = "{}"
  747. provider.quiet_hours_enabled = False
  748. with patch.object(service, "_send_homeassistant", new_callable=AsyncMock) as mock_send:
  749. mock_send.return_value = (True, "OK")
  750. success, _ = await service._send_to_provider(provider, "Title", "Message", db=AsyncMock())
  751. assert success is True
  752. mock_send.assert_called_once()
  753. class TestNotificationVariableFallbacks:
  754. """Tests for notification variable fallback values."""
  755. @pytest.fixture
  756. def service(self):
  757. return NotificationService()
  758. def test_format_duration_with_valid_seconds(self, service):
  759. """Verify duration formats correctly with valid input."""
  760. result = service._format_duration(3661) # 1h 1m 1s
  761. assert "1h" in result
  762. def test_format_duration_with_none_returns_unknown(self, service):
  763. """CRITICAL: Verify None duration returns 'Unknown' fallback."""
  764. result = service._format_duration(None)
  765. assert result == "Unknown"
  766. def test_format_duration_with_zero(self, service):
  767. """Verify zero duration formats correctly."""
  768. result = service._format_duration(0)
  769. # Should return some valid string, not "Unknown"
  770. assert result is not None
  771. assert isinstance(result, str)
  772. def test_format_duration_hours_and_minutes(self, service):
  773. """Verify duration formats hours and minutes."""
  774. result = service._format_duration(5400) # 1h 30m
  775. assert "1h" in result
  776. assert "30m" in result
  777. def test_format_duration_minutes_only(self, service):
  778. """Verify duration formats minutes only when < 1 hour."""
  779. result = service._format_duration(1800) # 30m
  780. assert "30m" in result or "30" in result
  781. @pytest.mark.asyncio
  782. async def test_print_complete_fallback_values(self, service):
  783. """CRITICAL: Verify fallback values when archive_data is missing."""
  784. mock_db = AsyncMock()
  785. with (
  786. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  787. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  788. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  789. ):
  790. mock_get.return_value = [] # No providers, just testing variable setup
  791. mock_build.return_value = ("Test", "Test")
  792. await service.on_print_complete(
  793. printer_id=1,
  794. printer_name="Test",
  795. status="completed",
  796. data={"subtask_name": "test_print"},
  797. db=mock_db,
  798. archive_data=None, # No archive data - should use fallbacks
  799. )
  800. # Test passes if no exception is raised with missing archive_data
  801. @pytest.mark.asyncio
  802. async def test_print_complete_with_archive_data(self, service):
  803. """Verify archive data values are used when provided."""
  804. mock_db = AsyncMock()
  805. captured_variables = {}
  806. async def capture_build(db, event_type, variables):
  807. captured_variables.update(variables)
  808. return ("Test", "Test")
  809. with (
  810. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  811. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  812. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  813. ):
  814. mock_get.return_value = []
  815. await service.on_print_complete(
  816. printer_id=1,
  817. printer_name="Test",
  818. status="completed",
  819. data={"subtask_name": "test_print"},
  820. db=mock_db,
  821. archive_data={
  822. "print_time_seconds": 3600,
  823. "actual_filament_grams": 50.5,
  824. },
  825. )
  826. # When archive data is provided, duration should not be "Unknown"
  827. if captured_variables.get("duration"):
  828. assert captured_variables["duration"] != "Unknown"
  829. @pytest.mark.asyncio
  830. async def test_duration_prefers_actual_time_seconds_over_slicer_estimate(self, service):
  831. """#1198: completion notification duration must reflect *actual* elapsed
  832. time from started_at/completed_at, not the slicer's pre-print estimate.
  833. Pre-fix the duration variable read from `print_time_seconds` (slicer
  834. estimate parsed from the 3MF at archive creation), so a print cancelled
  835. 2 minutes into a 3-hour estimate would notify "duration: 3h"."""
  836. mock_db = AsyncMock()
  837. mock_provider = MagicMock()
  838. mock_provider.id = 1
  839. captured_variables: dict = {}
  840. async def capture_build(db, event_type, variables):
  841. captured_variables.update(variables)
  842. return ("Test", "Test")
  843. with (
  844. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  845. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  846. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  847. ):
  848. mock_get.return_value = [mock_provider]
  849. await service.on_print_complete(
  850. printer_id=1,
  851. printer_name="Test",
  852. status="cancelled",
  853. data={"subtask_name": "test_print"},
  854. db=mock_db,
  855. archive_data={
  856. "print_time_seconds": 10800, # 3h slicer estimate
  857. "actual_time_seconds": 120, # 2m actual elapsed
  858. },
  859. )
  860. # 2 minutes — not 3 hours — even though the slicer estimate is in the dict.
  861. assert "2m" in captured_variables["duration"]
  862. assert "3h" not in captured_variables["duration"]
  863. @pytest.mark.asyncio
  864. async def test_duration_falls_back_to_slicer_estimate_when_actual_time_missing(self, service):
  865. """#1198: when actual_time_seconds is absent (e.g. timestamps weren't
  866. recorded for some reason), the duration variable falls back to
  867. print_time_seconds rather than rendering 'Unknown'. Preserves
  868. backwards-compat for any code path that didn't compute actual elapsed."""
  869. mock_db = AsyncMock()
  870. mock_provider = MagicMock()
  871. mock_provider.id = 1
  872. captured_variables: dict = {}
  873. async def capture_build(db, event_type, variables):
  874. captured_variables.update(variables)
  875. return ("Test", "Test")
  876. with (
  877. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  878. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  879. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  880. ):
  881. mock_get.return_value = [mock_provider]
  882. await service.on_print_complete(
  883. printer_id=1,
  884. printer_name="Test",
  885. status="completed",
  886. data={"subtask_name": "test_print"},
  887. db=mock_db,
  888. archive_data={
  889. "print_time_seconds": 3600, # 1h slicer estimate, no actual
  890. "actual_time_seconds": None,
  891. },
  892. )
  893. assert captured_variables["duration"] != "Unknown"
  894. assert "1h" in captured_variables["duration"]
  895. @pytest.mark.asyncio
  896. async def test_duration_unknown_when_both_time_fields_missing(self, service):
  897. """#1198: with neither actual nor estimated time available the duration
  898. variable surfaces the existing 'Unknown' fallback."""
  899. mock_db = AsyncMock()
  900. mock_provider = MagicMock()
  901. mock_provider.id = 1
  902. captured_variables: dict = {}
  903. async def capture_build(db, event_type, variables):
  904. captured_variables.update(variables)
  905. return ("Test", "Test")
  906. with (
  907. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  908. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  909. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  910. ):
  911. mock_get.return_value = [mock_provider]
  912. await service.on_print_complete(
  913. printer_id=1,
  914. printer_name="Test",
  915. status="completed",
  916. data={"subtask_name": "test_print"},
  917. db=mock_db,
  918. archive_data={
  919. "print_time_seconds": None,
  920. "actual_time_seconds": None,
  921. },
  922. )
  923. assert captured_variables["duration"] == "Unknown"
  924. @pytest.mark.asyncio
  925. async def test_print_complete_with_finish_photo_url(self, service):
  926. """Verify finish_photo_url is passed through from archive_data."""
  927. mock_db = AsyncMock()
  928. mock_provider = MagicMock()
  929. mock_provider.id = 1
  930. captured_variables = {}
  931. async def capture_build(db, event_type, variables):
  932. captured_variables.update(variables)
  933. return ("Test", "Test")
  934. with (
  935. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  936. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  937. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  938. ):
  939. mock_get.return_value = [mock_provider]
  940. await service.on_print_complete(
  941. printer_id=1,
  942. printer_name="Test",
  943. status="completed",
  944. data={"subtask_name": "test_print"},
  945. db=mock_db,
  946. archive_data={
  947. "print_time_seconds": 3600,
  948. "actual_filament_grams": 50.5,
  949. "finish_photo_url": "http://localhost:8000/api/v1/archives/1/photos/finish_test.jpg",
  950. },
  951. )
  952. # finish_photo_url should be passed through to template variables
  953. assert (
  954. captured_variables.get("finish_photo_url")
  955. == "http://localhost:8000/api/v1/archives/1/photos/finish_test.jpg"
  956. )
  957. @pytest.mark.asyncio
  958. async def test_print_start_estimated_time_fallback(self, service):
  959. """Verify estimated time shows 'Unknown' when not available."""
  960. mock_db = AsyncMock()
  961. mock_provider = MagicMock()
  962. mock_provider.id = 1
  963. captured_variables = {}
  964. async def capture_build(db, event_type, variables):
  965. captured_variables.update(variables)
  966. return ("Test", "Test")
  967. with (
  968. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  969. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  970. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  971. patch("backend.app.api.routes.settings.get_setting", new_callable=AsyncMock, return_value=None),
  972. ):
  973. # Need at least one provider to trigger message building
  974. mock_get.return_value = [mock_provider]
  975. await service.on_print_start(
  976. printer_id=1,
  977. printer_name="Test",
  978. data={
  979. "subtask_name": "test",
  980. # No estimated_time or mc_remaining_time
  981. },
  982. db=mock_db,
  983. )
  984. # When no time data, should show "Unknown"
  985. assert captured_variables.get("estimated_time") == "Unknown"
  986. @pytest.mark.asyncio
  987. async def test_print_progress_remaining_time_fallback(self, service):
  988. """Verify remaining time shows 'Unknown' when not available."""
  989. mock_db = AsyncMock()
  990. mock_provider = MagicMock()
  991. mock_provider.id = 1
  992. captured_variables = {}
  993. async def capture_build(db, event_type, variables):
  994. captured_variables.update(variables)
  995. return ("Test", "Test")
  996. with (
  997. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  998. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  999. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1000. patch("backend.app.api.routes.settings.get_setting", new_callable=AsyncMock, return_value=None),
  1001. ):
  1002. # Need at least one provider to trigger message building
  1003. mock_get.return_value = [mock_provider]
  1004. await service.on_print_progress(
  1005. printer_id=1,
  1006. printer_name="Test",
  1007. progress=50,
  1008. remaining_time=None, # No remaining time
  1009. filename="test.3mf",
  1010. db=mock_db,
  1011. )
  1012. # When no remaining time, should show "Unknown"
  1013. assert captured_variables.get("remaining_time") == "Unknown"
  1014. @pytest.mark.asyncio
  1015. async def test_filename_fallback_to_unknown(self, service):
  1016. """Verify filename defaults to 'Unknown' when not provided."""
  1017. mock_db = AsyncMock()
  1018. mock_provider = MagicMock()
  1019. mock_provider.id = 1
  1020. captured_variables = {}
  1021. async def capture_build(db, event_type, variables):
  1022. captured_variables.update(variables)
  1023. return ("Test", "Test")
  1024. with (
  1025. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1026. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1027. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1028. ):
  1029. # Need at least one provider to trigger message building
  1030. mock_get.return_value = [mock_provider]
  1031. await service.on_print_complete(
  1032. printer_id=1,
  1033. printer_name="Test",
  1034. status="completed",
  1035. data={}, # No subtask_name or filename
  1036. db=mock_db,
  1037. )
  1038. # Filename should default to something (either "Unknown" or cleaned empty)
  1039. assert "filename" in captured_variables
  1040. @pytest.mark.asyncio
  1041. async def test_print_start_uses_archive_print_time_seconds(self, service):
  1042. """Verify print_time_seconds from archive_data is used for estimated_time."""
  1043. mock_db = AsyncMock()
  1044. mock_provider = MagicMock()
  1045. mock_provider.id = 1
  1046. captured_variables = {}
  1047. async def capture_build(db, event_type, variables):
  1048. captured_variables.update(variables)
  1049. return ("Test", "Test")
  1050. with (
  1051. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1052. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1053. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1054. patch("backend.app.api.routes.settings.get_setting", new_callable=AsyncMock, return_value=None),
  1055. ):
  1056. mock_get.return_value = [mock_provider]
  1057. # Pass archive_data with print_time_seconds (7200 seconds = 2 hours)
  1058. await service.on_print_start(
  1059. printer_id=1,
  1060. printer_name="Test",
  1061. data={"subtask_name": "test"},
  1062. db=mock_db,
  1063. archive_data={"print_time_seconds": 7200},
  1064. )
  1065. # Should use archive's print_time_seconds: 7200 seconds = 2h 0m
  1066. assert captured_variables.get("estimated_time") == "2h 0m"
  1067. @pytest.mark.asyncio
  1068. async def test_print_start_archive_data_overrides_mqtt(self, service):
  1069. """Verify archive_data takes priority over MQTT remaining_time."""
  1070. mock_db = AsyncMock()
  1071. mock_provider = MagicMock()
  1072. mock_provider.id = 1
  1073. captured_variables = {}
  1074. async def capture_build(db, event_type, variables):
  1075. captured_variables.update(variables)
  1076. return ("Test", "Test")
  1077. with (
  1078. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1079. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1080. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1081. patch("backend.app.api.routes.settings.get_setting", new_callable=AsyncMock, return_value=None),
  1082. ):
  1083. mock_get.return_value = [mock_provider]
  1084. # Both archive_data and MQTT remaining_time provided
  1085. # Archive says 2 hours, MQTT says 30 minutes (wrong at start)
  1086. await service.on_print_start(
  1087. printer_id=1,
  1088. printer_name="Test",
  1089. data={
  1090. "subtask_name": "test",
  1091. "remaining_time": 1800, # 30 minutes from MQTT
  1092. },
  1093. db=mock_db,
  1094. archive_data={"print_time_seconds": 7200}, # 2 hours from 3MF
  1095. )
  1096. # Should use archive's print_time_seconds (more reliable)
  1097. assert captured_variables.get("estimated_time") == "2h 0m"
  1098. @pytest.mark.asyncio
  1099. async def test_print_start_falls_back_to_mqtt_when_no_archive(self, service):
  1100. """Verify MQTT remaining_time is used when archive_data not provided."""
  1101. mock_db = AsyncMock()
  1102. mock_provider = MagicMock()
  1103. mock_provider.id = 1
  1104. captured_variables = {}
  1105. async def capture_build(db, event_type, variables):
  1106. captured_variables.update(variables)
  1107. return ("Test", "Test")
  1108. with (
  1109. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1110. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1111. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1112. patch("backend.app.api.routes.settings.get_setting", new_callable=AsyncMock, return_value=None),
  1113. ):
  1114. mock_get.return_value = [mock_provider]
  1115. # Only MQTT remaining_time provided (1800 seconds = 30 minutes)
  1116. await service.on_print_start(
  1117. printer_id=1,
  1118. printer_name="Test",
  1119. data={
  1120. "subtask_name": "test",
  1121. "remaining_time": 1800,
  1122. },
  1123. db=mock_db,
  1124. # No archive_data
  1125. )
  1126. # Should use MQTT remaining_time
  1127. assert captured_variables.get("estimated_time") == "30m"
  1128. @pytest.mark.asyncio
  1129. async def test_print_start_eta_calculated_from_estimated_time(self, service):
  1130. """Verify ETA is calculated as wall-clock time from estimated_time."""
  1131. mock_db = AsyncMock()
  1132. mock_provider = MagicMock()
  1133. mock_provider.id = 1
  1134. captured_variables = {}
  1135. async def capture_build(db, event_type, variables):
  1136. captured_variables.update(variables)
  1137. return ("Test", "Test")
  1138. with (
  1139. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1140. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1141. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1142. patch("backend.app.api.routes.settings.get_setting", new_callable=AsyncMock, return_value=None),
  1143. ):
  1144. mock_get.return_value = [mock_provider]
  1145. await service.on_print_start(
  1146. printer_id=1,
  1147. printer_name="Test",
  1148. data={"subtask_name": "test"},
  1149. db=mock_db,
  1150. archive_data={"print_time_seconds": 3600}, # 1 hour
  1151. )
  1152. # ETA should be a time string in HH:MM format
  1153. eta = captured_variables.get("eta")
  1154. assert eta is not None
  1155. assert eta != "Unknown"
  1156. assert ":" in eta # HH:MM format
  1157. @pytest.mark.asyncio
  1158. async def test_print_start_eta_unknown_when_no_time(self, service):
  1159. """Verify ETA shows 'Unknown' when no time data available."""
  1160. mock_db = AsyncMock()
  1161. mock_provider = MagicMock()
  1162. mock_provider.id = 1
  1163. captured_variables = {}
  1164. async def capture_build(db, event_type, variables):
  1165. captured_variables.update(variables)
  1166. return ("Test", "Test")
  1167. with (
  1168. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1169. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1170. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1171. patch("backend.app.api.routes.settings.get_setting", new_callable=AsyncMock, return_value=None),
  1172. ):
  1173. mock_get.return_value = [mock_provider]
  1174. await service.on_print_start(
  1175. printer_id=1,
  1176. printer_name="Test",
  1177. data={"subtask_name": "test"},
  1178. db=mock_db,
  1179. )
  1180. assert captured_variables.get("eta") == "Unknown"
  1181. @pytest.mark.asyncio
  1182. async def test_print_start_eta_respects_12h_format(self, service):
  1183. """Verify ETA uses 12-hour format when time_format is '12h'."""
  1184. mock_db = AsyncMock()
  1185. mock_provider = MagicMock()
  1186. mock_provider.id = 1
  1187. captured_variables = {}
  1188. async def capture_build(db, event_type, variables):
  1189. captured_variables.update(variables)
  1190. return ("Test", "Test")
  1191. with (
  1192. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1193. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1194. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1195. patch("backend.app.api.routes.settings.get_setting", new_callable=AsyncMock, return_value="12h"),
  1196. ):
  1197. mock_get.return_value = [mock_provider]
  1198. await service.on_print_start(
  1199. printer_id=1,
  1200. printer_name="Test",
  1201. data={"subtask_name": "test"},
  1202. db=mock_db,
  1203. archive_data={"print_time_seconds": 3600},
  1204. )
  1205. eta = captured_variables.get("eta")
  1206. assert eta is not None
  1207. # 12h format should contain AM or PM
  1208. assert "AM" in eta or "PM" in eta
  1209. class TestNotificationTemplates:
  1210. """Tests for notification message template rendering."""
  1211. @pytest.fixture
  1212. def service(self):
  1213. return NotificationService()
  1214. @pytest.mark.asyncio
  1215. async def test_template_renders_variables(self, service):
  1216. """Verify template variables are replaced correctly."""
  1217. template_title = "Print {progress}% Complete"
  1218. template_body = "{printer}: {filename}\nRemaining: {remaining_time}"
  1219. variables = {
  1220. "printer": "Test Printer",
  1221. "filename": "test.3mf",
  1222. "progress": "50",
  1223. "remaining_time": "1h 30m",
  1224. }
  1225. title = template_title.format(**variables)
  1226. body = template_body.format(**variables)
  1227. assert title == "Print 50% Complete"
  1228. assert "Test Printer" in body
  1229. assert "test.3mf" in body
  1230. assert "1h 30m" in body
  1231. @pytest.mark.asyncio
  1232. async def test_template_handles_missing_variables(self, service):
  1233. """Verify missing template variables don't cause crashes."""
  1234. template = "{printer}: {unknown_var}"
  1235. variables = {"printer": "Test"}
  1236. # Should handle gracefully - either leave placeholder or skip
  1237. try:
  1238. result = template.format_map({**variables, "unknown_var": "{unknown_var}"})
  1239. assert "Test" in result
  1240. except KeyError:
  1241. pytest.fail("Template should handle missing variables gracefully")
  1242. class TestPrinterErrorNotifications:
  1243. """Tests for HMS error (printer error) notifications."""
  1244. @pytest.fixture
  1245. def service(self):
  1246. return NotificationService()
  1247. @pytest.fixture
  1248. def mock_provider(self):
  1249. """Create a mock notification provider with error notifications enabled."""
  1250. provider = MagicMock()
  1251. provider.id = 1
  1252. provider.name = "Test Provider"
  1253. provider.provider_type = "webhook"
  1254. provider.enabled = True
  1255. provider.config = json.dumps({"webhook_url": "http://test.local/webhook"})
  1256. provider.on_printer_error = True # Enable error notifications
  1257. provider.quiet_hours_enabled = False
  1258. provider.daily_digest_enabled = False
  1259. provider.printer_id = None
  1260. return provider
  1261. @pytest.fixture
  1262. def mock_db(self):
  1263. """Create a mock database session."""
  1264. db = AsyncMock()
  1265. db.commit = AsyncMock()
  1266. return db
  1267. @pytest.mark.asyncio
  1268. async def test_on_printer_error_sends_notification(self, service, mock_provider, mock_db):
  1269. """Verify HMS error notification is sent when triggered."""
  1270. with (
  1271. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1272. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  1273. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  1274. ):
  1275. mock_get.return_value = [mock_provider]
  1276. mock_build.return_value = ("Printer Error", "AMS/Filament Error: 0700_8010")
  1277. await service.on_printer_error(
  1278. printer_id=1,
  1279. printer_name="Test Printer",
  1280. error_type="AMS/Filament Error",
  1281. db=mock_db,
  1282. error_detail="Error code: 0700_8010",
  1283. )
  1284. mock_get.assert_called_once()
  1285. mock_send.assert_called_once()
  1286. @pytest.mark.asyncio
  1287. async def test_on_printer_error_skipped_when_disabled(self, service, mock_provider, mock_db):
  1288. """CRITICAL: Verify error notifications respect toggle setting."""
  1289. mock_provider.on_printer_error = False
  1290. with (
  1291. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1292. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  1293. ):
  1294. # Provider with toggle disabled won't be returned
  1295. mock_get.return_value = []
  1296. await service.on_printer_error(
  1297. printer_id=1,
  1298. printer_name="Test",
  1299. error_type="AMS Error",
  1300. db=mock_db,
  1301. error_detail="Test error",
  1302. )
  1303. mock_send.assert_not_called()
  1304. @pytest.mark.asyncio
  1305. async def test_on_printer_error_includes_error_detail(self, service, mock_provider, mock_db):
  1306. """Verify error details are passed to template variables."""
  1307. captured_variables = {}
  1308. async def capture_build(db, event_type, variables):
  1309. captured_variables.update(variables)
  1310. return ("Test", "Test")
  1311. with (
  1312. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1313. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1314. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1315. ):
  1316. mock_get.return_value = [mock_provider]
  1317. await service.on_printer_error(
  1318. printer_id=1,
  1319. printer_name="X1 Carbon",
  1320. error_type="AMS/Filament Error",
  1321. db=mock_db,
  1322. error_detail="Error code: 0700_8010",
  1323. )
  1324. assert captured_variables["printer"] == "X1 Carbon"
  1325. assert captured_variables["error_type"] == "AMS/Filament Error"
  1326. assert captured_variables["error_detail"] == "Error code: 0700_8010"
  1327. @pytest.mark.asyncio
  1328. async def test_on_printer_error_fallback_when_no_detail(self, service, mock_provider, mock_db):
  1329. """Verify fallback message when error_detail is None."""
  1330. captured_variables = {}
  1331. async def capture_build(db, event_type, variables):
  1332. captured_variables.update(variables)
  1333. return ("Test", "Test")
  1334. with (
  1335. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1336. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1337. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1338. ):
  1339. mock_get.return_value = [mock_provider]
  1340. await service.on_printer_error(
  1341. printer_id=1,
  1342. printer_name="Test Printer",
  1343. error_type="Unknown Error",
  1344. db=mock_db,
  1345. error_detail=None, # No detail provided
  1346. )
  1347. assert captured_variables["error_detail"] == "No details available"
  1348. class TestPlateNotEmptyNotifications:
  1349. """Tests for plate not empty (build plate detection) notifications."""
  1350. @pytest.fixture
  1351. def service(self):
  1352. return NotificationService()
  1353. @pytest.fixture
  1354. def mock_provider(self):
  1355. """Create a mock notification provider with plate detection enabled."""
  1356. provider = MagicMock()
  1357. provider.id = 1
  1358. provider.name = "Test Provider"
  1359. provider.provider_type = "webhook"
  1360. provider.enabled = True
  1361. provider.config = json.dumps({"webhook_url": "http://test.local/webhook"})
  1362. provider.on_plate_not_empty = True
  1363. provider.quiet_hours_enabled = False
  1364. provider.daily_digest_enabled = False
  1365. provider.printer_id = None
  1366. return provider
  1367. @pytest.fixture
  1368. def mock_db(self):
  1369. """Create a mock database session."""
  1370. db = AsyncMock()
  1371. db.commit = AsyncMock()
  1372. return db
  1373. @pytest.mark.asyncio
  1374. async def test_on_plate_not_empty_sends_notification(self, service, mock_provider, mock_db):
  1375. """Verify plate not empty notification is sent when triggered."""
  1376. with (
  1377. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1378. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  1379. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  1380. ):
  1381. mock_get.return_value = [mock_provider]
  1382. mock_build.return_value = ("Plate Not Empty", "Objects detected on build plate")
  1383. await service.on_plate_not_empty(
  1384. printer_id=1,
  1385. printer_name="Test Printer",
  1386. db=mock_db,
  1387. difference_percent=5.2,
  1388. )
  1389. mock_get.assert_called_once()
  1390. mock_send.assert_called_once()
  1391. # Verify force_immediate is True (critical alert)
  1392. call_kwargs = mock_send.call_args[1]
  1393. assert call_kwargs.get("force_immediate") is True
  1394. @pytest.mark.asyncio
  1395. async def test_on_plate_not_empty_skipped_when_disabled(self, service, mock_provider, mock_db):
  1396. """Verify notification is skipped when toggle is disabled."""
  1397. mock_provider.on_plate_not_empty = False
  1398. with (
  1399. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1400. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  1401. ):
  1402. mock_get.return_value = []
  1403. await service.on_plate_not_empty(
  1404. printer_id=1,
  1405. printer_name="Test",
  1406. db=mock_db,
  1407. )
  1408. mock_send.assert_not_called()
  1409. @pytest.mark.asyncio
  1410. async def test_on_plate_not_empty_includes_difference_percent(self, service, mock_provider, mock_db):
  1411. """Verify difference percentage is passed to template variables."""
  1412. captured_variables = {}
  1413. async def capture_build(db, event_type, variables):
  1414. captured_variables.update(variables)
  1415. return ("Test", "Test")
  1416. with (
  1417. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1418. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1419. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1420. ):
  1421. mock_get.return_value = [mock_provider]
  1422. await service.on_plate_not_empty(
  1423. printer_id=1,
  1424. printer_name="X1 Carbon",
  1425. db=mock_db,
  1426. difference_percent=3.5,
  1427. )
  1428. assert captured_variables["printer"] == "X1 Carbon"
  1429. assert captured_variables["difference_percent"] == "3.5"
  1430. class TestBedCooledNotifications:
  1431. """Tests for bed cooled (after print) notifications."""
  1432. @pytest.fixture
  1433. def service(self):
  1434. return NotificationService()
  1435. @pytest.fixture
  1436. def mock_provider(self):
  1437. """Create a mock notification provider with bed cooled enabled."""
  1438. provider = MagicMock()
  1439. provider.id = 1
  1440. provider.name = "Test Provider"
  1441. provider.provider_type = "webhook"
  1442. provider.enabled = True
  1443. provider.config = json.dumps({"webhook_url": "http://test.local/webhook"})
  1444. provider.on_bed_cooled = True
  1445. provider.quiet_hours_enabled = False
  1446. provider.daily_digest_enabled = False
  1447. provider.printer_id = None
  1448. return provider
  1449. @pytest.fixture
  1450. def mock_db(self):
  1451. """Create a mock database session."""
  1452. db = AsyncMock()
  1453. db.commit = AsyncMock()
  1454. return db
  1455. @pytest.mark.asyncio
  1456. async def test_on_bed_cooled_sends_notification(self, service, mock_provider, mock_db):
  1457. """Verify bed cooled notification is sent when triggered."""
  1458. with (
  1459. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1460. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  1461. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  1462. ):
  1463. mock_get.return_value = [mock_provider]
  1464. mock_build.return_value = ("Bed Cooled", "Test Printer: Bed cooled to 30°C")
  1465. await service.on_bed_cooled(
  1466. printer_id=1,
  1467. printer_name="Test Printer",
  1468. bed_temp=30.0,
  1469. threshold=35.0,
  1470. filename="benchy.3mf",
  1471. db=mock_db,
  1472. )
  1473. mock_get.assert_called_once()
  1474. mock_send.assert_called_once()
  1475. @pytest.mark.asyncio
  1476. async def test_on_bed_cooled_skipped_when_no_providers(self, service, mock_db):
  1477. """Verify notification is skipped when no providers have bed cooled enabled."""
  1478. with (
  1479. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1480. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  1481. ):
  1482. mock_get.return_value = []
  1483. await service.on_bed_cooled(
  1484. printer_id=1,
  1485. printer_name="Test Printer",
  1486. bed_temp=30.0,
  1487. threshold=35.0,
  1488. filename="benchy.3mf",
  1489. db=mock_db,
  1490. )
  1491. mock_send.assert_not_called()
  1492. @pytest.mark.asyncio
  1493. async def test_on_bed_cooled_includes_correct_variables(self, service, mock_provider, mock_db):
  1494. """Verify bed temp, threshold, and filename are passed to template variables."""
  1495. captured_variables = {}
  1496. async def capture_build(db, event_type, variables):
  1497. captured_variables.update(variables)
  1498. return ("Test", "Test")
  1499. with (
  1500. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1501. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1502. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1503. ):
  1504. mock_get.return_value = [mock_provider]
  1505. await service.on_bed_cooled(
  1506. printer_id=1,
  1507. printer_name="X1 Carbon",
  1508. bed_temp=28.7,
  1509. threshold=35.0,
  1510. filename="benchy.gcode.3mf",
  1511. db=mock_db,
  1512. )
  1513. assert captured_variables["printer"] == "X1 Carbon"
  1514. assert captured_variables["bed_temp"] == "29"
  1515. assert captured_variables["threshold"] == "35"
  1516. assert captured_variables["filename"] == "benchy"
  1517. @pytest.mark.asyncio
  1518. async def test_on_bed_cooled_handles_none_filename(self, service, mock_provider, mock_db):
  1519. """Verify None filename is handled gracefully."""
  1520. captured_variables = {}
  1521. async def capture_build(db, event_type, variables):
  1522. captured_variables.update(variables)
  1523. return ("Test", "Test")
  1524. with (
  1525. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1526. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1527. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1528. ):
  1529. mock_get.return_value = [mock_provider]
  1530. await service.on_bed_cooled(
  1531. printer_id=1,
  1532. printer_name="Test Printer",
  1533. bed_temp=30.0,
  1534. threshold=35.0,
  1535. filename=None,
  1536. db=mock_db,
  1537. )
  1538. assert captured_variables["filename"] == "Unknown"
  1539. class TestFirstLayerCompleteNotifications:
  1540. """Tests for first layer complete notifications."""
  1541. @pytest.fixture
  1542. def service(self):
  1543. return NotificationService()
  1544. @pytest.fixture
  1545. def mock_provider(self):
  1546. """Create a mock notification provider with first layer complete enabled."""
  1547. provider = MagicMock()
  1548. provider.id = 1
  1549. provider.name = "Test Provider"
  1550. provider.provider_type = "webhook"
  1551. provider.enabled = True
  1552. provider.config = json.dumps({"webhook_url": "http://test.local/webhook"})
  1553. provider.on_first_layer_complete = True
  1554. provider.quiet_hours_enabled = False
  1555. provider.daily_digest_enabled = False
  1556. provider.printer_id = None
  1557. return provider
  1558. @pytest.fixture
  1559. def mock_db(self):
  1560. """Create a mock database session."""
  1561. db = AsyncMock()
  1562. db.commit = AsyncMock()
  1563. return db
  1564. @pytest.mark.asyncio
  1565. async def test_on_first_layer_complete_sends_notification(self, service, mock_provider, mock_db):
  1566. """Verify first layer complete notification is sent when triggered."""
  1567. with (
  1568. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1569. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  1570. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  1571. ):
  1572. mock_get.return_value = [mock_provider]
  1573. mock_build.return_value = ("First Layer Complete", "Test Printer: benchy.3mf")
  1574. await service.on_first_layer_complete(
  1575. printer_id=1,
  1576. printer_name="Test Printer",
  1577. filename="benchy.3mf",
  1578. total_layers=50,
  1579. db=mock_db,
  1580. )
  1581. mock_get.assert_called_once()
  1582. mock_send.assert_called_once()
  1583. @pytest.mark.asyncio
  1584. async def test_on_first_layer_complete_skipped_when_no_providers(self, service, mock_db):
  1585. """Verify notification is skipped when no providers have first layer complete enabled."""
  1586. with (
  1587. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1588. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  1589. ):
  1590. mock_get.return_value = []
  1591. await service.on_first_layer_complete(
  1592. printer_id=1,
  1593. printer_name="Test Printer",
  1594. filename="benchy.3mf",
  1595. total_layers=50,
  1596. db=mock_db,
  1597. )
  1598. mock_send.assert_not_called()
  1599. @pytest.mark.asyncio
  1600. async def test_on_first_layer_complete_includes_correct_variables(self, service, mock_provider, mock_db):
  1601. """Verify printer name, filename, and total_layers are passed to template variables."""
  1602. captured_variables = {}
  1603. async def capture_build(db, event_type, variables):
  1604. captured_variables.update(variables)
  1605. return ("Test", "Test")
  1606. with (
  1607. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1608. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1609. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1610. ):
  1611. mock_get.return_value = [mock_provider]
  1612. await service.on_first_layer_complete(
  1613. printer_id=1,
  1614. printer_name="X1 Carbon",
  1615. filename="benchy.gcode.3mf",
  1616. total_layers=120,
  1617. db=mock_db,
  1618. )
  1619. assert captured_variables["printer"] == "X1 Carbon"
  1620. assert captured_variables["filename"] == "benchy"
  1621. assert captured_variables["total_layers"] == "120"
  1622. @pytest.mark.asyncio
  1623. async def test_on_first_layer_complete_passes_image_data(self, service, mock_provider, mock_db):
  1624. """Verify image_data is passed through to _send_to_providers."""
  1625. with (
  1626. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1627. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  1628. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  1629. ):
  1630. mock_get.return_value = [mock_provider]
  1631. mock_build.return_value = ("First Layer Complete", "Test message")
  1632. fake_image = b"\x89PNG\r\n\x1a\nfakeimage"
  1633. await service.on_first_layer_complete(
  1634. printer_id=1,
  1635. printer_name="Test Printer",
  1636. filename="benchy.3mf",
  1637. total_layers=50,
  1638. db=mock_db,
  1639. image_data=fake_image,
  1640. )
  1641. mock_send.assert_called_once()
  1642. call_kwargs = mock_send.call_args
  1643. assert call_kwargs.kwargs.get("image_data") == fake_image