Introduce Update logic specific exceptions

Add Update specific exceptions and raise them where appropriate.

Author: agners

matter_server/common/errors.py

@@ -77,6 +77,18 @@ class InvalidCommand(MatterError):
     error_code = 9
 
 
+class UpdateCheckError(MatterError):
+    """Error raised when there was an error during searching for updates."""
+
+    error_code = 10
+
+
+class UpdateError(MatterError):
+    """Error raised when there was an error during applying updates."""
+
+    error_code = 11
+
+
 def exception_from_error_code(error_code: int) -> type[MatterError]:
     """Return correct Exception class from error_code."""
     return ERROR_MAP.get(error_code, MatterError)

matter_server/server/device_controller.py

@@ -43,6 +43,8 @@
     NodeNotExists,
     NodeNotReady,
     NodeNotResolving,
+    UpdateCheckError,
+    UpdateError,
 )
 from ..common.helpers.api import api_command
 from ..common.helpers.json import JSON_DECODE_EXCEPTIONS, json_loads
@@ -921,19 +923,15 @@ async def update_node(self, node_id: int, software_version: int) -> dict | None:
 
         update = await self._check_node_update(node_id, software_version)
         if update is None:
-            logging.error(
-                "Software version %d is not available for node %d",
-                software_version,
-                node_id,
+            raise UpdateCheckError(
+                f"Software version {software_version} is not available for node {node_id}."
             )
-            return None
 
         if self.chip_controller is None:
             raise RuntimeError("Device Controller not initialized.")
 
         if not self._ota_provider:
-            LOGGER.warning("No OTA provider found, updates not possible.")
-            return None
+            raise UpdateError("No OTA provider found, updates not possible.")
 
         # Add update to the OTA provider
         await self._ota_provider.download_update(update)
@@ -1011,26 +1009,33 @@ async def update_node(self, node_id: int, software_version: int) -> dict | None:
                     )
                 )
                 if write_result[0].Status != Status.Success:
-                    logging.error("Failed writing adjusted OTA Provider App ACL.")
+                    logging.error(
+                        "Failed writing adjusted OTA Provider App ACL: Status %s.",
+                        str(write_result[0].Status),
+                    )
                     await self.remove_node(ota_provider_node_id)
-                    return None
+                    raise UpdateError("Error while setting up OTA Provider.")
             except ChipStackError as ex:
                 logging.exception("Failed adjusting OTA Provider App ACL.", exc_info=ex)
                 await self.remove_node(ota_provider_node_id)
-            else:
-                self._ota_provider.set_node_id(ota_provider_node_id)
+                raise UpdateError("Error while setting up OTA Provider.") from ex
+
+            self._ota_provider.set_node_id(ota_provider_node_id)
 
         # Notify node about the new update!
-        await self.chip_controller.SendCommand(
-            nodeid=node_id,
-            endpoint=0,
-            payload=Clusters.OtaSoftwareUpdateRequestor.Commands.AnnounceOTAProvider(
-                providerNodeID=ota_provider_node_id,
-                vendorID=0,  # TODO: Use Server Vendor ID
-                announcementReason=Clusters.OtaSoftwareUpdateRequestor.Enums.AnnouncementReasonEnum.kUpdateAvailable,
+        try:
+            await self.chip_controller.SendCommand(
+                nodeid=node_id,
                 endpoint=0,
-            ),
-        )
+                payload=Clusters.OtaSoftwareUpdateRequestor.Commands.AnnounceOTAProvider(
+                    providerNodeID=ota_provider_node_id,
+                    vendorID=self.server.vendor_id,
+                    announcementReason=Clusters.OtaSoftwareUpdateRequestor.Enums.AnnouncementReasonEnum.kUpdateAvailable,
+                    endpoint=ExternalOtaProvider.ENDPOINT_ID,
+                ),
+            )
+        except ChipStackError as ex:
+            raise UpdateError("Error while announcing OTA Provider to node.") from ex
 
         return update
 
@@ -1062,8 +1067,7 @@ async def _check_node_update(
             return None
 
         if "otaUrl" not in update:
-            node_logger.warning("Update found, but no OTA URL provided.")
-            return None
+            raise UpdateCheckError("Update found, but no OTA URL provided.")
 
         node_logger.info(
             "New software update found: %s (current %s).",

matter_server/server/ota/dcl.py

@@ -5,6 +5,7 @@
 
 from aiohttp import ClientError, ClientSession
 
+from matter_server.common.errors import UpdateCheckError
 from matter_server.server.helpers import DCL_PRODUCTION_URL
 
 LOGGER = logging.getLogger(__name__)
@@ -92,5 +93,4 @@ async def check_for_update(
         return None
 
     except (ClientError, TimeoutError) as err:
-        LOGGER.error("Fetching software version failed: error %s", err, exc_info=err)
-    return None
+        raise UpdateCheckError("Fetching software version failed.") from err

matter_server/server/ota/provider.py

@@ -54,6 +54,8 @@ class ExternalOtaProvider:
     for devices.
     """
 
+    ENDPOINT_ID: Final[int] = 0
+
     def __init__(self, ota_provider_dir: Path) -> None:
         """Initialize the OTA provider."""
         self._ota_provider_dir: Path = ota_provider_dir