Mercurial > libervia-backend
view src/test/test_plugin_xep_0033.py @ 1356:c01cbd8fc8dd frontends_multi_profiles
plugin XEP-0045: make joinMUC asynchronous and fixes its handler
author | souliane <souliane@mailoo.org> |
---|---|
date | Sat, 07 Mar 2015 16:28:12 +0100 |
parents | 7ea0215e7092 |
children | 2308f8405ffb |
line wrap: on
line source
#!/usr/bin/python # -*- coding: utf-8 -*- # SAT: a jabber client # Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014 Jérôme Poisson (goffi@goffi.org) # Copyright (C) 2013, 2014 Adrien Cossa (souliane@mailoo.org) # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU Affero General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU Affero General Public License for more details. # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. """ Plugin extended addressing stanzas """ from constants import Const from sat.test import helpers from sat.plugins import plugin_xep_0033 as plugin from sat.core.exceptions import CancelError from sat.core.log import getLogger from copy import deepcopy from twisted.internet import defer from wokkel.generic import parseXml from twisted.words.protocols.jabber.jid import JID from logging import ERROR PROFILE = Const.PROFILE[0] JID_STR_FROM = Const.JID_STR[1] JID_STR_TO = Const.PROFILE_DICT[PROFILE].host JID_STR_X_TO = Const.JID_STR[0] JID_STR_X_CC = Const.JID_STR[1] JID_STR_X_BCC = Const.JID_STR[2] class XEP_0033Test(helpers.SatTestCase): def setUp(self): self.host = helpers.FakeSAT() self.plugin = plugin.XEP_0033(self.host) def test_messageReceived(self): self.host.memory.init() xml = u""" <message type="chat" from="%s" to="%s" id="test_1"> <body>test</body> <addresses xmlns='http://jabber.org/protocol/address'> <address type='to' jid='%s'/> <address type='cc' jid='%s'/> <address type='bcc' jid='%s'/> </addresses> </message> """ % (JID_STR_FROM, JID_STR_TO, JID_STR_X_TO, JID_STR_X_CC, JID_STR_X_BCC) stanza = parseXml(xml.encode("utf-8")) treatments = defer.Deferred() self.plugin.messageReceivedTrigger(stanza, treatments, PROFILE) data = {'extra': {}} def cb(data): expected = ('to', JID_STR_X_TO, 'cc', JID_STR_X_CC, 'bcc', JID_STR_X_BCC) msg = 'Expected: %s\nGot: %s' % (expected, data['extra']['addresses']) self.assertEqual(data['extra']['addresses'], '%s:%s\n%s:%s\n%s:%s\n' % expected, msg) treatments.addCallback(cb) treatments.callback(data) def test_sendMessageTrigger(self): mess_data = {"to": JID(JID_STR_TO), "type": "chat", "message": "content", "extra": {} } addresses = ('to', JID_STR_X_TO, 'cc', JID_STR_X_CC, 'bcc', JID_STR_X_BCC) mess_data["extra"]["address"] = '%s:%s\n%s:%s\n%s:%s\n' % addresses original_stanza = u""" <message type="chat" from="%s" to="%s" id="test_1"> <body>content</body> </message> """ % (JID_STR_FROM, JID_STR_TO) mess_data['xml'] = parseXml(original_stanza.encode("utf-8")) expected = deepcopy(mess_data['xml']) addresses_extra = """ <addresses xmlns='http://jabber.org/protocol/address'> <address type='%s' jid='%s'/> <address type='%s' jid='%s'/> <address type='%s' jid='%s'/> </addresses>""" % addresses addresses_element = parseXml(addresses_extra.encode('utf-8')) expected.addChild(addresses_element) def assertAddresses(mess_data): """The mess_data that we got here has been modified by self.plugin.sendMessageTrigger, check that the addresses element has been added to the stanza.""" self.assertEqualXML(mess_data['xml'].toXml().encode("utf-8"), expected.toXml().encode("utf-8")) def sendMessageErrback(failure, exception_class): """If the failure does encapsulate the expected exception, it will be silently trapped, otherwise it will be re-raised and will make the test fail""" failure.trap(exception_class) def checkSentAndStored(): """Check that all the recipients got their messages and that the history has been filled. /!\ see the comments in XEP_0033.sendAndStoreMessage""" sent = [] stored = [] for to_s in (JID_STR_X_TO, JID_STR_X_CC, JID_STR_X_BCC): to_jid = JID(to_s) host = JID(to_jid.host) logger = getLogger() level = logger.getEffectiveLevel() logger.setLevel(ERROR) # remove log.warning pollution entities = yield self.host.findFeaturesSet([plugin.NS_ADDRESS], jid_=host, profile_key=PROFILE) if host in entities: if host not in sent: # send the message to the entity offering the feature sent.append(host) stored.append(host) stored.append(to_jid) # store in history for each recipient else: # feature not supported, use normal behavior sent.append(to_jid) stored.append(to_jid) logger.setLevel(level) msg = "/!\ see the comments in XEP_0033.sendAndStoreMessage" self.assertEqualUnsortedList(self.host.sent_messages, sent, msg) self.assertEqualUnsortedList(self.host.stored_messages, stored, msg) def trigger(data, exception): """Execute self.plugin.sendMessageTrigger with a different logging level to not pollute the output, then check that the plugin did its job. It should abort sending the message or add the extended addressing information to the stanza. @param data: the data to be processed by self.plugin.sendMessageTrigger @param exception: CancelError """ logger = getLogger() level = logger.getEffectiveLevel() logger.setLevel(ERROR) # remove log.warning pollution pre_treatments = defer.Deferred() post_treatments = defer.Deferred() self.plugin.sendMessageTrigger(data, pre_treatments, post_treatments, PROFILE) post_treatments.callback(data) logger.setLevel(level) post_treatments.addCallbacks(assertAddresses, lambda failure: sendMessageErrback(failure, exception)) # feature is not supported, abort the message self.host.memory.init() data = deepcopy(mess_data) trigger(data, CancelError) # feature is supported by the main target server self.host.init() self.host.memory.init() self.host.addFeature(JID(JID_STR_TO), plugin.NS_ADDRESS, PROFILE) data = deepcopy(mess_data) trigger(data, CancelError) checkSentAndStored() # feature is supported by all target servers self.host.init() self.host.memory.init() self.host.addFeature(JID(JID_STR_TO), plugin.NS_ADDRESS, PROFILE) for dest in (JID_STR_X_TO, JID_STR_X_CC, JID_STR_X_BCC): self.host.addFeature(JID(JID(dest).host), plugin.NS_ADDRESS, PROFILE) data = deepcopy(mess_data) trigger(data, CancelError) checkSentAndStored() # check that a wrong recipient entity is fixed by the backend self.host.init() self.host.memory.init() self.host.addFeature(JID(JID_STR_TO), plugin.NS_ADDRESS, PROFILE) for dest in (JID_STR_X_TO, JID_STR_X_CC, JID_STR_X_BCC): self.host.addFeature(JID(JID(dest).host), plugin.NS_ADDRESS, PROFILE) data = deepcopy(mess_data) data["to"] = JID(JID_STR_X_TO) trigger(data, CancelError) checkSentAndStored()