test_arrived_departed.py 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298
  1. """Tests for Arrived/Departed binary sensors, Guest Arrived/Departed buttons,
  2. and coordinator arrived/departed flag lifecycle.
  3. Uses object.__new__ for pure-unit tests and hass fixtures for coordinator integration.
  4. """
  5. from datetime import date, time
  6. from unittest.mock import AsyncMock, MagicMock, patch
  7. import pytest
  8. from homeassistant.core import HomeAssistant
  9. from pytest_homeassistant_custom_component.common import MockConfigEntry
  10. from custom_components.room_cal_ha.binary_sensor import ArrivedSensor, DepartedSensor
  11. from custom_components.room_cal_ha.button import GuestArrivedButton, GuestDepartedButton
  12. from custom_components.room_cal_ha.const import (
  13. CONF_GUEST_SCRIPT,
  14. CONF_SYNC_MODE,
  15. DOMAIN,
  16. STORE_CURRENT,
  17. STORE_NEXT,
  18. SYNC_MODE_CALDAV,
  19. SYNC_MODE_MANUAL,
  20. )
  21. from custom_components.room_cal_ha.coordinator import CoordinatorData, RoomCalCoordinator
  22. from custom_components.room_cal_ha.models import ReservationData
  23. _ALICE = 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. )
  30. _BOB = ReservationData(
  31. guest_name="Bob",
  32. check_in_date=date(2026, 7, 6),
  33. check_in_time=time(15, 0),
  34. check_out_date=date(2026, 7, 10),
  35. check_out_time=time(11, 0),
  36. )
  37. _BASE_DATA = {"room_state_name": "Room State"}
  38. def _make_entry(hass, options: dict) -> MockConfigEntry:
  39. entry = MockConfigEntry(domain=DOMAIN, data=_BASE_DATA, options=options)
  40. entry.add_to_hass(hass)
  41. return entry
  42. # ---------------------------------------------------------------------------
  43. # ArrivedSensor / DepartedSensor unit tests
  44. # ---------------------------------------------------------------------------
  45. def _data(arrived=False, departed=False) -> CoordinatorData:
  46. return CoordinatorData(
  47. current=ReservationData(),
  48. next=ReservationData(),
  49. current_last_refresh=None,
  50. next_last_refresh=None,
  51. current_arrived=arrived,
  52. current_departed=departed,
  53. )
  54. def _arrived_sensor(arrived=False) -> ArrivedSensor:
  55. s = object.__new__(ArrivedSensor)
  56. s.coordinator = MagicMock()
  57. s.coordinator.data = _data(arrived=arrived)
  58. return s
  59. def _departed_sensor(departed=False) -> DepartedSensor:
  60. s = object.__new__(DepartedSensor)
  61. s.coordinator = MagicMock()
  62. s.coordinator.data = _data(departed=departed)
  63. return s
  64. def test_arrived_sensor_default_false():
  65. assert _arrived_sensor(arrived=False).is_on is False
  66. def test_arrived_sensor_true_when_set():
  67. assert _arrived_sensor(arrived=True).is_on is True
  68. def test_departed_sensor_default_false():
  69. assert _departed_sensor(departed=False).is_on is False
  70. def test_departed_sensor_true_when_set():
  71. assert _departed_sensor(departed=True).is_on is True
  72. # ---------------------------------------------------------------------------
  73. # GuestArrivedButton / GuestDepartedButton unit tests
  74. # ---------------------------------------------------------------------------
  75. def _arrived_button() -> GuestArrivedButton:
  76. btn = object.__new__(GuestArrivedButton)
  77. btn._coordinator = MagicMock()
  78. btn._coordinator.async_set_arrived = AsyncMock()
  79. return btn
  80. def _departed_button() -> GuestDepartedButton:
  81. btn = object.__new__(GuestDepartedButton)
  82. btn._coordinator = MagicMock()
  83. btn._coordinator.async_set_departed = AsyncMock()
  84. return btn
  85. async def test_arrived_button_calls_set_arrived_true():
  86. btn = _arrived_button()
  87. await btn.async_press()
  88. btn._coordinator.async_set_arrived.assert_awaited_once_with(True)
  89. async def test_departed_button_calls_set_departed_true():
  90. btn = _departed_button()
  91. await btn.async_press()
  92. btn._coordinator.async_set_departed.assert_awaited_once_with(True)
  93. # ---------------------------------------------------------------------------
  94. # Coordinator: async_set_arrived / async_set_departed
  95. # ---------------------------------------------------------------------------
  96. @pytest.fixture
  97. async def coord(hass: HomeAssistant):
  98. entry = _make_entry(hass, {CONF_SYNC_MODE: SYNC_MODE_MANUAL})
  99. c = RoomCalCoordinator(hass, entry)
  100. await c.async_setup()
  101. await c.async_refresh()
  102. return c
  103. async def test_set_arrived_sets_flag(coord: RoomCalCoordinator):
  104. await coord.async_set_arrived(True)
  105. assert coord._current_arrived is True
  106. assert coord.data.current_arrived is True
  107. async def test_set_arrived_persists_to_store(coord: RoomCalCoordinator):
  108. await coord.async_set_arrived(True)
  109. assert coord.store.get_arrived() is True
  110. async def test_set_departed_sets_flag(coord: RoomCalCoordinator):
  111. await coord.async_set_departed(True)
  112. assert coord._current_departed is True
  113. assert coord.data.current_departed is True
  114. async def test_set_departed_persists_to_store(coord: RoomCalCoordinator):
  115. await coord.async_set_departed(True)
  116. assert coord.store.get_departed() is True
  117. async def test_flags_load_from_store_on_startup(hass: HomeAssistant):
  118. entry = _make_entry(hass, {CONF_SYNC_MODE: SYNC_MODE_MANUAL})
  119. c = RoomCalCoordinator(hass, entry)
  120. await c.async_setup()
  121. await c.store.async_set_arrived(True)
  122. await c.store.async_set_departed(True)
  123. c2 = RoomCalCoordinator(hass, entry)
  124. await c2.async_setup()
  125. assert c2._current_arrived is True
  126. assert c2._current_departed is True
  127. # ---------------------------------------------------------------------------
  128. # Coordinator: flag reset on reservation identity change
  129. # ---------------------------------------------------------------------------
  130. async def test_flags_reset_when_reservation_changes(hass: HomeAssistant):
  131. entry = _make_entry(hass, {CONF_SYNC_MODE: SYNC_MODE_CALDAV, "caldav_url": "https://x", "calendar_name": "R"})
  132. c = RoomCalCoordinator(hass, entry)
  133. await c.async_setup()
  134. # Load Alice as current
  135. with patch("custom_components.room_cal_ha.coordinator.CalDavBackend") as M:
  136. M.return_value.async_fetch = AsyncMock(return_value=(_ALICE, None))
  137. await c.async_refresh()
  138. await c.async_set_arrived(True)
  139. assert c._current_arrived is True
  140. # Bob becomes current — different check-in identity
  141. with patch("custom_components.room_cal_ha.coordinator.CalDavBackend") as M:
  142. M.return_value.async_fetch = AsyncMock(return_value=(_BOB, None))
  143. await c.async_refresh()
  144. assert c._current_arrived is False
  145. assert c.data.current_arrived is False
  146. assert c.store.get_arrived() is False
  147. async def test_flags_not_reset_when_same_reservation(hass: HomeAssistant):
  148. entry = _make_entry(hass, {CONF_SYNC_MODE: SYNC_MODE_CALDAV, "caldav_url": "https://x", "calendar_name": "R"})
  149. c = RoomCalCoordinator(hass, entry)
  150. await c.async_setup()
  151. with patch("custom_components.room_cal_ha.coordinator.CalDavBackend") as M:
  152. M.return_value.async_fetch = AsyncMock(return_value=(_ALICE, None))
  153. await c.async_refresh()
  154. await c.async_set_arrived(True)
  155. # Same Alice again — no identity change
  156. with patch("custom_components.room_cal_ha.coordinator.CalDavBackend") as M:
  157. M.return_value.async_fetch = AsyncMock(return_value=(_ALICE, None))
  158. await c.async_refresh()
  159. assert c._current_arrived is True
  160. assert c.data.current_arrived is True
  161. async def test_flags_reset_on_promote_from_next(coord: RoomCalCoordinator):
  162. await coord.store.async_set(STORE_CURRENT, _ALICE)
  163. await coord.store.async_set(STORE_NEXT, _BOB)
  164. await coord.async_refresh()
  165. await coord.async_set_arrived(True)
  166. await coord.async_promote_next_to_current()
  167. assert coord._current_arrived is False
  168. assert coord.data.current_arrived is False
  169. async def test_flags_reset_on_clear_current(coord: RoomCalCoordinator):
  170. await coord.store.async_set(STORE_CURRENT, _ALICE)
  171. await coord.async_refresh()
  172. await coord.async_set_arrived(True)
  173. await coord.async_clear_current()
  174. assert coord._current_arrived is False
  175. assert coord.data.current_arrived is False
  176. async def test_flags_reset_on_checkout(coord: RoomCalCoordinator):
  177. await coord.store.async_set(STORE_CURRENT, _ALICE)
  178. await coord.async_refresh()
  179. await coord.async_set_arrived(True)
  180. await coord._async_do_check_out()
  181. assert coord._current_arrived is False
  182. assert coord.data.current_arrived is False
  183. # ---------------------------------------------------------------------------
  184. # Script dispatch
  185. # ---------------------------------------------------------------------------
  186. async def test_set_arrived_dispatches_script(hass: HomeAssistant):
  187. entry = _make_entry(hass, {CONF_SYNC_MODE: SYNC_MODE_MANUAL, CONF_GUEST_SCRIPT: "script.guest_event"})
  188. c = RoomCalCoordinator(hass, entry)
  189. await c.async_setup()
  190. await c.async_refresh()
  191. with patch.object(c, "_async_run_guest_script", new=AsyncMock()) as mock_script:
  192. await c.async_set_arrived(True)
  193. mock_script.assert_awaited_once_with("arrived")
  194. async def test_set_departed_dispatches_script(hass: HomeAssistant):
  195. entry = _make_entry(hass, {CONF_SYNC_MODE: SYNC_MODE_MANUAL, CONF_GUEST_SCRIPT: "script.guest_event"})
  196. c = RoomCalCoordinator(hass, entry)
  197. await c.async_setup()
  198. await c.async_refresh()
  199. with patch.object(c, "_async_run_guest_script", new=AsyncMock()) as mock_script:
  200. await c.async_set_departed(True)
  201. mock_script.assert_awaited_once_with("departed")
  202. async def test_no_script_dispatched_when_setting_false(hass: HomeAssistant):
  203. entry = _make_entry(hass, {CONF_SYNC_MODE: SYNC_MODE_MANUAL, CONF_GUEST_SCRIPT: "script.guest_event"})
  204. c = RoomCalCoordinator(hass, entry)
  205. await c.async_setup()
  206. await c.async_refresh()
  207. with patch.object(c, "_async_run_guest_script", new=AsyncMock()) as mock_script:
  208. await c.async_set_arrived(False)
  209. mock_script.assert_not_awaited()
  210. async def test_async_run_guest_script_no_op_when_not_configured(coord: RoomCalCoordinator):
  211. # coord has no CONF_GUEST_SCRIPT — should return early with no error
  212. await coord._async_run_guest_script("arrived")