10 import youtube_dl.extractor
11 from youtube_dl import YoutubeDL
12 from youtube_dl.utils import (
18 def get_params(override=None):
19 PARAMETERS_FILE = os.path.join(os.path.dirname(os.path.abspath(__file__)),
21 with io.open(PARAMETERS_FILE, encoding='utf-8') as pf:
22 parameters = json.load(pf)
24 parameters.update(override)
29 """ Remove a file if it exists """
32 except OSError as ose:
33 if ose.errno != errno.ENOENT:
37 def report_warning(message):
39 Print the message to stderr, it will be prefixed with 'WARNING:'
40 If stderr is a tty file the 'WARNING:' will be colored
42 if sys.stderr.isatty() and os.name != 'nt':
43 _msg_header = u'\033[0;33mWARNING:\033[0m'
45 _msg_header = u'WARNING:'
46 output = u'%s %s\n' % (_msg_header, message)
47 if 'b' in getattr(sys.stderr, 'mode', '') or sys.version_info[0] < 3:
48 output = output.encode(preferredencoding())
49 sys.stderr.write(output)
52 class FakeYDL(YoutubeDL):
53 def __init__(self, override=None):
54 # Different instances of the downloader can't share the same dictionary
55 # some test set the "sublang" parameter, which would break the md5 checks.
56 params = get_params(override=override)
57 super(FakeYDL, self).__init__(params)
60 def to_screen(self, s, skip_eol=None):
63 def trouble(self, s, tb=None):
66 def download(self, x):
69 def expect_warning(self, regex):
70 # Silence an expected warning matching a regex
71 old_report_warning = self.report_warning
72 def report_warning(self, message):
73 if re.match(regex, message): return
74 old_report_warning(message)
75 self.report_warning = types.MethodType(report_warning, self)
78 for ie in youtube_dl.extractor.gen_extractors():
79 t = getattr(ie, '_TEST', None)
81 t['name'] = type(ie).__name__[:-len('IE')]
83 for t in getattr(ie, '_TESTS', []):
84 t['name'] = type(ie).__name__[:-len('IE')]
88 md5 = lambda s: hashlib.md5(s.encode('utf-8')).hexdigest()
91 def expect_info_dict(self, expected_dict, got_dict):
92 for info_field, expected in expected_dict.items():
93 if isinstance(expected, compat_str) and expected.startswith('re:'):
94 got = got_dict.get(info_field)
95 match_str = expected[len('re:'):]
96 match_rex = re.compile(match_str)
99 isinstance(got, compat_str) and match_rex.match(got),
100 u'field %s (value: %r) should match %r' % (info_field, got, match_str))
101 elif isinstance(expected, type):
102 got = got_dict.get(info_field)
103 self.assertTrue(isinstance(got, expected),
104 u'Expected type %r, but got value %r of type %r' % (expected, got, type(got)))
106 if isinstance(expected, compat_str) and expected.startswith('md5:'):
107 got = 'md5:' + md5(got_dict.get(info_field))
109 got = got_dict.get(info_field)
110 self.assertEqual(expected, got,
111 u'invalid value for field %s, expected %r, got %r' % (info_field, expected, got))
113 # Check for the presence of mandatory fields
114 for key in ('id', 'url', 'title', 'ext'):
115 self.assertTrue(got_dict.get(key), 'Missing mandatory field %s' % key)
116 # Check for mandatory fields that are automatically set by YoutubeDL
117 for key in ['webpage_url', 'extractor', 'extractor_key']:
118 self.assertTrue(got_dict.get(key), u'Missing field: %s' % key)
120 # Are checkable fields missing from the test case definition?
121 test_info_dict = dict((key, value if not isinstance(value, compat_str) or len(value) < 250 else 'md5:' + md5(value))
122 for key, value in got_dict.items()
123 if value and key in ('title', 'description', 'uploader', 'upload_date', 'timestamp', 'uploader_id', 'location'))
124 missing_keys = set(test_info_dict.keys()) - set(expected_dict.keys())
126 sys.stderr.write(u'\n"info_dict": ' + json.dumps(test_info_dict, ensure_ascii=False, indent=4) + u'\n')
129 'Missing keys in test definition: %s' % (
130 ', '.join(sorted(missing_keys))))