Initial cut at tower_job_wait conversion

awx_collection/plugins/modules/tower_job_wait.py

@@ -42,10 +42,12 @@ options:
       description:
         - Maximum time in seconds to wait for a job to finish.
       type: int
-
+    tower_oauthtoken:
-requirements:
+      description:
-- ansible-tower-cli >= 3.0.2
+        - The Tower OAuth token to use.
-
+      required: False
+      type: str
+      version_added: "3.7"
 extends_documentation_fragment: awx.awx.auth
 '''
 
@@ -90,22 +92,26 @@ status:
 '''
 
 
-from ..module_utils.ansible_tower import TowerModule, tower_auth_config, tower_check_mode
+from ..module_utils.tower_api import TowerModule
-from ansible.module_utils.six import PY2
+import time
-from ansible.module_utils.six.moves import cStringIO as StringIO
+import itertools
-from codecs import getwriter
 
 
-try:
+def check_job(module, job_url):
-    import tower_cli
+    response = module.get_endpoint(job_url)
-    import tower_cli.exceptions as exc
+    if response['status_code'] != 200:
+        module.fail_json(msg="Unable to read job from Tower {0}: {1}".format(response['status_code'], module.extract_errors_from_response(response)))
 
-    from tower_cli.conf import settings
+    # Since we were successful, extract the fields we want to return
-except ImportError:
+    for k in ('id', 'status', 'elapsed', 'started', 'finished'):
-    pass
+        module.json_output[k] = response['json'].get(k)
+
+    # And finally return the payload
+    return response['json']
 
 
 def main():
+    # Any additional arguments that are not fields of the item can be added here
     argument_spec = dict(
         job_id=dict(type='int', required=True),
         timeout=dict(type='int'),
@@ -113,55 +119,82 @@ def main():
         max_interval=dict(type='float', default=30),
     )
 
-    module = TowerModule(
+    # Create a module for ourselves
-        argument_spec,
+    module = TowerModule(argument_spec=argument_spec, supports_check_mode=True)
-        supports_check_mode=True
-    )
 
-    json_output = {}
+    # Extract our parameters
-    fail_json = None
+    job_id = module.params.get('job_id')
+    timeout = module.params.get('timeout')
+    min_interval = module.params.get('min_interval')
+    max_interval = module.params.get('max_interval')
 
-    tower_auth = tower_auth_config(module)
+    # Attempt to look up job based on the provided id
-    with settings.runtime_values(**tower_auth):
+    job = module.get_one('jobs', **{
-        tower_check_mode(module)
+        'data': {
-        job = tower_cli.get_resource('job')
+            'id': job_id,
-        params = module.params.copy()
+        }
+    })
 
-        # tower-cli gets very noisy when monitoring.
+    if job is None:
-        # We pass in our our outfile to suppress the out during our monitor call.
+        module.fail_json(msg='Unable to wait, on job {0} that ID does not exist in Tower.'.format(job_id))
-        if PY2:
-            outfile = getwriter('utf-8')(StringIO())
-        else:
-            outfile = StringIO()
-        params['outfile'] = outfile
 
-        job_id = params.get('job_id')
+    job_url = job['url']
-        try:
-            result = job.monitor(job_id, **params)
-        except exc.Timeout:
-            result = job.status(job_id)
-            result['id'] = job_id
-            json_output['msg'] = 'Timeout waiting for job to finish.'
-            json_output['timeout'] = True
-        except exc.NotFound as excinfo:
-            fail_json = dict(msg='Unable to wait, no job_id {0} found: {1}'.format(job_id, excinfo), changed=False)
-        except exc.JobFailure as excinfo:
-            fail_json = dict(msg='Job with id={0} failed, error: {1}'.format(job_id, excinfo))
-            fail_json['success'] = False
-            result = job.get(job_id)
-            for k in ('id', 'status', 'elapsed', 'started', 'finished'):
-                fail_json[k] = result.get(k)
-        except (exc.ConnectionError, exc.BadRequest, exc.AuthError) as excinfo:
-            fail_json = dict(msg='Unable to wait for job: {0}'.format(excinfo), changed=False)
 
-    if fail_json is not None:
+    # This comes from tower_cli/models/base.py from the old tower-cli
-        module.fail_json(**fail_json)
+    dots = itertools.cycle([0, 1, 2, 3])
+    interval = min_interval
+    start = time.time()
 
-    json_output['success'] = True
+    # Poll the Ansible Tower instance for status, and print the status to the outfile (usually standard out).
-    for k in ('id', 'status', 'elapsed', 'started', 'finished'):
+    #
-        json_output[k] = result.get(k)
+    # Note that this is one of the few places where we use `secho` even though we're in a function that might
+    # theoretically be imported and run in Python.  This seems fine; outfile can be set to /dev/null and very
+    # much the normal use for this method should be CLI monitoring.
+    result = check_job(module, job_url)
 
-    module.exit_json(**json_output)
+    last_poll = time.time()
+    timeout_check = 0
+    while not result['finished']:
+        # Sanity check: Have we officially timed out?
+        # The timeout check is incremented below, so this is checking to see if we were timed out as of
+        # the previous iteration. If we are timed out, abort.
+        if timeout and timeout_check - start > timeout:
+            module.json_output['msg'] = "Monitoring aborted due to timeout"
+            module.fail_json(**module.json_output)
+
+        # If the outfile is a TTY, print the current status.
+        output = '\rCurrent status: %s%s' % (result['status'], '.' * next(dots))
+
+        # Put the process to sleep briefly.
+        time.sleep(0.2)
+
+        # Sanity check: Have we reached our timeout?
+        # If we're about to time out, then we need to ensure that we do one last check.
+        #
+        # Note that the actual timeout will be performed at the start of the **next** iteration,
+        # so there's a chance for the job's completion to be noted first.
+        timeout_check = time.time()
+        if timeout and timeout_check - start > timeout:
+            last_poll -= interval
+
+        # If enough time has elapsed, ask the server for a new status.
+        #
+        # Note that this doesn't actually do a status check every single time; we want the "spinner" to
+        # spin even if we're not actively doing a check.
+        #
+        # So, what happens is that we are "counting down" (actually up) to the next time that we intend
+        # to do a check, and once that time hits, we do the status check as part of the normal cycle.
+        if time.time() - last_poll > interval:
+            result = check_job(module, job_url)
+            last_poll = time.time()
+            interval = min(interval * 1.5, max_interval)
+
+    # If the job has failed, we want to raise an Exception for that so we get a non-zero response.
+    if result['failed']:
+        module.json_output['msg'] = 'Job with id {0} failed'.format(job_id)
+        module.fail_json(**module.json_output)
+
+    module.exit_json(**module.json_output)
 
 
 if __name__ == '__main__':

awx_collection/tests/integration/targets/tower_job_wait/tasks/main.yml

@@ -1,18 +1,24 @@
 ---
-- name: Launch a Job Template
+- name: generate random string for template and project
-  tower_job_launch:
+  set_fact:
-    job_template: "Demo Job Template"
+    jt_name: "AWX-Collection-tests-tower_job_wait-long_running-{{ lookup('password', '/dev/null chars=ascii_letters length=16') }}"
-  register: job
+    proj_name: "AWX-Collection-tests-tower_job_wait-long_running-{{ lookup('password', '/dev/null chars=ascii_letters length=16') }}"
 
-- assert:
+- name: Assure that demo project exists
-    that:
+  tower_project:
-      - "job is changed"
+    name: "{{ proj_name }}"
-      - "job.status == 'pending'"
+    scm_type: 'git'
+    scm_url: 'https://github.com/ansible/test-playbooks.git'
+    scm_update_on_launch: true
+    organization: Default
 
-- name: Wait for the Job to finish
+- name: Create a job template
-  tower_job_wait:
+  tower_job_template:
-    job_id: "{{ job.id }}"
+    name: "{{ jt_name }}"
-    timeout: 60
+    playbook: "sleep.yml"
+    job_type: run
+    project: "{{ proj_name }}"
+    inventory: "Demo Inventory"
 
 - name: Check module fails with correct msg
   tower_job_wait:
@@ -22,4 +28,80 @@
 
 - assert:
     that:
-      - "result.msg =='Unable to wait, no job_id 99999999 found: The requested object could not be found.'"
+      - result is failed
+      - "result.msg =='Unable to wait, on job 99999999 that ID does not exist in Tower.'"
+
+- name: Launch Demo Job Template (take happy path)
+  tower_job_launch:
+    job_template: "Jenkins Export Vars"
+  register: job
+
+- assert:
+    that:
+      - job is changed
+      - "job.status == 'pending'"
+
+- name: Wait for the Job to finish
+  tower_job_wait:
+    job_id: "{{ job.id }}"
+  register: wait_results
+
+# Make sure we worked and that we have some data in our results
+- assert:
+    that:
+      - wait_results is successful
+      - "'elapsed' in wait_results"
+      - "'id' in wait_results"
+
+- name: Launch a long running job
+  tower_job_launch:
+    job_template: "{{ jt_name }}"
+  register: job
+
+- assert:
+    that:
+      - job is changed
+      - "job.status == 'pending'"
+
+- name: Timeout waiting for the job to complete
+  tower_job_wait:
+    job_id: "{{ job.id }}"
+    timeout: 5
+  ignore_errors: True
+  register: wait_results
+
+# Make sure that we failed and that we have some data in our results
+- assert:
+    that:
+      - wait_results is failed
+      - "wait_results.msg == 'Monitoring aborted due to timeout'"
+      - "'id' in wait_results"
+
+- name: Async cancel the long running job
+  tower_job_cancel:
+    job_id: "{{ job.id }}"
+  async: 3600
+  poll: 0
+
+- name: Wait for the job to exit on cancel
+  tower_job_wait:
+    job_id: "{{ job.id }}"
+  register: wait_results
+  ignore_errors: True
+
+- assert:
+    that:
+      - wait_results is failed
+      - 'wait_results.status == "canceled"'
+      - "wait_results.msg == 'Job with id {{ job.id }} failed'"
+
+- name: Delete the job template
+  tower_job_template:
+    name: "{{ jt_name }}"
+    state: absent
+
+- name: Delete the project
+  tower_project:
+    name: "{{ proj_name }}"
+    organization: Default
+    state: absent