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