]>
Commit | Line | Data |
---|---|---|
7a08ad7d PH |
1 | from __future__ import unicode_literals |
2 | ||
f4aac741 | 3 | import errno |
112da0a0 | 4 | import io |
44a5f171 | 5 | import hashlib |
112da0a0 PH |
6 | import json |
7 | import os.path | |
00fcc17a FV |
8 | import re |
9 | import types | |
dd508b7c | 10 | import sys |
112da0a0 | 11 | |
fc2c063e | 12 | import youtube_dl.extractor |
44a5f171 | 13 | from youtube_dl import YoutubeDL |
e9c0cdd3 YCH |
14 | from youtube_dl.compat import ( |
15 | compat_os_name, | |
257cfebf | 16 | compat_str, |
e9c0cdd3 YCH |
17 | ) |
18 | from youtube_dl.utils import ( | |
257cfebf | 19 | preferredencoding, |
c0f64ac6 | 20 | write_string, |
257cfebf | 21 | ) |
112da0a0 | 22 | |
112da0a0 | 23 | |
44a5f171 PH |
24 | def get_params(override=None): |
25 | PARAMETERS_FILE = os.path.join(os.path.dirname(os.path.abspath(__file__)), | |
26 | "parameters.json") | |
27 | with io.open(PARAMETERS_FILE, encoding='utf-8') as pf: | |
28 | parameters = json.load(pf) | |
29 | if override: | |
30 | parameters.update(override) | |
31 | return parameters | |
112da0a0 | 32 | |
f4aac741 PH |
33 | |
34 | def try_rm(filename): | |
35 | """ Remove a file if it exists """ | |
36 | try: | |
37 | os.remove(filename) | |
38 | except OSError as ose: | |
39 | if ose.errno != errno.ENOENT: | |
40 | raise | |
41 | ||
42 | ||
dd508b7c FV |
43 | def report_warning(message): |
44 | ''' | |
45 | Print the message to stderr, it will be prefixed with 'WARNING:' | |
46 | If stderr is a tty file the 'WARNING:' will be colored | |
47 | ''' | |
e9c0cdd3 | 48 | if sys.stderr.isatty() and compat_os_name != 'nt': |
7a08ad7d | 49 | _msg_header = '\033[0;33mWARNING:\033[0m' |
dd508b7c | 50 | else: |
7a08ad7d PH |
51 | _msg_header = 'WARNING:' |
52 | output = '%s %s\n' % (_msg_header, message) | |
dd508b7c FV |
53 | if 'b' in getattr(sys.stderr, 'mode', '') or sys.version_info[0] < 3: |
54 | output = output.encode(preferredencoding()) | |
55 | sys.stderr.write(output) | |
56 | ||
57 | ||
112da0a0 | 58 | class FakeYDL(YoutubeDL): |
f4d96df0 | 59 | def __init__(self, override=None): |
112da0a0 PH |
60 | # Different instances of the downloader can't share the same dictionary |
61 | # some test set the "sublang" parameter, which would break the md5 checks. | |
f4d96df0 | 62 | params = get_params(override=override) |
ac35c266 | 63 | super(FakeYDL, self).__init__(params, auto_init=False) |
f4aac741 | 64 | self.result = [] |
5f6a1245 | 65 | |
f4aac741 | 66 | def to_screen(self, s, skip_eol=None): |
112da0a0 | 67 | print(s) |
f4aac741 | 68 | |
112da0a0 PH |
69 | def trouble(self, s, tb=None): |
70 | raise Exception(s) | |
f4aac741 | 71 | |
112da0a0 | 72 | def download(self, x): |
fc2c063e | 73 | self.result.append(x) |
f4aac741 | 74 | |
00fcc17a FV |
75 | def expect_warning(self, regex): |
76 | # Silence an expected warning matching a regex | |
77 | old_report_warning = self.report_warning | |
5f6a1245 | 78 | |
00fcc17a | 79 | def report_warning(self, message): |
5f6a1245 JW |
80 | if re.match(regex, message): |
81 | return | |
00fcc17a FV |
82 | old_report_warning(message) |
83 | self.report_warning = types.MethodType(report_warning, self) | |
fc2c063e | 84 | |
52fadd5f PH |
85 | |
86 | def gettestcases(include_onlymatching=False): | |
fc2c063e | 87 | for ie in youtube_dl.extractor.gen_extractors(): |
05900629 PH |
88 | for tc in ie.get_testcases(include_onlymatching): |
89 | yield tc | |
44a5f171 PH |
90 | |
91 | ||
92 | md5 = lambda s: hashlib.md5(s.encode('utf-8')).hexdigest() | |
257cfebf PH |
93 | |
94 | ||
40c931de QF |
95 | def expect_value(self, got, expected, field): |
96 | if isinstance(expected, compat_str) and expected.startswith('re:'): | |
97 | match_str = expected[len('re:'):] | |
98 | match_rex = re.compile(match_str) | |
99 | ||
100 | self.assertTrue( | |
101 | isinstance(got, compat_str), | |
102 | 'Expected a %s object, but got %s for field %s' % ( | |
103 | compat_str.__name__, type(got).__name__, field)) | |
104 | self.assertTrue( | |
105 | match_rex.match(got), | |
106 | 'field %s (value: %r) should match %r' % (field, got, match_str)) | |
107 | elif isinstance(expected, compat_str) and expected.startswith('startswith:'): | |
108 | start_str = expected[len('startswith:'):] | |
109 | self.assertTrue( | |
110 | isinstance(got, compat_str), | |
111 | 'Expected a %s object, but got %s for field %s' % ( | |
112 | compat_str.__name__, type(got).__name__, field)) | |
113 | self.assertTrue( | |
114 | got.startswith(start_str), | |
115 | 'field %s (value: %r) should start with %r' % (field, got, start_str)) | |
116 | elif isinstance(expected, compat_str) and expected.startswith('contains:'): | |
117 | contains_str = expected[len('contains:'):] | |
118 | self.assertTrue( | |
119 | isinstance(got, compat_str), | |
120 | 'Expected a %s object, but got %s for field %s' % ( | |
121 | compat_str.__name__, type(got).__name__, field)) | |
122 | self.assertTrue( | |
123 | contains_str in got, | |
124 | 'field %s (value: %r) should contain %r' % (field, got, contains_str)) | |
125 | elif isinstance(expected, type): | |
2e885de7 S |
126 | self.assertTrue( |
127 | isinstance(got, expected), | |
128 | 'Expected type %r for field %s, but got value %r of type %r' % (expected, field, got, type(got))) | |
40c931de QF |
129 | elif isinstance(expected, dict) and isinstance(got, dict): |
130 | expect_dict(self, got, expected) | |
131 | elif isinstance(expected, list) and isinstance(got, list): | |
2e885de7 S |
132 | self.assertEqual( |
133 | len(expected), len(got), | |
f88f1b40 S |
134 | 'Expect a list of length %d, but got a list of length %d for field %s' % ( |
135 | len(expected), len(got), field)) | |
687c04cb QF |
136 | for index, (item_got, item_expected) in enumerate(zip(got, expected)): |
137 | type_got = type(item_got) | |
138 | type_expected = type(item_expected) | |
2e885de7 S |
139 | self.assertEqual( |
140 | type_expected, type_got, | |
386a7b52 | 141 | 'Type mismatch for list item at index %d for field %s, expected %r, got %r' % ( |
7d0ada5f | 142 | index, field, type_expected, type_got)) |
687c04cb | 143 | expect_value(self, item_got, item_expected, field) |
40c931de QF |
144 | else: |
145 | if isinstance(expected, compat_str) and expected.startswith('md5:'): | |
6c4c7539 YCH |
146 | self.assertTrue( |
147 | isinstance(got, compat_str), | |
148 | 'Expected field %s to be a unicode object, but got value %r of type %r' % (field, got, type(got))) | |
40c931de QF |
149 | got = 'md5:' + md5(got) |
150 | elif isinstance(expected, compat_str) and expected.startswith('mincount:'): | |
9789d753 | 151 | self.assertTrue( |
40c931de QF |
152 | isinstance(got, (list, dict)), |
153 | 'Expected field %s to be a list or a dict, but it is of type %s' % ( | |
154 | field, type(got).__name__)) | |
155 | expected_num = int(expected.partition(':')[2]) | |
156 | assertGreaterEqual( | |
157 | self, len(got), expected_num, | |
2e885de7 | 158 | 'Expected %d items in field %s, but only got %d' % (expected_num, field, len(got))) |
40c931de | 159 | return |
2e885de7 S |
160 | self.assertEqual( |
161 | expected, got, | |
386a7b52 | 162 | 'Invalid value for field %s, expected %r, got %r' % (field, expected, got)) |
40c931de QF |
163 | |
164 | ||
165 | def expect_dict(self, got_dict, expected_dict): | |
166 | for info_field, expected in expected_dict.items(): | |
167 | got = got_dict.get(info_field) | |
168 | expect_value(self, got, expected, info_field) | |
257cfebf | 169 | |
93bc7ef1 QF |
170 | |
171 | def expect_info_dict(self, got_dict, expected_dict): | |
172 | expect_dict(self, got_dict, expected_dict) | |
ea38e55f | 173 | # Check for the presence of mandatory fields |
880ee801 | 174 | if got_dict.get('_type') not in ('playlist', 'multi_video'): |
e8ee972c PH |
175 | for key in ('id', 'url', 'title', 'ext'): |
176 | self.assertTrue(got_dict.get(key), 'Missing mandatory field %s' % key) | |
ea38e55f PH |
177 | # Check for mandatory fields that are automatically set by YoutubeDL |
178 | for key in ['webpage_url', 'extractor', 'extractor_key']: | |
7a08ad7d | 179 | self.assertTrue(got_dict.get(key), 'Missing field: %s' % key) |
ea38e55f PH |
180 | |
181 | # Are checkable fields missing from the test case definition? | |
182 | test_info_dict = dict((key, value if not isinstance(value, compat_str) or len(value) < 250 else 'md5:' + md5(value)) | |
9e1a5b84 | 183 | for key, value in got_dict.items() |
8e2b1be1 | 184 | if value and key in ('id', 'title', 'description', 'uploader', 'upload_date', 'timestamp', 'uploader_id', 'location', 'age_limit')) |
ea38e55f PH |
185 | missing_keys = set(test_info_dict.keys()) - set(expected_dict.keys()) |
186 | if missing_keys: | |
c0f64ac6 PH |
187 | def _repr(v): |
188 | if isinstance(v, compat_str): | |
155f9550 | 189 | return "'%s'" % v.replace('\\', '\\\\').replace("'", "\\'").replace('\n', '\\n') |
c0f64ac6 PH |
190 | else: |
191 | return repr(v) | |
dc35bfd2 PH |
192 | info_dict_str = '' |
193 | if len(missing_keys) != len(expected_dict): | |
194 | info_dict_str += ''.join( | |
195 | ' %s: %s,\n' % (_repr(k), _repr(v)) | |
196 | for k, v in test_info_dict.items() if k not in missing_keys) | |
6f53c63d PH |
197 | |
198 | if info_dict_str: | |
199 | info_dict_str += '\n' | |
dc35bfd2 PH |
200 | info_dict_str += ''.join( |
201 | ' %s: %s,\n' % (_repr(k), _repr(test_info_dict[k])) | |
202 | for k in missing_keys) | |
3e6e4999 | 203 | write_string( |
f21e915f | 204 | '\n\'info_dict\': {\n' + info_dict_str + '},\n', out=sys.stderr) |
ea38e55f PH |
205 | self.assertFalse( |
206 | missing_keys, | |
207 | 'Missing keys in test definition: %s' % ( | |
208 | ', '.join(sorted(missing_keys)))) | |
c57f7757 PH |
209 | |
210 | ||
211 | def assertRegexpMatches(self, text, regexp, msg=None): | |
0fd7fd71 PH |
212 | if hasattr(self, 'assertRegexp'): |
213 | return self.assertRegexp(text, regexp, msg) | |
c57f7757 PH |
214 | else: |
215 | m = re.match(regexp, text) | |
216 | if not m: | |
8bdcb436 PH |
217 | note = 'Regexp didn\'t match: %r not found' % (regexp) |
218 | if len(text) < 1000: | |
219 | note += ' in %r' % text | |
c57f7757 PH |
220 | if msg is None: |
221 | msg = note | |
222 | else: | |
223 | msg = note + ', ' + msg | |
224 | self.assertTrue(m, msg) | |
d8624e6a PH |
225 | |
226 | ||
227 | def assertGreaterEqual(self, got, expected, msg=None): | |
228 | if not (got >= expected): | |
229 | if msg is None: | |
230 | msg = '%r not greater than or equal to %r' % (got, expected) | |
231 | self.assertTrue(got >= expected, msg) | |
70b7e3fb PH |
232 | |
233 | ||
234 | def expect_warnings(ydl, warnings_re): | |
235 | real_warning = ydl.report_warning | |
236 | ||
237 | def _report_warning(w): | |
238 | if not any(re.search(w_re, w) for w_re in warnings_re): | |
239 | real_warning(w) | |
240 | ||
241 | ydl.report_warning = _report_warning |