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