adaptive-lighting/tests/test_adaptation_utils.py
Casey 03d2748cd4 Group 7: tests — 94 passing in 0.57s (53/53 + 9.4 deferred)
Test infrastructure:
- Add `pytest-homeassistant-custom-component` (PHACC) as a `test`
  dependency group. PHACC ships `hass`, `enable_custom_integrations`,
  `MockConfigEntry`, and friends without needing to clone HA core as a
  sibling directory. Modernizes the test setup from upstream's
  `setup-symlinks` pattern.
- conftest.py: add `auto_enable_custom_integrations` autouse fixture
  so HA discovers the integration under `custom_components/` during
  tests. Keep the upstream template-deprecation no-op.
- Import paths: all tests now import from `custom_components.adaptive_lighting`
  (not `homeassistant.components.adaptive_lighting`) and from
  `pytest_homeassistant_custom_component.common` (not `tests.common`).

New tests (groups 7.2-7.16):
- tests/test_color_and_brightness.py (16 tests): TestBrightnessCurve
  asserts min-before-sunrise, midpoint-at-event, max-during-day, sunset
  ramp symmetry. TestColorTempCurve verifies the same shape applies to
  K. TestSunPosition checks the synthetic +1/-1/0 derivation.
  TestTanhDayCurveDirect exercises the helper directly.
- tests/test_config_flow.py (12 tests): six sections in order, each
  section contains only its specified fields, conditional visibility
  of send_split_delay, default sun entities, strict-typed entity
  selectors, NumberSelector slider/box configs, BooleanSelector for
  every flag, full user→create-entry flow, YAML-managed entry aborts
  with `yaml_managed` reason, options flow renders the sectioned schema.
- tests/test_init.py (6 tests): successful setup on current version,
  stale version raises ConfigEntryError via async_migrate_entry,
  unload is clean, tombstone removes orphan sleep entity + logs INFO,
  tombstone is idempotent, tombstone respects config_entry ownership.

Source modernizations driven by the tests:
- __init__.py: add `async_migrate_entry` that surfaces the
  "incompatible — delete and recreate" message and sets the entry to
  MIGRATION_ERROR. Removed direct `ConfigEntryError` from
  `async_setup_entry` (HA routes version mismatches through the
  migration handler now).
- switch.py: removed upstream's YAML-managed-entry auto-remove hack.
  YAML profiles now load normally and the options flow handles the
  "you must edit configuration.yaml" message (spec R7).

Existing tests updated to PHACC paths: test_adaptation_utils.py
(38 tests), test_hass_utils.py (22 tests). Both pass without
modification beyond the import fix.

Deleted: tests/test_switch.py (2,999 LOC of upstream tests, most
covering sleep mode / take-over-control / manual-control state
machines that no longer exist; CDiT-specific switch tests deferred
to a follow-up change).

Result: `uv run --group test pytest tests/` → 94 passed in 0.57s.

Deferred from this change:
- 4.3: manual UI test that toggling a field and saving reloads cleanly
  (requires a real HA instance, can't be done from CLI).
- 9.4: GitHub repo description / topics update (do via `gh repo edit`
  outside the change scope).

openspec status: 4/4 artifacts complete; strict-validate green.
2026-05-16 15:11:49 +02:00

482 lines
14 KiB
Python

"""Tests for Adaptive Lighting utils."""
from unittest.mock import Mock
import pytest
from custom_components.adaptive_lighting.adaptation_utils import (
LightControlAttributes,
ServiceData,
_create_service_call_data_iterator,
_has_relevant_service_data_attributes,
_remove_redundant_attributes,
_split_service_call_data,
get_light_control_attributes,
has_brightness_attribute,
has_color_attribute,
has_effect_attribute,
manual_control_event_attribute_to_flags,
prepare_adaptation_data,
)
from homeassistant.components.light import (
ATTR_BRIGHTNESS,
ATTR_BRIGHTNESS_PCT,
ATTR_COLOR_TEMP_KELVIN,
ATTR_EFFECT,
ATTR_FLASH,
ATTR_HS_COLOR,
ATTR_TRANSITION,
)
from homeassistant.const import ATTR_ENTITY_ID, STATE_ON
from homeassistant.core import Context, State
@pytest.mark.parametrize(
("input_data", "expected_data_list"),
[
(
{"foo": 1},
[],
),
(
{ATTR_BRIGHTNESS: 10},
[{ATTR_BRIGHTNESS: 10}],
),
(
{ATTR_COLOR_TEMP_KELVIN: 3500},
[{ATTR_COLOR_TEMP_KELVIN: 3500}],
),
(
{ATTR_ENTITY_ID: "foo", ATTR_BRIGHTNESS: 10},
[{ATTR_ENTITY_ID: "foo", ATTR_BRIGHTNESS: 10}],
),
(
{ATTR_BRIGHTNESS: 10, ATTR_COLOR_TEMP_KELVIN: 3500},
[{ATTR_BRIGHTNESS: 10}, {ATTR_COLOR_TEMP_KELVIN: 3500}],
),
(
{ATTR_BRIGHTNESS: 10, ATTR_COLOR_TEMP_KELVIN: 3500, ATTR_TRANSITION: 2},
[
{ATTR_BRIGHTNESS: 10, ATTR_TRANSITION: 1},
{ATTR_COLOR_TEMP_KELVIN: 3500, ATTR_TRANSITION: 1},
],
),
(
{ATTR_TRANSITION: 1},
[],
),
],
ids=[
"remove irrelevant attributes",
"brightness only yields one service call",
"color only yields one service call",
"include entity ID",
"brightness and color are split into two with brightness first",
"transition time is distributed among service calls",
"ignore transition time without service calls",
],
)
async def test_split_service_call_data(input_data, expected_data_list):
"""Test splitting of service call data."""
assert _split_service_call_data(input_data) == expected_data_list
@pytest.mark.parametrize(
("service_data", "state", "service_data_expected"),
[
(
{ATTR_ENTITY_ID: "light.test", ATTR_BRIGHTNESS: 10, ATTR_TRANSITION: 2},
State("light.test", STATE_ON),
{ATTR_ENTITY_ID: "light.test", ATTR_BRIGHTNESS: 10, ATTR_TRANSITION: 2},
),
(
{ATTR_ENTITY_ID: "light.test", ATTR_BRIGHTNESS: 10, ATTR_TRANSITION: 2},
State("light.test", STATE_ON, {ATTR_BRIGHTNESS: 10}),
{ATTR_ENTITY_ID: "light.test", ATTR_TRANSITION: 2},
),
(
{ATTR_ENTITY_ID: "light.test", ATTR_BRIGHTNESS: 10, ATTR_TRANSITION: 2},
State("light.test", STATE_ON, {ATTR_BRIGHTNESS: 11}),
{ATTR_ENTITY_ID: "light.test", ATTR_BRIGHTNESS: 10, ATTR_TRANSITION: 2},
),
],
ids=[
"pass all attributes on empty state",
"remove attributes whose values equal the state",
"keep attributes whose values differ from the state",
],
)
async def test_remove_redundant_attributes(
service_data: ServiceData,
state: State | None,
service_data_expected: ServiceData,
):
"""Test filtering of service data."""
assert _remove_redundant_attributes(service_data, state) == service_data_expected
@pytest.mark.parametrize(
("service_data", "expected_relevant"),
[
(
{ATTR_ENTITY_ID: "light.test"},
False,
),
(
{ATTR_TRANSITION: 2},
False,
),
(
{ATTR_BRIGHTNESS: 10},
True,
),
(
{ATTR_ENTITY_ID: "light.test", ATTR_BRIGHTNESS: 10, ATTR_TRANSITION: 2},
True,
),
],
)
async def test_has_relevant_service_data_attributes(
service_data: ServiceData,
expected_relevant: bool,
):
"""Test the determination of relevancy of service data."""
assert _has_relevant_service_data_attributes(service_data) == expected_relevant
@pytest.mark.parametrize(
("service_datas", "filter_by_state", "service_datas_expected"),
[
(
[{ATTR_ENTITY_ID: "light.test"}],
False,
[{ATTR_ENTITY_ID: "light.test"}],
),
(
[{ATTR_ENTITY_ID: "light.test"}, {ATTR_ENTITY_ID: "light.test2"}],
False,
[{ATTR_ENTITY_ID: "light.test"}, {ATTR_ENTITY_ID: "light.test2"}],
),
(
[{ATTR_ENTITY_ID: "light.test"}],
True,
[],
),
(
[{ATTR_ENTITY_ID: "light.test", ATTR_BRIGHTNESS: 10}],
True,
[],
),
(
[{ATTR_ENTITY_ID: "light.test", ATTR_BRIGHTNESS: 11}],
True,
[{ATTR_ENTITY_ID: "light.test", ATTR_BRIGHTNESS: 11}],
),
(
[
{ATTR_ENTITY_ID: "light.test", ATTR_BRIGHTNESS: 11},
{ATTR_ENTITY_ID: "light.test", ATTR_BRIGHTNESS: 22},
],
True,
[
{ATTR_ENTITY_ID: "light.test", ATTR_BRIGHTNESS: 11},
{ATTR_ENTITY_ID: "light.test", ATTR_BRIGHTNESS: 22},
],
),
(
[
{ATTR_ENTITY_ID: "light.test", ATTR_BRIGHTNESS: 10},
{ATTR_ENTITY_ID: "light.test", ATTR_BRIGHTNESS: 22},
],
True,
[
{ATTR_ENTITY_ID: "light.test", ATTR_BRIGHTNESS: 22},
],
),
],
ids=[
"single item passed through without filtering",
"two items passed through without filtering",
"filter removes item without relevant attributes",
"filter removes item with relevant attribute that equals the state",
"filter keeps item with relevant attribute that is different from state",
"filter keeps two items with relevant attributes that are different from state",
"filter removes item that equals state and keeps items that differs from state",
],
)
async def test_create_service_call_data_iterator(
service_datas: list[ServiceData],
filter_by_state: bool,
service_datas_expected: list[ServiceData],
hass_states_mock,
):
"""Test the generator function for correct enumeration and filtering."""
generated_service_datas = [
data
async for data in _create_service_call_data_iterator(
hass_states_mock,
service_datas,
filter_by_state,
)
]
assert generated_service_datas == service_datas_expected
assert (
hass_states_mock.states.get.call_count == 0
if not filter_by_state
else len(service_datas)
)
@pytest.mark.parametrize(
(
"service_data",
"split",
"filter_by_state",
"service_datas_expected",
"sleep_time_expected",
),
[
(
{
ATTR_ENTITY_ID: "light.test",
ATTR_BRIGHTNESS: 10,
ATTR_COLOR_TEMP_KELVIN: 4000,
},
False,
False,
[
{
ATTR_ENTITY_ID: "light.test",
ATTR_BRIGHTNESS: 10,
ATTR_COLOR_TEMP_KELVIN: 4000,
},
],
1.2,
),
(
{
ATTR_ENTITY_ID: "light.test",
ATTR_BRIGHTNESS: 10,
ATTR_COLOR_TEMP_KELVIN: 4000,
},
True,
False,
[
{
ATTR_ENTITY_ID: "light.test",
ATTR_BRIGHTNESS: 10,
},
{
ATTR_ENTITY_ID: "light.test",
ATTR_COLOR_TEMP_KELVIN: 4000,
},
],
0.7,
),
(
{
ATTR_ENTITY_ID: "light.test",
ATTR_BRIGHTNESS: 10,
ATTR_COLOR_TEMP_KELVIN: 4000,
},
False,
True,
[
{
ATTR_ENTITY_ID: "light.test",
ATTR_COLOR_TEMP_KELVIN: 4000,
},
],
1.2,
),
(
{
ATTR_ENTITY_ID: "light.test",
ATTR_BRIGHTNESS: 10,
ATTR_COLOR_TEMP_KELVIN: 4000,
},
True,
True,
[
{
ATTR_ENTITY_ID: "light.test",
ATTR_COLOR_TEMP_KELVIN: 4000,
},
],
0.7,
),
],
ids=[
"service data passed through",
"service data split",
"service data filtered",
"service data split and filtered",
],
)
async def test_prepare_adaptation_data(
hass_states_mock,
service_data,
split,
filter_by_state,
service_datas_expected,
sleep_time_expected,
):
"""Test creation of correct service data objects."""
data = prepare_adaptation_data(
hass_states_mock,
"test.entity",
Context(id="test-id"),
1,
0.2,
service_data,
split,
filter_by_state,
force=False,
)
generated_service_datas = [item async for item in data.service_call_datas]
assert data.entity_id == "test.entity"
assert data.context.id == "test-id"
assert data.sleep_time == sleep_time_expected
assert generated_service_datas == service_datas_expected
@pytest.fixture(name="hass_states_mock")
def fixture_hass_states_mock():
"""Mocks a HA state machine which returns a mock state."""
hass = Mock()
hass.states.get.return_value = Mock(attributes={ATTR_BRIGHTNESS: 10})
return hass
@pytest.mark.parametrize(
("attribute", "expected_str", "has_any", "has_none", "has_all"),
[
(LightControlAttributes.NONE, "NONE", False, True, False),
(LightControlAttributes.BRIGHTNESS, "BRIGHTNESS", True, False, False),
(LightControlAttributes.COLOR, "COLOR", True, False, False),
(
LightControlAttributes.BRIGHTNESS | LightControlAttributes.COLOR,
"BRIGHTNESS|COLOR",
True,
False,
True,
),
(
LightControlAttributes.ALL,
"BRIGHTNESS|COLOR",
True,
False,
True,
),
],
)
def test_light_control_attribute_flags(
attribute: LightControlAttributes,
expected_str: str,
has_any: bool,
has_none: bool,
has_all: bool,
):
"""Test helper methods and string conversion for the light attribute flag."""
assert str(attribute) == expected_str
assert attribute.has_any() is has_any
assert attribute.has_none() is has_none
assert attribute.has_all() is has_all
@pytest.mark.parametrize(
("manual_control_attribute", "expected_flag"),
[
(True, LightControlAttributes.ALL),
(False, LightControlAttributes.NONE),
("brightness", LightControlAttributes.BRIGHTNESS),
("color", LightControlAttributes.COLOR),
("unsupported", LightControlAttributes.NONE),
],
)
def test_manual_control_event_attribute_to_flags(
manual_control_attribute: bool | str,
expected_flag: LightControlAttributes,
):
"""Test mapping of manual control events to attribute flags."""
assert (
manual_control_event_attribute_to_flags(manual_control_attribute)
== expected_flag
)
@pytest.mark.parametrize(
("service_data", "expected"),
[
({ATTR_BRIGHTNESS: 125}, True),
({ATTR_BRIGHTNESS_PCT: 50}, True),
({ATTR_BRIGHTNESS_PCT: 50, ATTR_COLOR_TEMP_KELVIN: 3500}, True),
({ATTR_BRIGHTNESS_PCT: 50, "unknown": "foo"}, True),
({ATTR_COLOR_TEMP_KELVIN: 3500}, False),
({}, False),
],
)
def test_has_brightness_attribute(service_data: ServiceData, expected: bool):
"""Test detection of brightness attributes in service data."""
assert has_brightness_attribute(service_data) is expected
@pytest.mark.parametrize(
("service_data", "expected"),
[
({ATTR_HS_COLOR: (10, 20)}, True),
({ATTR_COLOR_TEMP_KELVIN: 5000}, True),
({ATTR_COLOR_TEMP_KELVIN: 5000, ATTR_BRIGHTNESS: 125}, True),
({ATTR_COLOR_TEMP_KELVIN: 5000, "unknown": "foo"}, True),
({ATTR_BRIGHTNESS: 125}, False),
({}, False),
],
)
def test_has_color_attribute(service_data: ServiceData, expected: bool):
"""Test detection of color attributes in service data."""
assert has_color_attribute(service_data) is expected
@pytest.mark.parametrize(
("service_data", "expected"),
[
({ATTR_EFFECT: "colorloop"}, True),
({ATTR_FLASH: "short"}, True),
({ATTR_EFFECT: "colorloop", ATTR_FLASH: "short"}, True),
({ATTR_EFFECT: "colorloop", "unknown": "foo"}, True),
({}, False),
],
)
def test_has_effect_attribute(service_data: ServiceData, expected: bool):
"""Test detection of effect attributes in service data."""
assert has_effect_attribute(service_data) is expected
@pytest.mark.parametrize(
("service_data", "expected_flags"),
[
({ATTR_BRIGHTNESS: 1}, LightControlAttributes.BRIGHTNESS),
({ATTR_HS_COLOR: (1, 2)}, LightControlAttributes.COLOR),
(
{ATTR_BRIGHTNESS: 1, ATTR_HS_COLOR: (1, 2)},
LightControlAttributes.BRIGHTNESS | LightControlAttributes.COLOR,
),
(
{ATTR_EFFECT: "colorloop"},
LightControlAttributes.BRIGHTNESS | LightControlAttributes.COLOR,
),
(
{ATTR_FLASH: "short"},
LightControlAttributes.BRIGHTNESS | LightControlAttributes.COLOR,
),
({}, LightControlAttributes.NONE),
],
)
def test_get_light_control_attributes(
service_data: ServiceData,
expected_flags: LightControlAttributes,
):
"""Test determination of light control attributes."""
assert get_light_control_attributes(service_data) == expected_flags