]>
Commit | Line | Data |
---|---|---|
cc52de43 | 1 | #!/usr/bin/env python3 |
54007a45 | 2 | |
44a5f171 PH |
3 | # Allow direct execution |
4 | import os | |
5 | import sys | |
6 | import unittest | |
f8271158 | 7 | |
44a5f171 PH |
8 | sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__)))) |
9 | ||
ac668111 | 10 | |
f2e8dbcc | 11 | import collections |
ac668111 | 12 | import hashlib |
13 | import json | |
ac668111 | 14 | |
dd508b7c | 15 | from test.helper import ( |
0990305d | 16 | assertGreaterEqual, |
060ac762 | 17 | expect_info_dict, |
70b7e3fb | 18 | expect_warnings, |
dd508b7c | 19 | get_params, |
ff14fc49 | 20 | gettestcases, |
f2e8dbcc | 21 | getwebpagetestcases, |
060ac762 | 22 | is_download_test, |
257cfebf | 23 | report_warning, |
060ac762 | 24 | try_rm, |
dd508b7c | 25 | ) |
54007a45 | 26 | |
ac668111 | 27 | import yt_dlp.YoutubeDL # isort: split |
f8271158 | 28 | from yt_dlp.extractor import get_info_extractor |
227bf1a3 | 29 | from yt_dlp.networking.exceptions import HTTPError, TransportError |
7a5c1cfe | 30 | from yt_dlp.utils import ( |
44a5f171 PH |
31 | DownloadError, |
32 | ExtractorError, | |
33 | UnavailableVideoError, | |
661c9a1d | 34 | YoutubeDLError, |
f8271158 | 35 | format_bytes, |
f2e8dbcc | 36 | join_nonempty, |
44a5f171 | 37 | ) |
fd5ff020 | 38 | |
8cc83b8d FV |
39 | RETRIES = 3 |
40 | ||
5f6a1245 | 41 | |
7a5c1cfe | 42 | class YoutubeDL(yt_dlp.YoutubeDL): |
fd5ff020 | 43 | def __init__(self, *args, **kwargs): |
fd5ff020 | 44 | self.to_stderr = self.to_screen |
0eaf520d | 45 | self.processed_info_dicts = [] |
86e5f3ed | 46 | super().__init__(*args, **kwargs) |
5f6a1245 | 47 | |
f0500bd1 | 48 | def report_warning(self, message, *args, **kwargs): |
be95cac1 FV |
49 | # Don't accept warnings during tests |
50 | raise ExtractorError(message) | |
5f6a1245 | 51 | |
0eaf520d | 52 | def process_info(self, info_dict): |
f46e2f9d | 53 | self.processed_info_dicts.append(info_dict.copy()) |
86e5f3ed | 54 | return super().process_info(info_dict) |
1535ac2a | 55 | |
5f6a1245 | 56 | |
fd5ff020 FV |
57 | def _file_md5(fn): |
58 | with open(fn, 'rb') as f: | |
59 | return hashlib.md5(f.read()).hexdigest() | |
60 | ||
582be358 | 61 | |
f2e8dbcc | 62 | normal_test_cases = gettestcases() |
63 | webpage_test_cases = getwebpagetestcases() | |
64 | tests_counter = collections.defaultdict(collections.Counter) | |
6b47c7f2 | 65 | |
0eaf520d | 66 | |
060ac762 | 67 | @is_download_test |
1535ac2a | 68 | class TestDownload(unittest.TestCase): |
8936f68a YCH |
69 | # Parallel testing in nosetests. See |
70 | # http://nose.readthedocs.org/en/latest/doc_tests/test_multiprocess/multiprocess.html | |
71 | _multiprocess_shared_ = True | |
72 | ||
744435f2 | 73 | maxDiff = None |
5f6a1245 | 74 | |
243c57cf | 75 | COMPLETED_TESTS = {} |
76 | ||
c6c22e98 JH |
77 | def __str__(self): |
78 | """Identify each test with the `add_ie` attribute, if available.""" | |
f2e8dbcc | 79 | cls, add_ie = type(self), getattr(self, self._testMethodName).add_ie |
80 | return f'{self._testMethodName} ({cls.__module__}.{cls.__name__}){f" [{add_ie}]" if add_ie else ""}:' | |
c6c22e98 | 81 | |
fd5ff020 | 82 | |
5f6a1245 JW |
83 | # Dynamically generate tests |
84 | ||
8936f68a | 85 | def generator(test_case, tname): |
1535ac2a | 86 | def test_template(self): |
243c57cf | 87 | if self.COMPLETED_TESTS.get(tname): |
88 | return | |
89 | self.COMPLETED_TESTS[tname] = True | |
7a5c1cfe | 90 | ie = yt_dlp.extractor.get_info_extractor(test_case['name'])() |
655c4100 | 91 | other_ies = [get_info_extractor(ie_key)() for ie_key in test_case.get('add_ie', [])] |
e8ee972c PH |
92 | is_playlist = any(k.startswith('playlist') for k in test_case) |
93 | test_cases = test_case.get( | |
94 | 'playlist', [] if is_playlist else [test_case]) | |
95 | ||
bc2884af JMF |
96 | def print_skipping(reason): |
97 | print('Skipping %s: %s' % (test_case['name'], reason)) | |
6d1b3489 | 98 | self.skipTest(reason) |
99 | ||
9ee2b5f6 | 100 | if not ie.working(): |
bc2884af | 101 | print_skipping('IE marked as not _WORKING') |
e8ee972c PH |
102 | |
103 | for tc in test_cases: | |
661c9a1d | 104 | if tc.get('expected_exception'): |
105 | continue | |
e8ee972c | 106 | info_dict = tc.get('info_dict', {}) |
0855702f | 107 | params = tc.get('params', {}) |
108 | if not info_dict.get('id'): | |
d7118397 | 109 | raise Exception(f'Test {tname} definition incorrect - "id" key is not present') |
495322b9 | 110 | elif not info_dict.get('ext') and info_dict.get('_type', 'video') == 'video': |
0855702f | 111 | if params.get('skip_download') and params.get('ignore_no_formats_error'): |
112 | continue | |
d7118397 | 113 | raise Exception(f'Test {tname} definition incorrect - "ext" key must be present to define the output file') |
e8ee972c | 114 | |
fd5ff020 | 115 | if 'skip' in test_case: |
bc2884af | 116 | print_skipping(test_case['skip']) |
6d1b3489 | 117 | |
9ee2b5f6 JMF |
118 | for other_ie in other_ies: |
119 | if not other_ie.working(): | |
e075a44a | 120 | print_skipping('test depends on %sIE, marked as not WORKING' % other_ie.ie_key()) |
0eaf520d | 121 | |
44a5f171 | 122 | params = get_params(test_case.get('params', {})) |
8936f68a | 123 | params['outtmpl'] = tname + '_' + params['outtmpl'] |
e8ee972c | 124 | if is_playlist and 'playlist' not in test_case: |
65d49afa | 125 | params.setdefault('extract_flat', 'in_playlist') |
c9bd6518 AK |
126 | params.setdefault('playlistend', test_case.get( |
127 | 'playlist_mincount', test_case.get('playlist_count', -2) + 1)) | |
e8ee972c | 128 | params.setdefault('skip_download', True) |
0eaf520d | 129 | |
ac35c266 | 130 | ydl = YoutubeDL(params, auto_init=False) |
023fa8c4 | 131 | ydl.add_default_info_extractors() |
bffbd5f0 | 132 | finished_hook_called = set() |
5f6a1245 | 133 | |
bffbd5f0 PH |
134 | def _hook(status): |
135 | if status['status'] == 'finished': | |
136 | finished_hook_called.add(status['filename']) | |
933605d7 | 137 | ydl.add_progress_hook(_hook) |
70b7e3fb | 138 | expect_warnings(ydl, test_case.get('expected_warnings', [])) |
5c892b0b | 139 | |
702665c0 | 140 | def get_tc_filename(tc): |
ad3dc496 | 141 | return ydl.prepare_filename(dict(tc.get('info_dict', {}))) |
702665c0 | 142 | |
28570840 | 143 | res_dict = None |
5f6a1245 | 144 | |
661c9a1d | 145 | def match_exception(err): |
146 | expected_exception = test_case.get('expected_exception') | |
147 | if not expected_exception: | |
148 | return False | |
149 | if err.__class__.__name__ == expected_exception: | |
150 | return True | |
151 | for exc in err.exc_info: | |
152 | if exc.__class__.__name__ == expected_exception: | |
153 | return True | |
154 | return False | |
155 | ||
28570840 PH |
156 | def try_rm_tcs_files(tcs=None): |
157 | if tcs is None: | |
158 | tcs = test_cases | |
159 | for tc in tcs: | |
702665c0 JMF |
160 | tc_filename = get_tc_filename(tc) |
161 | try_rm(tc_filename) | |
162 | try_rm(tc_filename + '.part') | |
4eb92208 | 163 | try_rm(os.path.splitext(tc_filename)[0] + '.info.json') |
702665c0 | 164 | try_rm_tcs_files() |
5c892b0b | 165 | try: |
dd508b7c FV |
166 | try_num = 1 |
167 | while True: | |
8cc83b8d | 168 | try: |
3bef10a5 | 169 | # We're not using .download here since that is just a shim |
e8ee972c PH |
170 | # for outside error handling, and returns the exit code |
171 | # instead of the result dict. | |
308cfe0a S |
172 | res_dict = ydl.extract_info( |
173 | test_case['url'], | |
174 | force_generic_extractor=params.get('force_generic_extractor', False)) | |
8cc83b8d | 175 | except (DownloadError, ExtractorError) as err: |
8cc83b8d | 176 | # Check if the exception is not a network related one |
3d2623a8 | 177 | if not isinstance(err.exc_info[1], (TransportError, UnavailableVideoError)) or (isinstance(err.exc_info[1], HTTPError) and err.exc_info[1].status == 503): |
661c9a1d | 178 | if match_exception(err): |
179 | return | |
d7118397 | 180 | err.msg = f'{getattr(err, "msg", err)} ({tname})' |
8cc83b8d FV |
181 | raise |
182 | ||
dd508b7c | 183 | if try_num == RETRIES: |
8936f68a | 184 | report_warning('%s failed due to network errors, skipping...' % tname) |
dd508b7c FV |
185 | return |
186 | ||
86e5f3ed | 187 | print(f'Retrying: {try_num} failed tries\n\n##########\n\n') |
dd508b7c FV |
188 | |
189 | try_num += 1 | |
661c9a1d | 190 | except YoutubeDLError as err: |
191 | if match_exception(err): | |
192 | return | |
193 | raise | |
8cc83b8d FV |
194 | else: |
195 | break | |
5c892b0b | 196 | |
e8ee972c | 197 | if is_playlist: |
880ee801 | 198 | self.assertTrue(res_dict['_type'] in ['playlist', 'multi_video']) |
d6e6a422 | 199 | self.assertTrue('entries' in res_dict) |
f74b341d | 200 | expect_info_dict(self, res_dict, test_case.get('info_dict', {})) |
d6e6a422 | 201 | |
e8ee972c | 202 | if 'playlist_mincount' in test_case: |
0990305d PH |
203 | assertGreaterEqual( |
204 | self, | |
e8ee972c PH |
205 | len(res_dict['entries']), |
206 | test_case['playlist_mincount'], | |
207 | 'Expected at least %d in playlist %s, but got only %d' % ( | |
208 | test_case['playlist_mincount'], test_case['url'], | |
209 | len(res_dict['entries']))) | |
829476b8 PH |
210 | if 'playlist_count' in test_case: |
211 | self.assertEqual( | |
212 | len(res_dict['entries']), | |
213 | test_case['playlist_count'], | |
28570840 | 214 | 'Expected %d entries in playlist %s, but got %d.' % ( |
22a6f150 | 215 | test_case['playlist_count'], |
28570840 | 216 | test_case['url'], |
22a6f150 PH |
217 | len(res_dict['entries']), |
218 | )) | |
28570840 PH |
219 | if 'playlist_duration_sum' in test_case: |
220 | got_duration = sum(e['duration'] for e in res_dict['entries']) | |
221 | self.assertEqual( | |
222 | test_case['playlist_duration_sum'], got_duration) | |
e8ee972c | 223 | |
364a69e8 S |
224 | # Generalize both playlists and single videos to unified format for |
225 | # simplicity | |
226 | if 'entries' not in res_dict: | |
227 | res_dict['entries'] = [res_dict] | |
228 | ||
80b2fdf9 | 229 | for tc_num, tc in enumerate(test_cases): |
364a69e8 S |
230 | tc_res_dict = res_dict['entries'][tc_num] |
231 | # First, check test cases' data against extracted data alone | |
80b2fdf9 | 232 | expect_info_dict(self, tc_res_dict, tc.get('info_dict', {})) |
495322b9 | 233 | if tc_res_dict.get('_type', 'video') != 'video': |
234 | continue | |
364a69e8 | 235 | # Now, check downloaded file consistency |
702665c0 | 236 | tc_filename = get_tc_filename(tc) |
511eda8e | 237 | if not test_case.get('params', {}).get('skip_download', False): |
702665c0 JMF |
238 | self.assertTrue(os.path.exists(tc_filename), msg='Missing file ' + tc_filename) |
239 | self.assertTrue(tc_filename in finished_hook_called) | |
08a36c35 S |
240 | expected_minsize = tc.get('file_minsize', 10000) |
241 | if expected_minsize is not None: | |
242 | if params.get('test'): | |
243 | expected_minsize = max(expected_minsize, 10000) | |
244 | got_fsize = os.path.getsize(tc_filename) | |
245 | assertGreaterEqual( | |
246 | self, got_fsize, expected_minsize, | |
247 | 'Expected %s to be at least %s, but it\'s only %s ' % | |
248 | (tc_filename, format_bytes(expected_minsize), | |
249 | format_bytes(got_fsize))) | |
250 | if 'md5' in tc: | |
251 | md5_for_file = _file_md5(tc_filename) | |
374560f0 | 252 | self.assertEqual(tc['md5'], md5_for_file) |
364a69e8 S |
253 | # Finally, check test cases' data again but this time against |
254 | # extracted data from info JSON file written during processing | |
4eb92208 | 255 | info_json_fn = os.path.splitext(tc_filename)[0] + '.info.json' |
f744c0f3 PH |
256 | self.assertTrue( |
257 | os.path.exists(info_json_fn), | |
258 | 'Missing info file %s' % info_json_fn) | |
86e5f3ed | 259 | with open(info_json_fn, encoding='utf-8') as infof: |
5c892b0b | 260 | info_dict = json.load(infof) |
f74b341d | 261 | expect_info_dict(self, info_dict, tc.get('info_dict', {})) |
5c892b0b | 262 | finally: |
702665c0 | 263 | try_rm_tcs_files() |
d6e6a422 | 264 | if is_playlist and res_dict is not None and res_dict.get('entries'): |
28570840 PH |
265 | # Remove all other files that may have been extracted if the |
266 | # extractor returns full results even with extract_flat | |
267 | res_tcs = [{'info_dict': e} for e in res_dict['entries']] | |
268 | try_rm_tcs_files(res_tcs) | |
227bf1a3 | 269 | ydl.close() |
1535ac2a | 270 | return test_template |
fd5ff020 | 271 | |
582be358 | 272 | |
5f6a1245 | 273 | # And add them to TestDownload |
f2e8dbcc | 274 | def inject_tests(test_cases, label=''): |
275 | for test_case in test_cases: | |
276 | name = test_case['name'] | |
277 | tname = join_nonempty('test', name, label, tests_counter[name][label], delim='_') | |
278 | tests_counter[name][label] += 1 | |
cdab8aa3 | 279 | |
f2e8dbcc | 280 | test_method = generator(test_case, tname) |
281 | test_method.__name__ = tname | |
282 | test_method.add_ie = ','.join(test_case.get('add_ie', [])) | |
283 | setattr(TestDownload, test_method.__name__, test_method) | |
cdab8aa3 | 284 | |
243c57cf | 285 | |
f2e8dbcc | 286 | inject_tests(normal_test_cases) |
287 | ||
288 | # TODO: disable redirection to the IE to ensure we are actually testing the webpage extraction | |
289 | inject_tests(webpage_test_cases, 'webpage') | |
290 | ||
291 | ||
292 | def batch_generator(name): | |
243c57cf | 293 | def test_template(self): |
f2e8dbcc | 294 | for label, num_tests in tests_counter[name].items(): |
295 | for i in range(num_tests): | |
296 | test_name = join_nonempty('test', name, label, i, delim='_') | |
297 | try: | |
298 | getattr(self, test_name)() | |
299 | except unittest.SkipTest: | |
300 | print(f'Skipped {test_name}') | |
243c57cf | 301 | |
302 | return test_template | |
303 | ||
304 | ||
f2e8dbcc | 305 | for name in tests_counter: |
306 | test_method = batch_generator(name) | |
243c57cf | 307 | test_method.__name__ = f'test_{name}_all' |
308 | test_method.add_ie = '' | |
309 | setattr(TestDownload, test_method.__name__, test_method) | |
f2e8dbcc | 310 | del test_method |
243c57cf | 311 | |
312 | ||
cdab8aa3 PH |
313 | if __name__ == '__main__': |
314 | unittest.main() |