]>
jfr.im git - yt-dlp.git/blob - test/helper.py
6612970ef211cec2e73528f328fac6fbf480ecee
1 from __future__
import unicode_literals
12 import youtube_dl
.extractor
13 from youtube_dl
import YoutubeDL
14 from youtube_dl
.utils
import (
21 def get_params(override
=None):
22 PARAMETERS_FILE
= os
.path
.join(os
.path
.dirname(os
.path
.abspath(__file__
)),
24 with io
.open(PARAMETERS_FILE
, encoding
='utf-8') as pf
:
25 parameters
= json
.load(pf
)
27 parameters
.update(override
)
32 """ Remove a file if it exists """
35 except OSError as ose
:
36 if ose
.errno
!= errno
.ENOENT
:
40 def report_warning(message
):
42 Print the message to stderr, it will be prefixed with 'WARNING:'
43 If stderr is a tty file the 'WARNING:' will be colored
45 if sys
.stderr
.isatty() and os
.name
!= 'nt':
46 _msg_header
= '\033[0;33mWARNING:\033[0m'
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
)
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)
63 def to_screen(self
, s
, skip_eol
=None):
66 def trouble(self
, s
, tb
=None):
69 def download(self
, x
):
72 def expect_warning(self
, regex
):
73 # Silence an expected warning matching a regex
74 old_report_warning
= self
.report_warning
76 def report_warning(self
, message
):
77 if re
.match(regex
, message
):
79 old_report_warning(message
)
80 self
.report_warning
= types
.MethodType(report_warning
, self
)
83 def gettestcases(include_onlymatching
=False):
84 for ie
in youtube_dl
.extractor
.gen_extractors():
85 for tc
in ie
.get_testcases(include_onlymatching
):
89 md5
= lambda s
: hashlib
.md5(s
.encode('utf-8')).hexdigest()
92 def expect_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
)
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
))
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:'):]
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
))
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:'):]
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
))
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 elif isinstance(expected
, dict) and isinstance(got_dict
.get(info_field
, None), dict):
131 expect_dict(self
, got_dict
.get(info_field
), expected
)
132 elif isinstance(expected
, list) and isinstance(got_dict
.get(info_field
, None), list):
133 got
= got_dict
.get(info_field
, None)
134 self
.assertEqual(len(expected
), len(got
),
135 'Expect a list of length %d, but got a list of length %d' % (
136 len(expected
), len(got
)))
138 for i
, j
in zip(got
, expected
):
141 self
.assertEqual(_type_j
, _type_i
,
142 'Type doesn\'t match at element %d of the list in field %s, expect %s, got %s' % (
143 _id
, info_field
, _type_j
, _type_i
))
144 expect_dict(self
, {'_': i}
, {'_': j}
)
147 if isinstance(expected
, compat_str
) and expected
.startswith('md5:'):
148 got
= 'md5:' + md5(got_dict
.get(info_field
))
149 elif isinstance(expected
, compat_str
) and expected
.startswith('mincount:'):
150 got
= got_dict
.get(info_field
)
152 isinstance(got
, (list, dict)),
153 'Expected field %s to be a list or a dict, but it is of type %s' % (
154 info_field
, type(got
).__name
__))
155 expected_num
= int(expected
.partition(':')[2])
157 self
, len(got
), expected_num
,
158 'Expected %d items in field %s, but only got %d' % (
159 expected_num
, info_field
, len(got
)
164 got
= got_dict
.get(info_field
)
165 self
.assertEqual(expected
, got
,
166 'invalid value for field %s, expected %r, got %r' % (info_field
, expected
, got
))
169 def expect_info_dict(self
, got_dict
, expected_dict
):
170 expect_dict(self
, got_dict
, expected_dict
)
171 # Check for the presence of mandatory fields
172 if got_dict
.get('_type') not in ('playlist', 'multi_video'):
173 for key
in ('id', 'url', 'title', 'ext'):
174 self
.assertTrue(got_dict
.get(key
), 'Missing mandatory field %s' % key
)
175 # Check for mandatory fields that are automatically set by YoutubeDL
176 for key
in ['webpage_url', 'extractor', 'extractor_key']:
177 self
.assertTrue(got_dict
.get(key
), 'Missing field: %s' % key
)
179 # Are checkable fields missing from the test case definition?
180 test_info_dict
= dict((key
, value
if not isinstance(value
, compat_str
) or len(value
) < 250 else 'md5:' + md5(value
))
181 for key
, value
in got_dict
.items()
182 if value
and key
in ('id', 'title', 'description', 'uploader', 'upload_date', 'timestamp', 'uploader_id', 'location', 'age_limit'))
183 missing_keys
= set(test_info_dict
.keys()) - set(expected_dict
.keys())
186 if isinstance(v
, compat_str
):
187 return "'%s'" % v
.replace('\\', '\\\\').replace("'", "\\'").replace('\n', '\\n')
191 if len(missing_keys
) != len(expected_dict
):
192 info_dict_str
+= ''.join(
193 ' %s: %s,\n' % (_repr(k
), _repr(v
))
194 for k
, v
in test_info_dict
.items() if k
not in missing_keys
)
197 info_dict_str
+= '\n'
198 info_dict_str
+= ''.join(
199 ' %s: %s,\n' % (_repr(k
), _repr(test_info_dict
[k
]))
200 for k
in missing_keys
)
202 '\n\'info_dict\': {\n' + info_dict_str + '},\n', out
=sys
.stderr
)
205 'Missing keys in test definition: %s' % (
206 ', '.join(sorted(missing_keys
))))
209 def assertRegexpMatches(self
, text
, regexp
, msg
=None):
210 if hasattr(self
, 'assertRegexp'):
211 return self
.assertRegexp(text
, regexp
, msg
)
213 m
= re
.match(regexp
, text
)
215 note
= 'Regexp didn\'t match: %r not found' % (regexp
)
217 note
+= ' in %r' % text
221 msg
= note
+ ', ' + msg
222 self
.assertTrue(m
, msg
)
225 def assertGreaterEqual(self
, got
, expected
, msg
=None):
226 if not (got
>= expected
):
228 msg
= '%r not greater than or equal to %r' % (got
, expected
)
229 self
.assertTrue(got
>= expected
, msg
)
232 def expect_warnings(ydl
, warnings_re
):
233 real_warning
= ydl
.report_warning
235 def _report_warning(w
):
236 if not any(re
.search(w_re
, w
) for w_re
in warnings_re
):
239 ydl
.report_warning
= _report_warning