From ec0cef0611902ceb9de037503c557912c3b31f82 Mon Sep 17 00:00:00 2001
From: Erik Montnemery <erik@montnemery.com>
Date: Tue, 11 Feb 2025 09:47:09 +0100
Subject: [PATCH] Unify error reporting in onboarding backup API (#138200)

---
 homeassistant/components/onboarding/views.py |  4 +--
 tests/components/onboarding/test_views.py    | 26 +++++++++++++-------
 2 files changed, 19 insertions(+), 11 deletions(-)

diff --git a/homeassistant/components/onboarding/views.py b/homeassistant/components/onboarding/views.py
index 1e29860e3c5..2d4b44a73cd 100644
--- a/homeassistant/components/onboarding/views.py
+++ b/homeassistant/components/onboarding/views.py
@@ -357,7 +357,7 @@ def with_backup_manager[_ViewT: BackupOnboardingView, **_P](
             manager = async_get_backup_manager(request.app[KEY_HASS])
         except HomeAssistantError:
             return self.json(
-                {"error": "backup_disabled"},
+                {"code": "backup_disabled"},
                 status_code=HTTPStatus.INTERNAL_SERVER_ERROR,
             )
 
@@ -420,7 +420,7 @@ class RestoreBackupView(BackupOnboardingView):
             )
         except IncorrectPasswordError:
             return self.json(
-                {"message": "incorrect_password"}, status_code=HTTPStatus.BAD_REQUEST
+                {"code": "incorrect_password"}, status_code=HTTPStatus.BAD_REQUEST
             )
         return web.Response(status=HTTPStatus.OK)
 
diff --git a/tests/components/onboarding/test_views.py b/tests/components/onboarding/test_views.py
index 98f6426609e..003a137738d 100644
--- a/tests/components/onboarding/test_views.py
+++ b/tests/components/onboarding/test_views.py
@@ -777,7 +777,7 @@ async def test_onboarding_backup_view_without_backup(
     resp = await client.request(method, f"/api/onboarding/{view}", **kwargs)
 
     assert resp.status == 500
-    assert await resp.json() == {"error": "backup_disabled"}
+    assert await resp.json() == {"code": "backup_disabled"}
 
 
 async def test_onboarding_backup_info(
@@ -920,14 +920,16 @@ async def test_onboarding_backup_restore(
 
 
 @pytest.mark.parametrize(
-    ("params", "restore_error", "expected_status", "expected_message", "restore_calls"),
+    ("params", "restore_error", "expected_status", "expected_json", "restore_calls"),
     [
         # Missing agent_id
         (
             {"backup_id": "abc123"},
             None,
             400,
-            "Message format incorrect: required key not provided @ data['agent_id']",
+            {
+                "message": "Message format incorrect: required key not provided @ data['agent_id']"
+            },
             0,
         ),
         # Missing backup_id
@@ -935,7 +937,9 @@ async def test_onboarding_backup_restore(
             {"agent_id": "backup.local"},
             None,
             400,
-            "Message format incorrect: required key not provided @ data['backup_id']",
+            {
+                "message": "Message format incorrect: required key not provided @ data['backup_id']"
+            },
             0,
         ),
         # Invalid restore_database
@@ -947,7 +951,9 @@ async def test_onboarding_backup_restore(
             },
             None,
             400,
-            "Message format incorrect: expected bool for dictionary value @ data['restore_database']",
+            {
+                "message": "Message format incorrect: expected bool for dictionary value @ data['restore_database']"
+            },
             0,
         ),
         # Invalid folder
@@ -959,7 +965,9 @@ async def test_onboarding_backup_restore(
             },
             None,
             400,
-            "Message format incorrect: expected Folder or one of 'share', 'addons/local', 'ssl', 'media' @ data['restore_folders'][0]",
+            {
+                "message": "Message format incorrect: expected Folder or one of 'share', 'addons/local', 'ssl', 'media' @ data['restore_folders'][0]"
+            },
             0,
         ),
         # Wrong password
@@ -967,7 +975,7 @@ async def test_onboarding_backup_restore(
             {"backup_id": "abc123", "agent_id": "backup.local"},
             backup.IncorrectPasswordError,
             400,
-            "incorrect_password",
+            {"code": "incorrect_password"},
             1,
         ),
     ],
@@ -979,7 +987,7 @@ async def test_onboarding_backup_restore_error(
     params: dict[str, Any],
     restore_error: Exception | None,
     expected_status: int,
-    expected_message: str,
+    expected_json: str,
     restore_calls: int,
 ) -> None:
     """Test returning installation type during onboarding."""
@@ -998,7 +1006,7 @@ async def test_onboarding_backup_restore_error(
         resp = await client.post("/api/onboarding/backup/restore", json=params)
 
     assert resp.status == expected_status
-    assert await resp.json() == {"message": expected_message}
+    assert await resp.json() == expected_json
     assert len(mock_restore.mock_calls) == restore_calls