From 8247615d24a47c23b3f6bcc349f32fce46b0a191 Mon Sep 17 00:00:00 2001
From: Felix Fontein <felix@fontein.de>
Date: Sun, 9 Mar 2025 16:32:48 +0100
Subject: [PATCH] Fix diy callback plugin.
---
changelogs/fragments/9833-data-tagging.yml | 1 +
plugins/callback/diy.py | 13 +++++++++++--
2 files changed, 12 insertions(+), 2 deletions(-)
diff --git a/changelogs/fragments/9833-data-tagging.yml b/changelogs/fragments/9833-data-tagging.yml
index b1f39dab28..7d4617b7f9 100644
--- a/changelogs/fragments/9833-data-tagging.yml
+++ b/changelogs/fragments/9833-data-tagging.yml
@@ -1,6 +1,7 @@
bugfixes:
- "dependent look plugin - make compatible with ansible-core's Data Tagging feature (https://github.com/ansible-collections/community.general/pull/9833)."
- "reveal_ansible_type filter plugin and ansible_type test plugin - make compatible with ansible-core's Data Tagging feature (https://github.com/ansible-collections/community.general/pull/9833)."
+ - "diy callback plugin - make compatible with ansible-core's Data Tagging feature (https://github.com/ansible-collections/community.general/pull/9833)."
known_issues:
- "reveal_ansible_type filter plugin and ansible_type test plugin - note that ansible-core's Data Tagging feature implements new aliases,
such as ``_AnsibleTaggedStr`` for ``str``, ``_AnsibleTaggedInt`` for ``int``, and ``_AnsibleTaggedFloat`` for ``float``
diff --git a/plugins/callback/diy.py b/plugins/callback/diy.py
index b3cd0cdbce..a4369daadd 100644
--- a/plugins/callback/diy.py
+++ b/plugins/callback/diy.py
@@ -785,6 +785,12 @@ from ansible.vars.manager import VariableManager
from ansible.plugins.callback.default import CallbackModule as Default
from ansible.module_utils.common.text.converters import to_text
+try:
+ from ansible.template import trust_as_template # noqa: F401, pylint: disable=unused-import
+ SUPPORTS_DATA_TAGGING = True
+except ImportError:
+ SUPPORTS_DATA_TAGGING = False
+
class DummyStdout(object):
def flush(self):
@@ -838,7 +844,10 @@ class CallbackModule(Default):
return _ret
def _using_diy(self, spec):
- return (spec['msg'] is not None) and (spec['msg'] != spec['vars']['omit'])
+ sentinel = object()
+ omit = spec['vars'].get('omit', sentinel)
+ # With Data Tagging, omit is sentinel
+ return (spec['msg'] is not None) and (spec['msg'] != omit or omit is sentinel)
def _parent_has_callback(self):
return hasattr(super(CallbackModule, self), sys._getframe(1).f_code.co_name)
@@ -894,7 +903,7 @@ class CallbackModule(Default):
)
_ret.update(_all)
- _ret.update(_ret.get(self.DIY_NS, {self.DIY_NS: CallbackDIYDict()}))
+ _ret.update(_ret.get(self.DIY_NS, {self.DIY_NS: {} if SUPPORTS_DATA_TAGGING else CallbackDIYDict()}))
_ret[self.DIY_NS].update({'playbook': {}})
_playbook_attributes = ['entries', 'file_name', 'basedir']