Merge 8cdf51b3b3 into 9a2ddcd713

Remove skippy callback

SUMMARY
Fixes: #350
Signed-off-by: Abhijeet Kasurde akasurde@redhat.com
ISSUE TYPE

Bugfix Pull Request

Reviewed-by: Hideki Saito <saito@fgrep.org>

.github/BOTMETA.yml

@@ -40,7 +40,6 @@ files:
     labels: debug
   $plugins/patch.py:
     labels: patch
-  $plugins/skippy.py:
   $plugins/synchronize.py:
     labels: synchronize
   $plugins/timer.py:

changelogs/fragments/428-synchronize-user-defined-out-format.yml

@@ -0,0 +1,2 @@
+minor_changes:
+  - synchronize - user-defined ``--out-format`` in ``rsync_opts`` is now honored in the returned output. (https://github.com/ansible-collections/ansible.posix/pull/428)

changelogs/fragments/556_remove_skippy_callback.yml

@@ -0,0 +1,2 @@
+removed_features:
+  - skippy - Remove skippy pluglin as it is no longer supported(https://github.com/ansible-collections/ansible.posix/issues/350).

meta/runtime.yml

@@ -1,8 +1,2 @@
 ---
 requires_ansible: ">=2.14.0"
-plugin_routing:
-  callback:
-    skippy:
-      deprecation:
-        removal_date: "2022-06-01"
-        warning_text: See the plugin documentation for more details

plugins/callback/skippy.py

@@ -1,43 +0,0 @@
-# (c) 2012-2014, Michael DeHaan <michael.dehaan@gmail.com>
-# (c) 2017 Ansible Project
-# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-
-# Make coding more python3-ish
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-DOCUMENTATION = '''
-    name: skippy
-    type: stdout
-    requirements:
-      - set as main display callback
-    short_description: Ansible screen output that ignores skipped status
-    deprecated:
-      why: The 'default' callback plugin now supports this functionality
-      removed_at_date: '2022-06-01'
-      alternative: "'default' callback plugin with 'display_skipped_hosts = no' option"
-    extends_documentation_fragment:
-      - default_callback
-    description:
-      - This callback does the same as the default except it does not output skipped host/task/item status
-'''
-
-from ansible.plugins.callback.default import CallbackModule as CallbackModule_default
-
-
-class CallbackModule(CallbackModule_default):
-
-    '''
-    This is the default callback interface, which simply prints messages
-    to stdout when new callback events are received.
-    '''
-
-    CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'stdout'
-    CALLBACK_NAME = 'ansible.posix.skippy'
-
-    def v2_runner_on_skipped(self, result):
-        pass
-
-    def v2_runner_item_on_skipped(self, result):
-        pass

plugins/modules/synchronize.py

@@ -366,6 +366,7 @@ EXAMPLES = r'''
 
 import os
 import errno
+import re
 
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils._text import to_bytes, to_native
@@ -597,8 +598,19 @@ def main():
                 module.fail_json(msg='Hardlinking into a subdirectory of the source would cause recursion. %s and %s' % (destination_path, dest))
             cmd.append('--link-dest=%s' % link_path)
 
-    changed_marker = '<<CHANGED>>'
+    # find the last specified out-format
-    cmd.append('--out-format=%s' % shlex_quote(changed_marker + '%i %n%L'))
+    out_format = ''
+    for rsync_opt in rsync_opts:
+        if rsync_opt.startswith('--out-format='):
+            out_format = rsync_opt.replace('--out-format=', '', 1)
+
+    # force a known out-format so we can test for changes and return a known format of diff
+    diff_marker = 'DIFF'
+    if out_format == '' or module._diff:
+        diff_detail = '%n%L'
+    else:
+        diff_detail = ''
+    cmd.append('--out-format=%s' % shlex_quote('%s//%s//%%i//%s' % (out_format, diff_marker, diff_detail)))
 
     cmd.append(shlex_quote(source))
     cmd.append(shlex_quote(dest))
@@ -624,18 +636,36 @@ def main():
     if rc:
         return module.fail_json(msg=err, rc=rc, cmd=cmdstr)
 
-    if link_dest:
+    changed = False
-        # a leading period indicates no change
+    diff = []
-        changed = (changed_marker + '.') not in out
+    out_lines = []
-    else:
+    # remove forced out-format suffix, check for file changes
-        changed = changed_marker in out
+    for line in out.split('\n'):
+        match = re.match('(.*)//%s//(...*?)//(.*)$' % diff_marker, line)
+        if match:
+            default_diff = '%s %s' % (match.group(2), match.group(3))
 
-    out_clean = out.replace(changed_marker, '')
+            if module._diff:
-    out_lines = out_clean.split('\n')
+                diff.append(default_diff)
+
+            if out_format == '':
+                out_lines.append(default_diff)
+            else:
+                out_lines.append(match.group(1))
+
+            # a period in the first position indicates no changes to the file's contents
+            # a period in every other position from the third onward indicates no attribute changes
+            if not re.match(r'\..\.*$', match.group(2)):
+                changed = True
+        else:
+            out_lines.append(line)
+
+    out_clean = '\n'.join(out_lines)
     while '' in out_lines:
         out_lines.remove('')
+
     if module._diff:
-        diff = {'prepared': out_clean}
+        diff = {'prepared': '\n'.join(diff)}
         return module.exit_json(changed=changed, msg=out_clean,
                                 rc=rc, cmd=cmdstr, stdout_lines=out_lines,
                                 diff=diff)