synchronize: fix changed status with link_dest (#812)

* synchronize: fix changed status with link_dest

With link_dest the module runs rsync with -vv, which also itemizes
unchanged files as '.f' followed by spaces. Any such line made the
module report no change, even when other files in the same run were
transferred, deleted or had their permissions updated.

Treat a line as unchanged only when it starts with a period and has no
attribute changes, which is how rsync lists files it did not touch.

Signed-off-by: Luca Marsella <marsluca7@gmail.com>
Assisted-by: Claude Opus 5.5

* synchronize: don't make link_dest test files world-readable

SonarCloud flags the new test tasks for granting access to others.
The test does not need it, so use 0750 and 0640 instead.

Signed-off-by: Luca Marsella <marsluca7@gmail.com>

* synchronize: read rsync markers only at the start of a line

The link_dest check split the whole output on the marker, so a file
name that contains the marker made a no-op sync report a change.

Signed-off-by: Luca Marsella <marsluca7@gmail.com>

---------

Signed-off-by: Luca Marsella <marsluca7@gmail.com>
This commit is contained in:
Luca Marsella
2026-11-16 16:16:54 +09:00
committed by GitHub
parent 4bd26a3cc6
commit 4daa61d294
3 changed files with 105 additions and 2 deletions
@@ -0,0 +1,5 @@
bugfixes:
- synchronize - report ``changed`` correctly when ``link_dest`` is used. Previously the module
reported no change as soon as rsync listed one unchanged file, even if other files were
transferred, deleted or had their attributes updated
(https://github.com/ansible-collections/ansible.posix/issues/716).
+4 -2
View File
@@ -632,8 +632,10 @@ def main():
return module.fail_json(msg=err, rc=rc, cmd=cmdstr)
if link_dest:
# a leading period indicates no change
changed = (changed_marker + '.') not in out
# -vv also itemizes unchanged items: a period, the file type, then
# spaces (e.g. '.f foo'). Every other itemized line is a change.
items = [line[len(changed_marker):] for line in out.splitlines() if line.startswith(changed_marker)]
changed = any(not (item.startswith('.') and item[2:3] == ' ') for item in items)
else:
changed = changed_marker in out
@@ -299,6 +299,102 @@
- directory_a
- directory_b
- name: Setup - directories for link_dest change detection
ansible.builtin.file:
state: directory
path: "{{ output_dir }}/{{ item }}"
mode: "0750"
loop:
- link_dest_src
- link_dest_dst
- link_dest_base
- name: Setup - create source files for link_dest change detection
ansible.builtin.copy:
dest: "{{ output_dir }}/link_dest_src/{{ item }}"
mode: "0640"
content: hello world
loop:
- foo.txt
- bar.txt
# the module's output marker in a file name must not count as a change
- "<<CHANGED>>baz.txt"
- name: Synchronize a directory using link_dest
ansible.posix.synchronize:
src: "{{ output_dir }}/link_dest_src/"
dest: "{{ output_dir }}/link_dest_dst/"
link_dest:
- "{{ output_dir }}/link_dest_base"
register: sync_initial
delegate_to: "{{ inventory_hostname }}"
- name: Synchronize the same directory again using link_dest
ansible.posix.synchronize:
src: "{{ output_dir }}/link_dest_src/"
dest: "{{ output_dir }}/link_dest_dst/"
link_dest:
- "{{ output_dir }}/link_dest_base"
register: sync_unchanged
delegate_to: "{{ inventory_hostname }}"
- name: Change the content of one source file only
ansible.builtin.copy:
dest: "{{ output_dir }}/link_dest_src/bar.txt"
mode: "0640"
content: goodbye world
# rsync -vv still lists the unchanged foo.txt, which used to hide the change
- name: Synchronize using link_dest after a content change
ansible.posix.synchronize:
src: "{{ output_dir }}/link_dest_src/"
dest: "{{ output_dir }}/link_dest_dst/"
link_dest:
- "{{ output_dir }}/link_dest_base"
register: sync_content
delegate_to: "{{ inventory_hostname }}"
- name: Change the permissions of one source file only
ansible.builtin.file:
path: "{{ output_dir }}/link_dest_src/foo.txt"
mode: "0600"
- name: Synchronize using link_dest after a permission change
ansible.posix.synchronize:
src: "{{ output_dir }}/link_dest_src/"
dest: "{{ output_dir }}/link_dest_dst/"
link_dest:
- "{{ output_dir }}/link_dest_base"
register: sync_mode
delegate_to: "{{ inventory_hostname }}"
- name: Synchronize again using link_dest after the changes
ansible.posix.synchronize:
src: "{{ output_dir }}/link_dest_src/"
dest: "{{ output_dir }}/link_dest_dst/"
link_dest:
- "{{ output_dir }}/link_dest_base"
register: sync_unchanged_again
delegate_to: "{{ inventory_hostname }}"
- name: Ensure link_dest reports a change only when something changed
ansible.builtin.assert:
that:
- sync_initial is changed
- sync_unchanged is not changed
- sync_content is changed
- sync_mode is changed
- sync_unchanged_again is not changed
- name: Cleanup
ansible.builtin.file:
state: absent
path: "{{ output_dir }}/{{ item }}"
loop:
- link_dest_src
- link_dest_dst
- link_dest_base
- name: Setup - test for source with working dir with spaces in path
ansible.builtin.file:
state: directory