Merge pull request #165 from jbergler/refactor-test-infra

update test infra to make testing different combinations of features easier

Author: jbergler

tests/conftest.py

@@ -1,6 +1,7 @@
 """Global fixtures for ttlock integration."""
 
 from time import time
+from typing import NamedTuple
 from unittest.mock import patch
 
 from aiohttp import ClientSession
@@ -18,7 +19,12 @@
 from homeassistant.core import HomeAssistant
 from homeassistant.setup import async_setup_component
 
-from .const import LOCK_DETAILS, LOCK_STATE_UNLOCKED, PASSAGE_MODE_6_TO_6_7_DAYS
+from .const import (
+    BASIC_LOCK_DETAILS,
+    LOCK_STATE_LOCKED,
+    LOCK_STATE_UNLOCKED,
+    PASSAGE_MODE_6_TO_6_7_DAYS,
+)
 
 pytest_plugins = "pytest_homeassistant_custom_component"
 
@@ -93,22 +99,72 @@ async def coordinator(hass, api):
     return LockUpdateCoordinator(hass, api, 7252408)
 
 
+class MockApiData(NamedTuple):
+    """Container for mock API response data."""
+
+    lock: Lock
+    state: LockState
+    passage_mode: PassageModeConfig | None
+
+
 @pytest.fixture
-def sane_default_data():
-    """Fixture for mocking sane default data from the API."""
-
-    lock = Lock.parse_obj(LOCK_DETAILS)
-    state = LockState.parse_obj(LOCK_STATE_UNLOCKED)
-    passage_mode_config = PassageModeConfig.parse_obj(PASSAGE_MODE_6_TO_6_7_DAYS)
-
-    with patch(
-        "custom_components.ttlock.api.TTLockApi.get_locks", return_value=[lock.id]
-    ), patch(
-        "custom_components.ttlock.api.TTLockApi.get_lock", return_value=lock
-    ), patch(
-        "custom_components.ttlock.api.TTLockApi.get_lock_state", return_value=state
-    ), patch(
-        "custom_components.ttlock.api.TTLockApi.get_lock_passage_mode_config",
-        return_value=passage_mode_config,
-    ):
-        yield
+def mock_data_factory():
+    """Factory fixture to create different sets of mock data."""
+
+    def create_mock_data(scenario: str = "default") -> MockApiData:
+        scenarios = {
+            "default": MockApiData(
+                lock=Lock.parse_obj(BASIC_LOCK_DETAILS),
+                state=LockState.parse_obj(LOCK_STATE_UNLOCKED),
+                passage_mode=PassageModeConfig.parse_obj(PASSAGE_MODE_6_TO_6_7_DAYS),
+            ),
+            "locked": MockApiData(
+                lock=Lock.parse_obj(BASIC_LOCK_DETAILS),
+                state=LockState.parse_obj(LOCK_STATE_LOCKED),
+                passage_mode=PassageModeConfig.parse_obj(PASSAGE_MODE_6_TO_6_7_DAYS),
+            ),
+            "no_passage_mode": MockApiData(
+                lock=Lock.parse_obj(BASIC_LOCK_DETAILS),
+                state=LockState.parse_obj(LOCK_STATE_UNLOCKED),
+                passage_mode=None,
+            ),
+        }
+        return scenarios[scenario]
+
+    return create_mock_data
+
+
+@pytest.fixture
+def mock_api_responses(monkeypatch, mock_data_factory):
+    """Fixture for mocking TTLock API responses with configurable data."""
+
+    def create_mock_responses(scenario: str = "default"):
+        mock_data = mock_data_factory(scenario)
+
+        async def mock_get_locks(*args, **kwargs):
+            return [mock_data.lock.id]
+
+        async def mock_get_lock(*args, **kwargs):
+            return mock_data.lock
+
+        async def mock_get_lock_state(*args, **kwargs):
+            return mock_data.state
+
+        async def mock_get_passage_mode(*args, **kwargs):
+            return mock_data.passage_mode
+
+        monkeypatch.setattr(
+            "custom_components.ttlock.api.TTLockApi.get_locks", mock_get_locks
+        )
+        monkeypatch.setattr(
+            "custom_components.ttlock.api.TTLockApi.get_lock", mock_get_lock
+        )
+        monkeypatch.setattr(
+            "custom_components.ttlock.api.TTLockApi.get_lock_state", mock_get_lock_state
+        )
+        monkeypatch.setattr(
+            "custom_components.ttlock.api.TTLockApi.get_lock_passage_mode_config",
+            mock_get_passage_mode,
+        )
+
+    return create_mock_responses

tests/const.py

@@ -1,6 +1,6 @@
 """Dummy data for tests."""
 
-LOCK_DETAILS = {
+BASIC_LOCK_DETAILS = {
     "date": 1669690212000,
     "lockAlias": "Front Door",
     "lockSound": 2,
@@ -44,8 +44,9 @@
     "sensitivity": -1,
 }
 
-LOCK_STATE_LOCKED = {"state": 0}
-LOCK_STATE_UNLOCKED = {"state": 1}
+LOCK_STATE_LOCKED = {"state": 0, "electricQuantity": 90, "lockTime": 1621459200000}
+
+LOCK_STATE_UNLOCKED = {"state": 1, "electricQuantity": 90, "lockTime": 1621459200000}
 
 PASSAGE_MODE_6_TO_6_7_DAYS = {
     "autoUnlock": 2,
@@ -64,8 +65,8 @@
 }
 
 WEBHOOK_LOCK_10AM_UTC = {
-    "lockId": LOCK_DETAILS["lockId"],
-    "lockMac": LOCK_DETAILS["lockMac"],
+    "lockId": BASIC_LOCK_DETAILS["lockId"],
+    "lockMac": BASIC_LOCK_DETAILS["lockMac"],
     "electricQuantity": 40,
     "serverDate": 1682244497000,
     "lockDate": 1682244497000,
@@ -75,8 +76,8 @@
 }
 
 WEBHOOK_UNLOCK_10AM_UTC = {
-    "lockId": LOCK_DETAILS["lockId"],
-    "lockMac": LOCK_DETAILS["lockMac"],
+    "lockId": BASIC_LOCK_DETAILS["lockId"],
+    "lockMac": BASIC_LOCK_DETAILS["lockMac"],
     "electricQuantity": 40,
     "serverDate": 1682244497000,
     "lockDate": 1682244497000,

tests/test_coordinator.py

@@ -10,7 +10,7 @@
 from custom_components.ttlock.models import PassageModeConfig, WebhookEvent
 
 from .const import (
-    LOCK_DETAILS,
+    BASIC_LOCK_DETAILS,
     PASSAGE_MODE_6_TO_6_7_DAYS,
     PASSAGE_MODE_ALL_DAY_WEEKDAYS,
     WEBHOOK_LOCK_10AM_UTC,
@@ -19,11 +19,12 @@
 
 
 async def test_coordinator_loads_data(
-    coordinator: LockUpdateCoordinator, sane_default_data
+    coordinator: LockUpdateCoordinator, mock_api_responses
 ):
+    mock_api_responses("default")
     await coordinator.async_refresh()
 
-    assert coordinator.data.name == LOCK_DETAILS["lockAlias"]
+    assert coordinator.data.name == BASIC_LOCK_DETAILS["lockAlias"]
     assert coordinator.data.locked is False
     assert coordinator.data.action_pending is False
     assert coordinator.data.last_user is None
@@ -132,8 +133,9 @@ def test_is_none_when_passage_mode_is_all_day(self, lock_state, time):
 class TestLockUpdateCoordinator:
     class TestProcessWebhookData:
         async def test_lock_works(
-            self, coordinator: LockUpdateCoordinator, sane_default_data
+            self, coordinator: LockUpdateCoordinator, mock_api_responses
         ):
+            mock_api_responses("default")
             await coordinator.async_refresh()
             coordinator.data.locked = False
 
@@ -146,8 +148,9 @@ async def test_lock_works(
             assert coordinator.data.last_reason == "lock by lock key"
 
         async def test_unlock_works(
-            self, coordinator: LockUpdateCoordinator, sane_default_data
+            self, coordinator: LockUpdateCoordinator, mock_api_responses
         ):
+            mock_api_responses("default")
             await coordinator.async_refresh()
             coordinator.data.locked = True
             coordinator.data.auto_lock_seconds = -1
@@ -160,8 +163,9 @@ async def test_unlock_works(
             assert coordinator.data.last_reason == "unlock by IC card"
 
         async def test_auto_lock_works(
-            self, hass, coordinator: LockUpdateCoordinator, sane_default_data
+            self, hass, coordinator: LockUpdateCoordinator, mock_api_responses
         ):
+            mock_api_responses("default")
             await coordinator.async_refresh()
             coordinator.data.locked = True
             coordinator.data.auto_lock_seconds = 1

tests/test_init.py

@@ -7,8 +7,9 @@
 from homeassistant.helpers.network import NoURLAvailableError
 
 
-async def test_setup_unload_and_reload_entry(hass, component_setup, sane_default_data):
+async def test_setup_unload_and_reload_entry(hass, component_setup, mock_api_responses):
     """Test entry setup and unload."""
+    mock_api_responses("default")
     await component_setup()
 
     entries = hass.config_entries.async_entries(DOMAIN)
@@ -24,7 +25,8 @@ async def test_setup_unload_and_reload_entry(hass, component_setup, sane_default
     "homeassistant.components.webhook.async_generate_url",
     side_effect=NoURLAvailableError,
 )
-async def test_no_url(hass, component_setup, sane_default_data):
+async def test_no_url(hass, component_setup, mock_api_responses):
+    mock_api_responses("default")
     with patch("homeassistant.helpers.issue_registry.async_create_issue") as mock:
         assert await component_setup()
         assert mock.assert_called

tests/test_lock.py

@@ -0,0 +1,8 @@
+from homeassistant.core import HomeAssistant
+
+
+async def test_lock_states(hass: HomeAssistant, mock_api_responses, component_setup):
+    """Test different lock states."""
+    mock_api_responses("default")
+    coordinator = await component_setup()
+    assert not coordinator.data.locked

tests/test_services.py

@@ -16,8 +16,9 @@
 
 class Test_create_passcode:
     async def test_can_create_passcode(
-        self, hass: HomeAssistant, component_setup, sane_default_data
+        self, hass: HomeAssistant, component_setup, mock_api_responses
     ):
+        mock_api_responses("default")
         coordinator = await component_setup()
 
         attrs = {
@@ -54,9 +55,10 @@ async def test_can_create_passcode(
 class Test_cleanup_passcodes:
     @pytest.mark.parametrize("return_response", (True, False))
     async def test_works_when_there_is_nothing_to_do(
-        self, hass: HomeAssistant, component_setup, sane_default_data, return_response
+        self, hass: HomeAssistant, component_setup, mock_api_responses, return_response
     ) -> None:
         """Test get schedule service."""
+        mock_api_responses("default")
         coordinator = await component_setup()
 
         with patch(
@@ -81,9 +83,10 @@ async def test_works_when_there_is_an_expired_passcode(
         self,
         hass: HomeAssistant,
         component_setup,
-        sane_default_data,
+        mock_api_responses,
     ) -> None:
         """Test get schedule service."""
+        mock_api_responses("default")
         coordinator = await component_setup()
 
         with patch(