put() empty remote_path arg ignores use of with cd():

[GaretJax]

Description

When using put() in this way:

with cd("/etc/apache2"):
    put('%s/httpd-vhosts.conf' % confs_dir, '', use_sudo=True)
    put('%s/apache2.conf' % confs_dir, '', use_sudo=True)
    sudo('mkdir logs')`

the empty string in put's second arg is supposed to resolve to the current working directory on the remote end. However, in this case it resolves to the user's home directory.

I believe the lines where this is determined are 397-400 in operations.py:

# Expand tildes (assumption: default remote cwd is user $HOME)
home = ftp.normalize('.')

# Empty remote path implies cwd
remote_path = remote_path or home

---

Originally submitted by Matt DeBoard (mdeboard) on 2011-06-29 at 03:32pm EDT

[bitprophet]

Jeff Forcier (bitprophet) posted:

---

Specifically, what needs to happen is the application of cd (in put) and lcd (in get, assuming it has the same problem) must occur before the substitution of $HOME for empty arguments. Hopefully doing this swap will not cause other problems; double check.

(also: updated the ticket subject to be more accurate.)

---

on 2011-06-29 at 03:53pm EDT

[kbd]

Btw, pretty sure lcd does have the same issue, last time I checked.

[GaretJax]

I just merged the upstream master into this branch, it should be ready to be merged into master. Is there a showstopper? If so, please report, I'm willing to correct any flaws!

[bitprophet]

I think this does need a bit more tweaking, e.g. I started writing a test for this, and noticed that a call of with settings(cwd='subdirectory'): put('whatever.txt') was trying to upload to subdirectory/subdirectory instead of subdirectory/whatever.txt -- this is due to the existing way we deal with cwd (the abspath check shortly after the line you modified.)

In other words, my fears were right, it's not as simple as just adding the extra checks to cwd.

So there definitely need to be some tweaks somewhere, and we should be careful to check a lot of possible combinations:

• env.cwd (which is what's set by with cd()): empty string, relative path, absolute path
• env.lcwd: ditto
• remote_path kwarg: empty, relative path, absolute path, contains ~, doesn't contain ~
• local_path kwarg: ditto

Ideally we want to test all potential combos there, but for now I think we can get away with just adding a handful of the more common ones.

It should be possible to expand the test suite (tests/test_operations.py, section about put), though re: the remote cwd stuff, we'd need to make sure that the test server's mkdir functionality works, and figure out how best to call it from within the tests. Forget if existing tests use it at this point.

If you think tackling all this is feasible, by all means give it a shot, otherwise I'll try sometime.

[kuba]

It seems like put+cd+~ combo doesn't work as well:

$ fab --version
Fabric 1.4.0
ssh (library) 1.7.13
$ cat fabfile.py
from fabric.api import *

def buggy_put():
    with cd("~"):
        put('foo-file', 'bar-dir')
$ ls -l foo-file
-rw-rw-r-- 1 jakub jakub 0 2012-03-27 23:11 foo-file
$ ssh host ls -ld bar-dir
drwx------ 2 jakub jakub 4096 2012-03-27 23:17 bar-dir
$ fab buggy_put         
No hosts found. Please specify (single) host string for connection: host
[host] put: foo-file -> ~/bar-dir

Fatal error: put() encountered an exception while uploading 'foo-file'

Underlying exception:
    No such file

Aborting.
Disconnecting from host... done.