13 # Allow direct execution
14 sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
16 import youtube_dl.YoutubeDL
17 import youtube_dl.extractor
18 from youtube_dl.utils import *
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")
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)
33 def _try_rm(filename):
34 """ Remove a file if it exists """
37 except OSError as ose:
38 if ose.errno != errno.ENOENT:
41 md5 = lambda s: hashlib.md5(s.encode('utf-8')).hexdigest()
43 class YoutubeDL(youtube_dl.YoutubeDL):
44 def __init__(self, *args, **kwargs):
45 self.to_stderr = self.to_screen
46 self.processed_info_dicts = []
47 super(YoutubeDL, self).__init__(*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 super(YoutubeDL, self).process_info(info_dict)
56 with open(fn, 'rb') as f:
57 return hashlib.md5(f.read()).hexdigest()
59 with io.open(DEF_FILE, encoding='utf-8') as deff:
60 defs = json.load(deff)
61 for ie in youtube_dl.extractor.gen_extractors():
62 t = getattr(ie, '_TEST', None)
64 t['name'] = type(ie).__name__[:-len('IE')]
68 with io.open(PARAMETERS_FILE, encoding='utf-8') as pf:
69 parameters = json.load(pf)
72 class TestDownload(unittest.TestCase):
75 self.parameters = parameters
78 ### Dynamically generate tests
79 def generator(test_case):
81 def test_template(self):
82 ie = youtube_dl.extractor.get_info_extractor(test_case['name'])
84 print('Skipping: IE marked as not _WORKING')
86 if 'playlist' not in test_case and not test_case['file']:
87 print('Skipping: No output file specified')
89 if 'skip' in test_case:
90 print('Skipping: {0}'.format(test_case['skip']))
93 params = self.parameters.copy()
94 params.update(test_case.get('params', {}))
96 ydl = YoutubeDL(params)
97 for ie in youtube_dl.extractor.gen_extractors():
98 ydl.add_info_extractor(ie)
99 finished_hook_called = set()
101 if status['status'] == 'finished':
102 finished_hook_called.add(status['filename'])
103 ydl.fd.add_progress_hook(_hook)
105 test_cases = test_case.get('playlist', [test_case])
106 for tc in test_cases:
108 _try_rm(tc['file'] + '.part')
109 _try_rm(tc['file'] + '.info.json')
111 for retry in range(1, RETRIES + 1):
113 ydl.download([test_case['url']])
114 except (DownloadError, ExtractorError) as err:
115 if retry == RETRIES: raise
117 # Check if the exception is not a network related one
118 if not err.exc_info[0] in (compat_urllib_error.URLError, socket.timeout, UnavailableVideoError):
121 print('Retrying: {0} failed tries\n\n##########\n\n'.format(retry))
125 for tc in test_cases:
126 if not test_case.get('params', {}).get('skip_download', False):
127 self.assertTrue(os.path.exists(tc['file']), msg='Missing file ' + tc['file'])
128 self.assertTrue(tc['file'] in finished_hook_called)
129 self.assertTrue(os.path.exists(tc['file'] + '.info.json'))
131 md5_for_file = _file_md5(tc['file'])
132 self.assertEqual(md5_for_file, tc['md5'])
133 with io.open(tc['file'] + '.info.json', encoding='utf-8') as infof:
134 info_dict = json.load(infof)
135 for (info_field, expected) in tc.get('info_dict', {}).items():
136 if isinstance(expected, compat_str) and expected.startswith('md5:'):
137 self.assertEqual(expected, 'md5:' + md5(info_dict.get(info_field)))
139 got = info_dict.get(info_field)
142 u'invalid value for field %s, expected %r, got %r' % (info_field, expected, got))
144 # If checkable fields are missing from the test case, print the info_dict
145 test_info_dict = dict((key, value if not isinstance(value, compat_str) or len(value) < 250 else 'md5:' + md5(value))
146 for key, value in info_dict.items()
147 if value and key in ('title', 'description', 'uploader', 'upload_date', 'uploader_id', 'location'))
148 if not all(key in tc.get('info_dict', {}).keys() for key in test_info_dict.keys()):
149 sys.stderr.write(u'\n"info_dict": ' + json.dumps(test_info_dict, ensure_ascii=False, indent=2) + u'\n')
151 # Check for the presence of mandatory fields
152 for key in ('id', 'url', 'title', 'ext'):
153 self.assertTrue(key in info_dict.keys() and info_dict[key])
155 for tc in test_cases:
157 _try_rm(tc['file'] + '.part')
158 _try_rm(tc['file'] + '.info.json')
162 ### And add them to TestDownload
163 for n, test_case in enumerate(defs):
164 test_method = generator(test_case)
165 test_method.__name__ = "test_{0}".format(test_case["name"])
166 if getattr(TestDownload, test_method.__name__, False):
167 test_method.__name__ = "test_{0}_{1}".format(test_case["name"], n)
168 setattr(TestDownload, test_method.__name__, test_method)
172 if __name__ == '__main__':