Add exception group and test timeout

Author: jooola

hcloud/actions/__init__.py

@@ -10,6 +10,7 @@
     Action,
     ActionException,
     ActionFailedException,
+    ActionGroupException,
     ActionTimeoutException,
 )
 
@@ -18,6 +19,7 @@
     "ActionException",
     "ActionFailedException",
     "ActionTimeoutException",
+    "ActionGroupException",
     "ActionsClient",
     "ActionsPageResult",
     "BoundAction",

hcloud/actions/client.py

@@ -5,7 +5,12 @@
 
 from .._utils import batched, waiter
 from ..core import BoundModelBase, ClientEntityBase, Meta
-from .domain import Action, ActionFailedException, ActionTimeoutException
+from .domain import (
+    Action,
+    ActionFailedException,
+    ActionGroupException,
+    ActionTimeoutException,
+)
 
 if TYPE_CHECKING:
     from .._client import Client
@@ -193,25 +198,25 @@ def wait_for_function(
         :raises: ActionFailedException when an Action failed.
         :return: List of succeeded Actions.
         """
-        running_ids = [a.id for a in actions]
-
+        running: list[BoundAction] = list(actions)
         completed: list[BoundAction] = []
 
         retries = 0
         wait = waiter(timeout)
-        while len(running_ids):
+        while len(running):
             # pylint: disable=protected-access
             if wait(self._client._poll_interval_func(retries)):
-                # TODO: How to raise a timeout exception for many actions without using an exception group.
-                raise ActionTimeoutException("")
+                raise ActionGroupException(
+                    [ActionTimeoutException(action=action) for action in running]
+                )
 
             retries += 1
 
-            updates = self._get_list_by_ids(running_ids)
+            running = self._get_list_by_ids([a.id for a in running])
 
-            for update in updates:
+            for update in running:
                 if update.status != Action.STATUS_RUNNING:
-                    running_ids.remove(update.id)
+                    running.remove(update)
                     completed.append(update)
 
                 handle_update(update)

hcloud/actions/domain.py

@@ -98,3 +98,11 @@ class ActionFailedException(ActionException):
 
 class ActionTimeoutException(ActionException):
     """The pending action timed out"""
+
+
+class ActionGroupException(HCloudException):
+    """An exception for a group of actions"""
+
+    def __init__(self, exceptions: list[ActionException]):
+        super().__init__("Multiple pending actions failed")
+        self.exceptions = exceptions

tests/unit/actions/test_client.py

@@ -7,6 +7,7 @@
 from hcloud.actions import (
     Action,
     ActionFailedException,
+    ActionGroupException,
     ActionsClient,
     ActionTimeoutException,
     BoundAction,
@@ -258,3 +259,29 @@ def test_wait_for_error(self, actions_client: ActionsClient):
                 mock.call(method="GET", url="/actions", params={"id": (1, 2)}),
             ]
         )
+
+    def test_wait_for_timeout(self, actions_client: ActionsClient):
+        actions = [
+            Action(id=1, status="running", command="create_server"),
+            Action(id=2, status="running", command="start_server"),
+        ]
+
+        # Speed up test by not really waiting
+        actions_client._client._poll_interval_func = mock.MagicMock()
+        actions_client._client._poll_interval_func.return_value = 0.1
+
+        actions_client._client.request.return_value = {
+            "actions": [
+                {"id": 1, "status": "running", "command": "create_server"},
+                {"id": 2, "status": "running", "command": "start_server"},
+            ]
+        }
+
+        with pytest.raises(ActionGroupException):
+            actions_client.wait_for(actions, timeout=0.2)
+
+        actions_client._client.request.assert_has_calls(
+            [
+                mock.call(method="GET", url="/actions", params={"id": (1, 2)}),
+            ]
+        )