Jelle Lauwers
9ab3c5827c
The gate holds finish_time at its last reported value until a new one differs by at least a configured number of minutes, regardless of how long that difference has been building up -- a magnitude-based deadband, not a time-based debounce (which would wait for the value to stay put for N minutes before accepting it). debounce invited the wrong mental model for anyone reading the option name or the code later, so rename it throughout before the option name ships: CONF_FINISH_TIME_DEBOUNCE_MINUTES -> CONF_FINISH_TIME_HYSTERESIS_MINUTES, SensorDesc.debounce -> hysteresis, LocalThingsSensor._debounce/_debounced_value -> _apply_hysteresis/ _hysteresis_value, and the options-flow data key/translations to match.
101 lines
3.4 KiB
Python
101 lines
3.4 KiB
Python
"""Unit tests for LocalThingsSensor's hysteresis gate (finish_time churn)."""
|
|
from __future__ import annotations
|
|
|
|
from datetime import datetime, timedelta, timezone
|
|
|
|
from custom_components.localthings.const import CONF_FINISH_TIME_HYSTERESIS_MINUTES
|
|
from custom_components.localthings.registry.capabilities.operational import OPERATIONAL_STATE
|
|
from custom_components.localthings.registry.discovery import BoundEntity
|
|
from custom_components.localthings.sensor import LocalThingsSensor
|
|
|
|
_FINISH_TIME_DESC = next(e for e in OPERATIONAL_STATE.entities if e.key == 'finish_time')
|
|
|
|
|
|
class _FakeConfigEntry:
|
|
def __init__(self, options):
|
|
self.options = options
|
|
|
|
|
|
class _FakeCoordinator:
|
|
"""Just enough surface for LocalThingsEntity/LocalThingsSensor."""
|
|
|
|
def __init__(self, threshold_minutes):
|
|
self.device_serial = 'TEST-SERIAL'
|
|
self.config_entry = _FakeConfigEntry({
|
|
CONF_FINISH_TIME_HYSTERESIS_MINUTES: threshold_minutes,
|
|
})
|
|
self.data: dict = {}
|
|
|
|
|
|
def _sensor(threshold_minutes=3):
|
|
coordinator = _FakeCoordinator(threshold_minutes)
|
|
bound = BoundEntity(
|
|
href=OPERATIONAL_STATE.href, capability=OPERATIONAL_STATE, desc=_FINISH_TIME_DESC,
|
|
)
|
|
sensor = LocalThingsSensor(coordinator, bound)
|
|
return sensor, coordinator
|
|
|
|
|
|
def test_small_change_is_suppressed():
|
|
sensor, coordinator = _sensor(threshold_minutes=3)
|
|
base = datetime(2026, 7, 31, 17, 0, tzinfo=timezone.utc)
|
|
|
|
coordinator.data = {'finish_time': base}
|
|
assert sensor.native_value == base
|
|
|
|
coordinator.data = {'finish_time': base + timedelta(minutes=1)}
|
|
assert sensor.native_value == base, "a 1-minute wobble should be held back"
|
|
|
|
|
|
def test_change_past_threshold_is_reported():
|
|
sensor, coordinator = _sensor(threshold_minutes=3)
|
|
base = datetime(2026, 7, 31, 17, 0, tzinfo=timezone.utc)
|
|
|
|
coordinator.data = {'finish_time': base}
|
|
assert sensor.native_value == base
|
|
|
|
new = base + timedelta(minutes=5)
|
|
coordinator.data = {'finish_time': new}
|
|
assert sensor.native_value == new
|
|
|
|
|
|
def test_zero_threshold_disables_hysteresis():
|
|
sensor, coordinator = _sensor(threshold_minutes=0)
|
|
base = datetime(2026, 7, 31, 17, 0, tzinfo=timezone.utc)
|
|
|
|
coordinator.data = {'finish_time': base}
|
|
assert sensor.native_value == base
|
|
|
|
new = base + timedelta(seconds=1)
|
|
coordinator.data = {'finish_time': new}
|
|
assert sensor.native_value == new
|
|
|
|
|
|
def test_cycle_end_passes_through_immediately():
|
|
"""A cycle ending (finish_time -> None) must never be held back."""
|
|
sensor, coordinator = _sensor(threshold_minutes=3)
|
|
base = datetime(2026, 7, 31, 17, 0, tzinfo=timezone.utc)
|
|
|
|
coordinator.data = {'finish_time': base}
|
|
assert sensor.native_value == base
|
|
|
|
coordinator.data = {'finish_time': None}
|
|
assert sensor.native_value is None
|
|
|
|
|
|
def test_non_hysteresis_sensor_is_unaffected():
|
|
"""A SensorDesc without hysteresis=True reads straight through, unchanged."""
|
|
machine_state_desc = next(
|
|
e for e in OPERATIONAL_STATE.entities if e.key == 'machine_state'
|
|
)
|
|
coordinator = _FakeCoordinator(threshold_minutes=3)
|
|
bound = BoundEntity(
|
|
href=OPERATIONAL_STATE.href, capability=OPERATIONAL_STATE, desc=machine_state_desc,
|
|
)
|
|
sensor = LocalThingsSensor(coordinator, bound)
|
|
|
|
coordinator.data = {'machine_state': 'active'}
|
|
assert sensor.native_value == 'active'
|
|
coordinator.data = {'machine_state': 'idle'}
|
|
assert sensor.native_value == 'idle'
|