You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

449 lines
18 KiB

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