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