Docker events based watchdog and docker healthchecks (#3725)

* Docker events based watchdog * Separate monitor from DockerAPI since it needs coresys * Move monitor into dockerAPI * Fix properties on coresys * Add watchdog tests * Added tests * pylint issue * Current state failures test * Thread-safe event processing * Use labels property
2025-12-24 20:35:55 +00:00 · 2022-07-15 03:21:59 -04:00
parent 14bc771ba9
commit d19166bb86
31 changed files with 1860 additions and 671 deletions
--- a/tests/homeassistant/test_home_assistant_watchdog.py
+++ b/tests/homeassistant/test_home_assistant_watchdog.py
@@ -0,0 +1,142 @@
+"""Test Home Assistant watchdog."""
+import asyncio
+from unittest.mock import PropertyMock, patch
+
+from awesomeversion import AwesomeVersion
+
+from supervisor.const import BusEvent
+from supervisor.coresys import CoreSys
+from supervisor.docker.const import ContainerState
+from supervisor.docker.monitor import DockerContainerStateEvent
+from supervisor.exceptions import HomeAssistantError
+
+
+async def mock_current_state(state: ContainerState) -> ContainerState:
+    """Mock for current state method."""
+    return state
+
+
+async def test_home_assistant_watchdog(coresys: CoreSys) -> None:
+    """Test homeassistant watchdog works correctly."""
+    coresys.homeassistant.version = AwesomeVersion("2022.7.3")
+    with patch(
+        "supervisor.docker.interface.DockerInterface.version",
+        new=PropertyMock(return_value=AwesomeVersion("2022.7.3")),
+    ), patch.object(type(coresys.homeassistant.core.instance), "attach"):
+        await coresys.homeassistant.core.load()
+
+    coresys.homeassistant.core.watchdog = True
+
+    with patch.object(
+        type(coresys.homeassistant.core), "restart"
+    ) as restart, patch.object(
+        type(coresys.homeassistant.core), "start"
+    ) as start, patch.object(
+        type(coresys.homeassistant.core.instance), "current_state"
+    ) as current_state:
+        current_state.return_value = mock_current_state(ContainerState.UNHEALTHY)
+        coresys.bus.fire_event(
+            BusEvent.DOCKER_CONTAINER_STATE_CHANGE,
+            DockerContainerStateEvent(
+                name="homeassistant",
+                state=ContainerState.UNHEALTHY,
+                id="abc123",
+                time=1,
+            ),
+        )
+        await asyncio.sleep(0)
+        restart.assert_called_once()
+        start.assert_not_called()
+
+        restart.reset_mock()
+        current_state.return_value = mock_current_state(ContainerState.FAILED)
+        coresys.bus.fire_event(
+            BusEvent.DOCKER_CONTAINER_STATE_CHANGE,
+            DockerContainerStateEvent(
+                name="homeassistant",
+                state=ContainerState.FAILED,
+                id="abc123",
+                time=1,
+            ),
+        )
+        await asyncio.sleep(0)
+        restart.assert_not_called()
+        start.assert_called_once()
+
+        start.reset_mock()
+        # Do not process event if container state has changed since fired
+        current_state.return_value = mock_current_state(ContainerState.HEALTHY)
+        coresys.bus.fire_event(
+            BusEvent.DOCKER_CONTAINER_STATE_CHANGE,
+            DockerContainerStateEvent(
+                name="homeassistant",
+                state=ContainerState.FAILED,
+                id="abc123",
+                time=1,
+            ),
+        )
+        await asyncio.sleep(0)
+        restart.assert_not_called()
+        start.assert_not_called()
+
+        # Do not restart when home assistant stopped normally
+        coresys.bus.fire_event(
+            BusEvent.DOCKER_CONTAINER_STATE_CHANGE,
+            DockerContainerStateEvent(
+                name="homeassistant",
+                state=ContainerState.STOPPED,
+                id="abc123",
+                time=1,
+            ),
+        )
+        await asyncio.sleep(0)
+        restart.assert_not_called()
+        start.assert_not_called()
+
+        # Other containers ignored
+        coresys.bus.fire_event(
+            BusEvent.DOCKER_CONTAINER_STATE_CHANGE,
+            DockerContainerStateEvent(
+                name="addon_local_other",
+                state=ContainerState.UNHEALTHY,
+                id="abc123",
+                time=1,
+            ),
+        )
+        await asyncio.sleep(0)
+        restart.assert_not_called()
+        start.assert_not_called()
+
+
+async def test_home_assistant_watchdog_rebuild_on_failure(coresys: CoreSys) -> None:
+    """Test home assistant watchdog rebuilds if start fails."""
+    coresys.homeassistant.version = AwesomeVersion("2022.7.3")
+    with patch(
+        "supervisor.docker.interface.DockerInterface.version",
+        new=PropertyMock(return_value=AwesomeVersion("2022.7.3")),
+    ), patch.object(type(coresys.homeassistant.core.instance), "attach"):
+        await coresys.homeassistant.core.load()
+
+    coresys.homeassistant.core.watchdog = True
+
+    with patch.object(
+        type(coresys.homeassistant.core), "start", side_effect=HomeAssistantError()
+    ) as start, patch.object(
+        type(coresys.homeassistant.core), "rebuild"
+    ) as rebuild, patch.object(
+        type(coresys.homeassistant.core.instance),
+        "current_state",
+        return_value=mock_current_state(ContainerState.FAILED),
+    ):
+        coresys.bus.fire_event(
+            BusEvent.DOCKER_CONTAINER_STATE_CHANGE,
+            DockerContainerStateEvent(
+                name="homeassistant",
+                state=ContainerState.FAILED,
+                id="abc123",
+                time=1,
+            ),
+        )
+        await asyncio.sleep(0)
+        start.assert_called_once()
+        rebuild.assert_called_once()