Merge c401a5d331 into 5321a9ecb5

.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:

CHANGELOG.rst

@@ -4,23 +4,6 @@ ansible.posix Release Notes
 
 .. contents:: Topics
 
-v1.6.1
-======
-
-Release Summary
----------------
-
-This is the bugfix release of the stable version ``ansible.posix`` collection.
-This changelog contains all changes to the modules and plugins
-in this collection that have been added after the release of
-``ansible.posix`` 1.6.1.
-
-Bugfixes
---------
-
-- acl - Fixed to set ACLs on paths mounted with NFS version 4 correctly (https://github.com/ansible-collections/ansible.posix/issues/240).
-- mount - Handle ``boot`` option on Linux, NetBSD and OpenBSD correctly (https://github.com/ansible-collections/ansible.posix/issues/364).
-- skippy - Revert removal of skippy plugin. It will be removed in version 2.0.0 (https://github.com/ansible-collections/ansible.posix/issues/573).
 
 v1.6.0
 ======

changelogs/changelog.yaml

@@ -405,27 +405,3 @@ releases:
     - dropping-ansible29.yml
     - test-reqs.yml
     release_date: '2024-09-11'
-  1.6.1:
-    changes:
-      bugfixes:
-      - acl - Fixed to set ACLs on paths mounted with NFS version 4 correctly (https://github.com/ansible-collections/ansible.posix/issues/240).
-      - mount - Handle ``boot`` option on Linux, NetBSD and OpenBSD correctly (https://github.com/ansible-collections/ansible.posix/issues/364).
-      - skippy - Revert removal of skippy plugin. It will be removed in version 2.0.0
-        (https://github.com/ansible-collections/ansible.posix/issues/573).
-      release_summary: 'This is the bugfix release of the stable version ``ansible.posix``
-        collection.
-
-        This changelog contains all changes to the modules and plugins
-
-        in this collection that have been added after the release of
-
-        ``ansible.posix`` 1.6.1.'
-    fragments:
-    - 1.6.1.yml
-    - 365-boot-linux.yml
-    - 566_bump_version_161.yml
-    - 567_remove_version_added.yml
-    - 570_nfs4_acl.yml
-    - 571_ci_bump_core_version.yml
-    - 572_revert_removal_of_skippy.yml
-    release_date: '2024-10-11'

changelogs/fragments/220_synchronize_add_quiet_option.yml

@@ -0,0 +1,2 @@
+minor_changes:
+- synchronize - add the ``quiet`` option to suppress non-error messages (https://github.com/ansible-collections/ansible.posix/issues/171).

changelogs/fragments/566_bump_version_161.yml

@@ -0,0 +1,3 @@
+---
+trivial:
+  - Bump version to 1.6.1 for next release.

changelogs/fragments/567_remove_version_added.yml

@@ -0,0 +1,3 @@
+---
+trivial:
+  - mount - remove wrong version_added section from ``opts_no_log``.

changelogs/fragments/570_nfs4_acl.yml

@@ -0,0 +1,3 @@
+---
+bugfixes:
+  - acl - Fixed to set ACLs on paths mounted with NFS version 4 correctly (https://github.com/ansible-collections/ansible.posix/issues/240).

changelogs/fragments/571_ci_bump_core_version.yml

@@ -0,0 +1,3 @@
+---
+trivial:
+  - Bump ansible-core version to 2.19 of devel branch and add 2.18 to CI.

meta/runtime.yml

@@ -1,8 +1,2 @@
 ---
-requires_ansible: ">=2.14.0"
-plugin_routing:
-  callback:
-    skippy:
-      deprecation:
-        removal_date: "2024-12-05"
-        warning_text: See the plugin documentation for more details
+requires_ansible: ">=2.15.0"

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: '2024-12-05'
-      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/mount.py

@@ -850,6 +850,9 @@ def main():
             args['warnings'].append("Ignore the 'boot' due to 'opts' contains 'noauto'.")
         elif not module.params['boot']:
             args['boot'] = 'no'
+            if 'defaults' in opts:
+                args['warnings'].append("Ignore the 'boot' due to 'opts' contains 'defaults'.")
+            else:
                 opts.append('noauto')
                 args['opts'] = ','.join(opts)
 

plugins/modules/synchronize.py

@@ -8,7 +8,6 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-
 DOCUMENTATION = r'''
 ---
 module: synchronize
@@ -204,6 +203,12 @@ options:
     description: Internal use only. See O(use_ssh_args) for ssh arg settings.
     type: str
     required: false
+  quiet:
+    description:
+      - This option specifies quiet option which on true suppresses the output.
+    type: bool
+    default: false
+    version_added: 1.6.0
 
 notes:
    - C(rsync) must be installed on both the local and remote host.
@@ -361,6 +366,12 @@ EXAMPLES = r'''
         src: /tmp/localpath/
         dest: /tmp/remotepath
         rsync_path: /usr/gnu/bin/rsync
+
+- name: Synchronization with quiet option enabled
+  ansible.posix.synchronize:
+    src: some/relative/path
+    dest: /some/absolute/path
+    quiet: true
 '''
 
 
@@ -438,6 +449,7 @@ def main():
             delay_updates=dict(type='bool', default=True),
             mode=dict(type='str', default='push', choices=['pull', 'push']),
             link_dest=dict(type='list', elements='path'),
+            quiet=dict(type='bool', default=False)
         ),
         supports_check_mode=True,
     )
@@ -478,6 +490,7 @@ def main():
     verify_host = module.params['verify_host']
     link_dest = module.params['link_dest']
     delay_updates = module.params['delay_updates']
+    quiet = module.params['quiet']
 
     if '/' not in rsync:
         rsync = module.get_bin_path(rsync, required=True)
@@ -602,6 +615,9 @@ def main():
 
     cmd.append(shlex_quote(source))
     cmd.append(shlex_quote(dest))
+    if quiet:
+        cmd.append('--quiet')
+
     cmdstr = ' '.join(cmd)
 
     # If we are using password authentication, write the password into the pipe
@@ -634,14 +650,17 @@ def main():
     out_lines = out_clean.split('\n')
     while '' in out_lines:
         out_lines.remove('')
-    if module._diff:
-        diff = {'prepared': out_clean}
-        return module.exit_json(changed=changed, msg=out_clean,
-                                rc=rc, cmd=cmdstr, stdout_lines=out_lines,
-                                diff=diff)
 
-    return module.exit_json(changed=changed, msg=out_clean,
-                            rc=rc, cmd=cmdstr, stdout_lines=out_lines)
+    result = dict(changed=changed, rc=rc, cmd=cmdstr, stdout_lines=out_lines, msg=out_clean)
+
+    if quiet:
+        changes = out.count(changed_marker) if changed else 0
+        result['msg'] = "%s files/directories have been synchronized" % changes
+
+    if module._diff:
+        result['diff'] = {'prepared': out_clean}
+
+    return module.exit_json(**result)
 
 
 if __name__ == '__main__':

tests/integration/inventory

@@ -0,0 +1,2 @@
+[testgroup]
+testhost ansible_connection="local" ansible_pipelining="yes" ansible_python_interpreter="/Users/mandkulk/venv3.9/bin/python"

tests/integration/targets/mount/tasks/main.yml

@@ -472,25 +472,6 @@
         path: /tmp/myfs
         state: absent
 
-    - name: Mount the FS with noauto option and defaults
-      ansible.posix.mount:
-        path: /tmp/myfs
-        src: /tmp/myfs.img
-        fstype: ext3
-        state: mounted
-        boot: false
-      register: mount_info
-
-    - name: Assert the mount without noauto was successful
-      ansible.builtin.assert:
-        that:
-          - "'noauto' in mount_info['opts'].split(',')"
-
-    - name: Unmount FS
-      ansible.posix.mount:
-        path: /tmp/myfs
-        state: absent
-
     - name: Remove the test FS
       ansible.builtin.file:
         path: '{{ item }}'

tests/integration/targets/synchronize/tasks/main.yml

@@ -339,6 +339,37 @@
       - stat_result_b.stat.exists == True
       - stat_result_b.stat.checksum == '2aae6c35c94fcfb415dbe95f408b9ce91ee846ed'
 
+- name: Synchronize files with quiet option
+  ansible.posix.synchronize:
+    src: '{{ output_dir }}/foo.txt'
+    dest: '{{ output_dir }}/foo.result'
+    quiet: true
+  register: sync_result
+
+- name: Assertion for synchronize with quiet option
+  ansible.builtin.assert:
+    that:
+      - '''files/directories have been synchronized'' in sync_result.msg'
+
+- name: Cleanup
+  ansible.builtin.file:
+    state: absent
+    path: '{{ output_dir }}/{{ item }}'
+  loop:
+    - foo.result
+    - bar.result
+
+- name: Synchronize files without quiet option
+  ansible.posix.synchronize:
+    src: '{{ output_dir }}/foo.txt'
+    dest: '{{ output_dir }}/foo.result'
+  register: sync_result
+
+- name: Assertion for synchronize without quiet option
+  ansible.builtin.assert:
+    that:
+      - '''files/directories have been synchronized'' not in sync_result.msg'
+
 - name: Cleanup
   ansible.builtin.file:
     state: absent