feat: include action_id in formatted output of response containing ActionLink

Author: nats

src/binarylane/console/printers/formatter.py

@@ -14,6 +14,7 @@
 def format_response(response: Any, show_header: bool, fields: Optional[List[str]] = None) -> List[List[str]]:
     """Convert structured response object into a 'table' (where the length of each inner list is the same)"""
 
+    action_id: Optional[int] = _get_action_id(response)
     response = _extract_primary(response)
 
     if isinstance(response, list):
@@ -40,6 +41,10 @@ def object_to_list(row: Dict[str, Any], columns: List[str]) -> List[Any]:
         data = [["name", "value"]] if show_header else []
         data += [_flatten(item, True) for item in response.to_dict().items()]
 
+    # If response contained an action ID, prepend it to the formatted data
+    if action_id:
+        data.insert(1 if show_header else 0, ["action_id", str(action_id)])
+
     return data
 
 
@@ -127,3 +132,18 @@ def _flatten_dict(item: Dict[str, Any], single_object: bool) -> str:
 
     # Generic handler
     return "<object>" if not single_object else "\n".join([f"{key}: {value}" for key, value in item.items()])
+
+
+def _get_action_id(response: Any) -> Optional[int]:
+    """Return response.links.actions[0].id or None"""
+
+    if not (links := getattr(response, "links", None)):
+        return None
+
+    if not (actions := getattr(links, "actions", None)) or not isinstance(actions, list):
+        return None
+
+    if not (action_id := getattr(actions[0], "id", None)) or not isinstance(action_id, int):
+        return None
+
+    return action_id

src/binarylane/console/runners/actionlink.py

@@ -16,8 +16,10 @@ def response(self, status_code: int, received: Any) -> None:
             super().response(status_code, received)
             return
 
-        action_id = links.actions[0].id
-        super().response(status_code, action_id)
+        # Show action progress on stdout
+        if not self._async:
+            action_id = links.actions[0].id
+            super().response(status_code, action_id)
 
         # Print the 'other' object (e.g. server) from the response
         self._printer.print(received)

tests/models/create_server_response.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+from typing import Any, Dict, TypeVar
+
+import attr
+
+# We have to use the real ActionsLinks, because handler checks for it by type
+from binarylane.models.actions_links import ActionsLinks
+from tests.models.server import Server
+
+
+@attr.s(auto_attribs=True)
+class CreateServerResponse:
+    server: Server
+    links: ActionsLinks
+    additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict)
+
+    def to_dict(self) -> Dict[str, Any]:
+        server = self.server.to_dict()
+
+        links = self.links.to_dict()
+
+        field_dict: Dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "server": server,
+                "links": links,
+            }
+        )
+
+        return field_dict

tests/printers/test_formatter.py

@@ -2,6 +2,9 @@
 
 from typing import Any, Dict, List
 
+from binarylane.models.action_link import ActionLink
+from binarylane.models.actions_links import ActionsLinks
+from tests.models.create_server_response import CreateServerResponse
 from tests.models.network import Network
 from tests.models.network_type import NetworkType
 from tests.models.servers_response import ServersResponse
@@ -97,3 +100,14 @@ def test_format_networks_v4_and_v6(servers_response: ServersResponse) -> None:
 def test_format_int() -> None:
     assert formatter.format_response(12345, True) == [[formatter.DEFAULT_HEADING], ["12345"]]
     assert formatter.format_response(12345, False) == [["12345"]]
+
+
+def test_format_action_link(servers_response: ServersResponse) -> None:
+    action_link = ActionLink(12345, "create", "https://api.example.com/v2/actions/12345")
+    response = CreateServerResponse(servers_response.servers[0], ActionsLinks([action_link]))
+    assert formatter.format_response(response, True)[:4] == [
+        ["name", "value"],
+        ["action_id", "12345"],
+        ["id", "1"],
+        ["name", "test"],
+    ]