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

   1 #!/usr/bin/env python
   2
   3 import errno
   4 import hashlib
   5 import io
   6 import os
   7 import json
   8 import unittest
   9 import sys
  10 import hashlib
  11 import socket
  12
  13 # Allow direct execution
  14 sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
  15
  16 import youtube_dl.FileDownloader
  17 import youtube_dl.InfoExtractors
  18 from youtube_dl.utils import *
  19
  20 DEF_FILE = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'tests.json')
  21 PARAMETERS_FILE = os.path.join(os.path.dirname(os.path.abspath(__file__)), "parameters.json")
  22
  23 RETRIES = 3
  24
  25 # General configuration (from __init__, not very elegant...)
  26 jar = compat_cookiejar.CookieJar()
  27 cookie_processor = compat_urllib_request.HTTPCookieProcessor(jar)
  28 proxy_handler = compat_urllib_request.ProxyHandler()
  29 opener = compat_urllib_request.build_opener(proxy_handler, cookie_processor, YoutubeDLHandler())
  30 compat_urllib_request.install_opener(opener)
  31 socket.setdefaulttimeout(10)
  32
  33 def _try_rm(filename):
  34     """ Remove a file if it exists """
  35     try:
  36         os.remove(filename)
  37     except OSError as ose:
  38         if ose.errno != errno.ENOENT:
  39             raise
  40
  41 class FileDownloader(youtube_dl.FileDownloader):
  42     def __init__(self, *args, **kwargs):
  43         self._to_stderr = self.to_stderr
  44         self.to_stderr = self.to_screen
  45         self.processed_info_dicts = []
  46         return youtube_dl.FileDownloader.__init__(self, *args, **kwargs)
  47     def report_warning(self, message):
  48         # let warnings pass to output
  49         if sys.stderr.isatty() and os.name != 'nt':
  50             _msg_header=u'\033[0;33mWARNING:\033[0m'
  51         else:
  52             _msg_header=u'WARNING:'
  53         warning_message=u'%s %s' % (_msg_header,message)
  54         self._to_stderr(warning_message)
  55     def process_info(self, info_dict):
  56         self.processed_info_dicts.append(info_dict)
  57         return youtube_dl.FileDownloader.process_info(self, info_dict)
  58
  59 def _file_md5(fn):
  60     with open(fn, 'rb') as f:
  61         return hashlib.md5(f.read()).hexdigest()
  62
  63 with io.open(DEF_FILE, encoding='utf-8') as deff:
  64     defs = json.load(deff)
  65 with io.open(PARAMETERS_FILE, encoding='utf-8') as pf:
  66     parameters = json.load(pf)
  67
  68
  69 class TestDownload(unittest.TestCase):
  70     maxDiff = None
  71     def setUp(self):
  72         self.parameters = parameters
  73         self.defs = defs
  74
  75 ### Dynamically generate tests
  76 def generator(test_case):
  77
  78     def test_template(self):
  79         ie = youtube_dl.InfoExtractors.get_info_extractor(test_case['name'])
  80         if not ie._WORKING:
  81             print('Skipping: IE marked as not _WORKING')
  82             return
  83         if 'playlist' not in test_case and not test_case['file']:
  84             print('Skipping: No output file specified')
  85             return
  86         if 'skip' in test_case:
  87             print('Skipping: {0}'.format(test_case['skip']))
  88             return
  89
  90         params = self.parameters.copy()
  91         params.update(test_case.get('params', {}))
  92
  93         fd = FileDownloader(params)
  94         for ie in youtube_dl.InfoExtractors.gen_extractors():
  95             fd.add_info_extractor(ie)
  96         finished_hook_called = set()
  97         def _hook(status):
  98             if status['status'] == 'finished':
  99                 finished_hook_called.add(status['filename'])
 100         fd.add_progress_hook(_hook)
 101
 102         test_cases = test_case.get('playlist', [test_case])
 103         for tc in test_cases:
 104             _try_rm(tc['file'])
 105             _try_rm(tc['file'] + '.part')
 106             _try_rm(tc['file'] + '.info.json')
 107         try:
 108             for retry in range(1, RETRIES + 1):
 109                 try:
 110                     fd.download([test_case['url']])
 111                 except (DownloadError, ExtractorError) as err:
 112                     if retry == RETRIES: raise
 113
 114                     # Check if the exception is not a network related one
 115                     if not err.exc_info[0] in (compat_urllib_error.URLError, socket.timeout, UnavailableVideoError):
 116                         raise
 117
 118                     print('Retrying: {0} failed tries\n\n##########\n\n'.format(retry))
 119                 else:
 120                     break
 121
 122             for tc in test_cases:
 123                 if not test_case.get('params', {}).get('skip_download', False):
 124                     self.assertTrue(os.path.exists(tc['file']), msg='Missing file ' + tc['file'])
 125                     self.assertTrue(tc['file'] in finished_hook_called)
 126                 self.assertTrue(os.path.exists(tc['file'] + '.info.json'))
 127                 if 'md5' in tc:
 128                     md5_for_file = _file_md5(tc['file'])
 129                     self.assertEqual(md5_for_file, tc['md5'])
 130                 with io.open(tc['file'] + '.info.json', encoding='utf-8') as infof:
 131                     info_dict = json.load(infof)
 132                 for (info_field, value) in tc.get('info_dict', {}).items():
 133                     self.assertEqual(value, info_dict.get(info_field))
 134         finally:
 135             for tc in test_cases:
 136                 _try_rm(tc['file'])
 137                 _try_rm(tc['file'] + '.part')
 138                 _try_rm(tc['file'] + '.info.json')
 139
 140     return test_template
 141
 142 ### And add them to TestDownload
 143 for test_case in defs:
 144     test_method = generator(test_case)
 145     test_method.__name__ = "test_{0}".format(test_case["name"])
 146     setattr(TestDownload, test_method.__name__, test_method)
 147     del test_method
 148
 149
 150 if __name__ == '__main__':
 151     unittest.main()