def subtest_receptionOfSUBSTwoRequestsOneAvailable(self):
"""
Asking for two subtitles while the recipent of the request has only one.
The response should contain only the one available subtitle content,
plus a bitmask that reflects the contents of the response.
"""
print >> sys.stderr, "test: test_subtitles_msgs_2_1 -----------------------"
ol_conn = OLConnection(self.my_keypair, 'localhost', self.hisport)
bitmask = LanguagesProvider.getLanguagesInstance().langCodesToMask(
['nld', 'eng'])
binmask = utilities.uintToBinaryString(bitmask, length=4)
request = GET_SUBS + \
bencode((
self.anotherpermid,
self.testInfohash,
binmask
))
subshandler = SubtitlesHandler()
subshandler.register(ol_conn, self.richMetadata_db, self.session)
ol_conn.send(request)
subs_data = ol_conn.recv()
self.assertEquals(SUBS, subs_data[0])
data = bdecode(subs_data[1:])
print >> sys.stderr, "test: subtitles_messages : received SUBS repsonse: ", data
#check on the format of the response
self.assertTrue(isinstance(data, list))
self.assertEquals(4, len(data)) # for fields
self.assertEquals(self.mdto.channel, data[0])
self.assertEquals(self.mdto.infohash, data[1])
#the receiver had only one of the two requested subtitles
# so I expect a different bitmask
bitmask = LanguagesProvider.getLanguagesInstance().langCodesToMask(
['nld'])
expectedBinarymask = utilities.uintToBinaryString(bitmask, length=4)
self.assertEquals(expectedBinarymask, data[2])
self.assertTrue(isinstance(data[3], list))
self.assertEquals(1, len(data[3]))
with codecs.open(self.sub1, "rb", "utf-8") as sub:
expectedContents = sub.read()
self.assertEquals(expectedContents, data[3][0])
ol_conn.close()
print >> sys.stderr, "test: subtitles_messages: received content is valid."
print >> sys.stderr, "End of test_subtitles_msgs_2_1 test --------------------"
def subtest_receptionOfSUBSTwoRequestsOneAvailable(self):
"""
Asking for two subtitles while the recipent of the request has only one.
The response should contain only the one available subtitle content,
plus a bitmask that reflects the contents of the response.
"""
print >> sys.stderr, "test: test_subtitles_msgs_2_1 -----------------------"
ol_conn = OLConnection(self.my_keypair,'localhost',self.hisport)
bitmask = LanguagesProvider.getLanguagesInstance().langCodesToMask(['nld','eng'])
binmask = utilities.uintToBinaryString(bitmask, length=4)
request = GET_SUBS + \
bencode((
self.anotherpermid,
self.testInfohash,
binmask
))
subshandler = SubtitlesHandler()
subshandler.register(ol_conn, self.richMetadata_db, self.session)
ol_conn.send(request)
subs_data = ol_conn.recv()
self.assertEquals(SUBS, subs_data[0])
data = bdecode(subs_data[1:])
print >> sys.stderr, "test: subtitles_messages : received SUBS repsonse: ", data
#check on the format of the response
self.assertTrue(isinstance(data,list))
self.assertEquals(4, len(data)) # for fields
self.assertEquals(self.mdto.channel,data[0])
self.assertEquals(self.mdto.infohash, data[1])
#the receiver had only one of the two requested subtitles
# so I expect a different bitmask
bitmask = LanguagesProvider.getLanguagesInstance().langCodesToMask(['nld'])
expectedBinarymask = utilities.uintToBinaryString(bitmask, length=4)
self.assertEquals(expectedBinarymask, data[2])
self.assertTrue(isinstance(data[3],list))
self.assertEquals(1, len(data[3]))
with codecs.open(self.sub1, "rb", "utf-8") as sub:
expectedContents = sub.read()
self.assertEquals(expectedContents, data[3][0])
ol_conn.close()
print >> sys.stderr, "test: subtitles_messages: received content is valid."
print >> sys.stderr, "End of test_subtitles_msgs_2_1 test --------------------"
def subtest_receptionOfSUBS(self):
'''
Asking for the single available subtitle. The response should be
a valid SUBS message containing its contents
'''
print >> sys.stderr, "test: test_subtitles_msgs_1_1 -----------------------"
ol_conn = OLConnection(self.my_keypair, 'localhost', self.hisport)
bitmask = LanguagesProvider.getLanguagesInstance().langCodesToMask(
['nld'])
binmask = utilities.uintToBinaryString(bitmask, length=4)
request = GET_SUBS + \
bencode((
self.anotherpermid,
self.testInfohash,
binmask
))
subshandler = SubtitlesHandler()
subshandler.register(ol_conn, self.richMetadata_db, self.session)
ol_conn.send(request)
subs_data = ol_conn.recv()
print >> sys.stderr, "test: subtitles_messages : received SUBS response: len", len(
subs_data)
self.assertEquals(SUBS, subs_data[0])
data = bdecode(subs_data[1:])
print >> sys.stderr, "test: subtitles_messages : received SUBS response: ", data
#check on the format of the response
self.assertTrue(isinstance(data, list))
self.assertEquals(4, len(data)) # for fields
self.assertEquals(self.mdto.channel, data[0])
self.assertEquals(self.mdto.infohash, data[1])
self.assertEquals(binmask, data[2])
self.assertTrue(isinstance(data[3], list))
self.assertEquals(1, len(data[3]))
with codecs.open(self.sub1, "rb", "utf-8") as sub:
expectedContents = sub.read()
self.assertEquals(expectedContents, data[3][0])
ol_conn.close()
print >> sys.stderr, "test: subtitles_messages: received content is valid."
print >> sys.stderr, "End of test_subtitles_msgs_1_1 test --------------------"
def subtest_receptionOfSUBS(self):
'''
Asking for the single available subtitle. The response should be
a valid SUBS message containing its contents
'''
print >> sys.stderr, "test: test_subtitles_msgs_1_1 -----------------------"
ol_conn = OLConnection(self.my_keypair,'localhost',self.hisport)
bitmask = LanguagesProvider.getLanguagesInstance().langCodesToMask(['nld'])
binmask = utilities.uintToBinaryString(bitmask, length=4)
request = GET_SUBS + \
bencode((
self.anotherpermid,
self.testInfohash,
binmask
))
subshandler = SubtitlesHandler()
subshandler.register(ol_conn, self.richMetadata_db, self.session)
ol_conn.send(request)
subs_data = ol_conn.recv()
print >> sys.stderr, "test: subtitles_messages : received SUBS response: len",len(subs_data)
self.assertEquals(SUBS, subs_data[0])
data = bdecode(subs_data[1:])
print >> sys.stderr, "test: subtitles_messages : received SUBS response: ", data
#check on the format of the response
self.assertTrue(isinstance(data,list))
self.assertEquals(4, len(data)) # for fields
self.assertEquals(self.mdto.channel,data[0])
self.assertEquals(self.mdto.infohash, data[1])
self.assertEquals(binmask, data[2])
self.assertTrue(isinstance(data[3],list))
self.assertEquals(1, len(data[3]))
with codecs.open(self.sub1, "rb", "utf-8") as sub:
expectedContents = sub.read()
self.assertEquals(expectedContents, data[3][0])
ol_conn.close()
print >> sys.stderr, "test: subtitles_messages: received content is valid."
print >> sys.stderr, "End of test_subtitles_msgs_1_1 test --------------------"
class TestSubtitlesHandler(unittest.TestCase):
def setUp(self):
self._session = MockSession()
self.ol_bridge = MockOverlayBridge()
self.rmdDBHandler = MockMetadataDBHandler()
self.underTest = SubtitlesHandler()
def tearDown(self):
self.ol_bridge = None
#cleanup the mess in collected dir
if self.underTest.subs_dir is not None:
toDelete = [ os.path.join(self.underTest.subs_dir, entry) for entry in os.listdir(self.underTest.subs_dir)\
if entry.endswith(".srt")]
for xfile in toDelete:
if os.path.isfile(xfile):
os.remove(xfile)
def testRegisterStuff(self):
self.underTest.register(self.ol_bridge, self.rmdDBHandler,
self._session)
self.assertTrue(self.underTest.registered)
self.assertTrue(self.ol_bridge is self.underTest.overlay_bridge)
self.assertTrue(self.rmdDBHandler is self.underTest.subtitlesDb)
expectedPath = os.path.join(os.path.abspath(os.path.curdir),
self._session.get_state_dir(),
"subtitles_collecting_dir")
self.assertEqual(os.path.normpath(expectedPath),
self.underTest.subs_dir)
# preaparing the mock msg handler
self.mockMsgHandler = MockSubsMsgHander()
self.underTest._subsMsgHndlr = self.mockMsgHandler
def testGetSubtitlesFileRelativeName(self):
#subtitles filenames are build from the sha1 hash
#of the triple (channel_id, infohash, langCode)
name = getSubtitleFileRelativeName(testChannelId, testInfohash, "rus")
hasher = sha()
for value in (testChannelId, testInfohash, "rus"):
hasher.update(value)
self.assertEquals(hasher.hexdigest() + ".srt", name)
def testSendSubtitleRequestSimple(self):
self.testRegisterStuff()
self.underTest.sendSubtitleRequest(testDestPermId, testChannelId,
testInfohash, ["zho", "rus"], None,
OLPROTO_VER_FOURTEENTH)
self.assertEquals(1, self.mockMsgHandler.sendReqCount)
def testReceibedGETSUBSNoSubs(self):
self.testRegisterStuff()
self.underTest.receivedSubsRequest(
testDestPermId, (testDestPermId, testChannelId, ["ita", "nld"]),
OLPROTO_VER_FOURTEENTH)
self.assertEquals(0, self.mockMsgHandler.sendResCount)
def testReceivedGETSUBSTwoSubs(self):
self.testRegisterStuff()
self.underTest.receivedSubsRequest(
testDestPermId, (testChannelId, testInfohash, ["eng", "rus"]),
OLPROTO_VER_FOURTEENTH)
eng = u"this is a fake srt\n\nonly needed for testing\n\ncheers :)\n\n"
rus = eng + \
u"asfasgb sagas gba\n\nasfasfas 24214 a \nThe checksum is different yuppy!\n\n"
self.assertEquals(1, self.mockMsgHandler.sendResCount)
destination, response, selversion = self.mockMsgHandler.sendResParams[
0]
self.assertEquals(testDestPermId, destination)
self.assertEquals(OLPROTO_VER_FOURTEENTH, selversion)
channelId, infohash, contentsList = response
self.assertEquals(testChannelId, channelId)
self.assertEquals(testInfohash, infohash)
self.assertEquals(contentsList, {"eng": eng, "rus": rus})
def testReceivedSUBSMessage(self):
self.testRegisterStuff()
languages = ["eng", "rus"]
zho = u"Subtitle Content 1"
kor = u"Subtitle Content 2"
contentsDict = {"eng": zho, "rus": kor}
msg = (testChannelId, testInfohash, contentsDict)
simpleCallback = lambda x: x
bitmask = LanguagesProvider.getLanguagesInstance().langCodesToMask(
["eng", "rus"])
self.underTest.receivedSubsResponse(testDestPermId, msg,
[(simpleCallback, bitmask)],
OLPROTO_VER_FOURTEENTH)
#self.assertEquals(languages,callbackParams)
expectedFilename1 = getSubtitleFileRelativeName(
testChannelId, testInfohash, "eng")
expectedFilename2 = getSubtitleFileRelativeName(
testChannelId, testInfohash, "rus")
expectedPath1 = os.path.join(self._session.get_state_dir(),
self.underTest.subs_dir,
expectedFilename1)
expectedPath2 = os.path.join(self._session.get_state_dir(),
self.underTest.subs_dir,
expectedFilename2)
self.assertTrue(os.path.isfile(expectedPath1))
self.assertTrue(os.path.isfile(expectedPath2))
with codecs.open(expectedPath1, "rb", "utf-8") as file1:
content1 = file1.read()
self.assertEquals(zho, content1)
with codecs.open(expectedPath2, "rb", "utf-8") as file2:
content2 = file2.read()
self.assertEquals(kor, content2)
self.assertEquals(1, self.ol_bridge.add_task_count)
params = self.ol_bridge.add_taskParametersHistory[0]
#calling the lambda
val = params[0]()
self.assertEquals(languages, val)
def test_saveSubsOnDisk(self):
self.testRegisterStuff()
subContent = u"Test Content\nFor a pseudo subtitle file\n\nYo!\n"
self.underTest._saveSubOnDisk(testChannelId, testInfohash, "eng",
subContent)
expectedFilename = getSubtitleFileRelativeName(testChannelId,
testInfohash, "eng")
expectedPath = os.path.join(self.underTest.subs_dir, expectedFilename)
self.assertTrue(os.path.isfile(expectedPath))
#check the contents
with codecs.open(expectedPath, "rb", "utf-8") as file:
cont = file.read()
self.assertEquals(subContent, cont)
##now the file exists. If a new subtitle is saved for the same
# channel, infohash, lang but with a different content
# the old one should be overwritten
newContent = u"I'm the new content! I shall win over the old one!"
self.underTest._saveSubOnDisk(testChannelId, testInfohash, "eng",
newContent)
self.assertTrue(os.path.isfile(expectedPath))
#check the contents
with codecs.open(expectedPath, "rb", "utf-8") as file:
cont = file.read()
self.assertEquals(newContent, cont)
class TestSubtitlesHandler(unittest.TestCase):
def setUp(self):
self._session = MockSession()
self.ol_bridge = MockOverlayBridge()
self.rmdDBHandler = MockMetadataDBHandler()
self.underTest = SubtitlesHandler()
def tearDown(self):
self.ol_bridge = None
#cleanup the mess in collected dir
if self.underTest.subs_dir is not None:
toDelete = [ os.path.join(self.underTest.subs_dir, entry) for entry in os.listdir(self.underTest.subs_dir)\
if entry.endswith(".srt")]
for xfile in toDelete:
if os.path.isfile(xfile) :
os.remove(xfile)
def testRegisterStuff(self):
self.underTest.register(self.ol_bridge, self.rmdDBHandler, self._session)
self.assertTrue(self.underTest.registered)
self.assertTrue(self.ol_bridge is self.underTest.overlay_bridge)
self.assertTrue(self.rmdDBHandler is self.underTest.subtitlesDb)
expectedPath = os.path.join(os.path.abspath(os.path.curdir), self._session.get_state_dir(),
"subtitles_collecting_dir")
self.assertEqual(os.path.normpath(expectedPath), self.underTest.subs_dir)
# preaparing the mock msg handler
self.mockMsgHandler = MockSubsMsgHander()
self.underTest._subsMsgHndlr = self.mockMsgHandler
def testGetSubtitlesFileRelativeName(self):
#subtitles filenames are build from the sha1 hash
#of the triple (channel_id, infohash, langCode)
name = getSubtitleFileRelativeName(testChannelId, testInfohash, "rus")
hasher = sha()
for value in (testChannelId, testInfohash, "rus"):
hasher.update(value)
self.assertEquals(hasher.hexdigest() + ".srt", name)
def testSendSubtitleRequestSimple(self):
self.testRegisterStuff()
self.underTest.sendSubtitleRequest(testDestPermId, testChannelId, testInfohash,
["zho","rus"], None, OLPROTO_VER_FOURTEENTH)
self.assertEquals(1,self.mockMsgHandler.sendReqCount)
def testReceibedGETSUBSNoSubs(self):
self.testRegisterStuff()
self.underTest.receivedSubsRequest(testDestPermId,
(testDestPermId,testChannelId,["ita","nld"]), OLPROTO_VER_FOURTEENTH)
self.assertEquals(0,self.mockMsgHandler.sendResCount)
def testReceivedGETSUBSTwoSubs(self):
self.testRegisterStuff()
self.underTest.receivedSubsRequest(testDestPermId,
(testChannelId,testInfohash,["eng","rus"]), OLPROTO_VER_FOURTEENTH)
eng = u"this is a fake srt\n\nonly needed for testing\n\ncheers :)\n\n"
rus = eng + \
u"asfasgb sagas gba\n\nasfasfas 24214 a \nThe checksum is different yuppy!\n\n"
self.assertEquals(1,self.mockMsgHandler.sendResCount)
destination, response, selversion = self.mockMsgHandler.sendResParams[0]
self.assertEquals(testDestPermId,destination)
self.assertEquals(OLPROTO_VER_FOURTEENTH,selversion)
channelId, infohash, contentsList = response
self.assertEquals(testChannelId,channelId)
self.assertEquals(testInfohash,infohash)
self.assertEquals(contentsList,{"eng":eng,"rus":rus})
def testReceivedSUBSMessage(self):
self.testRegisterStuff()
languages = ["eng","rus"]
zho = u"Subtitle Content 1"
kor = u"Subtitle Content 2"
contentsDict = {"eng":zho, "rus":kor}
msg = (testChannelId,
testInfohash, contentsDict)
simpleCallback = lambda x : x
bitmask = LanguagesProvider.getLanguagesInstance().langCodesToMask(["eng","rus"])
self.underTest.receivedSubsResponse(testDestPermId, msg, [(simpleCallback,bitmask)], OLPROTO_VER_FOURTEENTH)
#self.assertEquals(languages,callbackParams)
expectedFilename1 = getSubtitleFileRelativeName(testChannelId, testInfohash, "eng")
expectedFilename2 = getSubtitleFileRelativeName(testChannelId, testInfohash, "rus")
expectedPath1 = os.path.join(self._session.get_state_dir(),self.underTest.subs_dir,expectedFilename1)
expectedPath2 = os.path.join(self._session.get_state_dir(),self.underTest.subs_dir,expectedFilename2)
self.assertTrue(os.path.isfile(expectedPath1))
self.assertTrue(os.path.isfile(expectedPath2))
with codecs.open(expectedPath1,"rb","utf-8") as file1:
content1 = file1.read()
self.assertEquals(zho,content1)
with codecs.open(expectedPath2,"rb","utf-8") as file2:
content2 = file2.read()
self.assertEquals(kor,content2)
self.assertEquals(1, self.ol_bridge.add_task_count)
params = self.ol_bridge.add_taskParametersHistory[0]
#calling the lambda
val = params[0]()
self.assertEquals(languages,val)
def test_saveSubsOnDisk(self):
self.testRegisterStuff()
subContent = u"Test Content\nFor a pseudo subtitle file\n\nYo!\n"
self.underTest._saveSubOnDisk(testChannelId, testInfohash,
"eng", subContent)
expectedFilename = getSubtitleFileRelativeName(testChannelId,
testInfohash, "eng")
expectedPath = os.path.join(self.underTest.subs_dir, expectedFilename)
self.assertTrue(os.path.isfile(expectedPath))
#check the contents
with codecs.open(expectedPath, "rb", "utf-8") as file:
cont = file.read()
self.assertEquals(subContent,cont)
##now the file exists. If a new subtitle is saved for the same
# channel, infohash, lang but with a different content
# the old one should be overwritten
newContent = u"I'm the new content! I shall win over the old one!"
self.underTest._saveSubOnDisk(testChannelId, testInfohash,
"eng", newContent)
self.assertTrue(os.path.isfile(expectedPath))
#check the contents
with codecs.open(expectedPath, "rb", "utf-8") as file:
cont = file.read()
self.assertEquals(newContent,cont)
