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_screen
  44         self.processed_info_dicts = []
  45         return youtube_dl.FileDownloader.__init__(self, *args, **kwargs)
  46     def report_warning(self, message):
  47         # Don't accept warnings during tests
  48         raise ExtractorError(message)
  49     def process_info(self, info_dict):
  50         self.processed_info_dicts.append(info_dict)
  51         return youtube_dl.FileDownloader.process_info(self, info_dict)
  52
  53 def _file_md5(fn):
  54     with open(fn, 'rb') as f:
  55         return hashlib.md5(f.read()).hexdigest()
  56
  57 with io.open(DEF_FILE, encoding='utf-8') as deff:
  58     defs = json.load(deff)
  59 with io.open(PARAMETERS_FILE, encoding='utf-8') as pf:
  60     parameters = json.load(pf)
  61
  62
  63 class TestDownload(unittest.TestCase):
  64     maxDiff = None
  65     def setUp(self):
  66         self.parameters = parameters
  67         self.defs = defs
  68
  69 ### Dynamically generate tests
  70 def generator(test_case):
  71
  72     def test_template(self):
  73         ie = youtube_dl.InfoExtractors.get_info_extractor(test_case['name'])
  74         if not ie._WORKING:
  75             print('Skipping: IE marked as not _WORKING')
  76             return
  77         if 'playlist' not in test_case and not test_case['file']:
  78             print('Skipping: No output file specified')
  79             return
  80         if 'skip' in test_case:
  81             print('Skipping: {0}'.format(test_case['skip']))
  82             return
  83
  84         params = self.parameters.copy()
  85         params.update(test_case.get('params', {}))
  86
  87         fd = FileDownloader(params)
  88         for ie in youtube_dl.InfoExtractors.gen_extractors():
  89             fd.add_info_extractor(ie)
  90         finished_hook_called = set()
  91         def _hook(status):
  92             if status['status'] == 'finished':
  93                 finished_hook_called.add(status['filename'])
  94         fd.add_progress_hook(_hook)
  95
  96         test_cases = test_case.get('playlist', [test_case])
  97         for tc in test_cases:
  98             _try_rm(tc['file'])
  99             _try_rm(tc['file'] + '.part')
 100             _try_rm(tc['file'] + '.info.json')
 101         try:
 102             for retry in range(1, RETRIES + 1):
 103                 try:
 104                     fd.download([test_case['url']])
 105                 except (DownloadError, ExtractorError) as err:
 106                     if retry == RETRIES: raise
 107
 108                     # Check if the exception is not a network related one
 109                     if not err.exc_info[0] in (compat_urllib_error.URLError, socket.timeout, UnavailableVideoError):
 110                         raise
 111
 112                     print('Retrying: {0} failed tries\n\n##########\n\n'.format(retry))
 113                 else:
 114                     break
 115
 116             for tc in test_cases:
 117                 if not test_case.get('params', {}).get('skip_download', False):
 118                     self.assertTrue(os.path.exists(tc['file']), msg='Missing file ' + tc['file'])
 119                     self.assertTrue(tc['file'] in finished_hook_called)
 120                 self.assertTrue(os.path.exists(tc['file'] + '.info.json'))
 121                 if 'md5' in tc:
 122                     md5_for_file = _file_md5(tc['file'])
 123                     self.assertEqual(md5_for_file, tc['md5'])
 124                 with io.open(tc['file'] + '.info.json', encoding='utf-8') as infof:
 125                     info_dict = json.load(infof)
 126                 for (info_field, value) in tc.get('info_dict', {}).items():
 127                     self.assertEqual(value, info_dict.get(info_field))
 128         finally:
 129             for tc in test_cases:
 130                 _try_rm(tc['file'])
 131                 _try_rm(tc['file'] + '.part')
 132                 _try_rm(tc['file'] + '.info.json')
 133
 134     return test_template
 135
 136 ### And add them to TestDownload
 137 for test_case in defs:
 138     test_method = generator(test_case)
 139     test_method.__name__ = "test_{0}".format(test_case["name"])
 140     setattr(TestDownload, test_method.__name__, test_method)
 141     del test_method
 142
 143
 144 if __name__ == '__main__':
 145     unittest.main()