mirror of
https://github.com/ansible/awx.git
synced 2026-01-09 15:02:07 -03:30
116 lines
2.9 KiB
Python
116 lines
2.9 KiB
Python
#!/usr/bin/python
|
|
# coding: utf-8 -*-
|
|
|
|
# (c) 2021, Sean Sullivan
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
|
|
__metaclass__ = type
|
|
|
|
|
|
ANSIBLE_METADATA = {
|
|
"metadata_version": "1.1",
|
|
"status": ["preview"],
|
|
"supported_by": "community",
|
|
}
|
|
|
|
|
|
DOCUMENTATION = """
|
|
---
|
|
module: workflow_node_wait
|
|
author: "Sean Sullivan (@sean-m-sullivan)"
|
|
short_description: Approve an approval node in a workflow job.
|
|
description:
|
|
- Approve an approval node in a workflow job. See
|
|
U(https://www.ansible.com/tower) for an overview.
|
|
options:
|
|
workflow_job_id:
|
|
description:
|
|
- ID of the workflow job to monitor for node.
|
|
required: True
|
|
type: int
|
|
name:
|
|
description:
|
|
- Name of the workflow node to wait on.
|
|
required: True
|
|
type: str
|
|
interval:
|
|
description:
|
|
- The interval in sections, to request an update from Tower.
|
|
required: False
|
|
default: 1
|
|
type: float
|
|
timeout:
|
|
description:
|
|
- Maximum time in seconds to wait for a workflow job to to reach approval node.
|
|
default: 10
|
|
type: int
|
|
extends_documentation_fragment: awx.awx.auth
|
|
"""
|
|
|
|
|
|
EXAMPLES = """
|
|
- name: Launch a workflow with a timeout of 10 seconds
|
|
workflow_launch:
|
|
workflow_template: "Test Workflow"
|
|
wait: False
|
|
register: workflow
|
|
|
|
- name: Wait for a workflow node to finish
|
|
workflow_node_wait:
|
|
workflow_job_id: "{{ workflow.id }}"
|
|
name: Approval Data Step
|
|
timeout: 120
|
|
"""
|
|
|
|
RETURN = """
|
|
|
|
"""
|
|
|
|
|
|
from ..module_utils.controller_api import ControllerAPIModule
|
|
import time
|
|
|
|
|
|
def main():
|
|
# Any additional arguments that are not fields of the item can be added here
|
|
argument_spec = dict(
|
|
workflow_job_id=dict(type="int", required=True),
|
|
name=dict(required=True),
|
|
timeout=dict(type="int", default=10),
|
|
interval=dict(type="float", default=1),
|
|
)
|
|
|
|
# Create a module for ourselves
|
|
module = ControllerAPIModule(argument_spec=argument_spec)
|
|
|
|
# Extract our parameters
|
|
workflow_job_id = module.params.get("workflow_job_id")
|
|
name = module.params.get("name")
|
|
timeout = module.params.get("timeout")
|
|
interval = module.params.get("interval")
|
|
|
|
node_url = "workflow_jobs/{0}/workflow_nodes/?job__name={1}".format(workflow_job_id, name)
|
|
# Attempt to look up workflow job node based on the provided id
|
|
|
|
result = module.wait_on_workflow_node_url(
|
|
url="workflow_jobs/{0}/workflow_nodes/".format(workflow_job_id),
|
|
object_name=name,
|
|
object_type="Workflow Node",
|
|
timeout=timeout,
|
|
interval=interval,
|
|
**{
|
|
"data": {
|
|
"job__name": name,
|
|
}
|
|
}
|
|
)
|
|
|
|
# Attempt to look up jobs based on the status
|
|
module.exit_json(**module.json_output)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|