]>
Commit | Line | Data |
---|---|---|
fd5ff020 FV |
1 | #!/usr/bin/env python |
2 | ||
a0f59cdc PH |
3 | from __future__ import unicode_literals |
4 | ||
44a5f171 PH |
5 | # Allow direct execution |
6 | import os | |
7 | import sys | |
8 | import unittest | |
9 | sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__)))) | |
10 | ||
dd508b7c | 11 | from test.helper import ( |
0990305d | 12 | assertGreaterEqual, |
70b7e3fb | 13 | expect_warnings, |
dd508b7c | 14 | get_params, |
ff14fc49 | 15 | gettestcases, |
257cfebf | 16 | expect_info_dict, |
257cfebf PH |
17 | try_rm, |
18 | report_warning, | |
dd508b7c | 19 | ) |
44a5f171 PH |
20 | |
21 | ||
efe8902f | 22 | import hashlib |
fd5ff020 | 23 | import io |
7f60b5aa | 24 | import json |
6b3aef80 | 25 | import socket |
cdab8aa3 | 26 | |
8222d8de | 27 | import youtube_dl.YoutubeDL |
42f7d2f5 | 28 | from youtube_dl.compat import ( |
dcf3eec4 | 29 | compat_http_client, |
44a5f171 | 30 | compat_urllib_error, |
f6cc16f5 | 31 | compat_HTTPError, |
42f7d2f5 PH |
32 | ) |
33 | from youtube_dl.utils import ( | |
44a5f171 PH |
34 | DownloadError, |
35 | ExtractorError, | |
753727cd | 36 | format_bytes, |
44a5f171 PH |
37 | UnavailableVideoError, |
38 | ) | |
9ee2b5f6 | 39 | from youtube_dl.extractor import get_info_extractor |
fd5ff020 | 40 | |
8cc83b8d FV |
41 | RETRIES = 3 |
42 | ||
5f6a1245 | 43 | |
8222d8de | 44 | class YoutubeDL(youtube_dl.YoutubeDL): |
fd5ff020 | 45 | def __init__(self, *args, **kwargs): |
fd5ff020 | 46 | self.to_stderr = self.to_screen |
0eaf520d | 47 | self.processed_info_dicts = [] |
8222d8de | 48 | super(YoutubeDL, self).__init__(*args, **kwargs) |
5f6a1245 | 49 | |
476203d0 | 50 | def report_warning(self, message): |
be95cac1 FV |
51 | # Don't accept warnings during tests |
52 | raise ExtractorError(message) | |
5f6a1245 | 53 | |
0eaf520d FV |
54 | def process_info(self, info_dict): |
55 | self.processed_info_dicts.append(info_dict) | |
8222d8de | 56 | return super(YoutubeDL, self).process_info(info_dict) |
1535ac2a | 57 | |
5f6a1245 | 58 | |
fd5ff020 FV |
59 | def _file_md5(fn): |
60 | with open(fn, 'rb') as f: | |
61 | return hashlib.md5(f.read()).hexdigest() | |
62 | ||
ff14fc49 | 63 | defs = gettestcases() |
6b47c7f2 | 64 | |
0eaf520d | 65 | |
1535ac2a | 66 | class TestDownload(unittest.TestCase): |
744435f2 | 67 | maxDiff = None |
5f6a1245 | 68 | |
fd5ff020 | 69 | def setUp(self): |
fd5ff020 FV |
70 | self.defs = defs |
71 | ||
5f6a1245 JW |
72 | # Dynamically generate tests |
73 | ||
74 | ||
5d01a647 PH |
75 | def generator(test_case): |
76 | ||
1535ac2a | 77 | def test_template(self): |
d1cade5a | 78 | ie = youtube_dl.extractor.get_info_extractor(test_case['name']) |
9ee2b5f6 | 79 | other_ies = [get_info_extractor(ie_key) for ie_key in test_case.get('add_ie', [])] |
e8ee972c PH |
80 | is_playlist = any(k.startswith('playlist') for k in test_case) |
81 | test_cases = test_case.get( | |
82 | 'playlist', [] if is_playlist else [test_case]) | |
83 | ||
bc2884af JMF |
84 | def print_skipping(reason): |
85 | print('Skipping %s: %s' % (test_case['name'], reason)) | |
9ee2b5f6 | 86 | if not ie.working(): |
bc2884af | 87 | print_skipping('IE marked as not _WORKING') |
fd5ff020 | 88 | return |
e8ee972c PH |
89 | |
90 | for tc in test_cases: | |
91 | info_dict = tc.get('info_dict', {}) | |
4e980275 | 92 | if not (info_dict.get('id') and info_dict.get('ext')): |
2437fbca | 93 | raise Exception('Test definition incorrect. The output file cannot be known. Are both \'id\' and \'ext\' keys present?') |
e8ee972c | 94 | |
fd5ff020 | 95 | if 'skip' in test_case: |
bc2884af | 96 | print_skipping(test_case['skip']) |
fd5ff020 | 97 | return |
9ee2b5f6 JMF |
98 | for other_ie in other_ies: |
99 | if not other_ie.working(): | |
e075a44a | 100 | print_skipping('test depends on %sIE, marked as not WORKING' % other_ie.ie_key()) |
9ee2b5f6 | 101 | return |
0eaf520d | 102 | |
44a5f171 | 103 | params = get_params(test_case.get('params', {})) |
e8ee972c | 104 | if is_playlist and 'playlist' not in test_case: |
65d49afa | 105 | params.setdefault('extract_flat', 'in_playlist') |
e8ee972c | 106 | params.setdefault('skip_download', True) |
0eaf520d | 107 | |
ac35c266 | 108 | ydl = YoutubeDL(params, auto_init=False) |
023fa8c4 | 109 | ydl.add_default_info_extractors() |
bffbd5f0 | 110 | finished_hook_called = set() |
5f6a1245 | 111 | |
bffbd5f0 PH |
112 | def _hook(status): |
113 | if status['status'] == 'finished': | |
114 | finished_hook_called.add(status['filename']) | |
933605d7 | 115 | ydl.add_progress_hook(_hook) |
70b7e3fb | 116 | expect_warnings(ydl, test_case.get('expected_warnings', [])) |
5c892b0b | 117 | |
702665c0 | 118 | def get_tc_filename(tc): |
4e980275 | 119 | return ydl.prepare_filename(tc.get('info_dict', {})) |
702665c0 | 120 | |
28570840 | 121 | res_dict = None |
5f6a1245 | 122 | |
28570840 PH |
123 | def try_rm_tcs_files(tcs=None): |
124 | if tcs is None: | |
125 | tcs = test_cases | |
126 | for tc in tcs: | |
702665c0 JMF |
127 | tc_filename = get_tc_filename(tc) |
128 | try_rm(tc_filename) | |
129 | try_rm(tc_filename + '.part') | |
4eb92208 | 130 | try_rm(os.path.splitext(tc_filename)[0] + '.info.json') |
702665c0 | 131 | try_rm_tcs_files() |
5c892b0b | 132 | try: |
dd508b7c FV |
133 | try_num = 1 |
134 | while True: | |
8cc83b8d | 135 | try: |
e8ee972c PH |
136 | # We're not using .download here sine that is just a shim |
137 | # for outside error handling, and returns the exit code | |
138 | # instead of the result dict. | |
308cfe0a S |
139 | res_dict = ydl.extract_info( |
140 | test_case['url'], | |
141 | force_generic_extractor=params.get('force_generic_extractor', False)) | |
8cc83b8d | 142 | except (DownloadError, ExtractorError) as err: |
8cc83b8d | 143 | # Check if the exception is not a network related one |
dcf3eec4 | 144 | 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 |
145 | raise |
146 | ||
dd508b7c | 147 | if try_num == RETRIES: |
e075a44a | 148 | report_warning('Failed due to network errors, skipping...') |
dd508b7c FV |
149 | return |
150 | ||
151 | print('Retrying: {0} failed tries\n\n##########\n\n'.format(try_num)) | |
152 | ||
153 | try_num += 1 | |
8cc83b8d FV |
154 | else: |
155 | break | |
5c892b0b | 156 | |
e8ee972c | 157 | if is_playlist: |
880ee801 | 158 | self.assertTrue(res_dict['_type'] in ['playlist', 'multi_video']) |
d6e6a422 | 159 | self.assertTrue('entries' in res_dict) |
f74b341d | 160 | expect_info_dict(self, res_dict, test_case.get('info_dict', {})) |
d6e6a422 | 161 | |
e8ee972c | 162 | if 'playlist_mincount' in test_case: |
0990305d PH |
163 | assertGreaterEqual( |
164 | self, | |
e8ee972c PH |
165 | len(res_dict['entries']), |
166 | test_case['playlist_mincount'], | |
167 | 'Expected at least %d in playlist %s, but got only %d' % ( | |
168 | test_case['playlist_mincount'], test_case['url'], | |
169 | len(res_dict['entries']))) | |
829476b8 PH |
170 | if 'playlist_count' in test_case: |
171 | self.assertEqual( | |
172 | len(res_dict['entries']), | |
173 | test_case['playlist_count'], | |
28570840 | 174 | 'Expected %d entries in playlist %s, but got %d.' % ( |
22a6f150 | 175 | test_case['playlist_count'], |
28570840 | 176 | test_case['url'], |
22a6f150 PH |
177 | len(res_dict['entries']), |
178 | )) | |
28570840 PH |
179 | if 'playlist_duration_sum' in test_case: |
180 | got_duration = sum(e['duration'] for e in res_dict['entries']) | |
181 | self.assertEqual( | |
182 | test_case['playlist_duration_sum'], got_duration) | |
e8ee972c | 183 | |
5c892b0b | 184 | for tc in test_cases: |
702665c0 | 185 | tc_filename = get_tc_filename(tc) |
511eda8e | 186 | if not test_case.get('params', {}).get('skip_download', False): |
702665c0 JMF |
187 | self.assertTrue(os.path.exists(tc_filename), msg='Missing file ' + tc_filename) |
188 | self.assertTrue(tc_filename in finished_hook_called) | |
08a36c35 S |
189 | expected_minsize = tc.get('file_minsize', 10000) |
190 | if expected_minsize is not None: | |
191 | if params.get('test'): | |
192 | expected_minsize = max(expected_minsize, 10000) | |
193 | got_fsize = os.path.getsize(tc_filename) | |
194 | assertGreaterEqual( | |
195 | self, got_fsize, expected_minsize, | |
196 | 'Expected %s to be at least %s, but it\'s only %s ' % | |
197 | (tc_filename, format_bytes(expected_minsize), | |
198 | format_bytes(got_fsize))) | |
199 | if 'md5' in tc: | |
200 | md5_for_file = _file_md5(tc_filename) | |
201 | self.assertEqual(md5_for_file, tc['md5']) | |
4eb92208 | 202 | info_json_fn = os.path.splitext(tc_filename)[0] + '.info.json' |
f744c0f3 PH |
203 | self.assertTrue( |
204 | os.path.exists(info_json_fn), | |
205 | 'Missing info file %s' % info_json_fn) | |
4eb92208 | 206 | with io.open(info_json_fn, encoding='utf-8') as infof: |
5c892b0b | 207 | info_dict = json.load(infof) |
257cfebf | 208 | |
f74b341d | 209 | expect_info_dict(self, info_dict, tc.get('info_dict', {})) |
5c892b0b | 210 | finally: |
702665c0 | 211 | try_rm_tcs_files() |
d6e6a422 | 212 | if is_playlist and res_dict is not None and res_dict.get('entries'): |
28570840 PH |
213 | # Remove all other files that may have been extracted if the |
214 | # extractor returns full results even with extract_flat | |
215 | res_tcs = [{'info_dict': e} for e in res_dict['entries']] | |
216 | try_rm_tcs_files(res_tcs) | |
fd5ff020 | 217 | |
1535ac2a | 218 | return test_template |
fd5ff020 | 219 | |
5f6a1245 | 220 | # And add them to TestDownload |
f7ab6cbe | 221 | for n, test_case in enumerate(defs): |
5d01a647 | 222 | test_method = generator(test_case) |
2eb88d95 PH |
223 | tname = 'test_' + str(test_case['name']) |
224 | i = 1 | |
225 | while hasattr(TestDownload, tname): | |
a0f59cdc | 226 | tname = 'test_%s_%d' % (test_case['name'], i) |
2eb88d95 | 227 | i += 1 |
a0f59cdc | 228 | test_method.__name__ = str(tname) |
fd5ff020 | 229 | setattr(TestDownload, test_method.__name__, test_method) |
5d01a647 | 230 | del test_method |
cdab8aa3 PH |
231 | |
232 | ||
233 | if __name__ == '__main__': | |
234 | unittest.main() |