-
Notifications
You must be signed in to change notification settings - Fork 1.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add default_without_diff callback #7949
Merged
felixfontein
merged 2 commits into
ansible-collections:main
from
felixfontein:default-without-diff
Feb 14, 2024
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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,46 @@ | ||
# -*- coding: utf-8 -*- | ||
|
||
# Copyright (c) 2024, Felix Fontein <[email protected]> | ||
# 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 | ||
|
||
from __future__ import (absolute_import, division, print_function) | ||
__metaclass__ = type | ||
|
||
DOCUMENTATION = r''' | ||
name: default_without_diff | ||
type: stdout | ||
short_description: The default ansible callback without diff output | ||
version_added: 8.4.0 | ||
description: | ||
- This is basically the default ansible callback plugin (P(ansible.builtin.default#callback)) without | ||
showing diff output. This can be useful when using another callback which sends more detailed information | ||
to another service, like the L(ARA, https://ara.recordsansible.org/) callback, and you want diff output | ||
sent to that plugin but not shown on the console output. | ||
author: Felix Fontein (@felixfontein) | ||
extends_documentation_fragment: | ||
- ansible.builtin.default_callback | ||
- ansible.builtin.result_format_callback | ||
''' | ||
|
||
EXAMPLES = r''' | ||
# Enable callback in ansible.cfg: | ||
ansible_config: | | ||
[defaults] | ||
stdout_callback = community.general.default_without_diff | ||
|
||
# Enable callback with environment variables: | ||
environment_variable: | | ||
ANSIBLE_STDOUT_CALLBACK=community.general.default_without_diff | ||
''' | ||
|
||
from ansible.plugins.callback.default import CallbackModule as Default | ||
|
||
|
||
class CallbackModule(Default): | ||
CALLBACK_VERSION = 2.0 | ||
CALLBACK_TYPE = 'stdout' | ||
CALLBACK_NAME = 'community.general.default_without_diff' | ||
|
||
def v2_on_file_diff(self, result): | ||
pass |
6 changes: 6 additions & 0 deletions
6
tests/integration/targets/callback_default_without_diff/aliases
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,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 |
65 changes: 65 additions & 0 deletions
65
tests/integration/targets/callback_default_without_diff/tasks/main.yml
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,65 @@ | ||
--- | ||
#################################################################### | ||
# 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 | ||
|
||
- block: | ||
- name: Create temporary file | ||
tempfile: | ||
register: tempfile | ||
|
||
- name: Run tests | ||
include_role: | ||
name: callback | ||
vars: | ||
tests: | ||
- name: Basic file diff | ||
environment: | ||
ANSIBLE_NOCOLOR: 'true' | ||
ANSIBLE_FORCE_COLOR: 'false' | ||
ANSIBLE_DIFF_ALWAYS: 'true' | ||
ANSIBLE_PYTHON_INTERPRETER: "{{ ansible_python_interpreter }}" | ||
ANSIBLE_STDOUT_CALLBACK: community.general.default_without_diff | ||
playbook: | | ||
- hosts: testhost | ||
gather_facts: true | ||
tasks: | ||
- name: Create file | ||
copy: | ||
dest: "{{ tempfile.path }}" | ||
content: | | ||
Foo bar | ||
|
||
- name: Modify file | ||
copy: | ||
dest: "{{ tempfile.path }}" | ||
content: | | ||
Foo bar | ||
Bar baz bam! | ||
expected_output: [ | ||
"", | ||
"PLAY [testhost] ****************************************************************", | ||
"", | ||
"TASK [Gathering Facts] *********************************************************", | ||
"ok: [testhost]", | ||
"", | ||
"TASK [Create file] *************************************************************", | ||
"changed: [testhost]", | ||
"", | ||
"TASK [Modify file] *************************************************************", | ||
"changed: [testhost]", | ||
"", | ||
"PLAY RECAP *********************************************************************", | ||
"testhost : ok=3 changed=2 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 ", | ||
] | ||
|
||
always: | ||
- name: Clean up temp file | ||
file: | ||
path: "{{ tempfile.path }}" | ||
state: absent |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎉