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