Merge pull request #49408 from terminalmage/issue49269

Allow our custom yaml dumper to NamespacedDictWrapper objects

salt/loader.py

@@ -1357,11 +1357,11 @@ def __prep_mod_opts(self, opts):
         '''
         if '__grains__' not in self.pack:
             self.context_dict['grains'] = opts.get('grains', {})
-            self.pack['__grains__'] = salt.utils.context.NamespacedDictWrapper(self.context_dict, 'grains', override_name='grains')
+            self.pack['__grains__'] = salt.utils.context.NamespacedDictWrapper(self.context_dict, 'grains')
 
         if '__pillar__' not in self.pack:
             self.context_dict['pillar'] = opts.get('pillar', {})
-            self.pack['__pillar__'] = salt.utils.context.NamespacedDictWrapper(self.context_dict, 'pillar', override_name='pillar')
+            self.pack['__pillar__'] = salt.utils.context.NamespacedDictWrapper(self.context_dict, 'pillar')
 
         mod_opts = {}
         for key, val in list(opts.items()):

salt/utils/yamldumper.py

@@ -17,6 +17,7 @@
 
 import yaml
 import collections
+import salt.utils.context
 from salt.utils.odict import OrderedDict
 
 try:
@@ -54,6 +55,14 @@ def represent_ordereddict(dumper, data):
     collections.defaultdict,
     yaml.representer.SafeRepresenter.represent_dict
 )
+OrderedDumper.add_representer(
+    salt.utils.context.NamespacedDictWrapper,
+    yaml.representer.SafeRepresenter.represent_dict
+)
+SafeOrderedDumper.add_representer(
+    salt.utils.context.NamespacedDictWrapper,
+    yaml.representer.SafeRepresenter.represent_dict
+)
 
 if HAS_IOFLO:
     OrderedDumper.add_representer(odict, represent_ordereddict)

tests/integration/output/test_output.py

@@ -7,6 +7,7 @@
 from __future__ import absolute_import
 import os
 import traceback
+import yaml
 
 # Import Salt Testing Libs
 from tests.support.case import ShellCase
@@ -81,6 +82,20 @@ def test_output_yaml(self):
         ret = self.run_call('test.ping --out=yaml')
         self.assertEqual(ret, expected)
 
+    def test_output_yaml_namespaced_dict_wrapper(self):
+        '''
+        Tests the ability to dump a NamespacedDictWrapper instance, as used in
+        magic dunders like __grains__ and __pillar__
+
+        See https://github.com/saltstack/salt/issues/49269
+        '''
+        dumped_yaml = '\n'.join(self.run_call('grains.items --out=yaml'))
+        loaded_yaml = yaml.load(dumped_yaml)
+        # We just want to check that the dumped YAML loades as a dict with a
+        # single top-level key, we don't care about the real contents.
+        assert isinstance(loaded_yaml, dict)
+        assert list(loaded_yaml) == ['local']
+
     def test_output_unicodebad(self):
         '''
         Tests outputter reliability with utf8