From d0d7f7d362759e6bff489e7a9cef96397045b843 Mon Sep 17 00:00:00 2001 From: Mandar Kulkarni Date: Sun, 11 Jul 2021 22:39:10 -0700 Subject: [PATCH 01/11] Adding parameter to synchronize module to suppress verbose output and print error only --- plugins/modules/synchronize.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/plugins/modules/synchronize.py b/plugins/modules/synchronize.py index 40fae71..8444de7 100644 --- a/plugins/modules/synchronize.py +++ b/plugins/modules/synchronize.py @@ -419,6 +419,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='str'), + print_err_only=dict(type='bool',default=False) ), supports_check_mode=True, ) @@ -459,6 +460,7 @@ def main(): verify_host = module.params['verify_host'] link_dest = module.params['link_dest'] delay_updates = module.params['delay_updates'] + print_err_only = module.params['print_err_only'] if '/' not in rsync: rsync = module.get_bin_path(rsync, required=True) @@ -608,6 +610,10 @@ def main(): else: (rc, out, err) = module.run_command(cmdstr) + # If print_errors_only is true, supress the verbose output by suppressing changes but allowing errors + if print_err_only: + return module.fail_json(msg=err) + if rc: return module.fail_json(msg=err, rc=rc, cmd=cmdstr) From adb459b64e027df473a38a80a73a2cb32465ecf6 Mon Sep 17 00:00:00 2001 From: Mandar Kulkarni Date: Mon, 12 Jul 2021 09:00:16 -0700 Subject: [PATCH 02/11] Adding rsync parameter 'quiet' to synchronize --- plugins/modules/synchronize.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/plugins/modules/synchronize.py b/plugins/modules/synchronize.py index 8444de7..393b014 100644 --- a/plugins/modules/synchronize.py +++ b/plugins/modules/synchronize.py @@ -419,7 +419,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='str'), - print_err_only=dict(type='bool',default=False) + quiet=dict(type='bool',default=False) ), supports_check_mode=True, ) @@ -460,7 +460,7 @@ def main(): verify_host = module.params['verify_host'] link_dest = module.params['link_dest'] delay_updates = module.params['delay_updates'] - print_err_only = module.params['print_err_only'] + quiet = module.params['quiet'] if '/' not in rsync: rsync = module.get_bin_path(rsync, required=True) @@ -610,9 +610,9 @@ def main(): else: (rc, out, err) = module.run_command(cmdstr) - # If print_errors_only is true, supress the verbose output by suppressing changes but allowing errors - if print_err_only: - return module.fail_json(msg=err) + # If quiet is true, supress the verbose output by suppressing changes but allowing errors + if quiet: + cmd.append('--quiet') if rc: return module.fail_json(msg=err, rc=rc, cmd=cmdstr) From 19a961c118f37282602effdb302c0275aceb5b5e Mon Sep 17 00:00:00 2001 From: Mandar Kulkarni Date: Mon, 12 Jul 2021 09:13:16 -0700 Subject: [PATCH 03/11] Added documentation and example for quiet option --- plugins/modules/synchronize.py | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/plugins/modules/synchronize.py b/plugins/modules/synchronize.py index 393b014..23db5fb 100644 --- a/plugins/modules/synchronize.py +++ b/plugins/modules/synchronize.py @@ -186,6 +186,11 @@ options: type: bool default: true version_added: '1.3.0' + quiet: + description: + - This specifies rsync quiet option which on yes/true suppresses the non-error messages + type: bool + default: no notes: - rsync must be installed on both the local and remote host. @@ -343,6 +348,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: yes ''' @@ -610,7 +621,6 @@ def main(): else: (rc, out, err) = module.run_command(cmdstr) - # If quiet is true, supress the verbose output by suppressing changes but allowing errors if quiet: cmd.append('--quiet') From fd95dcade203087db74bd036ff0f4f80210a2250 Mon Sep 17 00:00:00 2001 From: Mandar Kulkarni Date: Mon, 12 Jul 2021 10:21:36 -0700 Subject: [PATCH 04/11] Fix: moving conditional to correct place --- plugins/modules/synchronize.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/plugins/modules/synchronize.py b/plugins/modules/synchronize.py index 23db5fb..7bca717 100644 --- a/plugins/modules/synchronize.py +++ b/plugins/modules/synchronize.py @@ -191,6 +191,7 @@ options: - This specifies rsync quiet option which on yes/true suppresses the non-error messages type: bool default: no + version_added: '1.3.0' notes: - rsync must be installed on both the local and remote host. @@ -602,6 +603,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 @@ -621,9 +625,6 @@ def main(): else: (rc, out, err) = module.run_command(cmdstr) - if quiet: - cmd.append('--quiet') - if rc: return module.fail_json(msg=err, rc=rc, cmd=cmdstr) From a5227da4c408cf0af674b4bf1daf033804756dc4 Mon Sep 17 00:00:00 2001 From: Mandar Kulkarni Date: Mon, 12 Jul 2021 12:00:24 -0700 Subject: [PATCH 05/11] Added Changelog fragment --- changelogs/fragments/220_synchronize_add_quiet_option.yml | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 changelogs/fragments/220_synchronize_add_quiet_option.yml 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..a9a7cb1 --- /dev/null +++ b/changelogs/fragments/220_synchronize_add_quiet_option.yml @@ -0,0 +1,2 @@ +minor_changes: +- synchronize - add the ``quiet`` option to supress non-error messages (https://github.com/ansible-collections/ansible.posix/issues/171). From 26a968e1f00c2bdd6de18d85fc2c2c72b94488d9 Mon Sep 17 00:00:00 2001 From: Mandar Kulkarni Date: Tue, 27 Jul 2021 15:16:58 -0700 Subject: [PATCH 06/11] Modifying based on feedback --- plugins/modules/synchronize.py | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/plugins/modules/synchronize.py b/plugins/modules/synchronize.py index 7bca717..2907fa2 100644 --- a/plugins/modules/synchronize.py +++ b/plugins/modules/synchronize.py @@ -188,7 +188,7 @@ options: version_added: '1.3.0' quiet: description: - - This specifies rsync quiet option which on yes/true suppresses the non-error messages + - This option specifies quiet option which on true suppresses the output. type: bool default: no version_added: '1.3.0' @@ -350,7 +350,7 @@ EXAMPLES = r''' dest: /tmp/remotepath rsync_path: /usr/gnu/bin/rsync -- name: Synchronization with --quiet option enabled +- name: Synchronization with quiet option enabled ansible.posix.synchronize: src: some/relative/path dest: /some/absolute/path @@ -638,15 +638,20 @@ def main(): out_lines = out_clean.split('\n') while '' in out_lines: out_lines.remove('') + + result = dict(changed=changed, rc=rc, cmd=cmdstr) + + if quiet: + result['msg'] = "OUTPUT IS HIDDEN DUE TO 'quiet=true'" + result['stdout_lines'] = [] + else: + result['msg'] = out_clean + result['std_out'] = out_lines + 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['diff'] = {'prepare': out_clean} + return module.exit_json(**result) if __name__ == '__main__': main() From 9dbedb6d4c160d5c0c8122de1e372492756908c8 Mon Sep 17 00:00:00 2001 From: mandar Date: Tue, 13 Jul 2021 18:08:26 -0400 Subject: [PATCH 07/11] Adding tests, corrections --- .../220_synchronize_add_quiet_option.yml | 2 +- plugins/modules/synchronize.py | 4 +- .../targets/synchronize/tasks/main.yml | 56 ++++++++----------- 3 files changed, 26 insertions(+), 36 deletions(-) diff --git a/changelogs/fragments/220_synchronize_add_quiet_option.yml b/changelogs/fragments/220_synchronize_add_quiet_option.yml index a9a7cb1..e64a50c 100644 --- a/changelogs/fragments/220_synchronize_add_quiet_option.yml +++ b/changelogs/fragments/220_synchronize_add_quiet_option.yml @@ -1,2 +1,2 @@ minor_changes: -- synchronize - add the ``quiet`` option to supress non-error messages (https://github.com/ansible-collections/ansible.posix/issues/171). +- 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 2907fa2..b0fee74 100644 --- a/plugins/modules/synchronize.py +++ b/plugins/modules/synchronize.py @@ -431,7 +431,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='str'), - quiet=dict(type='bool',default=False) + quiet=dict(type='bool', default=False) ), supports_check_mode=True, ) @@ -604,7 +604,7 @@ def main(): cmd.append(shlex_quote(source)) cmd.append(shlex_quote(dest)) if quiet: - cmd.append('--quiet') + cmd.append('--quiet') cmdstr = ' '.join(cmd) diff --git a/tests/integration/targets/synchronize/tasks/main.yml b/tests/integration/targets/synchronize/tasks/main.yml index 125a406..0fe2a3b 100644 --- a/tests/integration/targets/synchronize/tasks/main.yml +++ b/tests/integration/targets/synchronize/tasks/main.yml @@ -265,46 +265,36 @@ - directory_a/foo.txt - directory_a - directory_b - -- name: setup - test for source with working dir with spaces in path - file: - state: directory - path: '{{output_dir}}/{{item}}' - delegate_to: '{{ inventory_hostname }}' - with_items: - - 'directory a' - - 'directory b' -- name: setup - create test new files - copy: - dest: '{{output_dir}}/directory a/{{item}}' - mode: '0644' - content: 'hello world' - with_items: - - foo.txt - delegate_to: '{{ inventory_hostname }}' -- name: copy source with spaces in dir path +- name: synchronize files with quiet option synchronize: - src: '{{output_dir}}/directory a/foo.txt' - dest: '{{output_dir}}/directory b/' - delegate_to: '{{ inventory_hostname }}' + src: '{{output_dir}}/foo.txt' + dest: '{{output_dir}}/foo.result' + quiet: true register: sync_result ignore_errors: true -- name: get stat information for directory_b - stat: - path: '{{ output_dir }}/directory b/foo.txt' - register: stat_result_b - assert: that: - - '''changed'' in sync_result' - - sync_result.changed == true - - stat_result_b.stat.exists == True - - stat_result_b.stat.checksum == '2aae6c35c94fcfb415dbe95f408b9ce91ee846ed' + - '''--quiet'' in sync_result.cmd' - name: Cleanup file: state: absent path: '{{output_dir}}/{{item}}' with_items: - - 'directory b/foo.txt' - - 'directory a/foo.txt' - - 'directory a' - - 'directory b' + - foo.result + - bar.result +- name: synchronize files without quiet option + synchronize: + src: '{{output_dir}}/foo.txt' + dest: '{{output_dir}}/foo.result' + register: sync_result + ignore_errors: true +- assert: + that: + - '''--quiet'' not in sync_result.cmd' +- name: Cleanup + file: + state: absent + path: '{{output_dir}}/{{item}}' + with_items: + - foo.result + - bar.result From 41bbe0dcbd19323331b813c9ba704ad84abc36db Mon Sep 17 00:00:00 2001 From: Mandar Kulkarni Date: Wed, 28 Jul 2021 15:11:25 -0700 Subject: [PATCH 08/11] Modifying output to be displayed based on feedback --- plugins/modules/synchronize.py | 13 +++++-------- .../integration/targets/synchronize/tasks/main.yml | 4 ++-- 2 files changed, 7 insertions(+), 10 deletions(-) diff --git a/plugins/modules/synchronize.py b/plugins/modules/synchronize.py index b0fee74..eba9b12 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 @@ -639,19 +638,17 @@ def main(): while '' in out_lines: out_lines.remove('') - result = dict(changed=changed, rc=rc, cmd=cmdstr) + result = dict(changed=changed, rc=rc, cmd=cmdstr, stdout_lines=out_lines, msg=out_clean) if quiet: - result['msg'] = "OUTPUT IS HIDDEN DUE TO 'quiet=true'" - result['stdout_lines'] = [] - else: - result['msg'] = out_clean - result['std_out'] = out_lines + changes = len(out_lines) - 1 if len(out_lines) >= 1 else 0 + result['msg'] = "%s files/directories have been synchronized" % changes if module._diff: - result['diff'] = {'prepare': out_clean} + result['diff'] = {'prepared': out_clean} return module.exit_json(**result) + if __name__ == '__main__': main() diff --git a/tests/integration/targets/synchronize/tasks/main.yml b/tests/integration/targets/synchronize/tasks/main.yml index 0fe2a3b..df13665 100644 --- a/tests/integration/targets/synchronize/tasks/main.yml +++ b/tests/integration/targets/synchronize/tasks/main.yml @@ -274,7 +274,7 @@ ignore_errors: true - assert: that: - - '''--quiet'' in sync_result.cmd' + - '''files/directories have been synchronized'' in sync_result.msg' - name: Cleanup file: state: absent @@ -290,7 +290,7 @@ ignore_errors: true - assert: that: - - '''--quiet'' not in sync_result.cmd' + - '''files/directories have been synchronized'' not in sync_result.msg' - name: Cleanup file: state: absent From 7af8b051050b3b09bf95a962876ac5c4ee577a9d Mon Sep 17 00:00:00 2001 From: Mandar Kulkarni Date: Thu, 5 Aug 2021 16:15:45 -0700 Subject: [PATCH 09/11] Modify based on feedback --- plugins/modules/synchronize.py | 2 +- .../integration/targets/synchronize/tasks/main.yml | 14 +++++++------- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/plugins/modules/synchronize.py b/plugins/modules/synchronize.py index eba9b12..9bbd307 100644 --- a/plugins/modules/synchronize.py +++ b/plugins/modules/synchronize.py @@ -641,7 +641,7 @@ def main(): result = dict(changed=changed, rc=rc, cmd=cmdstr, stdout_lines=out_lines, msg=out_clean) if quiet: - changes = len(out_lines) - 1 if len(out_lines) >= 1 else 0 + changes = out.count(changed_marker) if changed else 0 result['msg'] = "%s files/directories have been synchronized" % changes if module._diff: diff --git a/tests/integration/targets/synchronize/tasks/main.yml b/tests/integration/targets/synchronize/tasks/main.yml index df13665..969f528 100644 --- a/tests/integration/targets/synchronize/tasks/main.yml +++ b/tests/integration/targets/synchronize/tasks/main.yml @@ -267,8 +267,8 @@ - directory_b - name: synchronize files with quiet option synchronize: - src: '{{output_dir}}/foo.txt' - dest: '{{output_dir}}/foo.result' + src: '{{ output_dir }}/foo.txt' + dest: '{{ output_dir }}/foo.result' quiet: true register: sync_result ignore_errors: true @@ -278,14 +278,14 @@ - name: Cleanup file: state: absent - path: '{{output_dir}}/{{item}}' - with_items: + path: '{{ output_dir }}/{{ item }}' + loop: - foo.result - bar.result - name: synchronize files without quiet option synchronize: - src: '{{output_dir}}/foo.txt' - dest: '{{output_dir}}/foo.result' + src: '{{ output_dir }}/foo.txt' + dest: '{{ output_dir }}/foo.result' register: sync_result ignore_errors: true - assert: @@ -294,7 +294,7 @@ - name: Cleanup file: state: absent - path: '{{output_dir}}/{{item}}' + path: '{{ output_dir }}/{{ item }}' with_items: - foo.result - bar.result From 6deb45c943543999cb59ec6cef42dc6c028c5b4f Mon Sep 17 00:00:00 2001 From: Mandar Kulkarni Date: Thu, 5 Aug 2021 16:58:51 -0700 Subject: [PATCH 10/11] Minor fix, remove ignore_errors --- tests/integration/targets/synchronize/tasks/main.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/tests/integration/targets/synchronize/tasks/main.yml b/tests/integration/targets/synchronize/tasks/main.yml index 969f528..601f648 100644 --- a/tests/integration/targets/synchronize/tasks/main.yml +++ b/tests/integration/targets/synchronize/tasks/main.yml @@ -271,7 +271,6 @@ dest: '{{ output_dir }}/foo.result' quiet: true register: sync_result - ignore_errors: true - assert: that: - '''files/directories have been synchronized'' in sync_result.msg' @@ -287,7 +286,6 @@ src: '{{ output_dir }}/foo.txt' dest: '{{ output_dir }}/foo.result' register: sync_result - ignore_errors: true - assert: that: - '''files/directories have been synchronized'' not in sync_result.msg' From 92dc532b49741c547dad7d32c465db5617663c84 Mon Sep 17 00:00:00 2001 From: Mandar Kulkarni Date: Thu, 5 Aug 2021 17:00:03 -0700 Subject: [PATCH 11/11] Minor fix, with_items --- tests/integration/targets/synchronize/tasks/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/integration/targets/synchronize/tasks/main.yml b/tests/integration/targets/synchronize/tasks/main.yml index 601f648..ba9ff87 100644 --- a/tests/integration/targets/synchronize/tasks/main.yml +++ b/tests/integration/targets/synchronize/tasks/main.yml @@ -293,6 +293,6 @@ file: state: absent path: '{{ output_dir }}/{{ item }}' - with_items: + loop: - foo.result - bar.result