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
|
import io
from collections import OrderedDict
from datetime import datetime
from hashlib import sha1
from pathlib import Path
import torf.flatbencode as bencode
import pytest
import torf
from torf import _utils
def test_non_bencoded_data():
fo = io.BytesIO(b'not valid bencoded data')
with pytest.raises(torf.BdecodeError) as excinfo:
torf.Torrent.read_stream(fo)
assert excinfo.match('^Invalid metainfo format$')
def test_unreadable_stream():
class Unreadable(io.BytesIO):
def read(self, *args, **kwargs):
raise OSError('Refusing to read')
fo = Unreadable(b'foo')
with pytest.raises(torf.ReadError) as excinfo:
torf.Torrent.read_stream(fo)
assert excinfo.match('^Unable to read$')
def test_validate_when_reading_stream(valid_singlefile_metainfo):
del valid_singlefile_metainfo[b'info'][b'name']
fo = io.BytesIO(bencode.encode(valid_singlefile_metainfo))
with pytest.raises(torf.MetainfoError) as excinfo:
torf.Torrent.read_stream(fo, validate=True)
assert excinfo.match(r"^Invalid metainfo: Missing 'name' in \['info'\]$")
fo.seek(0)
t = torf.Torrent.read_stream(fo, validate=False)
assert isinstance(t, torf.Torrent)
def test_validate_when_reading_file(tmp_path, valid_singlefile_metainfo):
del valid_singlefile_metainfo[b'info'][b'length']
torrent_file = tmp_path / 'invalid.torrent'
with open(torrent_file, 'wb') as f:
f.write(bencode.encode(valid_singlefile_metainfo))
with pytest.raises(torf.MetainfoError) as excinfo:
torf.Torrent.read(torrent_file, validate=True)
assert excinfo.match("^Invalid metainfo: Missing 'length' or 'files' in 'info'$")
t = torf.Torrent.read(torrent_file, validate=False)
assert isinstance(t, torf.Torrent)
def test_successful_read(valid_singlefile_metainfo):
fo = io.BytesIO(bencode.encode(valid_singlefile_metainfo))
t = torf.Torrent.read_stream(fo)
assert t.path is None
assert t.files == (Path(str(valid_singlefile_metainfo[b'info'][b'name'], encoding='utf-8')),)
assert t.filepaths == ()
assert t.name == str(valid_singlefile_metainfo[b'info'][b'name'], encoding='utf-8')
assert t.size == valid_singlefile_metainfo[b'info'][b'length']
assert t.infohash == sha1(bencode.encode(valid_singlefile_metainfo[b'info'])).hexdigest()
assert t.comment == str(valid_singlefile_metainfo[b'comment'], encoding='utf-8')
assert t.creation_date == datetime.fromtimestamp(valid_singlefile_metainfo[b'creation date'])
assert t.created_by == str(valid_singlefile_metainfo[b'created by'], encoding='utf-8')
assert t.private is bool(valid_singlefile_metainfo[b'info'][b'private'])
assert t.piece_size == valid_singlefile_metainfo[b'info'][b'piece length']
def test_single_tracker(valid_singlefile_metainfo):
valid_singlefile_metainfo[b'announce'] = b'http://lonelyhost/announce'
valid_singlefile_metainfo.pop(b'announce-list', None)
fo = io.BytesIO(bencode.encode(valid_singlefile_metainfo))
t = torf.Torrent.read_stream(fo)
assert t.trackers == [[str(valid_singlefile_metainfo[b'announce'], encoding='utf-8')]]
def test_multiple_trackers(valid_singlefile_metainfo):
valid_singlefile_metainfo[b'announce-list'] = [[b'http://localhost', b'http://foohost'],
[b'http://bazhost']]
valid_singlefile_metainfo.pop(b'announce', None)
fo = io.BytesIO(bencode.encode(valid_singlefile_metainfo))
t = torf.Torrent.read_stream(fo)
assert t.trackers == [[str(url, encoding='utf-8') for url in tier] for tier
in valid_singlefile_metainfo[b'announce-list']]
def test_validate_nondict():
data = b'3:foo'
with pytest.raises(torf.BdecodeError) as excinfo:
torf.Torrent.read_stream(io.BytesIO(data), validate=True)
assert excinfo.match("^Invalid metainfo format$")
with pytest.raises(torf.BdecodeError) as excinfo:
torf.Torrent.read_stream(io.BytesIO(data), validate=False)
assert excinfo.match("^Invalid metainfo format$")
def test_validate_missing_info():
data = OrderedDict([(b'foo', b'bar')])
with pytest.raises(torf.MetainfoError) as excinfo:
torf.Torrent.read_stream(io.BytesIO(bencode.encode(data)), validate=True)
assert excinfo.match(r"^Invalid metainfo: Missing 'info'$")
t = torf.Torrent.read_stream(io.BytesIO(bencode.encode(data)), validate=False)
assert t.metainfo == {'foo': 'bar', 'info': {}}
def test_validate_info_not_a_dictionary():
data = OrderedDict([(b'info', 1)])
with pytest.raises(torf.MetainfoError) as excinfo:
torf.Torrent.read_stream(io.BytesIO(bencode.encode(data)), validate=True)
assert excinfo.match(r"^Invalid metainfo: \['info'\] must be dict, not int: 1$")
with pytest.raises(torf.MetainfoError) as excinfo:
torf.Torrent.read_stream(io.BytesIO(bencode.encode(data)), validate=False)
assert excinfo.match(r"^Invalid metainfo: \['info'\] must be dict, not int: 1$")
def test_validate_missing_pieces():
data = OrderedDict([(b'info', {b'name': b'Foo',
b'piece length': 16384})])
fo = io.BytesIO(bencode.encode(data))
with pytest.raises(torf.MetainfoError) as excinfo:
torf.Torrent.read_stream(fo, validate=True)
assert excinfo.match(r"^Invalid metainfo: Missing 'pieces' in \['info'\]$")
def test_read_nonstandard_data_without_validation():
data = OrderedDict([
(b'foo', b'bar'),
(b'number', 17),
(b'list', [1, b'two']),
(b'dict', OrderedDict([
(b'yes', 1),
(b'no', 0),
]))
])
fo = io.BytesIO(bencode.encode(data))
t = torf.Torrent.read_stream(fo, validate=False)
assert t.metainfo['foo'] == 'bar'
assert t.metainfo['number'] == 17
assert t.metainfo['list'] == [1, 'two']
assert t.metainfo['dict'] == {'yes': 1, 'no': 0}
assert t.metainfo['info'] == {}
def test_read_from_unreadable_file(valid_singlefile_metainfo, tmp_path):
f = (tmp_path / 'a.torrent')
f.write_bytes(bencode.encode(valid_singlefile_metainfo))
f.chmod(mode=0o222)
with pytest.raises(torf.ReadError) as excinfo:
torf.Torrent.read(str(f))
assert excinfo.match(f'^{f}: Permission denied$')
def test_read_from_invalid_file(tmp_path):
f = tmp_path / 'a.torrent'
f.write_bytes(b'this is not metainfo')
with pytest.raises(torf.BdecodeError) as excinfo:
torf.Torrent.read(f)
assert excinfo.match(f'^{f}: Invalid torrent file format$')
def test_read_from_nonexisting_file(tmp_path):
f = tmp_path / 'a.torrent'
with pytest.raises(torf.ReadError) as excinfo:
torf.Torrent.read(f)
assert excinfo.match(f'^{f}: No such file or directory$')
def test_read_from_proper_torrent_file(valid_multifile_metainfo, tmp_path):
f = tmp_path / 'a.torrent'
f.write_bytes(bencode.encode(valid_multifile_metainfo))
t = torf.Torrent.read(f)
exp_info = valid_multifile_metainfo[b'info']
assert t.path is None
assert t.files == tuple(Path(str(b'/'.join([exp_info[b'name']] + f[b'path']), encoding='utf-8'))
for f in exp_info[b'files'])
assert t.filepaths == ()
assert t.name == str(exp_info[b'name'], encoding='utf-8')
assert t.size == sum(f[b'length'] for f in exp_info[b'files'])
assert t.infohash == sha1(bencode.encode(exp_info)).hexdigest()
assert t.comment == str(valid_multifile_metainfo[b'comment'], encoding='utf-8')
assert t.creation_date == datetime.fromtimestamp(valid_multifile_metainfo[b'creation date'])
assert t.created_by == str(valid_multifile_metainfo[b'created by'], encoding='utf-8')
assert t.private is bool(exp_info[b'private'])
assert t.piece_size == exp_info[b'piece length']
@pytest.mark.parametrize('bytes_type', (bytes, bytearray), ids=lambda t: t.__name__)
def test_read_from_bytes(bytes_type, valid_multifile_metainfo, tmp_path):
bytes = bytes_type(bencode.encode(valid_multifile_metainfo))
t = torf.Torrent.read_stream(bytes)
exp_info = valid_multifile_metainfo[b'info']
assert t.path is None
assert t.files == tuple(Path(str(b'/'.join([exp_info[b'name']] + f[b'path']), encoding='utf-8'))
for f in exp_info[b'files'])
assert t.filepaths == ()
assert t.name == str(exp_info[b'name'], encoding='utf-8')
assert t.size == sum(f[b'length'] for f in exp_info[b'files'])
assert t.infohash == sha1(bencode.encode(exp_info)).hexdigest()
assert t.comment == str(valid_multifile_metainfo[b'comment'], encoding='utf-8')
assert t.creation_date == datetime.fromtimestamp(valid_multifile_metainfo[b'creation date'])
assert t.created_by == str(valid_multifile_metainfo[b'created by'], encoding='utf-8')
assert t.private is bool(exp_info[b'private'])
assert t.piece_size == exp_info[b'piece length']
@pytest.mark.parametrize('bytes_type', (bytes, bytearray), ids=lambda t: t.__name__)
def test_read_from_too_many_bytes(bytes_type, valid_multifile_metainfo, tmp_path):
bytes = bytes_type(b'x' * (torf.Torrent.MAX_TORRENT_FILE_SIZE + 1))
with pytest.raises(ValueError, match=(
r'^Size of stream exceeds Torrent.MAX_TORRENT_FILE_SIZE: '
f'{torf.Torrent.MAX_TORRENT_FILE_SIZE + 1} > {torf.Torrent.MAX_TORRENT_FILE_SIZE}$'
)):
torf.Torrent.read_stream(bytes)
def test_read_from_invalid_type(valid_multifile_metainfo, tmp_path):
obj = 123
with pytest.raises(TypeError, match=r'^Expected bytes, bytearray or a readable file-like object, got int$'):
torf.Torrent.read_stream(obj)
def test_reading_converts_private_flag_to_bool(tmp_path, valid_singlefile_metainfo):
valid_singlefile_metainfo[b'info'][b'private'] = 1
fo = io.BytesIO(bencode.encode(valid_singlefile_metainfo))
torrent = torf.Torrent.read_stream(fo)
assert torrent.metainfo['info']['private'] is True
valid_singlefile_metainfo[b'info'][b'private'] = 0
fo = io.BytesIO(bencode.encode(valid_singlefile_metainfo))
torrent = torf.Torrent.read_stream(fo)
assert torrent.metainfo['info']['private'] is False
def test_reading_torrent_without_private_flag(tmp_path, valid_singlefile_metainfo):
valid_singlefile_metainfo[b'info'][b'private'] = 1
fo = io.BytesIO(bencode.encode(valid_singlefile_metainfo))
torrent = torf.Torrent.read_stream(fo)
assert torrent.metainfo['info']['private'] is True
assert torrent.private is True
del valid_singlefile_metainfo[b'info'][b'private']
fo = io.BytesIO(bencode.encode(valid_singlefile_metainfo))
torrent = torf.Torrent.read_stream(fo)
assert 'private' not in torrent.metainfo['info']
assert torrent.private is None
def test_reading_torrent_without_creation_date(tmp_path, valid_singlefile_metainfo):
del valid_singlefile_metainfo[b'creation date']
fo = io.BytesIO(bencode.encode(valid_singlefile_metainfo))
torrent = torf.Torrent.read_stream(fo)
assert 'creation date' not in torrent.metainfo['info']
assert torrent.creation_date is None
def test_read_from_torrent_file_with_empty_path_components(valid_multifile_metainfo, tmp_path):
valid_multifile_metainfo[b'info'][b'files'][0][b'path'] = [b'', b'foo', b'', b'', b'bar', b'']
f = (tmp_path / 'foo.torrent')
f.write_bytes(bencode.encode(valid_multifile_metainfo))
t = torf.Torrent.read(str(f))
exp_path = f'{valid_multifile_metainfo[b"info"][b"name"].decode()}/foo/bar'
assert exp_path in tuple(str(f) for f in t.files)
def test_read_nonutf8_encoded_metainfo(valid_multifile_metainfo, tmp_path):
valid_multifile_metainfo[b'comment'] = 'A çommقnt'.encode('CP1256')
valid_multifile_metainfo[b'created by'] = 'bДd ЗncodeЯ'.encode('CP866')
valid_multifile_metainfo[b'info'][b'name'] = 'Thê ñãme'.encode('CP860')
valid_multifile_metainfo[b'info'][b'source'] = 'Þhe ßource'.encode('CP861')
valid_multifile_metainfo[b'info'][b'files'] = [
{
b'path': [
'FΩO'.encode('ISO8859-7'),
'BAΓ'.encode('ISO8859-7'),
'βAZ'.encode('ISO8859-7'),
],
b'length': 124,
},
]
f = (tmp_path / 'test.torrent')
f.write_bytes(bencode.encode(valid_multifile_metainfo))
t = torf.Torrent.read(str(f))
assert t.name == 'Th� ��me'
assert t.comment == 'A �omm�nt'
assert t.created_by == 'b�d �ncode�'
assert t.source == '�he �ource'
assert t.files == [
_utils.File('Th� ��me/F�O/BA�/�AZ', size=124),
]
|
