saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Merge pull request #38908 from bobrik/show-changes-for-serialize

Browse source 
Deprecate show_diff for file.serialize to mimic file.managed, closes #38853
This commit is contained in:
Mike Place 2017-01-27 10:15:36 -07:00 • committed by GitHub
commit 58543d5cbf
1 changed files with 22 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
salt/states/file.py
View file

@ -4950,7 +4950,8 @@ def serialize(name,
mode=None,
backup='',
makedirs=False,
show_diff=True,
show_diff=None,
show_changes=True,
create=True,
merge_if_exists=False,
**kwargs):
@ -5005,7 +5006,14 @@ def serialize(name,
.. versionadded:: 2014.1.3
show_diff
If set to False, the diff will not be shown.
DEPRECATED: Please use show_changes.
If set to ``False``, the diff will not be shown in the return data if
changes are made.
show_changes
Output a unified diff of the old file and the new file. If ``False``
return a boolean if any changes were made.
create
Default is True, if create is set to False then the file will only be
@ -5137,6 +5145,14 @@ def serialize(name,
# Make sure that any leading zeros stripped by YAML loader are added back
mode = salt.utils.normalize_mode(mode)
if show_diff is not None:
show_changes = show_diff
msg = (
'The \'show_diff\' argument to the file.serialized state has been '
'deprecated, please use \'show_changes\' instead.'
)
salt.utils.warn_until('Oxygen', msg)
if __opts__['test']:
ret['changes'] = __salt__['file.check_managed_changes'](
name=name,
@ -5159,10 +5175,12 @@ def serialize(name,
ret['result'] = None
ret['comment'] = 'Dataset will be serialized and stored into {0}'.format(
name)
if not show_changes:
ret['changes']['diff'] = '<show_changes=False>'
else:
ret['result'] = True
ret['comment'] = 'The file {0} is in the correct state'.format(name)
return ret
return __salt__['file.manage_file'](name=name,
@ -5177,7 +5195,7 @@ def serialize(name,
backup=backup,
makedirs=makedirs,
template=None,
show_changes=show_diff,
show_changes=show_changes,
contents=contents)