Merge pull request #43165 from cloudflare/fix-napalm-ret

Improve napalm state output in debug mode

salt/states/netyang.py

@@ -92,6 +92,13 @@ def managed(name,
         Use certain profiles to generate the config.
         If not specified, will use the platform default profile(s).
 
+    compliance_report: ``False``
+        Return the compliance report in the comment.
+        The compliance report structured object can be found however
+        in the ``pchanges`` field of the output (not displayed on the CLI).
+
+        .. versionadded:: 2017.7.3
+
     test: ``False``
         Dry run? If set as ``True``, will apply the config, discard
         and return the changes. Default: ``False`` and will commit
@@ -140,6 +147,7 @@ def managed(name,
     debug = kwargs.get('debug', False) or __opts__.get('debug', False)
     commit = kwargs.get('commit', True) or __opts__.get('commit', True)
     replace = kwargs.get('replace', False) or __opts__.get('replace', False)
+    return_compliance_report = kwargs.get('compliance_report', False) or __opts__.get('compliance_report', False)
     profiles = kwargs.get('profiles', [])
     temp_file = __salt__['temp.file']()
     log.debug('Creating temp file: {0}'.format(temp_file))
@@ -180,7 +188,13 @@ def managed(name,
     log.debug('Loaded config result:')
     log.debug(loaded_changes)
     __salt__['file.remove'](temp_file)
-    return salt.utils.napalm.loaded_ret(ret, loaded_changes, test, debug)
+    loaded_changes['compliance_report'] = compliance_report
+    return salt.utils.napalm.loaded_ret(ret,
+                                        loaded_changes,
+                                        test,
+                                        debug,
+                                        opts=__opts__,
+                                        compliance_report=return_compliance_report)
 
 
 def configured(name,

salt/utils/napalm.py

@@ -24,6 +24,7 @@ from functools import wraps
 log = logging.getLogger(__file__)
 
 import salt.utils
+import salt.output
 
 # Import third party lib
 try:
@@ -432,58 +433,58 @@ def default_ret(name):
     return ret
 
 
-def loaded_ret(ret, loaded, test, debug):
+def loaded_ret(ret, loaded, test, debug, compliance_report=False, opts=None):
     '''
     Return the final state output.
-
     ret
         The initial state output structure.
-
     loaded
         The loaded dictionary.
     '''
     # Always get the comment
-    ret.update({
-        'comment': loaded.get('comment', '')
-    })
+    changes = {}
     pchanges = {}
+    ret['comment'] = loaded['comment']
+    if 'diff' in loaded:
+        changes['diff'] = loaded['diff']
+        pchanges['diff'] = loaded['diff']
+    if 'compliance_report' in loaded:
+        if compliance_report:
+            changes['compliance_report'] = loaded['compliance_report']
+        pchanges['compliance_report'] = loaded['compliance_report']
+    if debug and 'loaded_config' in loaded:
+        changes['loaded_config'] = loaded['loaded_config']
+        pchanges['loaded_config'] = loaded['loaded_config']
+    ret['pchanges'] = pchanges
+    if changes.get('diff'):
+        ret['comment'] = '{comment_base}\n\nConfiguration diff:\n\n{diff}'.format(comment_base=ret['comment'],
+                                                                                  diff=changes['diff'])
+    if changes.get('loaded_config'):
+        ret['comment'] = '{comment_base}\n\nLoaded config:\n\n{loaded_cfg}'.format(
+            comment_base=ret['comment'],
+            loaded_cfg=changes['loaded_config'])
+    if changes.get('compliance_report'):
+        ret['comment'] = '{comment_base}\n\nCompliance report:\n\n{compliance}'.format(
+            comment_base=ret['comment'],
+            compliance=salt.output.string_format(changes['compliance_report'], 'nested', opts=opts))
     if not loaded.get('result', False):
         # Failure of some sort
         return ret
-    if debug:
-        # Always check for debug
-        pchanges.update({
-            'loaded_config': loaded.get('loaded_config', '')
-        })
-        ret.update({
-            "pchanges": pchanges
-        })
     if not loaded.get('already_configured', True):
         # We're making changes
-        pchanges.update({
-            "diff": loaded.get('diff', '')
-        })
-        ret.update({
-            'pchanges': pchanges
-        })
         if test:
-            for k, v in pchanges.items():
-                ret.update({
-                    "comment": "{}:\n{}\n\n{}".format(k, v, ret.get("comment", ''))
-                })
-            ret.update({
-                'result': None,
-            })
+            ret['result'] = None
             return ret
         # Not test, changes were applied
         ret.update({
             'result': True,
-            'changes': pchanges,
-            'comment': "Configuration changed!\n{}".format(ret.get('comment', ''))
+            'changes': changes,
+            'comment': "Configuration changed!\n{}".format(loaded['comment'])
         })
         return ret
     # No changes
     ret.update({
-        'result': True
+        'result': True,
+        'changes': {}
     })
     return ret