Issue-739-refactor-to-modularize (#742)

* Refactor Presence Feature * Add PresenceFeatureManager ok * Python 3.13 * Fix presence test * Refactor power feature * Add Motion manager. All tests ok * Tests ok. But tests are not complete * All tests Window Feature Manager ok. * All windows tests ok * Fix all testus with feature_window_manager ok * Add test_auto_start_stop feature manager. All tests ok * Add safety feature_safety_manager Rename config attribute from security_ to safety_ * Documentation and release * Add safety manager direct tests * Typo --------- Co-authored-by: Jean-Marc Collin <jean-marc.collin-extern@renault.com>
2025-01-01 16:30:18 +01:00
parent d2a94d33e8
commit 9e52c843bc
78 changed files with 5116 additions and 2382 deletions
--- a/tests/test_power.py
+++ b/tests/test_power.py
@@ -1,17 +1,243 @@
 # pylint: disable=protected-access, unused-argument, line-too-long
 """ Test the Power management """
-from unittest.mock import patch, call
+from unittest.mock import patch, call, AsyncMock, MagicMock, PropertyMock
 from datetime import datetime, timedelta
 import logging

 from custom_components.versatile_thermostat.thermostat_switch import (
    ThermostatOverSwitch,
 )
+from custom_components.versatile_thermostat.feature_power_manager import (
+    FeaturePowerManager,
+)
+from custom_components.versatile_thermostat.prop_algorithm import PropAlgorithm
 from .commons import *  # pylint: disable=wildcard-import, unused-wildcard-import

 logging.getLogger().setLevel(logging.DEBUG)


+@pytest.mark.parametrize(
+    "is_over_climate, is_device_active, power, max_power, current_overpowering_state, overpowering_state, nb_call, changed, check_overpowering_ret",
+    [
+        # don't switch to overpower (power is enough)
+        (False, False, 1000, 3000, STATE_OFF, STATE_OFF, 0, True, False),
+        # switch to overpower (power is not enough)
+        (False, False, 2000, 3000, STATE_OFF, STATE_ON, 1, True, True),
+        # don't switch to overpower (power is not enough but device is already on)
+        (False, True, 2000, 3000, STATE_OFF, STATE_OFF, 0, True, False),
+        # Same with a over_climate
+        # don't switch to overpower (power is enough)
+        (True, False, 1000, 3000, STATE_OFF, STATE_OFF, 0, True, False),
+        # switch to overpower (power is not enough)
+        (True, False, 2000, 3000, STATE_OFF, STATE_ON, 1, True, True),
+        # don't switch to overpower (power is not enough but device is already on)
+        (True, True, 2000, 3000, STATE_OFF, STATE_OFF, 0, True, False),
+        # Leave overpowering state
+        # switch to not overpower (power is enough)
+        (False, False, 1000, 3000, STATE_ON, STATE_OFF, 1, True, False),
+        # don't switch to overpower (power is still not enough)
+        (False, False, 2000, 3000, STATE_ON, STATE_ON, 0, True, True),
+        # keep overpower (power is not enough but device is already on)
+        (False, True, 3000, 3000, STATE_ON, STATE_ON, 0, True, True),
+    ],
+)
+async def test_power_feature_manager(
+    hass: HomeAssistant,
+    is_over_climate,
+    is_device_active,
+    power,
+    max_power,
+    current_overpowering_state,
+    overpowering_state,
+    nb_call,
+    changed,
+    check_overpowering_ret,
+):
+    """Test the FeaturePresenceManager class direclty"""
+
+    fake_vtherm = MagicMock(spec=BaseThermostat)
+    type(fake_vtherm).name = PropertyMock(return_value="the name")
+
+    # 1. creation
+    power_manager = FeaturePowerManager(fake_vtherm, hass)
+
+    assert power_manager is not None
+    assert power_manager.is_configured is False
+    assert power_manager.overpowering_state == STATE_UNAVAILABLE
+    assert power_manager.name == "the name"
+
+    assert len(power_manager._active_listener) == 0
+
+    custom_attributes = {}
+    power_manager.add_custom_attributes(custom_attributes)
+    assert custom_attributes["power_sensor_entity_id"] is None
+    assert custom_attributes["max_power_sensor_entity_id"] is None
+    assert custom_attributes["overpowering_state"] == STATE_UNAVAILABLE
+    assert custom_attributes["is_power_configured"] is False
+    assert custom_attributes["device_power"] is 0
+    assert custom_attributes["power_temp"] is None
+    assert custom_attributes["current_power"] is None
+    assert custom_attributes["current_max_power"] is None
+
+    # 2. post_init
+    power_manager.post_init(
+        {
+            CONF_POWER_SENSOR: "sensor.the_power_sensor",
+            CONF_MAX_POWER_SENSOR: "sensor.the_max_power_sensor",
+            CONF_USE_POWER_FEATURE: True,
+            CONF_PRESET_POWER: 10,
+            CONF_DEVICE_POWER: 1234,
+        }
+    )
+
+    assert power_manager.is_configured is True
+    assert power_manager.overpowering_state == STATE_UNKNOWN
+
+    custom_attributes = {}
+    power_manager.add_custom_attributes(custom_attributes)
+    assert custom_attributes["power_sensor_entity_id"] == "sensor.the_power_sensor"
+    assert (
+        custom_attributes["max_power_sensor_entity_id"] == "sensor.the_max_power_sensor"
+    )
+    assert custom_attributes["overpowering_state"] == STATE_UNKNOWN
+    assert custom_attributes["is_power_configured"] is True
+    assert custom_attributes["device_power"] == 1234
+    assert custom_attributes["power_temp"] == 10
+    assert custom_attributes["current_power"] is None
+    assert custom_attributes["current_max_power"] is None
+
+    # 3. start listening
+    power_manager.start_listening()
+    assert power_manager.is_configured is True
+    assert power_manager.overpowering_state == STATE_UNKNOWN
+
+    assert len(power_manager._active_listener) == 2
+
+    # 4. test refresh and check_overpowering with the parametrized
+    side_effects = SideEffects(
+        {
+            "sensor.the_power_sensor": State("sensor.the_power_sensor", power),
+            "sensor.the_max_power_sensor": State(
+                "sensor.the_max_power_sensor", max_power
+            ),
+        },
+        State("unknown.entity_id", "unknown"),
+    )
+    # fmt:off
+    with patch("homeassistant.core.StateMachine.get", side_effect=side_effects.get_side_effects()) as mock_get_state:
+    # fmt:on
+        # Finish the mock configuration
+        tpi_algo = PropAlgorithm(PROPORTIONAL_FUNCTION_TPI, 0.6, 0.01, 5, 0, "climate.vtherm")
+        tpi_algo._on_percent = 1 # pylint: disable="protected-access"
+        type(fake_vtherm).hvac_mode = PropertyMock(return_value=HVACMode.HEAT)
+        type(fake_vtherm).is_device_active = PropertyMock(return_value=is_device_active)
+        type(fake_vtherm).is_over_climate = PropertyMock(return_value=is_over_climate)
+        type(fake_vtherm).proportional_algorithm = PropertyMock(return_value=tpi_algo)
+        type(fake_vtherm).nb_underlying_entities = PropertyMock(return_value=1)
+        type(fake_vtherm).preset_mode = PropertyMock(return_value=PRESET_COMFORT if current_overpowering_state == STATE_OFF else PRESET_POWER)
+        type(fake_vtherm)._saved_preset_mode = PropertyMock(return_value=PRESET_ECO)
+
+        fake_vtherm.save_hvac_mode = MagicMock()
+        fake_vtherm.restore_hvac_mode = AsyncMock()
+        fake_vtherm.save_preset_mode = MagicMock()
+        fake_vtherm.restore_preset_mode = AsyncMock()
+        fake_vtherm.async_underlying_entity_turn_off = AsyncMock()
+        fake_vtherm.async_set_preset_mode_internal = AsyncMock()
+        fake_vtherm.send_event = MagicMock()
+        fake_vtherm.update_custom_attributes = MagicMock()
+
+
+        ret = await power_manager.refresh_state()
+        assert ret == changed
+        assert power_manager.is_configured is True
+        assert power_manager.overpowering_state == STATE_UNKNOWN
+        assert power_manager.current_power == power
+        assert power_manager.current_max_power == max_power
+
+        # check overpowering
+        power_manager._overpowering_state = current_overpowering_state
+        ret2 = await power_manager.check_overpowering()
+        assert ret2 == check_overpowering_ret
+        assert power_manager.overpowering_state == overpowering_state
+        assert mock_get_state.call_count == 2
+
+        if power_manager.overpowering_state == STATE_OFF:
+            assert fake_vtherm.save_hvac_mode.call_count == 0
+            assert fake_vtherm.save_preset_mode.call_count == 0
+            assert fake_vtherm.async_underlying_entity_turn_off.call_count == 0
+            assert fake_vtherm.async_set_preset_mode_internal.call_count == 0
+            assert fake_vtherm.send_event.call_count == nb_call
+
+            if current_overpowering_state == STATE_ON:
+                assert fake_vtherm.update_custom_attributes.call_count == 1
+                assert fake_vtherm.restore_preset_mode.call_count == 1
+                if is_over_climate:
+                    assert fake_vtherm.restore_hvac_mode.call_count == 1
+                else:
+                    assert fake_vtherm.restore_hvac_mode.call_count == 0
+            else:
+                assert fake_vtherm.update_custom_attributes.call_count == 0
+
+            if nb_call == 1:
+                fake_vtherm.send_event.assert_has_calls(
+                    [
+                        call.fake_vtherm.send_event(
+                            EventType.POWER_EVENT,
+                            {'type': 'end', 'current_power': power, 'device_power': 1234, 'current_max_power': max_power}),
+                    ]
+                )
+
+
+        elif power_manager.overpowering_state == STATE_ON:
+            if is_over_climate:
+                assert fake_vtherm.save_hvac_mode.call_count == 1
+            else:
+                assert fake_vtherm.save_hvac_mode.call_count == 0
+
+            if current_overpowering_state == STATE_OFF:
+                assert fake_vtherm.save_preset_mode.call_count == 1
+                assert fake_vtherm.async_underlying_entity_turn_off.call_count == 1
+                assert fake_vtherm.async_set_preset_mode_internal.call_count == 1
+                assert fake_vtherm.send_event.call_count == 1
+                assert fake_vtherm.update_custom_attributes.call_count == 1
+            else:
+                assert fake_vtherm.save_preset_mode.call_count == 0
+                assert fake_vtherm.async_underlying_entity_turn_off.call_count == 0
+                assert fake_vtherm.async_set_preset_mode_internal.call_count == 0
+                assert fake_vtherm.send_event.call_count == 0
+                assert fake_vtherm.update_custom_attributes.call_count == 0
+            assert fake_vtherm.restore_hvac_mode.call_count == 0
+            assert fake_vtherm.restore_preset_mode.call_count == 0
+
+            if nb_call == 1:
+                fake_vtherm.send_event.assert_has_calls(
+                    [
+                        call.fake_vtherm.send_event(
+                            EventType.POWER_EVENT,
+                            {'type': 'start', 'current_power': power, 'device_power': 1234, 'current_max_power': max_power, 'current_power_consumption': 1234.0}),
+                    ]
+                )
+
+        fake_vtherm.reset_mock()
+
+    # 5. Check custom_attributes
+        custom_attributes = {}
+        power_manager.add_custom_attributes(custom_attributes)
+        assert custom_attributes["power_sensor_entity_id"] == "sensor.the_power_sensor"
+        assert (
+            custom_attributes["max_power_sensor_entity_id"] == "sensor.the_max_power_sensor"
+        )
+        assert custom_attributes["overpowering_state"] == overpowering_state
+        assert custom_attributes["is_power_configured"] is True
+        assert custom_attributes["device_power"] == 1234
+        assert custom_attributes["power_temp"] == 10
+        assert custom_attributes["current_power"] == power
+        assert custom_attributes["current_max_power"] == max_power
+
+    power_manager.stop_listening()
+    await hass.async_block_till_done()
+
+
@pytest.mark.parametrize("expected_lingering_tasks", [True])
@pytest.mark.parametrize("expected_lingering_timers", [True])
 async def test_power_management_hvac_off(
@@ -43,8 +269,8 @@ async def test_power_management_hvac_off(
            CONF_TPI_COEF_INT: 0.3,
            CONF_TPI_COEF_EXT: 0.01,
            CONF_MINIMAL_ACTIVATION_DELAY: 30,
-            CONF_SECURITY_DELAY_MIN: 5,
-            CONF_SECURITY_MIN_ON_PERCENT: 0.3,
+            CONF_SAFETY_DELAY_MIN: 5,
+            CONF_SAFETY_MIN_ON_PERCENT: 0.3,
            CONF_POWER_SENSOR: "sensor.mock_power_sensor",
            CONF_MAX_POWER_SENSOR: "sensor.mock_power_max_sensor",
            CONF_DEVICE_POWER: 100,
@@ -63,23 +289,23 @@ async def test_power_management_hvac_off(
    await entity.async_set_preset_mode(PRESET_BOOST)
    assert entity.preset_mode is PRESET_BOOST
    assert entity.target_temperature == 19
-    assert entity.overpowering_state is None
+    assert entity.power_manager.overpowering_state is STATE_UNKNOWN
    assert entity.hvac_mode == HVACMode.OFF

    # Send power mesurement
    await send_power_change_event(entity, 50, datetime.now())
-    assert await entity.check_overpowering() is False
+    assert await entity.power_manager.check_overpowering() is False

    # All configuration is not complete
    assert entity.preset_mode is PRESET_BOOST
-    assert entity.overpowering_state is None
+    assert entity.power_manager.overpowering_state is STATE_UNKNOWN

    # Send power max mesurement
    await send_max_power_change_event(entity, 300, datetime.now())
-    assert await entity.check_overpowering() is False
+    assert await entity.power_manager.check_overpowering() is False
    # All configuration is complete and power is < power_max
    assert entity.preset_mode is PRESET_BOOST
-    assert entity.overpowering_state is False
+    assert entity.power_manager.overpowering_state is STATE_OFF

    # Send power max mesurement too low but HVACMode is off
    with patch(
@@ -90,10 +316,10 @@ async def test_power_management_hvac_off(
        "custom_components.versatile_thermostat.underlyings.UnderlyingSwitch.turn_off"
    ) as mock_heater_off:
        await send_max_power_change_event(entity, 149, datetime.now())
-        assert await entity.check_overpowering() is True
+        assert await entity.power_manager.check_overpowering() is True
        # All configuration is complete and power is > power_max but we stay in Boost cause thermostat if Off
        assert entity.preset_mode is PRESET_BOOST
-        assert entity.overpowering_state is True
+        assert entity.power_manager.overpowering_state is STATE_ON

        assert mock_send_event.call_count == 0
        assert mock_heater_on.call_count == 0
@@ -129,8 +355,8 @@ async def test_power_management_hvac_on(hass: HomeAssistant, skip_hass_states_is
            CONF_TPI_COEF_INT: 0.3,
            CONF_TPI_COEF_EXT: 0.01,
            CONF_MINIMAL_ACTIVATION_DELAY: 30,
-            CONF_SECURITY_DELAY_MIN: 5,
-            CONF_SECURITY_MIN_ON_PERCENT: 0.3,
+            CONF_SAFETY_DELAY_MIN: 5,
+            CONF_SAFETY_MIN_ON_PERCENT: 0.3,
            CONF_POWER_SENSOR: "sensor.mock_power_sensor",
            CONF_MAX_POWER_SENSOR: "sensor.mock_power_max_sensor",
            CONF_DEVICE_POWER: 100,
@@ -150,17 +376,17 @@ async def test_power_management_hvac_on(hass: HomeAssistant, skip_hass_states_is
    await entity.async_set_preset_mode(PRESET_BOOST)
    assert entity.hvac_mode is HVACMode.HEAT
    assert entity.preset_mode is PRESET_BOOST
-    assert entity.overpowering_state is None
+    assert entity.power_manager.overpowering_state is STATE_UNKNOWN
    assert entity.target_temperature == 19

    # Send power mesurement
    await send_power_change_event(entity, 50, datetime.now())
    # Send power max mesurement
    await send_max_power_change_event(entity, 300, datetime.now())
-    assert await entity.check_overpowering() is False
+    assert await entity.power_manager.check_overpowering() is False
    # All configuration is complete and power is < power_max
    assert entity.preset_mode is PRESET_BOOST
-    assert entity.overpowering_state is False
+    assert entity.power_manager.overpowering_state is STATE_OFF

    # Send power max mesurement too low and HVACMode is on
    with patch(
@@ -171,10 +397,10 @@ async def test_power_management_hvac_on(hass: HomeAssistant, skip_hass_states_is
        "custom_components.versatile_thermostat.underlyings.UnderlyingSwitch.turn_off"
    ) as mock_heater_off:
        await send_max_power_change_event(entity, 149, datetime.now())
-        assert await entity.check_overpowering() is True
+        assert await entity.power_manager.check_overpowering() is True
        # All configuration is complete and power is > power_max we switch to POWER preset
        assert entity.preset_mode is PRESET_POWER
-        assert entity.overpowering_state is True
+        assert entity.power_manager.overpowering_state is STATE_ON
        assert entity.target_temperature == 12

        assert mock_send_event.call_count == 2
@@ -187,7 +413,7 @@ async def test_power_management_hvac_on(hass: HomeAssistant, skip_hass_states_is
                        "type": "start",
                        "current_power": 50,
                        "device_power": 100,
-                        "current_power_max": 149,
+                        "current_max_power": 149,
                        "current_power_consumption": 100.0,
                    },
                ),
@@ -206,10 +432,10 @@ async def test_power_management_hvac_on(hass: HomeAssistant, skip_hass_states_is
        "custom_components.versatile_thermostat.underlyings.UnderlyingSwitch.turn_off"
    ) as mock_heater_off:
        await send_power_change_event(entity, 48, datetime.now())
-        assert await entity.check_overpowering() is False
+        assert await entity.power_manager.check_overpowering() is False
        # All configuration is complete and power is < power_max, we restore previous preset
        assert entity.preset_mode is PRESET_BOOST
-        assert entity.overpowering_state is False
+        assert entity.power_manager.overpowering_state is STATE_OFF
        assert entity.target_temperature == 19

        assert mock_send_event.call_count == 2
@@ -222,7 +448,7 @@ async def test_power_management_hvac_on(hass: HomeAssistant, skip_hass_states_is
                        "type": "end",
                        "current_power": 48,
                        "device_power": 100,
-                        "current_power_max": 149,
+                        "current_max_power": 149,
                    },
                ),
            ],
@@ -265,8 +491,8 @@ async def test_power_management_energy_over_switch(
            CONF_TPI_COEF_INT: 0.3,
            CONF_TPI_COEF_EXT: 0.01,
            CONF_MINIMAL_ACTIVATION_DELAY: 30,
-            CONF_SECURITY_DELAY_MIN: 5,
-            CONF_SECURITY_MIN_ON_PERCENT: 0.3,
+            CONF_SAFETY_DELAY_MIN: 5,
+            CONF_SAFETY_MIN_ON_PERCENT: 0.3,
            CONF_POWER_SENSOR: "sensor.mock_power_sensor",
            CONF_MAX_POWER_SENSOR: "sensor.mock_power_max_sensor",
            CONF_DEVICE_POWER: 100,
@@ -303,7 +529,7 @@ async def test_power_management_energy_over_switch(
        assert entity.current_temperature == 15
        assert tpi_algo.on_percent == 1

-        assert entity.device_power == 100.0
+        assert entity.power_manager.device_power == 100.0

        assert mock_send_event.call_count == 2
        assert mock_heater_on.call_count == 1
@@ -324,7 +550,7 @@ async def test_power_management_energy_over_switch(
    ) as mock_heater_off:
        await send_temperature_change_event(entity, 18, datetime.now())
        assert tpi_algo.on_percent == 0.3
-        assert entity.mean_cycle_power == 30.0
+        assert entity.power_manager.mean_cycle_power == 30.0

        assert mock_send_event.call_count == 0
        assert mock_heater_on.call_count == 0
@@ -346,7 +572,7 @@ async def test_power_management_energy_over_switch(
    ) as mock_heater_off:
        await send_temperature_change_event(entity, 20, datetime.now())
        assert tpi_algo.on_percent == 0.0
-        assert entity.mean_cycle_power == 0.0
+        assert entity.power_manager.mean_cycle_power == 0.0

        assert mock_send_event.call_count == 0
        assert mock_heater_on.call_count == 0
@@ -394,8 +620,8 @@ async def test_power_management_energy_over_climate(
                CONF_USE_PRESENCE_FEATURE: False,
                CONF_CLIMATE: "climate.mock_climate",
                CONF_MINIMAL_ACTIVATION_DELAY: 30,
-                CONF_SECURITY_DELAY_MIN: 5,
-                CONF_SECURITY_MIN_ON_PERCENT: 0.3,
+                CONF_SAFETY_DELAY_MIN: 5,
+                CONF_SAFETY_MIN_ON_PERCENT: 0.3,
                CONF_POWER_SENSOR: "sensor.mock_power_sensor",
                CONF_MAX_POWER_SENSOR: "sensor.mock_power_max_sensor",
                CONF_DEVICE_POWER: 100,
@@ -421,7 +647,7 @@ async def test_power_management_energy_over_climate(
    assert entity.current_temperature == 15

    # Not initialised yet
-    assert entity.mean_cycle_power is None
+    assert entity.power_manager.mean_cycle_power is None
    assert entity._underlying_climate_start_hvac_action_date is None

    # Send a climate_change event with HVACAction=HEATING