added some tests for FindBestSubtitleMatches and QueryOpenSubtitles

Author: nicoddemus

ss.py

@@ -2,7 +2,7 @@
 import xmlrpclib
 import difflib
 import os
-from calculate_hash import CalculateHashForFile
+import calculate_hash
 import gzip
 import urllib
 import tempfile
@@ -16,7 +16,6 @@
 def QueryOpenSubtitles(movie_filenames, language):
     uri = 'http://api.opensubtitles.org/xml-rpc'
     server = xmlrpclib.Server(uri, verbose=0, allow_none=True, use_datetime=True)
-    
     login_info = server.LogIn('', '', 'en', 'OS Test User Agent')
     token = login_info['token']
 
@@ -26,7 +25,7 @@ def QueryOpenSubtitles(movie_filenames, language):
         for movie_filename in movie_filenames:
             search_queries = [
                 dict(
-                    moviehash=CalculateHashForFile(movie_filename),
+                    moviehash=calculate_hash.CalculateHashForFile(movie_filename),
                     moviebytesize=os.path.getsize(movie_filename),
                     sublanguageid=language,
                 ),
@@ -36,6 +35,7 @@ def QueryOpenSubtitles(movie_filenames, language):
             ]
 
             response = server.SearchSubtitles(token, search_queries)
+            print movie_filename, response
             search_results = response['data']
 
             if search_results:

tests/test_ss.py

@@ -1,5 +1,7 @@
+from __future__ import with_statement
 import pytest
-from ss import FindMovieFiles
+from mock import patch, MagicMock, call
+from ss import FindMovieFiles, QueryOpenSubtitles, FindBestSubtitleMatches
 
 
 #===================================================================================================
@@ -25,6 +27,72 @@ def testFindMovieFiles(tmpdir):
     ] 
 
 
+#===================================================================================================
+# testQueryOpenSubtitles
+#===================================================================================================
+def testQueryOpenSubtitles(tmpdir):
+    tmpdir.join('movie1.avi').ensure()
+    tmpdir.join('movie2.avi').ensure()
+    #
+    with patch('xmlrpclib.Server') as rpc_mock:
+        with patch('calculate_hash.CalculateHashForFile') as hash_mock:
+            hash_mock.return_value = 13
+            rpc_mock.return_value = server = MagicMock(name='MockServer')
+            server.LogIn = MagicMock()    
+            server.LogIn.return_value = dict(token='TOKEN')    
+            server.SearchSubtitles = MagicMock()    
+            server.SearchSubtitles.return_value = dict(data={'SubFileName' : 'movie.srt'})    
+            server.LogOut = MagicMock()
+            
+            filenames = [str(tmpdir.join('movie1.avi')), str(tmpdir.join('movie2.avi'))]
+            search_results = QueryOpenSubtitles(filenames, 'en')    
+            server.LogIn.assert_called_once_with('', '', 'en', 'OS Test User Agent')
+            calls = [
+                call('TOKEN', [dict(moviehash=13, moviebytesize=0, sublanguageid='en'), dict(query='movie1')]),
+                call('TOKEN', [dict(moviehash=13, moviebytesize=0, sublanguageid='en'), dict(query='movie2')]),
+            ]
+            server.SearchSubtitles.assert_has_calls(calls)
+            server.LogOut.assert_called_once_with('TOKEN')
+            
+            assert search_results == {
+                str(tmpdir.join('movie1.avi')) : {'SubFileName' : 'movie.srt'},
+                str(tmpdir.join('movie2.avi')) : {'SubFileName' : 'movie.srt'},
+            }
+            
+            
+#===================================================================================================
+# testFindBestSubtitleMatches
+#===================================================================================================
+def testFindBestSubtitleMatches():     
+    
+    with patch('ss.QueryOpenSubtitles') as mock:
+        mock.return_value = {
+            'Parks.and.Recreation.S05E13.HDTV.x264-LOL.avi' : [
+                dict(
+                    SubFileName='Parks.and.Recreation.S05E13.HDTV.x264-LOL.srt',
+                    SubDownloadsCnt=1000,
+                    SubDownloadLink='http://sub1.srt',
+                    SubFormat='srt',
+                ),
+                dict(
+                    SubFileName='Parks.and.Recreation.S05E13.HDTV.x264-LOL.srt',
+                    SubDownloadsCnt=1500,
+                    SubDownloadLink='http://sub2.srt',
+                    SubFormat='srt',
+                ),
+                dict(
+                    SubFileName='Parks.and.Recreation.S05E13.HDTV.-LOL.srt',
+                    SubDownloadsCnt=3000,
+                    SubDownloadLink='http://sub3.srt',
+                    SubFormat='srt',
+                ),
+            ]
+        }
+        
+        results = list(FindBestSubtitleMatches(['Parks.and.Recreation.S05E13.HDTV.x264-LOL.avi'], 'en'))
+        assert results == [('Parks.and.Recreation.S05E13.HDTV.x264-LOL.avi', 'http://sub1.srt', '.srt' )]
+        
+           
 #===================================================================================================
 # main    
 #===================================================================================================