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.

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