Merge branch 'master' of https://github.com/rg3/youtube-dl
[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 # General configuration (from __init__, not very elegant...)
24 jar = compat_cookiejar.CookieJar()
25 cookie_processor = compat_urllib_request.HTTPCookieProcessor(jar)
26 proxy_handler = compat_urllib_request.ProxyHandler()
27 opener = compat_urllib_request.build_opener(proxy_handler, cookie_processor, YoutubeDLHandler())
28 compat_urllib_request.install_opener(opener)
29
30 def _try_rm(filename):
31     """ Remove a file if it exists """
32     try:
33         os.remove(filename)
34     except OSError as ose:
35         if ose.errno != errno.ENOENT:
36             raise
37
38 class FileDownloader(youtube_dl.FileDownloader):
39     def __init__(self, *args, **kwargs):
40         self.to_stderr = self.to_screen
41         self.processed_info_dicts = []
42         return youtube_dl.FileDownloader.__init__(self, *args, **kwargs)
43     def process_info(self, info_dict):
44         self.processed_info_dicts.append(info_dict)
45         return youtube_dl.FileDownloader.process_info(self, info_dict)
46
47 def _file_md5(fn):
48     with open(fn, 'rb') as f:
49         return hashlib.md5(f.read()).hexdigest()
50
51 with io.open(DEF_FILE, encoding='utf-8') as deff:
52     defs = json.load(deff)
53 with io.open(PARAMETERS_FILE, encoding='utf-8') as pf:
54     parameters = json.load(pf)
55
56
57 class TestDownload(unittest.TestCase):
58     def setUp(self):
59         self.parameters = parameters
60         self.defs = defs
61
62 ### Dynamically generate tests
63 def generator(test_case):
64
65     def test_template(self):
66         ie = getattr(youtube_dl.InfoExtractors, test_case['name'] + 'IE')
67         if not ie._WORKING:
68             print('Skipping: IE marked as not _WORKING')
69             return
70         if 'playlist' not in test_case and not test_case['file']:
71             print('Skipping: No output file specified')
72             return
73         if 'skip' in test_case:
74             print('Skipping: {0}'.format(test_case['skip']))
75             return
76
77         params = self.parameters.copy()
78         params.update(test_case.get('params', {}))
79
80         fd = FileDownloader(params)
81         fd.add_info_extractor(ie())
82         for ien in test_case.get('add_ie', []):
83             fd.add_info_extractor(getattr(youtube_dl.InfoExtractors, ien + 'IE')())
84
85         test_cases = test_case.get('playlist', [test_case])
86         for tc in test_cases:
87             _try_rm(tc['file'])
88             _try_rm(tc['file'] + '.part')
89             _try_rm(tc['file'] + '.info.json')
90         try:
91             fd.download([test_case['url']])
92
93             for tc in test_cases:
94                 if not test_case.get('params', {}).get('skip_download', False):
95                     self.assertTrue(os.path.exists(tc['file']))
96                 self.assertTrue(os.path.exists(tc['file'] + '.info.json'))
97                 if 'md5' in tc:
98                     md5_for_file = _file_md5(tc['file'])
99                     self.assertEqual(md5_for_file, tc['md5'])
100                 with io.open(tc['file'] + '.info.json', encoding='utf-8') as infof:
101                     info_dict = json.load(infof)
102                 for (info_field, value) in tc.get('info_dict', {}).items():
103                     if value.startswith('md5:'):
104                         md5_info_value = hashlib.md5(info_dict.get(info_field, '')).hexdigest()
105                         self.assertEqual(value[3:], md5_info_value)
106                     else:
107                         self.assertEqual(value, info_dict.get(info_field))
108         finally:
109             for tc in test_cases:
110                 _try_rm(tc['file'])
111                 _try_rm(tc['file'] + '.part')
112                 _try_rm(tc['file'] + '.info.json')
113
114     return test_template
115
116 ### And add them to TestDownload
117 for test_case in defs:
118     test_method = generator(test_case)
119     test_method.__name__ = "test_{0}".format(test_case["name"])
120     setattr(TestDownload, test_method.__name__, test_method)
121     del test_method
122
123
124 if __name__ == '__main__':
125     unittest.main()