Add support for single-test tox runs
[youtube-dl] / test / test_download.py
index 6926dd04e624e2c50b006519a886e55e2184a5c8..68da4d98450e12a3bae790e43e62f5d8dc9b7909 100644 (file)
 #!/usr/bin/env python
 
-# DO NOT EDIT THIS FILE BY HAND!
-# It is auto-generated from tests.json and gentests.py.
-
 import hashlib
 import io
 import os
 import json
 import unittest
 import sys
+import socket
+import binascii
 
 # Allow direct execution
-import os
 sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
 
-from youtube_dl.FileDownloader import FileDownloader
-import youtube_dl.InfoExtractors
+import youtube_dl.YoutubeDL
+from youtube_dl.utils import *
+
+PARAMETERS_FILE = os.path.join(os.path.dirname(os.path.abspath(__file__)), "parameters.json")
+
+RETRIES = 3
+
+md5 = lambda s: hashlib.md5(s.encode('utf-8')).hexdigest()
+
+class YoutubeDL(youtube_dl.YoutubeDL):
+    def __init__(self, *args, **kwargs):
+        self.to_stderr = self.to_screen
+        self.processed_info_dicts = []
+        super(YoutubeDL, self).__init__(*args, **kwargs)
+    def report_warning(self, message):
+        # Don't accept warnings during tests
+        raise ExtractorError(message)
+    def process_info(self, info_dict):
+        self.processed_info_dicts.append(info_dict)
+        return super(YoutubeDL, self).process_info(info_dict)
 
 def _file_md5(fn):
     with open(fn, 'rb') as f:
         return hashlib.md5(f.read()).hexdigest()
-try:
-    _skip_unless = unittest.skipUnless
-except AttributeError: # Python 2.6
-    def _skip_unless(cond, reason='No reason given'):
-        def resfunc(f):
-            # Start the function name with test to appease nosetests-2.6
-            def test_wfunc(*args, **kwargs):
-                if cond:
-                    return f(*args, **kwargs)
-                else:
-                    print('Skipped test')
-                    return
-            return test_wfunc
-        return resfunc
-_skip = lambda *args, **kwargs: _skip_unless(False, *args, **kwargs)
 
-class DownloadTest(unittest.TestCase):
-    PARAMETERS_FILE = os.path.join(os.path.dirname(os.path.abspath(__file__)), "parameters.json")
+import test.helper as helper  # Set up remaining global configuration
+from .helper import get_testcases, try_rm
+defs = get_testcases()
+
+with io.open(PARAMETERS_FILE, encoding='utf-8') as pf:
+    parameters = json.load(pf)
 
-    def setUp(self):
-        # Clear old files
-        self.tearDown()
-
-        with io.open(self.PARAMETERS_FILE, encoding='utf-8') as pf:
-            self.parameters = json.load(pf)
-
-    @_skip_unless(youtube_dl.InfoExtractors.YoutubeIE._WORKING, "IE marked as not _WORKING")
-    def test_Youtube(self):
-        filename = 'BaW_jenozKc.mp4'
-        fd = FileDownloader(self.parameters)
-        fd.add_info_extractor(youtube_dl.InfoExtractors.YoutubeIE())
-        fd.download(['http://www.youtube.com/watch?v=BaW_jenozKc'])
-        self.assertTrue(os.path.exists(filename))
-        self.assertEqual(os.path.getsize(filename), 1993883)
-
-    @_skip_unless(youtube_dl.InfoExtractors.DailymotionIE._WORKING, "IE marked as not _WORKING")
-    def test_Dailymotion(self):
-        filename = 'x33vw9.mp4'
-        fd = FileDownloader(self.parameters)
-        fd.add_info_extractor(youtube_dl.InfoExtractors.DailymotionIE())
-        fd.download(['http://www.dailymotion.com/video/x33vw9_tutoriel-de-youtubeur-dl-des-video_tech'])
-        self.assertTrue(os.path.exists(filename))
-        md5_for_file = _file_md5(filename)
-        self.assertEqual(md5_for_file, 'd363a50e9eb4f22ce90d08d15695bb47')
-
-    @_skip_unless(youtube_dl.InfoExtractors.MetacafeIE._WORKING, "IE marked as not _WORKING")
-    def test_Metacafe(self):
-        filename = '_aUehQsCQtM.flv'
-        fd = FileDownloader(self.parameters)
-        fd.add_info_extractor(youtube_dl.InfoExtractors.MetacafeIE())
-        fd.add_info_extractor(youtube_dl.InfoExtractors.YoutubeIE())
-        fd.download(['http://www.metacafe.com/watch/yt-_aUehQsCQtM/the_electric_company_short_i_pbs_kids_go/'])
-        self.assertTrue(os.path.exists(filename))
-        self.assertEqual(os.path.getsize(filename), 5754305)
-
-    @_skip_unless(youtube_dl.InfoExtractors.BlipTVIE._WORKING, "IE marked as not _WORKING")
-    def test_BlipTV(self):
-        filename = '5779306.m4v'
-        fd = FileDownloader(self.parameters)
-        fd.add_info_extractor(youtube_dl.InfoExtractors.BlipTVIE())
-        fd.download(['http://blip.tv/cbr/cbr-exclusive-gotham-city-imposters-bats-vs-jokerz-short-3-5796352'])
-        self.assertTrue(os.path.exists(filename))
-        md5_for_file = _file_md5(filename)
-        self.assertEqual(md5_for_file, '4962f94441605832eb1008eb820ef47a')
-
-    @_skip_unless(youtube_dl.InfoExtractors.XVideosIE._WORKING, "IE marked as not _WORKING")
-    def test_XVideos(self):
-        filename = '939581.flv'
-        fd = FileDownloader(self.parameters)
-        fd.add_info_extractor(youtube_dl.InfoExtractors.XVideosIE())
-        fd.download(['http://www.xvideos.com/video939581/funny_porns_by_s_-1'])
-        self.assertTrue(os.path.exists(filename))
-        md5_for_file = _file_md5(filename)
-        self.assertEqual(md5_for_file, 'aecab2ea59b7996110a7e409f0c55da3')
-
-    @_skip_unless(youtube_dl.InfoExtractors.VimeoIE._WORKING, "IE marked as not _WORKING")
-    @_skip("No output file specified")
-    def test_Vimeo(self):
-        filename = ''
-        fd = FileDownloader(self.parameters)
-        fd.add_info_extractor(youtube_dl.InfoExtractors.VimeoIE())
-        fd.download(['http://vimeo.com/14160053'])
-        self.assertTrue(os.path.exists(filename))
-        md5_for_file = _file_md5(filename)
-        self.assertEqual(md5_for_file, '1ab4dedc01f771cb2a65e91caa801aaf')
-
-    @_skip_unless(youtube_dl.InfoExtractors.SoundcloudIE._WORKING, "IE marked as not _WORKING")
-    def test_Soundcloud(self):
-        filename = '62986583.mp3'
-        fd = FileDownloader(self.parameters)
-        fd.add_info_extractor(youtube_dl.InfoExtractors.SoundcloudIE())
-        fd.download(['http://soundcloud.com/ethmusic/lostin-powers-she-so-heavy'])
-        self.assertTrue(os.path.exists(filename))
-        md5_for_file = _file_md5(filename)
-        self.assertEqual(md5_for_file, 'c1b9b9ea8bfd620b96b2628664576e1c')
-
-    @_skip_unless(youtube_dl.InfoExtractors.StanfordOpenClassroomIE._WORKING, "IE marked as not _WORKING")
-    def test_StanfordOpenClassroom(self):
-        filename = 'PracticalUnix_intro-environment.mp4'
-        fd = FileDownloader(self.parameters)
-        fd.add_info_extractor(youtube_dl.InfoExtractors.StanfordOpenClassroomIE())
-        fd.download(['http://openclassroom.stanford.edu/MainFolder/VideoPage.php?course=PracticalUnix&video=intro-environment&speed=100'])
-        self.assertTrue(os.path.exists(filename))
-        md5_for_file = _file_md5(filename)
-        self.assertEqual(md5_for_file, '8aac7873a07dcfaed66b1559ab128514')
-
-    @_skip_unless(youtube_dl.InfoExtractors.CollegeHumorIE._WORKING, "IE marked as not _WORKING")
-    @_skip("No output file specified")
-    def test_CollegeHumor(self):
-        filename = ''
-        fd = FileDownloader(self.parameters)
-        fd.add_info_extractor(youtube_dl.InfoExtractors.CollegeHumorIE())
-        fd.download(['http://www.collegehumor.com/video/6830834/mitt-romney-style-gangnam-style-parody'])
-        self.assertTrue(os.path.exists(filename))
-        md5_for_file = _file_md5(filename)
-        self.assertEqual(md5_for_file, '')
-
-    @_skip_unless(youtube_dl.InfoExtractors.XNXXIE._WORKING, "IE marked as not _WORKING")
-    def test_XNXX(self):
-        filename = '1135332.flv'
-        fd = FileDownloader(self.parameters)
-        fd.add_info_extractor(youtube_dl.InfoExtractors.XNXXIE())
-        fd.download(['http://video.xnxx.com/video1135332/lida_naked_funny_actress_5_'])
-        self.assertTrue(os.path.exists(filename))
-        md5_for_file = _file_md5(filename)
-        self.assertEqual(md5_for_file, 'c5c67df477eb0d9b058200351448ba4c')
-
-    @_skip_unless(youtube_dl.InfoExtractors.YoukuIE._WORKING, "IE marked as not _WORKING")
-    def test_Youku(self):
-        filename = 'XNDgyMDQ2NTQw_part00.flv'
-        fd = FileDownloader(self.parameters)
-        fd.add_info_extractor(youtube_dl.InfoExtractors.YoukuIE())
-        fd.download(['http://v.youku.com/v_show/id_XNDgyMDQ2NTQw.html'])
-        self.assertTrue(os.path.exists(filename))
-        md5_for_file = _file_md5(filename)
-        self.assertEqual(md5_for_file, 'ffe3f2e435663dc2d1eea34faeff5b5b')
-
-
-    def tearDown(self):
-        if os.path.exists('BaW_jenozKc.mp4'):
-            os.remove('BaW_jenozKc.mp4')
-        if os.path.exists('x33vw9.mp4'):
-            os.remove('x33vw9.mp4')
-        if os.path.exists('_aUehQsCQtM.flv'):
-            os.remove('_aUehQsCQtM.flv')
-        if os.path.exists('5779306.m4v'):
-            os.remove('5779306.m4v')
-        if os.path.exists('939581.flv'):
-            os.remove('939581.flv')
-        # No file specified for Vimeo
-        if os.path.exists('62986583.mp3'):
-            os.remove('62986583.mp3')
-        if os.path.exists('PracticalUnix_intro-environment.mp4'):
-            os.remove('PracticalUnix_intro-environment.mp4')
-        # No file specified for CollegeHumor
-        if os.path.exists('1135332.flv'):
-            os.remove('1135332.flv')
-        if os.path.exists('XNDgyMDQ2NTQw_part00.flv'):
-            os.remove('XNDgyMDQ2NTQw_part00.flv')
 
+class TestDownload(unittest.TestCase):
+    maxDiff = None
+    def setUp(self):
+        self.parameters = parameters
+        self.defs = defs
+
+### Dynamically generate tests
+def generator(test_case):
+
+    def test_template(self):
+        ie = youtube_dl.extractor.get_info_extractor(test_case['name'])
+        def print_skipping(reason):
+            print('Skipping %s: %s' % (test_case['name'], reason))
+        if not ie._WORKING:
+            print_skipping('IE marked as not _WORKING')
+            return
+        if 'playlist' not in test_case and not test_case['file']:
+            print_skipping('No output file specified')
+            return
+        if 'skip' in test_case:
+            print_skipping(test_case['skip'])
+            return
+
+        params = self.parameters.copy()
+        params.update(test_case.get('params', {}))
+
+        ydl = YoutubeDL(params)
+        ydl.add_default_info_extractors()
+        finished_hook_called = set()
+        def _hook(status):
+            if status['status'] == 'finished':
+                finished_hook_called.add(status['filename'])
+        ydl.fd.add_progress_hook(_hook)
+
+        test_cases = test_case.get('playlist', [test_case])
+        for tc in test_cases:
+            try_rm(tc['file'])
+            try_rm(tc['file'] + '.part')
+            try_rm(tc['file'] + '.info.json')
+        try:
+            for retry in range(1, RETRIES + 1):
+                try:
+                    ydl.download([test_case['url']])
+                except (DownloadError, ExtractorError) as err:
+                    if retry == RETRIES: raise
+
+                    # Check if the exception is not a network related one
+                    if not err.exc_info[0] in (compat_urllib_error.URLError, socket.timeout, UnavailableVideoError):
+                        raise
+
+                    print('Retrying: {0} failed tries\n\n##########\n\n'.format(retry))
+                else:
+                    break
+
+            for tc in test_cases:
+                if not test_case.get('params', {}).get('skip_download', False):
+                    self.assertTrue(os.path.exists(tc['file']), msg='Missing file ' + tc['file'])
+                    self.assertTrue(tc['file'] in finished_hook_called)
+                self.assertTrue(os.path.exists(tc['file'] + '.info.json'))
+                if 'md5' in tc:
+                    md5_for_file = _file_md5(tc['file'])
+                    self.assertEqual(md5_for_file, tc['md5'])
+                with io.open(tc['file'] + '.info.json', encoding='utf-8') as infof:
+                    info_dict = json.load(infof)
+                for (info_field, expected) in tc.get('info_dict', {}).items():
+                    if isinstance(expected, compat_str) and expected.startswith('md5:'):
+                        got = 'md5:' + md5(info_dict.get(info_field))
+                    else:
+                        got = info_dict.get(info_field)
+                    self.assertEqual(expected, got,
+                        u'invalid value for field %s, expected %r, got %r' % (info_field, expected, got))
+
+                # If checkable fields are missing from the test case, print the info_dict
+                test_info_dict = dict((key, value if not isinstance(value, compat_str) or len(value) < 250 else 'md5:' + md5(value))
+                    for key, value in info_dict.items()
+                    if value and key in ('title', 'description', 'uploader', 'upload_date', 'uploader_id', 'location'))
+                if not all(key in tc.get('info_dict', {}).keys() for key in test_info_dict.keys()):
+                    sys.stderr.write(u'\n"info_dict": ' + json.dumps(test_info_dict, ensure_ascii=False, indent=2) + u'\n')
+
+                # Check for the presence of mandatory fields
+                for key in ('id', 'url', 'title', 'ext'):
+                    self.assertTrue(key in info_dict.keys() and info_dict[key])
+        finally:
+            for tc in test_cases:
+                try_rm(tc['file'])
+                try_rm(tc['file'] + '.part')
+                try_rm(tc['file'] + '.info.json')
+
+    return test_template
+
+### And add them to TestDownload
+for n, test_case in enumerate(defs):
+    test_method = generator(test_case)
+    tname = 'test_' + str(test_case['name'])
+    i = 1
+    while hasattr(TestDownload, tname):
+        tname = 'test_'  + str(test_case['name']) + '_' + str(i)
+        i += 1
+    test_method.__name__ = tname
+    setattr(TestDownload, test_method.__name__, test_method)
+    del test_method
 
 
 if __name__ == '__main__':