]> Raphaƫl G. Git Repositories - youtubedl/blob - test/test_download.py
8d869847821877042a3a73cc4939f833f17cd37b
[youtubedl] / test / test_download.py
1 #!/usr/bin/env python
2
3 import errno
4 import hashlib
5 import io
6 import os
7 import json
8 import unittest
9 import sys
10 import socket
11 import binascii
12
13 # Allow direct execution
14 sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
15
16 import youtube_dl.FileDownloader
17 import youtube_dl.extractor
18 from youtube_dl.utils import *
19
20 DEF_FILE = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'tests.json')
21 PARAMETERS_FILE = os.path.join(os.path.dirname(os.path.abspath(__file__)), "parameters.json")
22
23 RETRIES = 3
24
25 # General configuration (from __init__, not very elegant...)
26 jar = compat_cookiejar.CookieJar()
27 cookie_processor = compat_urllib_request.HTTPCookieProcessor(jar)
28 proxy_handler = compat_urllib_request.ProxyHandler()
29 opener = compat_urllib_request.build_opener(proxy_handler, cookie_processor, YoutubeDLHandler())
30 compat_urllib_request.install_opener(opener)
31 socket.setdefaulttimeout(10)
32
33 def _try_rm(filename):
34 """ Remove a file if it exists """
35 try:
36 os.remove(filename)
37 except OSError as ose:
38 if ose.errno != errno.ENOENT:
39 raise
40
41 md5 = lambda s: hashlib.md5(s.encode('utf-8')).hexdigest()
42
43 class FileDownloader(youtube_dl.FileDownloader):
44 def __init__(self, *args, **kwargs):
45 self.to_stderr = self.to_screen
46 self.processed_info_dicts = []
47 return youtube_dl.FileDownloader.__init__(self, *args, **kwargs)
48 def report_warning(self, message):
49 # Don't accept warnings during tests
50 raise ExtractorError(message)
51 def process_info(self, info_dict):
52 self.processed_info_dicts.append(info_dict)
53 return youtube_dl.FileDownloader.process_info(self, info_dict)
54
55 def _file_md5(fn):
56 with open(fn, 'rb') as f:
57 return hashlib.md5(f.read()).hexdigest()
58
59 with io.open(DEF_FILE, encoding='utf-8') as deff:
60 defs = json.load(deff)
61 with io.open(PARAMETERS_FILE, encoding='utf-8') as pf:
62 parameters = json.load(pf)
63
64
65 class TestDownload(unittest.TestCase):
66 maxDiff = None
67 def setUp(self):
68 self.parameters = parameters
69 self.defs = defs
70
71 ### Dynamically generate tests
72 def generator(test_case):
73
74 def test_template(self):
75 ie = youtube_dl.extractor.get_info_extractor(test_case['name'])
76 if not ie._WORKING:
77 print('Skipping: IE marked as not _WORKING')
78 return
79 if 'playlist' not in test_case and not test_case['file']:
80 print('Skipping: No output file specified')
81 return
82 if 'skip' in test_case:
83 print('Skipping: {0}'.format(test_case['skip']))
84 return
85
86 params = self.parameters.copy()
87 params.update(test_case.get('params', {}))
88
89 fd = FileDownloader(params)
90 for ie in youtube_dl.extractor.gen_extractors():
91 fd.add_info_extractor(ie)
92 finished_hook_called = set()
93 def _hook(status):
94 if status['status'] == 'finished':
95 finished_hook_called.add(status['filename'])
96 fd.add_progress_hook(_hook)
97
98 test_cases = test_case.get('playlist', [test_case])
99 for tc in test_cases:
100 _try_rm(tc['file'])
101 _try_rm(tc['file'] + '.part')
102 _try_rm(tc['file'] + '.info.json')
103 try:
104 for retry in range(1, RETRIES + 1):
105 try:
106 fd.download([test_case['url']])
107 except (DownloadError, ExtractorError) as err:
108 if retry == RETRIES: raise
109
110 # Check if the exception is not a network related one
111 if not err.exc_info[0] in (compat_urllib_error.URLError, socket.timeout, UnavailableVideoError):
112 raise
113
114 print('Retrying: {0} failed tries\n\n##########\n\n'.format(retry))
115 else:
116 break
117
118 for tc in test_cases:
119 if not test_case.get('params', {}).get('skip_download', False):
120 self.assertTrue(os.path.exists(tc['file']), msg='Missing file ' + tc['file'])
121 self.assertTrue(tc['file'] in finished_hook_called)
122 self.assertTrue(os.path.exists(tc['file'] + '.info.json'))
123 if 'md5' in tc:
124 md5_for_file = _file_md5(tc['file'])
125 self.assertEqual(md5_for_file, tc['md5'])
126 with io.open(tc['file'] + '.info.json', encoding='utf-8') as infof:
127 info_dict = json.load(infof)
128 for (info_field, expected) in tc.get('info_dict', {}).items():
129 if isinstance(expected, compat_str) and expected.startswith('md5:'):
130 self.assertEqual(expected, 'md5:' + md5(info_dict.get(info_field)))
131 else:
132 got = info_dict.get(info_field)
133 self.assertEqual(
134 expected, got,
135 u'invalid value for field %s, expected %r, got %r' % (info_field, expected, got))
136
137 # If checkable fields are missing from the test case, print the info_dict
138 test_info_dict = dict((key, value if not isinstance(value, compat_str) or len(value) < 250 else 'md5:' + md5(value))
139 for key, value in info_dict.items()
140 if value and key in ('title', 'description', 'uploader', 'upload_date', 'uploader_id', 'location'))
141 if not all(key in tc.get('info_dict', {}).keys() for key in test_info_dict.keys()):
142 sys.stderr.write(u'\n"info_dict": ' + json.dumps(test_info_dict, ensure_ascii=False, indent=2) + u'\n')
143
144 # Check for the presence of mandatory fields
145 for key in ('id', 'url', 'title', 'ext'):
146 self.assertTrue(key in info_dict.keys() and info_dict[key])
147 finally:
148 for tc in test_cases:
149 _try_rm(tc['file'])
150 _try_rm(tc['file'] + '.part')
151 _try_rm(tc['file'] + '.info.json')
152
153 return test_template
154
155 ### And add them to TestDownload
156 for test_case in defs:
157 test_method = generator(test_case)
158 test_method.__name__ = "test_{0}".format(test_case["name"])
159 setattr(TestDownload, test_method.__name__, test_method)
160 del test_method
161
162
163 if __name__ == '__main__':
164 unittest.main()