-
Notifications
You must be signed in to change notification settings - Fork 166
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(wait_task): Add a wait_task module.
And a new module that simply expose the wait_for_task function Signed-off-by: Julien Godin <[email protected]>
- Loading branch information
1 parent
7e36b39
commit 7c35d6c
Showing
6 changed files
with
166 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -93,6 +93,7 @@ authors: | |
- "metalcated <[email protected]>" | ||
- "russianguppie <[email protected]>" | ||
- "willtome <[email protected]>" | ||
- "Julien Godin <[email protected]>" | ||
version: "3.13.0-dev" | ||
license: | ||
- "GPL-3.0-or-later" | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,93 @@ | ||
#!/usr/bin/python | ||
# -*- coding: utf-8 -*- | ||
# (c) 2023, Julien Godin <[email protected]> | ||
# | ||
# This program 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. | ||
# | ||
# This program 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 this program. If not, see <http://www.gnu.org/licenses/>. | ||
|
||
from __future__ import absolute_import, division, print_function | ||
|
||
__metaclass__ = type | ||
|
||
DOCUMENTATION = ''' | ||
--- | ||
module: wait_for_task | ||
version_added: 3.13.0 | ||
short_description: Wait for a task | ||
description: | ||
- Wait for a task to finish | ||
author: | ||
- "Julien Godin (@JGodin-C2C)" | ||
options: | ||
task: | ||
description: | ||
- Task to wait for. Typical output of the resource_info module | ||
required: true | ||
type: dict | ||
timeout: | ||
description: | ||
- How much time the task should take to be finished | ||
required: false | ||
type: int | ||
default: 60 | ||
extends_documentation_fragment: | ||
- theforeman.foreman.foreman | ||
''' | ||
|
||
|
||
EXAMPLES = ''' | ||
- name: wait for a task to finish in at least 10 seconds | ||
theforeman.foreman.wait_for_task: | ||
server_url: "https://foreman.example.com" | ||
password: changeme | ||
username: admin | ||
task: "{{ item }}" | ||
timeout: 60 | ||
loop: "{{ tasks.resources }}" | ||
''' | ||
|
||
RETURN = ''' | ||
entity: | ||
description: Designated task is finished | ||
returned: success | ||
type: dict | ||
contains: | ||
task: | ||
description: The finished task | ||
type: dict | ||
''' | ||
|
||
|
||
from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ForemanAnsibleModule | ||
|
||
|
||
class ForemanWaitForTask(ForemanAnsibleModule): | ||
pass | ||
|
||
|
||
def main(): | ||
module = ForemanWaitForTask( | ||
argument_spec=dict( | ||
task=dict(type="dict", required=True), | ||
timeout=dict(type="int", required=False, default=60), | ||
) | ||
) | ||
module.task_timeout = module.foreman_params["timeout"] | ||
with module.api_connection(): | ||
task = module.wait_for_task(module.foreman_params["task"]) | ||
module.exit_json(task=task) | ||
|
||
|
||
if __name__ == "__main__": | ||
main() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
foreman.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
--- | ||
- name: "Create katello content view version" | ||
vars: | ||
- content_view_name: "Test Content View" | ||
- organization_name: "Test Organization" | ||
- lifecycle_environments: Library | ||
content_view_version: | ||
username: "{{ foreman_username }}" | ||
password: "{{ foreman_password }}" | ||
server_url: "{{ foreman_server_url }}" | ||
validate_certs: "{{ foreman_validate_certs }}" | ||
content_view: "{{ content_view_name }}" | ||
organization: "{{ organization_name }}" | ||
description: "{{ description | default(omit)}}" | ||
version: "{{ version | default(omit)}}" | ||
lifecycle_environments: "{{ lifecycle_environments }}" | ||
force_promote: "{{ force_promote | default(omit) }}" | ||
force_yum_metadata_regeneration: "{{ force_yum_metadata_regeneration | default(omit) }}" | ||
current_lifecycle_environment: "{{ current_lifecycle_environment | default(omit) }}" | ||
state: "{{ state | default(omit) }}" | ||
async: 9999 | ||
|
||
- name: Wait for API to react | ||
ansible.builtin.pause: | ||
seconds: 10 | ||
|
||
- name: "Search for previously created task" | ||
resource_info: | ||
username: "{{ foreman_username }}" | ||
password: "{{ foreman_password }}" | ||
server_url: "{{ foreman_server_url }}" | ||
validate_certs: "{{ foreman_validate_certs }}" | ||
resource: foreman_tasks | ||
search: "(label = Actions::Katello::ContentView::Publish and state = running)" | ||
|
||
- name: wait for the task to finish | ||
wait_for_task: | ||
username: "{{ foreman_username }}" | ||
password: "{{ foreman_password }}" | ||
server_url: "{{ foreman_server_url }}" | ||
validate_certs: "{{ foreman_validate_certs }}" | ||
task: "{{ item }}" | ||
timeout: 900 | ||
loop: "{{ tasks.resources }}" | ||
|
||
|
||
- name: "Search for previously created task" | ||
resource_info: | ||
username: "{{ foreman_username }}" | ||
password: "{{ foreman_password }}" | ||
server_url: "{{ foreman_server_url }}" | ||
validate_certs: "{{ foreman_validate_certs }}" | ||
resource: foreman_tasks | ||
search: "(label = Actions::Katello::ContentView::Publish and state = running)" | ||
register: tasks | ||
- assert: | ||
fail_msg: "Verification that '{{ resource }}' resource is not runing anymore" | ||
that: result.resource | lenght == 0 | ||
... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
- hosts: localhost | ||
collections: | ||
- theforeman.foreman | ||
gather_facts: false | ||
vars_files: | ||
- vars/server.yml | ||
tasks: | ||
- include_tasks: tasks/wait_task.yml |