Ovirt add job (#55440)

* init ovirt_job module

* ovirt job add state finished

* redone logic in ovirt job

* ovirt jobs add docs

* ovirt job update docs

* update failed status

* ovirt job update return docs

* ovirt job update docs

* check if job and step has finished

* remove job status end

lib/ansible/modules/cloud/ovirt/ovirt_job.py

@@ -0,0 +1,235 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+#
+# Copyright (c) 2016 Red Hat, Inc.
+#
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+
+DOCUMENTATION = '''
+---
+module: ovirt_job
+short_description: Module to manage jobs in oVirt/RHV
+version_added: "2.9"
+author: "Martin Necas (@mnecas)"
+description:
+    - "This module manage jobs in oVirt/RHV. It can also manage steps of the job."
+options:
+    description:
+        description:
+            - "Description of the job."
+        required: true
+    state:
+        description:
+            - "Should the job be C(present)/C(absent)/C(failed)."
+            - "C(started) is alias for C(present). C(finished) is alias for C(absent). Same in the steps."
+            - "Note when C(finished)/C(failed) it will finish/fail all steps."
+        choices: ['present', 'absent', 'started', 'finished', 'failed']
+        default: present
+    steps:
+        description:
+            - "The steps of the job."
+        suboptions:
+            description:
+                description:
+                    - "Description of the step."
+                required: true
+            state:
+                description:
+                    - "Should the step be present/absent/failed."
+                    - "Note when one step fail whole job will fail"
+                    - "Note when all steps are finished it will finish job."
+                choices: ['present', 'absent', 'started', 'finished', 'failed']
+                default: present
+        type: list
+extends_documentation_fragment: ovirt
+'''
+
+EXAMPLES = '''
+# Examples don't contain auth parameter for simplicity,
+# look at ovirt_auth module to see how to reuse authentication:
+
+- name: Create job with two steps
+  ovirt_job:
+    description: job_name
+    steps:
+      - description: step_name_A
+      - description: step_name_B
+
+- name: Finish one step
+  ovirt_job:
+    description: job_name
+    steps:
+      - description: step_name_A
+        state: finished
+
+- name: When you fail one step whole job will stop
+  ovirt_job:
+    description: job_name
+    steps:
+      - description: step_name_B
+        state: failed
+
+- name: Finish all steps
+  ovirt_job:
+    description: job_name
+    state: finished
+'''
+
+RETURN = '''
+id:
+    description: ID of the job which is managed
+    returned: On success if job is found.
+    type: str
+    sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
+job:
+    description: "Dictionary of all the job attributes. Job attributes can be found on your oVirt/RHV instance
+                  at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/job."
+    returned: On success if job is found.
+    type: dict
+'''
+
+import traceback
+
+try:
+    import ovirtsdk4.types as otypes
+except ImportError:
+    pass
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.ovirt import (
+    check_sdk,
+    create_connection,
+    equal,
+    get_id_by_name,
+    ovirt_full_argument_spec,
+    get_dict_of_struct,
+)
+
+
+def build_job(description):
+    return otypes.Job(
+        description=description,
+        status=otypes.JobStatus.STARTED,
+        external=True,
+        auto_cleared=True
+    )
+
+
+def build_step(description, job_id):
+    return otypes.Step(
+        description=description,
+        type=otypes.StepEnum.UNKNOWN,
+        job=otypes.Job(
+            id=job_id
+        ),
+        status=otypes.StepStatus.STARTED,
+        external=True,
+    )
+
+
+def attach_steps(module, job_id, jobs_service):
+    changed = False
+    steps_service = jobs_service.job_service(job_id).steps_service()
+    if module.params.get('steps'):
+        for step in module.params.get('steps'):
+            step_entity = get_entity(steps_service, step.get('description'))
+            step_state = step.get('state', 'present')
+            if step_state in ['present', 'started']:
+                if step_entity is None:
+                    steps_service.add(build_step(step.get('description'), job_id))
+                    changed = True
+            if step_entity is not None and step_entity.status not in [otypes.StepStatus.FINISHED, otypes.StepStatus.FAILED]:
+                if step_state in ['absent', 'finished']:
+                    steps_service.step_service(step_entity.id).end(succeeded=True)
+                    changed = True
+                elif step_state == 'failed':
+                    steps_service.step_service(step_entity.id).end(succeeded=False)
+                    changed = True
+    return changed
+
+
+def get_entity(service, description):
+    all_entities = service.list()
+    for entity in all_entities:
+        if entity.description == description and entity.status not in [otypes.StepStatus.FINISHED, otypes.JobStatus.FINISHED]:
+            return entity
+
+
+def main():
+    argument_spec = ovirt_full_argument_spec(
+        state=dict(
+            choices=['present', 'absent', 'started', 'finished', 'failed'],
+            default='present',
+        ),
+        description=dict(default=None),
+        steps=dict(default=None, type='list'),
+    )
+    module = AnsibleModule(
+        argument_spec=argument_spec,
+        supports_check_mode=False,
+    )
+
+    check_sdk(module)
+
+    try:
+        auth = module.params.pop('auth')
+        connection = create_connection(auth)
+        jobs_service = connection.system_service().jobs_service()
+
+        state = module.params['state']
+        job = get_entity(jobs_service, module.params['description'])
+        changed = False
+        if state in ['present', 'started']:
+            if job is None:
+                job = jobs_service.add(build_job(module.params['description']))
+                changed = True
+            changed = attach_steps(module, job.id, jobs_service) or changed
+
+        if job is not None and job.status not in [otypes.JobStatus.FINISHED, otypes.JobStatus.FAILED]:
+            if state in ['absent', 'finished']:
+                jobs_service.job_service(job.id).end(succeeded=True)
+                changed = True
+
+            elif state == 'failed':
+                jobs_service.job_service(job.id).end(succeeded=False)
+                changed = True
+
+        ret = {
+            'changed': changed,
+            'id': getattr(job, 'id', None),
+            'job': get_dict_of_struct(
+                struct=job,
+                connection=connection,
+                fetch_nested=True,
+                attributes=module.params.get('nested_attributes'),
+            ),
+        }
+
+        module.exit_json(**ret)
+    except Exception as e:
+        module.fail_json(msg=str(e), exception=traceback.format_exc())
+    finally:
+        connection.close(logout=auth.get('token') is None)
+
+
+if __name__ == "__main__":
+    main()