Implement basic Hetzner API support for storagebox_snapshot_plan[_info] (#167)

* Implement basic Hetzner API support for storagebox_snapshot_plan[_info].

* Add tests.

Author: felixfontein

antsibull-nox.toml

@@ -51,8 +51,6 @@ pattern = "^storagebox.*$"
 exclusions = [
     "storagebox_set_password",
     "storagebox_snapshot_info",
-    "storagebox_snapshot_plan_info",
-    "storagebox_snapshot_plan",
     "storagebox_snapshot",
     "storagebox_subaccount_info",
     "storagebox_subaccount",

changelogs/fragments/167-storagebox.yml

@@ -0,0 +1,3 @@
+minor_changes:
+  - "storagebox_snapshot_plan - support the new Hetzner API (https://github.com/ansible-collections/community.hrobot/pull/167)."
+  - "storagebox_snapshot_plan_info - support the new Hetzner API (https://github.com/ansible-collections/community.hrobot/pull/167)."

meta/runtime.yml

@@ -31,3 +31,5 @@ action_groups:
   api:
     - storagebox
     - storagebox_info
+    - storagebox_snapshot_plan
+    - storagebox_snapshot_plan_info

plugins/module_utils/api.py

@@ -8,6 +8,7 @@
 __metaclass__ = type
 
 
+from ansible.module_utils.common.text.converters import to_native
 from ansible.module_utils.six import PY3
 from ansible.module_utils.six.moves.urllib.parse import urlencode
 from ansible.module_utils.urls import fetch_url
@@ -248,3 +249,38 @@ def api_fetch_url_json_with_retries(module, url, check_done_callback, check_done
             return result, info, error
         if left_time < check_done_delay:
             raise CheckDoneTimeoutException(result, error)
+
+
+class ApplyActionError(Exception):
+    pass
+
+
+def api_apply_action(module, action_url, action_data, action_check_url_provider, check_done_delay=10, check_done_timeout=180):
+    headers = {"Content-type": "application/json"} if action_data is not None else {}
+    result, dummy, dummy2 = api_fetch_url_json(
+        module,
+        action_url,
+        data=module.jsonify(action_data) if action_data is not None else None,
+        headers=headers,
+        method='POST',
+    )
+    action_id = result["action"]["id"]
+    if result["action"]["status"] == "running":
+        this_action_url = action_check_url_provider(action_id)
+
+        def action_done_callback(result_, info_, error_):
+            if error_ is not None:  # pragma: no cover
+                return True  # pragma: no cover
+            return result_["action"]["status"] != "running"
+
+        try:
+            result, dummy, dummy2 = api_fetch_url_json_with_retries(
+                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")
+    error = result["action"].get("error")
+    if isinstance(error, dict):
+        raise ApplyActionError('[{0}] {1}'.format(to_native(error.get("code")), to_native(error.get("message"))))
+    elif result["action"]["status"] == "error":
+        raise ApplyActionError('Unknown error')

plugins/modules/storagebox.py

@@ -124,9 +124,6 @@
 from ansible.module_utils.common.text.converters import to_native
 from ansible.module_utils.six.moves.urllib.parse import urlencode
 
-from ansible_collections.community.hrobot.plugins.module_utils.common import (
-    CheckDoneTimeoutException,
-)
 from ansible_collections.community.hrobot.plugins.module_utils.robot import (
     BASE_URL,
     ROBOT_DEFAULT_ARGUMENT_SPEC,
@@ -138,7 +135,8 @@
     API_BASE_URL,
     API_DEFAULT_ARGUMENT_SPEC,
     _API_DEFAULT_ARGUMENT_SPEC_COMPAT,
-    api_fetch_url_json_with_retries,
+    ApplyActionError,
+    api_apply_action,
     api_fetch_url_json,
 )
 
@@ -297,34 +295,17 @@ def main():
         if action and not module.check_mode:
             after.update(update_after_update)
             action_url = "{0}/actions/update_access_settings".format(url)
-            headers = {"Content-type": "application/json"}
-            result, dummy, dummy2 = api_fetch_url_json(
-                module,
-                action_url,
-                data=module.jsonify(action),
-                headers=headers,
-                method='POST',
-            )
-            action_id = result["action"]["id"]
-            if result["action"]["status"] == "running":
-                this_action_url = "{0}/v1/storage_boxes/actions/{1}".format(API_BASE_URL, action_id)
-
-                def action_done_callback(result_, info_, error_):
-                    if error_ is not None:  # pragma: no cover
-                        return True  # pragma: no cover
-                    return result_["action"]["status"] != "running"
-
-                try:
-                    result, dummy, dummy2 = api_fetch_url_json_with_retries(
-                        module, this_action_url, action_done_callback, check_done_delay=1, check_done_timeout=60, skip_first=True,
-                    )
-                except CheckDoneTimeoutException as dummy:
-                    module.fail_json(msg='Timeout while waiting for access settings to be configured.')
-            error = result["action"].get("error")
-            if isinstance(error, dict):
-                module.fail_json(msg='Error while updating access settings: [{0}] {1}'.format(error.get("code"), error.get("message")))
-            elif result["action"]["status"] == "error":
-                module.fail_json(msg='Error while updating access settings (unknown error)')
+            try:
+                api_apply_action(
+                    module,
+                    action_url,
+                    action,
+                    lambda action_id: "{0}/v1/storage_boxes/actions/{1}".format(API_BASE_URL, action_id),
+                    check_done_delay=1,
+                    check_done_timeout=60,
+                )
+            except ApplyActionError as exc:
+                module.fail_json(msg='Error while updating access settings: {0}'.format(exc))
 
     result = dict(after)
     result['changed'] = bool(changes)