Implement basic Hetzner API support for storagebox_subaccount[_info] (#169)

* Implement basic Hetzner API support for storagebox_subaccount_info.

* Add changelog.

* Add IDs to snapshot test.

* Remove superfluous no_log.

* Implement basic Hetzner API support for storagebox_subaccount.

* Improve creation of snapshots and subaccounts by returning the created object.

Author: felixfontein

antsibull-nox.toml

@@ -48,10 +48,7 @@ doc_fragment = "community.hrobot.attributes.actiongroup_robot"
 [[sessions.extra_checks.action_groups_config]]
 name = "api"
 pattern = "^storagebox.*$"
-exclusions = [
-    "storagebox_subaccount_info",
-    "storagebox_subaccount",
-]
+exclusions = []
 doc_fragment = "community.hrobot.attributes.actiongroup_api"
 
 [sessions.build_import_check]

changelogs/fragments/166-storagebox.yml

@@ -16,4 +16,5 @@ minor_changes:
     the Robot API for storage boxes is removed by Hetzner
     (https://github.com/ansible-collections/community.hrobot/pull/166,
      https://github.com/ansible-collections/community.hrobot/pull/167,
-     https://github.com/ansible-collections/community.hrobot/pull/168).
+     https://github.com/ansible-collections/community.hrobot/pull/168,
+     https://github.com/ansible-collections/community.hrobot/pull/169).

changelogs/fragments/169-storagebox.yml

@@ -0,0 +1,4 @@
+minor_changes:
+  - "storagebox_subaccount - support the new Hetzner API (https://github.com/ansible-collections/community.hrobot/pull/168)."
+  - "storagebox_subaccount - no longer mark ``password_mode`` as ``no_log`` (https://github.com/ansible-collections/community.hrobot/pull/168)."
+  - "storagebox_subaccount_info - support the new Hetzner API (https://github.com/ansible-collections/community.hrobot/pull/168)."

meta/runtime.yml

@@ -36,3 +36,5 @@ action_groups:
     - storagebox_snapshot_info
     - storagebox_snapshot_plan
     - storagebox_snapshot_plan_info
+    - storagebox_subaccount
+    - storagebox_subaccount_info

plugins/module_utils/api.py

@@ -257,7 +257,9 @@ def api_fetch_url_json_with_retries(module, url, check_done_callback, check_done
 
 
 class ApplyActionError(Exception):
-    pass
+    def __init__(self, msg, extracted_ids=None):
+        super(ApplyActionError, self).__init__(msg)
+        self.extracted_ids = extracted_ids or {}
 
 
 def api_apply_action(
@@ -280,8 +282,11 @@ def api_apply_action(
         accept_errors=accept_errors,
     )
     if error:
-        return error
+        return None, error
     action_id = result["action"]["id"]
+    extracted_ids = {
+        res["type"]: res["id"] for res in result["action"]["resources"] or [] if res.get("id") is not None and res.get("type")
+    }
     if result["action"]["status"] == "running":
         this_action_url = action_check_url_provider(action_id)
 
@@ -295,10 +300,10 @@ def action_done_callback(result_, info_, error_):
                 module, this_action_url, action_done_callback, check_done_delay=1, check_done_timeout=60, skip_first=True,
             )
         except CheckDoneTimeoutException as dummy:
-            raise ApplyActionError("Timeout")
+            raise ApplyActionError("Timeout", extracted_ids=extracted_ids)
     error = result["action"].get("error")
     if isinstance(error, dict):
-        raise ApplyActionError('[{0}] {1}'.format(to_native(error.get("code")), to_native(error.get("message"))))
+        raise ApplyActionError('[{0}] {1}'.format(to_native(error.get("code")), to_native(error.get("message"))), extracted_ids=extracted_ids)
     elif result["action"]["status"] == "error":
-        raise ApplyActionError('Unknown error')
-    return None
+        raise ApplyActionError('Unknown error', extracted_ids=extracted_ids)
+    return extracted_ids, None

plugins/modules/storagebox_set_password.py

@@ -147,7 +147,7 @@ def main():
             "password": password,
         }
         try:
-            error = api_apply_action(
+            dummy, error = api_apply_action(
                 module,
                 action_url,
                 action,

plugins/modules/storagebox_snapshot.py

@@ -85,9 +85,8 @@
 RETURN = r"""
 snapshot:
   description:
-    - The snapshot that was created if O(hetzner_user) is provided.
-    - The snapshot that was updated if O(hetzner_token) is provided.
-  returned: success and O(state=present); if O(hetzner_token) is provided and O(snapshot_name) not, this will not be returned
+    - The snapshot that was created or updated.
+  returned: success and O(state=present)
   type: dict
   contains:
     name:
@@ -224,7 +223,7 @@ def main():
             if snapshot_comment:
                 action["description"] = snapshot_comment
             try:
-                error = api_apply_action(
+                extracted_ids, error = api_apply_action(
                     module,
                     action_url,
                     action,
@@ -239,7 +238,12 @@ def main():
             if error == "not_found":
                 module.fail_json(msg="Storagebox with ID {0} does not exist".format(storagebox_id))
 
-            module.exit_json(changed=True)
+            new_snapshot_id = extracted_ids["storage_box_snapshot"]
+            # Retrieve created snapshot
+            url = "{0}/v1/storage_boxes/{1}/snapshots/{2}".format(API_BASE_URL, storagebox_id, new_snapshot_id)
+            snapshot = api_fetch_url_json(module, url, method='GET')[0]["snapshot"]
+
+            module.exit_json(changed=True, snapshot=extract_legacy(snapshot))
 
         # Update snapshot comment
         elif state == 'present' and snapshot_name: