From 325738829d522bd9120ffebd2733a1027a5ef716 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20S=C3=B8rensen?= Date: Wed, 13 Nov 2024 20:22:54 +0100 Subject: [PATCH 1/9] MVP implementation of Backup sync agents (#126122) * init sync agent * add syncing * root import * rename list to info and add sync state * Add base backup class * Revert unneded change * adjust tests * move to kitchen_sink * split * move * Adjustments * Adjustment * update * Tests * Test unknown agent * adjust * Adjust for different test environments * Change /info WS to contain a dictinary * reorder * Add websocket command to trigger sync from the supervisor * cleanup * Make mypy happier --------- Co-authored-by: Erik --- homeassistant/components/backup/__init__.py | 13 +- homeassistant/components/backup/const.py | 5 +- homeassistant/components/backup/http.py | 3 +- homeassistant/components/backup/manager.py | 99 +++++-- homeassistant/components/backup/models.py | 28 ++ homeassistant/components/backup/sync_agent.py | 73 ++++++ homeassistant/components/backup/websocket.py | 110 +++++++- .../components/kitchen_sink/backup.py | 74 ++++++ tests/components/backup/common.py | 37 +++ .../backup/snapshots/test_websocket.ambr | 176 +++++++++++++ tests/components/backup/test_manager.py | 191 +++++++++++++- tests/components/backup/test_websocket.py | 245 +++++++++++++++++- 12 files changed, 1009 insertions(+), 45 deletions(-) create mode 100644 homeassistant/components/backup/models.py create mode 100644 homeassistant/components/backup/sync_agent.py create mode 100644 homeassistant/components/kitchen_sink/backup.py diff --git a/homeassistant/components/backup/__init__.py b/homeassistant/components/backup/__init__.py index 907fda4c7f8..c7e8df88bd1 100644 --- a/homeassistant/components/backup/__init__.py +++ b/homeassistant/components/backup/__init__.py @@ -5,18 +5,25 @@ from homeassistant.helpers import config_validation as cv from homeassistant.helpers.hassio import is_hassio from homeassistant.helpers.typing import ConfigType -from .const import DATA_MANAGER, DOMAIN, LOGGER +from .const import DOMAIN, LOGGER from .http import async_register_http_views from .manager import BackupManager +from .models import BackupSyncMetadata +from .sync_agent import BackupSyncAgent, SyncedBackup from .websocket import async_register_websocket_handlers +__all__ = [ + "BackupSyncAgent", + "BackupSyncMetadata", + "SyncedBackup", +] + CONFIG_SCHEMA = cv.empty_config_schema(DOMAIN) async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool: """Set up the Backup integration.""" - backup_manager = BackupManager(hass) - hass.data[DATA_MANAGER] = backup_manager + hass.data[DOMAIN] = backup_manager = BackupManager(hass) with_hassio = is_hassio(hass) diff --git a/homeassistant/components/backup/const.py b/homeassistant/components/backup/const.py index f613f7cc352..a10fec80360 100644 --- a/homeassistant/components/backup/const.py +++ b/homeassistant/components/backup/const.py @@ -8,10 +8,11 @@ from typing import TYPE_CHECKING from homeassistant.util.hass_dict import HassKey if TYPE_CHECKING: - from .manager import BackupManager + from .manager import BaseBackupManager + from .models import BaseBackup DOMAIN = "backup" -DATA_MANAGER: HassKey[BackupManager] = HassKey(DOMAIN) +DATA_MANAGER: HassKey[BaseBackupManager[BaseBackup]] = HassKey(DOMAIN) LOGGER = getLogger(__package__) EXCLUDE_FROM_BACKUP = [ diff --git a/homeassistant/components/backup/http.py b/homeassistant/components/backup/http.py index 42693035bd3..da8c65098d0 100644 --- a/homeassistant/components/backup/http.py +++ b/homeassistant/components/backup/http.py @@ -15,6 +15,7 @@ from homeassistant.core import HomeAssistant, callback from homeassistant.util import slugify from .const import DATA_MANAGER +from .manager import BackupManager @callback @@ -39,7 +40,7 @@ class DownloadBackupView(HomeAssistantView): if not request["hass_user"].is_admin: return Response(status=HTTPStatus.UNAUTHORIZED) - manager = request.app[KEY_HASS].data[DATA_MANAGER] + manager = cast(BackupManager, request.app[KEY_HASS].data[DATA_MANAGER]) backup = await manager.async_get_backup(slug=slug) if backup is None or not backup.path.exists(): diff --git a/homeassistant/components/backup/manager.py b/homeassistant/components/backup/manager.py index ddc0a1eac3f..70f29679cdc 100644 --- a/homeassistant/components/backup/manager.py +++ b/homeassistant/components/backup/manager.py @@ -16,10 +16,11 @@ import tarfile from tarfile import TarError from tempfile import TemporaryDirectory import time -from typing import Any, Protocol, cast +from typing import Any, Generic, Protocol, cast import aiohttp from securetar import SecureTarFile, atomic_contents_add +from typing_extensions import TypeVar from homeassistant.backup_restore import RESTORE_BACKUP_FILE from homeassistant.const import __version__ as HAVERSION @@ -31,9 +32,13 @@ from homeassistant.util import dt as dt_util from homeassistant.util.json import json_loads_object from .const import DOMAIN, EXCLUDE_FROM_BACKUP, LOGGER +from .models import BaseBackup +from .sync_agent import BackupPlatformAgentProtocol, BackupSyncAgent BUF_SIZE = 2**20 * 4 # 4MB +_BackupT = TypeVar("_BackupT", bound=BaseBackup, default=BaseBackup) + @dataclass(slots=True) class NewBackup: @@ -43,14 +48,10 @@ class NewBackup: @dataclass(slots=True) -class Backup: +class Backup(BaseBackup): """Backup class.""" - slug: str - name: str - date: str path: Path - size: float def as_dict(self) -> dict: """Return a dict representation of this backup.""" @@ -76,19 +77,21 @@ class BackupPlatformProtocol(Protocol): """Perform operations after a backup finishes.""" -class BaseBackupManager(abc.ABC): +class BaseBackupManager(abc.ABC, Generic[_BackupT]): """Define the format that backup managers can have.""" def __init__(self, hass: HomeAssistant) -> None: """Initialize the backup manager.""" self.hass = hass self.backup_task: asyncio.Task | None = None - self.backups: dict[str, Backup] = {} + self.backups: dict[str, _BackupT] = {} self.loaded_platforms = False self.platforms: dict[str, BackupPlatformProtocol] = {} + self.sync_agents: dict[str, BackupSyncAgent] = {} + self.syncing = False @callback - def _add_platform( + def _add_platform_pre_post_handlers( self, hass: HomeAssistant, integration_domain: str, @@ -98,13 +101,25 @@ class BaseBackupManager(abc.ABC): if not hasattr(platform, "async_pre_backup") or not hasattr( platform, "async_post_backup" ): - LOGGER.warning( - "%s does not implement required functions for the backup platform", - integration_domain, - ) return + self.platforms[integration_domain] = platform + async def _async_add_platform_agents( + self, + hass: HomeAssistant, + integration_domain: str, + platform: BackupPlatformAgentProtocol, + ) -> None: + """Add a platform to the backup manager.""" + if not hasattr(platform, "async_get_backup_sync_agents"): + return + + agents = await platform.async_get_backup_sync_agents(hass=hass) + self.sync_agents.update( + {f"{integration_domain}.{agent.name}": agent for agent in agents} + ) + async def async_pre_backup_actions(self, **kwargs: Any) -> None: """Perform pre backup actions.""" if not self.loaded_platforms: @@ -139,10 +154,22 @@ class BaseBackupManager(abc.ABC): async def load_platforms(self) -> None: """Load backup platforms.""" + if self.loaded_platforms: + return await integration_platform.async_process_integration_platforms( - self.hass, DOMAIN, self._add_platform, wait_for_platforms=True + self.hass, + DOMAIN, + self._add_platform_pre_post_handlers, + wait_for_platforms=True, + ) + await integration_platform.async_process_integration_platforms( + self.hass, + DOMAIN, + self._async_add_platform_agents, + wait_for_platforms=True, ) LOGGER.debug("Loaded %s platforms", len(self.platforms)) + LOGGER.debug("Loaded %s agents", len(self.sync_agents)) self.loaded_platforms = True @abc.abstractmethod @@ -159,14 +186,14 @@ class BaseBackupManager(abc.ABC): """Generate a backup.""" @abc.abstractmethod - async def async_get_backups(self, **kwargs: Any) -> dict[str, Backup]: + async def async_get_backups(self, **kwargs: Any) -> dict[str, _BackupT]: """Get backups. Return a dictionary of Backup instances keyed by their slug. """ @abc.abstractmethod - async def async_get_backup(self, *, slug: str, **kwargs: Any) -> Backup | None: + async def async_get_backup(self, *, slug: str, **kwargs: Any) -> _BackupT | None: """Get a backup.""" @abc.abstractmethod @@ -182,8 +209,12 @@ class BaseBackupManager(abc.ABC): ) -> None: """Receive and store a backup file from upload.""" + @abc.abstractmethod + async def async_sync_backup(self, *, slug: str, **kwargs: Any) -> None: + """Sync a backup.""" -class BackupManager(BaseBackupManager): + +class BackupManager(BaseBackupManager[Backup]): """Backup manager for the Backup integration.""" def __init__(self, hass: HomeAssistant) -> None: @@ -192,10 +223,42 @@ class BackupManager(BaseBackupManager): self.backup_dir = Path(hass.config.path("backups")) self.loaded_backups = False + async def async_sync_backup(self, *, slug: str, **kwargs: Any) -> None: + """Sync a backup.""" + await self.load_platforms() + + if not self.sync_agents: + return + + if not (backup := await self.async_get_backup(slug=slug)): + return + + self.syncing = True + sync_backup_results = await asyncio.gather( + *( + agent.async_upload_backup( + path=backup.path, + metadata={ + "homeassistant": HAVERSION, + "size": backup.size, + "date": backup.date, + "slug": backup.slug, + "name": backup.name, + }, + ) + for agent in self.sync_agents.values() + ), + return_exceptions=True, + ) + for result in sync_backup_results: + if isinstance(result, Exception): + LOGGER.error("Error during backup sync - %s", result) + self.syncing = False + async def load_backups(self) -> None: """Load data of stored backup files.""" backups = await self.hass.async_add_executor_job(self._read_backups) - LOGGER.debug("Loaded %s backups", len(backups)) + LOGGER.debug("Loaded %s local backups", len(backups)) self.backups = backups self.loaded_backups = True diff --git a/homeassistant/components/backup/models.py b/homeassistant/components/backup/models.py new file mode 100644 index 00000000000..6f5f013e403 --- /dev/null +++ b/homeassistant/components/backup/models.py @@ -0,0 +1,28 @@ +"""Models for the backup integration.""" + +from dataclasses import asdict, dataclass +from typing import TypedDict + + +@dataclass() +class BaseBackup: + """Base backup class.""" + + date: str + slug: str + size: float + name: str + + def as_dict(self) -> dict: + """Return a dict representation of this backup.""" + return asdict(self) + + +class BackupSyncMetadata(TypedDict): + """Dictionary type for backup sync metadata.""" + + date: str # The date the backup was created + slug: str # The slug of the backup + size: float # The size of the backup (in bytes) + name: str # The name of the backup + homeassistant: str # The version of Home Assistant that created the backup diff --git a/homeassistant/components/backup/sync_agent.py b/homeassistant/components/backup/sync_agent.py new file mode 100644 index 00000000000..0da469d84a3 --- /dev/null +++ b/homeassistant/components/backup/sync_agent.py @@ -0,0 +1,73 @@ +"""Backup sync agents for the Backup integration.""" + +from __future__ import annotations + +import abc +from dataclasses import dataclass +from pathlib import Path +from typing import Any, Protocol + +from homeassistant.core import HomeAssistant + +from .models import BackupSyncMetadata, BaseBackup + + +@dataclass(slots=True) +class SyncedBackup(BaseBackup): + """Synced backup class.""" + + id: str + + +class BackupSyncAgent(abc.ABC): + """Define the format that backup sync agents can have.""" + + def __init__(self, name: str) -> None: + """Initialize the backup sync agent.""" + self.name = name + + @abc.abstractmethod + async def async_download_backup( + self, + *, + id: str, + path: Path, + **kwargs: Any, + ) -> None: + """Download a backup file. + + The `id` parameter is the ID of the synced backup that was returned in async_list_backups. + + The `path` parameter is the full file path to download the synced backup to. + """ + + @abc.abstractmethod + async def async_upload_backup( + self, + *, + path: Path, + metadata: BackupSyncMetadata, + **kwargs: Any, + ) -> None: + """Upload a backup. + + The `path` parameter is the full file path to the backup that should be synced. + + The `metadata` parameter contains metadata about the backup that should be synced. + """ + + @abc.abstractmethod + async def async_list_backups(self, **kwargs: Any) -> list[SyncedBackup]: + """List backups.""" + + +class BackupPlatformAgentProtocol(Protocol): + """Define the format that backup platforms can have.""" + + async def async_get_backup_sync_agents( + self, + *, + hass: HomeAssistant, + **kwargs: Any, + ) -> list[BackupSyncAgent]: + """Register the backup sync agent.""" diff --git a/homeassistant/components/backup/websocket.py b/homeassistant/components/backup/websocket.py index a7c61b7c66c..439e8e1a271 100644 --- a/homeassistant/components/backup/websocket.py +++ b/homeassistant/components/backup/websocket.py @@ -1,5 +1,6 @@ """Websocket commands for the Backup integration.""" +from pathlib import Path from typing import Any import voluptuous as vol @@ -14,9 +15,14 @@ from .manager import BackupProgress @callback def async_register_websocket_handlers(hass: HomeAssistant, with_hassio: bool) -> None: """Register websocket commands.""" + websocket_api.async_register_command(hass, backup_agents_download) + websocket_api.async_register_command(hass, backup_agents_info) + websocket_api.async_register_command(hass, backup_agents_list_synced_backups) + if with_hassio: websocket_api.async_register_command(hass, handle_backup_end) websocket_api.async_register_command(hass, handle_backup_start) + websocket_api.async_register_command(hass, handle_backup_sync) return websocket_api.async_register_command(hass, handle_details) @@ -40,7 +46,7 @@ async def handle_info( connection.send_result( msg["id"], { - "backups": list(backups.values()), + "backups": [b.as_dict() for b in backups.values()], "backing_up": manager.backup_task is not None, }, ) @@ -162,3 +168,105 @@ async def handle_backup_end( return connection.send_result(msg["id"]) + + +@websocket_api.ws_require_user(only_supervisor=True) +@websocket_api.websocket_command( + { + vol.Required("type"): "backup/sync", + vol.Required("data"): { + vol.Required("slug"): str, + }, + } +) +@websocket_api.async_response +async def handle_backup_sync( + hass: HomeAssistant, + connection: websocket_api.ActiveConnection, + msg: dict[str, Any], +) -> None: + """Backup sync notification.""" + LOGGER.debug("Backup sync notification") + data = msg["data"] + + try: + await hass.data[DATA_MANAGER].async_sync_backup(slug=data["slug"]) + except Exception as err: # noqa: BLE001 + connection.send_error(msg["id"], "backup_sync_failed", str(err)) + return + + connection.send_result(msg["id"]) + + +@websocket_api.require_admin +@websocket_api.websocket_command({vol.Required("type"): "backup/agents/info"}) +@websocket_api.async_response +async def backup_agents_info( + hass: HomeAssistant, + connection: websocket_api.ActiveConnection, + msg: dict[str, Any], +) -> None: + """Return backup agents info.""" + manager = hass.data[DATA_MANAGER] + await manager.load_platforms() + connection.send_result( + msg["id"], + { + "agents": [{"id": agent_id} for agent_id in manager.sync_agents], + "syncing": manager.syncing, + }, + ) + + +@websocket_api.require_admin +@websocket_api.websocket_command({vol.Required("type"): "backup/agents/synced"}) +@websocket_api.async_response +async def backup_agents_list_synced_backups( + hass: HomeAssistant, + connection: websocket_api.ActiveConnection, + msg: dict[str, Any], +) -> None: + """Return a list of synced backups.""" + manager = hass.data[DATA_MANAGER] + backups: list[dict[str, Any]] = [] + await manager.load_platforms() + for agent_id, agent in manager.sync_agents.items(): + _listed_backups = await agent.async_list_backups() + backups.extend({**b.as_dict(), "agent_id": agent_id} for b in _listed_backups) + connection.send_result(msg["id"], backups) + + +@websocket_api.require_admin +@websocket_api.websocket_command( + { + vol.Required("type"): "backup/agents/download", + vol.Required("agent"): str, + vol.Required("sync_id"): str, + vol.Required("slug"): str, + } +) +@websocket_api.async_response +async def backup_agents_download( + hass: HomeAssistant, + connection: websocket_api.ActiveConnection, + msg: dict[str, Any], +) -> None: + """Download a synced backup.""" + manager = hass.data[DATA_MANAGER] + await manager.load_platforms() + + if not (agent := manager.sync_agents.get(msg["agent"])): + connection.send_error( + msg["id"], "unknown_agent", f"Agent {msg['agent']} not found" + ) + return + try: + await agent.async_download_backup( + id=msg["sync_id"], + path=Path(hass.config.path("backup"), f"{msg['slug']}.tar"), + ) + except Exception as err: # noqa: BLE001 + connection.send_error(msg["id"], "backup_agents_download", str(err)) + return + + connection.send_result(msg["id"]) diff --git a/homeassistant/components/kitchen_sink/backup.py b/homeassistant/components/kitchen_sink/backup.py new file mode 100644 index 00000000000..18c8f0f9abf --- /dev/null +++ b/homeassistant/components/kitchen_sink/backup.py @@ -0,0 +1,74 @@ +"""Backup platform for the kitchen_sink integration.""" + +from __future__ import annotations + +import logging +from pathlib import Path +from typing import Any +from uuid import uuid4 + +from homeassistant.components.backup import ( + BackupSyncAgent, + BackupSyncMetadata, + SyncedBackup, +) +from homeassistant.core import HomeAssistant + +LOGGER = logging.getLogger(__name__) + + +async def async_get_backup_sync_agents( + hass: HomeAssistant, +) -> list[BackupSyncAgent]: + """Register the backup sync agents.""" + return [KitchenSinkBackupSyncAgent("syncer")] + + +class KitchenSinkBackupSyncAgent(BackupSyncAgent): + """Kitchen sink backup sync agent.""" + + def __init__(self, name: str) -> None: + """Initialize the kitchen sink backup sync agent.""" + super().__init__(name) + self._uploads = [ + SyncedBackup( + id="def456", + name="Kitchen sink syncer", + slug="abc123", + size=1234, + date="1970-01-01T00:00:00Z", + ) + ] + + async def async_download_backup( + self, + *, + id: str, + path: Path, + **kwargs: Any, + ) -> None: + """Download a backup file.""" + LOGGER.info("Downloading backup %s to %s", id, path) + + async def async_upload_backup( + self, + *, + path: Path, + metadata: BackupSyncMetadata, + **kwargs: Any, + ) -> None: + """Upload a backup.""" + LOGGER.info("Uploading backup %s %s", path.name, metadata) + self._uploads.append( + SyncedBackup( + id=uuid4().hex, + name=metadata["name"], + slug=metadata["slug"], + size=metadata["size"], + date=metadata["date"], + ) + ) + + async def async_list_backups(self, **kwargs: Any) -> list[SyncedBackup]: + """List synced backups.""" + return self._uploads diff --git a/tests/components/backup/common.py b/tests/components/backup/common.py index 70b33d2de3f..f15ccd14a1c 100644 --- a/tests/components/backup/common.py +++ b/tests/components/backup/common.py @@ -3,10 +3,13 @@ from __future__ import annotations from pathlib import Path +from typing import Any from unittest.mock import patch from homeassistant.components.backup import DOMAIN from homeassistant.components.backup.manager import Backup +from homeassistant.components.backup.models import BackupSyncMetadata +from homeassistant.components.backup.sync_agent import BackupSyncAgent, SyncedBackup from homeassistant.core import HomeAssistant from homeassistant.helpers.typing import ConfigType from homeassistant.setup import async_setup_component @@ -20,6 +23,40 @@ TEST_BACKUP = Backup( ) +class BackupSyncAgentTest(BackupSyncAgent): + """Test backup sync agent.""" + + async def async_download_backup( + self, + *, + id: str, + path: Path, + **kwargs: Any, + ) -> None: + """Download a backup file.""" + + async def async_upload_backup( + self, + *, + path: Path, + metadata: BackupSyncMetadata, + **kwargs: Any, + ) -> None: + """Upload a backup.""" + + async def async_list_backups(self, **kwargs: Any) -> list[SyncedBackup]: + """List synced backups.""" + return [ + SyncedBackup( + id="abc123", + name="Test", + slug="abc123", + size=13.37, + date="1970-01-01T00:00:00Z", + ) + ] + + async def setup_backup_integration( hass: HomeAssistant, with_hassio: bool = False, diff --git a/tests/components/backup/snapshots/test_websocket.ambr b/tests/components/backup/snapshots/test_websocket.ambr index 42eb524e529..34d3638e850 100644 --- a/tests/components/backup/snapshots/test_websocket.ambr +++ b/tests/components/backup/snapshots/test_websocket.ambr @@ -1,4 +1,106 @@ # serializer version: 1 +# name: test_agents_download[with_hassio] + dict({ + 'id': 1, + 'result': None, + 'success': True, + 'type': 'result', + }) +# --- +# name: test_agents_download[without_hassio] + dict({ + 'id': 1, + 'result': None, + 'success': True, + 'type': 'result', + }) +# --- +# name: test_agents_download_exception + dict({ + 'error': dict({ + 'code': 'backup_agents_download', + 'message': 'Boom', + }), + 'id': 1, + 'success': False, + 'type': 'result', + }) +# --- +# name: test_agents_download_unknown_agent + dict({ + 'error': dict({ + 'code': 'unknown_agent', + 'message': 'Agent domain.test not found', + }), + 'id': 1, + 'success': False, + 'type': 'result', + }) +# --- +# name: test_agents_info[with_hassio] + dict({ + 'id': 1, + 'result': dict({ + 'agents': list([ + dict({ + 'id': 'domain.test', + }), + ]), + 'syncing': False, + }), + 'success': True, + 'type': 'result', + }) +# --- +# name: test_agents_info[without_hassio] + dict({ + 'id': 1, + 'result': dict({ + 'agents': list([ + dict({ + 'id': 'domain.test', + }), + ]), + 'syncing': False, + }), + 'success': True, + 'type': 'result', + }) +# --- +# name: test_agents_synced[with_hassio] + dict({ + 'id': 1, + 'result': list([ + dict({ + 'agent_id': 'domain.test', + 'date': '1970-01-01T00:00:00Z', + 'id': 'abc123', + 'name': 'Test', + 'size': 13.37, + 'slug': 'abc123', + }), + ]), + 'success': True, + 'type': 'result', + }) +# --- +# name: test_agents_synced[without_hassio] + dict({ + 'id': 1, + 'result': list([ + dict({ + 'agent_id': 'domain.test', + 'date': '1970-01-01T00:00:00Z', + 'id': 'abc123', + 'name': 'Test', + 'size': 13.37, + 'slug': 'abc123', + }), + ]), + 'success': True, + 'type': 'result', + }) +# --- # name: test_backup_end[with_hassio-hass_access_token] dict({ 'error': dict({ @@ -147,6 +249,80 @@ 'type': 'result', }) # --- +# name: test_backup_sync[with_hassio-hass_access_token] + dict({ + 'error': dict({ + 'code': 'only_supervisor', + 'message': 'Only allowed as Supervisor', + }), + 'id': 1, + 'success': False, + 'type': 'result', + }) +# --- +# name: test_backup_sync[with_hassio-hass_supervisor_access_token] + dict({ + 'id': 1, + 'result': None, + 'success': True, + 'type': 'result', + }) +# --- +# name: test_backup_sync[without_hassio-hass_access_token] + dict({ + 'error': dict({ + 'code': 'unknown_command', + 'message': 'Unknown command.', + }), + 'id': 1, + 'success': False, + 'type': 'result', + }) +# --- +# name: test_backup_sync[without_hassio-hass_supervisor_access_token] + dict({ + 'error': dict({ + 'code': 'unknown_command', + 'message': 'Unknown command.', + }), + 'id': 1, + 'success': False, + 'type': 'result', + }) +# --- +# name: test_backup_sync_excepion[exception0] + dict({ + 'error': dict({ + 'code': 'backup_sync_failed', + 'message': '', + }), + 'id': 1, + 'success': False, + 'type': 'result', + }) +# --- +# name: test_backup_sync_excepion[exception1] + dict({ + 'error': dict({ + 'code': 'backup_sync_failed', + 'message': 'Boom', + }), + 'id': 1, + 'success': False, + 'type': 'result', + }) +# --- +# name: test_backup_sync_excepion[exception2] + dict({ + 'error': dict({ + 'code': 'backup_sync_failed', + 'message': 'Boom', + }), + 'id': 1, + 'success': False, + 'type': 'result', + }) +# --- # name: test_details[with_hassio-with_backup_content] dict({ 'error': dict({ diff --git a/tests/components/backup/test_manager.py b/tests/components/backup/test_manager.py index 9d24964aedf..827ee896299 100644 --- a/tests/components/backup/test_manager.py +++ b/tests/components/backup/test_manager.py @@ -3,6 +3,7 @@ from __future__ import annotations import asyncio +from typing import Any from unittest.mock import AsyncMock, MagicMock, Mock, mock_open, patch import aiohttp @@ -14,11 +15,12 @@ from homeassistant.components.backup.manager import ( BackupPlatformProtocol, BackupProgress, ) +from homeassistant.components.backup.sync_agent import BackupPlatformAgentProtocol from homeassistant.core import HomeAssistant from homeassistant.exceptions import HomeAssistantError from homeassistant.setup import async_setup_component -from .common import TEST_BACKUP +from .common import TEST_BACKUP, BackupSyncAgentTest from tests.common import MockPlatform, mock_platform @@ -39,7 +41,7 @@ async def _mock_backup_generation( assert manager.backup_task is not None assert progress == [] - await manager.backup_task + backup = await manager.backup_task assert progress == [BackupProgress(done=True, stage=None, success=True)] assert mocked_json_bytes.call_count == 1 @@ -48,10 +50,12 @@ async def _mock_backup_generation( assert backup_json_dict["homeassistant"] == {"version": "2025.1.0"} assert manager.backup_dir.as_posix() in str(mocked_tarfile.call_args_list[0][0][0]) + return backup + async def _setup_mock_domain( hass: HomeAssistant, - platform: BackupPlatformProtocol | None = None, + platform: BackupPlatformProtocol | BackupPlatformAgentProtocol | None = None, ) -> None: """Set up a mock domain.""" mock_platform(hass, "some_domain.backup", platform or MockPlatform()) @@ -174,6 +178,7 @@ async def test_async_create_backup( assert "Generated new backup with slug " in caplog.text assert "Creating backup directory" in caplog.text assert "Loaded 0 platforms" in caplog.text + assert "Loaded 0 agents" in caplog.text async def test_loading_platforms( @@ -191,6 +196,7 @@ async def test_loading_platforms( Mock( async_pre_backup=AsyncMock(), async_post_backup=AsyncMock(), + async_get_backup_sync_agents=AsyncMock(), ), ) await manager.load_platforms() @@ -202,6 +208,34 @@ async def test_loading_platforms( assert "Loaded 1 platforms" in caplog.text +async def test_loading_sync_agents( + hass: HomeAssistant, + caplog: pytest.LogCaptureFixture, +) -> None: + """Test loading backup sync agents.""" + manager = BackupManager(hass) + + assert not manager.loaded_platforms + assert not manager.platforms + + await _setup_mock_domain( + hass, + Mock( + async_get_backup_sync_agents=AsyncMock( + return_value=[BackupSyncAgentTest("test")] + ), + ), + ) + await manager.load_platforms() + await hass.async_block_till_done() + + assert manager.loaded_platforms + assert len(manager.sync_agents) == 1 + + assert "Loaded 1 agents" in caplog.text + assert "some_domain.test" in manager.sync_agents + + async def test_not_loading_bad_platforms( hass: HomeAssistant, caplog: pytest.LogCaptureFixture, @@ -220,10 +254,151 @@ async def test_not_loading_bad_platforms( assert len(manager.platforms) == 0 assert "Loaded 0 platforms" in caplog.text - assert ( - "some_domain does not implement required functions for the backup platform" - in caplog.text + + +@pytest.mark.usefixtures("mock_backup_generation") +async def test_syncing_backup( + hass: HomeAssistant, + caplog: pytest.LogCaptureFixture, + mocked_json_bytes: Mock, + mocked_tarfile: Mock, +) -> None: + """Test syncing a backup.""" + manager = BackupManager(hass) + + await _setup_mock_domain( + hass, + Mock( + async_pre_backup=AsyncMock(), + async_post_backup=AsyncMock(), + async_get_backup_sync_agents=AsyncMock( + return_value=[ + BackupSyncAgentTest("agent1"), + BackupSyncAgentTest("agent2"), + ] + ), + ), ) + await manager.load_platforms() + await hass.async_block_till_done() + + backup = await _mock_backup_generation(manager, mocked_json_bytes, mocked_tarfile) + + with ( + patch( + "homeassistant.components.backup.manager.BackupManager.async_get_backup", + return_value=backup, + ), + patch.object(BackupSyncAgentTest, "async_upload_backup") as mocked_upload, + patch( + "homeassistant.components.backup.manager.HAVERSION", + "2025.1.0", + ), + ): + await manager.async_sync_backup(slug=backup.slug) + assert mocked_upload.call_count == 2 + first_call = mocked_upload.call_args_list[0] + assert first_call[1]["path"] == backup.path + assert first_call[1]["metadata"] == { + "date": backup.date, + "homeassistant": "2025.1.0", + "name": backup.name, + "size": backup.size, + "slug": backup.slug, + } + + assert "Error during backup sync" not in caplog.text + + +@pytest.mark.usefixtures("mock_backup_generation") +async def test_syncing_backup_with_exception( + hass: HomeAssistant, + caplog: pytest.LogCaptureFixture, + mocked_json_bytes: Mock, + mocked_tarfile: Mock, +) -> None: + """Test syncing a backup with exception.""" + manager = BackupManager(hass) + + class ModifiedBackupSyncAgentTest(BackupSyncAgentTest): + async def async_upload_backup(self, **kwargs: Any) -> None: + raise HomeAssistantError("Test exception") + + await _setup_mock_domain( + hass, + Mock( + async_pre_backup=AsyncMock(), + async_post_backup=AsyncMock(), + async_get_backup_sync_agents=AsyncMock( + return_value=[ + ModifiedBackupSyncAgentTest("agent1"), + ModifiedBackupSyncAgentTest("agent2"), + ] + ), + ), + ) + await manager.load_platforms() + await hass.async_block_till_done() + + backup = await _mock_backup_generation(manager, mocked_json_bytes, mocked_tarfile) + + with ( + patch( + "homeassistant.components.backup.manager.BackupManager.async_get_backup", + return_value=backup, + ), + patch.object( + ModifiedBackupSyncAgentTest, + "async_upload_backup", + ) as mocked_upload, + patch( + "homeassistant.components.backup.manager.HAVERSION", + "2025.1.0", + ), + ): + mocked_upload.side_effect = HomeAssistantError("Test exception") + await manager.async_sync_backup(slug=backup.slug) + assert mocked_upload.call_count == 2 + first_call = mocked_upload.call_args_list[0] + assert first_call[1]["path"] == backup.path + assert first_call[1]["metadata"] == { + "date": backup.date, + "homeassistant": "2025.1.0", + "name": backup.name, + "size": backup.size, + "slug": backup.slug, + } + + assert "Error during backup sync - Test exception" in caplog.text + + +@pytest.mark.usefixtures("mock_backup_generation") +async def test_syncing_backup_no_agents( + hass: HomeAssistant, + caplog: pytest.LogCaptureFixture, + mocked_json_bytes: Mock, + mocked_tarfile: Mock, +) -> None: + """Test syncing a backup with no agents.""" + manager = BackupManager(hass) + + await _setup_mock_domain( + hass, + Mock( + async_pre_backup=AsyncMock(), + async_post_backup=AsyncMock(), + async_get_backup_sync_agents=AsyncMock(return_value=[]), + ), + ) + await manager.load_platforms() + await hass.async_block_till_done() + + backup = await _mock_backup_generation(manager, mocked_json_bytes, mocked_tarfile) + with patch( + "homeassistant.components.backup.sync_agent.BackupSyncAgent.async_upload_backup" + ) as mocked_async_upload_backup: + await manager.async_sync_backup(slug=backup.slug) + assert mocked_async_upload_backup.call_count == 0 async def test_exception_plaform_pre( @@ -241,6 +416,7 @@ async def test_exception_plaform_pre( Mock( async_pre_backup=_mock_step, async_post_backup=AsyncMock(), + async_get_backup_sync_agents=AsyncMock(), ), ) @@ -263,6 +439,7 @@ async def test_exception_plaform_post( Mock( async_pre_backup=AsyncMock(), async_post_backup=_mock_step, + async_get_backup_sync_agents=AsyncMock(), ), ) @@ -285,6 +462,7 @@ async def test_loading_platforms_when_running_async_pre_backup_actions( Mock( async_pre_backup=AsyncMock(), async_post_backup=AsyncMock(), + async_get_backup_sync_agents=AsyncMock(), ), ) await manager.async_pre_backup_actions() @@ -310,6 +488,7 @@ async def test_loading_platforms_when_running_async_post_backup_actions( Mock( async_pre_backup=AsyncMock(), async_post_backup=AsyncMock(), + async_get_backup_sync_agents=AsyncMock(), ), ) await manager.async_post_backup_actions() diff --git a/tests/components/backup/test_websocket.py b/tests/components/backup/test_websocket.py index 3e031f172ae..beeeb7d63f7 100644 --- a/tests/components/backup/test_websocket.py +++ b/tests/components/backup/test_websocket.py @@ -1,16 +1,18 @@ """Tests for the Backup integration.""" -from unittest.mock import patch +from pathlib import Path +from unittest.mock import AsyncMock, patch from freezegun.api import FrozenDateTimeFactory import pytest from syrupy import SnapshotAssertion -from homeassistant.components.backup.manager import Backup +from homeassistant.components.backup.const import DATA_MANAGER +from homeassistant.components.backup.models import BaseBackup from homeassistant.core import HomeAssistant from homeassistant.exceptions import HomeAssistantError -from .common import TEST_BACKUP, setup_backup_integration +from .common import TEST_BACKUP, BackupSyncAgentTest, setup_backup_integration from tests.typing import WebSocketGenerator @@ -43,15 +45,23 @@ async def test_info( """Test getting backup info.""" await setup_backup_integration(hass, with_hassio=with_hassio) + hass.data[DATA_MANAGER].backups = {TEST_BACKUP.slug: TEST_BACKUP} + client = await hass_ws_client(hass) await hass.async_block_till_done() - with patch( - "homeassistant.components.backup.manager.BackupManager.async_get_backups", - return_value={TEST_BACKUP.slug: TEST_BACKUP}, + with ( + patch( + "homeassistant.components.backup.manager.BackupManager.load_backups", + AsyncMock(), + ), + patch( + "homeassistant.components.backup.manager.BackupManager.async_get_backups", + return_value={TEST_BACKUP.slug: TEST_BACKUP}, + ), ): await client.send_json_auto_id({"type": "backup/info"}) - assert snapshot == await client.receive_json() + assert await client.receive_json() == snapshot @pytest.mark.parametrize( @@ -73,7 +83,7 @@ async def test_details( hass_ws_client: WebSocketGenerator, snapshot: SnapshotAssertion, with_hassio: bool, - backup_content: Backup | None, + backup_content: BaseBackup | None, ) -> None: """Test getting backup info.""" await setup_backup_integration(hass, with_hassio=with_hassio) @@ -112,7 +122,7 @@ async def test_remove( "homeassistant.components.backup.manager.BackupManager.async_remove_backup", ): await client.send_json_auto_id({"type": "backup/remove", "slug": "abc123"}) - assert snapshot == await client.receive_json() + assert await client.receive_json() == snapshot @pytest.mark.parametrize( @@ -140,7 +150,7 @@ async def test_generate( await client.send_json_auto_id({"type": "backup/generate"}) for _ in range(number_of_messages): - assert snapshot == await client.receive_json() + assert await client.receive_json() == snapshot @pytest.mark.parametrize( @@ -199,7 +209,7 @@ async def test_backup_end( "homeassistant.components.backup.manager.BackupManager.async_post_backup_actions", ): await client.send_json_auto_id({"type": "backup/end"}) - assert snapshot == await client.receive_json() + assert await client.receive_json() == snapshot @pytest.mark.parametrize( @@ -232,7 +242,47 @@ async def test_backup_start( "homeassistant.components.backup.manager.BackupManager.async_pre_backup_actions", ): await client.send_json_auto_id({"type": "backup/start"}) - assert snapshot == await client.receive_json() + assert await client.receive_json() == snapshot + + +@pytest.mark.parametrize( + "access_token_fixture_name", + ["hass_access_token", "hass_supervisor_access_token"], +) +@pytest.mark.parametrize( + ("with_hassio"), + [ + pytest.param(True, id="with_hassio"), + pytest.param(False, id="without_hassio"), + ], +) +async def test_backup_sync( + hass: HomeAssistant, + hass_ws_client: WebSocketGenerator, + snapshot: SnapshotAssertion, + sync_access_token_proxy: str, + *, + access_token_fixture_name: str, + with_hassio: bool, +) -> None: + """Test handling of pre backup actions from a WS command.""" + await setup_backup_integration(hass, with_hassio=with_hassio) + + client = await hass_ws_client(hass, sync_access_token_proxy) + await hass.async_block_till_done() + + with patch( + "homeassistant.components.backup.manager.BackupManager.async_sync_backup", + ): + await client.send_json_auto_id( + { + "type": "backup/sync", + "data": { + "slug": "abc123", + }, + } + ) + assert await client.receive_json() == snapshot @pytest.mark.parametrize( @@ -261,7 +311,43 @@ async def test_backup_end_excepion( side_effect=exception, ): await client.send_json_auto_id({"type": "backup/end"}) - assert snapshot == await client.receive_json() + assert await client.receive_json() == snapshot + + +@pytest.mark.parametrize( + "exception", + [ + TimeoutError(), + HomeAssistantError("Boom"), + Exception("Boom"), + ], +) +async def test_backup_sync_excepion( + hass: HomeAssistant, + hass_ws_client: WebSocketGenerator, + snapshot: SnapshotAssertion, + hass_supervisor_access_token: str, + exception: Exception, +) -> None: + """Test exception handling while running sync backup action from a WS command.""" + await setup_backup_integration(hass, with_hassio=True) + + client = await hass_ws_client(hass, hass_supervisor_access_token) + await hass.async_block_till_done() + + with patch( + "homeassistant.components.backup.manager.BackupManager.async_sync_backup", + side_effect=exception, + ): + await client.send_json_auto_id( + { + "type": "backup/sync", + "data": { + "slug": "abc123", + }, + } + ) + assert await client.receive_json() == snapshot @pytest.mark.parametrize( @@ -290,4 +376,135 @@ async def test_backup_start_excepion( side_effect=exception, ): await client.send_json_auto_id({"type": "backup/start"}) - assert snapshot == await client.receive_json() + assert await client.receive_json() == snapshot + + +@pytest.mark.parametrize( + "with_hassio", + [ + pytest.param(True, id="with_hassio"), + pytest.param(False, id="without_hassio"), + ], +) +async def test_agents_info( + hass: HomeAssistant, + hass_ws_client: WebSocketGenerator, + snapshot: SnapshotAssertion, + with_hassio: bool, +) -> None: + """Test getting backup agents info.""" + await setup_backup_integration(hass, with_hassio=with_hassio) + hass.data[DATA_MANAGER].sync_agents = {"domain.test": BackupSyncAgentTest("test")} + + client = await hass_ws_client(hass) + await hass.async_block_till_done() + + await client.send_json_auto_id({"type": "backup/agents/info"}) + assert await client.receive_json() == snapshot + + +@pytest.mark.parametrize( + "with_hassio", + [ + pytest.param(True, id="with_hassio"), + pytest.param(False, id="without_hassio"), + ], +) +async def test_agents_synced( + hass: HomeAssistant, + hass_ws_client: WebSocketGenerator, + snapshot: SnapshotAssertion, + with_hassio: bool, +) -> None: + """Test getting backup agents synced details.""" + await setup_backup_integration(hass, with_hassio=with_hassio) + hass.data[DATA_MANAGER].sync_agents = {"domain.test": BackupSyncAgentTest("test")} + + client = await hass_ws_client(hass) + await hass.async_block_till_done() + + await client.send_json_auto_id({"type": "backup/agents/synced"}) + assert await client.receive_json() == snapshot + + +@pytest.mark.parametrize( + "with_hassio", + [ + pytest.param(True, id="with_hassio"), + pytest.param(False, id="without_hassio"), + ], +) +async def test_agents_download( + hass: HomeAssistant, + hass_ws_client: WebSocketGenerator, + snapshot: SnapshotAssertion, + with_hassio: bool, +) -> None: + """Test WS command to start downloading a synced backup.""" + await setup_backup_integration(hass, with_hassio=with_hassio) + hass.data[DATA_MANAGER].sync_agents = {"domain.test": BackupSyncAgentTest("test")} + + client = await hass_ws_client(hass) + await hass.async_block_till_done() + + await client.send_json_auto_id( + { + "type": "backup/agents/download", + "slug": "abc123", + "agent": "domain.test", + "sync_id": "abc123", + } + ) + with patch.object(BackupSyncAgentTest, "async_download_backup") as download_mock: + assert await client.receive_json() == snapshot + assert download_mock.call_args[1] == { + "id": "abc123", + "path": Path(hass.config.path("backup"), "abc123.tar"), + } + + +async def test_agents_download_exception( + hass: HomeAssistant, + hass_ws_client: WebSocketGenerator, + snapshot: SnapshotAssertion, +) -> None: + """Test WS command to start downloading a synced backup throwing an exception.""" + await setup_backup_integration(hass) + hass.data[DATA_MANAGER].sync_agents = {"domain.test": BackupSyncAgentTest("test")} + + client = await hass_ws_client(hass) + await hass.async_block_till_done() + + await client.send_json_auto_id( + { + "type": "backup/agents/download", + "slug": "abc123", + "agent": "domain.test", + "sync_id": "abc123", + } + ) + with patch.object(BackupSyncAgentTest, "async_download_backup") as download_mock: + download_mock.side_effect = Exception("Boom") + assert await client.receive_json() == snapshot + + +async def test_agents_download_unknown_agent( + hass: HomeAssistant, + hass_ws_client: WebSocketGenerator, + snapshot: SnapshotAssertion, +) -> None: + """Test downloading a synced backup with an unknown agent.""" + await setup_backup_integration(hass) + + client = await hass_ws_client(hass) + await hass.async_block_till_done() + + await client.send_json_auto_id( + { + "type": "backup/agents/download", + "slug": "abc123", + "agent": "domain.test", + "sync_id": "abc123", + } + ) + assert await client.receive_json() == snapshot From 957ece747d38bd9cb5baf67522bddf398ce8c422 Mon Sep 17 00:00:00 2001 From: Martin Hjelmare Date: Wed, 13 Nov 2024 21:11:25 +0100 Subject: [PATCH 2/9] Make BackupSyncMetadata model a dataclass (#130555) Make backup BackupSyncMetadata model a dataclass --- homeassistant/components/backup/manager.py | 16 +++++----- homeassistant/components/backup/models.py | 6 ++-- .../components/kitchen_sink/backup.py | 8 ++--- tests/components/backup/test_manager.py | 30 +++++++++---------- 4 files changed, 30 insertions(+), 30 deletions(-) diff --git a/homeassistant/components/backup/manager.py b/homeassistant/components/backup/manager.py index 70f29679cdc..f20bc1b8372 100644 --- a/homeassistant/components/backup/manager.py +++ b/homeassistant/components/backup/manager.py @@ -32,7 +32,7 @@ from homeassistant.util import dt as dt_util from homeassistant.util.json import json_loads_object from .const import DOMAIN, EXCLUDE_FROM_BACKUP, LOGGER -from .models import BaseBackup +from .models import BackupSyncMetadata, BaseBackup from .sync_agent import BackupPlatformAgentProtocol, BackupSyncAgent BUF_SIZE = 2**20 * 4 # 4MB @@ -238,13 +238,13 @@ class BackupManager(BaseBackupManager[Backup]): *( agent.async_upload_backup( path=backup.path, - metadata={ - "homeassistant": HAVERSION, - "size": backup.size, - "date": backup.date, - "slug": backup.slug, - "name": backup.name, - }, + metadata=BackupSyncMetadata( + homeassistant=HAVERSION, + size=backup.size, + date=backup.date, + slug=backup.slug, + name=backup.name, + ), ) for agent in self.sync_agents.values() ), diff --git a/homeassistant/components/backup/models.py b/homeassistant/components/backup/models.py index 6f5f013e403..2eb720847bb 100644 --- a/homeassistant/components/backup/models.py +++ b/homeassistant/components/backup/models.py @@ -1,7 +1,6 @@ """Models for the backup integration.""" from dataclasses import asdict, dataclass -from typing import TypedDict @dataclass() @@ -18,8 +17,9 @@ class BaseBackup: return asdict(self) -class BackupSyncMetadata(TypedDict): - """Dictionary type for backup sync metadata.""" +@dataclass() +class BackupSyncMetadata: + """Backup sync metadata.""" date: str # The date the backup was created slug: str # The slug of the backup diff --git a/homeassistant/components/kitchen_sink/backup.py b/homeassistant/components/kitchen_sink/backup.py index 18c8f0f9abf..7140ae3099d 100644 --- a/homeassistant/components/kitchen_sink/backup.py +++ b/homeassistant/components/kitchen_sink/backup.py @@ -62,10 +62,10 @@ class KitchenSinkBackupSyncAgent(BackupSyncAgent): self._uploads.append( SyncedBackup( id=uuid4().hex, - name=metadata["name"], - slug=metadata["slug"], - size=metadata["size"], - date=metadata["date"], + name=metadata.name, + slug=metadata.slug, + size=metadata.size, + date=metadata.date, ) ) diff --git a/tests/components/backup/test_manager.py b/tests/components/backup/test_manager.py index 827ee896299..7b5f97f2cc3 100644 --- a/tests/components/backup/test_manager.py +++ b/tests/components/backup/test_manager.py @@ -10,7 +10,7 @@ import aiohttp from multidict import CIMultiDict, CIMultiDictProxy import pytest -from homeassistant.components.backup import BackupManager +from homeassistant.components.backup import BackupManager, BackupSyncMetadata from homeassistant.components.backup.manager import ( BackupPlatformProtocol, BackupProgress, @@ -299,13 +299,13 @@ async def test_syncing_backup( assert mocked_upload.call_count == 2 first_call = mocked_upload.call_args_list[0] assert first_call[1]["path"] == backup.path - assert first_call[1]["metadata"] == { - "date": backup.date, - "homeassistant": "2025.1.0", - "name": backup.name, - "size": backup.size, - "slug": backup.slug, - } + assert first_call[1]["metadata"] == BackupSyncMetadata( + date=backup.date, + homeassistant="2025.1.0", + name=backup.name, + size=backup.size, + slug=backup.slug, + ) assert "Error during backup sync" not in caplog.text @@ -361,13 +361,13 @@ async def test_syncing_backup_with_exception( assert mocked_upload.call_count == 2 first_call = mocked_upload.call_args_list[0] assert first_call[1]["path"] == backup.path - assert first_call[1]["metadata"] == { - "date": backup.date, - "homeassistant": "2025.1.0", - "name": backup.name, - "size": backup.size, - "slug": backup.slug, - } + assert first_call[1]["metadata"] == BackupSyncMetadata( + date=backup.date, + homeassistant="2025.1.0", + name=backup.name, + size=backup.size, + slug=backup.slug, + ) assert "Error during backup sync - Test exception" in caplog.text From f99b31904824d6455afe79a98d61284b2c512075 Mon Sep 17 00:00:00 2001 From: Martin Hjelmare Date: Thu, 14 Nov 2024 02:00:49 +0100 Subject: [PATCH 3/9] Rename backup sync agent to backup agent (#130575) * Rename sync agent module to agent * Rename BackupSyncAgent to BackupAgent * Fix test typo * Rename async_get_backup_sync_agents to async_get_backup_agents * Rename and clean up remaining sync things * Update kitchen sink * Apply suggestions from code review * Update test_manager.py --------- Co-authored-by: Erik Montnemery --- homeassistant/components/backup/__init__.py | 10 ++-- .../backup/{sync_agent.py => agent.py} | 34 +++++------ homeassistant/components/backup/manager.py | 32 +++++----- homeassistant/components/backup/models.py | 4 +- homeassistant/components/backup/websocket.py | 34 +++++------ .../components/kitchen_sink/backup.py | 24 ++++---- tests/components/backup/common.py | 16 ++--- .../backup/snapshots/test_websocket.ambr | 36 +++++------ tests/components/backup/test_manager.py | 60 +++++++++---------- tests/components/backup/test_websocket.py | 52 ++++++++-------- 10 files changed, 150 insertions(+), 152 deletions(-) rename homeassistant/components/backup/{sync_agent.py => agent.py} (58%) diff --git a/homeassistant/components/backup/__init__.py b/homeassistant/components/backup/__init__.py index c7e8df88bd1..b479f33422d 100644 --- a/homeassistant/components/backup/__init__.py +++ b/homeassistant/components/backup/__init__.py @@ -5,17 +5,17 @@ from homeassistant.helpers import config_validation as cv from homeassistant.helpers.hassio import is_hassio from homeassistant.helpers.typing import ConfigType +from .agent import BackupAgent, UploadedBackup from .const import DOMAIN, LOGGER from .http import async_register_http_views from .manager import BackupManager -from .models import BackupSyncMetadata -from .sync_agent import BackupSyncAgent, SyncedBackup +from .models import BackupUploadMetadata from .websocket import async_register_websocket_handlers __all__ = [ - "BackupSyncAgent", - "BackupSyncMetadata", - "SyncedBackup", + "BackupAgent", + "BackupUploadMetadata", + "UploadedBackup", ] CONFIG_SCHEMA = cv.empty_config_schema(DOMAIN) diff --git a/homeassistant/components/backup/sync_agent.py b/homeassistant/components/backup/agent.py similarity index 58% rename from homeassistant/components/backup/sync_agent.py rename to homeassistant/components/backup/agent.py index 0da469d84a3..ee636b244cd 100644 --- a/homeassistant/components/backup/sync_agent.py +++ b/homeassistant/components/backup/agent.py @@ -1,4 +1,4 @@ -"""Backup sync agents for the Backup integration.""" +"""Backup agents for the Backup integration.""" from __future__ import annotations @@ -9,21 +9,21 @@ from typing import Any, Protocol from homeassistant.core import HomeAssistant -from .models import BackupSyncMetadata, BaseBackup +from .models import BackupUploadMetadata, BaseBackup @dataclass(slots=True) -class SyncedBackup(BaseBackup): - """Synced backup class.""" +class UploadedBackup(BaseBackup): + """Uploaded backup class.""" id: str -class BackupSyncAgent(abc.ABC): - """Define the format that backup sync agents can have.""" +class BackupAgent(abc.ABC): + """Define the format that backup agents can have.""" def __init__(self, name: str) -> None: - """Initialize the backup sync agent.""" + """Initialize the backup agent.""" self.name = name @abc.abstractmethod @@ -36,9 +36,9 @@ class BackupSyncAgent(abc.ABC): ) -> None: """Download a backup file. - The `id` parameter is the ID of the synced backup that was returned in async_list_backups. + The `id` parameter is the ID of the backup that was returned in async_list_backups. - The `path` parameter is the full file path to download the synced backup to. + The `path` parameter is the full file path to download the backup to. """ @abc.abstractmethod @@ -46,28 +46,28 @@ class BackupSyncAgent(abc.ABC): self, *, path: Path, - metadata: BackupSyncMetadata, + metadata: BackupUploadMetadata, **kwargs: Any, ) -> None: """Upload a backup. - The `path` parameter is the full file path to the backup that should be synced. + The `path` parameter is the full file path to the backup that should be uploaded. - The `metadata` parameter contains metadata about the backup that should be synced. + The `metadata` parameter contains metadata about the backup that should be uploaded. """ @abc.abstractmethod - async def async_list_backups(self, **kwargs: Any) -> list[SyncedBackup]: + async def async_list_backups(self, **kwargs: Any) -> list[UploadedBackup]: """List backups.""" -class BackupPlatformAgentProtocol(Protocol): +class BackupAgentPlatformProtocol(Protocol): """Define the format that backup platforms can have.""" - async def async_get_backup_sync_agents( + async def async_get_backup_agents( self, *, hass: HomeAssistant, **kwargs: Any, - ) -> list[BackupSyncAgent]: - """Register the backup sync agent.""" + ) -> list[BackupAgent]: + """Register the backup agent.""" diff --git a/homeassistant/components/backup/manager.py b/homeassistant/components/backup/manager.py index f20bc1b8372..c0c033cd1fe 100644 --- a/homeassistant/components/backup/manager.py +++ b/homeassistant/components/backup/manager.py @@ -31,9 +31,9 @@ from homeassistant.helpers.json import json_bytes from homeassistant.util import dt as dt_util from homeassistant.util.json import json_loads_object +from .agent import BackupAgent, BackupAgentPlatformProtocol from .const import DOMAIN, EXCLUDE_FROM_BACKUP, LOGGER -from .models import BackupSyncMetadata, BaseBackup -from .sync_agent import BackupPlatformAgentProtocol, BackupSyncAgent +from .models import BackupUploadMetadata, BaseBackup BUF_SIZE = 2**20 * 4 # 4MB @@ -87,7 +87,7 @@ class BaseBackupManager(abc.ABC, Generic[_BackupT]): self.backups: dict[str, _BackupT] = {} self.loaded_platforms = False self.platforms: dict[str, BackupPlatformProtocol] = {} - self.sync_agents: dict[str, BackupSyncAgent] = {} + self.backup_agents: dict[str, BackupAgent] = {} self.syncing = False @callback @@ -109,14 +109,14 @@ class BaseBackupManager(abc.ABC, Generic[_BackupT]): self, hass: HomeAssistant, integration_domain: str, - platform: BackupPlatformAgentProtocol, + platform: BackupAgentPlatformProtocol, ) -> None: """Add a platform to the backup manager.""" - if not hasattr(platform, "async_get_backup_sync_agents"): + if not hasattr(platform, "async_get_backup_agents"): return - agents = await platform.async_get_backup_sync_agents(hass=hass) - self.sync_agents.update( + agents = await platform.async_get_backup_agents(hass=hass) + self.backup_agents.update( {f"{integration_domain}.{agent.name}": agent for agent in agents} ) @@ -169,7 +169,7 @@ class BaseBackupManager(abc.ABC, Generic[_BackupT]): wait_for_platforms=True, ) LOGGER.debug("Loaded %s platforms", len(self.platforms)) - LOGGER.debug("Loaded %s agents", len(self.sync_agents)) + LOGGER.debug("Loaded %s agents", len(self.backup_agents)) self.loaded_platforms = True @abc.abstractmethod @@ -210,8 +210,8 @@ class BaseBackupManager(abc.ABC, Generic[_BackupT]): """Receive and store a backup file from upload.""" @abc.abstractmethod - async def async_sync_backup(self, *, slug: str, **kwargs: Any) -> None: - """Sync a backup.""" + async def async_upload_backup(self, *, slug: str, **kwargs: Any) -> None: + """Upload a backup.""" class BackupManager(BaseBackupManager[Backup]): @@ -223,11 +223,11 @@ class BackupManager(BaseBackupManager[Backup]): self.backup_dir = Path(hass.config.path("backups")) self.loaded_backups = False - async def async_sync_backup(self, *, slug: str, **kwargs: Any) -> None: - """Sync a backup.""" + async def async_upload_backup(self, *, slug: str, **kwargs: Any) -> None: + """Upload a backup.""" await self.load_platforms() - if not self.sync_agents: + if not self.backup_agents: return if not (backup := await self.async_get_backup(slug=slug)): @@ -238,7 +238,7 @@ class BackupManager(BaseBackupManager[Backup]): *( agent.async_upload_backup( path=backup.path, - metadata=BackupSyncMetadata( + metadata=BackupUploadMetadata( homeassistant=HAVERSION, size=backup.size, date=backup.date, @@ -246,13 +246,13 @@ class BackupManager(BaseBackupManager[Backup]): name=backup.name, ), ) - for agent in self.sync_agents.values() + for agent in self.backup_agents.values() ), return_exceptions=True, ) for result in sync_backup_results: if isinstance(result, Exception): - LOGGER.error("Error during backup sync - %s", result) + LOGGER.error("Error during backup upload - %s", result) self.syncing = False async def load_backups(self) -> None: diff --git a/homeassistant/components/backup/models.py b/homeassistant/components/backup/models.py index 2eb720847bb..1007a233923 100644 --- a/homeassistant/components/backup/models.py +++ b/homeassistant/components/backup/models.py @@ -18,8 +18,8 @@ class BaseBackup: @dataclass() -class BackupSyncMetadata: - """Backup sync metadata.""" +class BackupUploadMetadata: + """Backup upload metadata.""" date: str # The date the backup was created slug: str # The slug of the backup diff --git a/homeassistant/components/backup/websocket.py b/homeassistant/components/backup/websocket.py index 439e8e1a271..876f6c2bff5 100644 --- a/homeassistant/components/backup/websocket.py +++ b/homeassistant/components/backup/websocket.py @@ -17,12 +17,12 @@ def async_register_websocket_handlers(hass: HomeAssistant, with_hassio: bool) -> """Register websocket commands.""" websocket_api.async_register_command(hass, backup_agents_download) websocket_api.async_register_command(hass, backup_agents_info) - websocket_api.async_register_command(hass, backup_agents_list_synced_backups) + websocket_api.async_register_command(hass, backup_agents_list_backups) if with_hassio: websocket_api.async_register_command(hass, handle_backup_end) websocket_api.async_register_command(hass, handle_backup_start) - websocket_api.async_register_command(hass, handle_backup_sync) + websocket_api.async_register_command(hass, handle_backup_upload) return websocket_api.async_register_command(hass, handle_details) @@ -173,26 +173,26 @@ async def handle_backup_end( @websocket_api.ws_require_user(only_supervisor=True) @websocket_api.websocket_command( { - vol.Required("type"): "backup/sync", + vol.Required("type"): "backup/upload", vol.Required("data"): { vol.Required("slug"): str, }, } ) @websocket_api.async_response -async def handle_backup_sync( +async def handle_backup_upload( hass: HomeAssistant, connection: websocket_api.ActiveConnection, msg: dict[str, Any], ) -> None: - """Backup sync notification.""" - LOGGER.debug("Backup sync notification") + """Backup upload.""" + LOGGER.debug("Backup upload notification") data = msg["data"] try: - await hass.data[DATA_MANAGER].async_sync_backup(slug=data["slug"]) + await hass.data[DATA_MANAGER].async_upload_backup(slug=data["slug"]) except Exception as err: # noqa: BLE001 - connection.send_error(msg["id"], "backup_sync_failed", str(err)) + connection.send_error(msg["id"], "backup_upload_failed", str(err)) return connection.send_result(msg["id"]) @@ -212,25 +212,25 @@ async def backup_agents_info( connection.send_result( msg["id"], { - "agents": [{"id": agent_id} for agent_id in manager.sync_agents], + "agents": [{"id": agent_id} for agent_id in manager.backup_agents], "syncing": manager.syncing, }, ) @websocket_api.require_admin -@websocket_api.websocket_command({vol.Required("type"): "backup/agents/synced"}) +@websocket_api.websocket_command({vol.Required("type"): "backup/agents/list_backups"}) @websocket_api.async_response -async def backup_agents_list_synced_backups( +async def backup_agents_list_backups( hass: HomeAssistant, connection: websocket_api.ActiveConnection, msg: dict[str, Any], ) -> None: - """Return a list of synced backups.""" + """Return a list of uploaded backups.""" manager = hass.data[DATA_MANAGER] backups: list[dict[str, Any]] = [] await manager.load_platforms() - for agent_id, agent in manager.sync_agents.items(): + for agent_id, agent in manager.backup_agents.items(): _listed_backups = await agent.async_list_backups() backups.extend({**b.as_dict(), "agent_id": agent_id} for b in _listed_backups) connection.send_result(msg["id"], backups) @@ -241,7 +241,7 @@ async def backup_agents_list_synced_backups( { vol.Required("type"): "backup/agents/download", vol.Required("agent"): str, - vol.Required("sync_id"): str, + vol.Required("backup_id"): str, vol.Required("slug"): str, } ) @@ -251,18 +251,18 @@ async def backup_agents_download( connection: websocket_api.ActiveConnection, msg: dict[str, Any], ) -> None: - """Download a synced backup.""" + """Download an uploaded backup.""" manager = hass.data[DATA_MANAGER] await manager.load_platforms() - if not (agent := manager.sync_agents.get(msg["agent"])): + if not (agent := manager.backup_agents.get(msg["agent"])): connection.send_error( msg["id"], "unknown_agent", f"Agent {msg['agent']} not found" ) return try: await agent.async_download_backup( - id=msg["sync_id"], + id=msg["backup_id"], path=Path(hass.config.path("backup"), f"{msg['slug']}.tar"), ) except Exception as err: # noqa: BLE001 diff --git a/homeassistant/components/kitchen_sink/backup.py b/homeassistant/components/kitchen_sink/backup.py index 7140ae3099d..92d1859dbe6 100644 --- a/homeassistant/components/kitchen_sink/backup.py +++ b/homeassistant/components/kitchen_sink/backup.py @@ -8,9 +8,9 @@ from typing import Any from uuid import uuid4 from homeassistant.components.backup import ( - BackupSyncAgent, - BackupSyncMetadata, - SyncedBackup, + BackupAgent, + BackupUploadMetadata, + UploadedBackup, ) from homeassistant.core import HomeAssistant @@ -19,19 +19,19 @@ LOGGER = logging.getLogger(__name__) async def async_get_backup_sync_agents( hass: HomeAssistant, -) -> list[BackupSyncAgent]: - """Register the backup sync agents.""" - return [KitchenSinkBackupSyncAgent("syncer")] +) -> list[BackupAgent]: + """Register the backup agents.""" + return [KitchenSinkBackupAgent("syncer")] -class KitchenSinkBackupSyncAgent(BackupSyncAgent): - """Kitchen sink backup sync agent.""" +class KitchenSinkBackupAgent(BackupAgent): + """Kitchen sink backup agent.""" def __init__(self, name: str) -> None: """Initialize the kitchen sink backup sync agent.""" super().__init__(name) self._uploads = [ - SyncedBackup( + UploadedBackup( id="def456", name="Kitchen sink syncer", slug="abc123", @@ -54,13 +54,13 @@ class KitchenSinkBackupSyncAgent(BackupSyncAgent): self, *, path: Path, - metadata: BackupSyncMetadata, + metadata: BackupUploadMetadata, **kwargs: Any, ) -> None: """Upload a backup.""" LOGGER.info("Uploading backup %s %s", path.name, metadata) self._uploads.append( - SyncedBackup( + UploadedBackup( id=uuid4().hex, name=metadata.name, slug=metadata.slug, @@ -69,6 +69,6 @@ class KitchenSinkBackupSyncAgent(BackupSyncAgent): ) ) - async def async_list_backups(self, **kwargs: Any) -> list[SyncedBackup]: + async def async_list_backups(self, **kwargs: Any) -> list[UploadedBackup]: """List synced backups.""" return self._uploads diff --git a/tests/components/backup/common.py b/tests/components/backup/common.py index f15ccd14a1c..2af5c76236f 100644 --- a/tests/components/backup/common.py +++ b/tests/components/backup/common.py @@ -7,9 +7,9 @@ from typing import Any from unittest.mock import patch from homeassistant.components.backup import DOMAIN +from homeassistant.components.backup.agent import BackupAgent, UploadedBackup from homeassistant.components.backup.manager import Backup -from homeassistant.components.backup.models import BackupSyncMetadata -from homeassistant.components.backup.sync_agent import BackupSyncAgent, SyncedBackup +from homeassistant.components.backup.models import BackupUploadMetadata from homeassistant.core import HomeAssistant from homeassistant.helpers.typing import ConfigType from homeassistant.setup import async_setup_component @@ -23,8 +23,8 @@ TEST_BACKUP = Backup( ) -class BackupSyncAgentTest(BackupSyncAgent): - """Test backup sync agent.""" +class BackupAgentTest(BackupAgent): + """Test backup agent.""" async def async_download_backup( self, @@ -39,15 +39,15 @@ class BackupSyncAgentTest(BackupSyncAgent): self, *, path: Path, - metadata: BackupSyncMetadata, + metadata: BackupUploadMetadata, **kwargs: Any, ) -> None: """Upload a backup.""" - async def async_list_backups(self, **kwargs: Any) -> list[SyncedBackup]: - """List synced backups.""" + async def async_list_backups(self, **kwargs: Any) -> list[UploadedBackup]: + """List backups.""" return [ - SyncedBackup( + UploadedBackup( id="abc123", name="Test", slug="abc123", diff --git a/tests/components/backup/snapshots/test_websocket.ambr b/tests/components/backup/snapshots/test_websocket.ambr index 34d3638e850..9edd1216203 100644 --- a/tests/components/backup/snapshots/test_websocket.ambr +++ b/tests/components/backup/snapshots/test_websocket.ambr @@ -67,7 +67,7 @@ 'type': 'result', }) # --- -# name: test_agents_synced[with_hassio] +# name: test_agents_list_backups[with_hassio] dict({ 'id': 1, 'result': list([ @@ -84,7 +84,7 @@ 'type': 'result', }) # --- -# name: test_agents_synced[without_hassio] +# name: test_agents_list_backups[without_hassio] dict({ 'id': 1, 'result': list([ @@ -142,7 +142,7 @@ 'type': 'result', }) # --- -# name: test_backup_end_excepion[exception0] +# name: test_backup_end_exception[exception0] dict({ 'error': dict({ 'code': 'post_backup_actions_failed', @@ -153,7 +153,7 @@ 'type': 'result', }) # --- -# name: test_backup_end_excepion[exception1] +# name: test_backup_end_exception[exception1] dict({ 'error': dict({ 'code': 'post_backup_actions_failed', @@ -164,7 +164,7 @@ 'type': 'result', }) # --- -# name: test_backup_end_excepion[exception2] +# name: test_backup_end_exception[exception2] dict({ 'error': dict({ 'code': 'post_backup_actions_failed', @@ -216,7 +216,7 @@ 'type': 'result', }) # --- -# name: test_backup_start_excepion[exception0] +# name: test_backup_start_exception[exception0] dict({ 'error': dict({ 'code': 'pre_backup_actions_failed', @@ -227,7 +227,7 @@ 'type': 'result', }) # --- -# name: test_backup_start_excepion[exception1] +# name: test_backup_start_exception[exception1] dict({ 'error': dict({ 'code': 'pre_backup_actions_failed', @@ -238,7 +238,7 @@ 'type': 'result', }) # --- -# name: test_backup_start_excepion[exception2] +# name: test_backup_start_exception[exception2] dict({ 'error': dict({ 'code': 'pre_backup_actions_failed', @@ -249,7 +249,7 @@ 'type': 'result', }) # --- -# name: test_backup_sync[with_hassio-hass_access_token] +# name: test_backup_upload[with_hassio-hass_access_token] dict({ 'error': dict({ 'code': 'only_supervisor', @@ -260,7 +260,7 @@ 'type': 'result', }) # --- -# name: test_backup_sync[with_hassio-hass_supervisor_access_token] +# name: test_backup_upload[with_hassio-hass_supervisor_access_token] dict({ 'id': 1, 'result': None, @@ -268,7 +268,7 @@ 'type': 'result', }) # --- -# name: test_backup_sync[without_hassio-hass_access_token] +# name: test_backup_upload[without_hassio-hass_access_token] dict({ 'error': dict({ 'code': 'unknown_command', @@ -279,7 +279,7 @@ 'type': 'result', }) # --- -# name: test_backup_sync[without_hassio-hass_supervisor_access_token] +# name: test_backup_upload[without_hassio-hass_supervisor_access_token] dict({ 'error': dict({ 'code': 'unknown_command', @@ -290,10 +290,10 @@ 'type': 'result', }) # --- -# name: test_backup_sync_excepion[exception0] +# name: test_backup_upload_exception[exception0] dict({ 'error': dict({ - 'code': 'backup_sync_failed', + 'code': 'backup_upload_failed', 'message': '', }), 'id': 1, @@ -301,10 +301,10 @@ 'type': 'result', }) # --- -# name: test_backup_sync_excepion[exception1] +# name: test_backup_upload_exception[exception1] dict({ 'error': dict({ - 'code': 'backup_sync_failed', + 'code': 'backup_upload_failed', 'message': 'Boom', }), 'id': 1, @@ -312,10 +312,10 @@ 'type': 'result', }) # --- -# name: test_backup_sync_excepion[exception2] +# name: test_backup_upload_exception[exception2] dict({ 'error': dict({ - 'code': 'backup_sync_failed', + 'code': 'backup_upload_failed', 'message': 'Boom', }), 'id': 1, diff --git a/tests/components/backup/test_manager.py b/tests/components/backup/test_manager.py index 7b5f97f2cc3..9cc0067cf1a 100644 --- a/tests/components/backup/test_manager.py +++ b/tests/components/backup/test_manager.py @@ -10,17 +10,17 @@ import aiohttp from multidict import CIMultiDict, CIMultiDictProxy import pytest -from homeassistant.components.backup import BackupManager, BackupSyncMetadata +from homeassistant.components.backup import BackupManager, BackupUploadMetadata +from homeassistant.components.backup.agent import BackupAgentPlatformProtocol from homeassistant.components.backup.manager import ( BackupPlatformProtocol, BackupProgress, ) -from homeassistant.components.backup.sync_agent import BackupPlatformAgentProtocol from homeassistant.core import HomeAssistant from homeassistant.exceptions import HomeAssistantError from homeassistant.setup import async_setup_component -from .common import TEST_BACKUP, BackupSyncAgentTest +from .common import TEST_BACKUP, BackupAgentTest from tests.common import MockPlatform, mock_platform @@ -55,7 +55,7 @@ async def _mock_backup_generation( async def _setup_mock_domain( hass: HomeAssistant, - platform: BackupPlatformProtocol | BackupPlatformAgentProtocol | None = None, + platform: BackupPlatformProtocol | BackupAgentPlatformProtocol | None = None, ) -> None: """Set up a mock domain.""" mock_platform(hass, "some_domain.backup", platform or MockPlatform()) @@ -196,7 +196,7 @@ async def test_loading_platforms( Mock( async_pre_backup=AsyncMock(), async_post_backup=AsyncMock(), - async_get_backup_sync_agents=AsyncMock(), + async_get_backup_agents=AsyncMock(), ), ) await manager.load_platforms() @@ -208,11 +208,11 @@ async def test_loading_platforms( assert "Loaded 1 platforms" in caplog.text -async def test_loading_sync_agents( +async def test_loading_agents( hass: HomeAssistant, caplog: pytest.LogCaptureFixture, ) -> None: - """Test loading backup sync agents.""" + """Test loading backup agents.""" manager = BackupManager(hass) assert not manager.loaded_platforms @@ -221,19 +221,17 @@ async def test_loading_sync_agents( await _setup_mock_domain( hass, Mock( - async_get_backup_sync_agents=AsyncMock( - return_value=[BackupSyncAgentTest("test")] - ), + async_get_backup_agents=AsyncMock(return_value=[BackupAgentTest("test")]), ), ) await manager.load_platforms() await hass.async_block_till_done() assert manager.loaded_platforms - assert len(manager.sync_agents) == 1 + assert len(manager.backup_agents) == 1 assert "Loaded 1 agents" in caplog.text - assert "some_domain.test" in manager.sync_agents + assert "some_domain.test" in manager.backup_agents async def test_not_loading_bad_platforms( @@ -271,10 +269,10 @@ async def test_syncing_backup( Mock( async_pre_backup=AsyncMock(), async_post_backup=AsyncMock(), - async_get_backup_sync_agents=AsyncMock( + async_get_backup_agents=AsyncMock( return_value=[ - BackupSyncAgentTest("agent1"), - BackupSyncAgentTest("agent2"), + BackupAgentTest("agent1"), + BackupAgentTest("agent2"), ] ), ), @@ -289,17 +287,17 @@ async def test_syncing_backup( "homeassistant.components.backup.manager.BackupManager.async_get_backup", return_value=backup, ), - patch.object(BackupSyncAgentTest, "async_upload_backup") as mocked_upload, + patch.object(BackupAgentTest, "async_upload_backup") as mocked_upload, patch( "homeassistant.components.backup.manager.HAVERSION", "2025.1.0", ), ): - await manager.async_sync_backup(slug=backup.slug) + await manager.async_upload_backup(slug=backup.slug) assert mocked_upload.call_count == 2 first_call = mocked_upload.call_args_list[0] assert first_call[1]["path"] == backup.path - assert first_call[1]["metadata"] == BackupSyncMetadata( + assert first_call[1]["metadata"] == BackupUploadMetadata( date=backup.date, homeassistant="2025.1.0", name=backup.name, @@ -307,7 +305,7 @@ async def test_syncing_backup( slug=backup.slug, ) - assert "Error during backup sync" not in caplog.text + assert "Error during backup upload" not in caplog.text @pytest.mark.usefixtures("mock_backup_generation") @@ -320,7 +318,7 @@ async def test_syncing_backup_with_exception( """Test syncing a backup with exception.""" manager = BackupManager(hass) - class ModifiedBackupSyncAgentTest(BackupSyncAgentTest): + class ModifiedBackupSyncAgentTest(BackupAgentTest): async def async_upload_backup(self, **kwargs: Any) -> None: raise HomeAssistantError("Test exception") @@ -329,7 +327,7 @@ async def test_syncing_backup_with_exception( Mock( async_pre_backup=AsyncMock(), async_post_backup=AsyncMock(), - async_get_backup_sync_agents=AsyncMock( + async_get_backup_agents=AsyncMock( return_value=[ ModifiedBackupSyncAgentTest("agent1"), ModifiedBackupSyncAgentTest("agent2"), @@ -357,11 +355,11 @@ async def test_syncing_backup_with_exception( ), ): mocked_upload.side_effect = HomeAssistantError("Test exception") - await manager.async_sync_backup(slug=backup.slug) + await manager.async_upload_backup(slug=backup.slug) assert mocked_upload.call_count == 2 first_call = mocked_upload.call_args_list[0] assert first_call[1]["path"] == backup.path - assert first_call[1]["metadata"] == BackupSyncMetadata( + assert first_call[1]["metadata"] == BackupUploadMetadata( date=backup.date, homeassistant="2025.1.0", name=backup.name, @@ -369,7 +367,7 @@ async def test_syncing_backup_with_exception( slug=backup.slug, ) - assert "Error during backup sync - Test exception" in caplog.text + assert "Error during backup upload - Test exception" in caplog.text @pytest.mark.usefixtures("mock_backup_generation") @@ -387,7 +385,7 @@ async def test_syncing_backup_no_agents( Mock( async_pre_backup=AsyncMock(), async_post_backup=AsyncMock(), - async_get_backup_sync_agents=AsyncMock(return_value=[]), + async_get_backup_agents=AsyncMock(return_value=[]), ), ) await manager.load_platforms() @@ -395,9 +393,9 @@ async def test_syncing_backup_no_agents( backup = await _mock_backup_generation(manager, mocked_json_bytes, mocked_tarfile) with patch( - "homeassistant.components.backup.sync_agent.BackupSyncAgent.async_upload_backup" + "homeassistant.components.backup.agent.BackupAgent.async_upload_backup" ) as mocked_async_upload_backup: - await manager.async_sync_backup(slug=backup.slug) + await manager.async_upload_backup(slug=backup.slug) assert mocked_async_upload_backup.call_count == 0 @@ -416,7 +414,7 @@ async def test_exception_plaform_pre( Mock( async_pre_backup=_mock_step, async_post_backup=AsyncMock(), - async_get_backup_sync_agents=AsyncMock(), + async_get_backup_agents=AsyncMock(), ), ) @@ -439,7 +437,7 @@ async def test_exception_plaform_post( Mock( async_pre_backup=AsyncMock(), async_post_backup=_mock_step, - async_get_backup_sync_agents=AsyncMock(), + async_get_backup_agents=AsyncMock(), ), ) @@ -462,7 +460,7 @@ async def test_loading_platforms_when_running_async_pre_backup_actions( Mock( async_pre_backup=AsyncMock(), async_post_backup=AsyncMock(), - async_get_backup_sync_agents=AsyncMock(), + async_get_backup_agents=AsyncMock(), ), ) await manager.async_pre_backup_actions() @@ -488,7 +486,7 @@ async def test_loading_platforms_when_running_async_post_backup_actions( Mock( async_pre_backup=AsyncMock(), async_post_backup=AsyncMock(), - async_get_backup_sync_agents=AsyncMock(), + async_get_backup_agents=AsyncMock(), ), ) await manager.async_post_backup_actions() diff --git a/tests/components/backup/test_websocket.py b/tests/components/backup/test_websocket.py index beeeb7d63f7..68b6666264f 100644 --- a/tests/components/backup/test_websocket.py +++ b/tests/components/backup/test_websocket.py @@ -12,7 +12,7 @@ from homeassistant.components.backup.models import BaseBackup from homeassistant.core import HomeAssistant from homeassistant.exceptions import HomeAssistantError -from .common import TEST_BACKUP, BackupSyncAgentTest, setup_backup_integration +from .common import TEST_BACKUP, BackupAgentTest, setup_backup_integration from tests.typing import WebSocketGenerator @@ -256,7 +256,7 @@ async def test_backup_start( pytest.param(False, id="without_hassio"), ], ) -async def test_backup_sync( +async def test_backup_upload( hass: HomeAssistant, hass_ws_client: WebSocketGenerator, snapshot: SnapshotAssertion, @@ -265,18 +265,18 @@ async def test_backup_sync( access_token_fixture_name: str, with_hassio: bool, ) -> None: - """Test handling of pre backup actions from a WS command.""" + """Test backup upload from a WS command.""" await setup_backup_integration(hass, with_hassio=with_hassio) client = await hass_ws_client(hass, sync_access_token_proxy) await hass.async_block_till_done() with patch( - "homeassistant.components.backup.manager.BackupManager.async_sync_backup", + "homeassistant.components.backup.manager.BackupManager.async_upload_backup", ): await client.send_json_auto_id( { - "type": "backup/sync", + "type": "backup/upload", "data": { "slug": "abc123", }, @@ -293,7 +293,7 @@ async def test_backup_sync( Exception("Boom"), ], ) -async def test_backup_end_excepion( +async def test_backup_end_exception( hass: HomeAssistant, hass_ws_client: WebSocketGenerator, snapshot: SnapshotAssertion, @@ -322,26 +322,26 @@ async def test_backup_end_excepion( Exception("Boom"), ], ) -async def test_backup_sync_excepion( +async def test_backup_upload_exception( hass: HomeAssistant, hass_ws_client: WebSocketGenerator, snapshot: SnapshotAssertion, hass_supervisor_access_token: str, exception: Exception, ) -> None: - """Test exception handling while running sync backup action from a WS command.""" + """Test exception handling while running backup upload from a WS command.""" await setup_backup_integration(hass, with_hassio=True) client = await hass_ws_client(hass, hass_supervisor_access_token) await hass.async_block_till_done() with patch( - "homeassistant.components.backup.manager.BackupManager.async_sync_backup", + "homeassistant.components.backup.manager.BackupManager.async_upload_backup", side_effect=exception, ): await client.send_json_auto_id( { - "type": "backup/sync", + "type": "backup/upload", "data": { "slug": "abc123", }, @@ -358,7 +358,7 @@ async def test_backup_sync_excepion( Exception("Boom"), ], ) -async def test_backup_start_excepion( +async def test_backup_start_exception( hass: HomeAssistant, hass_ws_client: WebSocketGenerator, snapshot: SnapshotAssertion, @@ -394,7 +394,7 @@ async def test_agents_info( ) -> None: """Test getting backup agents info.""" await setup_backup_integration(hass, with_hassio=with_hassio) - hass.data[DATA_MANAGER].sync_agents = {"domain.test": BackupSyncAgentTest("test")} + hass.data[DATA_MANAGER].backup_agents = {"domain.test": BackupAgentTest("test")} client = await hass_ws_client(hass) await hass.async_block_till_done() @@ -410,20 +410,20 @@ async def test_agents_info( pytest.param(False, id="without_hassio"), ], ) -async def test_agents_synced( +async def test_agents_list_backups( hass: HomeAssistant, hass_ws_client: WebSocketGenerator, snapshot: SnapshotAssertion, with_hassio: bool, ) -> None: - """Test getting backup agents synced details.""" + """Test backup agents list backups details.""" await setup_backup_integration(hass, with_hassio=with_hassio) - hass.data[DATA_MANAGER].sync_agents = {"domain.test": BackupSyncAgentTest("test")} + hass.data[DATA_MANAGER].backup_agents = {"domain.test": BackupAgentTest("test")} client = await hass_ws_client(hass) await hass.async_block_till_done() - await client.send_json_auto_id({"type": "backup/agents/synced"}) + await client.send_json_auto_id({"type": "backup/agents/list_backups"}) assert await client.receive_json() == snapshot @@ -440,9 +440,9 @@ async def test_agents_download( snapshot: SnapshotAssertion, with_hassio: bool, ) -> None: - """Test WS command to start downloading a synced backup.""" + """Test WS command to start downloading a backup.""" await setup_backup_integration(hass, with_hassio=with_hassio) - hass.data[DATA_MANAGER].sync_agents = {"domain.test": BackupSyncAgentTest("test")} + hass.data[DATA_MANAGER].backup_agents = {"domain.test": BackupAgentTest("test")} client = await hass_ws_client(hass) await hass.async_block_till_done() @@ -452,10 +452,10 @@ async def test_agents_download( "type": "backup/agents/download", "slug": "abc123", "agent": "domain.test", - "sync_id": "abc123", + "backup_id": "abc123", } ) - with patch.object(BackupSyncAgentTest, "async_download_backup") as download_mock: + with patch.object(BackupAgentTest, "async_download_backup") as download_mock: assert await client.receive_json() == snapshot assert download_mock.call_args[1] == { "id": "abc123", @@ -468,9 +468,9 @@ async def test_agents_download_exception( hass_ws_client: WebSocketGenerator, snapshot: SnapshotAssertion, ) -> None: - """Test WS command to start downloading a synced backup throwing an exception.""" + """Test WS command to start downloading a backup throwing an exception.""" await setup_backup_integration(hass) - hass.data[DATA_MANAGER].sync_agents = {"domain.test": BackupSyncAgentTest("test")} + hass.data[DATA_MANAGER].backup_agents = {"domain.test": BackupAgentTest("test")} client = await hass_ws_client(hass) await hass.async_block_till_done() @@ -480,10 +480,10 @@ async def test_agents_download_exception( "type": "backup/agents/download", "slug": "abc123", "agent": "domain.test", - "sync_id": "abc123", + "backup_id": "abc123", } ) - with patch.object(BackupSyncAgentTest, "async_download_backup") as download_mock: + with patch.object(BackupAgentTest, "async_download_backup") as download_mock: download_mock.side_effect = Exception("Boom") assert await client.receive_json() == snapshot @@ -493,7 +493,7 @@ async def test_agents_download_unknown_agent( hass_ws_client: WebSocketGenerator, snapshot: SnapshotAssertion, ) -> None: - """Test downloading a synced backup with an unknown agent.""" + """Test downloading a backup with an unknown agent.""" await setup_backup_integration(hass) client = await hass_ws_client(hass) @@ -504,7 +504,7 @@ async def test_agents_download_unknown_agent( "type": "backup/agents/download", "slug": "abc123", "agent": "domain.test", - "sync_id": "abc123", + "backup_id": "abc123", } ) assert await client.receive_json() == snapshot From 0599983a37eea0fc9a8a92f7854ad18c6f1012ad Mon Sep 17 00:00:00 2001 From: Erik Montnemery Date: Thu, 14 Nov 2024 09:31:08 +0100 Subject: [PATCH 4/9] Add additional options to WS command backup/generate (#130530) * Add additional options to WS command backup/generate * Improve test * Improve test --- homeassistant/components/backup/__init__.py | 8 +- homeassistant/components/backup/const.py | 5 ++ homeassistant/components/backup/manager.py | 49 ++++++++++-- homeassistant/components/backup/websocket.py | 18 ++++- tests/components/backup/conftest.py | 3 +- .../backup/snapshots/test_websocket.ambr | 20 +++++ tests/components/backup/test_manager.py | 76 ++++++++++++++++--- tests/components/backup/test_websocket.py | 57 +++++++++++++- 8 files changed, 212 insertions(+), 24 deletions(-) diff --git a/homeassistant/components/backup/__init__.py b/homeassistant/components/backup/__init__.py index b479f33422d..26cadb6c7f2 100644 --- a/homeassistant/components/backup/__init__.py +++ b/homeassistant/components/backup/__init__.py @@ -39,7 +39,13 @@ async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool: async def async_handle_create_service(call: ServiceCall) -> None: """Service handler for creating backups.""" - await backup_manager.async_create_backup(on_progress=None) + await backup_manager.async_create_backup( + addons_included=None, + database_included=True, + folders_included=None, + name=None, + on_progress=None, + ) if backup_task := backup_manager.backup_task: await backup_task diff --git a/homeassistant/components/backup/const.py b/homeassistant/components/backup/const.py index a10fec80360..4f916d94650 100644 --- a/homeassistant/components/backup/const.py +++ b/homeassistant/components/backup/const.py @@ -26,3 +26,8 @@ EXCLUDE_FROM_BACKUP = [ "OZW_Log.txt", "tts/*", ] + +EXCLUDE_DATABASE_FROM_BACKUP = [ + "home-assistant_v2.db", + "home-assistant_v2.db-wal", +] diff --git a/homeassistant/components/backup/manager.py b/homeassistant/components/backup/manager.py index c0c033cd1fe..671edb933ae 100644 --- a/homeassistant/components/backup/manager.py +++ b/homeassistant/components/backup/manager.py @@ -32,7 +32,7 @@ from homeassistant.util import dt as dt_util from homeassistant.util.json import json_loads_object from .agent import BackupAgent, BackupAgentPlatformProtocol -from .const import DOMAIN, EXCLUDE_FROM_BACKUP, LOGGER +from .const import DOMAIN, EXCLUDE_DATABASE_FROM_BACKUP, EXCLUDE_FROM_BACKUP, LOGGER from .models import BackupUploadMetadata, BaseBackup BUF_SIZE = 2**20 * 4 # 4MB @@ -180,10 +180,18 @@ class BaseBackupManager(abc.ABC, Generic[_BackupT]): async def async_create_backup( self, *, + addons_included: list[str] | None, + database_included: bool, + folders_included: list[str] | None, + name: str | None, on_progress: Callable[[BackupProgress], None] | None, **kwargs: Any, ) -> NewBackup: - """Generate a backup.""" + """Initiate generating a backup. + + :param on_progress: A callback that will be called with the progress of the + backup. + """ @abc.abstractmethod async def async_get_backups(self, **kwargs: Any) -> dict[str, _BackupT]: @@ -380,17 +388,29 @@ class BackupManager(BaseBackupManager[Backup]): async def async_create_backup( self, *, + addons_included: list[str] | None, + database_included: bool, + folders_included: list[str] | None, + name: str | None, on_progress: Callable[[BackupProgress], None] | None, **kwargs: Any, ) -> NewBackup: - """Generate a backup.""" + """Initiate generating a backup.""" if self.backup_task: raise HomeAssistantError("Backup already in progress") - backup_name = f"Core {HAVERSION}" + backup_name = name or f"Core {HAVERSION}" date_str = dt_util.now().isoformat() slug = _generate_slug(date_str, backup_name) self.backup_task = self.hass.async_create_task( - self._async_create_backup(backup_name, date_str, slug, on_progress), + self._async_create_backup( + addons_included=addons_included, + backup_name=backup_name, + database_included=database_included, + date_str=date_str, + folders_included=folders_included, + on_progress=on_progress, + slug=slug, + ), name="backup_manager_create_backup", eager_start=False, # To ensure the task is not started before we return ) @@ -398,10 +418,14 @@ class BackupManager(BaseBackupManager[Backup]): async def _async_create_backup( self, + *, + addons_included: list[str] | None, + database_included: bool, backup_name: str, date_str: str, - slug: str, + folders_included: list[str] | None, on_progress: Callable[[BackupProgress], None] | None, + slug: str, ) -> Backup: """Generate a backup.""" success = False @@ -414,7 +438,10 @@ class BackupManager(BaseBackupManager[Backup]): "date": date_str, "type": "partial", "folders": ["homeassistant"], - "homeassistant": {"version": HAVERSION}, + "homeassistant": { + "exclude_database": not database_included, + "version": HAVERSION, + }, "compressed": True, } tar_file_path = Path(self.backup_dir, f"{backup_data['slug']}.tar") @@ -422,6 +449,7 @@ class BackupManager(BaseBackupManager[Backup]): self._mkdir_and_generate_backup_contents, tar_file_path, backup_data, + database_included, ) backup = Backup( slug=slug, @@ -445,12 +473,17 @@ class BackupManager(BaseBackupManager[Backup]): self, tar_file_path: Path, backup_data: dict[str, Any], + database_included: bool, ) -> int: """Generate backup contents and return the size.""" if not self.backup_dir.exists(): LOGGER.debug("Creating backup directory") self.backup_dir.mkdir() + excludes = EXCLUDE_FROM_BACKUP + if not database_included: + excludes = excludes + EXCLUDE_DATABASE_FROM_BACKUP + outer_secure_tarfile = SecureTarFile( tar_file_path, "w", gzip=False, bufsize=BUF_SIZE ) @@ -467,7 +500,7 @@ class BackupManager(BaseBackupManager[Backup]): atomic_contents_add( tar_file=core_tar, origin_path=Path(self.hass.config.path()), - excludes=EXCLUDE_FROM_BACKUP, + excludes=excludes, arcname="data", ) diff --git a/homeassistant/components/backup/websocket.py b/homeassistant/components/backup/websocket.py index 876f6c2bff5..04b16bad304 100644 --- a/homeassistant/components/backup/websocket.py +++ b/homeassistant/components/backup/websocket.py @@ -112,7 +112,15 @@ async def handle_restore( @websocket_api.require_admin -@websocket_api.websocket_command({vol.Required("type"): "backup/generate"}) +@websocket_api.websocket_command( + { + vol.Required("type"): "backup/generate", + vol.Optional("addons_included"): [str], + vol.Optional("database_included", default=True): bool, + vol.Optional("folders_included"): [str], + vol.Optional("name"): str, + } +) @websocket_api.async_response async def handle_create( hass: HomeAssistant, @@ -124,7 +132,13 @@ async def handle_create( def on_progress(progress: BackupProgress) -> None: connection.send_message(websocket_api.event_message(msg["id"], progress)) - backup = await hass.data[DATA_MANAGER].async_create_backup(on_progress=on_progress) + backup = await hass.data[DATA_MANAGER].async_create_backup( + addons_included=msg.get("addons_included"), + database_included=msg["database_included"], + folders_included=msg.get("folders_included"), + name=msg.get("name"), + on_progress=on_progress, + ) connection.send_result(msg["id"], backup) diff --git a/tests/components/backup/conftest.py b/tests/components/backup/conftest.py index 631c774e63c..aeb5f76234a 100644 --- a/tests/components/backup/conftest.py +++ b/tests/components/backup/conftest.py @@ -43,11 +43,12 @@ def mock_backup_generation_fixture( Path("test.txt"), Path(".DS_Store"), Path(".storage"), + Path("home-assistant_v2.db"), ] with ( patch("pathlib.Path.iterdir", _mock_iterdir), - patch("pathlib.Path.stat", MagicMock(st_size=123)), + patch("pathlib.Path.stat", return_value=MagicMock(st_size=123)), patch("pathlib.Path.is_file", lambda x: x.name != ".storage"), patch( "pathlib.Path.is_dir", diff --git a/tests/components/backup/snapshots/test_websocket.ambr b/tests/components/backup/snapshots/test_websocket.ambr index 9edd1216203..427748083a2 100644 --- a/tests/components/backup/snapshots/test_websocket.ambr +++ b/tests/components/backup/snapshots/test_websocket.ambr @@ -403,6 +403,26 @@ 'type': 'event', }) # --- +# name: test_generate_without_hassio[params0-expected_extra_call_params0] + dict({ + 'id': 1, + 'result': dict({ + 'slug': 'abc123', + }), + 'success': True, + 'type': 'result', + }) +# --- +# name: test_generate_without_hassio[params1-expected_extra_call_params1] + dict({ + 'id': 1, + 'result': dict({ + 'slug': 'abc123', + }), + 'success': True, + 'type': 'result', + }) +# --- # name: test_info[with_hassio] dict({ 'error': dict({ diff --git a/tests/components/backup/test_manager.py b/tests/components/backup/test_manager.py index 9cc0067cf1a..5b3396291ad 100644 --- a/tests/components/backup/test_manager.py +++ b/tests/components/backup/test_manager.py @@ -4,7 +4,7 @@ from __future__ import annotations import asyncio from typing import Any -from unittest.mock import AsyncMock, MagicMock, Mock, mock_open, patch +from unittest.mock import ANY, AsyncMock, MagicMock, Mock, call, mock_open, patch import aiohttp from multidict import CIMultiDict, CIMultiDictProxy @@ -24,9 +24,20 @@ from .common import TEST_BACKUP, BackupAgentTest from tests.common import MockPlatform, mock_platform +_EXPECTED_FILES_WITH_DATABASE = { + True: ["test.txt", ".storage", "home-assistant_v2.db"], + False: ["test.txt", ".storage"], +} + async def _mock_backup_generation( - manager: BackupManager, mocked_json_bytes: Mock, mocked_tarfile: Mock + hass: HomeAssistant, + manager: BackupManager, + mocked_json_bytes: Mock, + mocked_tarfile: Mock, + *, + database_included: bool = True, + name: str | None = "Core 2025.1.0", ) -> None: """Mock backup generator.""" @@ -37,7 +48,13 @@ async def _mock_backup_generation( progress.append(_progress) assert manager.backup_task is None - await manager.async_create_backup(on_progress=on_progress) + await manager.async_create_backup( + addons_included=[], + database_included=database_included, + folders_included=[], + name=name, + on_progress=on_progress, + ) assert manager.backup_task is not None assert progress == [] @@ -47,8 +64,26 @@ async def _mock_backup_generation( assert mocked_json_bytes.call_count == 1 backup_json_dict = mocked_json_bytes.call_args[0][0] assert isinstance(backup_json_dict, dict) - assert backup_json_dict["homeassistant"] == {"version": "2025.1.0"} + assert backup_json_dict == { + "compressed": True, + "date": ANY, + "folders": ["homeassistant"], + "homeassistant": { + "exclude_database": not database_included, + "version": "2025.1.0", + }, + "name": name, + "slug": ANY, + "type": "partial", + } assert manager.backup_dir.as_posix() in str(mocked_tarfile.call_args_list[0][0][0]) + outer_tar = mocked_tarfile.return_value + core_tar = outer_tar.create_inner_tar.return_value.__enter__.return_value + expected_files = [call(hass.config.path(), arcname="data", recursive=False)] + [ + call(file, arcname=f"data/{file}", recursive=False) + for file in _EXPECTED_FILES_WITH_DATABASE[database_included] + ] + assert core_tar.add.call_args_list == expected_files return backup @@ -158,22 +193,35 @@ async def test_async_create_backup_when_backing_up(hass: HomeAssistant) -> None: manager = BackupManager(hass) manager.backup_task = hass.async_create_task(event.wait()) with pytest.raises(HomeAssistantError, match="Backup already in progress"): - await manager.async_create_backup(on_progress=None) + await manager.async_create_backup( + addons_included=[], + database_included=True, + folders_included=[], + name=None, + on_progress=None, + ) event.set() @pytest.mark.usefixtures("mock_backup_generation") +@pytest.mark.parametrize( + "params", + [{}, {"database_included": True, "name": "abc123"}, {"database_included": False}], +) async def test_async_create_backup( hass: HomeAssistant, caplog: pytest.LogCaptureFixture, mocked_json_bytes: Mock, mocked_tarfile: Mock, + params: dict, ) -> None: """Test generate backup.""" manager = BackupManager(hass) manager.loaded_backups = True - await _mock_backup_generation(manager, mocked_json_bytes, mocked_tarfile) + await _mock_backup_generation( + hass, manager, mocked_json_bytes, mocked_tarfile, **params + ) assert "Generated new backup with slug " in caplog.text assert "Creating backup directory" in caplog.text @@ -280,7 +328,9 @@ async def test_syncing_backup( await manager.load_platforms() await hass.async_block_till_done() - backup = await _mock_backup_generation(manager, mocked_json_bytes, mocked_tarfile) + backup = await _mock_backup_generation( + hass, manager, mocked_json_bytes, mocked_tarfile + ) with ( patch( @@ -338,7 +388,9 @@ async def test_syncing_backup_with_exception( await manager.load_platforms() await hass.async_block_till_done() - backup = await _mock_backup_generation(manager, mocked_json_bytes, mocked_tarfile) + backup = await _mock_backup_generation( + hass, manager, mocked_json_bytes, mocked_tarfile + ) with ( patch( @@ -391,7 +443,9 @@ async def test_syncing_backup_no_agents( await manager.load_platforms() await hass.async_block_till_done() - backup = await _mock_backup_generation(manager, mocked_json_bytes, mocked_tarfile) + backup = await _mock_backup_generation( + hass, manager, mocked_json_bytes, mocked_tarfile + ) with patch( "homeassistant.components.backup.agent.BackupAgent.async_upload_backup" ) as mocked_async_upload_backup: @@ -419,7 +473,7 @@ async def test_exception_plaform_pre( ) with pytest.raises(HomeAssistantError): - await _mock_backup_generation(manager, mocked_json_bytes, mocked_tarfile) + await _mock_backup_generation(hass, manager, mocked_json_bytes, mocked_tarfile) async def test_exception_plaform_post( @@ -442,7 +496,7 @@ async def test_exception_plaform_post( ) with pytest.raises(HomeAssistantError): - await _mock_backup_generation(manager, mocked_json_bytes, mocked_tarfile) + await _mock_backup_generation(hass, manager, mocked_json_bytes, mocked_tarfile) async def test_loading_platforms_when_running_async_pre_backup_actions( diff --git a/tests/components/backup/test_websocket.py b/tests/components/backup/test_websocket.py index 68b6666264f..265de55f855 100644 --- a/tests/components/backup/test_websocket.py +++ b/tests/components/backup/test_websocket.py @@ -1,13 +1,14 @@ """Tests for the Backup integration.""" from pathlib import Path -from unittest.mock import AsyncMock, patch +from unittest.mock import ANY, AsyncMock, patch from freezegun.api import FrozenDateTimeFactory import pytest from syrupy import SnapshotAssertion from homeassistant.components.backup.const import DATA_MANAGER +from homeassistant.components.backup.manager import NewBackup from homeassistant.components.backup.models import BaseBackup from homeassistant.core import HomeAssistant from homeassistant.exceptions import HomeAssistantError @@ -153,6 +154,60 @@ async def test_generate( assert await client.receive_json() == snapshot +@pytest.mark.usefixtures("mock_backup_generation") +@pytest.mark.parametrize( + ("params", "expected_extra_call_params"), + [ + ({}, {}), + ( + { + "addons_included": ["ssl"], + "database_included": False, + "folders_included": ["media"], + "name": "abc123", + }, + { + "addons_included": ["ssl"], + "database_included": False, + "folders_included": ["media"], + "name": "abc123", + }, + ), + ], +) +async def test_generate_without_hassio( + hass: HomeAssistant, + hass_ws_client: WebSocketGenerator, + freezer: FrozenDateTimeFactory, + snapshot: SnapshotAssertion, + params: dict, + expected_extra_call_params: tuple, +) -> None: + """Test generating a backup.""" + await setup_backup_integration(hass, with_hassio=False) + + client = await hass_ws_client(hass) + freezer.move_to("2024-11-13 12:01:00+01:00") + await hass.async_block_till_done() + + with patch( + "homeassistant.components.backup.manager.BackupManager.async_create_backup", + return_value=NewBackup("abc123"), + ) as generate_backup: + await client.send_json_auto_id({"type": "backup/generate"} | params) + assert await client.receive_json() == snapshot + generate_backup.assert_called_once_with( + **{ + "addons_included": None, + "database_included": True, + "folders_included": None, + "name": None, + "on_progress": ANY, + } + | expected_extra_call_params + ) + + @pytest.mark.parametrize( "with_hassio", [ From d1185f87542d6249bb14453e9b09f3c050941c25 Mon Sep 17 00:00:00 2001 From: Erik Montnemery Date: Thu, 14 Nov 2024 12:44:59 +0100 Subject: [PATCH 5/9] Align parameter names in backup/agents/* WS commands (#130590) --- homeassistant/components/backup/websocket.py | 8 ++++---- tests/components/backup/snapshots/test_websocket.ambr | 4 ++-- tests/components/backup/test_websocket.py | 6 +++--- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/homeassistant/components/backup/websocket.py b/homeassistant/components/backup/websocket.py index 04b16bad304..375ee4c04ee 100644 --- a/homeassistant/components/backup/websocket.py +++ b/homeassistant/components/backup/websocket.py @@ -226,7 +226,7 @@ async def backup_agents_info( connection.send_result( msg["id"], { - "agents": [{"id": agent_id} for agent_id in manager.backup_agents], + "agents": [{"agent_id": agent_id} for agent_id in manager.backup_agents], "syncing": manager.syncing, }, ) @@ -254,7 +254,7 @@ async def backup_agents_list_backups( @websocket_api.websocket_command( { vol.Required("type"): "backup/agents/download", - vol.Required("agent"): str, + vol.Required("agent_id"): str, vol.Required("backup_id"): str, vol.Required("slug"): str, } @@ -269,9 +269,9 @@ async def backup_agents_download( manager = hass.data[DATA_MANAGER] await manager.load_platforms() - if not (agent := manager.backup_agents.get(msg["agent"])): + if not (agent := manager.backup_agents.get(msg["agent_id"])): connection.send_error( - msg["id"], "unknown_agent", f"Agent {msg['agent']} not found" + msg["id"], "unknown_agent", f"Agent {msg['agent_id']} not found" ) return try: diff --git a/tests/components/backup/snapshots/test_websocket.ambr b/tests/components/backup/snapshots/test_websocket.ambr index 427748083a2..2dc35469778 100644 --- a/tests/components/backup/snapshots/test_websocket.ambr +++ b/tests/components/backup/snapshots/test_websocket.ambr @@ -43,7 +43,7 @@ 'result': dict({ 'agents': list([ dict({ - 'id': 'domain.test', + 'agent_id': 'domain.test', }), ]), 'syncing': False, @@ -58,7 +58,7 @@ 'result': dict({ 'agents': list([ dict({ - 'id': 'domain.test', + 'agent_id': 'domain.test', }), ]), 'syncing': False, diff --git a/tests/components/backup/test_websocket.py b/tests/components/backup/test_websocket.py index 265de55f855..5fee1870c10 100644 --- a/tests/components/backup/test_websocket.py +++ b/tests/components/backup/test_websocket.py @@ -506,7 +506,7 @@ async def test_agents_download( { "type": "backup/agents/download", "slug": "abc123", - "agent": "domain.test", + "agent_id": "domain.test", "backup_id": "abc123", } ) @@ -534,7 +534,7 @@ async def test_agents_download_exception( { "type": "backup/agents/download", "slug": "abc123", - "agent": "domain.test", + "agent_id": "domain.test", "backup_id": "abc123", } ) @@ -558,7 +558,7 @@ async def test_agents_download_unknown_agent( { "type": "backup/agents/download", "slug": "abc123", - "agent": "domain.test", + "agent_id": "domain.test", "backup_id": "abc123", } ) From 5a6948863023eb19353d7e0f1c430f169745d7a9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20S=C3=B8rensen?= Date: Thu, 14 Nov 2024 12:53:28 +0100 Subject: [PATCH 6/9] Allow setting password for backups (#110630) * Allow setting password for backups * use is_hassio from helpers * move it * Fix getting psw * Fix restoring with psw * Address review comments * Improve docstring * Adjust kitchen sink * Adjust --------- Co-authored-by: Erik --- homeassistant/backup_restore.py | 56 ++++++++++---- homeassistant/components/backup/__init__.py | 13 +++- homeassistant/components/backup/manager.py | 36 +++++++-- homeassistant/components/backup/models.py | 4 +- homeassistant/components/backup/services.yaml | 6 ++ homeassistant/components/backup/strings.json | 8 +- homeassistant/components/backup/websocket.py | 8 +- .../components/kitchen_sink/backup.py | 2 + tests/components/backup/common.py | 8 +- .../backup/snapshots/test_websocket.ambr | 74 ++++++++++++++++++- tests/components/backup/test_init.py | 4 + tests/components/backup/test_manager.py | 44 ++++++++++- tests/components/backup/test_websocket.py | 13 +++- tests/test_backup_restore.py | 60 +++++++++++++-- 14 files changed, 295 insertions(+), 41 deletions(-) diff --git a/homeassistant/backup_restore.py b/homeassistant/backup_restore.py index 32991dfb2d3..622a473c5c9 100644 --- a/homeassistant/backup_restore.py +++ b/homeassistant/backup_restore.py @@ -1,6 +1,7 @@ """Home Assistant module to handle restoring backups.""" from dataclasses import dataclass +import hashlib import json import logging from pathlib import Path @@ -24,6 +25,18 @@ class RestoreBackupFileContent: """Definition for restore backup file content.""" backup_file_path: Path + password: str | None = None + + +def password_to_key(password: str) -> bytes: + """Generate a AES Key from password. + + Matches the implementation in supervisor.backups.utils.password_to_key. + """ + key: bytes = password.encode() + for _ in range(100): + key = hashlib.sha256(key).digest() + return key[:16] def restore_backup_file_content(config_dir: Path) -> RestoreBackupFileContent | None: @@ -32,7 +45,8 @@ def restore_backup_file_content(config_dir: Path) -> RestoreBackupFileContent | try: instruction_content = json.loads(instruction_path.read_text(encoding="utf-8")) return RestoreBackupFileContent( - backup_file_path=Path(instruction_content["path"]) + backup_file_path=Path(instruction_content["path"]), + password=instruction_content.get("password"), ) except (FileNotFoundError, json.JSONDecodeError): return None @@ -54,7 +68,11 @@ def _clear_configuration_directory(config_dir: Path) -> None: shutil.rmtree(entrypath) -def _extract_backup(config_dir: Path, backup_file_path: Path) -> None: +def _extract_backup( + config_dir: Path, + backup_file_path: Path, + password: str | None = None, +) -> None: """Extract the backup file to the config directory.""" with ( TemporaryDirectory() as tempdir, @@ -88,22 +106,28 @@ def _extract_backup(config_dir: Path, backup_file_path: Path) -> None: f"homeassistant.tar{'.gz' if backup_meta["compressed"] else ''}", ), gzip=backup_meta["compressed"], + key=password_to_key(password) if password is not None else None, mode="r", ) as istf: - for member in istf.getmembers(): - if member.name == "data": - continue - member.name = member.name.replace("data/", "") - _clear_configuration_directory(config_dir) istf.extractall( - path=config_dir, - members=[ - member - for member in securetar.secure_path(istf) - if member.name != "data" - ], + path=Path( + tempdir, + "homeassistant", + ), + members=securetar.secure_path(istf), filter="fully_trusted", ) + _clear_configuration_directory(config_dir) + shutil.copytree( + Path( + tempdir, + "homeassistant", + "data", + ), + config_dir, + dirs_exist_ok=True, + ignore=shutil.ignore_patterns(*(KEEP_PATHS)), + ) def restore_backup(config_dir_path: str) -> bool: @@ -119,7 +143,11 @@ def restore_backup(config_dir_path: str) -> bool: backup_file_path = restore_content.backup_file_path _LOGGER.info("Restoring %s", backup_file_path) try: - _extract_backup(config_dir, backup_file_path) + _extract_backup( + config_dir=config_dir, + backup_file_path=backup_file_path, + password=restore_content.password, + ) except FileNotFoundError as err: raise ValueError(f"Backup file {backup_file_path} does not exist") from err _LOGGER.info("Restore complete, restarting") diff --git a/homeassistant/components/backup/__init__.py b/homeassistant/components/backup/__init__.py index 26cadb6c7f2..d160b0bd88f 100644 --- a/homeassistant/components/backup/__init__.py +++ b/homeassistant/components/backup/__init__.py @@ -1,5 +1,8 @@ """The Backup integration.""" +import voluptuous as vol + +from homeassistant.const import CONF_PASSWORD from homeassistant.core import HomeAssistant, ServiceCall from homeassistant.helpers import config_validation as cv from homeassistant.helpers.hassio import is_hassio @@ -20,6 +23,8 @@ __all__ = [ CONFIG_SCHEMA = cv.empty_config_schema(DOMAIN) +SERVICE_CREATE_SCHEMA = vol.Schema({vol.Optional(CONF_PASSWORD): str}) + async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool: """Set up the Backup integration.""" @@ -45,11 +50,17 @@ async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool: folders_included=None, name=None, on_progress=None, + password=call.data.get(CONF_PASSWORD), ) if backup_task := backup_manager.backup_task: await backup_task - hass.services.async_register(DOMAIN, "create", async_handle_create_service) + hass.services.async_register( + DOMAIN, + "create", + async_handle_create_service, + schema=SERVICE_CREATE_SCHEMA, + ) async_register_http_views(hass) diff --git a/homeassistant/components/backup/manager.py b/homeassistant/components/backup/manager.py index 671edb933ae..b2e353a0c4e 100644 --- a/homeassistant/components/backup/manager.py +++ b/homeassistant/components/backup/manager.py @@ -22,7 +22,7 @@ import aiohttp from securetar import SecureTarFile, atomic_contents_add from typing_extensions import TypeVar -from homeassistant.backup_restore import RESTORE_BACKUP_FILE +from homeassistant.backup_restore import RESTORE_BACKUP_FILE, password_to_key from homeassistant.const import __version__ as HAVERSION from homeassistant.core import HomeAssistant, callback from homeassistant.exceptions import HomeAssistantError @@ -173,7 +173,13 @@ class BaseBackupManager(abc.ABC, Generic[_BackupT]): self.loaded_platforms = True @abc.abstractmethod - async def async_restore_backup(self, slug: str, **kwargs: Any) -> None: + async def async_restore_backup( + self, + slug: str, + *, + password: str | None = None, + **kwargs: Any, + ) -> None: """Restore a backup.""" @abc.abstractmethod @@ -185,6 +191,7 @@ class BaseBackupManager(abc.ABC, Generic[_BackupT]): folders_included: list[str] | None, name: str | None, on_progress: Callable[[BackupProgress], None] | None, + password: str | None, **kwargs: Any, ) -> NewBackup: """Initiate generating a backup. @@ -252,6 +259,7 @@ class BackupManager(BaseBackupManager[Backup]): date=backup.date, slug=backup.slug, name=backup.name, + protected=backup.protected, ), ) for agent in self.backup_agents.values() @@ -284,6 +292,7 @@ class BackupManager(BaseBackupManager[Backup]): date=cast(str, data["date"]), path=backup_path, size=round(backup_path.stat().st_size / 1_048_576, 2), + protected=cast(bool, data.get("protected", False)), ) backups[backup.slug] = backup except (OSError, TarError, json.JSONDecodeError, KeyError) as err: @@ -393,6 +402,7 @@ class BackupManager(BaseBackupManager[Backup]): folders_included: list[str] | None, name: str | None, on_progress: Callable[[BackupProgress], None] | None, + password: str | None, **kwargs: Any, ) -> NewBackup: """Initiate generating a backup.""" @@ -409,6 +419,7 @@ class BackupManager(BaseBackupManager[Backup]): date_str=date_str, folders_included=folders_included, on_progress=on_progress, + password=password, slug=slug, ), name="backup_manager_create_backup", @@ -425,6 +436,7 @@ class BackupManager(BaseBackupManager[Backup]): date_str: str, folders_included: list[str] | None, on_progress: Callable[[BackupProgress], None] | None, + password: str | None, slug: str, ) -> Backup: """Generate a backup.""" @@ -443,13 +455,16 @@ class BackupManager(BaseBackupManager[Backup]): "version": HAVERSION, }, "compressed": True, + "protected": password is not None, } + tar_file_path = Path(self.backup_dir, f"{backup_data['slug']}.tar") size_in_bytes = await self.hass.async_add_executor_job( self._mkdir_and_generate_backup_contents, tar_file_path, backup_data, database_included, + password, ) backup = Backup( slug=slug, @@ -457,6 +472,7 @@ class BackupManager(BaseBackupManager[Backup]): date=date_str, path=tar_file_path, size=round(size_in_bytes / 1_048_576, 2), + protected=password is not None, ) if self.loaded_backups: self.backups[slug] = backup @@ -474,6 +490,7 @@ class BackupManager(BaseBackupManager[Backup]): tar_file_path: Path, backup_data: dict[str, Any], database_included: bool, + password: str | None = None, ) -> int: """Generate backup contents and return the size.""" if not self.backup_dir.exists(): @@ -495,7 +512,9 @@ class BackupManager(BaseBackupManager[Backup]): tar_info.mtime = int(time.time()) outer_secure_tarfile_tarfile.addfile(tar_info, fileobj=fileobj) with outer_secure_tarfile.create_inner_tar( - "./homeassistant.tar.gz", gzip=True + "./homeassistant.tar.gz", + gzip=True, + key=password_to_key(password) if password is not None else None, ) as core_tar: atomic_contents_add( tar_file=core_tar, @@ -503,10 +522,15 @@ class BackupManager(BaseBackupManager[Backup]): excludes=excludes, arcname="data", ) - return tar_file_path.stat().st_size - async def async_restore_backup(self, slug: str, **kwargs: Any) -> None: + async def async_restore_backup( + self, + slug: str, + *, + password: str | None = None, + **kwargs: Any, + ) -> None: """Restore a backup. This will write the restore information to .HA_RESTORE which @@ -518,7 +542,7 @@ class BackupManager(BaseBackupManager[Backup]): def _write_restore_file() -> None: """Write the restore file.""" Path(self.hass.config.path(RESTORE_BACKUP_FILE)).write_text( - json.dumps({"path": backup.path.as_posix()}), + json.dumps({"path": backup.path.as_posix(), "password": password}), encoding="utf-8", ) diff --git a/homeassistant/components/backup/models.py b/homeassistant/components/backup/models.py index 1007a233923..98fd15c9475 100644 --- a/homeassistant/components/backup/models.py +++ b/homeassistant/components/backup/models.py @@ -8,9 +8,10 @@ class BaseBackup: """Base backup class.""" date: str + name: str + protected: bool slug: str size: float - name: str def as_dict(self) -> dict: """Return a dict representation of this backup.""" @@ -26,3 +27,4 @@ class BackupUploadMetadata: size: float # The size of the backup (in bytes) name: str # The name of the backup homeassistant: str # The version of Home Assistant that created the backup + protected: bool # If the backup is protected diff --git a/homeassistant/components/backup/services.yaml b/homeassistant/components/backup/services.yaml index 900aa39dd6e..772ed015d3a 100644 --- a/homeassistant/components/backup/services.yaml +++ b/homeassistant/components/backup/services.yaml @@ -1 +1,7 @@ create: + fields: + password: + required: false + selector: + text: + type: password diff --git a/homeassistant/components/backup/strings.json b/homeassistant/components/backup/strings.json index 6ad3416b1b9..da75ba08511 100644 --- a/homeassistant/components/backup/strings.json +++ b/homeassistant/components/backup/strings.json @@ -2,7 +2,13 @@ "services": { "create": { "name": "Create backup", - "description": "Creates a new backup." + "description": "Creates a new backup.", + "fields": { + "password": { + "name": "[%key:common::config_flow::data::password%]", + "description": "Password protect the backup" + } + } } } } diff --git a/homeassistant/components/backup/websocket.py b/homeassistant/components/backup/websocket.py index 375ee4c04ee..e2164a2dbca 100644 --- a/homeassistant/components/backup/websocket.py +++ b/homeassistant/components/backup/websocket.py @@ -98,6 +98,7 @@ async def handle_remove( { vol.Required("type"): "backup/restore", vol.Required("slug"): str, + vol.Optional("password"): str, } ) @websocket_api.async_response @@ -107,7 +108,10 @@ async def handle_restore( msg: dict[str, Any], ) -> None: """Restore a backup.""" - await hass.data[DATA_MANAGER].async_restore_backup(msg["slug"]) + await hass.data[DATA_MANAGER].async_restore_backup( + slug=msg["slug"], + password=msg.get("password"), + ) connection.send_result(msg["id"]) @@ -119,6 +123,7 @@ async def handle_restore( vol.Optional("database_included", default=True): bool, vol.Optional("folders_included"): [str], vol.Optional("name"): str, + vol.Optional("password"): str, } ) @websocket_api.async_response @@ -138,6 +143,7 @@ async def handle_create( folders_included=msg.get("folders_included"), name=msg.get("name"), on_progress=on_progress, + password=msg.get("password"), ) connection.send_result(msg["id"], backup) diff --git a/homeassistant/components/kitchen_sink/backup.py b/homeassistant/components/kitchen_sink/backup.py index 92d1859dbe6..ffbca276680 100644 --- a/homeassistant/components/kitchen_sink/backup.py +++ b/homeassistant/components/kitchen_sink/backup.py @@ -34,6 +34,7 @@ class KitchenSinkBackupAgent(BackupAgent): UploadedBackup( id="def456", name="Kitchen sink syncer", + protected=False, slug="abc123", size=1234, date="1970-01-01T00:00:00Z", @@ -63,6 +64,7 @@ class KitchenSinkBackupAgent(BackupAgent): UploadedBackup( id=uuid4().hex, name=metadata.name, + protected=metadata.protected, slug=metadata.slug, size=metadata.size, date=metadata.date, diff --git a/tests/components/backup/common.py b/tests/components/backup/common.py index 2af5c76236f..18f9f28520d 100644 --- a/tests/components/backup/common.py +++ b/tests/components/backup/common.py @@ -20,6 +20,7 @@ TEST_BACKUP = Backup( date="1970-01-01T00:00:00.000Z", path=Path("abc123.tar"), size=0.0, + protected=False, ) @@ -49,10 +50,11 @@ class BackupAgentTest(BackupAgent): return [ UploadedBackup( id="abc123", - name="Test", - slug="abc123", - size=13.37, date="1970-01-01T00:00:00Z", + name="Test", + protected=False, + size=13.37, + slug="abc123", ) ] diff --git a/tests/components/backup/snapshots/test_websocket.ambr b/tests/components/backup/snapshots/test_websocket.ambr index 2dc35469778..2adaafc5060 100644 --- a/tests/components/backup/snapshots/test_websocket.ambr +++ b/tests/components/backup/snapshots/test_websocket.ambr @@ -76,6 +76,7 @@ 'date': '1970-01-01T00:00:00Z', 'id': 'abc123', 'name': 'Test', + 'protected': False, 'size': 13.37, 'slug': 'abc123', }), @@ -93,6 +94,7 @@ 'date': '1970-01-01T00:00:00Z', 'id': 'abc123', 'name': 'Test', + 'protected': False, 'size': 13.37, 'slug': 'abc123', }), @@ -353,6 +355,7 @@ 'date': '1970-01-01T00:00:00.000Z', 'name': 'Test', 'path': 'abc123.tar', + 'protected': False, 'size': 0.0, 'slug': 'abc123', }), @@ -371,7 +374,7 @@ 'type': 'result', }) # --- -# name: test_generate[with_hassio] +# name: test_generate[with_hassio-None] dict({ 'error': dict({ 'code': 'unknown_command', @@ -382,7 +385,29 @@ 'type': 'result', }) # --- -# name: test_generate[without_hassio] +# name: test_generate[with_hassio-data1] + dict({ + 'error': dict({ + 'code': 'unknown_command', + 'message': 'Unknown command.', + }), + 'id': 1, + 'success': False, + 'type': 'result', + }) +# --- +# name: test_generate[with_hassio-data2] + dict({ + 'error': dict({ + 'code': 'unknown_command', + 'message': 'Unknown command.', + }), + 'id': 1, + 'success': False, + 'type': 'result', + }) +# --- +# name: test_generate[without_hassio-None] dict({ 'id': 1, 'result': dict({ @@ -392,7 +417,49 @@ 'type': 'result', }) # --- -# name: test_generate[without_hassio].1 +# name: test_generate[without_hassio-None].1 + dict({ + 'event': dict({ + 'done': True, + 'stage': None, + 'success': True, + }), + 'id': 1, + 'type': 'event', + }) +# --- +# name: test_generate[without_hassio-data1] + dict({ + 'id': 1, + 'result': dict({ + 'slug': '27f5c632', + }), + 'success': True, + 'type': 'result', + }) +# --- +# name: test_generate[without_hassio-data1].1 + dict({ + 'event': dict({ + 'done': True, + 'stage': None, + 'success': True, + }), + 'id': 1, + 'type': 'event', + }) +# --- +# name: test_generate[without_hassio-data2] + dict({ + 'id': 1, + 'result': dict({ + 'slug': '27f5c632', + }), + 'success': True, + 'type': 'result', + }) +# --- +# name: test_generate[without_hassio-data2].1 dict({ 'event': dict({ 'done': True, @@ -444,6 +511,7 @@ 'date': '1970-01-01T00:00:00.000Z', 'name': 'Test', 'path': 'abc123.tar', + 'protected': False, 'size': 0.0, 'slug': 'abc123', }), diff --git a/tests/components/backup/test_init.py b/tests/components/backup/test_init.py index e064939d618..ad55c4cc0cb 100644 --- a/tests/components/backup/test_init.py +++ b/tests/components/backup/test_init.py @@ -1,5 +1,6 @@ """Tests for the Backup integration.""" +from typing import Any from unittest.mock import patch import pytest @@ -26,8 +27,10 @@ async def test_setup_with_hassio( ) in caplog.text +@pytest.mark.parametrize("service_data", [None, {}, {"password": "abc123"}]) async def test_create_service( hass: HomeAssistant, + service_data: dict[str, Any] | None, ) -> None: """Test generate backup.""" await setup_backup_integration(hass) @@ -39,6 +42,7 @@ async def test_create_service( DOMAIN, "create", blocking=True, + service_data=service_data, ) assert generate_backup.called diff --git a/tests/components/backup/test_manager.py b/tests/components/backup/test_manager.py index 5b3396291ad..a15002d217e 100644 --- a/tests/components/backup/test_manager.py +++ b/tests/components/backup/test_manager.py @@ -38,6 +38,7 @@ async def _mock_backup_generation( *, database_included: bool = True, name: str | None = "Core 2025.1.0", + password: str | None = None, ) -> None: """Mock backup generator.""" @@ -54,6 +55,7 @@ async def _mock_backup_generation( folders_included=[], name=name, on_progress=on_progress, + password=password, ) assert manager.backup_task is not None assert progress == [] @@ -73,6 +75,7 @@ async def _mock_backup_generation( "version": "2025.1.0", }, "name": name, + "protected": bool(password), "slug": ANY, "type": "partial", } @@ -199,6 +202,7 @@ async def test_async_create_backup_when_backing_up(hass: HomeAssistant) -> None: folders_included=[], name=None, on_progress=None, + password=None, ) event.set() @@ -206,7 +210,12 @@ async def test_async_create_backup_when_backing_up(hass: HomeAssistant) -> None: @pytest.mark.usefixtures("mock_backup_generation") @pytest.mark.parametrize( "params", - [{}, {"database_included": True, "name": "abc123"}, {"database_included": False}], + [ + {}, + {"database_included": True, "name": "abc123"}, + {"database_included": False}, + {"password": "abc123"}, + ], ) async def test_async_create_backup( hass: HomeAssistant, @@ -228,6 +237,10 @@ async def test_async_create_backup( assert "Loaded 0 platforms" in caplog.text assert "Loaded 0 agents" in caplog.text + assert len(manager.backups) == 1 + backup = list(manager.backups.values())[0] + assert backup.protected is bool(params.get("password")) + async def test_loading_platforms( hass: HomeAssistant, @@ -351,6 +364,7 @@ async def test_syncing_backup( date=backup.date, homeassistant="2025.1.0", name=backup.name, + protected=backup.protected, size=backup.size, slug=backup.slug, ) @@ -415,6 +429,7 @@ async def test_syncing_backup_with_exception( date=backup.date, homeassistant="2025.1.0", name=backup.name, + protected=backup.protected, size=backup.size, slug=backup.slug, ) @@ -600,7 +615,32 @@ async def test_async_trigger_restore( patch("homeassistant.core.ServiceRegistry.async_call") as mocked_service_call, ): await manager.async_restore_backup(TEST_BACKUP.slug) - assert mocked_write_text.call_args[0][0] == '{"path": "abc123.tar"}' + assert ( + mocked_write_text.call_args[0][0] + == '{"path": "abc123.tar", "password": null}' + ) + assert mocked_service_call.called + + +async def test_async_trigger_restore_with_password( + hass: HomeAssistant, + caplog: pytest.LogCaptureFixture, +) -> None: + """Test trigger restore.""" + manager = BackupManager(hass) + manager.loaded_backups = True + manager.backups = {TEST_BACKUP.slug: TEST_BACKUP} + + with ( + patch("pathlib.Path.exists", return_value=True), + patch("pathlib.Path.write_text") as mocked_write_text, + patch("homeassistant.core.ServiceRegistry.async_call") as mocked_service_call, + ): + await manager.async_restore_backup(slug=TEST_BACKUP.slug, password="abc123") + assert ( + mocked_write_text.call_args[0][0] + == '{"path": "abc123.tar", "password": "abc123"}' + ) assert mocked_service_call.called diff --git a/tests/components/backup/test_websocket.py b/tests/components/backup/test_websocket.py index 5fee1870c10..8e130b1bceb 100644 --- a/tests/components/backup/test_websocket.py +++ b/tests/components/backup/test_websocket.py @@ -1,6 +1,7 @@ """Tests for the Backup integration.""" from pathlib import Path +from typing import Any from unittest.mock import ANY, AsyncMock, patch from freezegun.api import FrozenDateTimeFactory @@ -126,6 +127,14 @@ async def test_remove( assert await client.receive_json() == snapshot +@pytest.mark.parametrize( + "data", + [ + None, + {}, + {"password": "abc123"}, + ], +) @pytest.mark.parametrize( ("with_hassio", "number_of_messages"), [ @@ -137,6 +146,7 @@ async def test_remove( async def test_generate( hass: HomeAssistant, hass_ws_client: WebSocketGenerator, + data: dict[str, Any] | None, freezer: FrozenDateTimeFactory, snapshot: SnapshotAssertion, with_hassio: bool, @@ -149,7 +159,7 @@ async def test_generate( freezer.move_to("2024-11-13 12:01:00+01:00") await hass.async_block_till_done() - await client.send_json_auto_id({"type": "backup/generate"}) + await client.send_json_auto_id({"type": "backup/generate", **(data or {})}) for _ in range(number_of_messages): assert await client.receive_json() == snapshot @@ -203,6 +213,7 @@ async def test_generate_without_hassio( "folders_included": None, "name": None, "on_progress": ANY, + "password": None, } | expected_extra_call_params ) diff --git a/tests/test_backup_restore.py b/tests/test_backup_restore.py index 44a05c0540e..7f69d4db728 100644 --- a/tests/test_backup_restore.py +++ b/tests/test_backup_restore.py @@ -19,7 +19,23 @@ from .common import get_test_config_dir ( None, '{"path": "test"}', - backup_restore.RestoreBackupFileContent(backup_file_path=Path("test")), + backup_restore.RestoreBackupFileContent( + backup_file_path=Path("test"), password=None + ), + ), + ( + None, + '{"path": "test", "password": "psw"}', + backup_restore.RestoreBackupFileContent( + backup_file_path=Path("test"), password="psw" + ), + ), + ( + None, + '{"path": "test", "password": null}', + backup_restore.RestoreBackupFileContent( + backup_file_path=Path("test"), password=None + ), ), ], ) @@ -155,15 +171,17 @@ def test_removal_of_current_configuration_when_restoring() -> None: return_value=[x["path"] for x in mock_config_dir], ), mock.patch("pathlib.Path.unlink") as unlink_mock, - mock.patch("shutil.rmtree") as rmtreemock, + mock.patch("shutil.copytree") as copytree_mock, + mock.patch("shutil.rmtree") as rmtree_mock, ): assert backup_restore.restore_backup(config_dir) is True assert unlink_mock.call_count == 2 + assert copytree_mock.call_count == 1 assert ( - rmtreemock.call_count == 1 + rmtree_mock.call_count == 1 ) # We have 2 directories in the config directory, but backups is kept - removed_directories = {Path(call.args[0]) for call in rmtreemock.mock_calls} + removed_directories = {Path(call.args[0]) for call in rmtree_mock.mock_calls} assert removed_directories == {Path(config_dir, "www")} @@ -177,8 +195,8 @@ def test_extracting_the_contents_of_a_backup_file() -> None: getmembers_mock = mock.MagicMock( return_value=[ + tarfile.TarInfo(name="../data/test"), tarfile.TarInfo(name="data"), - tarfile.TarInfo(name="data/../test"), tarfile.TarInfo(name="data/.HA_VERSION"), tarfile.TarInfo(name="data/.storage"), tarfile.TarInfo(name="data/www"), @@ -190,7 +208,7 @@ def test_extracting_the_contents_of_a_backup_file() -> None: mock.patch( "homeassistant.backup_restore.restore_backup_file_content", return_value=backup_restore.RestoreBackupFileContent( - backup_file_path=backup_file_path + backup_file_path=backup_file_path, ), ), mock.patch( @@ -205,11 +223,37 @@ def test_extracting_the_contents_of_a_backup_file() -> None: mock.patch("pathlib.Path.read_text", _patched_path_read_text), mock.patch("pathlib.Path.is_file", return_value=False), mock.patch("pathlib.Path.iterdir", return_value=[]), + mock.patch("shutil.copytree"), ): assert backup_restore.restore_backup(config_dir) is True - assert getmembers_mock.call_count == 1 assert extractall_mock.call_count == 2 assert { member.name for member in extractall_mock.mock_calls[-1].kwargs["members"] - } == {".HA_VERSION", ".storage", "www"} + } == {"data", "data/.HA_VERSION", "data/.storage", "data/www"} + + +@pytest.mark.parametrize( + ("password", "expected"), + [ + ("test", b"\xf0\x9b\xb9\x1f\xdc,\xff\xd5x\xd6\xd6\x8fz\x19.\x0f"), + ("lorem ipsum...", b"#\xe0\xfc\xe0\xdb?_\x1f,$\rQ\xf4\xf5\xd8\xfb"), + ], +) +def test_pw_to_key(password: str | None, expected: bytes | None) -> None: + """Test password to key conversion.""" + assert backup_restore.password_to_key(password) == expected + + +@pytest.mark.parametrize( + ("password", "expected"), + [ + (None, None), + ("test", b"\xf0\x9b\xb9\x1f\xdc,\xff\xd5x\xd6\xd6\x8fz\x19.\x0f"), + ("lorem ipsum...", b"#\xe0\xfc\xe0\xdb?_\x1f,$\rQ\xf4\xf5\xd8\xfb"), + ], +) +def test_pw_to_key_none(password: str | None, expected: bytes | None) -> None: + """Test password to key conversion.""" + with pytest.raises(AttributeError): + backup_restore.password_to_key(None) From e9247fb94b5d22da172ddcfcc682a945c53c1ec6 Mon Sep 17 00:00:00 2001 From: Martin Hjelmare Date: Thu, 14 Nov 2024 13:14:36 +0100 Subject: [PATCH 7/9] Export relevant names from backup integration (#130596) --- homeassistant/components/backup/__init__.py | 9 ++++++--- tests/components/backup/common.py | 9 ++++++--- tests/components/backup/test_manager.py | 9 +++++---- tests/components/backup/test_websocket.py | 2 +- 4 files changed, 18 insertions(+), 11 deletions(-) diff --git a/homeassistant/components/backup/__init__.py b/homeassistant/components/backup/__init__.py index d160b0bd88f..a7cceee05cd 100644 --- a/homeassistant/components/backup/__init__.py +++ b/homeassistant/components/backup/__init__.py @@ -8,16 +8,19 @@ from homeassistant.helpers import config_validation as cv from homeassistant.helpers.hassio import is_hassio from homeassistant.helpers.typing import ConfigType -from .agent import BackupAgent, UploadedBackup +from .agent import BackupAgent, BackupAgentPlatformProtocol, UploadedBackup from .const import DOMAIN, LOGGER from .http import async_register_http_views -from .manager import BackupManager -from .models import BackupUploadMetadata +from .manager import BackupManager, BackupPlatformProtocol +from .models import BackupUploadMetadata, BaseBackup from .websocket import async_register_websocket_handlers __all__ = [ "BackupAgent", + "BackupAgentPlatformProtocol", + "BackupPlatformProtocol", "BackupUploadMetadata", + "BaseBackup", "UploadedBackup", ] diff --git a/tests/components/backup/common.py b/tests/components/backup/common.py index 18f9f28520d..5e2a7c7bf53 100644 --- a/tests/components/backup/common.py +++ b/tests/components/backup/common.py @@ -6,10 +6,13 @@ from pathlib import Path from typing import Any from unittest.mock import patch -from homeassistant.components.backup import DOMAIN -from homeassistant.components.backup.agent import BackupAgent, UploadedBackup +from homeassistant.components.backup import ( + DOMAIN, + BackupAgent, + BackupUploadMetadata, + UploadedBackup, +) from homeassistant.components.backup.manager import Backup -from homeassistant.components.backup.models import BackupUploadMetadata from homeassistant.core import HomeAssistant from homeassistant.helpers.typing import ConfigType from homeassistant.setup import async_setup_component diff --git a/tests/components/backup/test_manager.py b/tests/components/backup/test_manager.py index a15002d217e..ac856ad7d72 100644 --- a/tests/components/backup/test_manager.py +++ b/tests/components/backup/test_manager.py @@ -10,12 +10,13 @@ import aiohttp from multidict import CIMultiDict, CIMultiDictProxy import pytest -from homeassistant.components.backup import BackupManager, BackupUploadMetadata -from homeassistant.components.backup.agent import BackupAgentPlatformProtocol -from homeassistant.components.backup.manager import ( +from homeassistant.components.backup import ( + BackupAgentPlatformProtocol, + BackupManager, BackupPlatformProtocol, - BackupProgress, + BackupUploadMetadata, ) +from homeassistant.components.backup.manager import BackupProgress from homeassistant.core import HomeAssistant from homeassistant.exceptions import HomeAssistantError from homeassistant.setup import async_setup_component diff --git a/tests/components/backup/test_websocket.py b/tests/components/backup/test_websocket.py index 8e130b1bceb..bc8b126aa27 100644 --- a/tests/components/backup/test_websocket.py +++ b/tests/components/backup/test_websocket.py @@ -8,9 +8,9 @@ from freezegun.api import FrozenDateTimeFactory import pytest from syrupy import SnapshotAssertion +from homeassistant.components.backup import BaseBackup from homeassistant.components.backup.const import DATA_MANAGER from homeassistant.components.backup.manager import NewBackup -from homeassistant.components.backup.models import BaseBackup from homeassistant.core import HomeAssistant from homeassistant.exceptions import HomeAssistantError From e8179f7a73154769eeb574f746be3c374c7f7c81 Mon Sep 17 00:00:00 2001 From: Erik Montnemery Date: Thu, 14 Nov 2024 15:49:17 +0100 Subject: [PATCH 8/9] Tweak backup agent interface (#130613) * Tweak backup agent interface * Adjust kitchen_sink --- homeassistant/components/backup/agent.py | 21 +++++++------------ .../components/kitchen_sink/backup.py | 3 ++- tests/components/backup/common.py | 4 ++++ 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/homeassistant/components/backup/agent.py b/homeassistant/components/backup/agent.py index ee636b244cd..8d378b36467 100644 --- a/homeassistant/components/backup/agent.py +++ b/homeassistant/components/backup/agent.py @@ -20,11 +20,9 @@ class UploadedBackup(BaseBackup): class BackupAgent(abc.ABC): - """Define the format that backup agents can have.""" + """Backup agent interface.""" - def __init__(self, name: str) -> None: - """Initialize the backup agent.""" - self.name = name + name: str @abc.abstractmethod async def async_download_backup( @@ -36,9 +34,8 @@ class BackupAgent(abc.ABC): ) -> None: """Download a backup file. - The `id` parameter is the ID of the backup that was returned in async_list_backups. - - The `path` parameter is the full file path to download the backup to. + :param id: The ID of the backup that was returned in async_list_backups. + :param path: The full file path to download the backup to. """ @abc.abstractmethod @@ -51,9 +48,8 @@ class BackupAgent(abc.ABC): ) -> None: """Upload a backup. - The `path` parameter is the full file path to the backup that should be uploaded. - - The `metadata` parameter contains metadata about the backup that should be uploaded. + :param path: The full file path to the backup that should be uploaded. + :param metadata: Metadata about the backup that should be uploaded. """ @abc.abstractmethod @@ -62,12 +58,11 @@ class BackupAgent(abc.ABC): class BackupAgentPlatformProtocol(Protocol): - """Define the format that backup platforms can have.""" + """Define the format of backup platforms which implement backup agents.""" async def async_get_backup_agents( self, - *, hass: HomeAssistant, **kwargs: Any, ) -> list[BackupAgent]: - """Register the backup agent.""" + """Return a list of backup agents.""" diff --git a/homeassistant/components/kitchen_sink/backup.py b/homeassistant/components/kitchen_sink/backup.py index ffbca276680..35c646845a3 100644 --- a/homeassistant/components/kitchen_sink/backup.py +++ b/homeassistant/components/kitchen_sink/backup.py @@ -29,7 +29,8 @@ class KitchenSinkBackupAgent(BackupAgent): def __init__(self, name: str) -> None: """Initialize the kitchen sink backup sync agent.""" - super().__init__(name) + super().__init__() + self.name = name self._uploads = [ UploadedBackup( id="def456", diff --git a/tests/components/backup/common.py b/tests/components/backup/common.py index 5e2a7c7bf53..f13543861ed 100644 --- a/tests/components/backup/common.py +++ b/tests/components/backup/common.py @@ -30,6 +30,10 @@ TEST_BACKUP = Backup( class BackupAgentTest(BackupAgent): """Test backup agent.""" + def __init__(self, name: str) -> None: + """Initialize the backup agent.""" + self.name = name + async def async_download_backup( self, *, From 8fc470b943cc8175d1479fae11930c2172a1e68d Mon Sep 17 00:00:00 2001 From: Martin Hjelmare Date: Thu, 14 Nov 2024 16:03:48 +0100 Subject: [PATCH 9/9] Test kitchen sink backup (#130609) * Test agents_list_backups * Test agents_info * Test agents_download * Export Backup from manager * Test agents_upload * Update tests after rebase * Use backup domain --- homeassistant/components/backup/__init__.py | 3 +- .../components/kitchen_sink/backup.py | 2 +- tests/components/kitchen_sink/test_backup.py | 162 ++++++++++++++++++ 3 files changed, 165 insertions(+), 2 deletions(-) create mode 100644 tests/components/kitchen_sink/test_backup.py diff --git a/homeassistant/components/backup/__init__.py b/homeassistant/components/backup/__init__.py index a7cceee05cd..0b89633dd53 100644 --- a/homeassistant/components/backup/__init__.py +++ b/homeassistant/components/backup/__init__.py @@ -11,11 +11,12 @@ from homeassistant.helpers.typing import ConfigType from .agent import BackupAgent, BackupAgentPlatformProtocol, UploadedBackup from .const import DOMAIN, LOGGER from .http import async_register_http_views -from .manager import BackupManager, BackupPlatformProtocol +from .manager import Backup, BackupManager, BackupPlatformProtocol from .models import BackupUploadMetadata, BaseBackup from .websocket import async_register_websocket_handlers __all__ = [ + "Backup", "BackupAgent", "BackupAgentPlatformProtocol", "BackupPlatformProtocol", diff --git a/homeassistant/components/kitchen_sink/backup.py b/homeassistant/components/kitchen_sink/backup.py index 35c646845a3..f3203781488 100644 --- a/homeassistant/components/kitchen_sink/backup.py +++ b/homeassistant/components/kitchen_sink/backup.py @@ -17,7 +17,7 @@ from homeassistant.core import HomeAssistant LOGGER = logging.getLogger(__name__) -async def async_get_backup_sync_agents( +async def async_get_backup_agents( hass: HomeAssistant, ) -> list[BackupAgent]: """Register the backup agents.""" diff --git a/tests/components/kitchen_sink/test_backup.py b/tests/components/kitchen_sink/test_backup.py new file mode 100644 index 00000000000..1866a1e2e19 --- /dev/null +++ b/tests/components/kitchen_sink/test_backup.py @@ -0,0 +1,162 @@ +"""Test the Kitchen Sink backup platform.""" + +from collections.abc import AsyncGenerator +from pathlib import Path +from unittest.mock import patch +from uuid import UUID + +import pytest + +from homeassistant.components.backup import DOMAIN as BACKUP_DOMAIN, Backup +from homeassistant.components.kitchen_sink import DOMAIN +from homeassistant.core import HomeAssistant +from homeassistant.setup import async_setup_component + +from tests.typing import WebSocketGenerator + + +@pytest.fixture(autouse=True) +async def backup_only() -> AsyncGenerator[None]: + """Enable only the backup platform. + + The backup platform is not an entity platform. + """ + with patch( + "homeassistant.components.kitchen_sink.COMPONENTS_WITH_DEMO_PLATFORM", + [], + ): + yield + + +@pytest.fixture(autouse=True) +async def setup_integration(hass: HomeAssistant) -> AsyncGenerator[None]: + """Set up Kitchen Sink integration.""" + with patch("homeassistant.components.backup.is_hassio", return_value=True): + assert await async_setup_component(hass, BACKUP_DOMAIN, {BACKUP_DOMAIN: {}}) + assert await async_setup_component(hass, DOMAIN, {DOMAIN: {}}) + await hass.async_block_till_done() + yield + + +async def test_agents_info( + hass: HomeAssistant, + hass_ws_client: WebSocketGenerator, +) -> None: + """Test backup agents info.""" + client = await hass_ws_client(hass) + + await client.send_json_auto_id({"type": "backup/agents/info"}) + response = await client.receive_json() + + assert response["success"] + assert response["result"] == { + "agents": [{"agent_id": "kitchen_sink.syncer"}], + "syncing": False, + } + + +async def test_agents_list_backups( + hass: HomeAssistant, + hass_ws_client: WebSocketGenerator, +) -> None: + """Test backup agents list backups.""" + client = await hass_ws_client(hass) + + await client.send_json_auto_id({"type": "backup/agents/list_backups"}) + response = await client.receive_json() + + assert response["success"] + assert response["result"] == [ + { + "agent_id": "kitchen_sink.syncer", + "date": "1970-01-01T00:00:00Z", + "id": "def456", + "slug": "abc123", + "size": 1234, + "name": "Kitchen sink syncer", + "protected": False, + } + ] + + +async def test_agents_download( + hass: HomeAssistant, + hass_ws_client: WebSocketGenerator, + caplog: pytest.LogCaptureFixture, +) -> None: + """Test backup agents download.""" + client = await hass_ws_client(hass) + backup_id = "def456" + slug = "abc123" + + await client.send_json_auto_id( + { + "type": "backup/agents/download", + "slug": slug, + "agent_id": "kitchen_sink.syncer", + "backup_id": backup_id, + } + ) + response = await client.receive_json() + + assert response["success"] + path = hass.config.path(f"backup/{slug}.tar") + assert f"Downloading backup {backup_id} to {path}" in caplog.text + + +async def test_agents_upload( + hass: HomeAssistant, + hass_ws_client: WebSocketGenerator, + caplog: pytest.LogCaptureFixture, + hass_supervisor_access_token: str, +) -> None: + """Test backup agents upload.""" + client = await hass_ws_client(hass, hass_supervisor_access_token) + slug = "test-backup" + test_backup = Backup( + slug=slug, + name="Test", + date="1970-01-01T00:00:00.000Z", + path=Path(hass.config.path(f"backups/{slug}.tar")), + size=0.0, + protected=False, + ) + uuid = UUID(int=123456) + + with ( + patch("homeassistant.components.kitchen_sink.backup.uuid4", return_value=uuid), + patch( + "homeassistant.components.backup.manager.BackupManager.async_get_backup", + ) as fetch_backup, + ): + fetch_backup.return_value = test_backup + await client.send_json_auto_id( + { + "type": "backup/upload", + "data": { + "slug": slug, + }, + } + ) + response = await client.receive_json() + + assert response["success"] + backup_name = f"{slug}.tar" + assert f"Uploading backup {backup_name}" in caplog.text + + with patch("homeassistant.components.kitchen_sink.backup.uuid4", return_value=uuid): + await client.send_json_auto_id({"type": "backup/agents/list_backups"}) + response = await client.receive_json() + + assert response["success"] + backup_list = response["result"] + assert len(backup_list) == 2 + assert backup_list[1] == { + "agent_id": "kitchen_sink.syncer", + "date": test_backup.date, + "id": uuid.hex, + "slug": slug, + "size": 0.0, + "name": test_backup.name, + "protected": test_backup.protected, + }