1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
|
import unittest
try:
import paramiko
except ImportError:
raise unittest.SkipTest("paramiko package not installed, skipping tests")
import io
import os
import socket
import stat
from unittest.mock import MagicMock
from unittest.mock import patch
from django.core.files.base import File
from django.test import TestCase
from django.test import override_settings
from storages.backends import sftpstorage
from tests.utils import NonSeekableContentFile
class SFTPStorageTest(TestCase):
def setUp(self):
self.storage = sftpstorage.SFTPStorage(host="foo", root_path="root")
def test_init(self):
pass
@patch("paramiko.SSHClient")
def test_no_known_hosts_file(self, mock_ssh):
self.storage.known_host_file = "not_existed_file"
self.storage._connect()
self.assertEqual("foo", mock_ssh.return_value.connect.call_args[0][0])
@patch.object(os.path, "expanduser", return_value="/path/to/known_hosts")
@patch.object(os.path, "exists", return_value=True)
@patch("paramiko.SSHClient")
def test_error_when_known_hosts_file_not_defined(self, mock_ssh, *a):
self.storage._connect()
self.storage._ssh.load_host_keys.assert_called_once_with("/path/to/known_hosts")
@patch("paramiko.SSHClient")
def test_connect(self, mock_ssh):
self.storage._connect()
self.assertEqual("foo", mock_ssh.return_value.connect.call_args[0][0])
@patch("paramiko.SSHClient")
def test_close_unopened(self, mock_ssh):
with self.storage:
pass
mock_ssh.return_value.close.assert_not_called()
@patch("paramiko.SSHClient")
def test_close_opened(self, mock_ssh):
with self.storage as storage:
storage._connect()
mock_ssh.return_value.close.assert_called_once_with()
def test_open(self):
file_ = self.storage._open("foo")
self.assertIsInstance(file_, sftpstorage.SFTPStorageFile)
@patch("storages.backends.sftpstorage.SFTPStorage.sftp")
def test_read(self, mock_sftp):
self.storage._read("foo")
self.assertTrue(mock_sftp.open.called)
@patch("storages.backends.sftpstorage.SFTPStorage.sftp")
def test_chown(self, mock_sftp):
self.storage._chown("foo", 1, 1)
self.assertEqual(mock_sftp.chown.call_args[0], ("foo", 1, 1))
@patch("storages.backends.sftpstorage.SFTPStorage.sftp")
def test_mkdir(self, mock_sftp):
self.storage._mkdir("foo")
self.assertEqual(mock_sftp.mkdir.call_args[0], ("foo",))
@patch(
"storages.backends.sftpstorage.SFTPStorage.sftp",
**{"stat.side_effect": (FileNotFoundError(), True)},
)
def test_mkdir_parent(self, mock_sftp):
self.storage._mkdir("bar/foo")
self.assertEqual(mock_sftp.mkdir.call_args_list[0][0], ("bar",))
self.assertEqual(mock_sftp.mkdir.call_args_list[1][0], ("bar/foo",))
@patch("storages.backends.sftpstorage.SFTPStorage.sftp")
def test_save(self, mock_sftp):
self.storage._save("foo", File(io.BytesIO(b"foo"), "foo"))
self.assertTrue(mock_sftp.putfo.called)
@patch("storages.backends.sftpstorage.SFTPStorage.sftp")
def test_save_non_seekable(self, mock_sftp):
self.storage._save("foo", NonSeekableContentFile("foo"))
self.assertTrue(mock_sftp.putfo.called)
@patch(
"storages.backends.sftpstorage.SFTPStorage.sftp",
**{"stat.side_effect": (FileNotFoundError(), True)},
)
def test_save_in_subdir(self, mock_sftp):
self.storage._save("bar/foo", File(io.BytesIO(b"foo"), "foo"))
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], ("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):
self.assertTrue(self.storage.exists("foo"))
@patch(
"storages.backends.sftpstorage.SFTPStorage.sftp",
**{"stat.side_effect": FileNotFoundError()},
)
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()},
)
def test_not_exists_timeout(self, mock_sftp):
with self.assertRaises(socket.timeout):
self.storage.exists("foo")
@patch(
"storages.backends.sftpstorage.SFTPStorage.sftp",
**{
"listdir_attr.return_value": [
MagicMock(filename="foo", st_mode=stat.S_IFDIR),
MagicMock(filename="bar", st_mode=None),
]
},
)
def test_listdir(self, mock_sftp):
dirs, files = self.storage.listdir("/")
self.assertTrue(dirs)
self.assertTrue(files)
@patch(
"storages.backends.sftpstorage.SFTPStorage.sftp",
**{
"stat.return_value.st_size": 42,
},
)
def test_size(self, mock_sftp):
self.assertEqual(self.storage.size("foo"), 42)
def test_url(self):
self.assertEqual(self.storage.url("foo"), "/media/foo")
# Test custom
self.storage.base_url = "http://bar.pt/"
self.assertEqual(self.storage.url("foo"), "http://bar.pt/foo")
# Test error
with self.assertRaises(ValueError):
self.storage.base_url = None
self.storage.url("foo")
@patch(
"storages.backends.sftpstorage.SFTPStorage.sftp",
**{
"stat.return_value.st_mtime": 1720287559,
"stat.return_value.st_atime": 1720287559,
},
)
def test_times(self, mock_sftp):
self.storage.get_modified_time("foo")
self.storage.get_accessed_time("foo")
@patch("paramiko.transport.Transport", **{"is_active.side_effect": (True, False)})
@patch("storages.backends.sftpstorage.SFTPStorage._connect")
def test_sftp(self, connect, transport):
self.assertIsNone(self.storage.sftp)
self.assertTrue(connect.called)
connect.reset_mock()
self.storage._ssh = paramiko.SSHClient()
self.storage._ssh._transport = transport
self.storage._sftp = True
self.assertTrue(self.storage.sftp)
self.assertFalse(connect.called)
self.assertTrue(self.storage.sftp)
self.assertTrue(connect.called)
def test_override_settings(self):
with override_settings(SFTP_STORAGE_ROOT="foo1"):
storage = sftpstorage.SFTPStorage()
self.assertEqual(storage.root_path, "foo1")
with override_settings(SFTP_STORAGE_ROOT="foo2"):
storage = sftpstorage.SFTPStorage()
self.assertEqual(storage.root_path, "foo2")
def test_override_class_variable(self):
class MyStorage1(sftpstorage.SFTPStorage):
root_path = "foo1"
storage = MyStorage1()
self.assertEqual(storage.root_path, "foo1")
class MyStorage2(sftpstorage.SFTPStorage):
root_path = "foo2"
storage = MyStorage2()
self.assertEqual(storage.root_path, "foo2")
def test_override_init_argument(self):
storage = sftpstorage.SFTPStorage(root_path="foo1")
self.assertEqual(storage.root_path, "foo1")
storage = sftpstorage.SFTPStorage(root_path="foo2")
self.assertEqual(storage.root_path, "foo2")
class SFTPStorageFileTest(TestCase):
def setUp(self):
self.storage = sftpstorage.SFTPStorage(host="foo")
self.file = sftpstorage.SFTPStorageFile("bar", self.storage, "wb")
@patch(
"storages.backends.sftpstorage.SFTPStorage.sftp",
**{
"stat.return_value.st_size": 42,
},
)
def test_size(self, mock_sftp):
self.assertEqual(self.file.size, 42)
@patch(
"storages.backends.sftpstorage.SFTPStorage.sftp",
**{
"open.return_value.read.return_value": b"foo",
},
)
def test_read(self, mock_sftp):
self.assertEqual(self.file.read(), b"foo")
self.assertTrue(mock_sftp.open.called)
def test_write(self):
self.file.write(b"foo")
self.assertEqual(self.file.file.read(), b"foo")
@patch("storages.backends.sftpstorage.SFTPStorage.sftp")
def test_close(self, mock_sftp):
self.file.write(b"foo")
self.file.close()
self.assertTrue(mock_sftp.putfo.called)
|
