test_coordinator.py 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963
  1. from datetime import date, datetime, time
  2. from unittest.mock import AsyncMock, MagicMock, patch
  3. import pytest
  4. from homeassistant.core import HomeAssistant
  5. from homeassistant.exceptions import HomeAssistantError
  6. from pytest_homeassistant_custom_component.common import MockConfigEntry
  7. from custom_components.room_cal_ha.backends import BackendAuthError, BackendConnectError
  8. from custom_components.room_cal_ha.const import (
  9. CONF_API_BASE_URL,
  10. CONF_CALDAV_URL,
  11. CONF_CALENDAR_NAME,
  12. CONF_RESERVATION_DEFAULTS,
  13. CONF_SYNC_MODE,
  14. DOMAIN,
  15. STORE_CURRENT,
  16. STORE_NEXT,
  17. SYNC_MODE_API,
  18. SYNC_MODE_CALDAV,
  19. SYNC_MODE_MANUAL,
  20. )
  21. from custom_components.room_cal_ha.coordinator import RoomCalCoordinator
  22. from custom_components.room_cal_ha.models import OverrideData, ReservationData
  23. SAMPLE = ReservationData(
  24. guest_name="Alice",
  25. check_in_date=date(2026, 7, 1),
  26. check_in_time=time(14, 0),
  27. check_out_date=date(2026, 7, 5),
  28. check_out_time=time(12, 0),
  29. wifi_key="stone-angel-market",
  30. door_code="0472",
  31. )
  32. _BASE_DATA = {
  33. "room_state_name": "Room State",
  34. "current_name": "Current",
  35. "next_name": "Next",
  36. }
  37. def _make_entry(hass, options: dict) -> MockConfigEntry:
  38. entry = MockConfigEntry(domain=DOMAIN, data=_BASE_DATA, options=options)
  39. entry.add_to_hass(hass)
  40. return entry
  41. @pytest.fixture
  42. async def coordinator(hass: HomeAssistant, mock_entry):
  43. mock_entry.add_to_hass(hass)
  44. coord = RoomCalCoordinator(hass, mock_entry)
  45. await coord.async_setup()
  46. return coord
  47. # ---------------------------------------------------------------------------
  48. # Manual mode
  49. # ---------------------------------------------------------------------------
  50. async def test_manual_mode_serves_empty(coordinator: RoomCalCoordinator):
  51. await coordinator.async_refresh()
  52. assert coordinator.data.current == ReservationData()
  53. assert coordinator.data.next == ReservationData()
  54. assert coordinator.data.current_last_refresh is None
  55. assert coordinator.data.next_last_refresh is None
  56. # ---------------------------------------------------------------------------
  57. # CalDAV mode
  58. # ---------------------------------------------------------------------------
  59. async def test_caldav_fetch_writes_store_and_timestamps(hass: HomeAssistant):
  60. entry = _make_entry(hass, {CONF_SYNC_MODE: SYNC_MODE_CALDAV, CONF_CALDAV_URL: "https://cal.example.com", CONF_CALENDAR_NAME: "Room"})
  61. coord = RoomCalCoordinator(hass, entry)
  62. await coord.async_setup()
  63. with patch("custom_components.room_cal_ha.coordinator.CalDavBackend") as MockBackend:
  64. MockBackend.return_value.async_fetch = AsyncMock(return_value=(SAMPLE, None))
  65. await coord.async_refresh()
  66. assert coord.data.current.guest_name == "Alice"
  67. assert coord.data.current.door_code == "0472"
  68. assert coord.data.next == ReservationData()
  69. assert coord.data.current_last_refresh is not None
  70. assert coord.data.next_last_refresh is not None
  71. async def test_caldav_empty_result_clears_store(hass: HomeAssistant):
  72. entry = _make_entry(hass, {CONF_SYNC_MODE: SYNC_MODE_CALDAV, CONF_CALDAV_URL: "https://cal.example.com", CONF_CALENDAR_NAME: "Room"})
  73. coord = RoomCalCoordinator(hass, entry)
  74. await coord.async_setup()
  75. await coord.store.async_set(STORE_CURRENT, SAMPLE)
  76. with patch("custom_components.room_cal_ha.coordinator.CalDavBackend") as MockBackend:
  77. MockBackend.return_value.async_fetch = AsyncMock(return_value=(None, None))
  78. await coord.async_refresh()
  79. assert coord.data.current == ReservationData()
  80. assert coord.store.get(STORE_CURRENT) is None
  81. async def test_caldav_connect_error_preserves_store(hass: HomeAssistant):
  82. entry = _make_entry(hass, {CONF_SYNC_MODE: SYNC_MODE_CALDAV, CONF_CALDAV_URL: "https://cal.example.com", CONF_CALENDAR_NAME: "Room"})
  83. coord = RoomCalCoordinator(hass, entry)
  84. await coord.async_setup()
  85. await coord.store.async_set(STORE_CURRENT, SAMPLE)
  86. with patch("custom_components.room_cal_ha.coordinator.CalDavBackend") as MockBackend:
  87. MockBackend.return_value.async_fetch = AsyncMock(side_effect=BackendConnectError("timeout"))
  88. await coord.async_refresh()
  89. assert coord.data.current.guest_name == "Alice"
  90. assert coord.data.current_last_refresh is None
  91. async def test_caldav_auth_error_triggers_reauth(hass: HomeAssistant):
  92. entry = _make_entry(hass, {CONF_SYNC_MODE: SYNC_MODE_CALDAV, CONF_CALDAV_URL: "https://cal.example.com", CONF_CALENDAR_NAME: "Room"})
  93. coord = RoomCalCoordinator(hass, entry)
  94. await coord.async_setup()
  95. with (
  96. patch("custom_components.room_cal_ha.coordinator.CalDavBackend") as MockBackend,
  97. patch.object(entry, "async_start_reauth") as mock_reauth,
  98. ):
  99. MockBackend.return_value.async_fetch = AsyncMock(side_effect=BackendAuthError)
  100. await coord.async_refresh()
  101. mock_reauth.assert_called_once_with(hass)
  102. # ---------------------------------------------------------------------------
  103. # API mode
  104. # ---------------------------------------------------------------------------
  105. async def test_api_fetch_writes_store(hass: HomeAssistant):
  106. entry = _make_entry(hass, {CONF_SYNC_MODE: SYNC_MODE_API, CONF_API_BASE_URL: "https://api.example.com"})
  107. coord = RoomCalCoordinator(hass, entry)
  108. await coord.async_setup()
  109. with patch("custom_components.room_cal_ha.coordinator.RoomCalApiBackend") as MockBackend:
  110. instance = MockBackend.return_value
  111. instance.async_fetch = AsyncMock(return_value=(SAMPLE, None))
  112. await coord.async_refresh()
  113. assert coord.data.current.guest_name == "Alice"
  114. assert coord.data.current_last_refresh is not None
  115. async def test_api_connect_error_preserves_store(hass: HomeAssistant):
  116. entry = _make_entry(hass, {CONF_SYNC_MODE: SYNC_MODE_API, CONF_API_BASE_URL: "https://api.example.com"})
  117. coord = RoomCalCoordinator(hass, entry)
  118. await coord.async_setup()
  119. await coord.store.async_set(STORE_CURRENT, SAMPLE)
  120. with patch("custom_components.room_cal_ha.coordinator.RoomCalApiBackend") as MockBackend:
  121. instance = MockBackend.return_value
  122. instance.async_fetch = AsyncMock(side_effect=BackendConnectError("timeout"))
  123. await coord.async_refresh()
  124. assert coord.data.current.guest_name == "Alice"
  125. assert coord.data.current_last_refresh is None
  126. async def test_api_auth_error_triggers_reauth(hass: HomeAssistant):
  127. entry = _make_entry(hass, {CONF_SYNC_MODE: SYNC_MODE_API, CONF_API_BASE_URL: "https://api.example.com"})
  128. coord = RoomCalCoordinator(hass, entry)
  129. await coord.async_setup()
  130. with (
  131. patch("custom_components.room_cal_ha.coordinator.RoomCalApiBackend") as MockBackend,
  132. patch.object(entry, "async_start_reauth") as mock_reauth,
  133. ):
  134. instance = MockBackend.return_value
  135. instance.async_fetch = AsyncMock(side_effect=BackendAuthError)
  136. await coord.async_refresh()
  137. mock_reauth.assert_called_once_with(hass)
  138. # ---------------------------------------------------------------------------
  139. # Thin updates
  140. # ---------------------------------------------------------------------------
  141. async def test_thin_update_overlays_fields(coordinator: RoomCalCoordinator):
  142. await coordinator.store.async_set(STORE_CURRENT, SAMPLE)
  143. await coordinator.async_refresh()
  144. await coordinator.async_apply_update(STORE_CURRENT, {"wifi_ssid": "GuestNet", "door_code": "9999"})
  145. assert coordinator.data.current.wifi_ssid == "GuestNet"
  146. assert coordinator.data.current.door_code == "9999"
  147. assert coordinator.data.current.guest_name == "Alice"
  148. assert coordinator.data.current.wifi_key == "stone-angel-market"
  149. async def test_thin_update_updates_last_refresh(coordinator: RoomCalCoordinator):
  150. await coordinator.store.async_set(STORE_CURRENT, SAMPLE)
  151. await coordinator.async_refresh()
  152. assert coordinator.data.current_last_refresh is None
  153. await coordinator.async_apply_update(STORE_CURRENT, {"door_code": "1234"})
  154. assert coordinator.data.current_last_refresh is not None
  155. # ---------------------------------------------------------------------------
  156. # last_updated
  157. # ---------------------------------------------------------------------------
  158. async def test_last_updated_set_when_backend_data_changes(hass: HomeAssistant):
  159. entry = _make_entry(hass, {CONF_SYNC_MODE: SYNC_MODE_CALDAV, CONF_CALDAV_URL: "https://cal.example.com", CONF_CALENDAR_NAME: "Room"})
  160. coord = RoomCalCoordinator(hass, entry)
  161. await coord.async_setup()
  162. next_sample = ReservationData(guest_name="Next")
  163. with patch("custom_components.room_cal_ha.coordinator.CalDavBackend") as MockBackend:
  164. MockBackend.return_value.async_fetch = AsyncMock(return_value=(SAMPLE, next_sample))
  165. await coord.async_refresh()
  166. assert coord.data.current_last_updated is not None
  167. assert coord.data.next_last_updated is not None
  168. async def test_last_updated_not_set_when_backend_data_unchanged(hass: HomeAssistant):
  169. entry = _make_entry(hass, {CONF_SYNC_MODE: SYNC_MODE_CALDAV, CONF_CALDAV_URL: "https://cal.example.com", CONF_CALENDAR_NAME: "Room"})
  170. coord = RoomCalCoordinator(hass, entry)
  171. await coord.async_setup()
  172. await coord.store.async_set(STORE_CURRENT, SAMPLE)
  173. with patch("custom_components.room_cal_ha.coordinator.CalDavBackend") as MockBackend:
  174. MockBackend.return_value.async_fetch = AsyncMock(return_value=(SAMPLE, None))
  175. # First refresh populates self.data
  176. await coord.async_refresh()
  177. ts_after_first = coord.data.current_last_updated
  178. # Second refresh returns same data — last_updated must not change
  179. await coord.async_refresh()
  180. assert coord.data.current_last_updated == ts_after_first
  181. async def test_last_updated_set_on_thin_update_with_change(coordinator: RoomCalCoordinator):
  182. await coordinator.store.async_set(STORE_CURRENT, SAMPLE)
  183. await coordinator.async_refresh()
  184. await coordinator.async_apply_update(STORE_CURRENT, {"door_code": "9999"})
  185. assert coordinator.data.current_last_updated is not None
  186. async def test_last_updated_not_set_on_thin_update_with_same_value(coordinator: RoomCalCoordinator):
  187. await coordinator.store.async_set(STORE_CURRENT, SAMPLE)
  188. await coordinator.async_refresh()
  189. # First update sets last_updated
  190. await coordinator.async_apply_update(STORE_CURRENT, {"door_code": "9999"})
  191. ts = coordinator.data.current_last_updated
  192. # Second update with the same value must not advance last_updated
  193. await coordinator.async_apply_update(STORE_CURRENT, {"door_code": "9999"})
  194. assert coordinator.data.current_last_updated == ts
  195. async def test_last_updated_set_when_override_starts(coordinator: RoomCalCoordinator):
  196. await coordinator.async_refresh()
  197. coordinator._room_state_switch = None
  198. assert coordinator.data.current_last_updated is None
  199. await coordinator.async_start_override(OverrideData(current=ReservationData(guest_name="Override")))
  200. assert coordinator.data.current_last_updated is not None
  201. async def test_last_updated_set_when_override_ends(coordinator: RoomCalCoordinator):
  202. coordinator._room_state_switch = None
  203. await coordinator.async_start_override(OverrideData(current=ReservationData(guest_name="Override")))
  204. ts_start = coordinator.data.current_last_updated
  205. await coordinator.store.async_set(STORE_CURRENT, SAMPLE)
  206. coordinator._override = OverrideData(current=ReservationData(guest_name="Override"))
  207. await coordinator.async_end_override()
  208. assert coordinator.data.current_last_updated != ts_start
  209. async def test_last_updated_persists_across_reload(hass: HomeAssistant, mock_entry):
  210. mock_entry.add_to_hass(hass)
  211. coord = RoomCalCoordinator(hass, mock_entry)
  212. await coord.async_setup()
  213. await coord.store.async_set(STORE_CURRENT, SAMPLE)
  214. await coord.store.async_set_last_updated(STORE_CURRENT, datetime(2026, 1, 1, 12, 0, tzinfo=None))
  215. coord2 = RoomCalCoordinator(hass, mock_entry)
  216. await coord2.async_setup()
  217. loaded = coord2.store.get_last_updated(STORE_CURRENT)
  218. assert loaded is not None
  219. assert loaded.year == 2026
  220. # ---------------------------------------------------------------------------
  221. # Store persistence
  222. # ---------------------------------------------------------------------------
  223. async def test_store_persists_across_reload(hass: HomeAssistant, mock_entry):
  224. mock_entry.add_to_hass(hass)
  225. coord = RoomCalCoordinator(hass, mock_entry)
  226. await coord.async_setup()
  227. await coord.store.async_set(STORE_CURRENT, SAMPLE)
  228. coord2 = RoomCalCoordinator(hass, mock_entry)
  229. await coord2.async_setup()
  230. loaded = coord2.store.get(STORE_CURRENT)
  231. assert loaded is not None
  232. assert loaded.guest_name == "Alice"
  233. assert loaded.door_code == "0472"
  234. # ---------------------------------------------------------------------------
  235. # _reservation_window_state
  236. # ---------------------------------------------------------------------------
  237. DATED = ReservationData(
  238. check_in_date=date(2026, 7, 1),
  239. check_in_time=time(14, 0),
  240. check_out_date=date(2026, 7, 5),
  241. check_out_time=time(12, 0),
  242. )
  243. def _state_at(coordinator, res, dt_str):
  244. """Freeze dt_util.now() to a naive local datetime and call _reservation_window_state."""
  245. frozen = MagicMock()
  246. frozen.replace.return_value = datetime.fromisoformat(dt_str) # naive, no TZ
  247. with patch("custom_components.room_cal_ha.coordinator.dt_util.now", return_value=frozen):
  248. return coordinator._reservation_window_state(res)
  249. async def test_window_state_active(coordinator):
  250. assert _state_at(coordinator, DATED, "2026-07-03T10:00:00") == "active"
  251. async def test_window_state_pending(coordinator):
  252. assert _state_at(coordinator, DATED, "2026-06-30T10:00:00") == "pending"
  253. async def test_window_state_elapsed(coordinator):
  254. assert _state_at(coordinator, DATED, "2026-07-10T12:00:00") == "elapsed"
  255. async def test_window_state_at_check_in_is_active(coordinator):
  256. assert _state_at(coordinator, DATED, "2026-07-01T14:00:00") == "active"
  257. async def test_window_state_at_check_out_is_elapsed(coordinator):
  258. assert _state_at(coordinator, DATED, "2026-07-05T12:00:00") == "elapsed"
  259. async def test_window_state_no_dates_returns_none(coordinator):
  260. assert coordinator._reservation_window_state(ReservationData()) is None
  261. # ---------------------------------------------------------------------------
  262. # Check-in WiFi key behavior
  263. # ---------------------------------------------------------------------------
  264. _WIFI_NEXT = ReservationData(
  265. guest_name="Bob",
  266. check_in_date=date(2026, 7, 1),
  267. check_in_time=time(14, 0),
  268. check_out_date=date(2026, 7, 5),
  269. check_out_time=time(12, 0),
  270. wifi_ssid="GuestNet",
  271. wifi_key="securepass",
  272. )
  273. # Freeze time at the check-in moment so the window registers as active during check-in tests.
  274. _AT_CHECK_IN = MagicMock()
  275. _AT_CHECK_IN.replace.return_value = datetime(2026, 7, 1, 14, 0, 0)
  276. async def test_check_in_calls_wifi_key(hass: HomeAssistant, coordinator: RoomCalCoordinator):
  277. await coordinator.store.async_set(STORE_NEXT, _WIFI_NEXT)
  278. mock_switch = MagicMock()
  279. mock_switch.async_turn_on = AsyncMock()
  280. coordinator._room_state_switch = mock_switch
  281. with (
  282. patch.object(coordinator, "_is_mode_sync_on", return_value=True),
  283. patch("custom_components.room_cal_ha.coordinator.dt_util.now", return_value=_AT_CHECK_IN),
  284. patch("custom_components.room_cal_ha.wifi.async_set_wifi_key", new_callable=AsyncMock) as mock_wifi,
  285. patch("custom_components.room_cal_ha.wifi.async_set_ssid_enabled", new_callable=AsyncMock) as mock_ssid,
  286. ):
  287. await coordinator._async_do_check_in()
  288. coordinator.cancel_mode_sync()
  289. mock_ssid.assert_awaited_once_with(hass, "GuestNet", True)
  290. mock_wifi.assert_awaited_once_with(hass, "GuestNet", "securepass")
  291. mock_switch.async_turn_on.assert_awaited_once()
  292. async def test_check_in_skips_wifi_when_ssid_none(coordinator: RoomCalCoordinator):
  293. await coordinator.store.async_set(STORE_NEXT, ReservationData(wifi_ssid=None, wifi_key="securepass"))
  294. coordinator._room_state_switch = None
  295. with patch("custom_components.room_cal_ha.wifi.async_set_wifi_key", new_callable=AsyncMock) as mock_wifi:
  296. await coordinator._async_do_check_in()
  297. mock_wifi.assert_not_awaited()
  298. async def test_check_in_skips_wifi_when_key_none(coordinator: RoomCalCoordinator):
  299. await coordinator.store.async_set(STORE_NEXT, ReservationData(wifi_ssid="GuestNet", wifi_key=None))
  300. coordinator._room_state_switch = None
  301. with patch("custom_components.room_cal_ha.wifi.async_set_wifi_key", new_callable=AsyncMock) as mock_wifi:
  302. await coordinator._async_do_check_in()
  303. mock_wifi.assert_not_awaited()
  304. async def test_check_in_skips_wifi_when_use_unifi_off(hass: HomeAssistant, coordinator: RoomCalCoordinator):
  305. await coordinator.store.async_set(STORE_NEXT, _WIFI_NEXT)
  306. mock_switch = MagicMock()
  307. mock_switch.async_turn_on = AsyncMock()
  308. coordinator._room_state_switch = mock_switch
  309. with (
  310. patch.object(coordinator, "_is_mode_sync_on", return_value=True),
  311. patch.object(coordinator, "_is_use_unifi_on", return_value=False),
  312. patch("custom_components.room_cal_ha.coordinator.dt_util.now", return_value=_AT_CHECK_IN),
  313. patch("custom_components.room_cal_ha.wifi.async_set_ssid_enabled", new_callable=AsyncMock) as mock_ssid,
  314. patch("custom_components.room_cal_ha.wifi.async_set_wifi_key", new_callable=AsyncMock) as mock_wifi,
  315. ):
  316. await coordinator._async_do_check_in()
  317. coordinator.cancel_mode_sync()
  318. mock_ssid.assert_not_awaited()
  319. mock_wifi.assert_not_awaited()
  320. mock_switch.async_turn_on.assert_awaited_once()
  321. async def test_check_in_wifi_error_still_activates_guest_mode(coordinator: RoomCalCoordinator):
  322. await coordinator.store.async_set(STORE_NEXT, _WIFI_NEXT)
  323. mock_switch = MagicMock()
  324. mock_switch.async_turn_on = AsyncMock()
  325. coordinator._room_state_switch = mock_switch
  326. with (
  327. patch.object(coordinator, "_is_mode_sync_on", return_value=True),
  328. patch("custom_components.room_cal_ha.coordinator.dt_util.now", return_value=_AT_CHECK_IN),
  329. patch("custom_components.room_cal_ha.wifi.async_set_ssid_enabled", new_callable=AsyncMock),
  330. patch("custom_components.room_cal_ha.wifi.async_set_wifi_key", side_effect=HomeAssistantError("hub down")),
  331. ):
  332. await coordinator._async_do_check_in()
  333. coordinator.cancel_mode_sync()
  334. mock_switch.async_turn_on.assert_awaited_once()
  335. # ---------------------------------------------------------------------------
  336. # Check-out SSID disable behavior
  337. # ---------------------------------------------------------------------------
  338. async def test_check_out_disables_ssid(hass: HomeAssistant, coordinator: RoomCalCoordinator):
  339. await coordinator.store.async_set(STORE_CURRENT, _WIFI_NEXT)
  340. mock_switch = MagicMock()
  341. mock_switch.async_turn_off = AsyncMock()
  342. coordinator._room_state_switch = mock_switch
  343. with (
  344. patch.object(coordinator, "_is_mode_sync_on", return_value=True),
  345. patch("custom_components.room_cal_ha.wifi.async_set_ssid_enabled", new_callable=AsyncMock) as mock_ssid,
  346. ):
  347. await coordinator._async_do_check_out()
  348. mock_ssid.assert_awaited_once_with(hass, "GuestNet", False)
  349. mock_switch.async_turn_off.assert_awaited_once()
  350. async def test_check_out_skips_ssid_when_ssid_none(coordinator: RoomCalCoordinator):
  351. await coordinator.store.async_set(STORE_CURRENT, ReservationData(wifi_ssid=None))
  352. coordinator._room_state_switch = None
  353. with patch("custom_components.room_cal_ha.wifi.async_set_ssid_enabled", new_callable=AsyncMock) as mock_ssid:
  354. await coordinator._async_do_check_out()
  355. mock_ssid.assert_not_awaited()
  356. async def test_check_out_skips_ssid_when_use_unifi_off(coordinator: RoomCalCoordinator):
  357. await coordinator.store.async_set(STORE_CURRENT, _WIFI_NEXT)
  358. coordinator._room_state_switch = None
  359. with (
  360. patch.object(coordinator, "_is_mode_sync_on", return_value=True),
  361. patch.object(coordinator, "_is_use_unifi_on", return_value=False),
  362. patch("custom_components.room_cal_ha.wifi.async_set_ssid_enabled", new_callable=AsyncMock) as mock_ssid,
  363. ):
  364. await coordinator._async_do_check_out()
  365. mock_ssid.assert_not_awaited()
  366. async def test_check_out_ssid_error_still_deactivates_guest_mode(coordinator: RoomCalCoordinator):
  367. await coordinator.store.async_set(STORE_CURRENT, _WIFI_NEXT)
  368. mock_switch = MagicMock()
  369. mock_switch.async_turn_off = AsyncMock()
  370. coordinator._room_state_switch = mock_switch
  371. with (
  372. patch.object(coordinator, "_is_mode_sync_on", return_value=True),
  373. patch("custom_components.room_cal_ha.wifi.async_set_ssid_enabled", side_effect=HomeAssistantError("hub down")),
  374. ):
  375. await coordinator._async_do_check_out()
  376. mock_switch.async_turn_off.assert_awaited_once()
  377. # ---------------------------------------------------------------------------
  378. # async_start_override / async_end_override
  379. # ---------------------------------------------------------------------------
  380. _OVERRIDE_RES = ReservationData(guest_name="Override Guest", door_code="1111")
  381. _WIFI_OVERRIDE = ReservationData(guest_name="WiFi Guest", wifi_ssid="GuestNet", wifi_key="secret")
  382. async def test_start_override_sets_current_in_data(coordinator: RoomCalCoordinator):
  383. coordinator._room_state_switch = None
  384. await coordinator.async_start_override(OverrideData(current=_OVERRIDE_RES))
  385. assert coordinator.data.current.guest_name == "Override Guest"
  386. async def test_start_override_sets_override_active_flag(coordinator: RoomCalCoordinator):
  387. coordinator._room_state_switch = None
  388. await coordinator.async_start_override(OverrideData(current=_OVERRIDE_RES))
  389. assert coordinator.data.override_active is True
  390. async def test_start_override_cancels_mode_sync(coordinator: RoomCalCoordinator):
  391. cancel1, cancel2 = MagicMock(), MagicMock()
  392. coordinator._mode_sync_handles = [cancel1, cancel2]
  393. coordinator._room_state_switch = None
  394. await coordinator.async_start_override(OverrideData(current=_OVERRIDE_RES))
  395. cancel1.assert_called_once()
  396. cancel2.assert_called_once()
  397. assert coordinator._mode_sync_handles == []
  398. async def test_start_override_turns_on_guest_mode(coordinator: RoomCalCoordinator):
  399. mock_switch = MagicMock()
  400. mock_switch.async_turn_on = AsyncMock()
  401. coordinator._room_state_switch = mock_switch
  402. with patch.object(coordinator, "_is_mode_sync_on", return_value=True):
  403. await coordinator.async_start_override(OverrideData(current=_OVERRIDE_RES))
  404. mock_switch.async_turn_on.assert_awaited_once()
  405. async def test_start_override_does_not_turn_on_guest_mode_when_mode_sync_off(coordinator: RoomCalCoordinator):
  406. mock_switch = MagicMock()
  407. mock_switch.async_turn_on = AsyncMock()
  408. coordinator._room_state_switch = mock_switch
  409. with patch.object(coordinator, "_is_mode_sync_on", return_value=False):
  410. await coordinator.async_start_override(OverrideData(current=_OVERRIDE_RES))
  411. mock_switch.async_turn_on.assert_not_awaited()
  412. async def test_start_override_calls_wifi_when_credentials_present(hass: HomeAssistant, coordinator: RoomCalCoordinator):
  413. coordinator._room_state_switch = MagicMock()
  414. coordinator._room_state_switch.async_turn_on = AsyncMock()
  415. with (
  416. patch.object(coordinator, "_is_mode_sync_on", return_value=True),
  417. patch("custom_components.room_cal_ha.wifi.async_set_wifi_key", new_callable=AsyncMock) as mock_wifi,
  418. ):
  419. await coordinator.async_start_override(OverrideData(current=_WIFI_OVERRIDE))
  420. mock_wifi.assert_awaited_once_with(hass, "GuestNet", "secret")
  421. async def test_start_override_skips_wifi_when_mode_sync_off(coordinator: RoomCalCoordinator):
  422. coordinator._room_state_switch = None
  423. with (
  424. patch.object(coordinator, "_is_mode_sync_on", return_value=False),
  425. patch("custom_components.room_cal_ha.wifi.async_set_wifi_key", new_callable=AsyncMock) as mock_wifi,
  426. ):
  427. await coordinator.async_start_override(OverrideData(current=_WIFI_OVERRIDE))
  428. mock_wifi.assert_not_awaited()
  429. async def test_start_override_skips_wifi_when_ssid_missing(coordinator: RoomCalCoordinator):
  430. coordinator._room_state_switch = None
  431. no_ssid = ReservationData(wifi_ssid=None, wifi_key="secret")
  432. with patch("custom_components.room_cal_ha.wifi.async_set_wifi_key", new_callable=AsyncMock) as mock_wifi:
  433. await coordinator.async_start_override(OverrideData(current=no_ssid))
  434. mock_wifi.assert_not_awaited()
  435. async def test_start_override_uses_store_next_when_override_next_is_none(coordinator: RoomCalCoordinator):
  436. await coordinator.store.async_set(STORE_NEXT, SAMPLE)
  437. coordinator._room_state_switch = None
  438. await coordinator.async_start_override(OverrideData(current=_OVERRIDE_RES))
  439. assert coordinator.data.next.guest_name == "Alice"
  440. async def test_start_override_uses_override_next_when_provided(coordinator: RoomCalCoordinator):
  441. override_next = ReservationData(guest_name="Override Next")
  442. coordinator._room_state_switch = None
  443. await coordinator.async_start_override(OverrideData(current=_OVERRIDE_RES, next=override_next))
  444. assert coordinator.data.next.guest_name == "Override Next"
  445. async def test_start_override_applies_defaults_to_current(hass: HomeAssistant):
  446. entry = MockConfigEntry(
  447. domain=DOMAIN,
  448. data={},
  449. options={
  450. CONF_SYNC_MODE: SYNC_MODE_MANUAL,
  451. CONF_RESERVATION_DEFAULTS: {"wifi_ssid": "DefaultSSID", "check_out_time": "11:00:00"},
  452. },
  453. )
  454. entry.add_to_hass(hass)
  455. coord = RoomCalCoordinator(hass, entry)
  456. await coord.async_setup()
  457. coord._guest_mode_switch = None
  458. partial_override = ReservationData(guest_name="Override Guest")
  459. await coord.async_start_override(OverrideData(current=partial_override))
  460. assert coord.data.current.guest_name == "Override Guest"
  461. assert coord.data.current.wifi_ssid == "DefaultSSID"
  462. assert coord.data.current.check_out_time == time(11, 0)
  463. async def test_start_override_defaults_do_not_overwrite_explicit_fields(hass: HomeAssistant):
  464. entry = MockConfigEntry(
  465. domain=DOMAIN,
  466. data={},
  467. options={
  468. CONF_SYNC_MODE: SYNC_MODE_MANUAL,
  469. CONF_RESERVATION_DEFAULTS: {"wifi_ssid": "DefaultSSID"},
  470. },
  471. )
  472. entry.add_to_hass(hass)
  473. coord = RoomCalCoordinator(hass, entry)
  474. await coord.async_setup()
  475. coord._guest_mode_switch = None
  476. explicit_override = ReservationData(guest_name="Override Guest", wifi_ssid="ExplicitSSID")
  477. await coord.async_start_override(OverrideData(current=explicit_override))
  478. assert coord.data.current.wifi_ssid == "ExplicitSSID"
  479. async def test_refresh_during_override_applies_defaults_to_current(hass: HomeAssistant):
  480. entry = MockConfigEntry(
  481. domain=DOMAIN,
  482. data={},
  483. options={
  484. CONF_SYNC_MODE: SYNC_MODE_MANUAL,
  485. CONF_RESERVATION_DEFAULTS: {"door_code": "9999"},
  486. },
  487. )
  488. entry.add_to_hass(hass)
  489. coord = RoomCalCoordinator(hass, entry)
  490. await coord.async_setup()
  491. coord._guest_mode_switch = None
  492. partial_override = ReservationData(guest_name="Override Guest")
  493. await coord.async_start_override(OverrideData(current=partial_override))
  494. await coord.async_refresh()
  495. assert coord.data.current.guest_name == "Override Guest"
  496. assert coord.data.current.door_code == "9999"
  497. async def test_start_override_applies_defaults_to_store_next(hass: HomeAssistant):
  498. entry = MockConfigEntry(
  499. domain=DOMAIN,
  500. data={},
  501. options={
  502. CONF_SYNC_MODE: SYNC_MODE_MANUAL,
  503. CONF_RESERVATION_DEFAULTS: {"wifi_ssid": "DefaultSSID"},
  504. },
  505. )
  506. entry.add_to_hass(hass)
  507. coord = RoomCalCoordinator(hass, entry)
  508. await coord.async_setup()
  509. coord._guest_mode_switch = None
  510. await coord.store.async_set(STORE_NEXT, ReservationData(guest_name="Next Guest"))
  511. await coord.async_start_override(OverrideData(current=_OVERRIDE_RES))
  512. assert coord.data.next.guest_name == "Next Guest"
  513. assert coord.data.next.wifi_ssid == "DefaultSSID"
  514. async def test_end_override_clears_override_active(coordinator: RoomCalCoordinator):
  515. coordinator._room_state_switch = None
  516. coordinator._override = OverrideData(current=_OVERRIDE_RES)
  517. await coordinator.async_end_override()
  518. assert coordinator.data.override_active is False
  519. async def test_end_override_restores_store_current(coordinator: RoomCalCoordinator):
  520. await coordinator.store.async_set(STORE_CURRENT, SAMPLE)
  521. coordinator._room_state_switch = None
  522. coordinator._override = OverrideData(current=_OVERRIDE_RES)
  523. await coordinator.async_end_override()
  524. assert coordinator.data.current.guest_name == "Alice"
  525. # ---------------------------------------------------------------------------
  526. # Thin updates during override
  527. # ---------------------------------------------------------------------------
  528. async def test_thin_update_current_during_override_updates_override_not_store(coordinator: RoomCalCoordinator):
  529. await coordinator.store.async_set(STORE_CURRENT, SAMPLE)
  530. await coordinator.async_refresh()
  531. coordinator._override = OverrideData(current=_OVERRIDE_RES)
  532. await coordinator.async_apply_update(STORE_CURRENT, {"door_code": "9999"})
  533. assert coordinator.data.current.door_code == "9999"
  534. # Store is unchanged
  535. assert coordinator.store.get(STORE_CURRENT).door_code == "0472"
  536. async def test_thin_update_current_during_override_data_still_shows_override_active(coordinator: RoomCalCoordinator):
  537. await coordinator.async_refresh()
  538. coordinator._override = OverrideData(current=_OVERRIDE_RES)
  539. await coordinator.async_apply_update(STORE_CURRENT, {"door_code": "9999"})
  540. assert coordinator.data.override_active is True
  541. async def test_thin_update_next_during_override_falls_through_to_store(coordinator: RoomCalCoordinator):
  542. coordinator._override = OverrideData(current=_OVERRIDE_RES) # override.next is None
  543. await coordinator.async_refresh()
  544. await coordinator.async_apply_update(STORE_NEXT, {"guest_name": "Next Guest"})
  545. assert coordinator.store.get(STORE_NEXT).guest_name == "Next Guest"
  546. assert coordinator.data.override_active is True
  547. assert coordinator.data.current.guest_name == "Override Guest"
  548. # ---------------------------------------------------------------------------
  549. # Backend fetch during override preserves override display
  550. # ---------------------------------------------------------------------------
  551. async def test_backend_fetch_during_override_updates_store_but_preserves_override(hass: HomeAssistant):
  552. entry = _make_entry(hass, {CONF_SYNC_MODE: SYNC_MODE_CALDAV, CONF_CALDAV_URL: "https://cal.example.com", CONF_CALENDAR_NAME: "Room"})
  553. coord = RoomCalCoordinator(hass, entry)
  554. await coord.async_setup()
  555. coord._override = OverrideData(current=_OVERRIDE_RES)
  556. backend_data = ReservationData(guest_name="Backend Alice")
  557. with patch("custom_components.room_cal_ha.coordinator.CalDavBackend") as MockBackend:
  558. MockBackend.return_value.async_fetch = AsyncMock(return_value=(backend_data, None))
  559. await coord.async_refresh()
  560. # Store was written by the backend
  561. assert coord.store.get(STORE_CURRENT).guest_name == "Backend Alice"
  562. # But displayed data still shows the override
  563. assert coord.data.current.guest_name == "Override Guest"
  564. assert coord.data.override_active is True
  565. # ---------------------------------------------------------------------------
  566. # async_reconcile_from_store (shared helper)
  567. # ---------------------------------------------------------------------------
  568. _ACTIVE = ReservationData(
  569. guest_name="Active Guest",
  570. check_in_date=date(2026, 6, 20),
  571. check_in_time=time(14, 0),
  572. check_out_date=date(2026, 6, 25),
  573. check_out_time=time(12, 0),
  574. )
  575. _ELAPSED = ReservationData(
  576. guest_name="Past Guest",
  577. check_in_date=date(2026, 6, 1),
  578. check_in_time=time(14, 0),
  579. check_out_date=date(2026, 6, 5),
  580. check_out_time=time(12, 0),
  581. )
  582. _FUTURE = ReservationData(
  583. guest_name="Future Guest",
  584. check_in_date=date(2026, 7, 1),
  585. check_in_time=time(14, 0),
  586. check_out_date=date(2026, 7, 5),
  587. check_out_time=time(12, 0),
  588. )
  589. # Freeze time at 2026-06-22 12:00 local (naive)
  590. _RECONCILE_NOW = MagicMock()
  591. _RECONCILE_NOW.replace.return_value = datetime(2026, 6, 22, 12, 0, 0)
  592. async def test_reconcile_active_current_turns_on_guest_mode(coordinator: RoomCalCoordinator):
  593. await coordinator.store.async_set(STORE_CURRENT, _ACTIVE)
  594. mock_switch = MagicMock()
  595. mock_switch.async_turn_on = AsyncMock()
  596. mock_switch.async_turn_off = AsyncMock()
  597. coordinator._room_state_switch = mock_switch
  598. with (
  599. patch.object(coordinator, "_is_mode_sync_on", return_value=True),
  600. patch("custom_components.room_cal_ha.coordinator.dt_util.now", return_value=_RECONCILE_NOW),
  601. ):
  602. await coordinator.async_reconcile_from_store()
  603. coordinator.cancel_mode_sync()
  604. mock_switch.async_turn_on.assert_awaited_once()
  605. mock_switch.async_turn_off.assert_not_awaited()
  606. async def test_reconcile_elapsed_current_clears_store_and_turns_off_guest_mode(coordinator: RoomCalCoordinator):
  607. await coordinator.store.async_set(STORE_CURRENT, _ELAPSED)
  608. mock_switch = MagicMock()
  609. mock_switch.async_turn_on = AsyncMock()
  610. mock_switch.async_turn_off = AsyncMock()
  611. coordinator._room_state_switch = mock_switch
  612. with (
  613. patch.object(coordinator, "_is_mode_sync_on", return_value=True),
  614. patch("custom_components.room_cal_ha.coordinator.dt_util.now", return_value=_RECONCILE_NOW),
  615. ):
  616. await coordinator.async_reconcile_from_store()
  617. assert coordinator.store.get(STORE_CURRENT) is None
  618. mock_switch.async_turn_off.assert_awaited_once()
  619. async def test_reconcile_promotes_next_when_check_in_elapsed(coordinator: RoomCalCoordinator):
  620. await coordinator.store.async_set(STORE_NEXT, _ACTIVE)
  621. with (
  622. patch.object(coordinator, "_is_mode_sync_on", return_value=True),
  623. patch("custom_components.room_cal_ha.coordinator.dt_util.now", return_value=_RECONCILE_NOW),
  624. ):
  625. await coordinator.async_reconcile_from_store()
  626. coordinator.cancel_mode_sync()
  627. assert coordinator.store.get(STORE_CURRENT).guest_name == "Active Guest"
  628. async def test_reconcile_turns_off_guest_mode_when_store_already_cleared(coordinator: RoomCalCoordinator):
  629. """Store was cleared (e.g. checkout write ran) but guest-mode-off action never ran."""
  630. # No current reservation in store — it was already cleared before HA was disabled.
  631. mock_switch = MagicMock()
  632. mock_switch.async_turn_on = AsyncMock()
  633. mock_switch.async_turn_off = AsyncMock()
  634. coordinator._room_state_switch = mock_switch
  635. with (
  636. patch.object(coordinator, "_is_mode_sync_on", return_value=True),
  637. patch("custom_components.room_cal_ha.coordinator.dt_util.now", return_value=_RECONCILE_NOW),
  638. ):
  639. await coordinator.async_reconcile_from_store()
  640. coordinator.cancel_mode_sync()
  641. mock_switch.async_turn_off.assert_awaited_once()
  642. mock_switch.async_turn_on.assert_not_awaited()
  643. async def test_reconcile_does_not_touch_guest_mode_when_mode_sync_off(coordinator: RoomCalCoordinator):
  644. await coordinator.store.async_set(STORE_CURRENT, _ACTIVE)
  645. mock_switch = MagicMock()
  646. mock_switch.async_turn_on = AsyncMock()
  647. mock_switch.async_turn_off = AsyncMock()
  648. coordinator._room_state_switch = mock_switch
  649. with (
  650. patch.object(coordinator, "_is_mode_sync_on", return_value=False),
  651. patch("custom_components.room_cal_ha.coordinator.dt_util.now", return_value=_RECONCILE_NOW),
  652. ):
  653. await coordinator.async_reconcile_from_store()
  654. mock_switch.async_turn_on.assert_not_awaited()
  655. mock_switch.async_turn_off.assert_not_awaited()
  656. # ---------------------------------------------------------------------------
  657. # _diff_with_unifi_check
  658. # ---------------------------------------------------------------------------
  659. _ACTIVE_WIFI_RES = ReservationData(
  660. check_in_date=date(2026, 7, 1),
  661. check_in_time=time(14, 0),
  662. check_out_date=date(2026, 7, 5),
  663. check_out_time=time(12, 0),
  664. wifi_ssid="GuestNet",
  665. wifi_key="correct-key",
  666. )
  667. _DURING_WINDOW = datetime(2026, 7, 3, 12, 0, 0)
  668. def _unifi_diff(coordinator, old, new, now, *, enabled, key):
  669. with (
  670. patch.object(coordinator, "_is_use_unifi_on", return_value=True),
  671. patch("custom_components.room_cal_ha.wifi.get_wlan_state", return_value=(enabled, key)),
  672. ):
  673. return coordinator._diff_with_unifi_check(old, new, now)
  674. async def test_unifi_diff_ssid_disabled_adds_checkin_needed(coordinator):
  675. diff = _unifi_diff(coordinator, None, _ACTIVE_WIFI_RES, _DURING_WINDOW, enabled=False, key="correct-key")
  676. assert diff.checkin_needed
  677. async def test_unifi_diff_key_mismatch_adds_wifi_key_changed(coordinator):
  678. diff = _unifi_diff(coordinator, _ACTIVE_WIFI_RES, _ACTIVE_WIFI_RES, _DURING_WINDOW, enabled=True, key="wrong-key")
  679. assert diff.wifi_key_changed
  680. async def test_unifi_diff_ssid_disabled_and_key_wrong_sets_both(coordinator):
  681. diff = _unifi_diff(coordinator, _ACTIVE_WIFI_RES, _ACTIVE_WIFI_RES, _DURING_WINDOW, enabled=False, key="wrong-key")
  682. assert diff.checkin_needed
  683. assert diff.wifi_key_changed
  684. async def test_unifi_diff_state_matches_no_extra_flags(coordinator):
  685. diff = _unifi_diff(coordinator, _ACTIVE_WIFI_RES, _ACTIVE_WIFI_RES, _DURING_WINDOW, enabled=True, key="correct-key")
  686. assert not diff.has_changes
  687. async def test_unifi_diff_skipped_when_use_unifi_off(coordinator):
  688. with (
  689. patch.object(coordinator, "_is_use_unifi_on", return_value=False),
  690. patch("custom_components.room_cal_ha.wifi.get_wlan_state") as mock_get,
  691. ):
  692. diff = coordinator._diff_with_unifi_check(_ACTIVE_WIFI_RES, _ACTIVE_WIFI_RES, _DURING_WINDOW)
  693. mock_get.assert_not_called()
  694. assert not diff.has_changes # base diff: same record, no changes; unifi check skipped
  695. async def test_unifi_diff_skipped_when_window_not_active(coordinator):
  696. before_window = datetime(2026, 6, 30, 12, 0, 0)
  697. with (
  698. patch.object(coordinator, "_is_use_unifi_on", return_value=True),
  699. patch("custom_components.room_cal_ha.wifi.get_wlan_state") as mock_get,
  700. ):
  701. diff = coordinator._diff_with_unifi_check(None, _ACTIVE_WIFI_RES, before_window)
  702. mock_get.assert_not_called()
  703. assert not diff.has_changes
  704. async def test_unifi_diff_skipped_when_hub_unavailable(coordinator):
  705. diff = _unifi_diff(coordinator, _ACTIVE_WIFI_RES, _ACTIVE_WIFI_RES, _DURING_WINDOW, enabled=None, key=None)
  706. assert not diff.has_changes
  707. async def test_unifi_diff_key_check_skipped_when_actual_key_none(coordinator):
  708. # Controller doesn't expose passphrase — only enabled state checked.
  709. diff = _unifi_diff(coordinator, _ACTIVE_WIFI_RES, _ACTIVE_WIFI_RES, _DURING_WINDOW, enabled=True, key=None)
  710. assert not diff.has_changes
  711. async def test_unifi_diff_preserves_original_diff_flags(coordinator):
  712. # Even when UniFi state is clean, original checkin_needed from the base diff is kept.
  713. old_inactive = ReservationData(wifi_ssid="GuestNet", wifi_key="correct-key") # no dates → not active
  714. diff = _unifi_diff(coordinator, old_inactive, _ACTIVE_WIFI_RES, _DURING_WINDOW, enabled=True, key="correct-key")
  715. assert diff.checkin_needed # from reservation_diff: old not active, new is active