Skip to content

Address bug that may generate two --rsync-path options with Rsync, #1356 #1369

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Address bug that may generate two --rsync-path options with Rsync, #1356 #1369

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 51 additions & 3 deletions lib/Rex/Commands/Rsync.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@ use Rex::Helper::IP;
use Rex::Helper::Path;
use Rex::Helper::Run;
use Rex::Interface::Shell;
use Getopt::Long
qw(GetOptionsFromString :config gnu_compat :config pass_through);

@EXPORT = qw(sync);

Expand Down Expand Up @@ -159,7 +161,7 @@ sub sync {
if ( $opt && exists $opt->{'download'} && $opt->{'download'} == 1 ) {
$dest = resolv_path($dest);
Rex::Logger::debug("Downloading $source -> $dest");
push @rsync_cmd, "rsync -rl --verbose --stats $params ";
push @rsync_cmd, "rsync -rl --verbose --stats";

$source = $auth->{user} . "\@$servername:$source";

Expand All @@ -171,7 +173,7 @@ sub sync {
$source = resolv_path($source);
Rex::Logger::debug("Uploading $source -> $dest");

push @rsync_cmd, "rsync -rl --verbose --stats $params";
push @rsync_cmd, "rsync -rl --verbose --stats";

if ( !$local_connection ) {
push @rsync_cmd, "-e '\%s'";
Expand All @@ -185,10 +187,24 @@ sub sync {
push @rsync_cmd, $source;
push @rsync_cmd, $dest;

# if running under sudo, create or modify --rsync-path as necessary
if (Rex::is_sudo) {
push @rsync_cmd, "--rsync-path='sudo rsync'";
my $has_rsync_path_param = $params =~ /--rsync-path/;

# simple case: add --rysnc-path
if ( !$has_rsync_path_param ) {
push @rsync_cmd, "--rsync-path='sudo rsync'";
}

# complex case: modify existing --rsync-path
else {
$params = _rsync_path_helper($params);
}
}

# modify command with use supplied $params
$rsync_cmd[0] =~ s/^rsync/rsync$params /i;

$cmd = join( " ", @rsync_cmd );

if ( !$local_connection ) {
Expand Down Expand Up @@ -377,4 +393,36 @@ sub sync {

}

# helper function to modify user-supplied --rsync-path parameter value when running sync as sudo
# will change rsync-path='blah rsync' to --rsync-path='sudo blah rsync'
sub _rsync_path_helper {
my $params = shift;

# determine value of --rsync-path
$params =~ s/(--rsync-path)\s*=\s*/$1=/; # remove spaces from around equal sign
my $rsync_path;
my ( $ret, $args ) =
GetOptionsFromString( $params, 'rsync-path=s' => \$rsync_path, );

# only add 'sudo' to value if it's not already there
if ( $rsync_path !~ /^sudo / ) {

# substitute old value with a new value preceded by 'sudo'

# for quoted values (e.g. --rsync-path='stuff')
if ( $params =~ /(['"])$rsync_path['"]/ ) {
my $d = $1; # delimiter
$params =~
s/--rsync-path=$d$rsync_path$d/--rsync-path=${d}sudo $rsync_path$d/i;
}

# for non-quoted values (e.g --rsync-path=/bin/rsync)
else {
$params =~ s/--rsync-path=$rsync_path/--rsync-path='sudo $rsync_path'/i;
}
}

return $params;
}

1;