~sschwarzer/ftputil

ftputil/test/test_file.py -rw-r--r-- 22.4 KiB
77f2ca24Stefan Schwarzer Move item "Push to repository" 27 days ago
                                                                                
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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
# Copyright (C) 2002-2019, Stefan Schwarzer <sschwarzer@sschwarzer.net>
# and ftputil contributors (see `doc/contributors.txt`)
# See the file LICENSE for licensing terms.

import ftplib
import io
import unittest

import pytest

import ftputil.error

from test import scripted_session
from test import test_base


Call = scripted_session.Call


# Test data for use in text/binary read/write tests.
TEXT_TEST_DATA = " söme line\r\nänother line\n almost done\n"
BINARY_TEST_DATA = TEXT_TEST_DATA.encode("UTF-8")


class TestFileOperations:
    """Test operations with file-like objects."""

    def test_inaccessible_dir(self):
        """
        Test whether opening a file at an invalid location fails.
        """
        host_script = [Call("__init__"), Call("pwd", result="/"), Call("close")]
        file_script = [
            Call("__init__"),
            Call("pwd", result="/"),
            Call("cwd", args=("/",)),
            Call("voidcmd", args=("TYPE I",)),
            Call(
                "transfercmd",
                args=("STOR inaccessible", None),
                result=ftplib.error_perm,
            ),
            Call("close"),
        ]
        multisession_factory = scripted_session.factory(host_script, file_script)
        with test_base.ftp_host_factory(multisession_factory) as host:
            with pytest.raises(ftputil.error.FTPIOError):
                host.open("/inaccessible", "w")

    def test_caching_of_children(self):
        """
        Test whether `FTPFile` cache of `FTPHost` object works.
        """
        host_script = [Call("__init__"), Call("pwd", result="/"), Call("close")]
        file1_script = [
            Call("__init__"),
            Call("pwd", result="/"),
            Call("cwd", args=("/",)),
            Call("voidcmd", args=("TYPE I",)),
            Call("transfercmd", args=("STOR path1", None), result=io.StringIO("")),
            Call("voidresp"),
            # Open a file again while reusing the child object and with it its
            # `_session` attribute (the `ftplib.FTP` object).
            Call("pwd", result="/"),
            Call("cwd", args=("/",)),
            Call("voidcmd", args=("TYPE I",)),
            Call("transfercmd", args=("STOR path1", None), result=io.StringIO("")),
            Call("voidresp"),
            Call("close"),
        ]
        file2_script = [
            Call("__init__"),
            Call("pwd", result="/"),
            Call("cwd", args=("/",)),
            Call("voidcmd", args=("TYPE I",)),
            Call("transfercmd", result=io.StringIO(""), args=("STOR path2", None)),
            Call("voidresp"),
            Call("close"),
        ]
        multisession_factory = scripted_session.factory(
            host_script, file1_script, file2_script
        )
        with test_base.ftp_host_factory(multisession_factory) as host:
            assert len(host._children) == 0
            path1 = "path1"
            path2 = "path2"
            # Open one file and inspect cache of available children.
            file1 = host.open(path1, "w")
            child1 = host._children[0]
            assert len(host._children) == 1
            assert not child1._file.closed
            # Open another file.
            file2 = host.open(path2, "w")
            child2 = host._children[1]
            assert len(host._children) == 2
            assert not child2._file.closed
            # Close first file.
            file1.close()
            assert len(host._children) == 2
            assert child1._file.closed
            assert not child2._file.closed
            # Re-open first child's file.
            file1 = host.open(path1, "w")
            child1_1 = file1._host
            # Check if it's reused.
            assert child1 is child1_1
            assert not child1._file.closed
            assert not child2._file.closed
            # Close second file.
            file2.close()
            assert child2._file.closed

    def test_write_to_directory(self):
        """
        Test whether attempting to write to a directory fails.
        """
        host_script = [Call("__init__"), Call("pwd", result="/"), Call("close")]
        file_script = [
            Call("__init__"),
            Call("pwd", result="/"),
            Call("cwd", args=("/",)),
            Call("voidcmd", args=("TYPE I",)),
            Call(
                "transfercmd",
                args=("STOR some_directory", None),
                result=ftplib.error_perm,
            ),
            # Because of the exception, `voidresp` isn't called.
            Call("close"),
        ]
        multisession_factory = scripted_session.factory(host_script, file_script)
        with test_base.ftp_host_factory(multisession_factory) as host:
            with pytest.raises(ftputil.error.FTPIOError):
                host.open("/some_directory", "w")

    def test_mode_not_given(self):
        """
        If the mode isn't given, a file should be opened in text read mode.
        """
        host_script = [Call("__init__"), Call("pwd", result="/"), Call("close")]
        file_script = [
            Call("__init__"),
            Call("pwd", result="/"),
            Call("cwd", args=("/",)),
            Call("voidcmd", args=("TYPE I",)),
            Call(
                "transfercmd",
                args=("RETR some_file", None),
                result=io.StringIO(TEXT_TEST_DATA),
            ),
            Call("voidresp"),
            Call("close"),
        ]
        multisession_factory = scripted_session.factory(host_script, file_script)
        with test_base.ftp_host_factory(multisession_factory) as host:
            with host.open("some_file") as fobj:
                data = fobj.read()
            assert data == TEXT_TEST_DATA

    def test_mode_is_none(self):
        """
        If the mode is passed as `None`, a `TypeError` should be raised.

        (This is Python's behavior for local files.)
        """
        host_script = [Call("__init__"), Call("pwd", result="/"), Call("close")]
        file_script = [
            Call("__init__"),
            Call("pwd", result="/"),
            Call("cwd", args=("/",)),
            Call("close"),
        ]
        multisession_factory = scripted_session.factory(host_script, file_script)
        with test_base.ftp_host_factory(multisession_factory) as host:
            with pytest.raises(TypeError):
                with host.open("some_file", None) as fobj:
                    pass

    def test_binary_read(self):
        """
        Read data from a binary file.
        """
        host_script = [Call("__init__"), Call("pwd", result="/"), Call("close")]
        file_script = [
            Call("__init__"),
            Call("pwd", result="/"),
            Call("cwd", args=("/",)),
            Call("voidcmd", args=("TYPE I",)),
            Call(
                "transfercmd",
                args=("RETR some_file", None),
                result=io.BytesIO(BINARY_TEST_DATA),
            ),
            Call("voidresp"),
            Call("close"),
        ]
        multisession_factory = scripted_session.factory(host_script, file_script)
        with test_base.ftp_host_factory(multisession_factory) as host:
            with host.open("some_file", "rb") as fobj:
                data = fobj.read()
            assert data == BINARY_TEST_DATA

    def test_binary_write(self):
        """
        Write binary data with `write`.
        """
        host_script = [Call("__init__"), Call("pwd", result="/"), Call("close")]
        file_script = [
            Call("__init__"),
            Call("pwd", result="/"),
            Call("cwd", args=("/",)),
            Call("voidcmd", args=("TYPE I",)),
            Call(
                "transfercmd",
                args=("STOR some_file", None),
                result=test_base.MockableBytesIO(b""),
            ),
            Call("voidresp"),
            Call("close"),
        ]
        multisession_factory = scripted_session.factory(host_script, file_script)
        with unittest.mock.patch("test.test_base.MockableBytesIO.write") as write_mock:
            with test_base.ftp_host_factory(multisession_factory) as host:
                with host.open("some_file", "wb") as output:
                    output.write(BINARY_TEST_DATA)
            write_mock.assert_called_with(BINARY_TEST_DATA)

    def test_text_read(self):
        """
        Read text with plain `read`.
        """
        host_script = [Call("__init__"), Call("pwd", result="/"), Call("close")]
        file_script = [
            Call("__init__"),
            Call("pwd", result="/"),
            Call("cwd", args=("/",)),
            Call("voidcmd", args=("TYPE I",)),
            Call(
                "transfercmd",
                args=("RETR dummy", None),
                # Use the same `newline` as `host.open` call. The default for
                # `StringIO`'s `newline` differs from the default for `open`
                # and `socket.makefile`.
                result=io.StringIO(TEXT_TEST_DATA, newline=None),
            ),
            Call("voidresp"),
            Call("close"),
        ]
        multisession_factory = scripted_session.factory(host_script, file_script)
        with test_base.ftp_host_factory(multisession_factory) as host:
            with host.open("dummy", "r") as input_:
                data = input_.read(0)
                assert data == ""
                data = input_.read(3)
                assert data == " sö"
                # Specifically check the behavior around the line ending
                # character.
                data = input_.read(7)
                assert data == "me line"
                data = input_.read(1)
                assert data == "\n"
                data = input_.read()
                assert data == "änother line\n almost done\n"
                data = input_.read()
                assert data == ""

    def test_text_write(self):
        """
        Write text with `write`.
        """
        host_script = [Call("__init__"), Call("pwd", result="/"), Call("close")]
        file_script = [
            Call("__init__"),
            Call("pwd", result="/"),
            Call("cwd", args=("/",)),
            Call("voidcmd", args=("TYPE I",)),
            Call(
                "transfercmd",
                args=("STOR dummy", None),
                # Use the same `newline` as `host.open` call. The default for
                # `StringIO`'s `newline` differs from the default for `open`
                # and `socket.makefile`.
                result=test_base.MockableStringIO(newline="\r\n"),
            ),
            Call("voidresp"),
            Call("close"),
        ]
        multisession_factory = scripted_session.factory(host_script, file_script)
        with unittest.mock.patch("test.test_base.MockableStringIO.write") as write_mock:
            with test_base.ftp_host_factory(multisession_factory) as host:
                with host.open("dummy", "w", newline="\r\n") as output:
                    output.write(TEXT_TEST_DATA)
        write_mock.assert_called_with(TEXT_TEST_DATA)

    def test_text_writelines(self):
        """
        Write text with `writelines`.
        """
        host_script = [Call("__init__"), Call("pwd", result="/"), Call("close")]
        file_script = [
            Call("__init__"),
            Call("pwd", result="/"),
            Call("cwd", args=("/",)),
            Call("voidcmd", args=("TYPE I",)),
            Call(
                "transfercmd",
                args=("STOR dummy", None),
                # Use the same `newline` as `host.open` call. The default for
                # `StringIO`'s `newline` differs from the default for `open`
                # and `socket.makefile`.
                result=test_base.MockableStringIO(newline="\r\n"),
            ),
            Call("voidresp"),
            Call("close"),
        ]
        data = [" söme line\r\n", "änother line\n", " almost done\n"]
        print("=== data:", data)
        backup_data = data[:]
        multisession_factory = scripted_session.factory(host_script, file_script)
        with unittest.mock.patch(
            "test.test_base.MockableStringIO.writelines"
        ) as write_mock:
            with test_base.ftp_host_factory(multisession_factory) as host:
                with host.open("dummy", "w", newline="\r\n") as output:
                    output.writelines(data)
        write_mock.assert_called_with(data)
        # Ensure that the original data was not modified.
        assert data == backup_data

    def test_binary_readline(self):
        """
        Read binary data with `readline`.
        """
        host_script = [Call("__init__"), Call("pwd", result="/"), Call("close")]
        file_script = [
            Call("__init__"),
            Call("pwd", result="/"),
            Call("cwd", args=("/",)),
            Call("voidcmd", args=("TYPE I",)),
            Call(
                "transfercmd",
                args=("RETR dummy", None),
                result=io.BytesIO(BINARY_TEST_DATA),
            ),
            Call("voidresp"),
            Call("close"),
        ]
        multisession_factory = scripted_session.factory(host_script, file_script)
        with test_base.ftp_host_factory(multisession_factory) as host:
            with host.open("dummy", "rb") as input_:
                data = input_.readline(3)
                assert data == b" s\xc3"
                data = input_.readline(9)
                assert data == b"\xb6me line\r"
                # 30 = at most 30 bytes
                data = input_.readline(30)
                assert data == b"\n"
                data = input_.readline()
                assert data == b"\xc3\xa4nother line\n"
                data = input_.readline()
                assert data == b" almost done\n"
                data = input_.readline()
                assert data == b""

    def test_text_readline(self):
        """
        Read text with `readline`.
        """
        host_script = [Call("__init__"), Call("pwd", result="/"), Call("close")]
        file_script = [
            Call("__init__"),
            Call("pwd", result="/"),
            Call("cwd", args=("/",)),
            Call("voidcmd", args=("TYPE I",)),
            Call(
                "transfercmd",
                args=("RETR dummy", None),
                # Use the same `newline` as `host.open` call. The default for
                # `StringIO`'s `newline` differs from the default for `open`
                # and `socket.makefile`.
                result=io.StringIO(TEXT_TEST_DATA, newline=None),
            ),
            Call("voidresp"),
            Call("close"),
        ]
        multisession_factory = scripted_session.factory(host_script, file_script)
        with test_base.ftp_host_factory(multisession_factory) as host:
            with host.open("dummy", "r") as input_:
                data = input_.readline(3)
                assert data == " sö"
                data = input_.readline(7)
                assert data == "me line"
                data = input_.readline(10)
                # Does implicit newline conversion.
                assert data == "\n"
                # 30 = at most 30 bytes
                data = input_.readline(30)
                assert data == "änother line\n"
                data = input_.readline()
                assert data == " almost done\n"
                data = input_.readline()
                assert data == ""

    def test_text_readlines(self):
        """
        Read text with `readlines`.
        """
        host_script = [Call("__init__"), Call("pwd", result="/"), Call("close")]
        file_script = [
            Call("__init__"),
            Call("pwd", result="/"),
            Call("cwd", args=("/",)),
            Call("voidcmd", args=("TYPE I",)),
            Call(
                "transfercmd",
                args=("RETR dummy", None),
                # Use the same `newline` as `host.open` call. The default for
                # `StringIO`'s `newline` differs from the default for `open`
                # and `socket.makefile`.
                result=io.StringIO(TEXT_TEST_DATA, newline=None),
            ),
            Call("voidresp"),
            Call("close"),
        ]
        multisession_factory = scripted_session.factory(host_script, file_script)
        with test_base.ftp_host_factory(multisession_factory) as host:
            with host.open("dummy", "r") as input_:
                data = input_.read(3)
                assert data == " sö"
                data = input_.readlines()
                assert data == ["me line\n", "änother line\n", " almost done\n"]
                input_.close()

    def test_binary_iterator(self):
        """
        Test iterator interface of `FTPFile` objects for binary files.
        """
        host_script = [Call("__init__"), Call("pwd", result="/"), Call("close")]
        file_script = [
            Call("__init__"),
            Call("pwd", result="/"),
            Call("cwd", args=("/",)),
            Call("voidcmd", args=("TYPE I",)),
            Call(
                "transfercmd",
                args=("RETR dummy", None),
                result=io.BytesIO(BINARY_TEST_DATA),
            ),
            Call("voidresp"),
            Call("close"),
        ]
        multisession_factory = scripted_session.factory(host_script, file_script)
        with test_base.ftp_host_factory(multisession_factory) as host:
            with host.open("dummy", "rb") as input_:
                input_iterator = iter(input_)
                assert next(input_iterator) == b" s\xc3\xb6me line\r\n"
                # The last two lines don't have a `\r`.
                assert next(input_iterator) == b"\xc3\xa4nother line\n"
                assert next(input_iterator) == b" almost done\n"
                with pytest.raises(StopIteration):
                    input_iterator.__next__()

    def test_text_iterator(self):
        """
        Test iterator interface of `FTPFile` objects for text files.
        """
        host_script = [Call("__init__"), Call("pwd", result="/"), Call("close")]
        file_script = [
            Call("__init__"),
            Call("pwd", result="/"),
            Call("cwd", args=("/",)),
            Call("voidcmd", args=("TYPE I",)),
            Call(
                "transfercmd",
                args=("RETR dummy", None),
                # Use the same `newline` as `host.open` call. The default for
                # `StringIO`'s `newline` differs from the default for `open`
                # and `socket.makefile`.
                result=io.StringIO(TEXT_TEST_DATA, newline=None),
            ),
            Call("voidresp"),
            Call("close"),
        ]
        multisession_factory = scripted_session.factory(host_script, file_script)
        with test_base.ftp_host_factory(multisession_factory) as host:
            with host.open("dummy", "r") as input_:
                input_iterator = iter(input_)
                assert next(input_iterator) == " söme line\n"
                assert next(input_iterator) == "änother line\n"
                assert next(input_iterator) == " almost done\n"
                with pytest.raises(StopIteration):
                    input_iterator.__next__()

    def test_read_unknown_file(self):
        """
        Test whether reading a file which isn't there fails.
        """
        host_script = [Call("__init__"), Call("pwd", result="/"), Call("close")]
        file_script = [
            Call("__init__"),
            Call("pwd", result="/"),
            Call("cwd", args=("/",)),
            Call("voidcmd", args=("TYPE I",)),
            Call("transfercmd", args=("RETR notthere", None), result=ftplib.error_perm),
            Call("close"),
        ]
        multisession_factory = scripted_session.factory(host_script, file_script)
        with test_base.ftp_host_factory(multisession_factory) as host:
            with pytest.raises(ftputil.error.FTPIOError):
                with host.open("notthere", "r") as input_:
                    pass


class TestAvailableChild:
    def _failing_pwd(self, exception_class):
        """
        Return a function that will be used instead of the `session.pwd` and
        will raise the exception `exception_to_raise`.
        """

        def new_pwd():
            raise exception_class("")

        return new_pwd

    def _test_with_pwd_error(self, exception_class):
        """
        Test if reusing a child session fails because of
        `child_host._session.pwd` raising an exception of type
        `exception_class`.
        """
        host_script = [Call("__init__"), Call("pwd", result="/"), Call("close")]
        first_file_script = [
            Call("__init__"),
            Call("pwd", result="/"),
            Call("cwd", args=("/",)),
            Call("voidcmd", args=("TYPE I",)),
            Call("transfercmd", args=("RETR dummy1", None), result=io.StringIO("")),
            Call("voidresp"),
            # This `pwd` is executed from `FTPHost._available_child`.
            Call("pwd", result=exception_class),
            Call("close"),
        ]
        second_file_script = [
            Call("__init__"),
            Call("pwd", result="/"),
            Call("cwd", args=("/",)),
            Call("voidcmd", args=("TYPE I",)),
            Call("transfercmd", args=("RETR dummy2", None), result=io.StringIO("")),
            Call("voidresp"),
            Call("close"),
        ]
        multisession_factory = scripted_session.factory(
            host_script, first_file_script, second_file_script
        )
        with test_base.ftp_host_factory(multisession_factory) as host:
            # Implicitly create a child session.
            with host.open("/dummy1") as _:
                pass
            assert len(host._children) == 1
            # Try to create a new file. Since `pwd` in
            # `FTPHost._available_child` raises an exception, a new child
            # session should be created.
            with host.open("/dummy2") as _:
                pass
            assert len(host._children) == 2

    def test_pwd_with_error_temp(self):
        """
        Test if an `error_temp` in `_session.pwd` skips the child session.
        """
        self._test_with_pwd_error(ftplib.error_temp)

    def test_pwd_with_error_reply(self):
        """
        Test if an `error_reply` in `_session.pwd` skips the child session.
        """
        self._test_with_pwd_error(ftplib.error_reply)

    def test_pwd_with_OSError(self):
        """
        Test if an `OSError` in `_session.pwd` skips the child session.
        """
        self._test_with_pwd_error(OSError)

    def test_pwd_with_EOFError(self):
        """
        Test if an `EOFError` in `_session.pwd` skips the child session.
        """
        self._test_with_pwd_error(EOFError)