test_notification_service.py 86 KB

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