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.

375 lines
15 KiB

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