]> Raphaël G. Git Repositories - youtubedl/blob - test/test_utils.py
Record the explicit provenance of public domain status.
[youtubedl] / test / test_utils.py
1 #!/usr/bin/env python
2 # coding: utf-8
3
4 from __future__ import unicode_literals
5
6 # Allow direct execution
7 import os
8 import sys
9 import unittest
10 sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
11
12
13 # Various small unit tests
14 import io
15 import json
16 import xml.etree.ElementTree
17
18 from youtube_dl.utils import (
19 clean_html,
20 DateRange,
21 encodeFilename,
22 find_xpath_attr,
23 fix_xml_ampersands,
24 orderedSet,
25 OnDemandPagedList,
26 InAdvancePagedList,
27 parse_duration,
28 read_batch_urls,
29 sanitize_filename,
30 shell_quote,
31 smuggle_url,
32 str_to_int,
33 struct_unpack,
34 timeconvert,
35 unescapeHTML,
36 unified_strdate,
37 unsmuggle_url,
38 url_basename,
39 urlencode_postdata,
40 xpath_with_ns,
41 parse_iso8601,
42 strip_jsonp,
43 uppercase_escape,
44 limit_length,
45 escape_rfc3986,
46 escape_url,
47 js_to_json,
48 intlist_to_bytes,
49 args_to_str,
50 parse_filesize,
51 )
52
53
54 class TestUtil(unittest.TestCase):
55 def test_timeconvert(self):
56 self.assertTrue(timeconvert('') is None)
57 self.assertTrue(timeconvert('bougrg') is None)
58
59 def test_sanitize_filename(self):
60 self.assertEqual(sanitize_filename('abc'), 'abc')
61 self.assertEqual(sanitize_filename('abc_d-e'), 'abc_d-e')
62
63 self.assertEqual(sanitize_filename('123'), '123')
64
65 self.assertEqual('abc_de', sanitize_filename('abc/de'))
66 self.assertFalse('/' in sanitize_filename('abc/de///'))
67
68 self.assertEqual('abc_de', sanitize_filename('abc/<>\\*|de'))
69 self.assertEqual('xxx', sanitize_filename('xxx/<>\\*|'))
70 self.assertEqual('yes no', sanitize_filename('yes? no'))
71 self.assertEqual('this - that', sanitize_filename('this: that'))
72
73 self.assertEqual(sanitize_filename('AT&T'), 'AT&T')
74 aumlaut = 'ä'
75 self.assertEqual(sanitize_filename(aumlaut), aumlaut)
76 tests = '\u043a\u0438\u0440\u0438\u043b\u043b\u0438\u0446\u0430'
77 self.assertEqual(sanitize_filename(tests), tests)
78
79 forbidden = '"\0\\/'
80 for fc in forbidden:
81 for fbc in forbidden:
82 self.assertTrue(fbc not in sanitize_filename(fc))
83
84 def test_sanitize_filename_restricted(self):
85 self.assertEqual(sanitize_filename('abc', restricted=True), 'abc')
86 self.assertEqual(sanitize_filename('abc_d-e', restricted=True), 'abc_d-e')
87
88 self.assertEqual(sanitize_filename('123', restricted=True), '123')
89
90 self.assertEqual('abc_de', sanitize_filename('abc/de', restricted=True))
91 self.assertFalse('/' in sanitize_filename('abc/de///', restricted=True))
92
93 self.assertEqual('abc_de', sanitize_filename('abc/<>\\*|de', restricted=True))
94 self.assertEqual('xxx', sanitize_filename('xxx/<>\\*|', restricted=True))
95 self.assertEqual('yes_no', sanitize_filename('yes? no', restricted=True))
96 self.assertEqual('this_-_that', sanitize_filename('this: that', restricted=True))
97
98 tests = 'a\xe4b\u4e2d\u56fd\u7684c'
99 self.assertEqual(sanitize_filename(tests, restricted=True), 'a_b_c')
100 self.assertTrue(sanitize_filename('\xf6', restricted=True) != '') # No empty filename
101
102 forbidden = '"\0\\/&!: \'\t\n()[]{}$;`^,#'
103 for fc in forbidden:
104 for fbc in forbidden:
105 self.assertTrue(fbc not in sanitize_filename(fc, restricted=True))
106
107 # Handle a common case more neatly
108 self.assertEqual(sanitize_filename('\u5927\u58f0\u5e26 - Song', restricted=True), 'Song')
109 self.assertEqual(sanitize_filename('\u603b\u7edf: Speech', restricted=True), 'Speech')
110 # .. but make sure the file name is never empty
111 self.assertTrue(sanitize_filename('-', restricted=True) != '')
112 self.assertTrue(sanitize_filename(':', restricted=True) != '')
113
114 def test_sanitize_ids(self):
115 self.assertEqual(sanitize_filename('_n_cd26wFpw', is_id=True), '_n_cd26wFpw')
116 self.assertEqual(sanitize_filename('_BD_eEpuzXw', is_id=True), '_BD_eEpuzXw')
117 self.assertEqual(sanitize_filename('N0Y__7-UOdI', is_id=True), 'N0Y__7-UOdI')
118
119 def test_ordered_set(self):
120 self.assertEqual(orderedSet([1, 1, 2, 3, 4, 4, 5, 6, 7, 3, 5]), [1, 2, 3, 4, 5, 6, 7])
121 self.assertEqual(orderedSet([]), [])
122 self.assertEqual(orderedSet([1]), [1])
123 # keep the list ordered
124 self.assertEqual(orderedSet([135, 1, 1, 1]), [135, 1])
125
126 def test_unescape_html(self):
127 self.assertEqual(unescapeHTML('%20;'), '%20;')
128 self.assertEqual(
129 unescapeHTML('&eacute;'), 'é')
130
131 def test_daterange(self):
132 _20century = DateRange("19000101", "20000101")
133 self.assertFalse("17890714" in _20century)
134 _ac = DateRange("00010101")
135 self.assertTrue("19690721" in _ac)
136 _firstmilenium = DateRange(end="10000101")
137 self.assertTrue("07110427" in _firstmilenium)
138
139 def test_unified_dates(self):
140 self.assertEqual(unified_strdate('December 21, 2010'), '20101221')
141 self.assertEqual(unified_strdate('8/7/2009'), '20090708')
142 self.assertEqual(unified_strdate('Dec 14, 2012'), '20121214')
143 self.assertEqual(unified_strdate('2012/10/11 01:56:38 +0000'), '20121011')
144 self.assertEqual(unified_strdate('1968-12-10'), '19681210')
145 self.assertEqual(unified_strdate('28/01/2014 21:00:00 +0100'), '20140128')
146
147 def test_find_xpath_attr(self):
148 testxml = '''<root>
149 <node/>
150 <node x="a"/>
151 <node x="a" y="c" />
152 <node x="b" y="d" />
153 </root>'''
154 doc = xml.etree.ElementTree.fromstring(testxml)
155
156 self.assertEqual(find_xpath_attr(doc, './/fourohfour', 'n', 'v'), None)
157 self.assertEqual(find_xpath_attr(doc, './/node', 'x', 'a'), doc[1])
158 self.assertEqual(find_xpath_attr(doc, './/node', 'y', 'c'), doc[2])
159
160 def test_xpath_with_ns(self):
161 testxml = '''<root xmlns:media="http://example.com/">
162 <media:song>
163 <media:author>The Author</media:author>
164 <url>http://server.com/download.mp3</url>
165 </media:song>
166 </root>'''
167 doc = xml.etree.ElementTree.fromstring(testxml)
168 find = lambda p: doc.find(xpath_with_ns(p, {'media': 'http://example.com/'}))
169 self.assertTrue(find('media:song') is not None)
170 self.assertEqual(find('media:song/media:author').text, 'The Author')
171 self.assertEqual(find('media:song/url').text, 'http://server.com/download.mp3')
172
173 def test_smuggle_url(self):
174 data = {"ö": "ö", "abc": [3]}
175 url = 'https://foo.bar/baz?x=y#a'
176 smug_url = smuggle_url(url, data)
177 unsmug_url, unsmug_data = unsmuggle_url(smug_url)
178 self.assertEqual(url, unsmug_url)
179 self.assertEqual(data, unsmug_data)
180
181 res_url, res_data = unsmuggle_url(url)
182 self.assertEqual(res_url, url)
183 self.assertEqual(res_data, None)
184
185 def test_shell_quote(self):
186 args = ['ffmpeg', '-i', encodeFilename('ñ€ß\'.mp4')]
187 self.assertEqual(shell_quote(args), """ffmpeg -i 'ñ€ß'"'"'.mp4'""")
188
189 def test_str_to_int(self):
190 self.assertEqual(str_to_int('123,456'), 123456)
191 self.assertEqual(str_to_int('123.456'), 123456)
192
193 def test_url_basename(self):
194 self.assertEqual(url_basename('http://foo.de/'), '')
195 self.assertEqual(url_basename('http://foo.de/bar/baz'), 'baz')
196 self.assertEqual(url_basename('http://foo.de/bar/baz?x=y'), 'baz')
197 self.assertEqual(url_basename('http://foo.de/bar/baz#x=y'), 'baz')
198 self.assertEqual(url_basename('http://foo.de/bar/baz/'), 'baz')
199 self.assertEqual(
200 url_basename('http://media.w3.org/2010/05/sintel/trailer.mp4'),
201 'trailer.mp4')
202
203 def test_parse_duration(self):
204 self.assertEqual(parse_duration(None), None)
205 self.assertEqual(parse_duration('1'), 1)
206 self.assertEqual(parse_duration('1337:12'), 80232)
207 self.assertEqual(parse_duration('9:12:43'), 33163)
208 self.assertEqual(parse_duration('12:00'), 720)
209 self.assertEqual(parse_duration('00:01:01'), 61)
210 self.assertEqual(parse_duration('x:y'), None)
211 self.assertEqual(parse_duration('3h11m53s'), 11513)
212 self.assertEqual(parse_duration('3h 11m 53s'), 11513)
213 self.assertEqual(parse_duration('3 hours 11 minutes 53 seconds'), 11513)
214 self.assertEqual(parse_duration('3 hours 11 mins 53 secs'), 11513)
215 self.assertEqual(parse_duration('62m45s'), 3765)
216 self.assertEqual(parse_duration('6m59s'), 419)
217 self.assertEqual(parse_duration('49s'), 49)
218 self.assertEqual(parse_duration('0h0m0s'), 0)
219 self.assertEqual(parse_duration('0m0s'), 0)
220 self.assertEqual(parse_duration('0s'), 0)
221 self.assertEqual(parse_duration('01:02:03.05'), 3723.05)
222 self.assertEqual(parse_duration('T30M38S'), 1838)
223
224 def test_fix_xml_ampersands(self):
225 self.assertEqual(
226 fix_xml_ampersands('"&x=y&z=a'), '"&amp;x=y&amp;z=a')
227 self.assertEqual(
228 fix_xml_ampersands('"&amp;x=y&wrong;&z=a'),
229 '"&amp;x=y&amp;wrong;&amp;z=a')
230 self.assertEqual(
231 fix_xml_ampersands('&amp;&apos;&gt;&lt;&quot;'),
232 '&amp;&apos;&gt;&lt;&quot;')
233 self.assertEqual(
234 fix_xml_ampersands('&#1234;&#x1abC;'), '&#1234;&#x1abC;')
235 self.assertEqual(fix_xml_ampersands('&#&#'), '&amp;#&amp;#')
236
237 def test_paged_list(self):
238 def testPL(size, pagesize, sliceargs, expected):
239 def get_page(pagenum):
240 firstid = pagenum * pagesize
241 upto = min(size, pagenum * pagesize + pagesize)
242 for i in range(firstid, upto):
243 yield i
244
245 pl = OnDemandPagedList(get_page, pagesize)
246 got = pl.getslice(*sliceargs)
247 self.assertEqual(got, expected)
248
249 iapl = InAdvancePagedList(get_page, size // pagesize + 1, pagesize)
250 got = iapl.getslice(*sliceargs)
251 self.assertEqual(got, expected)
252
253 testPL(5, 2, (), [0, 1, 2, 3, 4])
254 testPL(5, 2, (1,), [1, 2, 3, 4])
255 testPL(5, 2, (2,), [2, 3, 4])
256 testPL(5, 2, (4,), [4])
257 testPL(5, 2, (0, 3), [0, 1, 2])
258 testPL(5, 2, (1, 4), [1, 2, 3])
259 testPL(5, 2, (2, 99), [2, 3, 4])
260 testPL(5, 2, (20, 99), [])
261
262 def test_struct_unpack(self):
263 self.assertEqual(struct_unpack('!B', b'\x00'), (0,))
264
265 def test_read_batch_urls(self):
266 f = io.StringIO('''\xef\xbb\xbf foo
267 bar\r
268 baz
269 # More after this line\r
270 ; or after this
271 bam''')
272 self.assertEqual(read_batch_urls(f), ['foo', 'bar', 'baz', 'bam'])
273
274 def test_urlencode_postdata(self):
275 data = urlencode_postdata({'username': 'foo@bar.com', 'password': '1234'})
276 self.assertTrue(isinstance(data, bytes))
277
278 def test_parse_iso8601(self):
279 self.assertEqual(parse_iso8601('2014-03-23T23:04:26+0100'), 1395612266)
280 self.assertEqual(parse_iso8601('2014-03-23T22:04:26+0000'), 1395612266)
281 self.assertEqual(parse_iso8601('2014-03-23T22:04:26Z'), 1395612266)
282 self.assertEqual(parse_iso8601('2014-03-23T22:04:26.1234Z'), 1395612266)
283
284 def test_strip_jsonp(self):
285 stripped = strip_jsonp('cb ([ {"id":"532cb",\n\n\n"x":\n3}\n]\n);')
286 d = json.loads(stripped)
287 self.assertEqual(d, [{"id": "532cb", "x": 3}])
288
289 stripped = strip_jsonp('parseMetadata({"STATUS":"OK"})\n\n\n//epc')
290 d = json.loads(stripped)
291 self.assertEqual(d, {'STATUS': 'OK'})
292
293 def test_uppercase_escape(self):
294 self.assertEqual(uppercase_escape('aä'), 'aä')
295 self.assertEqual(uppercase_escape('\\U0001d550'), '𝕐')
296
297 def test_limit_length(self):
298 self.assertEqual(limit_length(None, 12), None)
299 self.assertEqual(limit_length('foo', 12), 'foo')
300 self.assertTrue(
301 limit_length('foo bar baz asd', 12).startswith('foo bar'))
302 self.assertTrue('...' in limit_length('foo bar baz asd', 12))
303
304 def test_escape_rfc3986(self):
305 reserved = "!*'();:@&=+$,/?#[]"
306 unreserved = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_.~'
307 self.assertEqual(escape_rfc3986(reserved), reserved)
308 self.assertEqual(escape_rfc3986(unreserved), unreserved)
309 self.assertEqual(escape_rfc3986('тест'), '%D1%82%D0%B5%D1%81%D1%82')
310 self.assertEqual(escape_rfc3986('%D1%82%D0%B5%D1%81%D1%82'), '%D1%82%D0%B5%D1%81%D1%82')
311 self.assertEqual(escape_rfc3986('foo bar'), 'foo%20bar')
312 self.assertEqual(escape_rfc3986('foo%20bar'), 'foo%20bar')
313
314 def test_escape_url(self):
315 self.assertEqual(
316 escape_url('http://wowza.imust.org/srv/vod/telemb/new/UPLOAD/UPLOAD/20224_IncendieHavré_FD.mp4'),
317 'http://wowza.imust.org/srv/vod/telemb/new/UPLOAD/UPLOAD/20224_IncendieHavre%CC%81_FD.mp4'
318 )
319 self.assertEqual(
320 escape_url('http://www.ardmediathek.de/tv/Sturm-der-Liebe/Folge-2036-Zu-Mann-und-Frau-erklärt/Das-Erste/Video?documentId=22673108&bcastId=5290'),
321 'http://www.ardmediathek.de/tv/Sturm-der-Liebe/Folge-2036-Zu-Mann-und-Frau-erkl%C3%A4rt/Das-Erste/Video?documentId=22673108&bcastId=5290'
322 )
323 self.assertEqual(
324 escape_url('http://тест.рф/фрагмент'),
325 'http://тест.рф/%D1%84%D1%80%D0%B0%D0%B3%D0%BC%D0%B5%D0%BD%D1%82'
326 )
327 self.assertEqual(
328 escape_url('http://тест.рф/абв?абв=абв#абв'),
329 'http://тест.рф/%D0%B0%D0%B1%D0%B2?%D0%B0%D0%B1%D0%B2=%D0%B0%D0%B1%D0%B2#%D0%B0%D0%B1%D0%B2'
330 )
331 self.assertEqual(escape_url('http://vimeo.com/56015672#at=0'), 'http://vimeo.com/56015672#at=0')
332
333 def test_js_to_json_realworld(self):
334 inp = '''{
335 'clip':{'provider':'pseudo'}
336 }'''
337 self.assertEqual(js_to_json(inp), '''{
338 "clip":{"provider":"pseudo"}
339 }''')
340 json.loads(js_to_json(inp))
341
342 inp = '''{
343 'playlist':[{'controls':{'all':null}}]
344 }'''
345 self.assertEqual(js_to_json(inp), '''{
346 "playlist":[{"controls":{"all":null}}]
347 }''')
348
349 def test_js_to_json_edgecases(self):
350 on = js_to_json("{abc_def:'1\\'\\\\2\\\\\\'3\"4'}")
351 self.assertEqual(json.loads(on), {"abc_def": "1'\\2\\'3\"4"})
352
353 on = js_to_json('{"abc": true}')
354 self.assertEqual(json.loads(on), {'abc': True})
355
356 def test_clean_html(self):
357 self.assertEqual(clean_html('a:\nb'), 'a: b')
358 self.assertEqual(clean_html('a:\n "b"'), 'a: "b"')
359
360 def test_intlist_to_bytes(self):
361 self.assertEqual(
362 intlist_to_bytes([0, 1, 127, 128, 255]),
363 b'\x00\x01\x7f\x80\xff')
364
365 def test_args_to_str(self):
366 self.assertEqual(
367 args_to_str(['foo', 'ba/r', '-baz', '2 be', '']),
368 'foo ba/r -baz \'2 be\' \'\''
369 )
370
371 def test_parse_filesize(self):
372 self.assertEqual(parse_filesize(None), None)
373 self.assertEqual(parse_filesize(''), None)
374 self.assertEqual(parse_filesize('91 B'), 91)
375 self.assertEqual(parse_filesize('foobar'), None)
376 self.assertEqual(parse_filesize('2 MiB'), 2097152)
377 self.assertEqual(parse_filesize('5 GB'), 5000000000)
378 self.assertEqual(parse_filesize('1.2Tb'), 1200000000000)
379
380 if __name__ == '__main__':
381 unittest.main()