]>
jfr.im git - yt-dlp.git/blob - test/helper.py
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
)
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
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
)
81 def gettestcases(include_onlymatching
=False):
82 for ie
in youtube_dl
.extractor
.gen_extractors():
83 t
= getattr(ie
, '_TEST', None)
85 assert not hasattr(ie
, '_TESTS'), \
86 '%s has _TEST and _TESTS' % type(ie
).__name
__
89 tests
= getattr(ie
, '_TESTS', [])
91 if not include_onlymatching
and t
.get('only_matching', False):
93 t
['name'] = type(ie
).__name
__[:-len('IE')]
97 md5
= lambda s
: hashlib
.md5(s
.encode('utf-8')).hexdigest()
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
)
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
))
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
)))
119 if isinstance(expected
, compat_str
) and expected
.startswith('md5:'):
120 got
= 'md5:' + md5(got_dict
.get(info_field
))
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
))
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
)
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())
141 if isinstance(v
, compat_str
):
142 return "'%s'" % v
.replace('\\', '\\\\').replace("'", "\\'")
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('\n"info_dict": {\n' + info_dict_str + '}\n', out
=sys
.stderr
)
151 'Missing keys in test definition: %s' % (
152 ', '.join(sorted(missing_keys
))))
155 def assertRegexpMatches(self
, text
, regexp
, msg
=None):
156 if hasattr(self
, 'assertRegexp'):
157 return self
.assertRegexp(text
, regexp
, msg
)
159 m
= re
.match(regexp
, text
)
161 note
= 'Regexp didn\'t match: %r not found in %r' % (regexp
, text
)
165 msg
= note
+ ', ' + msg
166 self
.assertTrue(m
, msg
)
169 def assertGreaterEqual(self
, got
, expected
, msg
=None):
170 if not (got
>= expected
):
172 msg
= '%r not greater than or equal to %r' % (got
, expected
)
173 self
.assertTrue(got
>= expected
, msg
)