Add ActionGroupSetupNotFoundException and DuplicateActionOnDeviceException (#1919)

This pull request enhances error handling in the Overkiz client by
introducing two new custom exceptions and updating the response checking
logic to catch and raise these exceptions based on specific API error
messages. Additionally, it refines and clarifies the error message
comments for better maintainability.

**Error handling improvements:**

* Added two new exception classes, `DuplicateActionOnDeviceException`
and `ActionGroupSetupNotFoundException`, to `pyoverkiz/exceptions.py`
for handling specific API error cases.
* Updated `pyoverkiz/client.py` to import the new exceptions.
* Modified the `check_response` function in `pyoverkiz/client.py` to
detect error messages indicating a duplicate action on a device or a
missing action group setup, and to raise the corresponding new
exceptions.

**Documentation and code clarity:**

* Updated comments in `check_response` to use consistent JSON-style
formatting for API error messages, improving readability and
maintainability.
[[1]](diffhunk://#diff-11513003e65960c0b1a4bccb3c6bf2b7dea08c03923a8e53b8dea1a05f213aa2L876-R885)
[[2]](diffhunk://#diff-11513003e65960c0b1a4bccb3c6bf2b7dea08c03923a8e53b8dea1a05f213aa2L892-R921)
[[3]](diffhunk://#diff-11513003e65960c0b1a4bccb3c6bf2b7dea08c03923a8e53b8dea1a05f213aa2L935-R944)

Fixes #1918

Author: iMicknl

pyoverkiz/client.py

@@ -42,9 +42,11 @@
 from pyoverkiz.enums import APIType, Server
 from pyoverkiz.exceptions import (
     AccessDeniedToGatewayException,
+    ActionGroupSetupNotFoundException,
     BadCredentialsException,
     CozyTouchBadCredentialsException,
     CozyTouchServiceException,
+    DuplicateActionOnDeviceException,
     ExecutionQueueFullException,
     InvalidCommandException,
     InvalidEventListenerIdException,
@@ -860,8 +862,15 @@ async def check_response(response: ClientResponse) -> None:
             # An error message can have an empty (None) message
             message = message.strip('".') if (message := result.get("error")) else ""
 
-            # {"errorCode": "AUTHENTICATION_ERROR",
-            # "error": "Too many requests, try again later : login with xxx@xxx.tld"}
+            # {"errorCode": "DUPLICATE_FIELD_OR_VALUE", "error": "Another action exists on the same device : rts://1234-5689-1234/123456"}
+            if message.startswith("Another action exists on the same device"):
+                raise DuplicateActionOnDeviceException(message)
+
+            # {"errorCode": "INVALID_FIELD_VALUE", "error": "Unable to determine action group setup (no setup for gateway #1234-5678-1234)"}
+            if message.startswith("Unable to determine action group setup"):
+                raise ActionGroupSetupNotFoundException(message)
+
+            # {"errorCode": "AUTHENTICATION_ERROR", "error": "Too many requests, try again later : login with xxx@xxx.tld"}
             if "Too many requests" in message:
                 raise TooManyRequestsException(message)
 
@@ -873,7 +882,7 @@ async def check_response(response: ClientResponse) -> None:
             if message == "Not authenticated":
                 raise NotAuthenticatedException(message)
 
-            # {'errorCode': 'AUTHENTICATION_ERROR', 'error': 'An API key is required to access this setup'}
+            # {"errorCode": "AUTHENTICATION_ERROR", "error": "An API key is required to access this setup"}
             if message == "An API key is required to access this setup":
                 raise MissingAPIKeyException(message)
 
@@ -889,27 +898,27 @@ async def check_response(response: ClientResponse) -> None:
             if "No such command" in message:
                 raise InvalidCommandException(message)
 
-            # {'errorCode': 'UNSPECIFIED_ERROR', 'error': 'Invalid event listener id : ...'}
+            # {"errorCode": "UNSPECIFIED_ERROR", "error": "Invalid event listener id : ..."}
             if "Invalid event listener id" in message:
                 raise InvalidEventListenerIdException(message)
 
-            # {'errorCode': 'UNSPECIFIED_ERROR', 'error': 'No registered event listener'}
+            # {"errorCode": "UNSPECIFIED_ERROR", "error": "No registered event listener"}
             if message == "No registered event listener":
                 raise NoRegisteredEventListenerException(message)
 
-            # {'errorCode': 'AUTHENTICATION_ERROR', 'error': 'No such user account : xxxxx'}
+            # {"errorCode": "AUTHENTICATION_ERROR", "error": "No such user account : xxxxx"}
             if "No such user account" in message:
                 raise UnknownUserException(message)
 
-            # {'errorCode': 'INVALID_API_CALL', 'error': 'No such resource'}
+            # {"errorCode": "INVALID_API_CALL", "error": "No such resource"}
             if message == "No such resource":
                 raise NoSuchResourceException(message)
 
             # {"errorCode": "RESOURCE_ACCESS_DENIED",  "error": "too many concurrent requests"}
             if message == "too many concurrent requests":
                 raise TooManyConcurrentRequestsException(message)
 
-            # {'errorCode': 'EXEC_QUEUE_FULL', 'error': 'Execution queue is full on gateway: #xxx-yyyy-zzzz (soft limit: 10)'}
+            # {"errorCode": "EXEC_QUEUE_FULL", "error": "Execution queue is full on gateway: #xxx-yyyy-zzzz (soft limit: 10)"}
             if "Execution queue is full on gateway" in message:
                 raise ExecutionQueueFullException(message)
 
@@ -932,7 +941,7 @@ async def check_response(response: ClientResponse) -> None:
             if message == "Unknown object":
                 raise UnknownObjectException(message)
 
-            # {'errorCode': 'RESOURCE_ACCESS_DENIED', 'error': 'Access denied to gateway #1234-5678-1234 for action ADD_TOKEN'}
+            # {"errorCode": "RESOURCE_ACCESS_DENIED", "error": "Access denied to gateway #1234-5678-1234 for action ADD_TOKEN"}
             if "Access denied to gateway" in message:
                 raise AccessDeniedToGatewayException(message)
 

pyoverkiz/exceptions.py

@@ -17,6 +17,14 @@ class InvalidCommandException(BaseOverkizException):
     """Raised when an invalid command is provided."""
 
 
+class DuplicateActionOnDeviceException(BaseOverkizException):
+    """Raised when another action already exists for the same device."""
+
+
+class ActionGroupSetupNotFoundException(BaseOverkizException):
+    """Raised when an action group setup cannot be determined for a gateway."""
+
+
 class NoSuchResourceException(BaseOverkizException):
     """Raised when an invalid API call is made."""
 

tests/fixtures/exceptions/local/400-action-group-setup-not-found.json

@@ -0,0 +1,4 @@
+{
+    "error": "Unable to determine action group setup (no setup for gateway #1234-5678-1234)",
+    "errorCode": "INVALID_FIELD_VALUE"
+}

tests/fixtures/exceptions/local/400-duplicate-action-on-device.json

@@ -0,0 +1,4 @@
+{
+    "error": "Another action exists on the same device : rts://1234-5678-1234/123456",
+    "errorCode": "DUPLICATE_FIELD_OR_VALUE"
+}

tests/test_client.py

@@ -311,6 +311,16 @@ async def test_get_diagnostic_data(self, client: OverkizClient, fixture_name: st
                 exceptions.OverkizException,
                 400,
             ),
+            (
+                "local/400-duplicate-action-on-device.json",
+                exceptions.DuplicateActionOnDeviceException,
+                400,
+            ),
+            (
+                "local/400-action-group-setup-not-found.json",
+                exceptions.ActionGroupSetupNotFoundException,
+                400,
+            ),
             (
                 "local/400-no-registered-event-listener.json",
                 exceptions.NoRegisteredEventListenerException,