mirror of
https://github.com/home-assistant/supervisor.git
synced 2025-10-26 03:59:35 +00:00
f3e1e0f423
* Fix CID file handling to prevent directory creation It seems that under certain conditions Docker creates a directory instead of a file for the CID file. This change ensures that the CID file is always created as a file, and any existing directory is removed before creating the file. * Fix tests * Fix pytest
916 lines
30 KiB
Python
916 lines
30 KiB
Python
"""Test Docker interface."""
|
|
|
|
import asyncio
|
|
from pathlib import Path
|
|
from typing import Any
|
|
from unittest.mock import ANY, AsyncMock, MagicMock, Mock, PropertyMock, call, patch
|
|
|
|
from awesomeversion import AwesomeVersion
|
|
from docker.errors import DockerException, NotFound
|
|
from docker.models.containers import Container
|
|
from docker.models.images import Image
|
|
import pytest
|
|
from requests import RequestException
|
|
|
|
from supervisor.addons.manager import Addon
|
|
from supervisor.const import BusEvent, CoreState, CpuArch
|
|
from supervisor.coresys import CoreSys
|
|
from supervisor.docker.const import ContainerState
|
|
from supervisor.docker.interface import DockerInterface
|
|
from supervisor.docker.manager import PullLogEntry, PullProgressDetail
|
|
from supervisor.docker.monitor import DockerContainerStateEvent
|
|
from supervisor.exceptions import (
|
|
DockerAPIError,
|
|
DockerError,
|
|
DockerNoSpaceOnDevice,
|
|
DockerNotFound,
|
|
DockerRequestError,
|
|
)
|
|
from supervisor.homeassistant.const import WSEvent
|
|
from supervisor.jobs import JobSchedulerOptions, SupervisorJob
|
|
|
|
from tests.common import load_json_fixture
|
|
|
|
|
|
@pytest.fixture(autouse=True)
|
|
def mock_verify_content(coresys: CoreSys):
|
|
"""Mock verify_content utility during tests."""
|
|
with patch.object(
|
|
coresys.security, "verify_content", return_value=None
|
|
) as verify_content:
|
|
yield verify_content
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"cpu_arch, platform",
|
|
[
|
|
(CpuArch.ARMV7, "linux/arm/v7"),
|
|
(CpuArch.ARMHF, "linux/arm/v6"),
|
|
(CpuArch.AARCH64, "linux/arm64"),
|
|
(CpuArch.I386, "linux/386"),
|
|
(CpuArch.AMD64, "linux/amd64"),
|
|
],
|
|
)
|
|
async def test_docker_image_platform(
|
|
coresys: CoreSys,
|
|
test_docker_interface: DockerInterface,
|
|
cpu_arch: str,
|
|
platform: str,
|
|
):
|
|
"""Test platform set correctly from arch."""
|
|
with patch.object(
|
|
coresys.docker.images, "get", return_value=Mock(id="test:1.2.3")
|
|
) as get:
|
|
await test_docker_interface.install(
|
|
AwesomeVersion("1.2.3"), "test", arch=cpu_arch
|
|
)
|
|
coresys.docker.docker.api.pull.assert_called_once_with(
|
|
"test", tag="1.2.3", platform=platform, stream=True, decode=True
|
|
)
|
|
get.assert_called_once_with("test:1.2.3")
|
|
|
|
|
|
async def test_docker_image_default_platform(
|
|
coresys: CoreSys, test_docker_interface: DockerInterface
|
|
):
|
|
"""Test platform set using supervisor arch when omitted."""
|
|
with (
|
|
patch.object(
|
|
type(coresys.supervisor), "arch", PropertyMock(return_value="i386")
|
|
),
|
|
patch.object(
|
|
coresys.docker.images, "get", return_value=Mock(id="test:1.2.3")
|
|
) as get,
|
|
):
|
|
await test_docker_interface.install(AwesomeVersion("1.2.3"), "test")
|
|
coresys.docker.docker.api.pull.assert_called_once_with(
|
|
"test", tag="1.2.3", platform="linux/386", stream=True, decode=True
|
|
)
|
|
get.assert_called_once_with("test:1.2.3")
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"attrs,expected",
|
|
[
|
|
({"State": {"Status": "running"}}, ContainerState.RUNNING),
|
|
({"State": {"Status": "exited", "ExitCode": 0}}, ContainerState.STOPPED),
|
|
({"State": {"Status": "exited", "ExitCode": 137}}, ContainerState.FAILED),
|
|
(
|
|
{"State": {"Status": "running", "Health": {"Status": "healthy"}}},
|
|
ContainerState.HEALTHY,
|
|
),
|
|
(
|
|
{"State": {"Status": "running", "Health": {"Status": "unhealthy"}}},
|
|
ContainerState.UNHEALTHY,
|
|
),
|
|
],
|
|
)
|
|
async def test_current_state(
|
|
coresys: CoreSys, attrs: dict[str, Any], expected: ContainerState
|
|
):
|
|
"""Test current state for container."""
|
|
container_collection = MagicMock()
|
|
container_collection.get.return_value = Container(attrs)
|
|
with patch(
|
|
"supervisor.docker.manager.DockerAPI.containers",
|
|
new=PropertyMock(return_value=container_collection),
|
|
):
|
|
assert await coresys.homeassistant.core.instance.current_state() == expected
|
|
|
|
|
|
async def test_current_state_failures(coresys: CoreSys):
|
|
"""Test failure states for current state."""
|
|
container_collection = MagicMock()
|
|
with patch(
|
|
"supervisor.docker.manager.DockerAPI.containers",
|
|
new=PropertyMock(return_value=container_collection),
|
|
):
|
|
container_collection.get.side_effect = NotFound("dne")
|
|
assert (
|
|
await coresys.homeassistant.core.instance.current_state()
|
|
== ContainerState.UNKNOWN
|
|
)
|
|
|
|
container_collection.get.side_effect = DockerException()
|
|
with pytest.raises(DockerAPIError):
|
|
await coresys.homeassistant.core.instance.current_state()
|
|
|
|
container_collection.get.side_effect = RequestException()
|
|
with pytest.raises(DockerRequestError):
|
|
await coresys.homeassistant.core.instance.current_state()
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"attrs,expected,fired_when_skip_down",
|
|
[
|
|
({"State": {"Status": "running"}}, ContainerState.RUNNING, True),
|
|
({"State": {"Status": "exited", "ExitCode": 0}}, ContainerState.STOPPED, False),
|
|
(
|
|
{"State": {"Status": "exited", "ExitCode": 137}},
|
|
ContainerState.FAILED,
|
|
False,
|
|
),
|
|
(
|
|
{"State": {"Status": "running", "Health": {"Status": "healthy"}}},
|
|
ContainerState.HEALTHY,
|
|
True,
|
|
),
|
|
(
|
|
{"State": {"Status": "running", "Health": {"Status": "unhealthy"}}},
|
|
ContainerState.UNHEALTHY,
|
|
True,
|
|
),
|
|
],
|
|
)
|
|
async def test_attach_existing_container(
|
|
coresys: CoreSys,
|
|
attrs: dict[str, Any],
|
|
expected: ContainerState,
|
|
fired_when_skip_down: bool,
|
|
):
|
|
"""Test attaching to existing container."""
|
|
attrs["Id"] = "abc123"
|
|
attrs["Config"] = {}
|
|
container_collection = MagicMock()
|
|
container_collection.get.return_value = Container(attrs)
|
|
with (
|
|
patch(
|
|
"supervisor.docker.manager.DockerAPI.containers",
|
|
new=PropertyMock(return_value=container_collection),
|
|
),
|
|
patch.object(type(coresys.bus), "fire_event") as fire_event,
|
|
patch("supervisor.docker.interface.time", return_value=1),
|
|
):
|
|
await coresys.homeassistant.core.instance.attach(AwesomeVersion("2022.7.3"))
|
|
await asyncio.sleep(0)
|
|
assert [
|
|
event
|
|
for event in fire_event.call_args_list
|
|
if event.args[0] == BusEvent.DOCKER_CONTAINER_STATE_CHANGE
|
|
] == [
|
|
call(
|
|
BusEvent.DOCKER_CONTAINER_STATE_CHANGE,
|
|
DockerContainerStateEvent("homeassistant", expected, "abc123", 1),
|
|
)
|
|
]
|
|
|
|
fire_event.reset_mock()
|
|
await coresys.homeassistant.core.instance.attach(
|
|
AwesomeVersion("2022.7.3"), skip_state_event_if_down=True
|
|
)
|
|
await asyncio.sleep(0)
|
|
docker_events = [
|
|
event
|
|
for event in fire_event.call_args_list
|
|
if event.args[0] == BusEvent.DOCKER_CONTAINER_STATE_CHANGE
|
|
]
|
|
if fired_when_skip_down:
|
|
assert docker_events == [
|
|
call(
|
|
BusEvent.DOCKER_CONTAINER_STATE_CHANGE,
|
|
DockerContainerStateEvent("homeassistant", expected, "abc123", 1),
|
|
)
|
|
]
|
|
else:
|
|
assert not docker_events
|
|
|
|
|
|
async def test_attach_container_failure(coresys: CoreSys):
|
|
"""Test attach fails to find container but finds image."""
|
|
container_collection = MagicMock()
|
|
container_collection.get.side_effect = DockerException()
|
|
image_collection = MagicMock()
|
|
image_config = {"Image": "sha256:abc123"}
|
|
image_collection.get.return_value = Image({"Config": image_config})
|
|
with (
|
|
patch(
|
|
"supervisor.docker.manager.DockerAPI.containers",
|
|
new=PropertyMock(return_value=container_collection),
|
|
),
|
|
patch(
|
|
"supervisor.docker.manager.DockerAPI.images",
|
|
new=PropertyMock(return_value=image_collection),
|
|
),
|
|
patch.object(type(coresys.bus), "fire_event") as fire_event,
|
|
):
|
|
await coresys.homeassistant.core.instance.attach(AwesomeVersion("2022.7.3"))
|
|
assert not [
|
|
event
|
|
for event in fire_event.call_args_list
|
|
if event.args[0] == BusEvent.DOCKER_CONTAINER_STATE_CHANGE
|
|
]
|
|
assert coresys.homeassistant.core.instance.meta_config == image_config
|
|
|
|
|
|
async def test_attach_total_failure(coresys: CoreSys):
|
|
"""Test attach fails to find container or image."""
|
|
container_collection = MagicMock()
|
|
container_collection.get.side_effect = DockerException()
|
|
image_collection = MagicMock()
|
|
image_collection.get.side_effect = DockerException()
|
|
with (
|
|
patch(
|
|
"supervisor.docker.manager.DockerAPI.containers",
|
|
new=PropertyMock(return_value=container_collection),
|
|
),
|
|
patch(
|
|
"supervisor.docker.manager.DockerAPI.images",
|
|
new=PropertyMock(return_value=image_collection),
|
|
),
|
|
pytest.raises(DockerError),
|
|
):
|
|
await coresys.homeassistant.core.instance.attach(AwesomeVersion("2022.7.3"))
|
|
|
|
|
|
@pytest.mark.parametrize("err", [DockerException(), RequestException()])
|
|
async def test_image_pull_fail(
|
|
coresys: CoreSys, capture_exception: Mock, err: Exception
|
|
):
|
|
"""Test failure to pull image."""
|
|
coresys.docker.images.get.side_effect = err
|
|
with pytest.raises(DockerError):
|
|
await coresys.homeassistant.core.instance.install(
|
|
AwesomeVersion("2022.7.3"), arch=CpuArch.AMD64
|
|
)
|
|
|
|
capture_exception.assert_called_once_with(err)
|
|
|
|
|
|
async def test_run_missing_image(
|
|
coresys: CoreSys,
|
|
install_addon_ssh: Addon,
|
|
container: MagicMock,
|
|
capture_exception: Mock,
|
|
path_extern,
|
|
tmp_supervisor_data: Path,
|
|
):
|
|
"""Test run captures the exception when image is missing."""
|
|
coresys.docker.containers.create.side_effect = [NotFound("missing"), MagicMock()]
|
|
container.status = "stopped"
|
|
install_addon_ssh.data["image"] = "test_image"
|
|
|
|
with pytest.raises(DockerNotFound):
|
|
await install_addon_ssh.instance.run()
|
|
|
|
capture_exception.assert_called_once()
|
|
|
|
|
|
async def test_install_fires_progress_events(
|
|
coresys: CoreSys, test_docker_interface: DockerInterface
|
|
):
|
|
"""Test progress events are fired during an install for listeners."""
|
|
# This is from a sample pull. Filtered log to just one per unique status for test
|
|
coresys.docker.docker.api.pull.return_value = [
|
|
{
|
|
"status": "Pulling from home-assistant/odroid-n2-homeassistant",
|
|
"id": "2025.7.2",
|
|
},
|
|
{"status": "Already exists", "progressDetail": {}, "id": "6e771e15690e"},
|
|
{"status": "Pulling fs layer", "progressDetail": {}, "id": "1578b14a573c"},
|
|
{"status": "Waiting", "progressDetail": {}, "id": "2488d0e401e1"},
|
|
{
|
|
"status": "Downloading",
|
|
"progressDetail": {"current": 1378, "total": 1486},
|
|
"progress": "[==============================================> ] 1.378kB/1.486kB",
|
|
"id": "1578b14a573c",
|
|
},
|
|
{"status": "Download complete", "progressDetail": {}, "id": "1578b14a573c"},
|
|
{
|
|
"status": "Extracting",
|
|
"progressDetail": {"current": 1486, "total": 1486},
|
|
"progress": "[==================================================>] 1.486kB/1.486kB",
|
|
"id": "1578b14a573c",
|
|
},
|
|
{"status": "Pull complete", "progressDetail": {}, "id": "1578b14a573c"},
|
|
{"status": "Verifying Checksum", "progressDetail": {}, "id": "6a1e931d8f88"},
|
|
{
|
|
"status": "Digest: sha256:490080d7da0f385928022927990e04f604615f7b8c622ef3e58253d0f089881d"
|
|
},
|
|
{
|
|
"status": "Status: Downloaded newer image for ghcr.io/home-assistant/odroid-n2-homeassistant:2025.7.2"
|
|
},
|
|
]
|
|
|
|
events: list[PullLogEntry] = []
|
|
|
|
async def capture_log_entry(event: PullLogEntry) -> None:
|
|
events.append(event)
|
|
|
|
coresys.bus.register_event(BusEvent.DOCKER_IMAGE_PULL_UPDATE, capture_log_entry)
|
|
|
|
with (
|
|
patch.object(
|
|
type(coresys.supervisor), "arch", PropertyMock(return_value="i386")
|
|
),
|
|
):
|
|
await test_docker_interface.install(AwesomeVersion("1.2.3"), "test")
|
|
coresys.docker.docker.api.pull.assert_called_once_with(
|
|
"test", tag="1.2.3", platform="linux/386", stream=True, decode=True
|
|
)
|
|
coresys.docker.images.get.assert_called_once_with("test:1.2.3")
|
|
|
|
await asyncio.sleep(1)
|
|
assert events == [
|
|
PullLogEntry(
|
|
job_id=ANY,
|
|
status="Pulling from home-assistant/odroid-n2-homeassistant",
|
|
id="2025.7.2",
|
|
),
|
|
PullLogEntry(
|
|
job_id=ANY,
|
|
status="Already exists",
|
|
progress_detail=PullProgressDetail(),
|
|
id="6e771e15690e",
|
|
),
|
|
PullLogEntry(
|
|
job_id=ANY,
|
|
status="Pulling fs layer",
|
|
progress_detail=PullProgressDetail(),
|
|
id="1578b14a573c",
|
|
),
|
|
PullLogEntry(
|
|
job_id=ANY,
|
|
status="Waiting",
|
|
progress_detail=PullProgressDetail(),
|
|
id="2488d0e401e1",
|
|
),
|
|
PullLogEntry(
|
|
job_id=ANY,
|
|
status="Downloading",
|
|
progress_detail=PullProgressDetail(current=1378, total=1486),
|
|
progress="[==============================================> ] 1.378kB/1.486kB",
|
|
id="1578b14a573c",
|
|
),
|
|
PullLogEntry(
|
|
job_id=ANY,
|
|
status="Download complete",
|
|
progress_detail=PullProgressDetail(),
|
|
id="1578b14a573c",
|
|
),
|
|
PullLogEntry(
|
|
job_id=ANY,
|
|
status="Extracting",
|
|
progress_detail=PullProgressDetail(current=1486, total=1486),
|
|
progress="[==================================================>] 1.486kB/1.486kB",
|
|
id="1578b14a573c",
|
|
),
|
|
PullLogEntry(
|
|
job_id=ANY,
|
|
status="Pull complete",
|
|
progress_detail=PullProgressDetail(),
|
|
id="1578b14a573c",
|
|
),
|
|
PullLogEntry(
|
|
job_id=ANY,
|
|
status="Verifying Checksum",
|
|
progress_detail=PullProgressDetail(),
|
|
id="6a1e931d8f88",
|
|
),
|
|
PullLogEntry(
|
|
job_id=ANY,
|
|
status="Digest: sha256:490080d7da0f385928022927990e04f604615f7b8c622ef3e58253d0f089881d",
|
|
),
|
|
PullLogEntry(
|
|
job_id=ANY,
|
|
status="Status: Downloaded newer image for ghcr.io/home-assistant/odroid-n2-homeassistant:2025.7.2",
|
|
),
|
|
]
|
|
|
|
|
|
async def test_install_sends_progress_to_home_assistant(
|
|
coresys: CoreSys, test_docker_interface: DockerInterface, ha_ws_client: AsyncMock
|
|
):
|
|
"""Test progress events are sent as job updates to Home Assistant."""
|
|
coresys.core.set_state(CoreState.RUNNING)
|
|
coresys.docker.docker.api.pull.return_value = load_json_fixture(
|
|
"docker_pull_image_log.json"
|
|
)
|
|
|
|
with (
|
|
patch.object(
|
|
type(coresys.supervisor), "arch", PropertyMock(return_value="i386")
|
|
),
|
|
):
|
|
# Schedule job so we can listen for the end. Then we can assert against the WS mock
|
|
event = asyncio.Event()
|
|
job, install_task = coresys.jobs.schedule_job(
|
|
test_docker_interface.install,
|
|
JobSchedulerOptions(),
|
|
AwesomeVersion("1.2.3"),
|
|
"test",
|
|
)
|
|
|
|
async def listen_for_job_end(reference: SupervisorJob):
|
|
if reference.uuid != job.uuid:
|
|
return
|
|
event.set()
|
|
|
|
coresys.bus.register_event(BusEvent.SUPERVISOR_JOB_END, listen_for_job_end)
|
|
await install_task
|
|
await event.wait()
|
|
|
|
events = [
|
|
evt.args[0]["data"]["data"]
|
|
for evt in ha_ws_client.async_send_command.call_args_list
|
|
if "data" in evt.args[0] and evt.args[0]["data"]["event"] == WSEvent.JOB
|
|
]
|
|
assert events[0]["name"] == "docker_interface_install"
|
|
assert events[0]["uuid"] == job.uuid
|
|
assert events[0]["done"] is None
|
|
assert events[1]["name"] == "docker_interface_install"
|
|
assert events[1]["uuid"] == job.uuid
|
|
assert events[1]["done"] is False
|
|
assert events[-1]["name"] == "docker_interface_install"
|
|
assert events[-1]["uuid"] == job.uuid
|
|
assert events[-1]["done"] is True
|
|
|
|
def make_sub_log(layer_id: str):
|
|
return [
|
|
{
|
|
"stage": evt["stage"],
|
|
"progress": evt["progress"],
|
|
"done": evt["done"],
|
|
"extra": evt["extra"],
|
|
}
|
|
for evt in events
|
|
if evt["name"] == "Pulling container image layer"
|
|
and evt["reference"] == layer_id
|
|
and evt["parent_id"] == job.uuid
|
|
]
|
|
|
|
layer_1_log = make_sub_log("1e214cd6d7d0")
|
|
layer_2_log = make_sub_log("1a38e1d5e18d")
|
|
assert len(layer_1_log) == 20
|
|
assert len(layer_2_log) == 19
|
|
assert len(events) == 42
|
|
assert layer_1_log == [
|
|
{"stage": "Pulling fs layer", "progress": 0, "done": False, "extra": None},
|
|
{
|
|
"stage": "Downloading",
|
|
"progress": 0.1,
|
|
"done": False,
|
|
"extra": {"current": 539462, "total": 436480882},
|
|
},
|
|
{
|
|
"stage": "Downloading",
|
|
"progress": 0.6,
|
|
"done": False,
|
|
"extra": {"current": 4864838, "total": 436480882},
|
|
},
|
|
{
|
|
"stage": "Downloading",
|
|
"progress": 0.9,
|
|
"done": False,
|
|
"extra": {"current": 7552896, "total": 436480882},
|
|
},
|
|
{
|
|
"stage": "Downloading",
|
|
"progress": 1.2,
|
|
"done": False,
|
|
"extra": {"current": 10252544, "total": 436480882},
|
|
},
|
|
{
|
|
"stage": "Downloading",
|
|
"progress": 2.9,
|
|
"done": False,
|
|
"extra": {"current": 25369792, "total": 436480882},
|
|
},
|
|
{
|
|
"stage": "Downloading",
|
|
"progress": 11.9,
|
|
"done": False,
|
|
"extra": {"current": 103619904, "total": 436480882},
|
|
},
|
|
{
|
|
"stage": "Downloading",
|
|
"progress": 26.1,
|
|
"done": False,
|
|
"extra": {"current": 227726144, "total": 436480882},
|
|
},
|
|
{
|
|
"stage": "Downloading",
|
|
"progress": 49.6,
|
|
"done": False,
|
|
"extra": {"current": 433170048, "total": 436480882},
|
|
},
|
|
{
|
|
"stage": "Verifying Checksum",
|
|
"progress": 50,
|
|
"done": False,
|
|
"extra": {"current": 433170048, "total": 436480882},
|
|
},
|
|
{
|
|
"stage": "Download complete",
|
|
"progress": 50,
|
|
"done": False,
|
|
"extra": {"current": 433170048, "total": 436480882},
|
|
},
|
|
{
|
|
"stage": "Extracting",
|
|
"progress": 50.1,
|
|
"done": False,
|
|
"extra": {"current": 557056, "total": 436480882},
|
|
},
|
|
{
|
|
"stage": "Extracting",
|
|
"progress": 60.3,
|
|
"done": False,
|
|
"extra": {"current": 89686016, "total": 436480882},
|
|
},
|
|
{
|
|
"stage": "Extracting",
|
|
"progress": 70.0,
|
|
"done": False,
|
|
"extra": {"current": 174358528, "total": 436480882},
|
|
},
|
|
{
|
|
"stage": "Extracting",
|
|
"progress": 80.0,
|
|
"done": False,
|
|
"extra": {"current": 261816320, "total": 436480882},
|
|
},
|
|
{
|
|
"stage": "Extracting",
|
|
"progress": 88.4,
|
|
"done": False,
|
|
"extra": {"current": 334790656, "total": 436480882},
|
|
},
|
|
{
|
|
"stage": "Extracting",
|
|
"progress": 94.0,
|
|
"done": False,
|
|
"extra": {"current": 383811584, "total": 436480882},
|
|
},
|
|
{
|
|
"stage": "Extracting",
|
|
"progress": 99.9,
|
|
"done": False,
|
|
"extra": {"current": 435617792, "total": 436480882},
|
|
},
|
|
{
|
|
"stage": "Extracting",
|
|
"progress": 100.0,
|
|
"done": False,
|
|
"extra": {"current": 436480882, "total": 436480882},
|
|
},
|
|
{
|
|
"stage": "Pull complete",
|
|
"progress": 100.0,
|
|
"done": True,
|
|
"extra": {"current": 436480882, "total": 436480882},
|
|
},
|
|
]
|
|
|
|
|
|
async def test_install_progress_rounding_does_not_cause_misses(
|
|
coresys: CoreSys, test_docker_interface: DockerInterface, ha_ws_client: AsyncMock
|
|
):
|
|
"""Test extremely close progress events do not create rounding issues."""
|
|
coresys.core.set_state(CoreState.RUNNING)
|
|
coresys.docker.docker.api.pull.return_value = [
|
|
{
|
|
"status": "Pulling from home-assistant/odroid-n2-homeassistant",
|
|
"id": "2025.7.1",
|
|
},
|
|
{"status": "Pulling fs layer", "progressDetail": {}, "id": "1e214cd6d7d0"},
|
|
{
|
|
"status": "Downloading",
|
|
"progressDetail": {"current": 432700000, "total": 436480882},
|
|
"progress": "[=================================================> ] 432.7MB/436.5MB",
|
|
"id": "1e214cd6d7d0",
|
|
},
|
|
{
|
|
"status": "Downloading",
|
|
"progressDetail": {"current": 432800000, "total": 436480882},
|
|
"progress": "[=================================================> ] 432.8MB/436.5MB",
|
|
"id": "1e214cd6d7d0",
|
|
},
|
|
{"status": "Verifying Checksum", "progressDetail": {}, "id": "1e214cd6d7d0"},
|
|
{"status": "Download complete", "progressDetail": {}, "id": "1e214cd6d7d0"},
|
|
{
|
|
"status": "Extracting",
|
|
"progressDetail": {"current": 432700000, "total": 436480882},
|
|
"progress": "[=================================================> ] 432.7MB/436.5MB",
|
|
"id": "1e214cd6d7d0",
|
|
},
|
|
{
|
|
"status": "Extracting",
|
|
"progressDetail": {"current": 432800000, "total": 436480882},
|
|
"progress": "[=================================================> ] 432.8MB/436.5MB",
|
|
"id": "1e214cd6d7d0",
|
|
},
|
|
{"status": "Pull complete", "progressDetail": {}, "id": "1e214cd6d7d0"},
|
|
{
|
|
"status": "Digest: sha256:7d97da645f232f82a768d0a537e452536719d56d484d419836e53dbe3e4ec736"
|
|
},
|
|
{
|
|
"status": "Status: Downloaded newer image for ghcr.io/home-assistant/odroid-n2-homeassistant:2025.7.1"
|
|
},
|
|
]
|
|
|
|
with (
|
|
patch.object(
|
|
type(coresys.supervisor), "arch", PropertyMock(return_value="i386")
|
|
),
|
|
):
|
|
# Schedule job so we can listen for the end. Then we can assert against the WS mock
|
|
event = asyncio.Event()
|
|
job, install_task = coresys.jobs.schedule_job(
|
|
test_docker_interface.install,
|
|
JobSchedulerOptions(),
|
|
AwesomeVersion("1.2.3"),
|
|
"test",
|
|
)
|
|
|
|
async def listen_for_job_end(reference: SupervisorJob):
|
|
if reference.uuid != job.uuid:
|
|
return
|
|
event.set()
|
|
|
|
coresys.bus.register_event(BusEvent.SUPERVISOR_JOB_END, listen_for_job_end)
|
|
await install_task
|
|
await event.wait()
|
|
|
|
events = [
|
|
evt.args[0]["data"]["data"]
|
|
for evt in ha_ws_client.async_send_command.call_args_list
|
|
if "data" in evt.args[0]
|
|
and evt.args[0]["data"]["event"] == WSEvent.JOB
|
|
and evt.args[0]["data"]["data"]["reference"] == "1e214cd6d7d0"
|
|
and evt.args[0]["data"]["data"]["stage"] in {"Downloading", "Extracting"}
|
|
]
|
|
|
|
assert events == [
|
|
{
|
|
"name": "Pulling container image layer",
|
|
"stage": "Downloading",
|
|
"progress": 49.6,
|
|
"done": False,
|
|
"extra": {"current": 432700000, "total": 436480882},
|
|
"reference": "1e214cd6d7d0",
|
|
"parent_id": job.uuid,
|
|
"errors": [],
|
|
"uuid": ANY,
|
|
"created": ANY,
|
|
},
|
|
{
|
|
"name": "Pulling container image layer",
|
|
"stage": "Downloading",
|
|
"progress": 49.6,
|
|
"done": False,
|
|
"extra": {"current": 432800000, "total": 436480882},
|
|
"reference": "1e214cd6d7d0",
|
|
"parent_id": job.uuid,
|
|
"errors": [],
|
|
"uuid": ANY,
|
|
"created": ANY,
|
|
},
|
|
{
|
|
"name": "Pulling container image layer",
|
|
"stage": "Extracting",
|
|
"progress": 99.6,
|
|
"done": False,
|
|
"extra": {"current": 432700000, "total": 436480882},
|
|
"reference": "1e214cd6d7d0",
|
|
"parent_id": job.uuid,
|
|
"errors": [],
|
|
"uuid": ANY,
|
|
"created": ANY,
|
|
},
|
|
{
|
|
"name": "Pulling container image layer",
|
|
"stage": "Extracting",
|
|
"progress": 99.6,
|
|
"done": False,
|
|
"extra": {"current": 432800000, "total": 436480882},
|
|
"reference": "1e214cd6d7d0",
|
|
"parent_id": job.uuid,
|
|
"errors": [],
|
|
"uuid": ANY,
|
|
"created": ANY,
|
|
},
|
|
]
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
("error_log", "exc_type", "exc_msg"),
|
|
[
|
|
(
|
|
{
|
|
"errorDetail": {
|
|
"message": "write /mnt/data/docker/tmp/GetImageBlob2228293192: no space left on device"
|
|
},
|
|
"error": "write /mnt/data/docker/tmp/GetImageBlob2228293192: no space left on device",
|
|
},
|
|
DockerNoSpaceOnDevice,
|
|
"No space left on disk",
|
|
),
|
|
(
|
|
{"errorDetail": {"message": "failure"}, "error": "failure"},
|
|
DockerError,
|
|
"failure",
|
|
),
|
|
],
|
|
)
|
|
async def test_install_raises_on_pull_error(
|
|
coresys: CoreSys,
|
|
test_docker_interface: DockerInterface,
|
|
error_log: dict[str, Any],
|
|
exc_type: type[DockerError],
|
|
exc_msg: str,
|
|
):
|
|
"""Test exceptions raised from errors in pull log."""
|
|
coresys.docker.docker.api.pull.return_value = [
|
|
{
|
|
"status": "Pulling from home-assistant/odroid-n2-homeassistant",
|
|
"id": "2025.7.2",
|
|
},
|
|
{
|
|
"status": "Downloading",
|
|
"progressDetail": {"current": 1378, "total": 1486},
|
|
"progress": "[==============================================> ] 1.378kB/1.486kB",
|
|
"id": "1578b14a573c",
|
|
},
|
|
error_log,
|
|
]
|
|
|
|
with pytest.raises(exc_type, match=exc_msg):
|
|
await test_docker_interface.install(AwesomeVersion("1.2.3"), "test")
|
|
|
|
|
|
async def test_install_progress_handles_download_restart(
|
|
coresys: CoreSys, test_docker_interface: DockerInterface, ha_ws_client: AsyncMock
|
|
):
|
|
"""Test install handles docker progress events that include a download restart."""
|
|
coresys.core.set_state(CoreState.RUNNING)
|
|
coresys.docker.docker.api.pull.return_value = load_json_fixture(
|
|
"docker_pull_image_log_restart.json"
|
|
)
|
|
|
|
with (
|
|
patch.object(
|
|
type(coresys.supervisor), "arch", PropertyMock(return_value="i386")
|
|
),
|
|
):
|
|
# Schedule job so we can listen for the end. Then we can assert against the WS mock
|
|
event = asyncio.Event()
|
|
job, install_task = coresys.jobs.schedule_job(
|
|
test_docker_interface.install,
|
|
JobSchedulerOptions(),
|
|
AwesomeVersion("1.2.3"),
|
|
"test",
|
|
)
|
|
|
|
async def listen_for_job_end(reference: SupervisorJob):
|
|
if reference.uuid != job.uuid:
|
|
return
|
|
event.set()
|
|
|
|
coresys.bus.register_event(BusEvent.SUPERVISOR_JOB_END, listen_for_job_end)
|
|
await install_task
|
|
await event.wait()
|
|
|
|
events = [
|
|
evt.args[0]["data"]["data"]
|
|
for evt in ha_ws_client.async_send_command.call_args_list
|
|
if "data" in evt.args[0] and evt.args[0]["data"]["event"] == WSEvent.JOB
|
|
]
|
|
|
|
def make_sub_log(layer_id: str):
|
|
return [
|
|
{
|
|
"stage": evt["stage"],
|
|
"progress": evt["progress"],
|
|
"done": evt["done"],
|
|
"extra": evt["extra"],
|
|
}
|
|
for evt in events
|
|
if evt["name"] == "Pulling container image layer"
|
|
and evt["reference"] == layer_id
|
|
and evt["parent_id"] == job.uuid
|
|
]
|
|
|
|
layer_1_log = make_sub_log("1e214cd6d7d0")
|
|
assert len(layer_1_log) == 14
|
|
assert layer_1_log == [
|
|
{"stage": "Pulling fs layer", "progress": 0, "done": False, "extra": None},
|
|
{
|
|
"stage": "Downloading",
|
|
"progress": 11.9,
|
|
"done": False,
|
|
"extra": {"current": 103619904, "total": 436480882},
|
|
},
|
|
{
|
|
"stage": "Downloading",
|
|
"progress": 26.1,
|
|
"done": False,
|
|
"extra": {"current": 227726144, "total": 436480882},
|
|
},
|
|
{
|
|
"stage": "Downloading",
|
|
"progress": 49.6,
|
|
"done": False,
|
|
"extra": {"current": 433170048, "total": 436480882},
|
|
},
|
|
{
|
|
"stage": "Retrying download",
|
|
"progress": 0,
|
|
"done": False,
|
|
"extra": None,
|
|
},
|
|
{
|
|
"stage": "Retrying download",
|
|
"progress": 0,
|
|
"done": False,
|
|
"extra": None,
|
|
},
|
|
{
|
|
"stage": "Downloading",
|
|
"progress": 11.9,
|
|
"done": False,
|
|
"extra": {"current": 103619904, "total": 436480882},
|
|
},
|
|
{
|
|
"stage": "Downloading",
|
|
"progress": 26.1,
|
|
"done": False,
|
|
"extra": {"current": 227726144, "total": 436480882},
|
|
},
|
|
{
|
|
"stage": "Downloading",
|
|
"progress": 49.6,
|
|
"done": False,
|
|
"extra": {"current": 433170048, "total": 436480882},
|
|
},
|
|
{
|
|
"stage": "Verifying Checksum",
|
|
"progress": 50,
|
|
"done": False,
|
|
"extra": {"current": 433170048, "total": 436480882},
|
|
},
|
|
{
|
|
"stage": "Download complete",
|
|
"progress": 50,
|
|
"done": False,
|
|
"extra": {"current": 433170048, "total": 436480882},
|
|
},
|
|
{
|
|
"stage": "Extracting",
|
|
"progress": 80.0,
|
|
"done": False,
|
|
"extra": {"current": 261816320, "total": 436480882},
|
|
},
|
|
{
|
|
"stage": "Extracting",
|
|
"progress": 100.0,
|
|
"done": False,
|
|
"extra": {"current": 436480882, "total": 436480882},
|
|
},
|
|
{
|
|
"stage": "Pull complete",
|
|
"progress": 100.0,
|
|
"done": True,
|
|
"extra": {"current": 436480882, "total": 436480882},
|
|
},
|
|
]
|