diff --git a/changelogs/fragments/220_synchronize_add_quiet_option.yml b/changelogs/fragments/220_synchronize_add_quiet_option.yml new file mode 100644 index 0000000..e64a50c --- /dev/null +++ b/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). diff --git a/plugins/modules/synchronize.py b/plugins/modules/synchronize.py index d65e08f..dd49d62 100644 --- a/plugins/modules/synchronize.py +++ b/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__': diff --git a/tests/integration/inventory b/tests/integration/inventory new file mode 100644 index 0000000..5d6e706 --- /dev/null +++ b/tests/integration/inventory @@ -0,0 +1,2 @@ +[testgroup] +testhost ansible_connection="local" ansible_pipelining="yes" ansible_python_interpreter="/Users/mandkulk/venv3.9/bin/python" diff --git a/tests/integration/targets/synchronize/tasks/main.yml b/tests/integration/targets/synchronize/tasks/main.yml index d6dcdad..52a677c 100644 --- a/tests/integration/targets/synchronize/tasks/main.yml +++ b/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