Make ready for data tagging (#9833)

* Fix dependent lookup.

* Fix ansible_type plugin utils and adjust documentation of reveal_ansible_type filter and ansible_type test.

* Fix diy callback plugin.

* Adjust to Data Tagging.

* Vendor and use internal code from ansible-core to fix YAML callback.

Ref: https://github.com/ansible/ansible/issues/84781

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']

plugins/callback/yaml.py

@@ -53,29 +53,77 @@ def should_use_block(value):
     return False
 
 
-class MyDumper(AnsibleDumper):
-    def represent_scalar(self, tag, value, style=None):
-        """Uses block style for multi-line strings"""
-        if style is None:
-            if should_use_block(value):
-                style = '|'
-                # we care more about readable than accuracy, so...
-                # ...no trailing space
-                value = value.rstrip()
-                # ...and non-printable characters
-                value = ''.join(x for x in value if x in string.printable or ord(x) >= 0xA0)
-                # ...tabs prevent blocks from expanding
-                value = value.expandtabs()
-                # ...and odd bits of whitespace
-                value = re.sub(r'[\x0b\x0c\r]', '', value)
-                # ...as does trailing space
-                value = re.sub(r' +\n', '\n', value)
-            else:
-                style = self.default_style
-        node = yaml.representer.ScalarNode(tag, value, style=style)
-        if self.alias_key is not None:
-            self.represented_objects[self.alias_key] = node
-        return node
+try:
+    class MyDumper(AnsibleDumper):  # pylint: disable=inherit-non-class
+        def represent_scalar(self, tag, value, style=None):
+            """Uses block style for multi-line strings"""
+            if style is None:
+                if should_use_block(value):
+                    style = '|'
+                    # we care more about readable than accuracy, so...
+                    # ...no trailing space
+                    value = value.rstrip()
+                    # ...and non-printable characters
+                    value = ''.join(x for x in value if x in string.printable or ord(x) >= 0xA0)
+                    # ...tabs prevent blocks from expanding
+                    value = value.expandtabs()
+                    # ...and odd bits of whitespace
+                    value = re.sub(r'[\x0b\x0c\r]', '', value)
+                    # ...as does trailing space
+                    value = re.sub(r' +\n', '\n', value)
+                else:
+                    style = self.default_style
+            node = yaml.representer.ScalarNode(tag, value, style=style)
+            if self.alias_key is not None:
+                self.represented_objects[self.alias_key] = node
+            return node
+except:  # noqa: E722, pylint: disable=bare-except
+    # This happens with Data Tagging, see https://github.com/ansible/ansible/issues/84781
+    # Until there is a better solution we'll resort to using ansible-core internals.
+    from ansible._internal._yaml import _dumper
+    import typing as t
+
+    class MyDumper(_dumper._BaseDumper):
+        # This code is mostly taken from ansible._internal._yaml._dumper
+        @classmethod
+        def _register_representers(cls) -> None:
+            cls.add_multi_representer(_dumper.AnsibleTaggedObject, cls.represent_ansible_tagged_object)
+            cls.add_multi_representer(_dumper.Tripwire, cls.represent_tripwire)
+            cls.add_multi_representer(_dumper.c.Mapping, _dumper.SafeRepresenter.represent_dict)
+            cls.add_multi_representer(_dumper.c.Sequence, _dumper.SafeRepresenter.represent_list)
+
+        def represent_ansible_tagged_object(self, data):
+            if ciphertext := _dumper.VaultHelper.get_ciphertext(data, with_tags=False):
+                return self.represent_scalar('!vault', ciphertext, style='|')
+
+            return self.represent_data(_dumper.AnsibleTagHelper.as_native_type(data))  # automatically decrypts encrypted strings
+
+        def represent_tripwire(self, data: _dumper.Tripwire) -> t.NoReturn:
+            data.trip()
+
+        # The following function is the same as in the try/except
+        def represent_scalar(self, tag, value, style=None):
+            """Uses block style for multi-line strings"""
+            if style is None:
+                if should_use_block(value):
+                    style = '|'
+                    # we care more about readable than accuracy, so...
+                    # ...no trailing space
+                    value = value.rstrip()
+                    # ...and non-printable characters
+                    value = ''.join(x for x in value if x in string.printable or ord(x) >= 0xA0)
+                    # ...tabs prevent blocks from expanding
+                    value = value.expandtabs()
+                    # ...and odd bits of whitespace
+                    value = re.sub(r'[\x0b\x0c\r]', '', value)
+                    # ...as does trailing space
+                    value = re.sub(r' +\n', '\n', value)
+                else:
+                    style = self.default_style
+            node = yaml.representer.ScalarNode(tag, value, style=style)
+            if self.alias_key is not None:
+                self.represented_objects[self.alias_key] = node
+            return node
 
 
 class CallbackModule(Default):