Increase sleep to 5 seconds (#245)

* Increase sleep to 5 seconds Deployments run successfully, but there are not reported correctly in Ansible. So a timeout increase is one option * adding variable timeout in role and script * add documentation * add changes to pass sanity check adding typing * add example, change example in plugin, add test --------- Co-authored-by: Sebastian Gumprich <[email protected]>
telekom-mms · Feb 13, 2024 · a811165 · a811165
1 parent 423484b
commit a811165
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 3 deletions.
diff --git a/examples/icinga_deploy.yml b/examples/icinga_deploy.yml
@@ -4,3 +4,4 @@
     url: "{{ icinga_url }}"
     url_username: "{{ icinga_user }}"
     url_password: "{{ icinga_pass }}"
+    timeout: 5
diff --git a/plugins/modules/icinga_deploy.py b/plugins/modules/icinga_deploy.py
@@ -32,6 +32,12 @@
 extends_documentation_fragment:
   - ansible.builtin.url
   - telekom_mms.icinga_director.common_options
+options:
+  timeout:
+    description:
+      - Default timeout to wait for deployment to finish in seconds.
+    default: 2
+    type: int
 """
 
 EXAMPLES = """
@@ -40,6 +46,7 @@
     url: "{{ icinga_url }}"
     url_username: "{{ icinga_user }}"
     url_password: "{{ icinga_pass }}"
+    timeout: 5
 """
 
 RETURN = r"""
@@ -71,6 +78,7 @@ def main():
     # add our own arguments
     argument_spec.update(
         url=dict(required=True),
+        timeout=dict(required=False, default=2, type="int")
     )
 
     # Define the main module
@@ -92,8 +100,8 @@ def main():
     icinga_deployment = Icinga2APIObject(module=module, path="/config/deploy", data=[])
     result = icinga_deployment.create()
     # the deployment is asynchronous and I don't know of a way to check if it is finished.
-    # so we need some sleep here. 2 seconds is a wild guess.
-    sleep(2)
+    # so we need some sleep here. 2 seconds is a wild guess and a default, now it is a variable
+    sleep(module.params["timeout"])
 
     # get the new deployment status
     create_deployment = icinga_deploy_status.query_deployment()["data"]["active_configuration"]["config"]

diff --git a/roles/ansible_icinga/handlers/main.yml b/roles/ansible_icinga/handlers/main.yml
@@ -9,5 +9,6 @@
     client_key: "{{ icinga_client_key | default(omit) }}"
     url_username: "{{ icinga_user }}"
     url_password: "{{ icinga_pass }}"
+    timeout: "{{ icinga_deploy_timeout | default(omit) }}"
   when: icinga_deploy_config and icinga_deploy_config is defined
   listen: config_deploy
diff --git a/tests/integration/targets/icinga/roles/icinga/handlers/main.yml b/tests/integration/targets/icinga/roles/icinga/handlers/main.yml
@@ -4,5 +4,6 @@
     url: "{{ icinga_url }}"
     url_username: "{{ icinga_user }}"
     url_password: "{{ icinga_pass }}"
+    timeout: 5
   when: icinga_deploy_config and icinga_deploy_config is defined
-  listen: config_deploy
+  listen: config_deploy