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