raise BackupAgentUnreachableError when NAS is unavailable

homeassistant/components/backup/__init__.py

@@ -14,6 +14,7 @@ from .agent import (
     BackupAgent,
     BackupAgentError,
     BackupAgentPlatformProtocol,
+    BackupAgentUnreachableError,
     LocalBackupAgent,
 )
 from .config import BackupConfig, CreateBackupParametersDict
@@ -49,6 +50,7 @@ __all__ = [
     "BackupAgent",
     "BackupAgentError",
     "BackupAgentPlatformProtocol",
+    "BackupAgentUnreachableError",
     "BackupConfig",
     "BackupManagerError",
     "BackupNotFound",

homeassistant/components/synology_dsm/backup.py

@@ -8,12 +8,16 @@ from typing import TYPE_CHECKING, Any
 
 from aiohttp import StreamReader
 from synology_dsm.api.file_station import SynoFileStation
-from synology_dsm.exceptions import SynologyDSMAPIErrorException
+from synology_dsm.exceptions import (
+    SynologyDSMAPIErrorException,
+    SynologyDSMRequestException,
+)
 
 from homeassistant.components.backup import (
     AgentBackup,
     BackupAgent,
     BackupAgentError,
+    BackupAgentUnreachableError,
     BackupNotFound,
     suggested_filename,
 )
@@ -238,6 +242,8 @@ class SynologyDSMBackupAgent(BackupAgent):
             files = await self._file_station.get_files(path=self.path)
         except SynologyDSMAPIErrorException as err:
             raise BackupAgentError("Failed to list backups") from err
+        except SynologyDSMRequestException as err:
+            raise BackupAgentUnreachableError from err
 
         if TYPE_CHECKING:
             assert files

tests/components/synology_dsm/test_backup.py

@@ -4,9 +4,14 @@ from io import StringIO
 from typing import Any
 from unittest.mock import ANY, AsyncMock, MagicMock, Mock, patch
 
+from aiohttp import ClientError
 import pytest
 from synology_dsm.api.file_station.models import SynoFileFile, SynoFileSharedFolder
-from synology_dsm.exceptions import SynologyDSMAPIErrorException
+from synology_dsm.exceptions import (
+    SynologyDSMAPIErrorException,
+    SynologyDSMException,
+    SynologyDSMRequestException,
+)
 
 from homeassistant.components.backup import (
     DOMAIN as BACKUP_DOMAIN,
@@ -315,26 +320,37 @@ async def test_agents_list_backups(
     ]
 
 
+@pytest.mark.parametrize(
+    ("error", "expected_aget_errors"),
+    [
+        (
+            SynologyDSMAPIErrorException("api", "500", "error"),
+            {"synology_dsm.mocked_syno_dsm_entry": "Failed to list backups"},
+        ),
+        (
+            SynologyDSMRequestException(ClientError("error")),
+            {"synology_dsm.mocked_syno_dsm_entry": "The backup agent is unreachable."},
+        ),
+    ],
+)
 async def test_agents_list_backups_error(
     hass: HomeAssistant,
     setup_dsm_with_filestation: MagicMock,
     hass_ws_client: WebSocketGenerator,
+    error: SynologyDSMException,
+    expected_aget_errors: dict[str, str],
 ) -> None:
     """Test agent error while list backups."""
     client = await hass_ws_client(hass)
 
-    setup_dsm_with_filestation.file.get_files.side_effect = (
-        SynologyDSMAPIErrorException("api", "500", "error")
-    )
+    setup_dsm_with_filestation.file.get_files.side_effect = error
 
     await client.send_json_auto_id({"type": "backup/info"})
     response = await client.receive_json()
 
     assert response["success"]
     assert response["result"] == {
-        "agent_errors": {
-            "synology_dsm.mocked_syno_dsm_entry": "Failed to list backups"
-        },
+        "agent_errors": expected_aget_errors,
         "backups": [],
         "last_attempted_automatic_backup": None,
         "last_completed_automatic_backup": None,