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 ssl
  11 import sys
  12
  13 import yt_dlp.extractor
  14 from yt_dlp import YoutubeDL
  15 from yt_dlp.compat import (
  16     compat_os_name,
  17     compat_str,
  18 )
  19 from yt_dlp.utils import (
  20     preferredencoding,
  21     write_string,
  22 )
  23
  24
  25 if "pytest" in sys.modules:
  26     import pytest
  27     is_download_test = pytest.mark.download
  28 else:
  29     def is_download_test(testClass):
  30         return testClass
  31
  32
  33 def get_params(override=None):
  34     PARAMETERS_FILE = os.path.join(os.path.dirname(os.path.abspath(__file__)),
  35                                    "parameters.json")
  36     LOCAL_PARAMETERS_FILE = os.path.join(os.path.dirname(os.path.abspath(__file__)),
  37                                          "local_parameters.json")
  38     with io.open(PARAMETERS_FILE, encoding='utf-8') as pf:
  39         parameters = json.load(pf)
  40     if os.path.exists(LOCAL_PARAMETERS_FILE):
  41         with io.open(LOCAL_PARAMETERS_FILE, encoding='utf-8') as pf:
  42             parameters.update(json.load(pf))
  43     if override:
  44         parameters.update(override)
  45     return parameters
  46
  47
  48 def try_rm(filename):
  49     """ Remove a file if it exists """
  50     try:
  51         os.remove(filename)
  52     except OSError as ose:
  53         if ose.errno != errno.ENOENT:
  54             raise
  55
  56
  57 def report_warning(message):
  58     '''
  59     Print the message to stderr, it will be prefixed with 'WARNING:'
  60     If stderr is a tty file the 'WARNING:' will be colored
  61     '''
  62     if sys.stderr.isatty() and compat_os_name != 'nt':
  63         _msg_header = '\033[0;33mWARNING:\033[0m'
  64     else:
  65         _msg_header = 'WARNING:'
  66     output = '%s %s\n' % (_msg_header, message)
  67     if 'b' in getattr(sys.stderr, 'mode', '') or sys.version_info[0] < 3:
  68         output = output.encode(preferredencoding())
  69     sys.stderr.write(output)
  70
  71
  72 class FakeYDL(YoutubeDL):
  73     def __init__(self, override=None):
  74         # Different instances of the downloader can't share the same dictionary
  75         # some test set the "sublang" parameter, which would break the md5 checks.
  76         params = get_params(override=override)
  77         super(FakeYDL, self).__init__(params, auto_init=False)
  78         self.result = []
  79
  80     def to_screen(self, s, skip_eol=None):
  81         print(s)
  82
  83     def trouble(self, s, tb=None):
  84         raise Exception(s)
  85
  86     def download(self, x):
  87         self.result.append(x)
  88
  89     def expect_warning(self, regex):
  90         # Silence an expected warning matching a regex
  91         old_report_warning = self.report_warning
  92
  93         def report_warning(self, message):
  94             if re.match(regex, message):
  95                 return
  96             old_report_warning(message)
  97         self.report_warning = types.MethodType(report_warning, self)
  98
  99
 100 def gettestcases(include_onlymatching=False):
 101     for ie in yt_dlp.extractor.gen_extractors():
 102         for tc in ie.get_testcases(include_onlymatching):
 103             yield tc
 104
 105
 106 md5 = lambda s: hashlib.md5(s.encode('utf-8')).hexdigest()
 107
 108
 109 def expect_value(self, got, expected, field):
 110     if isinstance(expected, compat_str) and expected.startswith('re:'):
 111         match_str = expected[len('re:'):]
 112         match_rex = re.compile(match_str)
 113
 114         self.assertTrue(
 115             isinstance(got, compat_str),
 116             'Expected a %s object, but got %s for field %s' % (
 117                 compat_str.__name__, type(got).__name__, field))
 118         self.assertTrue(
 119             match_rex.match(got),
 120             'field %s (value: %r) should match %r' % (field, got, match_str))
 121     elif isinstance(expected, compat_str) and expected.startswith('startswith:'):
 122         start_str = expected[len('startswith:'):]
 123         self.assertTrue(
 124             isinstance(got, compat_str),
 125             'Expected a %s object, but got %s for field %s' % (
 126                 compat_str.__name__, type(got).__name__, field))
 127         self.assertTrue(
 128             got.startswith(start_str),
 129             'field %s (value: %r) should start with %r' % (field, got, start_str))
 130     elif isinstance(expected, compat_str) and expected.startswith('contains:'):
 131         contains_str = expected[len('contains:'):]
 132         self.assertTrue(
 133             isinstance(got, compat_str),
 134             'Expected a %s object, but got %s for field %s' % (
 135                 compat_str.__name__, type(got).__name__, field))
 136         self.assertTrue(
 137             contains_str in got,
 138             'field %s (value: %r) should contain %r' % (field, got, contains_str))
 139     elif isinstance(expected, type):
 140         self.assertTrue(
 141             isinstance(got, expected),
 142             'Expected type %r for field %s, but got value %r of type %r' % (expected, field, got, type(got)))
 143     elif isinstance(expected, dict) and isinstance(got, dict):
 144         expect_dict(self, got, expected)
 145     elif isinstance(expected, list) and isinstance(got, list):
 146         self.assertEqual(
 147             len(expected), len(got),
 148             'Expect a list of length %d, but got a list of length %d for field %s' % (
 149                 len(expected), len(got), field))
 150         for index, (item_got, item_expected) in enumerate(zip(got, expected)):
 151             type_got = type(item_got)
 152             type_expected = type(item_expected)
 153             self.assertEqual(
 154                 type_expected, type_got,
 155                 'Type mismatch for list item at index %d for field %s, expected %r, got %r' % (
 156                     index, field, type_expected, type_got))
 157             expect_value(self, item_got, item_expected, field)
 158     else:
 159         if isinstance(expected, compat_str) and expected.startswith('md5:'):
 160             self.assertTrue(
 161                 isinstance(got, compat_str),
 162                 'Expected field %s to be a unicode object, but got value %r of type %r' % (field, got, type(got)))
 163             got = 'md5:' + md5(got)
 164         elif isinstance(expected, compat_str) and re.match(r'^(?:min|max)?count:\d+', expected):
 165             self.assertTrue(
 166                 isinstance(got, (list, dict)),
 167                 'Expected field %s to be a list or a dict, but it is of type %s' % (
 168                     field, type(got).__name__))
 169             op, _, expected_num = expected.partition(':')
 170             expected_num = int(expected_num)
 171             if op == 'mincount':
 172                 assert_func = assertGreaterEqual
 173                 msg_tmpl = 'Expected %d items in field %s, but only got %d'
 174             elif op == 'maxcount':
 175                 assert_func = assertLessEqual
 176                 msg_tmpl = 'Expected maximum %d items in field %s, but got %d'
 177             elif op == 'count':
 178                 assert_func = assertEqual
 179                 msg_tmpl = 'Expected exactly %d items in field %s, but got %d'
 180             else:
 181                 assert False
 182             assert_func(
 183                 self, len(got), expected_num,
 184                 msg_tmpl % (expected_num, field, len(got)))
 185             return
 186         self.assertEqual(
 187             expected, got,
 188             'Invalid value for field %s, expected %r, got %r' % (field, expected, got))
 189
 190
 191 def expect_dict(self, got_dict, expected_dict):
 192     for info_field, expected in expected_dict.items():
 193         got = got_dict.get(info_field)
 194         expect_value(self, got, expected, info_field)
 195
 196
 197 def expect_info_dict(self, got_dict, expected_dict):
 198     expect_dict(self, got_dict, expected_dict)
 199     # Check for the presence of mandatory fields
 200     if got_dict.get('_type') not in ('playlist', 'multi_video'):
 201         for key in ('id', 'url', 'title', 'ext'):
 202             self.assertTrue(got_dict.get(key), 'Missing mandatory field %s' % key)
 203     # Check for mandatory fields that are automatically set by YoutubeDL
 204     for key in ['webpage_url', 'extractor', 'extractor_key']:
 205         self.assertTrue(got_dict.get(key), 'Missing field: %s' % key)
 206
 207     # Are checkable fields missing from the test case definition?
 208     test_info_dict = dict((key, value if not isinstance(value, compat_str) or len(value) < 250 else 'md5:' + md5(value))
 209                           for key, value in got_dict.items()
 210                           if value and key in ('id', 'title', 'description', 'uploader', 'upload_date', 'timestamp', 'uploader_id', 'location', 'age_limit'))
 211     missing_keys = set(test_info_dict.keys()) - set(expected_dict.keys())
 212     if missing_keys:
 213         def _repr(v):
 214             if isinstance(v, compat_str):
 215                 return "'%s'" % v.replace('\\', '\\\\').replace("'", "\\'").replace('\n', '\\n')
 216             else:
 217                 return repr(v)
 218         info_dict_str = ''
 219         if len(missing_keys) != len(expected_dict):
 220             info_dict_str += ''.join(
 221                 '    %s: %s,\n' % (_repr(k), _repr(v))
 222                 for k, v in test_info_dict.items() if k not in missing_keys)
 223
 224             if info_dict_str:
 225                 info_dict_str += '\n'
 226         info_dict_str += ''.join(
 227             '    %s: %s,\n' % (_repr(k), _repr(test_info_dict[k]))
 228             for k in missing_keys)
 229         write_string(
 230             '\n\'info_dict\': {\n' + info_dict_str + '},\n', out=sys.stderr)
 231         self.assertFalse(
 232             missing_keys,
 233             'Missing keys in test definition: %s' % (
 234                 ', '.join(sorted(missing_keys))))
 235
 236
 237 def assertRegexpMatches(self, text, regexp, msg=None):
 238     if hasattr(self, 'assertRegexp'):
 239         return self.assertRegexp(text, regexp, msg)
 240     else:
 241         m = re.match(regexp, text)
 242         if not m:
 243             note = 'Regexp didn\'t match: %r not found' % (regexp)
 244             if len(text) < 1000:
 245                 note += ' in %r' % text
 246             if msg is None:
 247                 msg = note
 248             else:
 249                 msg = note + ', ' + msg
 250             self.assertTrue(m, msg)
 251
 252
 253 def assertGreaterEqual(self, got, expected, msg=None):
 254     if not (got >= expected):
 255         if msg is None:
 256             msg = '%r not greater than or equal to %r' % (got, expected)
 257         self.assertTrue(got >= expected, msg)
 258
 259
 260 def assertLessEqual(self, got, expected, msg=None):
 261     if not (got <= expected):
 262         if msg is None:
 263             msg = '%r not less than or equal to %r' % (got, expected)
 264         self.assertTrue(got <= expected, msg)
 265
 266
 267 def assertEqual(self, got, expected, msg=None):
 268     if not (got == expected):
 269         if msg is None:
 270             msg = '%r not equal to %r' % (got, expected)
 271         self.assertTrue(got == expected, msg)
 272
 273
 274 def expect_warnings(ydl, warnings_re):
 275     real_warning = ydl.report_warning
 276
 277     def _report_warning(w):
 278         if not any(re.search(w_re, w) for w_re in warnings_re):
 279             real_warning(w)
 280
 281     ydl.report_warning = _report_warning
 282
 283
 284 def http_server_port(httpd):
 285     if os.name == 'java' and isinstance(httpd.socket, ssl.SSLSocket):
 286         # In Jython SSLSocket is not a subclass of socket.socket
 287         sock = httpd.socket.sock
 288     else:
 289         sock = httpd.socket
 290     return sock.getsockname()[1]