Whitespace in fully path to playbook causes rsync to fail

[asnaedae]

Any whitespace in path to playbook directory causes rsync to incorrectly chdir fail to correctly run.

SUMMARY

Any whitespace in path to playbook directory causes rsync to incorrectly chdir fail to correctly run.

ISSUE TYPE

• Bugfix Pull Request

COMPONENT NAME

ansible.posix.synchronize

ADDITIONAL INFORMATION

Example :

cd "/home/a/ansible plays"

task:
  - synchronize:
      src: a
      dest: b

Results in the following error being thrown

fatal: [remote-host]: FAILED! => {"changed": false, "cmd": "/usr/bin/rsync --delay-updates -F --compress --archive --rsh='/usr/bin/ssh -S none -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null' --rsync-path='sudo -u root rsync' --out-format='<<CHANGED>>%i %n%L' /home/a/ansible plays/deployments// remote-user@remote-host:/b/", "msg": "rsync: [sender] link_stat \"/home/a/ansible\" failed: No such file or directory (2)\nrsync: [sender] change_dir \"/home/a/ansible plays/plays/a/\" failed: No such file or directory (2)\nrsync error: some files/attrs were not transferred (see previous errors) (code 23) at main.c(1330) [sender=3.2.3]\n", "rc": 23}

[saito-hideki]

@asnaedae Hi! thank you for the PR!
Looking at the output of CI tests, it has failed with the following error:

• https://dashboard.zuul.ansible.com/t/ansible/build/18679f3c89b94077962aaf12cc3a3dcf

Your pull-request is missing a changelog fragment, please add one. It should explain to end users the reason for your change.

In this case, you need to create a changelog fragments file under changelogs/fragments directory according to the following document:

• https://docs.ansible.com/ansible/latest/community/development_process.html#changelogs
• Example: https://github.com/ansible-collections/ansible.posix/blob/main/changelogs/fragments/247_firewalld.yml

Therefore, is it possible to create and add a fragments file and push those changes again?

[saito-hideki]

Hi! thanks for the PR!
I have left one change request regarding dest path handling. Also if it is possible, can you add some integration tests for source and dest handling with whitespaces in the full path?

[asnaedae]

Thanks for the feedback @saito-hideki , I should have added tests and read the background docs before hitting the code, have added a test to cover both situations, and correctly asserts. Do let me know if there's any further changes to be made

thanks!

[saito-hideki]

Looks good to me! thanks :)

[saito-hideki]

@Akasurde if it is possible, can you review this pull request? As far as I can see, this PR looks reasonable for me.

[saito-hideki]

@asnaedae @Akasurde thanks a lot. I'll move forward with this PR.

[ansible-zuul]

LGTM!

[saito-hideki]

Closing and re-opening for CI trigger

[Glandos]

I know this is old but… I only updated my playbook now (bye bye CentOS), and it breaks my synchronize usage, with multiple sources. Now, I have to loop over, but there is N output instead of one, it's much harder to aggregate.

I'll see if I have a workaround…

EDIT: I see this is addressed by #519