]> Raphaƫl G. Git Repositories - youtubedl/blob - test/helper.py
8be37a183abcedc80945d5bb663ed000dc33f738
[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 def report_warning(self, message):
76 if re.match(regex, message): return
77 old_report_warning(message)
78 self.report_warning = types.MethodType(report_warning, self)
79
80
81 def gettestcases(include_onlymatching=False):
82 for ie in youtube_dl.extractor.gen_extractors():
83 t = getattr(ie, '_TEST', None)
84 if t:
85 assert not hasattr(ie, '_TESTS'), \
86 '%s has _TEST and _TESTS' % type(ie).__name__
87 tests = [t]
88 else:
89 tests = getattr(ie, '_TESTS', [])
90 for t in tests:
91 if not include_onlymatching and t.get('only_matching', False):
92 continue
93 t['name'] = type(ie).__name__[:-len('IE')]
94 yield t
95
96
97 md5 = lambda s: hashlib.md5(s.encode('utf-8')).hexdigest()
98
99
100 def expect_info_dict(self, expected_dict, got_dict):
101 for info_field, expected in expected_dict.items():
102 if isinstance(expected, compat_str) and expected.startswith('re:'):
103 got = got_dict.get(info_field)
104 match_str = expected[len('re:'):]
105 match_rex = re.compile(match_str)
106
107 self.assertTrue(
108 isinstance(got, compat_str),
109 'Expected a %s object, but got %s for field %s' % (
110 compat_str.__name__, type(got).__name__, info_field))
111 self.assertTrue(
112 match_rex.match(got),
113 'field %s (value: %r) should match %r' % (info_field, got, match_str))
114 elif isinstance(expected, type):
115 got = got_dict.get(info_field)
116 self.assertTrue(isinstance(got, expected),
117 'Expected type %r for field %s, but got value %r of type %r' % (expected, info_field, got, type(got)))
118 else:
119 if isinstance(expected, compat_str) and expected.startswith('md5:'):
120 got = 'md5:' + md5(got_dict.get(info_field))
121 else:
122 got = got_dict.get(info_field)
123 self.assertEqual(expected, got,
124 'invalid value for field %s, expected %r, got %r' % (info_field, expected, got))
125
126 # Check for the presence of mandatory fields
127 if got_dict.get('_type') != 'playlist':
128 for key in ('id', 'url', 'title', 'ext'):
129 self.assertTrue(got_dict.get(key), 'Missing mandatory field %s' % key)
130 # Check for mandatory fields that are automatically set by YoutubeDL
131 for key in ['webpage_url', 'extractor', 'extractor_key']:
132 self.assertTrue(got_dict.get(key), 'Missing field: %s' % key)
133
134 # Are checkable fields missing from the test case definition?
135 test_info_dict = dict((key, value if not isinstance(value, compat_str) or len(value) < 250 else 'md5:' + md5(value))
136 for key, value in got_dict.items()
137 if value and key in ('title', 'description', 'uploader', 'upload_date', 'timestamp', 'uploader_id', 'location'))
138 missing_keys = set(test_info_dict.keys()) - set(expected_dict.keys())
139 if missing_keys:
140 def _repr(v):
141 if isinstance(v, compat_str):
142 return "'%s'" % v.replace('\\', '\\\\').replace("'", "\\'")
143 else:
144 return repr(v)
145 info_dict_str = ''.join(
146 ' %s: %s,\n' % (_repr(k), _repr(v))
147 for k, v in test_info_dict.items())
148 write_string(
149 '\n\'info_dict\': {\n' + info_dict_str + '}\n', out=sys.stderr)
150 self.assertFalse(
151 missing_keys,
152 'Missing keys in test definition: %s' % (
153 ', '.join(sorted(missing_keys))))
154
155
156 def assertRegexpMatches(self, text, regexp, msg=None):
157 if hasattr(self, 'assertRegexp'):
158 return self.assertRegexp(text, regexp, msg)
159 else:
160 m = re.match(regexp, text)
161 if not m:
162 note = 'Regexp didn\'t match: %r not found in %r' % (regexp, text)
163 if msg is None:
164 msg = note
165 else:
166 msg = note + ', ' + msg
167 self.assertTrue(m, msg)
168
169
170 def assertGreaterEqual(self, got, expected, msg=None):
171 if not (got >= expected):
172 if msg is None:
173 msg = '%r not greater than or equal to %r' % (got, expected)
174 self.assertTrue(got >= expected, msg)
175
176
177 def expect_warnings(ydl, warnings_re):
178 real_warning = ydl.report_warning
179
180 def _report_warning(w):
181 if not any(re.search(w_re, w) for w_re in warnings_re):
182 real_warning(w)
183
184 ydl.report_warning = _report_warning