File: test_verify_filesize.py

package info (click to toggle)
torf 4.3.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 988 kB
  • sloc: python: 10,054; makefile: 15; sh: 8
file content (499 lines) | stat: -rw-r--r-- 20,528 bytes parent folder | download
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
import os
import shutil
from pathlib import Path
from unittest import mock

import pytest

import torf


def test_validate_is_called_first(monkeypatch):
    torrent = torf.Torrent()
    mock_validate = mock.MagicMock(side_effect=torf.MetainfoError('Mock error'))
    monkeypatch.setattr(torrent, 'validate', mock_validate)
    with pytest.raises(torf.MetainfoError) as excinfo:
        torrent.verify_filesize('some/path')
    assert excinfo.match('^Invalid metainfo: Mock error$')
    mock_validate.assert_called_once_with()


@pytest.mark.parametrize(
    argnames='callback_return_values, exp_calls, exp_success',
    argvalues=(
        ([None], 1, True),
        ([True], 1, False),
        ([False], 1, False),
        ([''], 1, False),
    ),
)
def test_success_with_singlefile_torrent(callback_return_values, exp_calls, exp_success, create_file, create_torrent_file):
    content_path = create_file('file.jpg', '<image data>')
    with create_torrent_file(path=content_path) as torrent_file:
        torrent = torf.Torrent.read(torrent_file)

        # Without callback
        return_value = torrent.verify_filesize(content_path)
        assert return_value is True

        # With callback
        def assert_call(t, fs_path, t_path, files_done, files_total, exc):
            assert t == torrent
            assert fs_path == content_path
            assert files_done == 1
            assert files_total == 1
            assert exc is None
            return callback_return_values.pop(0)

        cb = mock.MagicMock()
        cb.side_effect = assert_call
        assert torrent.verify_filesize(content_path, callback=cb) is exp_success
        assert cb.call_count == exp_calls



@pytest.mark.parametrize(
    argnames='callback_return_values, exp_calls, exp_success',
    argvalues=(
        ([None, None, None], 3, True),
        ([None, None, True], 3, False),
        ([None, True], 2, False),
        ([True], 1, False),
    ),
)
def test_success_with_multifile_torrent(callback_return_values, exp_calls, exp_success, create_dir, create_torrent_file):
    content_path = create_dir('content',
                              ('a.jpg', 'some data'),
                              ('b.jpg', 'some other data'),
                              ('c.jpg', 'some more data'))
    with create_torrent_file(path=content_path) as torrent_file:
        torrent = torf.Torrent.read(torrent_file)

        assert os.path.exists(content_path / 'a.jpg')
        assert os.path.exists(content_path / 'b.jpg')
        assert os.path.exists(content_path / 'c.jpg')

        # Without callback
        assert torrent.verify_filesize(content_path) is True

        # With callback
        def assert_call(t, fs_path, t_path, files_done, files_total, exc):
            assert t == torrent
            assert files_done == cb.call_count
            assert files_total == 3
            if cb.call_count == 1:
                assert fs_path == content_path / 'a.jpg'
                assert t_path == Path(*(content_path / 'a.jpg').parts[-2:])
                assert exc is None
            elif cb.call_count == 2:
                assert fs_path == content_path / 'b.jpg'
                assert t_path == Path(*(content_path / 'b.jpg').parts[-2:])
                assert exc is None
            elif cb.call_count == 3:
                assert fs_path == content_path / 'c.jpg'
                assert t_path == Path(*(content_path / 'c.jpg').parts[-2:])
                assert exc is None
            return callback_return_values.pop(0)

        cb = mock.MagicMock()
        cb.side_effect = assert_call
        assert torrent.verify_filesize(content_path, callback=cb) is exp_success
        assert cb.call_count == exp_calls


@pytest.mark.parametrize(
    argnames='callback_return_values, exp_calls',
    argvalues=(
        ([None], 1),
        ([True], 1),
        ([False], 1),
        ([''], 1),
    ),
)
def test_file_in_singlefile_torrent_doesnt_exist(callback_return_values, exp_calls, create_file, create_torrent_file):
    content_path = create_file('file.jpg', '<image data>')
    with create_torrent_file(path=content_path) as torrent_file:
        torrent = torf.Torrent.read(torrent_file)

        # Without callback
        with pytest.raises(torf.ReadError) as excinfo:
            torrent.verify_filesize('/some/nonexisting/path')
        assert excinfo.match('^/some/nonexisting/path: No such file or directory$')

        # With callback
        def assert_call(t, fs_path, t_path, files_done, files_total, exc):
            assert t == torrent
            assert fs_path == Path('/some/nonexisting/path')
            assert files_done == 1
            assert files_total == 1
            assert str(exc) == '/some/nonexisting/path: No such file or directory'
            return callback_return_values.pop(0)

        cb = mock.MagicMock()
        cb.side_effect = assert_call
        assert torrent.verify_filesize('/some/nonexisting/path', callback=cb) is False
        assert cb.call_count == exp_calls


@pytest.mark.parametrize(
    argnames='callback_return_values, exp_calls',
    argvalues=(
        ([None, None, None], 3),
        ([None, True], 2),
        ([True], 1),
    ),
)
def test_file_in_multifile_torrent_doesnt_exist(callback_return_values, exp_calls, create_dir, create_torrent_file):
    content_path = create_dir('content',
                              ('a.jpg', 'some data'),
                              ('b.jpg', 'some other data'),
                              ('c.jpg', 'some more data'))
    with create_torrent_file(path=content_path) as torrent_file:
        torrent = torf.Torrent.read(torrent_file)

        os.remove(content_path / 'a.jpg')
        os.remove(content_path / 'c.jpg')
        assert not os.path.exists(content_path / 'a.jpg')
        assert os.path.exists(content_path / 'b.jpg')
        assert not os.path.exists(content_path / 'c.jpg')

        # Without callback
        with pytest.raises(torf.ReadError) as excinfo:
            torrent.verify_filesize(content_path)
        assert excinfo.match(f'^{content_path / "a.jpg"}: No such file or directory$')

        # With callback
        def assert_call(t, fs_path, t_path, files_done, files_total, exc):
            assert t == torrent
            assert files_done == cb.call_count
            assert files_total == 3
            if cb.call_count == 1:
                assert fs_path == content_path / 'a.jpg'
                assert t_path == Path(*(content_path / 'a.jpg').parts[-2:])
                assert str(exc) == f'{fs_path}: No such file or directory'
            elif cb.call_count == 2:
                assert fs_path == content_path / 'b.jpg'
                assert t_path == Path(*(content_path / 'b.jpg').parts[-2:])
                assert exc is None
            elif cb.call_count == 3:
                assert fs_path == content_path / 'c.jpg'
                assert t_path == Path(*(content_path / 'c.jpg').parts[-2:])
                assert str(exc) == f'{fs_path}: No such file or directory'
            return callback_return_values.pop(0)

        cb = mock.MagicMock()
        cb.side_effect = assert_call
        assert torrent.verify_filesize(content_path, callback=cb) is False
        assert cb.call_count == exp_calls


@pytest.mark.parametrize(
    argnames='callback_return_values, exp_calls',
    argvalues=(
        ([None], 1),
        ([True], 1),
        (['yes'], 1),
    ),
)
def test_file_in_singlefile_torrent_has_wrong_size(callback_return_values, exp_calls, create_file, create_torrent_file):
    content_path = create_file('file.jpg', '<image data>')
    with create_torrent_file(path=content_path) as torrent_file:
        torrent = torf.Torrent.read(torrent_file)

        content_path.write_text('<different image data>')
        assert os.path.getsize(content_path) != torrent.size

        # Without callback
        with pytest.raises(torf.VerifyFileSizeError) as excinfo:
            torrent.verify_filesize(content_path)
        assert excinfo.match(f'^{content_path}: Too big: 22 instead of 12 bytes$')

        # With callback
        def assert_call(t, fs_path, t_path, files_done, files_total, exc):
            assert t == torrent
            assert fs_path == content_path
            assert t_path == Path(Path(content_path).name)
            assert files_done == cb.call_count
            assert files_total == 1
            assert str(exc) == f'{content_path}: Too big: 22 instead of 12 bytes'
            return callback_return_values.pop(0)

        cb = mock.MagicMock()
        cb.side_effect = assert_call
        assert torrent.verify_filesize(content_path, callback=cb) is False
        assert cb.call_count == exp_calls


@pytest.mark.parametrize(
    argnames='callback_return_values, exp_calls',
    argvalues=(
        ([None, None, True], 3),
        ([None, True, None], 2),
        (['yes', None, None], 1),
    ),
)
def test_file_in_multifile_torrent_has_wrong_size(callback_return_values, exp_calls, create_dir, create_torrent_file):
    content_path = create_dir('content',
                              ('a.jpg', 100),
                              ('b.jpg', 200),
                              ('c.jpg', 300))
    with create_torrent_file(path=content_path) as torrent_file:
        torrent = torf.Torrent.read(torrent_file)

        (content_path / 'b.jpg').write_bytes(b'\x00' * 201)
        (content_path / 'c.jpg').write_bytes(b'\x00' * 299)
        assert len((content_path / 'b.jpg').read_bytes()) == 201
        assert len((content_path / 'c.jpg').read_bytes()) == 299

        # Without callback
        with pytest.raises(torf.VerifyFileSizeError) as excinfo:
            torrent.verify_filesize(content_path)
        assert excinfo.match(f'^{content_path / "b.jpg"}: Too big: 201 instead of 200 bytes$')

        # With callback
        def assert_call(t, fs_path, t_path, files_done, files_total, exc):
            assert t == torrent
            assert files_done == cb.call_count
            assert files_total == 3
            if cb.call_count == 1:
                assert fs_path == content_path / 'a.jpg'
                assert t_path == Path(content_path.name, 'a.jpg')
                assert exc is None
            elif cb.call_count == 2:
                assert fs_path == content_path / 'b.jpg'
                assert t_path == Path(content_path.name, 'b.jpg')
                assert str(exc)  == f'{fs_path}: Too big: 201 instead of 200 bytes'
            elif cb.call_count == 3:
                assert fs_path == content_path / 'c.jpg'
                assert t_path == Path(content_path.name, 'c.jpg')
                assert str(exc) == f'{fs_path}: Too small: 299 instead of 300 bytes'
            return callback_return_values.pop(0)

        cb = mock.MagicMock()
        cb.side_effect = assert_call
        assert torrent.verify_filesize(content_path, callback=cb) is False
        assert cb.call_count == exp_calls


@pytest.mark.parametrize(
    argnames='callback_return_values, exp_calls',
    argvalues=(
        ([None, None, True], 1),
        ([True, None, None], 1),
        ([None], 1),
    ),
)
def test_path_is_directory_and_torrent_contains_single_file(callback_return_values, exp_calls, create_file, create_dir, create_torrent_file):
    content_data = b'\x00' * 1001
    content_path = create_file('content', content_data)
    with create_torrent_file(path=content_path) as torrent_file:
        torrent = torf.Torrent.read(torrent_file)

        os.remove(content_path)
        content_path = create_dir('content', ('content', content_data))
        assert os.path.isdir(content_path)

        # Without callback
        with pytest.raises(torf.VerifyIsDirectoryError) as excinfo:
            torrent.verify_filesize(content_path)
        assert excinfo.match(f'^{content_path}: Is a directory$')

        # With callback
        def assert_call(t, fs_path, t_path, files_done, files_total, exc):
            assert t == torrent
            assert files_done == 1
            assert files_total == 1
            assert fs_path == Path(content_path)
            assert t_path == Path(Path(content_path).name)
            assert str(exc) == f'{content_path}: Is a directory'
            return callback_return_values.pop(0)

        cb = mock.MagicMock()
        cb.side_effect = assert_call
        assert torrent.verify_filesize(content_path, callback=cb) is False
        assert cb.call_count == exp_calls


@pytest.mark.parametrize(
    argnames='callback_return_values, exp_calls',
    argvalues=(
        ([None, None, None], 2),
        ([None, True], 2),
        ([False], 1),
    ),
)
def test_path_is_file_and_torrent_contains_directory(callback_return_values, exp_calls, create_file, create_dir, create_torrent_file):
    content_path = create_dir('content',
                              ('a.jpg', b'\x00' * 1234),
                              ('b.jpg', b'\x00' * 234))
    with create_torrent_file(path=content_path) as torrent_file:
        torrent = torf.Torrent.read(torrent_file)

        shutil.rmtree(content_path)
        assert not os.path.exists(content_path)

        create_file('content', 'some data')
        assert os.path.isfile(content_path)

        # Without callback
        with pytest.raises(torf.ReadError) as excinfo:
            torrent.verify_filesize(content_path)
        assert excinfo.match(f'^{content_path / "a.jpg"}: No such file or directory$')

        # With callback
        def assert_call(t, fs_path, t_path, files_done, files_total, exc):
            assert t == torrent
            assert files_done == cb.call_count
            assert files_total == 2
            if cb.call_count == 1:
                assert fs_path == content_path / 'a.jpg'
                assert t_path == Path(content_path.name, 'a.jpg')
                assert str(exc) == f'{fs_path}: No such file or directory'
            elif cb.call_count == 2:
                assert fs_path == content_path / 'b.jpg'
                assert t_path == Path(content_path.name, 'b.jpg')
                assert str(exc) == f'{fs_path}: No such file or directory'
            return callback_return_values.pop(0)

        cb = mock.MagicMock()
        cb.side_effect = assert_call
        assert torrent.verify_filesize(content_path, callback=cb) is False
        assert cb.call_count == exp_calls


@pytest.mark.parametrize(
    argnames='callback_return_values, exp_calls',
    argvalues=(
        ([None, None, None], 3),
        ([None, None, 'cancel'], 3),
        ([None, ()], 2),
        ([0], 1),
    ),
)
def test_parent_path_of_multifile_torrent_is_unreadable(callback_return_values, exp_calls, create_dir, create_torrent_file):
    content_path = create_dir('content',
                              ('unreadable1/b/c/a.jpg', 'a data'),
                              ('unreadable2/b/c/b.jpg', 'b data'),
                              ('readable/b/c/c.jpg', 'c data'))
    with create_torrent_file(path=content_path) as torrent_file:
        torrent = torf.Torrent.read(torrent_file)
        unreadable_path1_mode = os.stat(content_path / 'unreadable1').st_mode
        unreadable_path2_mode = os.stat(content_path / 'unreadable2').st_mode
        try:
            os.chmod((content_path / 'unreadable1'), mode=0o222)
            os.chmod((content_path / 'unreadable2'), mode=0o222)

            # NOTE: We would expect "Permission denied" here, but
            # os.path.exists() can't look inside .../content/unreadable1/ and
            # thus raises "No such file or directory".

            # Without callback
            with pytest.raises(torf.ReadError) as excinfo:
                torrent.verify_filesize(content_path)
            assert excinfo.match(f'^{content_path / "unreadable1/b/c/a.jpg"}: No such file or directory$')

            # With callback
            def assert_call(t, fs_path, t_path, files_done, files_total, exc):
                assert t == torrent
                assert files_done == cb.call_count
                assert files_total == 3
                if cb.call_count == 1:
                    assert fs_path == content_path / 'readable/b/c/c.jpg'
                    assert t_path == Path(content_path.name, 'readable/b/c/c.jpg')
                    assert exc is None
                elif cb.call_count == 2:
                    assert fs_path == content_path / 'unreadable1/b/c/a.jpg'
                    assert t_path == Path(content_path.name, 'unreadable1/b/c/a.jpg')
                    assert str(exc) == f'{fs_path}: No such file or directory'
                elif cb.call_count == 3:
                    assert fs_path == Path(content_path / 'unreadable2/b/c/b.jpg')
                    assert t_path == Path(content_path.name, 'unreadable2/b/c/b.jpg')
                    assert str(exc) == f'{fs_path}: No such file or directory'
                return callback_return_values.pop(0)

            cb = mock.MagicMock()
            cb.side_effect = assert_call
            assert torrent.verify_filesize(content_path, callback=cb) is False
            assert cb.call_count == exp_calls
        finally:
            os.chmod((content_path / 'unreadable1'), mode=unreadable_path1_mode)
            os.chmod((content_path / 'unreadable2'), mode=unreadable_path2_mode)


@pytest.mark.parametrize(
    argnames='callback_return_values, exp_calls',
    argvalues=(
        ([None, None, None], 1),
        (['abort', None, None], 1),
        ([range(123), None, None], 1),
        ([123, None, None], 1),
    ),
)
def test_parent_path_of_singlefile_torrent_is_unreadable(callback_return_values, exp_calls, create_dir, create_torrent_file):
    parent_path = create_dir('parent',
                             ('file.jpg', b'\x00' * 123))
    content_file = str(parent_path / 'file.jpg')
    with create_torrent_file(path=content_file) as torrent_file:
        torrent = torf.Torrent.read(torrent_file)

        parent_path_mode = os.stat(parent_path).st_mode
        try:
            os.chmod(parent_path, mode=0o222)

            # NOTE: We would expect "Permission denied" here, but
            # os.path.exists() can't look inside "parent" directory and thus
            # raises "No such file or directory".

            # Without callback
            with pytest.raises(torf.ReadError) as excinfo:
                torrent.verify_filesize(content_file)
            assert excinfo.match(f'^{content_file}: No such file or directory$')

            # With callback
            def assert_call(t, fs_path, t_path, files_done, files_total, exc):
                assert t == torrent
                assert files_done == 1
                assert files_total == 1
                assert fs_path == Path(content_file)
                assert t_path == Path(Path(content_file).name)
                assert str(exc) == f'{content_file}: No such file or directory'
                return callback_return_values.pop(0)

            cb = mock.MagicMock()
            cb.side_effect = assert_call
            assert torrent.verify_filesize(content_file, callback=cb) is False
            assert cb.call_count == exp_calls
        finally:
            os.chmod(parent_path, mode=parent_path_mode)


def test_callback_raises_exception(create_dir, create_torrent_file):
    content_path = create_dir('content',
                              ('a.jpg', b'\x00' * 123),
                              ('b.jpg', b'\x00' * 456),
                              ('c.jpg', b'\x00' * 789))
    with create_torrent_file(path=content_path) as torrent_file:
        def assert_call(t, fs_path, t_path, files_done, files_total, exc):
            assert t == torrent
            assert files_done == cb.call_count
            assert files_total == 3
            if cb.call_count == 1:
                assert fs_path == content_path / 'a.jpg'
                assert t_path == Path(content_path.name, 'a.jpg')
                assert exc is None
            elif cb.call_count == 2:
                raise RuntimeError("I'm off")
            elif cb.call_count == 3:
                assert fs_path == content_path / 'c.jpg'
                assert t_path == Path(content_path.name, 'c.jpg')
                assert exc is None
            return None

        torrent = torf.Torrent.read(torrent_file)
        cb = mock.MagicMock()
        cb.side_effect = assert_call

        with pytest.raises(RuntimeError) as excinfo:
            torrent.verify_filesize(content_path, callback=cb)
        assert excinfo.match("^I'm off$")
        assert cb.call_count == 2