Move backup/* WS commands to the backup integration (#111636)

Revert "Revert "Move backup/* WS commands to the backup integration" (#111136)"

This reverts commit 8f83426895.

tests/components/backup/test_websocket.py

@@ -2,20 +2,43 @@
 from unittest.mock import patch
 
 import pytest
+from syrupy import SnapshotAssertion
 
 from homeassistant.core import HomeAssistant
+from homeassistant.exceptions import HomeAssistantError
 
 from .common import TEST_BACKUP, setup_backup_integration
 
 from tests.typing import WebSocketGenerator
 
 
+@pytest.fixture
+def sync_access_token_proxy(
+    access_token_fixture_name: str,
+    request: pytest.FixtureRequest,
+) -> str:
+    """Non-async proxy for the *_access_token fixture.
+
+    Workaround for https://github.com/pytest-dev/pytest-asyncio/issues/112
+    """
+    return request.getfixturevalue(access_token_fixture_name)
+
+
+@pytest.mark.parametrize(
+    "with_hassio",
+    (
+        pytest.param(True, id="with_hassio"),
+        pytest.param(False, id="without_hassio"),
+    ),
+)
 async def test_info(
     hass: HomeAssistant,
     hass_ws_client: WebSocketGenerator,
+    snapshot: SnapshotAssertion,
+    with_hassio: bool,
 ) -> None:
     """Test getting backup info."""
-    await setup_backup_integration(hass)
+    await setup_backup_integration(hass, with_hassio=with_hassio)
 
     client = await hass_ws_client(hass)
     await hass.async_block_till_done()
@@ -24,21 +47,25 @@ async def test_info(
         "homeassistant.components.backup.websocket.BackupManager.get_backups",
         return_value={TEST_BACKUP.slug: TEST_BACKUP},
     ):
-        await client.send_json({"id": 1, "type": "backup/info"})
-        msg = await client.receive_json()
-
-    assert msg["id"] == 1
-    assert msg["success"]
-    assert msg["result"] == {"backing_up": False, "backups": [TEST_BACKUP.as_dict()]}
+        await client.send_json_auto_id({"type": "backup/info"})
+        assert snapshot == await client.receive_json()
 
 
+@pytest.mark.parametrize(
+    "with_hassio",
+    (
+        pytest.param(True, id="with_hassio"),
+        pytest.param(False, id="without_hassio"),
+    ),
+)
 async def test_remove(
     hass: HomeAssistant,
     hass_ws_client: WebSocketGenerator,
-    caplog: pytest.LogCaptureFixture,
+    snapshot: SnapshotAssertion,
+    with_hassio: bool,
 ) -> None:
     """Test removing a backup file."""
-    await setup_backup_integration(hass)
+    await setup_backup_integration(hass, with_hassio=with_hassio)
 
     client = await hass_ws_client(hass)
     await hass.async_block_till_done()
@@ -46,19 +73,25 @@ async def test_remove(
     with patch(
         "homeassistant.components.backup.websocket.BackupManager.remove_backup",
     ):
-        await client.send_json({"id": 1, "type": "backup/remove", "slug": "abc123"})
-        msg = await client.receive_json()
-
-        assert msg["id"] == 1
-        assert msg["success"]
+        await client.send_json_auto_id({"type": "backup/remove", "slug": "abc123"})
+        assert snapshot == await client.receive_json()
 
 
+@pytest.mark.parametrize(
+    "with_hassio",
+    (
+        pytest.param(True, id="with_hassio"),
+        pytest.param(False, id="without_hassio"),
+    ),
+)
 async def test_generate(
     hass: HomeAssistant,
     hass_ws_client: WebSocketGenerator,
+    snapshot: SnapshotAssertion,
+    with_hassio: bool,
 ) -> None:
-    """Test removing a backup file."""
-    await setup_backup_integration(hass)
+    """Test generating a backup."""
+    await setup_backup_integration(hass, with_hassio=with_hassio)
 
     client = await hass_ws_client(hass)
     await hass.async_block_till_done()
@@ -67,9 +100,130 @@ async def test_generate(
         "homeassistant.components.backup.websocket.BackupManager.generate_backup",
         return_value=TEST_BACKUP,
     ):
-        await client.send_json({"id": 1, "type": "backup/generate"})
-        msg = await client.receive_json()
+        await client.send_json_auto_id({"type": "backup/generate"})
+        assert snapshot == await client.receive_json()
 
-        assert msg["id"] == 1
-        assert msg["success"]
-        assert msg["result"] == TEST_BACKUP.as_dict()
+
+@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_end(
+    hass: HomeAssistant,
+    hass_ws_client: WebSocketGenerator,
+    snapshot: SnapshotAssertion,
+    request: pytest.FixtureRequest,
+    sync_access_token_proxy: str,
+    *,
+    access_token_fixture_name: str,
+    with_hassio: bool,
+) -> None:
+    """Test handling of post 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.websocket.BackupManager.post_backup_actions",
+    ):
+        await client.send_json_auto_id({"type": "backup/end"})
+        assert snapshot == await client.receive_json()
+
+
+@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_start(
+    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.websocket.BackupManager.pre_backup_actions",
+    ):
+        await client.send_json_auto_id({"type": "backup/start"})
+        assert snapshot == await client.receive_json()
+
+
+@pytest.mark.parametrize(
+    "exception",
+    (
+        TimeoutError(),
+        HomeAssistantError("Boom"),
+        Exception("Boom"),
+    ),
+)
+async def test_backup_end_excepion(
+    hass: HomeAssistant,
+    hass_ws_client: WebSocketGenerator,
+    snapshot: SnapshotAssertion,
+    hass_supervisor_access_token: str,
+    exception: Exception,
+) -> None:
+    """Test exception handling while running post backup actions 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.websocket.BackupManager.post_backup_actions",
+        side_effect=exception,
+    ):
+        await client.send_json_auto_id({"type": "backup/end"})
+        assert snapshot == await client.receive_json()
+
+
+@pytest.mark.parametrize(
+    "exception",
+    (
+        TimeoutError(),
+        HomeAssistantError("Boom"),
+        Exception("Boom"),
+    ),
+)
+async def test_backup_start_excepion(
+    hass: HomeAssistant,
+    hass_ws_client: WebSocketGenerator,
+    snapshot: SnapshotAssertion,
+    hass_supervisor_access_token: str,
+    exception: Exception,
+) -> None:
+    """Test exception handling while running pre backup actions 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.websocket.BackupManager.pre_backup_actions",
+        side_effect=exception,
+    ):
+        await client.send_json_auto_id({"type": "backup/start"})
+        assert snapshot == await client.receive_json()