ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-29 08:01:24 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

[PR #10087/b861850e backport][stable-10] Feat: Add callback plugin print_task (#10159)
Some checks are pending
EOL CI / EOL Sanity (Ⓐ2.15) (push) Waiting to run
Details
EOL CI / EOL Units (Ⓐ2.15+py2.7) (push) Waiting to run
Details
EOL CI / EOL Units (Ⓐ2.15+py3.10) (push) Waiting to run
Details
EOL CI / EOL Units (Ⓐ2.15+py3.5) (push) Waiting to run
Details
EOL CI / EOL I (Ⓐ2.15+alpine3+py:azp/posix/1/) (push) Waiting to run
Details
EOL CI / EOL I (Ⓐ2.15+alpine3+py:azp/posix/2/) (push) Waiting to run
Details
EOL CI / EOL I (Ⓐ2.15+alpine3+py:azp/posix/3/) (push) Waiting to run
Details
EOL CI / EOL I (Ⓐ2.15+fedora37+py:azp/posix/1/) (push) Waiting to run
Details
EOL CI / EOL I (Ⓐ2.15+fedora37+py:azp/posix/2/) (push) Waiting to run
Details
EOL CI / EOL I (Ⓐ2.15+fedora37+py:azp/posix/3/) (push) Waiting to run
Details
nox / Run extra sanity tests (push) Waiting to run
Details

Browse source 
Feat: Add callback plugin print_task (#10087)

* Feat: Add callback plugin print_task

Prints task snippet to job output.

* Fix for failing tests

* Fix some pep8 formatting issues

* Updating DOCUMENTATION variable with version_added

* Set correct CALLBACK_NAME and fix warning with gather_facts

* Fix formatting again

* Update plugins/callback/print_task.py



* Update plugins/callback/print_task.py



* Add entry to BOTMETA.yml

* Use CSafeLoader and fallback to SafeLoader

* Change output function to self._display.display()

* Adding tests for community.general.print_task

* Adding EXAMPLES

* Apply suggestions from code review



---------


(cherry picked from commit b861850e1a)

Co-authored-by: Max Mitschke <demonpig@fastmail.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
patchback[bot] 2025-05-19 07:05:21 +02:00 • committed by GitHub
commit f7189a55c6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 204 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

6
tests/integration/targets/callback_print_task/aliases Normal file
View file

@ -0,0 +1,6 @@
# Copyright (c) Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
azp/posix/3
needs/target/callback

132
tests/integration/targets/callback_print_task/tasks/main.yml Normal file
View file

@ -0,0 +1,132 @@
---
####################################################################
# WARNING: These are designed specifically for Ansible tests #
# and should not be used as examples of how to write Ansible roles #
####################################################################
# Copyright (c) Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
- name: Run tests
include_role:
name: callback
vars:
tests:
- name: community.general.print_task is not enabled
environment:
ANSIBLE_NOCOLOR: 'true'
ANSIBLE_FORCE_COLOR: 'false'
playbook: |
- hosts: testhost
gather_facts: false
tasks:
- name: Sample task
debug:
msg: This is a test
expected_output: [
"",
"PLAY [testhost] ****************************************************************",
"",
"TASK [Sample task] *************************************************************",
"ok: [testhost] => {",
" \"msg\": \"This is a test\"",
"}",
"",
"PLAY RECAP *********************************************************************",
"testhost : ok=1 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 "
]
- name: community.general.print_task is enabled
environment:
ANSIBLE_NOCOLOR: 'true'
ANSIBLE_FORCE_COLOR: 'false'
ANSIBLE_CALLBACKS_ENABLED: 'community.general.print_task'
playbook: |
- hosts: testhost
gather_facts: false
tasks:
- name: Sample task
debug:
msg: This is a test
expected_output: [
"",
"PLAY [testhost] ****************************************************************",
"",
"TASK [Sample task] *************************************************************",
"",
"- name: Sample task",
" debug:",
" msg: This is a test",
"",
"ok: [testhost] => {",
" \"msg\": \"This is a test\"",
"}",
"",
"PLAY RECAP *********************************************************************",
"testhost : ok=1 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 "
]
- name: Print with msg parameter on the same line
environment:
ANSIBLE_NOCOLOR: 'true'
ANSIBLE_FORCE_COLOR: 'false'
ANSIBLE_CALLBACKS_ENABLED: 'community.general.print_task'
playbook: |
- hosts: testhost
gather_facts: false
tasks:
- name: Sample task
debug: msg="This is a test"
expected_output: [
"",
"PLAY [testhost] ****************************************************************",
"",
"TASK [Sample task] *************************************************************",
"",
"- name: Sample task",
" debug: msg=\"This is a test\"",
"",
"ok: [testhost] => {",
" \"msg\": \"This is a test\"",
"}",
"",
"PLAY RECAP *********************************************************************",
"testhost : ok=1 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 "
]
- name: Task with additional parameters
environment:
ANSIBLE_NOCOLOR: 'true'
ANSIBLE_FORCE_COLOR: 'false'
ANSIBLE_CALLBACKS_ENABLED: 'community.general.print_task'
playbook: |
- hosts: testhost
gather_facts: false
tasks:
- name: Sample task
when: True
vars:
test_var: "Hello World"
debug:
var: test_var
expected_output: [
"",
"PLAY [testhost] ****************************************************************",
"",
"TASK [Sample task] *************************************************************",
"",
"- name: Sample task",
" when: true",
" vars:",
" test_var: Hello World",
" debug:",
" var: test_var",
"",
"ok: [testhost] => {",
" \"test_var\": \"Hello World\"",
"}",
"",
"PLAY RECAP *********************************************************************",
"testhost : ok=1 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 "
]