Skip to content

Commit

Permalink
[sftp] Check full path for existance in ._save() and ._mkdir()
Browse files Browse the repository at this point in the history
  • Loading branch information
pjpetersik authored and jschneier committed Apr 25, 2024
1 parent 969528b commit 28b122c
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 7 deletions.
18 changes: 14 additions & 4 deletions storages/backends/sftpstorage.py
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ def _mkdir(self, path):
"""Create directory, recursing up to create parent dirs if
necessary."""
parent = posixpath.dirname(path)
if not self.exists(parent):
if not self._path_exists(parent):
self._mkdir(parent)
self.sftp.mkdir(path)

Expand All @@ -134,7 +134,7 @@ def _save(self, name, content):
content.seek(0, os.SEEK_SET)
path = self._remote_path(name)
dirname = posixpath.dirname(path)
if not self.exists(dirname):
if not self._path_exists(dirname):
self._mkdir(dirname)

self.sftp.putfo(content, path)
Expand All @@ -152,13 +152,23 @@ def delete(self, name):
except OSError:
pass

def exists(self, name):
def _path_exists(self, path):
"""Determines whether a file existis in the sftp storage given its
absolute path."""
try:
self.sftp.stat(self._remote_path(name))
self.sftp.stat(path)
return True
except FileNotFoundError:
return False

def exists(self, name):
"""Determines whether a file exists within the root folder of the SFTP storage
(as set by `SFTP_STORAGE_ROOT`). This method differs from `._path_exists()`
in that the provided `name` is assumed to be the relative path of the file
within the root folder.
"""
return self._path_exists(self._remote_path(name))

def _isdir_attr(self, item):
# Return whether an item in sftp.listdir_attr results is a directory
if item.st_mode is not None:
Expand Down
18 changes: 15 additions & 3 deletions tests/test_sftp.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

class SFTPStorageTest(TestCase):
def setUp(self):
self.storage = sftpstorage.SFTPStorage(host="foo")
self.storage = sftpstorage.SFTPStorage(host="foo", root_path="root")

def test_init(self):
pass
Expand Down Expand Up @@ -95,13 +95,18 @@ def test_save_non_seekable(self, mock_sftp):
)
def test_save_in_subdir(self, mock_sftp):
self.storage._save("bar/foo", File(io.BytesIO(b"foo"), "foo"))
self.assertEqual(mock_sftp.mkdir.call_args_list[0][0], ("bar",))
self.assertEqual(mock_sftp.stat.call_args_list[0][0], ("root/bar",))
self.assertEqual(mock_sftp.mkdir.call_args_list[0][0], ("root/bar",))
self.assertTrue(mock_sftp.putfo.called)

@patch("storages.backends.sftpstorage.SFTPStorage.sftp")
def test_delete(self, mock_sftp):
self.storage.delete("foo")
self.assertEqual(mock_sftp.remove.call_args_list[0][0], ("foo",))
self.assertEqual(mock_sftp.remove.call_args_list[0][0], ("root/foo",))

@patch("storages.backends.sftpstorage.SFTPStorage.sftp")
def test_path_exists(self, mock_sftp):
self.assertTrue(self.storage._path_exists("root/foo"))

@patch("storages.backends.sftpstorage.SFTPStorage.sftp")
def test_exists(self, mock_sftp):
Expand All @@ -114,6 +119,13 @@ def test_exists(self, mock_sftp):
def test_not_exists(self, mock_sftp):
self.assertFalse(self.storage.exists("foo"))

@patch(
"storages.backends.sftpstorage.SFTPStorage.sftp",
**{"stat.side_effect": FileNotFoundError()},
)
def test_not_path_exists(self, mock_sftp):
self.assertFalse(self.storage._path_exists("root/foo"))

@patch(
"storages.backends.sftpstorage.SFTPStorage.sftp",
**{"stat.side_effect": socket.timeout()},
Expand Down

0 comments on commit 28b122c

Please sign in to comment.