]> jfr.im git - yt-dlp.git/blame - test/test_utils.py
release 2014.09.14.3
[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 (
a921f407 19 DateRange,
29eb5174 20 encodeFilename,
a921f407 21 find_xpath_attr,
5aafe895 22 fix_xml_ampersands,
a921f407 23 get_meta_content,
29eb5174 24 orderedSet,
b7ab0590 25 PagedList,
608d11f5 26 parse_duration,
62e609ab 27 read_batch_urls,
29eb5174 28 sanitize_filename,
a6a173c2 29 shell_quote,
29eb5174 30 smuggle_url,
f53c966a 31 str_to_int,
b53466e1 32 struct_unpack,
29eb5174
PH
33 timeconvert,
34 unescapeHTML,
35 unified_strdate,
36 unsmuggle_url,
37 url_basename,
b74fa8cd 38 urlencode_postdata,
29eb5174 39 xpath_with_ns,
912b38b4 40 parse_iso8601,
fac55558 41 strip_jsonp,
676eb3f2 42 uppercase_escape,
a921f407 43)
44fb3454 44
627dcfff 45
44fb3454 46class TestUtil(unittest.TestCase):
59ae15a5
PH
47 def test_timeconvert(self):
48 self.assertTrue(timeconvert('') is None)
49 self.assertTrue(timeconvert('bougrg') is None)
50
51 def test_sanitize_filename(self):
52 self.assertEqual(sanitize_filename('abc'), 'abc')
53 self.assertEqual(sanitize_filename('abc_d-e'), 'abc_d-e')
54
55 self.assertEqual(sanitize_filename('123'), '123')
56
57 self.assertEqual('abc_de', sanitize_filename('abc/de'))
58 self.assertFalse('/' in sanitize_filename('abc/de///'))
59
60 self.assertEqual('abc_de', sanitize_filename('abc/<>\\*|de'))
61 self.assertEqual('xxx', sanitize_filename('xxx/<>\\*|'))
62 self.assertEqual('yes no', sanitize_filename('yes? no'))
63 self.assertEqual('this - that', sanitize_filename('this: that'))
64
65 self.assertEqual(sanitize_filename('AT&T'), 'AT&T')
4e408e47 66 aumlaut = 'ä'
59ae15a5 67 self.assertEqual(sanitize_filename(aumlaut), aumlaut)
4e408e47 68 tests = '\u043a\u0438\u0440\u0438\u043b\u043b\u0438\u0446\u0430'
59ae15a5
PH
69 self.assertEqual(sanitize_filename(tests), tests)
70
71 forbidden = '"\0\\/'
72 for fc in forbidden:
73 for fbc in forbidden:
74 self.assertTrue(fbc not in sanitize_filename(fc))
75
76 def test_sanitize_filename_restricted(self):
77 self.assertEqual(sanitize_filename('abc', restricted=True), 'abc')
78 self.assertEqual(sanitize_filename('abc_d-e', restricted=True), 'abc_d-e')
79
80 self.assertEqual(sanitize_filename('123', restricted=True), '123')
81
82 self.assertEqual('abc_de', sanitize_filename('abc/de', restricted=True))
83 self.assertFalse('/' in sanitize_filename('abc/de///', restricted=True))
84
85 self.assertEqual('abc_de', sanitize_filename('abc/<>\\*|de', restricted=True))
86 self.assertEqual('xxx', sanitize_filename('xxx/<>\\*|', restricted=True))
87 self.assertEqual('yes_no', sanitize_filename('yes? no', restricted=True))
88 self.assertEqual('this_-_that', sanitize_filename('this: that', restricted=True))
89
4e408e47 90 tests = 'a\xe4b\u4e2d\u56fd\u7684c'
59ae15a5 91 self.assertEqual(sanitize_filename(tests, restricted=True), 'a_b_c')
4e408e47 92 self.assertTrue(sanitize_filename('\xf6', restricted=True) != '') # No empty filename
59ae15a5 93
627dcfff 94 forbidden = '"\0\\/&!: \'\t\n()[]{}$;`^,#'
59ae15a5
PH
95 for fc in forbidden:
96 for fbc in forbidden:
97 self.assertTrue(fbc not in sanitize_filename(fc, restricted=True))
98
99 # Handle a common case more neatly
4e408e47
PH
100 self.assertEqual(sanitize_filename('\u5927\u58f0\u5e26 - Song', restricted=True), 'Song')
101 self.assertEqual(sanitize_filename('\u603b\u7edf: Speech', restricted=True), 'Speech')
59ae15a5
PH
102 # .. but make sure the file name is never empty
103 self.assertTrue(sanitize_filename('-', restricted=True) != '')
104 self.assertTrue(sanitize_filename(':', restricted=True) != '')
105
796173d0 106 def test_sanitize_ids(self):
314d506b
PH
107 self.assertEqual(sanitize_filename('_n_cd26wFpw', is_id=True), '_n_cd26wFpw')
108 self.assertEqual(sanitize_filename('_BD_eEpuzXw', is_id=True), '_BD_eEpuzXw')
109 self.assertEqual(sanitize_filename('N0Y__7-UOdI', is_id=True), 'N0Y__7-UOdI')
796173d0 110
59ae15a5 111 def test_ordered_set(self):
627dcfff 112 self.assertEqual(orderedSet([1, 1, 2, 3, 4, 4, 5, 6, 7, 3, 5]), [1, 2, 3, 4, 5, 6, 7])
59ae15a5
PH
113 self.assertEqual(orderedSet([]), [])
114 self.assertEqual(orderedSet([1]), [1])
115 #keep the list ordered
627dcfff 116 self.assertEqual(orderedSet([135, 1, 1, 1]), [135, 1])
59ae15a5
PH
117
118 def test_unescape_html(self):
4e408e47
PH
119 self.assertEqual(unescapeHTML('%20;'), '%20;')
120 self.assertEqual(
121 unescapeHTML('&eacute;'), 'é')
bd558525
JMF
122
123 def test_daterange(self):
124 _20century = DateRange("19000101","20000101")
125 self.assertFalse("17890714" in _20century)
126 _ac = DateRange("00010101")
127 self.assertTrue("19690721" in _ac)
128 _firstmilenium = DateRange(end="10000101")
129 self.assertTrue("07110427" in _firstmilenium)
37254abc 130
bf50b038
JMF
131 def test_unified_dates(self):
132 self.assertEqual(unified_strdate('December 21, 2010'), '20101221')
133 self.assertEqual(unified_strdate('8/7/2009'), '20090708')
134 self.assertEqual(unified_strdate('Dec 14, 2012'), '20121214')
135 self.assertEqual(unified_strdate('2012/10/11 01:56:38 +0000'), '20121011')
026fcc04 136 self.assertEqual(unified_strdate('1968-12-10'), '19681210')
dae7c920 137
59ae56fa 138 def test_find_xpath_attr(self):
4e408e47 139 testxml = '''<root>
59ae56fa
PH
140 <node/>
141 <node x="a"/>
142 <node x="a" y="c" />
143 <node x="b" y="d" />
144 </root>'''
145 doc = xml.etree.ElementTree.fromstring(testxml)
146
147 self.assertEqual(find_xpath_attr(doc, './/fourohfour', 'n', 'v'), None)
148 self.assertEqual(find_xpath_attr(doc, './/node', 'x', 'a'), doc[1])
149 self.assertEqual(find_xpath_attr(doc, './/node', 'y', 'c'), doc[2])
150
a921f407 151 def test_meta_parser(self):
4e408e47 152 testhtml = '''
a921f407
JMF
153 <head>
154 <meta name="description" content="foo &amp; bar">
155 <meta content='Plato' name='author'/>
156 </head>
157 '''
158 get_meta = lambda name: get_meta_content(name, testhtml)
4e408e47 159 self.assertEqual(get_meta('description'), 'foo & bar')
a921f407
JMF
160 self.assertEqual(get_meta('author'), 'Plato')
161
d7e66d39 162 def test_xpath_with_ns(self):
4e408e47 163 testxml = '''<root xmlns:media="http://example.com/">
d7e66d39
JMF
164 <media:song>
165 <media:author>The Author</media:author>
166 <url>http://server.com/download.mp3</url>
167 </media:song>
168 </root>'''
169 doc = xml.etree.ElementTree.fromstring(testxml)
170 find = lambda p: doc.find(xpath_with_ns(p, {'media': 'http://example.com/'}))
171 self.assertTrue(find('media:song') is not None)
4e408e47
PH
172 self.assertEqual(find('media:song/media:author').text, 'The Author')
173 self.assertEqual(find('media:song/url').text, 'http://server.com/download.mp3')
d7e66d39 174
9d4660ca
PH
175 def test_smuggle_url(self):
176 data = {u"ö": u"ö", u"abc": [3]}
177 url = 'https://foo.bar/baz?x=y#a'
178 smug_url = smuggle_url(url, data)
179 unsmug_url, unsmug_data = unsmuggle_url(smug_url)
180 self.assertEqual(url, unsmug_url)
181 self.assertEqual(data, unsmug_data)
182
183 res_url, res_data = unsmuggle_url(url)
184 self.assertEqual(res_url, url)
185 self.assertEqual(res_data, None)
186
a6a173c2 187 def test_shell_quote(self):
4e408e47
PH
188 args = ['ffmpeg', '-i', encodeFilename('ñ€ß\'.mp4')]
189 self.assertEqual(shell_quote(args), """ffmpeg -i 'ñ€ß'"'"'.mp4'""")
a6a173c2 190
f53c966a
JMF
191 def test_str_to_int(self):
192 self.assertEqual(str_to_int('123,456'), 123456)
193 self.assertEqual(str_to_int('123.456'), 123456)
194
29eb5174 195 def test_url_basename(self):
4e408e47
PH
196 self.assertEqual(url_basename('http://foo.de/'), '')
197 self.assertEqual(url_basename('http://foo.de/bar/baz'), 'baz')
198 self.assertEqual(url_basename('http://foo.de/bar/baz?x=y'), 'baz')
199 self.assertEqual(url_basename('http://foo.de/bar/baz#x=y'), 'baz')
200 self.assertEqual(url_basename('http://foo.de/bar/baz/'), 'baz')
d6c7a367 201 self.assertEqual(
4e408e47
PH
202 url_basename('http://media.w3.org/2010/05/sintel/trailer.mp4'),
203 'trailer.mp4')
9d4660ca 204
608d11f5
PH
205 def test_parse_duration(self):
206 self.assertEqual(parse_duration(None), None)
207 self.assertEqual(parse_duration('1'), 1)
208 self.assertEqual(parse_duration('1337:12'), 80232)
209 self.assertEqual(parse_duration('9:12:43'), 33163)
2db806b4
S
210 self.assertEqual(parse_duration('12:00'), 720)
211 self.assertEqual(parse_duration('00:01:01'), 61)
608d11f5 212 self.assertEqual(parse_duration('x:y'), None)
2db806b4 213 self.assertEqual(parse_duration('3h11m53s'), 11513)
ca7b3246
S
214 self.assertEqual(parse_duration('3h 11m 53s'), 11513)
215 self.assertEqual(parse_duration('3 hours 11 minutes 53 seconds'), 11513)
216 self.assertEqual(parse_duration('3 hours 11 mins 53 secs'), 11513)
2db806b4
S
217 self.assertEqual(parse_duration('62m45s'), 3765)
218 self.assertEqual(parse_duration('6m59s'), 419)
219 self.assertEqual(parse_duration('49s'), 49)
220 self.assertEqual(parse_duration('0h0m0s'), 0)
221 self.assertEqual(parse_duration('0m0s'), 0)
222 self.assertEqual(parse_duration('0s'), 0)
7adcbe75 223 self.assertEqual(parse_duration('01:02:03.05'), 3723.05)
608d11f5 224
5aafe895
PH
225 def test_fix_xml_ampersands(self):
226 self.assertEqual(
227 fix_xml_ampersands('"&x=y&z=a'), '"&amp;x=y&amp;z=a')
228 self.assertEqual(
229 fix_xml_ampersands('"&amp;x=y&wrong;&z=a'),
230 '"&amp;x=y&amp;wrong;&amp;z=a')
231 self.assertEqual(
232 fix_xml_ampersands('&amp;&apos;&gt;&lt;&quot;'),
233 '&amp;&apos;&gt;&lt;&quot;')
234 self.assertEqual(
235 fix_xml_ampersands('&#1234;&#x1abC;'), '&#1234;&#x1abC;')
236 self.assertEqual(fix_xml_ampersands('&#&#'), '&amp;#&amp;#')
237
b7ab0590
PH
238 def test_paged_list(self):
239 def testPL(size, pagesize, sliceargs, expected):
240 def get_page(pagenum):
241 firstid = pagenum * pagesize
242 upto = min(size, pagenum * pagesize + pagesize)
243 for i in range(firstid, upto):
244 yield i
245
246 pl = PagedList(get_page, pagesize)
247 got = pl.getslice(*sliceargs)
248 self.assertEqual(got, expected)
249
250 testPL(5, 2, (), [0, 1, 2, 3, 4])
251 testPL(5, 2, (1,), [1, 2, 3, 4])
252 testPL(5, 2, (2,), [2, 3, 4])
253 testPL(5, 2, (4,), [4])
254 testPL(5, 2, (0, 3), [0, 1, 2])
255 testPL(5, 2, (1, 4), [1, 2, 3])
256 testPL(5, 2, (2, 99), [2, 3, 4])
257 testPL(5, 2, (20, 99), [])
258
b53466e1 259 def test_struct_unpack(self):
4e408e47 260 self.assertEqual(struct_unpack('!B', b'\x00'), (0,))
b53466e1 261
62e609ab 262 def test_read_batch_urls(self):
4e408e47 263 f = io.StringIO('''\xef\xbb\xbf foo
62e609ab
PH
264 bar\r
265 baz
266 # More after this line\r
267 ; or after this
268 bam''')
4e408e47 269 self.assertEqual(read_batch_urls(f), ['foo', 'bar', 'baz', 'bam'])
62e609ab 270
b74fa8cd
JMF
271 def test_urlencode_postdata(self):
272 data = urlencode_postdata({'username': 'foo@bar.com', 'password': '1234'})
273 self.assertTrue(isinstance(data, bytes))
274
912b38b4
PH
275 def test_parse_iso8601(self):
276 self.assertEqual(parse_iso8601('2014-03-23T23:04:26+0100'), 1395612266)
277 self.assertEqual(parse_iso8601('2014-03-23T22:04:26+0000'), 1395612266)
278 self.assertEqual(parse_iso8601('2014-03-23T22:04:26Z'), 1395612266)
279
fac55558
PH
280 def test_strip_jsonp(self):
281 stripped = strip_jsonp('cb ([ {"id":"532cb",\n\n\n"x":\n3}\n]\n);')
282 d = json.loads(stripped)
283 self.assertEqual(d, [{"id": "532cb", "x": 3}])
284
173a7026 285 def test_uppercase_escape(self):
4e408e47
PH
286 self.assertEqual(uppercase_escape('aä'), 'aä')
287 self.assertEqual(uppercase_escape('\\U0001d550'), '𝕐')
fac55558 288
dae7c920 289if __name__ == '__main__':
59ae15a5 290 unittest.main()