Add automated tests and switch to poetry.

Author: lexbrugman

.github/workflows/publisher.yaml

@@ -3,14 +3,37 @@ name: Publisher
 on:
   push:
     branches:
-      - dev
+      - '**'
     tags:
-      - v*
+      - '*'
 
 jobs:
+  tests:
+    runs-on: ubuntu-latest
+    name: Test
+    steps:
+      - name: Check out the repository
+        uses: actions/checkout@v6.0.2
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install poetry
+          python -m poetry install --with dev --no-interaction --no-ansi
+
+      - name: Run tests
+        run: python -m poetry run pytest
+
   publish:
     runs-on: ubuntu-latest
     name: Publish
+    needs: tests
+    if: ${{ (github.ref_type == 'branch' && github.ref_name == 'dev') || (github.ref_type == 'tag' && startsWith(github.ref_name, 'v')) }}
     steps:
       - name: Check out the repository
         uses: actions/checkout@v6.0.2

README.md

@@ -19,3 +19,19 @@ Depends on Home Assistant for presence and weather information.
 2. Open the menu (**⋮**) and choose **Repositories**.
 3. Add <https://github.com/lexbrugman/ha-apps> as a repository.
 4. Find **Evohome Helper** in the store and install it.
+
+
+## Development
+
+This project uses [Poetry](https://python-poetry.org/) for dependency management.
+
+```bash
+poetry install --with dev
+poetry run pytest
+```
+
+Run the service locally with:
+
+```bash
+poetry run python src/main.py
+```

poetry.lock

@@ -0,0 +1,18 @@
+[tool.poetry]
+package-mode = false
+
+[tool.poetry.dependencies]
+python = ">=3.10,<4.0"
+evohomeclient = "0.3.9"
+requests = "2.32.5"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "9.0.2"
+freezegun = "1.5.5"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]

pyproject.toml

@@ -28,6 +28,14 @@ def __init__(self, mode, status):
     def get_all(cls):
         return set(cls)
 
+    @classmethod
+    def get_by_status(cls, status_code: int):
+        for status in cls:
+            if status.status == status_code:
+                return status
+
+        return None
+
     @classmethod
     def get_by_mode(cls, mode: str):
         for status in cls:

src/evohome_helper/evohome.py

@@ -39,6 +39,8 @@ def function_wrapper(*args, **kwargs):
                 **kwargs
             )
 
+        function_wrapper.cache_clear = _cache_call.cache_clear
+
         return function_wrapper
 
     return function_decorator

src/evohome_helper/func_tools.py

@@ -19,7 +19,7 @@ def is_someone_home():
 def is_in_away_grace_period():
     for entity_id in settings.HOMEASSISTANT_PRESENCE_ENTITIES:
         seconds_since_last_seen = _get_data(entity_id).get("seconds_since_last_seen")
-        if seconds_since_last_seen and seconds_since_last_seen <= settings.PRESENCE_LAST_HOME_GRACE_TIME:
+        if seconds_since_last_seen is not None and seconds_since_last_seen <= settings.PRESENCE_LAST_HOME_GRACE_TIME:
             return True
 
     return False

src/evohome_helper/presence.py

@@ -6,6 +6,9 @@
 
 from logging import config as log_config
 
+from evohome_helper import evohome
+from evohome_helper import presence
+
 log_config.fileConfig(os.path.join(os.path.dirname(__file__), "logging.conf"))
 logger = logging.getLogger(__name__)
 
@@ -41,9 +44,6 @@ def set_thermostat_mode():
 
 
 if __name__ == "__main__":
-    from evohome_helper import evohome
-    from evohome_helper import presence
-
     while True:
         try:
             set_thermostat_mode()

src/main.py

@@ -0,0 +1,206 @@
+import sys
+import types
+from dataclasses import dataclass, field
+from unittest.mock import Mock
+
+import pytest
+
+
+def _switchpoint(time_of_day, heat_setpoint):
+    return {"TimeOfDay": time_of_day, "heatSetpoint": heat_setpoint}
+
+
+def _day_schedule(day_of_week, switchpoints):
+    return {"DayOfWeek": day_of_week, "Switchpoints": switchpoints}
+
+
+def _switch_point_reference(day_of_week, time_of_day):
+    return {"DayOfWeek": day_of_week, "TimeOfDay": time_of_day}
+
+
+if "settings" not in sys.modules:
+    settings = types.SimpleNamespace(
+        EVOHOME_USERNAME="user",
+        EVOHOME_PASSWORD="pass",
+        EVOHOME_LOCATION_NAME="Home",
+        EVOHOME_OFF_TEMP_THRESHOLD=5,
+        EVOHOME_AWAY_MODE="away",
+        AUTO_ECO_ENABLED=True,
+        AUTO_ECO_OUTSIDE_TEMP_THRESHOLD=14,
+        AUTO_ECO_INSIDE_TEMP_DIFF=2,
+        PRESENCE_HEATING_SCHEDULE_GRACE_TIME=1800,
+        PRESENCE_LAST_HOME_GRACE_TIME=1200,
+        HOMEASSISTANT_URL="http://ha.local",
+        HOMEASSISTANT_TOKEN="token",
+        HOMEASSISTANT_AUTO_ECO_WEATHER_ENTITY="weather.home",
+        HOMEASSISTANT_PRESENCE_ENTITIES=["person.a", "person.b"],
+    )
+    sys.modules["settings"] = settings
+
+
+if "evohomeclient2" not in sys.modules:
+    class DummyBaseClient:
+        def __init__(self, *_args, **_kwargs):
+            self.locations = []
+
+        def installation(self):
+            return None
+
+    sys.modules["evohomeclient2"] = types.SimpleNamespace(EvohomeClient=DummyBaseClient)
+
+
+@dataclass
+class FakeZone:
+    name: str = "zone"
+    activeFaults: list = field(default_factory=list)
+    setpointStatus: dict = field(default_factory=lambda: {"setpointMode": "FollowSchedule", "targetHeatTemperature": 20})
+    temperatureStatus: dict = field(default_factory=lambda: {"temperature": 19})
+    _schedule: dict = field(default_factory=lambda: {"DailySchedules": []})
+
+    def schedule(self):
+        return self._schedule
+
+    def set_schedule(self, daily_schedules):
+        self._schedule = {"DailySchedules": daily_schedules}
+
+    def set_weekly_schedule(self, setpoint=20, time_of_day="07:00:00"):
+        self._schedule = {
+            "DailySchedules": [
+                _day_schedule(day, [_switchpoint(time_of_day, setpoint)])
+                for day in range(7)
+            ]
+        }
+
+
+@dataclass
+class FakeControlSystem:
+    mode: str = "Auto"
+    zones: dict = field(default_factory=dict)
+    systemId: str = "system-1"
+    def __post_init__(self):
+        self.systemModeStatus = {"mode": self.mode}
+        self.set_status = Mock(side_effect=self._set_status)
+
+    def _set_status(self, status):
+        from evohome_helper.evohome import ThermostatStatus
+
+        next_status = ThermostatStatus.get_by_status(status)
+        if next_status is not None:
+            self.systemModeStatus["mode"] = next_status.mode
+
+
+@dataclass
+class FakeGateway:
+    control_systems: dict
+
+
+@dataclass
+class FakeLocation:
+    name: str = "Home"
+    gateways: dict = field(default_factory=dict)
+
+
+@dataclass
+class FakeEvohomeClient:
+    locations: list = field(default_factory=list)
+    installation_calls: int = 0
+
+    def installation(self):
+        self.installation_calls += 1
+
+    def get_location(self, name):
+        self.installation()
+        for location in self.locations:
+            if location.name == name:
+                return location
+        return None
+
+
+@pytest.fixture
+def evohome_factory():
+    class Factory:
+        @staticmethod
+        def weekly_schedule(setpoint=20, time_of_day="07:00:00"):
+            return {
+                "DailySchedules": [
+                    Factory.day_schedule(day, [Factory.switchpoint(time_of_day, setpoint)])
+                    for day in range(7)
+                ]
+            }
+
+        @staticmethod
+        def day_schedule(day_of_week, switchpoints):
+            return _day_schedule(day_of_week, switchpoints)
+
+        @staticmethod
+        def switchpoint(time_of_day, heat_setpoint):
+            return _switchpoint(time_of_day, heat_setpoint)
+
+        @staticmethod
+        def switch_point_reference(day_of_week, time_of_day):
+            return _switch_point_reference(day_of_week, time_of_day)
+
+        @staticmethod
+        def zone(**kwargs):
+            return FakeZone(**kwargs)
+
+        @staticmethod
+        def control_system(mode="Auto", zones=None, system_id="system-1"):
+            return FakeControlSystem(mode=mode, zones=zones or {}, systemId=system_id)
+
+        @staticmethod
+        def location(*, name="Home", control_systems=None, gateway_id="gateway-1"):
+            return FakeLocation(name=name, gateways={gateway_id: FakeGateway(control_systems=control_systems or {})})
+
+        @staticmethod
+        def complete_state(*, location_name="Home", zone_mode="FollowSchedule", system_mode="Auto", with_fault=False, setpoint=21):
+            zone = FakeZone(
+                name="Living",
+                setpointStatus={"setpointMode": zone_mode, "targetHeatTemperature": setpoint},
+                temperatureStatus={"temperature": 20},
+                activeFaults=["fault"] if with_fault else [],
+            )
+            control = FakeControlSystem(mode=system_mode, zones={"z1": zone}, systemId="sys-1")
+            location = FakeLocation(name=location_name, gateways={"g1": FakeGateway(control_systems={"c1": control})})
+            return {"location": location, "control_system": control, "zone": zone}
+
+    return Factory
+
+
+@pytest.fixture
+def evohome_client(evohome_factory):
+    from evohome_helper import evohome
+
+    def _build(*, location_name="Home", **state_kwargs):
+        state = evohome_factory.complete_state(location_name=location_name, **state_kwargs)
+        client = FakeEvohomeClient(locations=[state["location"]])
+        evohome._evohome_client = client
+        return client, state
+
+    yield _build
+    evohome._evohome_client = None
+
+
+@pytest.fixture
+def patch_evohome_client_class(monkeypatch):
+    from evohome_helper import evohome
+
+    def _apply(client_class):
+        monkeypatch.setattr("evohome_helper.evohome.EvohomeClient", client_class)
+        monkeypatch.setattr("evohome_helper.evohome.sleep", lambda _seconds: None)
+        evohome._evohome_client = None
+
+    yield _apply
+    evohome._evohome_client = None
+
+
+@pytest.fixture(autouse=True)
+def reset_cached_state():
+    from evohome_helper import presence, weather
+
+    presence.last_known_presence_state.clear()
+
+    presence._get_data.cache_clear()
+    weather.get_temperature.cache_clear()
+
+