synchronize: Allow user-defined --out-format #428
Conversation
If the user specifes --out-format in rsync_opts return msg and stdout_lines in that format otherwise use the default for --itemize-changes, '%i %n%L'; the output for diff will always be in the default --itemize-changes format. The use of '//' as a delimiter to split the format fields isn't perfect but it's the least-likely to clash with an actual filepath that I could think of.
growf
changed the title
|
Build succeeded. ✔️ ansible-changelog-fragment SUCCESS in 12s |
|
@growf this looks great, thank you for the contribution! Can you please add some test cases to validate this new functionality? Thank you! |
SUMMARY
If the user specifes
--out-formatin the synchronize module'srsync_optsreturn themsgandstdout_linesfields in the requested format. When no--out-formatis specified the default format for--itemize-changes(%i %n%L) is used.When the module is called with
diff: truethe returned diff will remain in the default format for--itemize-changes.This is a change from the current behaviour that always forces an output format of
%i %n%Lregardless of user-specified values for--out-format. This current behaviour was hard-coded in order to facilitate correctly setting thechangesreturn value and having a fixed format fordiff: true. I've endeavored to maintain the current behaviour for those purposes whilst additionally allowing user-defined formats.ISSUE TYPE
COMPONENT NAME
synchronize
ADDITIONAL INFORMATION
The generated
--out-formatattempts to combine:--out-formatDIFF%iitemize-changes field%n%Lfilename and link information fields (if we are returning a diff or if no format was specified)seperated by a delimiter of
//. No delimiter is completely safe for this purpose but I felt this one was sufficiently unlikely to appear the final three fields.I didn't attempt to use field widths for parsing given I've seen
rsyncversions with different widths for the%ifield. In fact this unreliability of the%ifield (added to the fact that it can contain internal spaces making the default pattern,%i %n%L, also tricky to split on a delimiter) is the motivation for this change. I wanted to pass an--out-formatof{%-16i} %nto synchronize to make programmatic parsing of the returned output easier but discovered that the module couldn't support it.I've avoided the use of some more modern Python syntax (
str.removeprefix(),Match.__getitem__()) because I'm developing against Python 2.7.18 and I imagine that I'm not alone in having to support old versions.