From 859e7972ac50c55711faed114e3207e520e710c7 Mon Sep 17 00:00:00 2001
From: Michael <35783820+mib1185@users.noreply.github.com>
Date: Sat, 23 Dec 2023 11:24:32 +0100
Subject: [PATCH] Add significant Change support for vacuum (#106002)

---
 .../components/vacuum/significant_change.py   | 58 +++++++++++++++++++
 .../vacuum/test_significant_change.py         | 51 ++++++++++++++++
 2 files changed, 109 insertions(+)
 create mode 100644 homeassistant/components/vacuum/significant_change.py
 create mode 100644 tests/components/vacuum/test_significant_change.py

diff --git a/homeassistant/components/vacuum/significant_change.py b/homeassistant/components/vacuum/significant_change.py
new file mode 100644
index 00000000000..3031d60305a
--- /dev/null
+++ b/homeassistant/components/vacuum/significant_change.py
@@ -0,0 +1,58 @@
+"""Helper to test significant Vacuum state changes."""
+from __future__ import annotations
+
+from typing import Any
+
+from homeassistant.core import HomeAssistant, callback
+from homeassistant.helpers.significant_change import (
+    check_absolute_change,
+    check_valid_float,
+)
+
+from . import ATTR_BATTERY_LEVEL, ATTR_FAN_SPEED
+
+SIGNIFICANT_ATTRIBUTES: set[str] = {
+    ATTR_BATTERY_LEVEL,
+    ATTR_FAN_SPEED,
+}
+
+
+@callback
+def async_check_significant_change(
+    hass: HomeAssistant,
+    old_state: str,
+    old_attrs: dict,
+    new_state: str,
+    new_attrs: dict,
+    **kwargs: Any,
+) -> bool | None:
+    """Test if state significantly changed."""
+    if old_state != new_state:
+        return True
+
+    old_attrs_s = set(old_attrs.items())
+    new_attrs_s = set(new_attrs.items())
+    changed_attrs: set[str] = {item[0] for item in old_attrs_s ^ new_attrs_s}
+
+    for attr_name in changed_attrs:
+        if attr_name not in SIGNIFICANT_ATTRIBUTES:
+            continue
+
+        if attr_name != ATTR_BATTERY_LEVEL:
+            return True
+
+        old_attr_value = old_attrs.get(attr_name)
+        new_attr_value = new_attrs.get(attr_name)
+        if new_attr_value is None or not check_valid_float(new_attr_value):
+            # New attribute value is invalid, ignore it
+            continue
+
+        if old_attr_value is None or not check_valid_float(old_attr_value):
+            # Old attribute value was invalid, we should report again
+            return True
+
+        if check_absolute_change(old_attr_value, new_attr_value, 1.0):
+            return True
+
+    # no significant attribute change detected
+    return False
diff --git a/tests/components/vacuum/test_significant_change.py b/tests/components/vacuum/test_significant_change.py
new file mode 100644
index 00000000000..5f46080fb8d
--- /dev/null
+++ b/tests/components/vacuum/test_significant_change.py
@@ -0,0 +1,51 @@
+"""Test the Vacuum significant change platform."""
+import pytest
+
+from homeassistant.components.vacuum import (
+    ATTR_BATTERY_ICON,
+    ATTR_BATTERY_LEVEL,
+    ATTR_FAN_SPEED,
+)
+from homeassistant.components.vacuum.significant_change import (
+    async_check_significant_change,
+)
+
+
+async def test_significant_state_change() -> None:
+    """Detect Vacuum significant state changes."""
+    attrs = {}
+    assert not async_check_significant_change(None, "on", attrs, "on", attrs)
+    assert async_check_significant_change(None, "on", attrs, "off", attrs)
+
+
+@pytest.mark.parametrize(
+    ("old_attrs", "new_attrs", "expected_result"),
+    [
+        ({ATTR_FAN_SPEED: "old_value"}, {ATTR_FAN_SPEED: "old_value"}, False),
+        ({ATTR_FAN_SPEED: "old_value"}, {ATTR_FAN_SPEED: "new_value"}, True),
+        # multiple attributes
+        (
+            {ATTR_FAN_SPEED: "old_value", ATTR_BATTERY_LEVEL: 10.0},
+            {ATTR_FAN_SPEED: "new_value", ATTR_BATTERY_LEVEL: 10.0},
+            True,
+        ),
+        # float attributes
+        ({ATTR_BATTERY_LEVEL: 10.0}, {ATTR_BATTERY_LEVEL: 11.0}, True),
+        ({ATTR_BATTERY_LEVEL: 10.0}, {ATTR_BATTERY_LEVEL: 10.9}, False),
+        ({ATTR_BATTERY_LEVEL: "invalid"}, {ATTR_BATTERY_LEVEL: 10.0}, True),
+        ({ATTR_BATTERY_LEVEL: 10.0}, {ATTR_BATTERY_LEVEL: "invalid"}, False),
+        # insignificant attributes
+        ({ATTR_BATTERY_ICON: "old_value"}, {ATTR_BATTERY_ICON: "new_value"}, False),
+        ({ATTR_BATTERY_ICON: "old_value"}, {ATTR_BATTERY_ICON: "old_value"}, False),
+        ({"unknown_attr": "old_value"}, {"unknown_attr": "old_value"}, False),
+        ({"unknown_attr": "old_value"}, {"unknown_attr": "new_value"}, False),
+    ],
+)
+async def test_significant_atributes_change(
+    old_attrs: dict, new_attrs: dict, expected_result: bool
+) -> None:
+    """Detect Vacuum significant attribute changes."""
+    assert (
+        async_check_significant_change(None, "state", old_attrs, "state", new_attrs)
+        == expected_result
+    )