_ Git - youtube-dl/blob - test/test_download.py

   1 #!/usr/bin/env python
   2
   3 import hashlib
   4 import io
   5 import os
   6 import json
   7 import unittest
   8 import sys
   9 import socket
  10 import binascii
  11
  12 # Allow direct execution
  13 sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
  14
  15 import youtube_dl.YoutubeDL
  16 from youtube_dl.utils import *
  17
  18 PARAMETERS_FILE = os.path.join(os.path.dirname(os.path.abspath(__file__)), "parameters.json")
  19
  20 RETRIES = 3
  21
  22 md5 = lambda s: hashlib.md5(s.encode('utf-8')).hexdigest()
  23
  24 class YoutubeDL(youtube_dl.YoutubeDL):
  25     def __init__(self, *args, **kwargs):
  26         self.to_stderr = self.to_screen
  27         self.processed_info_dicts = []
  28         super(YoutubeDL, self).__init__(*args, **kwargs)
  29     def report_warning(self, message):
  30         # Don't accept warnings during tests
  31         raise ExtractorError(message)
  32     def process_info(self, info_dict):
  33         self.processed_info_dicts.append(info_dict)
  34         return super(YoutubeDL, self).process_info(info_dict)
  35
  36 def _file_md5(fn):
  37     with open(fn, 'rb') as f:
  38         return hashlib.md5(f.read()).hexdigest()
  39
  40 import test.helper as helper  # Set up remaining global configuration
  41 from .helper import get_testcases, try_rm
  42 defs = get_testcases()
  43
  44 with io.open(PARAMETERS_FILE, encoding='utf-8') as pf:
  45     parameters = json.load(pf)
  46
  47
  48 class TestDownload(unittest.TestCase):
  49     maxDiff = None
  50     def setUp(self):
  51         self.parameters = parameters
  52         self.defs = defs
  53
  54 ### Dynamically generate tests
  55 def generator(test_case):
  56
  57     def test_template(self):
  58         ie = youtube_dl.extractor.get_info_extractor(test_case['name'])
  59         def print_skipping(reason):
  60             print('Skipping %s: %s' % (test_case['name'], reason))
  61         if not ie._WORKING:
  62             print_skipping('IE marked as not _WORKING')
  63             return
  64         if 'playlist' not in test_case and not test_case['file']:
  65             print_skipping('No output file specified')
  66             return
  67         if 'skip' in test_case:
  68             print_skipping(test_case['skip'])
  69             return
  70
  71         params = self.parameters.copy()
  72         params.update(test_case.get('params', {}))
  73
  74         ydl = YoutubeDL(params)
  75         ydl.add_default_info_extractors()
  76         finished_hook_called = set()
  77         def _hook(status):
  78             if status['status'] == 'finished':
  79                 finished_hook_called.add(status['filename'])
  80         ydl.fd.add_progress_hook(_hook)
  81
  82         test_cases = test_case.get('playlist', [test_case])
  83         for tc in test_cases:
  84             try_rm(tc['file'])
  85             try_rm(tc['file'] + '.part')
  86             try_rm(tc['file'] + '.info.json')
  87         try:
  88             for retry in range(1, RETRIES + 1):
  89                 try:
  90                     ydl.download([test_case['url']])
  91                 except (DownloadError, ExtractorError) as err:
  92                     if retry == RETRIES: raise
  93
  94                     # Check if the exception is not a network related one
  95                     if not err.exc_info[0] in (compat_urllib_error.URLError, socket.timeout, UnavailableVideoError):
  96                         raise
  97
  98                     print('Retrying: {0} failed tries\n\n##########\n\n'.format(retry))
  99                 else:
 100                     break
 101
 102             for tc in test_cases:
 103                 if not test_case.get('params', {}).get('skip_download', False):
 104                     self.assertTrue(os.path.exists(tc['file']), msg='Missing file ' + tc['file'])
 105                     self.assertTrue(tc['file'] in finished_hook_called)
 106                 self.assertTrue(os.path.exists(tc['file'] + '.info.json'))
 107                 if 'md5' in tc:
 108                     md5_for_file = _file_md5(tc['file'])
 109                     self.assertEqual(md5_for_file, tc['md5'])
 110                 with io.open(tc['file'] + '.info.json', encoding='utf-8') as infof:
 111                     info_dict = json.load(infof)
 112                 for (info_field, expected) in tc.get('info_dict', {}).items():
 113                     if isinstance(expected, compat_str) and expected.startswith('md5:'):
 114                         got = 'md5:' + md5(info_dict.get(info_field))
 115                     else:
 116                         got = info_dict.get(info_field)
 117                     self.assertEqual(expected, got,
 118                         u'invalid value for field %s, expected %r, got %r' % (info_field, expected, got))
 119
 120                 # If checkable fields are missing from the test case, print the info_dict
 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 info_dict.items()
 123                     if value and key in ('title', 'description', 'uploader', 'upload_date', 'uploader_id', 'location'))
 124                 if not all(key in tc.get('info_dict', {}).keys() for key in test_info_dict.keys()):
 125                     sys.stderr.write(u'\n"info_dict": ' + json.dumps(test_info_dict, ensure_ascii=False, indent=2) + u'\n')
 126
 127                 # Check for the presence of mandatory fields
 128                 for key in ('id', 'url', 'title', 'ext'):
 129                     self.assertTrue(key in info_dict.keys() and info_dict[key])
 130         finally:
 131             for tc in test_cases:
 132                 try_rm(tc['file'])
 133                 try_rm(tc['file'] + '.part')
 134                 try_rm(tc['file'] + '.info.json')
 135
 136     return test_template
 137
 138 ### And add them to TestDownload
 139 for n, test_case in enumerate(defs):
 140     test_method = generator(test_case)
 141     tname = 'test_' + str(test_case['name'])
 142     i = 1
 143     while hasattr(TestDownload, tname):
 144         tname = 'test_'  + str(test_case['name']) + '_' + str(i)
 145         i += 1
 146     test_method.__name__ = tname
 147     setattr(TestDownload, test_method.__name__, test_method)
 148     del test_method
 149
 150
 151 if __name__ == '__main__':
 152     unittest.main()